@thoughtspot/visual-embed-sdk 1.46.4 → 1.46.5

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 (255) hide show
  1. package/cjs/package.json +3 -3
  2. package/cjs/src/auth.d.ts +2 -1
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +2 -1
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/authToken.d.ts.map +1 -1
  7. package/cjs/src/authToken.js.map +1 -1
  8. package/cjs/src/css-variables.d.ts +87 -17
  9. package/cjs/src/css-variables.d.ts.map +1 -1
  10. package/cjs/src/embed/app.d.ts +41 -1
  11. package/cjs/src/embed/app.d.ts.map +1 -1
  12. package/cjs/src/embed/app.js +25 -36
  13. package/cjs/src/embed/app.js.map +1 -1
  14. package/cjs/src/embed/app.spec.js +35 -23
  15. package/cjs/src/embed/app.spec.js.map +1 -1
  16. package/cjs/src/embed/base.d.ts.map +1 -1
  17. package/cjs/src/embed/base.js.map +1 -1
  18. package/cjs/src/embed/base.spec.js.map +1 -1
  19. package/cjs/src/embed/conversation.d.ts +23 -1
  20. package/cjs/src/embed/conversation.d.ts.map +1 -1
  21. package/cjs/src/embed/conversation.js +18 -33
  22. package/cjs/src/embed/conversation.js.map +1 -1
  23. package/cjs/src/embed/conversation.spec.js +129 -97
  24. package/cjs/src/embed/conversation.spec.js.map +1 -1
  25. package/cjs/src/embed/events.spec.js +72 -0
  26. package/cjs/src/embed/events.spec.js.map +1 -1
  27. package/cjs/src/embed/hostEventClient/contracts.d.ts +105 -3
  28. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  29. package/cjs/src/embed/hostEventClient/contracts.js +9 -0
  30. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  31. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +28 -0
  32. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  33. package/cjs/src/embed/hostEventClient/host-event-client.js +106 -9
  34. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  35. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +327 -6
  36. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  37. package/cjs/src/embed/hostEventClient/utils.d.ts +22 -0
  38. package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -0
  39. package/cjs/src/embed/hostEventClient/utils.js +51 -0
  40. package/cjs/src/embed/hostEventClient/utils.js.map +1 -0
  41. package/cjs/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  42. package/cjs/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  43. package/cjs/src/embed/hostEventClient/utils.spec.js +115 -0
  44. package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -0
  45. package/cjs/src/embed/liveboard.d.ts +18 -0
  46. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  47. package/cjs/src/embed/liveboard.js +10 -3
  48. package/cjs/src/embed/liveboard.js.map +1 -1
  49. package/cjs/src/embed/liveboard.spec.js +54 -2
  50. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  51. package/cjs/src/embed/sage.d.ts.map +1 -1
  52. package/cjs/src/embed/sage.js.map +1 -1
  53. package/cjs/src/embed/search.spec.js.map +1 -1
  54. package/cjs/src/embed/spotter-utils.d.ts +20 -0
  55. package/cjs/src/embed/spotter-utils.d.ts.map +1 -0
  56. package/cjs/src/embed/spotter-utils.js +52 -0
  57. package/cjs/src/embed/spotter-utils.js.map +1 -0
  58. package/cjs/src/embed/spotter-utils.spec.d.ts +2 -0
  59. package/cjs/src/embed/spotter-utils.spec.d.ts.map +1 -0
  60. package/cjs/src/embed/spotter-utils.spec.js +54 -0
  61. package/cjs/src/embed/spotter-utils.spec.js.map +1 -0
  62. package/cjs/src/embed/ts-embed.d.ts +41 -2
  63. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  64. package/cjs/src/embed/ts-embed.js +54 -3
  65. package/cjs/src/embed/ts-embed.js.map +1 -1
  66. package/cjs/src/errors.d.ts +2 -0
  67. package/cjs/src/errors.d.ts.map +1 -1
  68. package/cjs/src/errors.js +2 -0
  69. package/cjs/src/errors.js.map +1 -1
  70. package/cjs/src/react/index.d.ts.map +1 -1
  71. package/cjs/src/react/index.js +58 -53
  72. package/cjs/src/react/index.js.map +1 -1
  73. package/cjs/src/types.d.ts +832 -33
  74. package/cjs/src/types.d.ts.map +1 -1
  75. package/cjs/src/types.js +835 -3
  76. package/cjs/src/types.js.map +1 -1
  77. package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
  78. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  79. package/cjs/src/utils/graphql/answerService/answerService.js +4 -2
  80. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  81. package/cjs/src/utils/graphql/preview-service.d.ts.map +1 -1
  82. package/cjs/src/utils/graphql/preview-service.js.map +1 -1
  83. package/cjs/src/utils/processData.d.ts.map +1 -1
  84. package/cjs/src/utils/processData.js.map +1 -1
  85. package/cjs/src/utils.d.ts +0 -9
  86. package/cjs/src/utils.d.ts.map +1 -1
  87. package/cjs/src/utils.js +1 -10
  88. package/cjs/src/utils.js.map +1 -1
  89. package/dist/index-ChNydfIz.js +7371 -0
  90. package/dist/index-DW2wEHqy.js +7371 -0
  91. package/dist/src/auth.d.ts +2 -1
  92. package/dist/src/auth.d.ts.map +1 -1
  93. package/dist/src/authToken.d.ts.map +1 -1
  94. package/dist/src/css-variables.d.ts +87 -17
  95. package/dist/src/css-variables.d.ts.map +1 -1
  96. package/dist/src/embed/app.d.ts +41 -1
  97. package/dist/src/embed/app.d.ts.map +1 -1
  98. package/dist/src/embed/base.d.ts.map +1 -1
  99. package/dist/src/embed/conversation.d.ts +23 -1
  100. package/dist/src/embed/conversation.d.ts.map +1 -1
  101. package/dist/src/embed/hostEventClient/contracts.d.ts +105 -3
  102. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  103. package/dist/src/embed/hostEventClient/host-event-client.d.ts +28 -0
  104. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  105. package/dist/src/embed/hostEventClient/utils.d.ts +22 -0
  106. package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -0
  107. package/dist/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  108. package/dist/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  109. package/dist/src/embed/liveboard.d.ts +18 -0
  110. package/dist/src/embed/liveboard.d.ts.map +1 -1
  111. package/dist/src/embed/sage.d.ts.map +1 -1
  112. package/dist/src/embed/spotter-utils.d.ts +20 -0
  113. package/dist/src/embed/spotter-utils.d.ts.map +1 -0
  114. package/dist/src/embed/spotter-utils.spec.d.ts +2 -0
  115. package/dist/src/embed/spotter-utils.spec.d.ts.map +1 -0
  116. package/dist/src/embed/ts-embed.d.ts +41 -2
  117. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  118. package/dist/src/errors.d.ts +2 -0
  119. package/dist/src/errors.d.ts.map +1 -1
  120. package/dist/src/react/index.d.ts.map +1 -1
  121. package/dist/src/types.d.ts +832 -33
  122. package/dist/src/types.d.ts.map +1 -1
  123. package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
  124. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  125. package/dist/src/utils/graphql/preview-service.d.ts.map +1 -1
  126. package/dist/src/utils/processData.d.ts.map +1 -1
  127. package/dist/src/utils.d.ts +0 -9
  128. package/dist/src/utils.d.ts.map +1 -1
  129. package/dist/tsembed-react.es.js +1208 -154
  130. package/dist/tsembed-react.js +1206 -152
  131. package/dist/tsembed.es.js +1150 -101
  132. package/dist/tsembed.js +1148 -99
  133. package/dist/visual-embed-sdk-react-full.d.ts +1156 -55
  134. package/dist/visual-embed-sdk-react.d.ts +1156 -55
  135. package/dist/visual-embed-sdk.d.ts +1179 -60
  136. package/lib/package.json +3 -3
  137. package/lib/src/auth.d.ts +2 -1
  138. package/lib/src/auth.d.ts.map +1 -1
  139. package/lib/src/auth.js +2 -1
  140. package/lib/src/auth.js.map +1 -1
  141. package/lib/src/authToken.d.ts.map +1 -1
  142. package/lib/src/authToken.js.map +1 -1
  143. package/lib/src/css-variables.d.ts +87 -17
  144. package/lib/src/css-variables.d.ts.map +1 -1
  145. package/lib/src/embed/app.d.ts +41 -1
  146. package/lib/src/embed/app.d.ts.map +1 -1
  147. package/lib/src/embed/app.js +27 -38
  148. package/lib/src/embed/app.js.map +1 -1
  149. package/lib/src/embed/app.spec.js +35 -23
  150. package/lib/src/embed/app.spec.js.map +1 -1
  151. package/lib/src/embed/base.d.ts.map +1 -1
  152. package/lib/src/embed/base.js.map +1 -1
  153. package/lib/src/embed/base.spec.js.map +1 -1
  154. package/lib/src/embed/conversation.d.ts +23 -1
  155. package/lib/src/embed/conversation.d.ts.map +1 -1
  156. package/lib/src/embed/conversation.js +19 -34
  157. package/lib/src/embed/conversation.js.map +1 -1
  158. package/lib/src/embed/conversation.spec.js +131 -99
  159. package/lib/src/embed/conversation.spec.js.map +1 -1
  160. package/lib/src/embed/events.spec.js +73 -1
  161. package/lib/src/embed/events.spec.js.map +1 -1
  162. package/lib/src/embed/hostEventClient/contracts.d.ts +105 -3
  163. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  164. package/lib/src/embed/hostEventClient/contracts.js +9 -0
  165. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  166. package/lib/src/embed/hostEventClient/host-event-client.d.ts +28 -0
  167. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  168. package/lib/src/embed/hostEventClient/host-event-client.js +106 -9
  169. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  170. package/lib/src/embed/hostEventClient/host-event-client.spec.js +327 -6
  171. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  172. package/lib/src/embed/hostEventClient/utils.d.ts +22 -0
  173. package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -0
  174. package/lib/src/embed/hostEventClient/utils.js +43 -0
  175. package/lib/src/embed/hostEventClient/utils.js.map +1 -0
  176. package/lib/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  177. package/lib/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  178. package/lib/src/embed/hostEventClient/utils.spec.js +113 -0
  179. package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -0
  180. package/lib/src/embed/liveboard.d.ts +18 -0
  181. package/lib/src/embed/liveboard.d.ts.map +1 -1
  182. package/lib/src/embed/liveboard.js +10 -3
  183. package/lib/src/embed/liveboard.js.map +1 -1
  184. package/lib/src/embed/liveboard.spec.js +54 -2
  185. package/lib/src/embed/liveboard.spec.js.map +1 -1
  186. package/lib/src/embed/sage.d.ts.map +1 -1
  187. package/lib/src/embed/sage.js.map +1 -1
  188. package/lib/src/embed/search.spec.js.map +1 -1
  189. package/lib/src/embed/spotter-utils.d.ts +20 -0
  190. package/lib/src/embed/spotter-utils.d.ts.map +1 -0
  191. package/lib/src/embed/spotter-utils.js +47 -0
  192. package/lib/src/embed/spotter-utils.js.map +1 -0
  193. package/lib/src/embed/spotter-utils.spec.d.ts +2 -0
  194. package/lib/src/embed/spotter-utils.spec.d.ts.map +1 -0
  195. package/lib/src/embed/spotter-utils.spec.js +52 -0
  196. package/lib/src/embed/spotter-utils.spec.js.map +1 -0
  197. package/lib/src/embed/ts-embed.d.ts +41 -2
  198. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  199. package/lib/src/embed/ts-embed.js +55 -4
  200. package/lib/src/embed/ts-embed.js.map +1 -1
  201. package/lib/src/errors.d.ts +2 -0
  202. package/lib/src/errors.d.ts.map +1 -1
  203. package/lib/src/errors.js +2 -0
  204. package/lib/src/errors.js.map +1 -1
  205. package/lib/src/react/index.d.ts.map +1 -1
  206. package/lib/src/react/index.js +58 -53
  207. package/lib/src/react/index.js.map +1 -1
  208. package/lib/src/types.d.ts +832 -33
  209. package/lib/src/types.d.ts.map +1 -1
  210. package/lib/src/types.js +835 -3
  211. package/lib/src/types.js.map +1 -1
  212. package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
  213. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  214. package/lib/src/utils/graphql/answerService/answerService.js +4 -2
  215. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  216. package/lib/src/utils/graphql/preview-service.d.ts.map +1 -1
  217. package/lib/src/utils/graphql/preview-service.js.map +1 -1
  218. package/lib/src/utils/processData.d.ts.map +1 -1
  219. package/lib/src/utils/processData.js.map +1 -1
  220. package/lib/src/utils.d.ts +0 -9
  221. package/lib/src/utils.d.ts.map +1 -1
  222. package/lib/src/utils.js +0 -8
  223. package/lib/src/utils.js.map +1 -1
  224. package/lib/src/visual-embed-sdk.d.ts +1179 -60
  225. package/package.json +3 -3
  226. package/src/auth.spec.ts +1 -1
  227. package/src/auth.ts +2 -1
  228. package/src/authToken.ts +0 -1
  229. package/src/css-variables.ts +96 -17
  230. package/src/embed/app.spec.ts +48 -30
  231. package/src/embed/app.ts +59 -54
  232. package/src/embed/base.spec.ts +1 -2
  233. package/src/embed/base.ts +1 -4
  234. package/src/embed/conversation.spec.ts +150 -119
  235. package/src/embed/conversation.ts +30 -54
  236. package/src/embed/events.spec.ts +88 -0
  237. package/src/embed/hostEventClient/contracts.ts +105 -2
  238. package/src/embed/hostEventClient/host-event-client.spec.ts +504 -6
  239. package/src/embed/hostEventClient/host-event-client.ts +146 -15
  240. package/src/embed/hostEventClient/utils.spec.ts +137 -0
  241. package/src/embed/hostEventClient/utils.ts +61 -0
  242. package/src/embed/liveboard.spec.ts +71 -2
  243. package/src/embed/liveboard.ts +29 -2
  244. package/src/embed/sage.ts +0 -1
  245. package/src/embed/search.spec.ts +0 -2
  246. package/src/embed/spotter-utils.spec.ts +56 -0
  247. package/src/embed/spotter-utils.ts +65 -0
  248. package/src/embed/ts-embed.ts +58 -4
  249. package/src/errors.ts +2 -0
  250. package/src/react/index.tsx +76 -72
  251. package/src/types.ts +843 -31
  252. package/src/utils/graphql/answerService/answerService.ts +4 -5
  253. package/src/utils/graphql/preview-service.ts +0 -1
  254. package/src/utils/processData.ts +0 -5
  255. package/src/utils.ts +0 -14
@@ -428,37 +428,49 @@ export interface CustomCssVariables {
428
428
  /**
429
429
  * Padding of the groups in the Liveboard.
430
430
  *
431
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
431
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
432
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
433
+ * this CSS variable.
432
434
  */
433
435
  "--ts-var-liveboard-group-padding"?: string;
434
436
  /**
435
437
  * Font size of the title of the groups in the Liveboard.
436
438
  *
437
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
439
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
440
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
441
+ * this CSS variable.
438
442
  */
439
443
  "--ts-var-liveboard-group-title-font-size"?: string;
440
444
  /**
441
445
  * Font weight of the title of the groups in the Liveboard.
442
446
  *
443
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
447
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
448
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
449
+ * this CSS variable.
444
450
  */
445
451
  "--ts-var-liveboard-group-title-font-weight"?: string;
446
452
  /**
447
453
  * Font size of the title of the tiles inside the groups in the Liveboard.
448
454
  *
449
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
455
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
456
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
457
+ * this CSS variable.
450
458
  */
451
459
  "--ts-var-liveboard-group-tile-title-font-size"?: string;
452
460
  /**
453
461
  * Font weight of the title of the tiles inside the groups in the Liveboard.
454
462
  *
455
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
463
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
464
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
465
+ * this CSS variable.
456
466
  */
457
467
  "--ts-var-liveboard-group-tile-title-font-weight"?: string;
458
468
  /**
459
469
  * Padding of the group tiles in the Liveboard.
460
470
  *
461
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
471
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
472
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
473
+ * this CSS variable.
462
474
  */
463
475
  "--ts-var-liveboard-group-tile-padding"?: string;
464
476
  /**
@@ -468,13 +480,17 @@ export interface CustomCssVariables {
468
480
  /**
469
481
  * Background color of the groups in the Liveboard.
470
482
  *
471
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
483
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
484
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
485
+ * this CSS variable.
472
486
  */
473
487
  "--ts-var-liveboard-group-background"?: string;
474
488
  /**
475
489
  * Border color of the groups in the Liveboard.
476
490
  *
477
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
491
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
492
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
493
+ * this CSS variable.
478
494
  */
479
495
  "--ts-var-liveboard-group-border-color"?: string;
480
496
  /**
@@ -488,55 +504,73 @@ export interface CustomCssVariables {
488
504
  /**
489
505
  * Font color of the title of the groups in the Liveboard.
490
506
  *
491
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
507
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
508
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
509
+ * this CSS variable.
492
510
  */
493
511
  "--ts-var-liveboard-group-title-font-color"?: string;
494
512
  /**
495
513
  * Font color of the description of the groups in the Liveboard.
496
514
  *
497
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
515
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
516
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
517
+ * this CSS variable.
498
518
  */
499
519
  "--ts-var-liveboard-group-description-font-color"?: string;
500
520
  /**
501
521
  * Font color of the title of the tiles inside the groups in the Liveboard.
502
522
  *
503
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
523
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
524
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
525
+ * this CSS variable.
504
526
  */
505
527
  "--ts-var-liveboard-group-tile-title-font-color"?: string;
506
528
  /**
507
529
  * Font color of the description of the tiles inside the groups in the Liveboard.
508
530
  *
509
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
531
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
532
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
533
+ * this CSS variable.
510
534
  */
511
535
  "--ts-var-liveboard-group-tile-description-font-color"?: string;
512
536
  /**
513
537
  * Background color of the tiles inside the groups in the Liveboard.
514
538
  *
515
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
539
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
540
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
541
+ * this CSS variable.
516
542
  */
517
543
  "--ts-var-liveboard-group-tile-background"?: string;
518
544
  /**
519
545
  * Background color of the filter chips in the Liveboard.
520
546
  *
521
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
547
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
548
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
549
+ * this CSS variable.
522
550
  */
523
551
  "--ts-var-liveboard-chip-background"?: string;
524
552
  /**
525
553
  * Font color of the filter chips in the Liveboard.
526
554
  *
527
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
555
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
556
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
557
+ * this CSS variable.
528
558
  */
529
559
  "--ts-var-liveboard-chip-color"?: string;
530
560
  /**
531
561
  * Background color of the filter chips in the Liveboard on hover.
532
562
  *
533
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
563
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
564
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
565
+ * this CSS variable.
534
566
  */
535
567
  "--ts-var-liveboard-chip--hover-background"?: string;
536
568
  /**
537
569
  * Background color of the filter chips in the Liveboard on active.
538
570
  *
539
- * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
571
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
572
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
573
+ * this CSS variable.
540
574
  */
541
575
  "--ts-var-liveboard-chip--active-background"?: string;
542
576
  /**
@@ -751,6 +785,42 @@ export interface CustomCssVariables {
751
785
  * Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar.
752
786
  */
753
787
  "--ts-var-saved-chats-section-title-color"?: string;
788
+ /**
789
+ * Text color of the styling panel in the Liveboard.
790
+ */
791
+ "--ts-var-liveboard-styling-panel-text-color"?: string;
792
+ /**
793
+ * Border color of the styling panel in the Liveboard.
794
+ */
795
+ "--ts-var-liveboard-styling-panel-border-color"?: string;
796
+ /**
797
+ * Background color of the styling button in the Liveboard.
798
+ */
799
+ "--ts-var-liveboard-styling-button-background"?: string;
800
+ /**
801
+ * Text color of the styling button in the Liveboard.
802
+ */
803
+ "--ts-var-liveboard-styling-button-text-color"?: string;
804
+ /**
805
+ * Background color of the styling button in the Liveboard on hover.
806
+ */
807
+ "--ts-var-liveboard-styling-button-hover-background"?: string;
808
+ /**
809
+ * Background color of the styling button in the Liveboard when active.
810
+ */
811
+ "--ts-var-liveboard-styling-button-active-background"?: string;
812
+ /**
813
+ * Text color of the styling button in the Liveboard on hover.
814
+ */
815
+ "--ts-var-liveboard-styling-button-hover-text-color"?: string;
816
+ /**
817
+ * Box shadow of the styling button in the Liveboard.
818
+ */
819
+ "--ts-var-liveboard-styling-button-shadow"?: string;
820
+ /**
821
+ * Background color of the color palette in the Liveboard styling panel.
822
+ */
823
+ "--ts-var-liveboard-styling-color-palette-background"?: string;
754
824
  }
755
825
  export interface SessionInterface {
756
826
  sessionId: string;
@@ -3539,6 +3609,17 @@ export declare enum EmbedEvent {
3539
3609
  * ```
3540
3610
  */
3541
3611
  DownloadAsXlsx = "downloadAsXlsx",
3612
+ /**
3613
+ * Emitted when the Download Liveboard as Continuous PDF action is triggered
3614
+ * on a Liveboard.
3615
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3616
+ * @example
3617
+ * ```js
3618
+ * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
3619
+ * console.log('download liveboard as continuous PDF', payload)})
3620
+ * ```
3621
+ */
3622
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
3542
3623
  /**
3543
3624
  * Emitted when an Answer is deleted in the app
3544
3625
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
@@ -3942,22 +4023,45 @@ export declare enum EmbedEvent {
3942
4023
  /**
3943
4024
  * Emitted when name, status (private or public) or filter values of a
3944
4025
  * Personalised view is updated.
4026
+ * This event is deprecated. Use {@link EmbedEvent.UpdatePersonalizedView} instead.
3945
4027
  * @returns viewName: string
3946
4028
  * @returns viewId: string
3947
4029
  * @returns liveboardId: string
3948
4030
  * @returns isPublic: boolean
3949
4031
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4032
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3950
4033
  */
3951
4034
  UpdatePersonalisedView = "updatePersonalisedView",
4035
+ /**
4036
+ * Emitted when name, status (private or public) or filter values of a
4037
+ * Personalized view is updated.
4038
+ * @returns viewName: string
4039
+ * @returns viewId: string
4040
+ * @returns liveboardId: string
4041
+ * @returns isPublic: boolean
4042
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4043
+ */
4044
+ UpdatePersonalizedView = "updatePersonalisedView",
3952
4045
  /**
3953
4046
  * Emitted when a Personalised view is saved.
4047
+ * This event is deprecated. Use {@link EmbedEvent.SavePersonalizedView} instead.
3954
4048
  * @returns viewName: string
3955
4049
  * @returns viewId: string
3956
4050
  * @returns liveboardId: string
3957
4051
  * @returns isPublic: boolean
3958
4052
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4053
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3959
4054
  */
3960
4055
  SavePersonalisedView = "savePersonalisedView",
4056
+ /**
4057
+ * Emitted when a Personalized view is saved.
4058
+ * @returns viewName: string
4059
+ * @returns viewId: string
4060
+ * @returns liveboardId: string
4061
+ * @returns isPublic: boolean
4062
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4063
+ */
4064
+ SavePersonalizedView = "savePersonalisedView",
3961
4065
  /**
3962
4066
  * Emitted when a Liveboard is reset.
3963
4067
  * @returns viewName: string
@@ -3969,11 +4073,41 @@ export declare enum EmbedEvent {
3969
4073
  ResetLiveboard = "resetLiveboard",
3970
4074
  /**
3971
4075
  * Emitted when a PersonalisedView is deleted.
4076
+ * This event is deprecated. Use {@link EmbedEvent.DeletePersonalizedView} instead.
3972
4077
  * @returns views: string[]
3973
4078
  * @returns liveboardId: string
3974
4079
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4080
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3975
4081
  */
3976
4082
  DeletePersonalisedView = "deletePersonalisedView",
4083
+ /**
4084
+ * Emitted when a PersonalizedView is deleted.
4085
+ * @returns views: string[]
4086
+ * @returns liveboardId: string
4087
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4088
+ */
4089
+ DeletePersonalizedView = "deletePersonalisedView",
4090
+ /**
4091
+ * Emitted when a user selects a different Personalized View or
4092
+ * resets to the original/default view on a Liveboard.
4093
+ * @example
4094
+ * ```js
4095
+ * liveboardEmbed.on(EmbedEvent.ChangePersonalizedView, (data) => {
4096
+ * console.log(data.viewName); // 'Q4 Revenue' or 'Original View'
4097
+ * console.log(data.viewId); // '2a021a12-...' or null (default)
4098
+ * console.log(data.liveboardId); // 'abc123...'
4099
+ * console.log(data.isPublic); // true | false
4100
+ * })
4101
+ * ```
4102
+ * @returns viewName: string - Name of the selected view,
4103
+ * or 'Original View' when reset to default.
4104
+ * @returns viewId: string | null - GUID of the selected view,
4105
+ * or null when reset to default.
4106
+ * @returns liveboardId: string
4107
+ * @returns isPublic: boolean
4108
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4109
+ */
4110
+ ChangePersonalizedView = "changePersonalisedView",
3977
4111
  /**
3978
4112
  * Emitted when a user creates a Worksheet.
3979
4113
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
@@ -4007,7 +4141,8 @@ export declare enum EmbedEvent {
4007
4141
  * @param - Includes the following parameters:
4008
4142
  * - `payload`: The payload received from the embed related to the Data API call.
4009
4143
  * - `responder`: Contains elements that let developers define whether ThoughtSpot
4010
- * will run or block the search operation, and if blocked, which error message to provide.
4144
+ * will run or block the search operation, and if blocked, which error message to
4145
+ * provide.
4011
4146
  * - `execute` - When `execute` returns `true`, the search is run.
4012
4147
  * When `execute` returns `false`, the search is not executed.
4013
4148
  * - `error` - Developers can customize the user-facing error message when `execute`
@@ -4441,6 +4576,25 @@ export declare enum EmbedEvent {
4441
4576
  * );
4442
4577
  * }
4443
4578
  * ```
4579
+ *
4580
+ * **Context Parameter (SDK: 1.45.2+)**
4581
+ *
4582
+ * Starting from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl, you can optionally pass a
4583
+ * `ContextType` as the third parameter to the `trigger` method to specify the context
4584
+ * from which the event is triggered. This helps ThoughtSpot understand the current page
4585
+ * context (Search, Answer, Liveboard, or Spotter) for better event handling.
4586
+ *
4587
+ * @example
4588
+ * ```js
4589
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
4590
+ *
4591
+ * // Trigger Pin event with Search context
4592
+ * appEmbed.trigger(HostEvent.Pin, {
4593
+ * vizId: "123",
4594
+ * liveboardId: "456"
4595
+ * }, ContextType.Search);
4596
+ * ```
4597
+ *
4444
4598
  * @group Events
4445
4599
  */
4446
4600
  export declare enum HostEvent {
@@ -4462,6 +4616,16 @@ export declare enum HostEvent {
4462
4616
  execute: true
4463
4617
  });
4464
4618
  * ```
4619
+ * @example
4620
+ * ```js
4621
+ * // Trigger search from search context
4622
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4623
+ * appEmbed.trigger(HostEvent.Search, {
4624
+ * searchQuery: "[revenue] by [region]",
4625
+ * dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
4626
+ * execute: true
4627
+ * }, ContextType.Search);
4628
+ * ```
4465
4629
  */
4466
4630
  Search = "search",
4467
4631
  /**
@@ -4512,6 +4676,24 @@ export declare enum HostEvent {
4512
4676
  * });
4513
4677
  * })
4514
4678
  * ```
4679
+ * @example
4680
+ * ```js
4681
+ * // Drill down from answer context
4682
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4683
+ * appEmbed.trigger(HostEvent.DrillDown, {
4684
+ * points: { clickedPoint, selectedPoints },
4685
+ * autoDrillDown: true
4686
+ * }, ContextType.Answer);
4687
+ * ```
4688
+ * @example
4689
+ * ```js
4690
+ * // Drill down from search context
4691
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4692
+ * searchEmbed.trigger(HostEvent.DrillDown, {
4693
+ * points: { clickedPoint, selectedPoints },
4694
+ * columnGuid: "column-guid"
4695
+ * }, ContextType.Search);
4696
+ * ```
4515
4697
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
4516
4698
  */
4517
4699
  DrillDown = "triggerDrillDown",
@@ -4532,6 +4714,13 @@ export declare enum HostEvent {
4532
4714
  * const url = embed.trigger(HostEvent.GetIframeUrl);
4533
4715
  * console.log("iFrameURL",url);
4534
4716
  * ```
4717
+ * @example
4718
+ * ```js
4719
+ * // Get iframe URL from specific context
4720
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4721
+ * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
4722
+ * console.log("iFrameURL", url);
4723
+ * ```
4535
4724
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4536
4725
  */
4537
4726
  GetIframeUrl = "GetIframeUrl",
@@ -4545,6 +4734,15 @@ export declare enum HostEvent {
4545
4734
  * '730496d6-6903-4601-937e-2c691821af3c',
4546
4735
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
4547
4736
  * ```
4737
+ * @example
4738
+ * ```js
4739
+ * // Set visible vizs from liveboard context
4740
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4741
+ * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
4742
+ * '730496d6-6903-4601-937e-2c691821af3c',
4743
+ * 'd547ec54-2a37-4516-a222-2b06719af726'
4744
+ * ], ContextType.Liveboard);
4745
+ * ```
4548
4746
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
4549
4747
  */
4550
4748
  SetVisibleVizs = "SetPinboardVisibleVizs",
@@ -4557,6 +4755,14 @@ export declare enum HostEvent {
4557
4755
  * tabId:'730496d6-6903-4601-937e-2c691821af3c'
4558
4756
  * })
4559
4757
  * ```
4758
+ * @example
4759
+ * ```js
4760
+ * // Set active tab from liveboard context
4761
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4762
+ * liveboardEmbed.trigger(HostEvent.SetActiveTab, {
4763
+ * tabId: '730496d6-6903-4601-937e-2c691821af3c'
4764
+ * }, ContextType.Liveboard);
4765
+ * ```
4560
4766
  * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw
4561
4767
  */
4562
4768
  SetActiveTab = "SetActiveTab",
@@ -4590,6 +4796,15 @@ export declare enum HostEvent {
4590
4796
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
4591
4797
  * ])
4592
4798
  * ```
4799
+ * @example
4800
+ * ```js
4801
+ * // Update runtime filters from liveboard context
4802
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4803
+ * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
4804
+ * {columnName: "region", operator: RuntimeFilterOp.EQ, values: ["west"]},
4805
+ * {columnName: "product", operator: RuntimeFilterOp.IN, values: ["shoes", "boots"]}
4806
+ * ], ContextType.Liveboard);
4807
+ * ```
4593
4808
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
4594
4809
  * @important
4595
4810
  */
@@ -4623,6 +4838,14 @@ export declare enum HostEvent {
4623
4838
  * LiveboardEmbed.trigger(HostEvent.OpenFilter,
4624
4839
  * { column: {columnId: '<column-GUID>'}})
4625
4840
  * ```
4841
+ * @example
4842
+ * ```js
4843
+ * // Open filter from search context
4844
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4845
+ * searchEmbed.trigger(HostEvent.OpenFilter, {
4846
+ * column: { columnId: '<column-GUID>', name: 'region', type: 'ATTRIBUTE', dataType: 'CHAR'}
4847
+ * }, ContextType.Search);
4848
+ * ```
4626
4849
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4627
4850
  */
4628
4851
  OpenFilter = "openFilter",
@@ -4633,6 +4856,14 @@ export declare enum HostEvent {
4633
4856
  * ```js
4634
4857
  * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
4635
4858
  * ```
4859
+ * @example
4860
+ * ```js
4861
+ * // Add columns from search context
4862
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4863
+ * searchEmbed.trigger(HostEvent.AddColumns, {
4864
+ * columnIds: ['col-guid-1', 'col-guid-2']
4865
+ * }, ContextType.Search);
4866
+ * ```
4636
4867
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4637
4868
  */
4638
4869
  AddColumns = "addColumns",
@@ -4643,6 +4874,14 @@ export declare enum HostEvent {
4643
4874
  * ```js
4644
4875
  * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
4645
4876
  * ```
4877
+ * @example
4878
+ * ```js
4879
+ * // Remove column from search context
4880
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4881
+ * searchEmbed.trigger(HostEvent.RemoveColumn, {
4882
+ * columnId: 'column-guid'
4883
+ * }, ContextType.Search);
4884
+ * ```
4646
4885
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4647
4886
  */
4648
4887
  RemoveColumn = "removeColumn",
@@ -4729,6 +4968,37 @@ export declare enum HostEvent {
4729
4968
  *
4730
4969
  * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
4731
4970
  * ```
4971
+ * @example
4972
+ * ```js
4973
+ * // Using context parameter to specify the context type (SDK: 1.45.2+)
4974
+ * // Pin from a search answer context
4975
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4976
+ * appEmbed.trigger(HostEvent.Pin, {
4977
+ * vizId: "123",
4978
+ * newVizName: "Sales by region",
4979
+ * liveboardId: "456"
4980
+ * }, ContextType.Search);
4981
+ * ```
4982
+ * @example
4983
+ * ```js
4984
+ * // Pin from an answer context (explore modal/page) (SDK: 1.45.2+)
4985
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4986
+ * appEmbed.trigger(HostEvent.Pin, {
4987
+ * vizId: "789",
4988
+ * newVizName: "Revenue trends",
4989
+ * liveboardId: "456"
4990
+ * }, ContextType.Answer);
4991
+ * ```
4992
+ * @example
4993
+ * ```js
4994
+ * // Pin from a spotter context (SDK: 1.45.2+)
4995
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4996
+ * appEmbed.trigger(HostEvent.Pin, {
4997
+ * vizId: latestSpotterVizId,
4998
+ * newVizName: "AI-generated insights",
4999
+ * liveboardId: "456"
5000
+ * }, ContextType.Spotter);
5001
+ * ```
4732
5002
  *
4733
5003
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4734
5004
  */
@@ -4739,6 +5009,12 @@ export declare enum HostEvent {
4739
5009
  * @example
4740
5010
  * ```js
4741
5011
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
5012
+ *```
5013
+ * @example
5014
+ * ```js
5015
+ * // Show liveboard info from liveboard context
5016
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5017
+ * liveboardEmbed.trigger(HostEvent.LiveboardInfo, {}, ContextType.Liveboard);
4742
5018
  * ```
4743
5019
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4744
5020
  */
@@ -4749,6 +5025,12 @@ export declare enum HostEvent {
4749
5025
  * ```js
4750
5026
  * liveboardEmbed.trigger(HostEvent.Schedule)
4751
5027
  * ```
5028
+ * @example
5029
+ * ```js
5030
+ * // Schedule from liveboard context
5031
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5032
+ * liveboardEmbed.trigger(HostEvent.Schedule, {}, ContextType.Liveboard);
5033
+ * ```
4752
5034
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4753
5035
  */
4754
5036
  Schedule = "subscription",
@@ -4758,6 +5040,12 @@ export declare enum HostEvent {
4758
5040
  * ```js
4759
5041
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
4760
5042
  * ```
5043
+ * @example
5044
+ * ```js
5045
+ * // Manage schedules from liveboard context
5046
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5047
+ * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
5048
+ * ```
4761
5049
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4762
5050
  */
4763
5051
  SchedulesList = "schedule-list",
@@ -4768,6 +5056,18 @@ export declare enum HostEvent {
4768
5056
  * ```js
4769
5057
  * liveboardEmbed.trigger(HostEvent.ExportTML)
4770
5058
  * ```
5059
+ * @example
5060
+ * ```js
5061
+ * // Export TML from liveboard context
5062
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5063
+ * liveboardEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Liveboard);
5064
+ * ```
5065
+ * @example
5066
+ * ```js
5067
+ * // Export TML from search-answer context
5068
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5069
+ * appEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Search);
5070
+ * ```
4771
5071
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4772
5072
  */
4773
5073
  ExportTML = "exportTSL",
@@ -4778,6 +5078,18 @@ export declare enum HostEvent {
4778
5078
  * ```js
4779
5079
  * liveboardEmbed.trigger(HostEvent.EditTML)
4780
5080
  * ```
5081
+ * @example
5082
+ * ```js
5083
+ * // Edit TML from liveboard context
5084
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5085
+ * liveboardEmbed.trigger(HostEvent.EditTML, {}, ContextType.Liveboard);
5086
+ * ```
5087
+ * @example
5088
+ * ```js
5089
+ * // Edit TML from search-answer context
5090
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5091
+ * appEmbed.trigger(HostEvent.EditTML, {}, ContextType.Search);
5092
+ * ```
4781
5093
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4782
5094
  */
4783
5095
  EditTML = "editTSL",
@@ -4787,6 +5099,12 @@ export declare enum HostEvent {
4787
5099
  * ```js
4788
5100
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
4789
5101
  * ```
5102
+ * @example
5103
+ * ```js
5104
+ * // Update TML from liveboard context
5105
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5106
+ * liveboardEmbed.trigger(HostEvent.UpdateTML, {}, ContextType.Liveboard);
5107
+ * ```
4790
5108
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4791
5109
  */
4792
5110
  UpdateTML = "updateTSL",
@@ -4813,10 +5131,34 @@ export declare enum HostEvent {
4813
5131
  *
4814
5132
  * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
4815
5133
  * ```
5134
+ * @example
5135
+ * ```js
5136
+ * // Download as PDF from search-answer context
5137
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5138
+ * appEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Search);
5139
+ * ```
5140
+ * @example
5141
+ * ```js
5142
+ * // Download as PDF from liveboard context
5143
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5144
+ * liveboardEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Liveboard);
5145
+ * ```
4816
5146
  *
4817
5147
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4818
5148
  */
4819
5149
  DownloadAsPdf = "downloadAsPdf",
5150
+ /**
5151
+ * Trigger the **Download Liveboard as Continuous PDF** action on an
5152
+ * embedded Liveboard.
5153
+ *
5154
+ * @example
5155
+ * ```js
5156
+ * liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
5157
+ * ```
5158
+ *
5159
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5160
+ */
5161
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
4820
5162
  /**
4821
5163
  * Trigger the **AI Highlights** action on an embedded Liveboard
4822
5164
  *
@@ -4857,6 +5199,18 @@ export declare enum HostEvent {
4857
5199
  *
4858
5200
  * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
4859
5201
  * ```
5202
+ * @example
5203
+ * ```js
5204
+ * // Make a copy from answer context
5205
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5206
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Answer);
5207
+ * ```
5208
+ * @example
5209
+ * ```js
5210
+ * // Make a copy from search context
5211
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5212
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Search);
5213
+ * ```
4860
5214
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4861
5215
  */
4862
5216
  MakeACopy = "makeACopy",
@@ -4881,6 +5235,14 @@ export declare enum HostEvent {
4881
5235
  * ```js
4882
5236
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4883
5237
  * ```
5238
+ * @example
5239
+ * ```js
5240
+ * // Explore from liveboard context
5241
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5242
+ * liveboardEmbed.trigger(HostEvent.Explore, {
5243
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5244
+ * }, ContextType.Liveboard);
5245
+ * ```
4884
5246
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4885
5247
  */
4886
5248
  Explore = "explore",
@@ -4898,6 +5260,20 @@ export declare enum HostEvent {
4898
5260
  * ```js
4899
5261
  * searchEmbed.trigger(HostEvent.CreateMonitor)
4900
5262
  * ```
5263
+ * @example
5264
+ * ```js
5265
+ * // Create monitor from answer context
5266
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5267
+ * appEmbed.trigger(HostEvent.CreateMonitor, {}, ContextType.Answer);
5268
+ * ```
5269
+ * @example
5270
+ * ```js
5271
+ * // Create monitor from liveboard context
5272
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5273
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
5274
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5275
+ * }, ContextType.Liveboard);
5276
+ * ```
4901
5277
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4902
5278
  */
4903
5279
  CreateMonitor = "createMonitor",
@@ -4919,6 +5295,20 @@ export declare enum HostEvent {
4919
5295
  * ```js
4920
5296
  * vizEmbed.trigger(HostEvent.ManageMonitor)
4921
5297
  * ```
5298
+ * @example
5299
+ * ```js
5300
+ * // Manage monitor from answer context
5301
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5302
+ * appEmbed.trigger(HostEvent.ManageMonitor, {}, ContextType.Answer);
5303
+ * ```
5304
+ * @example
5305
+ * ```js
5306
+ * // Manage monitor from liveboard context
5307
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5308
+ * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
5309
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5310
+ * }, ContextType.Liveboard);
5311
+ * ```
4922
5312
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4923
5313
  */
4924
5314
  ManageMonitor = "manageMonitor",
@@ -4944,6 +5334,26 @@ export declare enum HostEvent {
4944
5334
  * ```js
4945
5335
  * spotterEmbed.trigger(HostEvent.Edit);
4946
5336
  * ```
5337
+ * @example
5338
+ * ```js
5339
+ * // Using context parameter to edit liveboard context
5340
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5341
+ * liveboardEmbed.trigger(HostEvent.Edit, {}, ContextType.Liveboard);
5342
+ * ```
5343
+ * @example
5344
+ * ```js
5345
+ * // Edit from search context
5346
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5347
+ * appEmbed.trigger(HostEvent.Edit, {}, ContextType.Search);
5348
+ * ```
5349
+ * * @example
5350
+ * ```js
5351
+ * // Edit from spotter context
5352
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5353
+ * appEmbed.trigger(HostEvent.Edit, {
5354
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5355
+ * }, ContextType.Spotter);
5356
+ * ```
4947
5357
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4948
5358
  */
4949
5359
  Edit = "edit",
@@ -4961,6 +5371,34 @@ export declare enum HostEvent {
4961
5371
  * ```js
4962
5372
  * vizEmbed.trigger(HostEvent.CopyLink)
4963
5373
  * ```
5374
+ * @example
5375
+ * ```js
5376
+ * // Copy link from liveboard context
5377
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5378
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
5379
+ * ```
5380
+ * @example
5381
+ * ```js
5382
+ * // Copy link from liveboard visualization context
5383
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5384
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
5385
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5386
+ * }, ContextType.Liveboard);
5387
+ * ```
5388
+ * @example
5389
+ * ```js
5390
+ * // Copy link from liveboard context
5391
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5392
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
5393
+ * ```
5394
+ * @example
5395
+ * ```js
5396
+ * // Copy link from liveboard visualization context
5397
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5398
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
5399
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5400
+ * }, ContextType.Liveboard);
5401
+ * ```
4964
5402
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4965
5403
  */
4966
5404
  CopyLink = "embedDocument",
@@ -4978,6 +5416,34 @@ export declare enum HostEvent {
4978
5416
  * ```js
4979
5417
  * vizEmbed.trigger(HostEvent.Present)
4980
5418
  * ```
5419
+ * @example
5420
+ * ```js
5421
+ * // Present from liveboard visualization context
5422
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5423
+ * liveboardEmbed.trigger(HostEvent.Present, {
5424
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5425
+ * }, ContextType.Liveboard);
5426
+ * ```
5427
+ * @example
5428
+ * ```js
5429
+ * // Present from liveboard context
5430
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5431
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5432
+ * ```
5433
+ * @example
5434
+ * ```js
5435
+ * // Present from liveboard visualization context
5436
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5437
+ * liveboardEmbed.trigger(HostEvent.Present, {
5438
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5439
+ * }, ContextType.Liveboard);
5440
+ * ```
5441
+ * @example
5442
+ * ```js
5443
+ * // Present from liveboard context
5444
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5445
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5446
+ * ```
4981
5447
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4982
5448
  */
4983
5449
  Present = "present",
@@ -5006,6 +5472,22 @@ export declare enum HostEvent {
5006
5472
  * tml.answer.search_query // TML representation of the search query
5007
5473
  * );
5008
5474
  * })
5475
+ * ```
5476
+ * @example
5477
+ * ```js
5478
+ * // Get TML from search context
5479
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5480
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
5481
+ * console.log(tml.answer.search_query);
5482
+ * });
5483
+ * ```
5484
+ * @example
5485
+ * ```js
5486
+ * // Get TML from search-answer context
5487
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5488
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
5489
+ * console.log(tml.answer);
5490
+ * });
5009
5491
  * ```
5010
5492
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5011
5493
  * @important
@@ -5027,6 +5509,20 @@ export declare enum HostEvent {
5027
5509
  * ```js
5028
5510
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
5029
5511
  * ```
5512
+ * @example
5513
+ * ```js
5514
+ * // Show underlying data from liveboard visualization context
5515
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5516
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {
5517
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5518
+ * }, ContextType.Liveboard);
5519
+ * ```
5520
+ * @example
5521
+ * ```js
5522
+ * // Show underlying data from search context
5523
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5524
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {}, ContextType.Search);
5525
+ * ```
5030
5526
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5031
5527
  */
5032
5528
  ShowUnderlyingData = "showUnderlyingData",
@@ -5044,6 +5540,18 @@ export declare enum HostEvent {
5044
5540
  * ```js
5045
5541
  * searchEmbed.trigger(HostEvent.Delete)
5046
5542
  * ```
5543
+ * @example
5544
+ * ```js
5545
+ * // Delete from liveboard context
5546
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5547
+ * liveboardEmbed.trigger(HostEvent.Delete, {}, ContextType.Liveboard);
5548
+ * ```
5549
+ * @example
5550
+ * ```js
5551
+ * // Delete from search context
5552
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5553
+ * appEmbed.trigger(HostEvent.Delete, {}, ContextType.Search);
5554
+ * ```
5047
5555
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5048
5556
  */
5049
5557
  Delete = "onDeleteAnswer",
@@ -5064,6 +5572,20 @@ export declare enum HostEvent {
5064
5572
  * ```js
5065
5573
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
5066
5574
  * ```
5575
+ * @example
5576
+ * ```js
5577
+ * // SpotIQ analyze from search-answer context
5578
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5579
+ * appEmbed.trigger(HostEvent.SpotIQAnalyze, { vizId: '730496d6-6903-4601-937e-2c691821af3c' }, ContextType.Search);
5580
+ * ```
5581
+ * @example
5582
+ * ```js
5583
+ * // SpotIQ analyze from search context
5584
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5585
+ * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {
5586
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5587
+ * }, ContextType.Liveboard);
5588
+ * ```
5067
5589
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5068
5590
  */
5069
5591
  SpotIQAnalyze = "spotIQAnalyze",
@@ -5115,6 +5637,12 @@ export declare enum HostEvent {
5115
5637
  *
5116
5638
  * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
5117
5639
  * ```
5640
+ * @example
5641
+ * ```js
5642
+ * // Download as PNG from search-answer context
5643
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5644
+ * appEmbed.trigger(HostEvent.DownloadAsPng, {}, ContextType.Search);
5645
+ * ```
5118
5646
  *
5119
5647
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
5120
5648
  */
@@ -5143,6 +5671,18 @@ export declare enum HostEvent {
5143
5671
  *
5144
5672
  * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
5145
5673
  * ```
5674
+ * @example
5675
+ * ```js
5676
+ * // Download as CSV from search-answer context
5677
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5678
+ * appEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
5679
+ * ```
5680
+ * @example
5681
+ * ```js
5682
+ * // Download as CSV from search context
5683
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5684
+ * searchEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
5685
+ * ```
5146
5686
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5147
5687
  */
5148
5688
  DownloadAsCsv = "downloadAsCSV",
@@ -5170,6 +5710,18 @@ export declare enum HostEvent {
5170
5710
  *
5171
5711
  * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
5172
5712
  * ```
5713
+ * @example
5714
+ * ```js
5715
+ * // Download as XLSX from answer context
5716
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5717
+ * appEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Answer);
5718
+ * ```
5719
+ * @example
5720
+ * ```js
5721
+ * // Download as XLSX from search context
5722
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5723
+ * searchEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Search);
5724
+ * ```
5173
5725
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5174
5726
  */
5175
5727
  DownloadAsXlsx = "downloadAsXLSX",
@@ -5183,6 +5735,18 @@ export declare enum HostEvent {
5183
5735
  * ```js
5184
5736
  * searchEmbed.trigger(HostEvent.Share)
5185
5737
  * ```
5738
+ * @example
5739
+ * ```js
5740
+ * // Share from Liveboard context
5741
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5742
+ * liveboardEmbed.trigger(HostEvent.Share, {}, ContextType.Liveboard);
5743
+ * ```
5744
+ * @example
5745
+ * ```js
5746
+ * // Share from search-answer context
5747
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5748
+ * appEmbed.trigger(HostEvent.Share, {}, ContextType.Search);
5749
+ * ```
5186
5750
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5187
5751
  */
5188
5752
  Share = "share",
@@ -5222,6 +5786,18 @@ export declare enum HostEvent {
5222
5786
  *
5223
5787
  * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
5224
5788
  * ```
5789
+ * @example
5790
+ * ```js
5791
+ * // Save from answer context
5792
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5793
+ * appEmbed.trigger(HostEvent.Save, {}, ContextType.Answer);
5794
+ * ```
5795
+ * @example
5796
+ * ```js
5797
+ * // Save from search context
5798
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5799
+ * searchEmbed.trigger(HostEvent.Save, {}, ContextType.Search);
5800
+ * ```
5225
5801
  *
5226
5802
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5227
5803
  */
@@ -5238,6 +5814,20 @@ export declare enum HostEvent {
5238
5814
  * ```js
5239
5815
  * vizEmbed.trigger(HostEvent.SyncToSheets)
5240
5816
  * ```
5817
+ * @example
5818
+ * ```js
5819
+ * // Sync to sheets from answer context
5820
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5821
+ * appEmbed.trigger(HostEvent.SyncToSheets, {}, ContextType.Answer);
5822
+ * ```
5823
+ * @example
5824
+ * ```js
5825
+ * // Sync to sheets from liveboard context
5826
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5827
+ * liveboardEmbed.trigger(HostEvent.SyncToSheets, {
5828
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5829
+ * }, ContextType.Liveboard);
5830
+ * ```
5241
5831
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5242
5832
  */
5243
5833
  SyncToSheets = "sync-to-sheets",
@@ -5254,6 +5844,20 @@ export declare enum HostEvent {
5254
5844
  * ```js
5255
5845
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
5256
5846
  * ```
5847
+ * @example
5848
+ * ```js
5849
+ * // Sync to other apps from answer context
5850
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5851
+ * appEmbed.trigger(HostEvent.SyncToOtherApps, {}, ContextType.Answer);
5852
+ * ```
5853
+ * @example
5854
+ * ```js
5855
+ * // Sync to other apps from liveboard context
5856
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5857
+ * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {
5858
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5859
+ * }, ContextType.Liveboard);
5860
+ * ```
5257
5861
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5258
5862
  */
5259
5863
  SyncToOtherApps = "sync-to-other-apps",
@@ -5270,6 +5874,20 @@ export declare enum HostEvent {
5270
5874
  * ```js
5271
5875
  * vizEmbed.trigger(HostEvent.ManagePipelines)
5272
5876
  * ```
5877
+ * @example
5878
+ * ```js
5879
+ * // Manage pipelines from answer context
5880
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5881
+ * appEmbed.trigger(HostEvent.ManagePipelines, {}, ContextType.Answer);
5882
+ * ```
5883
+ * @example
5884
+ * ```js
5885
+ * // Manage pipelines from liveboard context
5886
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5887
+ * liveboardEmbed.trigger(HostEvent.ManagePipelines, {
5888
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5889
+ * }, ContextType.Liveboard);
5890
+ * ```
5273
5891
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5274
5892
  */
5275
5893
  ManagePipelines = "manage-pipeline",
@@ -5282,6 +5900,12 @@ export declare enum HostEvent {
5282
5900
  * ```js
5283
5901
  * appEmbed.trigger(HostEvent.ResetSearch)
5284
5902
  * ```
5903
+ * @example
5904
+ * ```js
5905
+ * // Reset search from search context
5906
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5907
+ * searchEmbed.trigger(HostEvent.ResetSearch, {}, ContextType.Search);
5908
+ * ```
5285
5909
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
5286
5910
  */
5287
5911
  ResetSearch = "resetSearch",
@@ -5293,6 +5917,13 @@ export declare enum HostEvent {
5293
5917
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
5294
5918
  * console.log('data', data);
5295
5919
  * ```
5920
+ * @example
5921
+ * ```js
5922
+ * // Get filters from liveboard context
5923
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5924
+ * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
5925
+ * console.log('filters', data);
5926
+ * ```
5296
5927
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5297
5928
  */
5298
5929
  GetFilters = "getFilters",
@@ -5300,7 +5931,8 @@ export declare enum HostEvent {
5300
5931
  * Update one or several filters applied on a Liveboard.
5301
5932
  * @param - Includes the following keys:
5302
5933
  * - `filter`: A single filter object containing column name, filter operator, and
5303
- * values. - `filters`: Multiple filter objects with column name, filter operator,
5934
+ * values.
5935
+ * - `filters`: Multiple filter objects with column name, filter operator,
5304
5936
  * and values for each.
5305
5937
  *
5306
5938
  * Each filter object must include the following attributes:
@@ -5383,6 +6015,18 @@ export declare enum HostEvent {
5383
6015
  * }]
5384
6016
  * });
5385
6017
  * ```
6018
+ * @example
6019
+ * ```js
6020
+ * // Update filters from liveboard context
6021
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6022
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
6023
+ * filter: {
6024
+ * column: "item type",
6025
+ * oper: "IN",
6026
+ * values: ["shoes", "boots"]
6027
+ * }
6028
+ * }, ContextType.Liveboard);
6029
+ * ```
5386
6030
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5387
6031
  */
5388
6032
  UpdateFilters = "updateFilters",
@@ -5396,6 +6040,14 @@ export declare enum HostEvent {
5396
6040
  * );
5397
6041
  * })
5398
6042
  * ```
6043
+ * @example
6044
+ * ```js
6045
+ * // Get tabs from liveboard context
6046
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6047
+ * liveboardEmbed.trigger(HostEvent.GetTabs, {}, ContextType.Liveboard).then((tabDetails) => {
6048
+ * console.log('tabs', tabDetails);
6049
+ * });
6050
+ * ```
5399
6051
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5400
6052
  */
5401
6053
  GetTabs = "getTabs",
@@ -5409,6 +6061,15 @@ export declare enum HostEvent {
5409
6061
  * '430496d6-6903-4601-937e-2c691821af3c',
5410
6062
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
5411
6063
  * ```
6064
+ * @example
6065
+ * ```js
6066
+ * // Set visible tabs from liveboard context
6067
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6068
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
6069
+ * '430496d6-6903-4601-937e-2c691821af3c',
6070
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
6071
+ * ], ContextType.Liveboard);
6072
+ * ```
5412
6073
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5413
6074
  */
5414
6075
  SetVisibleTabs = "SetPinboardVisibleTabs",
@@ -5422,6 +6083,15 @@ export declare enum HostEvent {
5422
6083
  * '630496d6-6903-4601-937e-2c691821af3c',
5423
6084
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
5424
6085
  * ```
6086
+ * @example
6087
+ * ```js
6088
+ * // Set hidden tabs from liveboard context
6089
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6090
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
6091
+ * '630496d6-6903-4601-937e-2c691821af3c',
6092
+ * 'i547ec54-2a37-4516-a222-2b06719af726'
6093
+ * ], ContextType.Liveboard);
6094
+ * ```
5425
6095
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5426
6096
  */
5427
6097
  SetHiddenTabs = "SetPinboardHiddenTabs",
@@ -5498,13 +6168,24 @@ export declare enum HostEvent {
5498
6168
  UpdateCrossFilter = "UpdateCrossFilter",
5499
6169
  /**
5500
6170
  * Trigger reset action for a personalized Liveboard view.
6171
+ * This event is deprecated. Use {@link HostEvent.ResetLiveboardPersonalizedView} instead.
5501
6172
  * @example
5502
6173
  * ```js
5503
6174
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
5504
6175
  * ```
5505
6176
  * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
6177
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5506
6178
  */
5507
6179
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
6180
+ /**
6181
+ * Trigger reset action for a personalized Liveboard view.
6182
+ * @example
6183
+ * ```js
6184
+ * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalizedView);
6185
+ * ```
6186
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6187
+ */
6188
+ ResetLiveboardPersonalizedView = "ResetLiveboardPersonalisedView",
5508
6189
  /**
5509
6190
  * Triggers an action to update Parameter values on embedded
5510
6191
  * Answers, Liveboard, and Spotter answer in Edit mode.
@@ -5521,6 +6202,16 @@ export declare enum HostEvent {
5521
6202
  * isVisibleToUser: false
5522
6203
  * }])
5523
6204
  * ```
6205
+ * @example
6206
+ * ```js
6207
+ * // Update parameters from liveboard context
6208
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6209
+ * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
6210
+ * name: "Region Param",
6211
+ * value: "West",
6212
+ * isVisibleToUser: true
6213
+ * }], ContextType.Liveboard);
6214
+ * ```
5524
6215
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5525
6216
  */
5526
6217
  UpdateParameters = "UpdateParameters",
@@ -5540,18 +6231,77 @@ export declare enum HostEvent {
5540
6231
  * });
5541
6232
  *
5542
6233
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
6234
+ *```
6235
+ * @example
6236
+ * ```js
6237
+ * // Get parameters from liveboard context
6238
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6239
+ * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
6240
+ * console.log('parameters', parameters);
6241
+ * });
5543
6242
  * ```
5544
6243
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5545
6244
  */
5546
6245
  GetParameters = "GetParameters",
5547
6246
  /**
5548
6247
  * Triggers an event to update a personalized view of a Liveboard.
6248
+ * This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
5549
6249
  * ```js
5550
6250
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5551
6251
  * ```
6252
+ * @example
6253
+ * ```js
6254
+ * // Update personalized view from liveboard context
6255
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6256
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {
6257
+ * viewId: '1234'
6258
+ * }, ContextType.Liveboard);
6259
+ * ```
5552
6260
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
6261
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5553
6262
  */
5554
6263
  UpdatePersonalisedView = "UpdatePersonalisedView",
6264
+ /**
6265
+ * Triggers an event to update a personalized view of a Liveboard.
6266
+ * ```js
6267
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
6268
+ * ```
6269
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6270
+ */
6271
+ UpdatePersonalizedView = "UpdatePersonalisedView",
6272
+ /**
6273
+ * Triggers selection of a specific Personalized View on a
6274
+ * Liveboard without reloading the embed. Pass either a
6275
+ * `viewId` (GUID) or `viewName`. If both are provided, `viewId` takes precedence.
6276
+ * If neither is provided, the Liveboard resets to the original/default view.
6277
+ * When a `viewName` is provided and multiple views share
6278
+ * the same name, the first match is selected.
6279
+ * @example
6280
+ * ```js
6281
+ * liveboardEmbed.trigger(
6282
+ * HostEvent.SelectPersonalizedView,
6283
+ * { viewId: '2a021a12-1aed-425d-984b-141ee916ce72' },
6284
+ * )
6285
+ * ```
6286
+ * @example
6287
+ * ```js
6288
+ * // Select by name
6289
+ * liveboardEmbed.trigger(
6290
+ * HostEvent.SelectPersonalizedView,
6291
+ * { viewName: 'Dr Smith Cardiology' },
6292
+ * )
6293
+ * ```
6294
+ * @example
6295
+ * ```js
6296
+ * // Reset to default view
6297
+ * liveboardEmbed.trigger(
6298
+ * HostEvent.SelectPersonalizedView,
6299
+ * {},
6300
+ * )
6301
+ * ```
6302
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6303
+ */
6304
+ SelectPersonalizedView = "SelectPersonalisedView",
5555
6305
  /**
5556
6306
  * @hidden
5557
6307
  * Notify when info call is completed successfully
@@ -5571,7 +6321,8 @@ export declare enum HostEvent {
5571
6321
  * add a name and description for the Answer.
5572
6322
  * @param - Includes the following keys:
5573
6323
  * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
5574
- * embed. - `name`: Optional. Name string for the Answer.
6324
+ * embed.
6325
+ * - `name`: Optional. Name string for the Answer.
5575
6326
  * - `description`: Optional. Description text for the Answer.
5576
6327
  * @example
5577
6328
  * ```js
@@ -5590,6 +6341,34 @@ export declare enum HostEvent {
5590
6341
  *
5591
6342
  * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
5592
6343
  * ```
6344
+ * @example
6345
+ * ```js
6346
+ * // Using context parameter to save answer from search context
6347
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6348
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6349
+ * name: "Regional sales analysis",
6350
+ * description: "Sales breakdown by region"
6351
+ * }, ContextType.Search);
6352
+ * ```
6353
+ * @example
6354
+ * ```js
6355
+ * // Save answer from answer context (explore modal)
6356
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6357
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6358
+ * name: "Modified analysis",
6359
+ * description: "Updated from explore view"
6360
+ * }, ContextType.Answer);
6361
+ * ```
6362
+ * @example
6363
+ * ```js
6364
+ * // Save answer from spotter context
6365
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6366
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6367
+ * vizId: latestSpotterVizId,
6368
+ * name: "AI insights",
6369
+ * description: "Generated from Spotter"
6370
+ * }, ContextType.Spotter);
6371
+ * ```
5593
6372
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5594
6373
  */
5595
6374
  SaveAnswer = "saveAnswer",
@@ -5631,6 +6410,15 @@ export declare enum HostEvent {
5631
6410
  * executeSearch: true,
5632
6411
  * })
5633
6412
  * ```
6413
+ * @example
6414
+ * ```js
6415
+ * // Spotter search from spotter context
6416
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6417
+ * spotterEmbed.trigger(HostEvent.SpotterSearch, {
6418
+ * query: 'sales by region',
6419
+ * executeSearch: true
6420
+ * }, ContextType.Spotter);
6421
+ * ```
5634
6422
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5635
6423
  */
5636
6424
  SpotterSearch = "SpotterSearch",
@@ -5641,6 +6429,12 @@ export declare enum HostEvent {
5641
6429
  * ```js
5642
6430
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
5643
6431
  * ```
6432
+ * @example
6433
+ * ```js
6434
+ * // Edit last prompt from spotter context
6435
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6436
+ * spotterEmbed.trigger(HostEvent.EditLastPrompt, "sales by region", ContextType.Spotter);
6437
+ * ```
5644
6438
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5645
6439
  */
5646
6440
  EditLastPrompt = "EditLastPrompt",
@@ -5650,6 +6444,12 @@ export declare enum HostEvent {
5650
6444
  * ```js
5651
6445
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
5652
6446
  * ```
6447
+ * @example
6448
+ * ```js
6449
+ * // Preview spotter data from spotter context
6450
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6451
+ * spotterEmbed.trigger(HostEvent.PreviewSpotterData, {}, ContextType.Spotter);
6452
+ * ```
5653
6453
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5654
6454
  */
5655
6455
  PreviewSpotterData = "PreviewSpotterData",
@@ -6111,6 +6911,16 @@ export declare enum Action {
6111
6911
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
6112
6912
  */
6113
6913
  DownloadLiveboard = "downloadLiveboard",
6914
+ /**
6915
+ * The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
6916
+ * Allows downloading the entire Liveboard as a continuous PDF.
6917
+ * @example
6918
+ * ```js
6919
+ * disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
6920
+ * ```
6921
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6922
+ */
6923
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
6114
6924
  /**
6115
6925
  * @hidden
6116
6926
  */
@@ -6744,13 +7554,25 @@ export declare enum Action {
6744
7554
  /**
6745
7555
  * The Liveboard Personalised Views dropdown.
6746
7556
  * Allows navigating to a personalized Liveboard View.
7557
+ * This action is deprecated. Use {@link Action.PersonalizedViewsDropdown} instead.
6747
7558
  * @example
6748
7559
  * ```js
6749
7560
  * disabledActions: [Action.PersonalisedViewsDropdown]
6750
7561
  * ```
6751
7562
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
7563
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6752
7564
  */
6753
7565
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
7566
+ /**
7567
+ * The Liveboard Personalized Views dropdown.
7568
+ * Allows navigating to a personalized Liveboard View.
7569
+ * @example
7570
+ * ```js
7571
+ * disabledActions: [Action.PersonalizedViewsDropdown]
7572
+ * ```
7573
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7574
+ */
7575
+ PersonalizedViewsDropdown = "personalisedViewsDropdown",
6754
7576
  /**
6755
7577
  * Action ID for show or hide the user details on a
6756
7578
  * Liveboard (Recently visited / social proof)
@@ -6838,14 +7660,27 @@ export declare enum Action {
6838
7660
  /**
6839
7661
  * The **Organize Favourites** action on Homepage
6840
7662
  * *Favorites* module.
7663
+ * This action is deprecated. Use {@link Action.OrganizeFavorites} instead.
6841
7664
  *
6842
7665
  * @example
6843
7666
  * ```js
6844
7667
  * disabledActions: [Action.OrganiseFavourites]
6845
7668
  * ```
6846
7669
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
7670
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6847
7671
  */
6848
7672
  OrganiseFavourites = "organiseFavourites",
7673
+ /**
7674
+ * The **Organize Favorites** action on Homepage
7675
+ * *Favorites* module.
7676
+ *
7677
+ * @example
7678
+ * ```js
7679
+ * disabledActions: [Action.OrganizeFavorites]
7680
+ * ```
7681
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7682
+ */
7683
+ OrganizeFavorites = "organiseFavourites",
6849
7684
  /**
6850
7685
  * The **AI Highlights** action on a Liveboard.
6851
7686
  *
@@ -7301,6 +8136,39 @@ export declare enum Action {
7301
8136
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7302
8137
  */
7303
8138
  SpotterDocs = "spotterDocs",
8139
+ /**
8140
+ * Controls visibility and disable state of the connector resources
8141
+ * section in the Spotter chat interface.
8142
+ * @example
8143
+ * ```js
8144
+ * hiddenActions: [Action.SpotterChatConnectorResources]
8145
+ * disabledActions: [Action.SpotterChatConnectorResources]
8146
+ * ```
8147
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8148
+ */
8149
+ SpotterChatConnectorResources = "spotterChatConnectorResources",
8150
+ /**
8151
+ * Controls visibility and disable state of the connectors
8152
+ * in the Spotter chat interface.
8153
+ * @example
8154
+ * ```js
8155
+ * hiddenActions: [Action.SpotterChatConnectors]
8156
+ * disabledActions: [Action.SpotterChatConnectors]
8157
+ * ```
8158
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8159
+ */
8160
+ SpotterChatConnectors = "spotterChatConnectors",
8161
+ /**
8162
+ * Controls visibility and disable state of the mode switcher
8163
+ * in the Spotter chat interface.
8164
+ * @example
8165
+ * ```js
8166
+ * hiddenActions: [Action.SpotterChatModeSwitcher]
8167
+ * disabledActions: [Action.SpotterChatModeSwitcher]
8168
+ * ```
8169
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8170
+ */
8171
+ SpotterChatModeSwitcher = "spotterChatModeSwitcher",
7304
8172
  /**
7305
8173
  * The **Include current period** checkbox for date filters.
7306
8174
  * Controls the visibility and availability of the option to include
@@ -7545,7 +8413,13 @@ declare enum EmbedErrorCodes {
7545
8413
  /** Failed to update embed parameters during pre-render */
7546
8414
  UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
7547
8415
  /** Invalid URL provided in configuration */
7548
- INVALID_URL = "INVALID_URL"
8416
+ INVALID_URL = "INVALID_URL",
8417
+ /** Host event payload validation failed */
8418
+ HOST_EVENT_VALIDATION = "HOST_EVENT_VALIDATION",
8419
+ /** UpdateFilters payload is invalid - missing or malformed filter/filters */
8420
+ UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
8421
+ /** DrillDown payload is invalid - missing or malformed points */
8422
+ DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
7549
8423
  }
7550
8424
  /**
7551
8425
  * Error event object emitted when an error occurs in an embedded component.
@@ -7558,7 +8432,8 @@ declare enum EmbedErrorCodes {
7558
8432
  *
7559
8433
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
7560
8434
  * - **message**: Human-readable error description (string or array of strings for
7561
- * multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
8435
+ * multiple errors)
8436
+ * - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
7562
8437
  * values
7563
8438
  * - **[key: string]**: Additional context-specific for backward compatibility
7564
8439
  *
@@ -7622,7 +8497,11 @@ declare enum ContextType {
7622
8497
  /**
7623
8498
  * Spotter context for spotter modal/page.
7624
8499
  */
7625
- Spotter = "spotter"
8500
+ Spotter = "spotter",
8501
+ /**
8502
+ * Other context for any other generic page.
8503
+ */
8504
+ Other = "other"
7626
8505
  }
7627
8506
  export interface DefaultAppInitData {
7628
8507
  customisations: CustomisationsInterface;
@@ -7722,33 +8601,6 @@ export interface ObjectIds {
7722
8601
  */
7723
8602
  modalTitle?: string;
7724
8603
  }
7725
- /**
7726
- * Context object for the embedded component.
7727
- * @example
7728
- * ```js
7729
- * const context = await embed.getCurrentContext();
7730
- * console.log(context);
7731
- * {
7732
- * stack: [
7733
- * {
7734
- * name: 'Liveboard',
7735
- * type: ContextType.Liveboard,
7736
- * objectIds: {
7737
- * liveboardId: '123',
7738
- * },
7739
- * },
7740
- * ],
7741
- * currentContext: {
7742
- * name: 'Liveboard',
7743
- * type: ContextType.Liveboard,
7744
- * objectIds: {
7745
- * liveboardId: '123',
7746
- * },
7747
- * },
7748
- * }
7749
- * ```
7750
- * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
7751
- */
7752
8604
  export interface ContextObject {
7753
8605
  /**
7754
8606
  * Stack of context objects.
@@ -7798,7 +8650,8 @@ declare enum AuthFailureType {
7798
8650
  /**
7799
8651
  * The current authentication token or session has expired.
7800
8652
  *
7801
- * Emitted when the embed receives an auth-expiry signal and starts auth refresh handling.
8653
+ * Emitted when the embed receives an auth-expiry signal and starts auth refresh
8654
+ * handling.
7802
8655
  */
7803
8656
  EXPIRY = "EXPIRY",
7804
8657
  /**
@@ -7926,6 +8779,11 @@ declare enum AuthEvent {
7926
8779
  */
7927
8780
  TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
7928
8781
  }
8782
+ export interface LiveboardTab {
8783
+ id: string;
8784
+ name: string;
8785
+ [key: string]: any;
8786
+ }
7929
8787
  declare enum UIPassthroughEvent {
7930
8788
  PinAnswerToLiveboard = "addVizToPinboard",
7931
8789
  SaveAnswer = "saveAnswer",
@@ -7933,7 +8791,16 @@ declare enum UIPassthroughEvent {
7933
8791
  GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
7934
8792
  GetAnswerConfig = "getAnswerPageConfig",
7935
8793
  GetLiveboardConfig = "getPinboardPageConfig",
7936
- GetUnsavedAnswerTML = "getUnsavedAnswerTML"
8794
+ GetUnsavedAnswerTML = "getUnsavedAnswerTML",
8795
+ UpdateFilters = "updateFilters",
8796
+ Drilldown = "drillDown",
8797
+ GetAnswerSession = "getAnswerSession",
8798
+ GetFilters = "getFilters",
8799
+ GetIframeUrl = "getIframeUrl",
8800
+ GetParameters = "getParameters",
8801
+ GetTML = "getTML",
8802
+ GetTabs = "getTabs",
8803
+ GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
7937
8804
  }
7938
8805
  export type UIPassthroughContractBase = {
7939
8806
  [UIPassthroughEvent.PinAnswerToLiveboard]: {
@@ -7997,17 +8864,104 @@ export type UIPassthroughContractBase = {
7997
8864
  tml: string;
7998
8865
  };
7999
8866
  };
8867
+ [UIPassthroughEvent.GetAnswerSession]: {
8868
+ request: {
8869
+ vizId?: string;
8870
+ };
8871
+ response: {
8872
+ session: SessionInterface;
8873
+ embedAnswerData?: Record<string, any>;
8874
+ };
8875
+ };
8876
+ [UIPassthroughEvent.GetFilters]: {
8877
+ request: {
8878
+ vizId?: string;
8879
+ };
8880
+ response: {
8881
+ liveboardFilters: Record<string, any>[];
8882
+ runtimeFilters: RuntimeFilter[];
8883
+ };
8884
+ };
8885
+ [UIPassthroughEvent.GetIframeUrl]: {
8886
+ request: Record<string, never>;
8887
+ response: {
8888
+ iframeUrl: string;
8889
+ };
8890
+ };
8891
+ [UIPassthroughEvent.GetParameters]: {
8892
+ request: Record<string, never>;
8893
+ response: {
8894
+ parameters: Record<string, any>[];
8895
+ };
8896
+ };
8897
+ [UIPassthroughEvent.GetTML]: {
8898
+ request: {
8899
+ vizId?: string;
8900
+ includeNonExecutedSearchTokens?: boolean;
8901
+ };
8902
+ response: Record<string, any>;
8903
+ };
8904
+ [UIPassthroughEvent.GetTabs]: {
8905
+ request: Record<string, never>;
8906
+ response: {
8907
+ orderedTabIds: string[];
8908
+ numberOfTabs: number;
8909
+ Tabs: LiveboardTab[];
8910
+ };
8911
+ };
8912
+ [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
8913
+ request: Record<string, never>;
8914
+ response: {
8915
+ v2Content: string;
8916
+ };
8917
+ };
8918
+ [UIPassthroughEvent.UpdateFilters]: {
8919
+ request: {
8920
+ filter?: {
8921
+ column: string;
8922
+ oper: string;
8923
+ values: string[];
8924
+ type?: string;
8925
+ };
8926
+ filters?: {
8927
+ column: string;
8928
+ oper: string;
8929
+ values: string[];
8930
+ type?: string;
8931
+ }[];
8932
+ };
8933
+ response: unknown;
8934
+ };
8935
+ [UIPassthroughEvent.Drilldown]: {
8936
+ request: {
8937
+ points: {
8938
+ selectedPoints?: string[];
8939
+ clickedPoint?: string;
8940
+ };
8941
+ columnGuid?: string;
8942
+ autoDrillDown?: boolean;
8943
+ vizId?: string;
8944
+ };
8945
+ response: unknown;
8946
+ };
8000
8947
  };
8001
8948
  export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
8002
8949
  export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
8003
8950
  export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> = Array<{
8004
- redId?: string;
8951
+ refId?: string;
8005
8952
  value?: UIPassthroughResponse<ApiName>;
8006
8953
  error?: any;
8007
8954
  }>;
8008
8955
  export type EmbedApiHostEventMapping = {
8009
8956
  [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
8010
8957
  [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
8958
+ [HostEvent.GetAnswerSession]: UIPassthroughEvent.GetAnswerSession;
8959
+ [HostEvent.GetFilters]: UIPassthroughEvent.GetFilters;
8960
+ [HostEvent.GetIframeUrl]: UIPassthroughEvent.GetIframeUrl;
8961
+ [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
8962
+ [HostEvent.GetTML]: UIPassthroughEvent.GetTML;
8963
+ [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
8964
+ [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
8011
8965
  };
8012
8966
  export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
8013
8967
  export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
@@ -8015,6 +8969,12 @@ export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT |
8015
8969
  export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
8016
8970
  declare class HostEventClient {
8017
8971
  iFrame: HTMLIFrameElement;
8972
+ /** Cached list of available UI passthrough keys from the embedded app */
8973
+ private availablePassthroughKeysCache;
8974
+ /** Host events with custom handlers
8975
+ * (setters or special logic) -
8976
+ * bound to instance for protected method access */
8977
+ private readonly customHandlers;
8018
8978
  constructor(iFrame?: HTMLIFrameElement);
8019
8979
  /**
8020
8980
  * A wrapper over process trigger to
@@ -8025,14 +8985,36 @@ declare class HostEventClient {
8025
8985
  protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
8026
8986
  handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
8027
8987
  hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
8988
+ /**
8989
+ * For getter events that return data. Tries UI passthrough first;
8990
+ * if the app doesn't support it (no response data), falls back to
8991
+ * the legacy host event channel. Real errors are thrown as-is.
8992
+ */
8993
+ private getDataWithPassthroughFallback;
8028
8994
  /**
8029
8995
  * Setter for the iframe element used for host events
8030
8996
  * @param {HTMLIFrameElement} iFrame - the iframe element to set
8031
8997
  */
8032
8998
  setIframeElement(iFrame: HTMLIFrameElement): void;
8999
+ /**
9000
+ * Fetches the list of available UI passthrough keys from the embedded app.
9001
+ * Result is cached for the session. Returns empty array on failure.
9002
+ */
9003
+ private getAvailableUIPassthroughKeys;
8033
9004
  triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
8034
9005
  protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
8035
9006
  protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
9007
+ protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
9008
+ protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
9009
+ /**
9010
+ * Dispatches a host event using the appropriate channel:
9011
+ * 1. If the embedded app supports UI passthrough for this event, use it (custom handler or getter).
9012
+ * 2. Otherwise fall back to the legacy host event channel.
9013
+ *
9014
+ * @param hostEvent - The host event to trigger
9015
+ * @param payload - Optional payload for the event
9016
+ * @param context - Optional context (e.g. vizId) for scoped operations
9017
+ */
8036
9018
  triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
8037
9019
  }
8038
9020
  declare class TsEmbed {
@@ -8368,7 +9350,21 @@ declare class TsEmbed {
8368
9350
  * Triggers an event to the embedded app
8369
9351
  * @param {HostEvent} messageType The event type
8370
9352
  * @param {any} data The payload to send with the message
9353
+ * @param {ContextType} context Optional context type to specify the context from which the event is triggered.
9354
+ * Use ContextType.Search for search answer context, ContextType.Answer for answer/explore context,
9355
+ * ContextType.Liveboard for liveboard context, or ContextType.Spotter for spotter context.
9356
+ * Available from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl
8371
9357
  * @returns A promise that resolves with the response from the embedded app
9358
+ * @example
9359
+ * ```js
9360
+ * // Trigger Pin event with context (SDK: 1.45.2+)
9361
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
9362
+ * embed.trigger(HostEvent.Pin, {
9363
+ * vizId: "123",
9364
+ * liveboardId: "456"
9365
+ * }, ContextType.Search);
9366
+ * ```
9367
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl (for context parameter)
8372
9368
  */
8373
9369
  trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
8374
9370
  /**
@@ -8389,8 +9385,33 @@ declare class TsEmbed {
8389
9385
  getIframeSrc(): string;
8390
9386
  protected handleRenderForPrerender(): Promise<TsEmbed>;
8391
9387
  /**
8392
- * Get the current context of the embedded TS component.
8393
- * @returns The current context object containing the page type and object ids.
9388
+ * Context object for the embedded component.
9389
+ * @returns {ContextObject} The current context object containing the page type and object ids.
9390
+ * @example
9391
+ * ```js
9392
+ * const context = await embed.getCurrentContext();
9393
+ * console.log(context);
9394
+ *
9395
+ * // Example output
9396
+ * {
9397
+ * stack: [
9398
+ * {
9399
+ * name: 'Liveboard',
9400
+ * type: ContextType.Liveboard,
9401
+ * objectIds: {
9402
+ * liveboardId: '123',
9403
+ * },
9404
+ * },
9405
+ * ],
9406
+ * currentContext: {
9407
+ * name: 'Liveboard',
9408
+ * type: ContextType.Liveboard,
9409
+ * objectIds: {
9410
+ * liveboardId: '123',
9411
+ * },
9412
+ * },
9413
+ * }
9414
+ * ```
8394
9415
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
8395
9416
  */
8396
9417
  getCurrentContext(): Promise<ContextObject>;
@@ -9415,9 +10436,31 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9415
10436
  */
9416
10437
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
9417
10438
  }
10439
+ /**
10440
+ * APP_INIT data shape for SpotterEmbed.
10441
+ * @internal
10442
+ */
10443
+ export interface SpotterAppInitData extends DefaultAppInitData {
10444
+ embedParams?: {
10445
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
10446
+ };
10447
+ }
9418
10448
  declare class SpotterEmbed extends TsEmbed {
9419
10449
  protected viewConfig: SpotterEmbedViewConfig;
9420
10450
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
10451
+ /**
10452
+ * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
10453
+ * so the conv-assist app can read sidebar configuration on initialisation.
10454
+ *
10455
+ * Precedence for `enablePastConversationsSidebar`:
10456
+ * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
10457
+ * deprecated top-level `enablePastConversationsSidebar` flag; if the former
10458
+ * is absent the latter is used as a fallback.
10459
+ *
10460
+ * An invalid `spotterDocumentationUrl` triggers a validation error and is
10461
+ * excluded from the payload rather than forwarded to the app.
10462
+ */
10463
+ protected getAppInitData(): Promise<SpotterAppInitData>;
9421
10464
  protected getEmbedParamsObject(): Record<any, any>;
9422
10465
  getIframeSrc(): string;
9423
10466
  render(): Promise<SpotterEmbed>;
@@ -9962,6 +11005,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9962
11005
  * ```
9963
11006
  */
9964
11007
  isPNGInScheduledEmailsEnabled?: boolean;
11008
+ /**
11009
+ * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
11010
+ * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
11011
+ * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
11012
+ *
11013
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
11014
+ * @type {boolean}
11015
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11016
+ * @example
11017
+ * ```js
11018
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
11019
+ * const embed = new <EmbedComponent>('#tsEmbed', {
11020
+ * ... // other embed view config
11021
+ * isContinuousLiveboardPDFEnabled: true,
11022
+ * })
11023
+ * ```
11024
+ */
11025
+ isContinuousLiveboardPDFEnabled?: boolean;
9965
11026
  /**
9966
11027
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
9967
11028
  *
@@ -10130,10 +11191,32 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10130
11191
  */
10131
11192
  enableHomepageAnnouncement?: boolean;
10132
11193
  }
11194
+ /**
11195
+ * APP_INIT data shape for AppEmbed.
11196
+ * @internal
11197
+ */
11198
+ export interface AppEmbedAppInitData extends DefaultAppInitData {
11199
+ embedParams?: {
11200
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
11201
+ };
11202
+ }
10133
11203
  declare class AppEmbed extends V1Embed {
10134
11204
  protected viewConfig: AppViewConfig;
10135
11205
  private defaultHeight;
10136
11206
  constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
11207
+ /**
11208
+ * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
11209
+ * so the conv-assist app can read sidebar configuration on initialisation.
11210
+ *
11211
+ * Precedence for `enablePastConversationsSidebar`:
11212
+ * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
11213
+ * deprecated top-level `enablePastConversationsSidebar` flag; if the former
11214
+ * is absent the latter is used as a fallback.
11215
+ *
11216
+ * An invalid `spotterDocumentationUrl` triggers a validation error and is
11217
+ * excluded from the payload rather than forwarded to the app.
11218
+ */
11219
+ protected getAppInitData(): Promise<AppEmbedAppInitData>;
10137
11220
  /**
10138
11221
  * Constructs a map of parameters to be passed on to the
10139
11222
  * embedded Liveboard or visualization.
@@ -10551,6 +11634,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10551
11634
  * ```
10552
11635
  */
10553
11636
  isPNGInScheduledEmailsEnabled?: boolean;
11637
+ /**
11638
+ * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
11639
+ * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
11640
+ * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
11641
+ *
11642
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
11643
+ * @type {boolean}
11644
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11645
+ * @example
11646
+ * ```js
11647
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
11648
+ * const embed = new <EmbedComponent>('#tsEmbed', {
11649
+ * ... // other embed view config
11650
+ * isContinuousLiveboardPDFEnabled: true,
11651
+ * })
11652
+ * ```
11653
+ */
11654
+ isContinuousLiveboardPDFEnabled?: boolean;
10554
11655
  /**
10555
11656
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
10556
11657
  *