@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;
@@ -3526,6 +3596,17 @@ export declare enum EmbedEvent {
3526
3596
  * ```
3527
3597
  */
3528
3598
  DownloadAsXlsx = "downloadAsXlsx",
3599
+ /**
3600
+ * Emitted when the Download Liveboard as Continuous PDF action is triggered
3601
+ * on a Liveboard.
3602
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3603
+ * @example
3604
+ * ```js
3605
+ * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
3606
+ * console.log('download liveboard as continuous PDF', payload)})
3607
+ * ```
3608
+ */
3609
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
3529
3610
  /**
3530
3611
  * Emitted when an Answer is deleted in the app
3531
3612
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
@@ -3929,22 +4010,45 @@ export declare enum EmbedEvent {
3929
4010
  /**
3930
4011
  * Emitted when name, status (private or public) or filter values of a
3931
4012
  * Personalised view is updated.
4013
+ * This event is deprecated. Use {@link EmbedEvent.UpdatePersonalizedView} instead.
3932
4014
  * @returns viewName: string
3933
4015
  * @returns viewId: string
3934
4016
  * @returns liveboardId: string
3935
4017
  * @returns isPublic: boolean
3936
4018
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4019
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3937
4020
  */
3938
4021
  UpdatePersonalisedView = "updatePersonalisedView",
4022
+ /**
4023
+ * Emitted when name, status (private or public) or filter values of a
4024
+ * Personalized view is updated.
4025
+ * @returns viewName: string
4026
+ * @returns viewId: string
4027
+ * @returns liveboardId: string
4028
+ * @returns isPublic: boolean
4029
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4030
+ */
4031
+ UpdatePersonalizedView = "updatePersonalisedView",
3939
4032
  /**
3940
4033
  * Emitted when a Personalised view is saved.
4034
+ * This event is deprecated. Use {@link EmbedEvent.SavePersonalizedView} instead.
3941
4035
  * @returns viewName: string
3942
4036
  * @returns viewId: string
3943
4037
  * @returns liveboardId: string
3944
4038
  * @returns isPublic: boolean
3945
4039
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4040
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3946
4041
  */
3947
4042
  SavePersonalisedView = "savePersonalisedView",
4043
+ /**
4044
+ * Emitted when a Personalized view is saved.
4045
+ * @returns viewName: string
4046
+ * @returns viewId: string
4047
+ * @returns liveboardId: string
4048
+ * @returns isPublic: boolean
4049
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4050
+ */
4051
+ SavePersonalizedView = "savePersonalisedView",
3948
4052
  /**
3949
4053
  * Emitted when a Liveboard is reset.
3950
4054
  * @returns viewName: string
@@ -3956,11 +4060,41 @@ export declare enum EmbedEvent {
3956
4060
  ResetLiveboard = "resetLiveboard",
3957
4061
  /**
3958
4062
  * Emitted when a PersonalisedView is deleted.
4063
+ * This event is deprecated. Use {@link EmbedEvent.DeletePersonalizedView} instead.
3959
4064
  * @returns views: string[]
3960
4065
  * @returns liveboardId: string
3961
4066
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4067
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3962
4068
  */
3963
4069
  DeletePersonalisedView = "deletePersonalisedView",
4070
+ /**
4071
+ * Emitted when a PersonalizedView is deleted.
4072
+ * @returns views: string[]
4073
+ * @returns liveboardId: string
4074
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4075
+ */
4076
+ DeletePersonalizedView = "deletePersonalisedView",
4077
+ /**
4078
+ * Emitted when a user selects a different Personalized View or
4079
+ * resets to the original/default view on a Liveboard.
4080
+ * @example
4081
+ * ```js
4082
+ * liveboardEmbed.on(EmbedEvent.ChangePersonalizedView, (data) => {
4083
+ * console.log(data.viewName); // 'Q4 Revenue' or 'Original View'
4084
+ * console.log(data.viewId); // '2a021a12-...' or null (default)
4085
+ * console.log(data.liveboardId); // 'abc123...'
4086
+ * console.log(data.isPublic); // true | false
4087
+ * })
4088
+ * ```
4089
+ * @returns viewName: string - Name of the selected view,
4090
+ * or 'Original View' when reset to default.
4091
+ * @returns viewId: string | null - GUID of the selected view,
4092
+ * or null when reset to default.
4093
+ * @returns liveboardId: string
4094
+ * @returns isPublic: boolean
4095
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4096
+ */
4097
+ ChangePersonalizedView = "changePersonalisedView",
3964
4098
  /**
3965
4099
  * Emitted when a user creates a Worksheet.
3966
4100
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
@@ -3994,7 +4128,8 @@ export declare enum EmbedEvent {
3994
4128
  * @param - Includes the following parameters:
3995
4129
  * - `payload`: The payload received from the embed related to the Data API call.
3996
4130
  * - `responder`: Contains elements that let developers define whether ThoughtSpot
3997
- * will run or block the search operation, and if blocked, which error message to provide.
4131
+ * will run or block the search operation, and if blocked, which error message to
4132
+ * provide.
3998
4133
  * - `execute` - When `execute` returns `true`, the search is run.
3999
4134
  * When `execute` returns `false`, the search is not executed.
4000
4135
  * - `error` - Developers can customize the user-facing error message when `execute`
@@ -4428,6 +4563,25 @@ export declare enum EmbedEvent {
4428
4563
  * );
4429
4564
  * }
4430
4565
  * ```
4566
+ *
4567
+ * **Context Parameter (SDK: 1.45.2+)**
4568
+ *
4569
+ * Starting from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl, you can optionally pass a
4570
+ * `ContextType` as the third parameter to the `trigger` method to specify the context
4571
+ * from which the event is triggered. This helps ThoughtSpot understand the current page
4572
+ * context (Search, Answer, Liveboard, or Spotter) for better event handling.
4573
+ *
4574
+ * @example
4575
+ * ```js
4576
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
4577
+ *
4578
+ * // Trigger Pin event with Search context
4579
+ * appEmbed.trigger(HostEvent.Pin, {
4580
+ * vizId: "123",
4581
+ * liveboardId: "456"
4582
+ * }, ContextType.Search);
4583
+ * ```
4584
+ *
4431
4585
  * @group Events
4432
4586
  */
4433
4587
  export declare enum HostEvent {
@@ -4449,6 +4603,16 @@ export declare enum HostEvent {
4449
4603
  execute: true
4450
4604
  });
4451
4605
  * ```
4606
+ * @example
4607
+ * ```js
4608
+ * // Trigger search from search context
4609
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4610
+ * appEmbed.trigger(HostEvent.Search, {
4611
+ * searchQuery: "[revenue] by [region]",
4612
+ * dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
4613
+ * execute: true
4614
+ * }, ContextType.Search);
4615
+ * ```
4452
4616
  */
4453
4617
  Search = "search",
4454
4618
  /**
@@ -4499,6 +4663,24 @@ export declare enum HostEvent {
4499
4663
  * });
4500
4664
  * })
4501
4665
  * ```
4666
+ * @example
4667
+ * ```js
4668
+ * // Drill down from answer context
4669
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4670
+ * appEmbed.trigger(HostEvent.DrillDown, {
4671
+ * points: { clickedPoint, selectedPoints },
4672
+ * autoDrillDown: true
4673
+ * }, ContextType.Answer);
4674
+ * ```
4675
+ * @example
4676
+ * ```js
4677
+ * // Drill down from search context
4678
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4679
+ * searchEmbed.trigger(HostEvent.DrillDown, {
4680
+ * points: { clickedPoint, selectedPoints },
4681
+ * columnGuid: "column-guid"
4682
+ * }, ContextType.Search);
4683
+ * ```
4502
4684
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
4503
4685
  */
4504
4686
  DrillDown = "triggerDrillDown",
@@ -4519,6 +4701,13 @@ export declare enum HostEvent {
4519
4701
  * const url = embed.trigger(HostEvent.GetIframeUrl);
4520
4702
  * console.log("iFrameURL",url);
4521
4703
  * ```
4704
+ * @example
4705
+ * ```js
4706
+ * // Get iframe URL from specific context
4707
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4708
+ * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
4709
+ * console.log("iFrameURL", url);
4710
+ * ```
4522
4711
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4523
4712
  */
4524
4713
  GetIframeUrl = "GetIframeUrl",
@@ -4532,6 +4721,15 @@ export declare enum HostEvent {
4532
4721
  * '730496d6-6903-4601-937e-2c691821af3c',
4533
4722
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
4534
4723
  * ```
4724
+ * @example
4725
+ * ```js
4726
+ * // Set visible vizs from liveboard context
4727
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4728
+ * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
4729
+ * '730496d6-6903-4601-937e-2c691821af3c',
4730
+ * 'd547ec54-2a37-4516-a222-2b06719af726'
4731
+ * ], ContextType.Liveboard);
4732
+ * ```
4535
4733
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
4536
4734
  */
4537
4735
  SetVisibleVizs = "SetPinboardVisibleVizs",
@@ -4544,6 +4742,14 @@ export declare enum HostEvent {
4544
4742
  * tabId:'730496d6-6903-4601-937e-2c691821af3c'
4545
4743
  * })
4546
4744
  * ```
4745
+ * @example
4746
+ * ```js
4747
+ * // Set active tab from liveboard context
4748
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4749
+ * liveboardEmbed.trigger(HostEvent.SetActiveTab, {
4750
+ * tabId: '730496d6-6903-4601-937e-2c691821af3c'
4751
+ * }, ContextType.Liveboard);
4752
+ * ```
4547
4753
  * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw
4548
4754
  */
4549
4755
  SetActiveTab = "SetActiveTab",
@@ -4577,6 +4783,15 @@ export declare enum HostEvent {
4577
4783
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
4578
4784
  * ])
4579
4785
  * ```
4786
+ * @example
4787
+ * ```js
4788
+ * // Update runtime filters from liveboard context
4789
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4790
+ * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
4791
+ * {columnName: "region", operator: RuntimeFilterOp.EQ, values: ["west"]},
4792
+ * {columnName: "product", operator: RuntimeFilterOp.IN, values: ["shoes", "boots"]}
4793
+ * ], ContextType.Liveboard);
4794
+ * ```
4580
4795
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
4581
4796
  * @important
4582
4797
  */
@@ -4610,6 +4825,14 @@ export declare enum HostEvent {
4610
4825
  * LiveboardEmbed.trigger(HostEvent.OpenFilter,
4611
4826
  * { column: {columnId: '<column-GUID>'}})
4612
4827
  * ```
4828
+ * @example
4829
+ * ```js
4830
+ * // Open filter from search context
4831
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4832
+ * searchEmbed.trigger(HostEvent.OpenFilter, {
4833
+ * column: { columnId: '<column-GUID>', name: 'region', type: 'ATTRIBUTE', dataType: 'CHAR'}
4834
+ * }, ContextType.Search);
4835
+ * ```
4613
4836
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4614
4837
  */
4615
4838
  OpenFilter = "openFilter",
@@ -4620,6 +4843,14 @@ export declare enum HostEvent {
4620
4843
  * ```js
4621
4844
  * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
4622
4845
  * ```
4846
+ * @example
4847
+ * ```js
4848
+ * // Add columns from search context
4849
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4850
+ * searchEmbed.trigger(HostEvent.AddColumns, {
4851
+ * columnIds: ['col-guid-1', 'col-guid-2']
4852
+ * }, ContextType.Search);
4853
+ * ```
4623
4854
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4624
4855
  */
4625
4856
  AddColumns = "addColumns",
@@ -4630,6 +4861,14 @@ export declare enum HostEvent {
4630
4861
  * ```js
4631
4862
  * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
4632
4863
  * ```
4864
+ * @example
4865
+ * ```js
4866
+ * // Remove column from search context
4867
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4868
+ * searchEmbed.trigger(HostEvent.RemoveColumn, {
4869
+ * columnId: 'column-guid'
4870
+ * }, ContextType.Search);
4871
+ * ```
4633
4872
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4634
4873
  */
4635
4874
  RemoveColumn = "removeColumn",
@@ -4716,6 +4955,37 @@ export declare enum HostEvent {
4716
4955
  *
4717
4956
  * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
4718
4957
  * ```
4958
+ * @example
4959
+ * ```js
4960
+ * // Using context parameter to specify the context type (SDK: 1.45.2+)
4961
+ * // Pin from a search answer context
4962
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4963
+ * appEmbed.trigger(HostEvent.Pin, {
4964
+ * vizId: "123",
4965
+ * newVizName: "Sales by region",
4966
+ * liveboardId: "456"
4967
+ * }, ContextType.Search);
4968
+ * ```
4969
+ * @example
4970
+ * ```js
4971
+ * // Pin from an answer context (explore modal/page) (SDK: 1.45.2+)
4972
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4973
+ * appEmbed.trigger(HostEvent.Pin, {
4974
+ * vizId: "789",
4975
+ * newVizName: "Revenue trends",
4976
+ * liveboardId: "456"
4977
+ * }, ContextType.Answer);
4978
+ * ```
4979
+ * @example
4980
+ * ```js
4981
+ * // Pin from a spotter context (SDK: 1.45.2+)
4982
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4983
+ * appEmbed.trigger(HostEvent.Pin, {
4984
+ * vizId: latestSpotterVizId,
4985
+ * newVizName: "AI-generated insights",
4986
+ * liveboardId: "456"
4987
+ * }, ContextType.Spotter);
4988
+ * ```
4719
4989
  *
4720
4990
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4721
4991
  */
@@ -4726,6 +4996,12 @@ export declare enum HostEvent {
4726
4996
  * @example
4727
4997
  * ```js
4728
4998
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
4999
+ *```
5000
+ * @example
5001
+ * ```js
5002
+ * // Show liveboard info from liveboard context
5003
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5004
+ * liveboardEmbed.trigger(HostEvent.LiveboardInfo, {}, ContextType.Liveboard);
4729
5005
  * ```
4730
5006
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4731
5007
  */
@@ -4736,6 +5012,12 @@ export declare enum HostEvent {
4736
5012
  * ```js
4737
5013
  * liveboardEmbed.trigger(HostEvent.Schedule)
4738
5014
  * ```
5015
+ * @example
5016
+ * ```js
5017
+ * // Schedule from liveboard context
5018
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5019
+ * liveboardEmbed.trigger(HostEvent.Schedule, {}, ContextType.Liveboard);
5020
+ * ```
4739
5021
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4740
5022
  */
4741
5023
  Schedule = "subscription",
@@ -4745,6 +5027,12 @@ export declare enum HostEvent {
4745
5027
  * ```js
4746
5028
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
4747
5029
  * ```
5030
+ * @example
5031
+ * ```js
5032
+ * // Manage schedules from liveboard context
5033
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5034
+ * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
5035
+ * ```
4748
5036
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4749
5037
  */
4750
5038
  SchedulesList = "schedule-list",
@@ -4755,6 +5043,18 @@ export declare enum HostEvent {
4755
5043
  * ```js
4756
5044
  * liveboardEmbed.trigger(HostEvent.ExportTML)
4757
5045
  * ```
5046
+ * @example
5047
+ * ```js
5048
+ * // Export TML from liveboard context
5049
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5050
+ * liveboardEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Liveboard);
5051
+ * ```
5052
+ * @example
5053
+ * ```js
5054
+ * // Export TML from search-answer context
5055
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5056
+ * appEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Search);
5057
+ * ```
4758
5058
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4759
5059
  */
4760
5060
  ExportTML = "exportTSL",
@@ -4765,6 +5065,18 @@ export declare enum HostEvent {
4765
5065
  * ```js
4766
5066
  * liveboardEmbed.trigger(HostEvent.EditTML)
4767
5067
  * ```
5068
+ * @example
5069
+ * ```js
5070
+ * // Edit TML from liveboard context
5071
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5072
+ * liveboardEmbed.trigger(HostEvent.EditTML, {}, ContextType.Liveboard);
5073
+ * ```
5074
+ * @example
5075
+ * ```js
5076
+ * // Edit TML from search-answer context
5077
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5078
+ * appEmbed.trigger(HostEvent.EditTML, {}, ContextType.Search);
5079
+ * ```
4768
5080
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4769
5081
  */
4770
5082
  EditTML = "editTSL",
@@ -4774,6 +5086,12 @@ export declare enum HostEvent {
4774
5086
  * ```js
4775
5087
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
4776
5088
  * ```
5089
+ * @example
5090
+ * ```js
5091
+ * // Update TML from liveboard context
5092
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5093
+ * liveboardEmbed.trigger(HostEvent.UpdateTML, {}, ContextType.Liveboard);
5094
+ * ```
4777
5095
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4778
5096
  */
4779
5097
  UpdateTML = "updateTSL",
@@ -4800,10 +5118,34 @@ export declare enum HostEvent {
4800
5118
  *
4801
5119
  * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
4802
5120
  * ```
5121
+ * @example
5122
+ * ```js
5123
+ * // Download as PDF from search-answer context
5124
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5125
+ * appEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Search);
5126
+ * ```
5127
+ * @example
5128
+ * ```js
5129
+ * // Download as PDF from liveboard context
5130
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5131
+ * liveboardEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Liveboard);
5132
+ * ```
4803
5133
  *
4804
5134
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4805
5135
  */
4806
5136
  DownloadAsPdf = "downloadAsPdf",
5137
+ /**
5138
+ * Trigger the **Download Liveboard as Continuous PDF** action on an
5139
+ * embedded Liveboard.
5140
+ *
5141
+ * @example
5142
+ * ```js
5143
+ * liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
5144
+ * ```
5145
+ *
5146
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5147
+ */
5148
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
4807
5149
  /**
4808
5150
  * Trigger the **AI Highlights** action on an embedded Liveboard
4809
5151
  *
@@ -4844,6 +5186,18 @@ export declare enum HostEvent {
4844
5186
  *
4845
5187
  * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
4846
5188
  * ```
5189
+ * @example
5190
+ * ```js
5191
+ * // Make a copy from answer context
5192
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5193
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Answer);
5194
+ * ```
5195
+ * @example
5196
+ * ```js
5197
+ * // Make a copy from search context
5198
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5199
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Search);
5200
+ * ```
4847
5201
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4848
5202
  */
4849
5203
  MakeACopy = "makeACopy",
@@ -4868,6 +5222,14 @@ export declare enum HostEvent {
4868
5222
  * ```js
4869
5223
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4870
5224
  * ```
5225
+ * @example
5226
+ * ```js
5227
+ * // Explore from liveboard context
5228
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5229
+ * liveboardEmbed.trigger(HostEvent.Explore, {
5230
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5231
+ * }, ContextType.Liveboard);
5232
+ * ```
4871
5233
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4872
5234
  */
4873
5235
  Explore = "explore",
@@ -4885,6 +5247,20 @@ export declare enum HostEvent {
4885
5247
  * ```js
4886
5248
  * searchEmbed.trigger(HostEvent.CreateMonitor)
4887
5249
  * ```
5250
+ * @example
5251
+ * ```js
5252
+ * // Create monitor from answer context
5253
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5254
+ * appEmbed.trigger(HostEvent.CreateMonitor, {}, ContextType.Answer);
5255
+ * ```
5256
+ * @example
5257
+ * ```js
5258
+ * // Create monitor from liveboard context
5259
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5260
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
5261
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5262
+ * }, ContextType.Liveboard);
5263
+ * ```
4888
5264
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4889
5265
  */
4890
5266
  CreateMonitor = "createMonitor",
@@ -4906,6 +5282,20 @@ export declare enum HostEvent {
4906
5282
  * ```js
4907
5283
  * vizEmbed.trigger(HostEvent.ManageMonitor)
4908
5284
  * ```
5285
+ * @example
5286
+ * ```js
5287
+ * // Manage monitor from answer context
5288
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5289
+ * appEmbed.trigger(HostEvent.ManageMonitor, {}, ContextType.Answer);
5290
+ * ```
5291
+ * @example
5292
+ * ```js
5293
+ * // Manage monitor from liveboard context
5294
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5295
+ * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
5296
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5297
+ * }, ContextType.Liveboard);
5298
+ * ```
4909
5299
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4910
5300
  */
4911
5301
  ManageMonitor = "manageMonitor",
@@ -4931,6 +5321,26 @@ export declare enum HostEvent {
4931
5321
  * ```js
4932
5322
  * spotterEmbed.trigger(HostEvent.Edit);
4933
5323
  * ```
5324
+ * @example
5325
+ * ```js
5326
+ * // Using context parameter to edit liveboard context
5327
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5328
+ * liveboardEmbed.trigger(HostEvent.Edit, {}, ContextType.Liveboard);
5329
+ * ```
5330
+ * @example
5331
+ * ```js
5332
+ * // Edit from search context
5333
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5334
+ * appEmbed.trigger(HostEvent.Edit, {}, ContextType.Search);
5335
+ * ```
5336
+ * * @example
5337
+ * ```js
5338
+ * // Edit from spotter context
5339
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5340
+ * appEmbed.trigger(HostEvent.Edit, {
5341
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5342
+ * }, ContextType.Spotter);
5343
+ * ```
4934
5344
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4935
5345
  */
4936
5346
  Edit = "edit",
@@ -4948,6 +5358,34 @@ export declare enum HostEvent {
4948
5358
  * ```js
4949
5359
  * vizEmbed.trigger(HostEvent.CopyLink)
4950
5360
  * ```
5361
+ * @example
5362
+ * ```js
5363
+ * // Copy link from liveboard context
5364
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5365
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
5366
+ * ```
5367
+ * @example
5368
+ * ```js
5369
+ * // Copy link from liveboard visualization context
5370
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5371
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
5372
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5373
+ * }, ContextType.Liveboard);
5374
+ * ```
5375
+ * @example
5376
+ * ```js
5377
+ * // Copy link from liveboard context
5378
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5379
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
5380
+ * ```
5381
+ * @example
5382
+ * ```js
5383
+ * // Copy link from liveboard visualization context
5384
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5385
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
5386
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5387
+ * }, ContextType.Liveboard);
5388
+ * ```
4951
5389
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4952
5390
  */
4953
5391
  CopyLink = "embedDocument",
@@ -4965,6 +5403,34 @@ export declare enum HostEvent {
4965
5403
  * ```js
4966
5404
  * vizEmbed.trigger(HostEvent.Present)
4967
5405
  * ```
5406
+ * @example
5407
+ * ```js
5408
+ * // Present from liveboard visualization context
5409
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5410
+ * liveboardEmbed.trigger(HostEvent.Present, {
5411
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5412
+ * }, ContextType.Liveboard);
5413
+ * ```
5414
+ * @example
5415
+ * ```js
5416
+ * // Present from liveboard context
5417
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5418
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5419
+ * ```
5420
+ * @example
5421
+ * ```js
5422
+ * // Present from liveboard visualization context
5423
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5424
+ * liveboardEmbed.trigger(HostEvent.Present, {
5425
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5426
+ * }, ContextType.Liveboard);
5427
+ * ```
5428
+ * @example
5429
+ * ```js
5430
+ * // Present from liveboard context
5431
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5432
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5433
+ * ```
4968
5434
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4969
5435
  */
4970
5436
  Present = "present",
@@ -4993,6 +5459,22 @@ export declare enum HostEvent {
4993
5459
  * tml.answer.search_query // TML representation of the search query
4994
5460
  * );
4995
5461
  * })
5462
+ * ```
5463
+ * @example
5464
+ * ```js
5465
+ * // Get TML from search context
5466
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5467
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
5468
+ * console.log(tml.answer.search_query);
5469
+ * });
5470
+ * ```
5471
+ * @example
5472
+ * ```js
5473
+ * // Get TML from search-answer context
5474
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5475
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
5476
+ * console.log(tml.answer);
5477
+ * });
4996
5478
  * ```
4997
5479
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4998
5480
  * @important
@@ -5014,6 +5496,20 @@ export declare enum HostEvent {
5014
5496
  * ```js
5015
5497
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
5016
5498
  * ```
5499
+ * @example
5500
+ * ```js
5501
+ * // Show underlying data from liveboard visualization context
5502
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5503
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {
5504
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5505
+ * }, ContextType.Liveboard);
5506
+ * ```
5507
+ * @example
5508
+ * ```js
5509
+ * // Show underlying data from search context
5510
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5511
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {}, ContextType.Search);
5512
+ * ```
5017
5513
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5018
5514
  */
5019
5515
  ShowUnderlyingData = "showUnderlyingData",
@@ -5031,6 +5527,18 @@ export declare enum HostEvent {
5031
5527
  * ```js
5032
5528
  * searchEmbed.trigger(HostEvent.Delete)
5033
5529
  * ```
5530
+ * @example
5531
+ * ```js
5532
+ * // Delete from liveboard context
5533
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5534
+ * liveboardEmbed.trigger(HostEvent.Delete, {}, ContextType.Liveboard);
5535
+ * ```
5536
+ * @example
5537
+ * ```js
5538
+ * // Delete from search context
5539
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5540
+ * appEmbed.trigger(HostEvent.Delete, {}, ContextType.Search);
5541
+ * ```
5034
5542
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5035
5543
  */
5036
5544
  Delete = "onDeleteAnswer",
@@ -5051,6 +5559,20 @@ export declare enum HostEvent {
5051
5559
  * ```js
5052
5560
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
5053
5561
  * ```
5562
+ * @example
5563
+ * ```js
5564
+ * // SpotIQ analyze from search-answer context
5565
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5566
+ * appEmbed.trigger(HostEvent.SpotIQAnalyze, { vizId: '730496d6-6903-4601-937e-2c691821af3c' }, ContextType.Search);
5567
+ * ```
5568
+ * @example
5569
+ * ```js
5570
+ * // SpotIQ analyze from search context
5571
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5572
+ * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {
5573
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5574
+ * }, ContextType.Liveboard);
5575
+ * ```
5054
5576
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5055
5577
  */
5056
5578
  SpotIQAnalyze = "spotIQAnalyze",
@@ -5102,6 +5624,12 @@ export declare enum HostEvent {
5102
5624
  *
5103
5625
  * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
5104
5626
  * ```
5627
+ * @example
5628
+ * ```js
5629
+ * // Download as PNG from search-answer context
5630
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5631
+ * appEmbed.trigger(HostEvent.DownloadAsPng, {}, ContextType.Search);
5632
+ * ```
5105
5633
  *
5106
5634
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
5107
5635
  */
@@ -5130,6 +5658,18 @@ export declare enum HostEvent {
5130
5658
  *
5131
5659
  * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
5132
5660
  * ```
5661
+ * @example
5662
+ * ```js
5663
+ * // Download as CSV from search-answer context
5664
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5665
+ * appEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
5666
+ * ```
5667
+ * @example
5668
+ * ```js
5669
+ * // Download as CSV from search context
5670
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5671
+ * searchEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
5672
+ * ```
5133
5673
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5134
5674
  */
5135
5675
  DownloadAsCsv = "downloadAsCSV",
@@ -5157,6 +5697,18 @@ export declare enum HostEvent {
5157
5697
  *
5158
5698
  * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
5159
5699
  * ```
5700
+ * @example
5701
+ * ```js
5702
+ * // Download as XLSX from answer context
5703
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5704
+ * appEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Answer);
5705
+ * ```
5706
+ * @example
5707
+ * ```js
5708
+ * // Download as XLSX from search context
5709
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5710
+ * searchEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Search);
5711
+ * ```
5160
5712
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5161
5713
  */
5162
5714
  DownloadAsXlsx = "downloadAsXLSX",
@@ -5170,6 +5722,18 @@ export declare enum HostEvent {
5170
5722
  * ```js
5171
5723
  * searchEmbed.trigger(HostEvent.Share)
5172
5724
  * ```
5725
+ * @example
5726
+ * ```js
5727
+ * // Share from Liveboard context
5728
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5729
+ * liveboardEmbed.trigger(HostEvent.Share, {}, ContextType.Liveboard);
5730
+ * ```
5731
+ * @example
5732
+ * ```js
5733
+ * // Share from search-answer context
5734
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5735
+ * appEmbed.trigger(HostEvent.Share, {}, ContextType.Search);
5736
+ * ```
5173
5737
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5174
5738
  */
5175
5739
  Share = "share",
@@ -5209,6 +5773,18 @@ export declare enum HostEvent {
5209
5773
  *
5210
5774
  * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
5211
5775
  * ```
5776
+ * @example
5777
+ * ```js
5778
+ * // Save from answer context
5779
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5780
+ * appEmbed.trigger(HostEvent.Save, {}, ContextType.Answer);
5781
+ * ```
5782
+ * @example
5783
+ * ```js
5784
+ * // Save from search context
5785
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5786
+ * searchEmbed.trigger(HostEvent.Save, {}, ContextType.Search);
5787
+ * ```
5212
5788
  *
5213
5789
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5214
5790
  */
@@ -5225,6 +5801,20 @@ export declare enum HostEvent {
5225
5801
  * ```js
5226
5802
  * vizEmbed.trigger(HostEvent.SyncToSheets)
5227
5803
  * ```
5804
+ * @example
5805
+ * ```js
5806
+ * // Sync to sheets from answer context
5807
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5808
+ * appEmbed.trigger(HostEvent.SyncToSheets, {}, ContextType.Answer);
5809
+ * ```
5810
+ * @example
5811
+ * ```js
5812
+ * // Sync to sheets from liveboard context
5813
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5814
+ * liveboardEmbed.trigger(HostEvent.SyncToSheets, {
5815
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5816
+ * }, ContextType.Liveboard);
5817
+ * ```
5228
5818
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5229
5819
  */
5230
5820
  SyncToSheets = "sync-to-sheets",
@@ -5241,6 +5831,20 @@ export declare enum HostEvent {
5241
5831
  * ```js
5242
5832
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
5243
5833
  * ```
5834
+ * @example
5835
+ * ```js
5836
+ * // Sync to other apps from answer context
5837
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5838
+ * appEmbed.trigger(HostEvent.SyncToOtherApps, {}, ContextType.Answer);
5839
+ * ```
5840
+ * @example
5841
+ * ```js
5842
+ * // Sync to other apps from liveboard context
5843
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5844
+ * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {
5845
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5846
+ * }, ContextType.Liveboard);
5847
+ * ```
5244
5848
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5245
5849
  */
5246
5850
  SyncToOtherApps = "sync-to-other-apps",
@@ -5257,6 +5861,20 @@ export declare enum HostEvent {
5257
5861
  * ```js
5258
5862
  * vizEmbed.trigger(HostEvent.ManagePipelines)
5259
5863
  * ```
5864
+ * @example
5865
+ * ```js
5866
+ * // Manage pipelines from answer context
5867
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5868
+ * appEmbed.trigger(HostEvent.ManagePipelines, {}, ContextType.Answer);
5869
+ * ```
5870
+ * @example
5871
+ * ```js
5872
+ * // Manage pipelines from liveboard context
5873
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5874
+ * liveboardEmbed.trigger(HostEvent.ManagePipelines, {
5875
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5876
+ * }, ContextType.Liveboard);
5877
+ * ```
5260
5878
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5261
5879
  */
5262
5880
  ManagePipelines = "manage-pipeline",
@@ -5269,6 +5887,12 @@ export declare enum HostEvent {
5269
5887
  * ```js
5270
5888
  * appEmbed.trigger(HostEvent.ResetSearch)
5271
5889
  * ```
5890
+ * @example
5891
+ * ```js
5892
+ * // Reset search from search context
5893
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5894
+ * searchEmbed.trigger(HostEvent.ResetSearch, {}, ContextType.Search);
5895
+ * ```
5272
5896
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
5273
5897
  */
5274
5898
  ResetSearch = "resetSearch",
@@ -5280,6 +5904,13 @@ export declare enum HostEvent {
5280
5904
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
5281
5905
  * console.log('data', data);
5282
5906
  * ```
5907
+ * @example
5908
+ * ```js
5909
+ * // Get filters from liveboard context
5910
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5911
+ * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
5912
+ * console.log('filters', data);
5913
+ * ```
5283
5914
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5284
5915
  */
5285
5916
  GetFilters = "getFilters",
@@ -5287,7 +5918,8 @@ export declare enum HostEvent {
5287
5918
  * Update one or several filters applied on a Liveboard.
5288
5919
  * @param - Includes the following keys:
5289
5920
  * - `filter`: A single filter object containing column name, filter operator, and
5290
- * values. - `filters`: Multiple filter objects with column name, filter operator,
5921
+ * values.
5922
+ * - `filters`: Multiple filter objects with column name, filter operator,
5291
5923
  * and values for each.
5292
5924
  *
5293
5925
  * Each filter object must include the following attributes:
@@ -5370,6 +6002,18 @@ export declare enum HostEvent {
5370
6002
  * }]
5371
6003
  * });
5372
6004
  * ```
6005
+ * @example
6006
+ * ```js
6007
+ * // Update filters from liveboard context
6008
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6009
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
6010
+ * filter: {
6011
+ * column: "item type",
6012
+ * oper: "IN",
6013
+ * values: ["shoes", "boots"]
6014
+ * }
6015
+ * }, ContextType.Liveboard);
6016
+ * ```
5373
6017
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5374
6018
  */
5375
6019
  UpdateFilters = "updateFilters",
@@ -5383,6 +6027,14 @@ export declare enum HostEvent {
5383
6027
  * );
5384
6028
  * })
5385
6029
  * ```
6030
+ * @example
6031
+ * ```js
6032
+ * // Get tabs from liveboard context
6033
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6034
+ * liveboardEmbed.trigger(HostEvent.GetTabs, {}, ContextType.Liveboard).then((tabDetails) => {
6035
+ * console.log('tabs', tabDetails);
6036
+ * });
6037
+ * ```
5386
6038
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5387
6039
  */
5388
6040
  GetTabs = "getTabs",
@@ -5396,6 +6048,15 @@ export declare enum HostEvent {
5396
6048
  * '430496d6-6903-4601-937e-2c691821af3c',
5397
6049
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
5398
6050
  * ```
6051
+ * @example
6052
+ * ```js
6053
+ * // Set visible tabs from liveboard context
6054
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6055
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
6056
+ * '430496d6-6903-4601-937e-2c691821af3c',
6057
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
6058
+ * ], ContextType.Liveboard);
6059
+ * ```
5399
6060
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5400
6061
  */
5401
6062
  SetVisibleTabs = "SetPinboardVisibleTabs",
@@ -5409,6 +6070,15 @@ export declare enum HostEvent {
5409
6070
  * '630496d6-6903-4601-937e-2c691821af3c',
5410
6071
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
5411
6072
  * ```
6073
+ * @example
6074
+ * ```js
6075
+ * // Set hidden tabs from liveboard context
6076
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6077
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
6078
+ * '630496d6-6903-4601-937e-2c691821af3c',
6079
+ * 'i547ec54-2a37-4516-a222-2b06719af726'
6080
+ * ], ContextType.Liveboard);
6081
+ * ```
5412
6082
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5413
6083
  */
5414
6084
  SetHiddenTabs = "SetPinboardHiddenTabs",
@@ -5485,13 +6155,24 @@ export declare enum HostEvent {
5485
6155
  UpdateCrossFilter = "UpdateCrossFilter",
5486
6156
  /**
5487
6157
  * Trigger reset action for a personalized Liveboard view.
6158
+ * This event is deprecated. Use {@link HostEvent.ResetLiveboardPersonalizedView} instead.
5488
6159
  * @example
5489
6160
  * ```js
5490
6161
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
5491
6162
  * ```
5492
6163
  * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
6164
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5493
6165
  */
5494
6166
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
6167
+ /**
6168
+ * Trigger reset action for a personalized Liveboard view.
6169
+ * @example
6170
+ * ```js
6171
+ * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalizedView);
6172
+ * ```
6173
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6174
+ */
6175
+ ResetLiveboardPersonalizedView = "ResetLiveboardPersonalisedView",
5495
6176
  /**
5496
6177
  * Triggers an action to update Parameter values on embedded
5497
6178
  * Answers, Liveboard, and Spotter answer in Edit mode.
@@ -5508,6 +6189,16 @@ export declare enum HostEvent {
5508
6189
  * isVisibleToUser: false
5509
6190
  * }])
5510
6191
  * ```
6192
+ * @example
6193
+ * ```js
6194
+ * // Update parameters from liveboard context
6195
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6196
+ * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
6197
+ * name: "Region Param",
6198
+ * value: "West",
6199
+ * isVisibleToUser: true
6200
+ * }], ContextType.Liveboard);
6201
+ * ```
5511
6202
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5512
6203
  */
5513
6204
  UpdateParameters = "UpdateParameters",
@@ -5527,18 +6218,77 @@ export declare enum HostEvent {
5527
6218
  * });
5528
6219
  *
5529
6220
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
6221
+ *```
6222
+ * @example
6223
+ * ```js
6224
+ * // Get parameters from liveboard context
6225
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6226
+ * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
6227
+ * console.log('parameters', parameters);
6228
+ * });
5530
6229
  * ```
5531
6230
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5532
6231
  */
5533
6232
  GetParameters = "GetParameters",
5534
6233
  /**
5535
6234
  * Triggers an event to update a personalized view of a Liveboard.
6235
+ * This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
5536
6236
  * ```js
5537
6237
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5538
6238
  * ```
6239
+ * @example
6240
+ * ```js
6241
+ * // Update personalized view from liveboard context
6242
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6243
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {
6244
+ * viewId: '1234'
6245
+ * }, ContextType.Liveboard);
6246
+ * ```
5539
6247
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
6248
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5540
6249
  */
5541
6250
  UpdatePersonalisedView = "UpdatePersonalisedView",
6251
+ /**
6252
+ * Triggers an event to update a personalized view of a Liveboard.
6253
+ * ```js
6254
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
6255
+ * ```
6256
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6257
+ */
6258
+ UpdatePersonalizedView = "UpdatePersonalisedView",
6259
+ /**
6260
+ * Triggers selection of a specific Personalized View on a
6261
+ * Liveboard without reloading the embed. Pass either a
6262
+ * `viewId` (GUID) or `viewName`. If both are provided, `viewId` takes precedence.
6263
+ * If neither is provided, the Liveboard resets to the original/default view.
6264
+ * When a `viewName` is provided and multiple views share
6265
+ * the same name, the first match is selected.
6266
+ * @example
6267
+ * ```js
6268
+ * liveboardEmbed.trigger(
6269
+ * HostEvent.SelectPersonalizedView,
6270
+ * { viewId: '2a021a12-1aed-425d-984b-141ee916ce72' },
6271
+ * )
6272
+ * ```
6273
+ * @example
6274
+ * ```js
6275
+ * // Select by name
6276
+ * liveboardEmbed.trigger(
6277
+ * HostEvent.SelectPersonalizedView,
6278
+ * { viewName: 'Dr Smith Cardiology' },
6279
+ * )
6280
+ * ```
6281
+ * @example
6282
+ * ```js
6283
+ * // Reset to default view
6284
+ * liveboardEmbed.trigger(
6285
+ * HostEvent.SelectPersonalizedView,
6286
+ * {},
6287
+ * )
6288
+ * ```
6289
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6290
+ */
6291
+ SelectPersonalizedView = "SelectPersonalisedView",
5542
6292
  /**
5543
6293
  * @hidden
5544
6294
  * Notify when info call is completed successfully
@@ -5558,7 +6308,8 @@ export declare enum HostEvent {
5558
6308
  * add a name and description for the Answer.
5559
6309
  * @param - Includes the following keys:
5560
6310
  * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
5561
- * embed. - `name`: Optional. Name string for the Answer.
6311
+ * embed.
6312
+ * - `name`: Optional. Name string for the Answer.
5562
6313
  * - `description`: Optional. Description text for the Answer.
5563
6314
  * @example
5564
6315
  * ```js
@@ -5577,6 +6328,34 @@ export declare enum HostEvent {
5577
6328
  *
5578
6329
  * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
5579
6330
  * ```
6331
+ * @example
6332
+ * ```js
6333
+ * // Using context parameter to save answer from search context
6334
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6335
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6336
+ * name: "Regional sales analysis",
6337
+ * description: "Sales breakdown by region"
6338
+ * }, ContextType.Search);
6339
+ * ```
6340
+ * @example
6341
+ * ```js
6342
+ * // Save answer from answer context (explore modal)
6343
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6344
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6345
+ * name: "Modified analysis",
6346
+ * description: "Updated from explore view"
6347
+ * }, ContextType.Answer);
6348
+ * ```
6349
+ * @example
6350
+ * ```js
6351
+ * // Save answer from spotter context
6352
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6353
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6354
+ * vizId: latestSpotterVizId,
6355
+ * name: "AI insights",
6356
+ * description: "Generated from Spotter"
6357
+ * }, ContextType.Spotter);
6358
+ * ```
5580
6359
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5581
6360
  */
5582
6361
  SaveAnswer = "saveAnswer",
@@ -5618,6 +6397,15 @@ export declare enum HostEvent {
5618
6397
  * executeSearch: true,
5619
6398
  * })
5620
6399
  * ```
6400
+ * @example
6401
+ * ```js
6402
+ * // Spotter search from spotter context
6403
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6404
+ * spotterEmbed.trigger(HostEvent.SpotterSearch, {
6405
+ * query: 'sales by region',
6406
+ * executeSearch: true
6407
+ * }, ContextType.Spotter);
6408
+ * ```
5621
6409
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5622
6410
  */
5623
6411
  SpotterSearch = "SpotterSearch",
@@ -5628,6 +6416,12 @@ export declare enum HostEvent {
5628
6416
  * ```js
5629
6417
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
5630
6418
  * ```
6419
+ * @example
6420
+ * ```js
6421
+ * // Edit last prompt from spotter context
6422
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6423
+ * spotterEmbed.trigger(HostEvent.EditLastPrompt, "sales by region", ContextType.Spotter);
6424
+ * ```
5631
6425
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5632
6426
  */
5633
6427
  EditLastPrompt = "EditLastPrompt",
@@ -5637,6 +6431,12 @@ export declare enum HostEvent {
5637
6431
  * ```js
5638
6432
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
5639
6433
  * ```
6434
+ * @example
6435
+ * ```js
6436
+ * // Preview spotter data from spotter context
6437
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6438
+ * spotterEmbed.trigger(HostEvent.PreviewSpotterData, {}, ContextType.Spotter);
6439
+ * ```
5640
6440
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5641
6441
  */
5642
6442
  PreviewSpotterData = "PreviewSpotterData",
@@ -6116,6 +6916,16 @@ export declare enum Action {
6116
6916
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
6117
6917
  */
6118
6918
  DownloadLiveboard = "downloadLiveboard",
6919
+ /**
6920
+ * The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
6921
+ * Allows downloading the entire Liveboard as a continuous PDF.
6922
+ * @example
6923
+ * ```js
6924
+ * disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
6925
+ * ```
6926
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6927
+ */
6928
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
6119
6929
  /**
6120
6930
  * @hidden
6121
6931
  */
@@ -6749,13 +7559,25 @@ export declare enum Action {
6749
7559
  /**
6750
7560
  * The Liveboard Personalised Views dropdown.
6751
7561
  * Allows navigating to a personalized Liveboard View.
7562
+ * This action is deprecated. Use {@link Action.PersonalizedViewsDropdown} instead.
6752
7563
  * @example
6753
7564
  * ```js
6754
7565
  * disabledActions: [Action.PersonalisedViewsDropdown]
6755
7566
  * ```
6756
7567
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
7568
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6757
7569
  */
6758
7570
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
7571
+ /**
7572
+ * The Liveboard Personalized Views dropdown.
7573
+ * Allows navigating to a personalized Liveboard View.
7574
+ * @example
7575
+ * ```js
7576
+ * disabledActions: [Action.PersonalizedViewsDropdown]
7577
+ * ```
7578
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7579
+ */
7580
+ PersonalizedViewsDropdown = "personalisedViewsDropdown",
6759
7581
  /**
6760
7582
  * Action ID for show or hide the user details on a
6761
7583
  * Liveboard (Recently visited / social proof)
@@ -6843,14 +7665,27 @@ export declare enum Action {
6843
7665
  /**
6844
7666
  * The **Organize Favourites** action on Homepage
6845
7667
  * *Favorites* module.
7668
+ * This action is deprecated. Use {@link Action.OrganizeFavorites} instead.
6846
7669
  *
6847
7670
  * @example
6848
7671
  * ```js
6849
7672
  * disabledActions: [Action.OrganiseFavourites]
6850
7673
  * ```
6851
7674
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
7675
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6852
7676
  */
6853
7677
  OrganiseFavourites = "organiseFavourites",
7678
+ /**
7679
+ * The **Organize Favorites** action on Homepage
7680
+ * *Favorites* module.
7681
+ *
7682
+ * @example
7683
+ * ```js
7684
+ * disabledActions: [Action.OrganizeFavorites]
7685
+ * ```
7686
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7687
+ */
7688
+ OrganizeFavorites = "organiseFavourites",
6854
7689
  /**
6855
7690
  * The **AI Highlights** action on a Liveboard.
6856
7691
  *
@@ -7306,6 +8141,39 @@ export declare enum Action {
7306
8141
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7307
8142
  */
7308
8143
  SpotterDocs = "spotterDocs",
8144
+ /**
8145
+ * Controls visibility and disable state of the connector resources
8146
+ * section in the Spotter chat interface.
8147
+ * @example
8148
+ * ```js
8149
+ * hiddenActions: [Action.SpotterChatConnectorResources]
8150
+ * disabledActions: [Action.SpotterChatConnectorResources]
8151
+ * ```
8152
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8153
+ */
8154
+ SpotterChatConnectorResources = "spotterChatConnectorResources",
8155
+ /**
8156
+ * Controls visibility and disable state of the connectors
8157
+ * in the Spotter chat interface.
8158
+ * @example
8159
+ * ```js
8160
+ * hiddenActions: [Action.SpotterChatConnectors]
8161
+ * disabledActions: [Action.SpotterChatConnectors]
8162
+ * ```
8163
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8164
+ */
8165
+ SpotterChatConnectors = "spotterChatConnectors",
8166
+ /**
8167
+ * Controls visibility and disable state of the mode switcher
8168
+ * in the Spotter chat interface.
8169
+ * @example
8170
+ * ```js
8171
+ * hiddenActions: [Action.SpotterChatModeSwitcher]
8172
+ * disabledActions: [Action.SpotterChatModeSwitcher]
8173
+ * ```
8174
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8175
+ */
8176
+ SpotterChatModeSwitcher = "spotterChatModeSwitcher",
7309
8177
  /**
7310
8178
  * The **Include current period** checkbox for date filters.
7311
8179
  * Controls the visibility and availability of the option to include
@@ -7556,7 +8424,13 @@ declare enum EmbedErrorCodes {
7556
8424
  /** Failed to update embed parameters during pre-render */
7557
8425
  UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
7558
8426
  /** Invalid URL provided in configuration */
7559
- INVALID_URL = "INVALID_URL"
8427
+ INVALID_URL = "INVALID_URL",
8428
+ /** Host event payload validation failed */
8429
+ HOST_EVENT_VALIDATION = "HOST_EVENT_VALIDATION",
8430
+ /** UpdateFilters payload is invalid - missing or malformed filter/filters */
8431
+ UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
8432
+ /** DrillDown payload is invalid - missing or malformed points */
8433
+ DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
7560
8434
  }
7561
8435
  /**
7562
8436
  * Error event object emitted when an error occurs in an embedded component.
@@ -7569,7 +8443,8 @@ declare enum EmbedErrorCodes {
7569
8443
  *
7570
8444
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
7571
8445
  * - **message**: Human-readable error description (string or array of strings for
7572
- * multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
8446
+ * multiple errors)
8447
+ * - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
7573
8448
  * values
7574
8449
  * - **[key: string]**: Additional context-specific for backward compatibility
7575
8450
  *
@@ -7633,7 +8508,11 @@ declare enum ContextType {
7633
8508
  /**
7634
8509
  * Spotter context for spotter modal/page.
7635
8510
  */
7636
- Spotter = "spotter"
8511
+ Spotter = "spotter",
8512
+ /**
8513
+ * Other context for any other generic page.
8514
+ */
8515
+ Other = "other"
7637
8516
  }
7638
8517
  export interface DefaultAppInitData {
7639
8518
  customisations: CustomisationsInterface;
@@ -7736,33 +8615,6 @@ export interface ObjectIds {
7736
8615
  */
7737
8616
  modalTitle?: string;
7738
8617
  }
7739
- /**
7740
- * Context object for the embedded component.
7741
- * @example
7742
- * ```js
7743
- * const context = await embed.getCurrentContext();
7744
- * console.log(context);
7745
- * {
7746
- * stack: [
7747
- * {
7748
- * name: 'Liveboard',
7749
- * type: ContextType.Liveboard,
7750
- * objectIds: {
7751
- * liveboardId: '123',
7752
- * },
7753
- * },
7754
- * ],
7755
- * currentContext: {
7756
- * name: 'Liveboard',
7757
- * type: ContextType.Liveboard,
7758
- * objectIds: {
7759
- * liveboardId: '123',
7760
- * },
7761
- * },
7762
- * }
7763
- * ```
7764
- * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
7765
- */
7766
8618
  export interface ContextObject {
7767
8619
  /**
7768
8620
  * Stack of context objects.
@@ -7817,7 +8669,8 @@ export declare enum AuthFailureType {
7817
8669
  /**
7818
8670
  * The current authentication token or session has expired.
7819
8671
  *
7820
- * Emitted when the embed receives an auth-expiry signal and starts auth refresh handling.
8672
+ * Emitted when the embed receives an auth-expiry signal and starts auth refresh
8673
+ * handling.
7821
8674
  */
7822
8675
  EXPIRY = "EXPIRY",
7823
8676
  /**
@@ -7953,6 +8806,11 @@ export declare enum AuthEvent {
7953
8806
  */
7954
8807
  TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
7955
8808
  }
8809
+ export interface LiveboardTab {
8810
+ id: string;
8811
+ name: string;
8812
+ [key: string]: any;
8813
+ }
7956
8814
  export declare enum UIPassthroughEvent {
7957
8815
  PinAnswerToLiveboard = "addVizToPinboard",
7958
8816
  SaveAnswer = "saveAnswer",
@@ -7960,7 +8818,16 @@ export declare enum UIPassthroughEvent {
7960
8818
  GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
7961
8819
  GetAnswerConfig = "getAnswerPageConfig",
7962
8820
  GetLiveboardConfig = "getPinboardPageConfig",
7963
- GetUnsavedAnswerTML = "getUnsavedAnswerTML"
8821
+ GetUnsavedAnswerTML = "getUnsavedAnswerTML",
8822
+ UpdateFilters = "updateFilters",
8823
+ Drilldown = "drillDown",
8824
+ GetAnswerSession = "getAnswerSession",
8825
+ GetFilters = "getFilters",
8826
+ GetIframeUrl = "getIframeUrl",
8827
+ GetParameters = "getParameters",
8828
+ GetTML = "getTML",
8829
+ GetTabs = "getTabs",
8830
+ GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
7964
8831
  }
7965
8832
  export type UIPassthroughContractBase = {
7966
8833
  [UIPassthroughEvent.PinAnswerToLiveboard]: {
@@ -8024,17 +8891,104 @@ export type UIPassthroughContractBase = {
8024
8891
  tml: string;
8025
8892
  };
8026
8893
  };
8894
+ [UIPassthroughEvent.GetAnswerSession]: {
8895
+ request: {
8896
+ vizId?: string;
8897
+ };
8898
+ response: {
8899
+ session: SessionInterface;
8900
+ embedAnswerData?: Record<string, any>;
8901
+ };
8902
+ };
8903
+ [UIPassthroughEvent.GetFilters]: {
8904
+ request: {
8905
+ vizId?: string;
8906
+ };
8907
+ response: {
8908
+ liveboardFilters: Record<string, any>[];
8909
+ runtimeFilters: RuntimeFilter[];
8910
+ };
8911
+ };
8912
+ [UIPassthroughEvent.GetIframeUrl]: {
8913
+ request: Record<string, never>;
8914
+ response: {
8915
+ iframeUrl: string;
8916
+ };
8917
+ };
8918
+ [UIPassthroughEvent.GetParameters]: {
8919
+ request: Record<string, never>;
8920
+ response: {
8921
+ parameters: Record<string, any>[];
8922
+ };
8923
+ };
8924
+ [UIPassthroughEvent.GetTML]: {
8925
+ request: {
8926
+ vizId?: string;
8927
+ includeNonExecutedSearchTokens?: boolean;
8928
+ };
8929
+ response: Record<string, any>;
8930
+ };
8931
+ [UIPassthroughEvent.GetTabs]: {
8932
+ request: Record<string, never>;
8933
+ response: {
8934
+ orderedTabIds: string[];
8935
+ numberOfTabs: number;
8936
+ Tabs: LiveboardTab[];
8937
+ };
8938
+ };
8939
+ [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
8940
+ request: Record<string, never>;
8941
+ response: {
8942
+ v2Content: string;
8943
+ };
8944
+ };
8945
+ [UIPassthroughEvent.UpdateFilters]: {
8946
+ request: {
8947
+ filter?: {
8948
+ column: string;
8949
+ oper: string;
8950
+ values: string[];
8951
+ type?: string;
8952
+ };
8953
+ filters?: {
8954
+ column: string;
8955
+ oper: string;
8956
+ values: string[];
8957
+ type?: string;
8958
+ }[];
8959
+ };
8960
+ response: unknown;
8961
+ };
8962
+ [UIPassthroughEvent.Drilldown]: {
8963
+ request: {
8964
+ points: {
8965
+ selectedPoints?: string[];
8966
+ clickedPoint?: string;
8967
+ };
8968
+ columnGuid?: string;
8969
+ autoDrillDown?: boolean;
8970
+ vizId?: string;
8971
+ };
8972
+ response: unknown;
8973
+ };
8027
8974
  };
8028
8975
  export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
8029
8976
  export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
8030
8977
  export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> = Array<{
8031
- redId?: string;
8978
+ refId?: string;
8032
8979
  value?: UIPassthroughResponse<ApiName>;
8033
8980
  error?: any;
8034
8981
  }>;
8035
8982
  export type EmbedApiHostEventMapping = {
8036
8983
  [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
8037
8984
  [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
8985
+ [HostEvent.GetAnswerSession]: UIPassthroughEvent.GetAnswerSession;
8986
+ [HostEvent.GetFilters]: UIPassthroughEvent.GetFilters;
8987
+ [HostEvent.GetIframeUrl]: UIPassthroughEvent.GetIframeUrl;
8988
+ [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
8989
+ [HostEvent.GetTML]: UIPassthroughEvent.GetTML;
8990
+ [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
8991
+ [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
8038
8992
  };
8039
8993
  export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
8040
8994
  export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
@@ -8042,6 +8996,12 @@ export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT |
8042
8996
  export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
8043
8997
  declare class HostEventClient {
8044
8998
  iFrame: HTMLIFrameElement;
8999
+ /** Cached list of available UI passthrough keys from the embedded app */
9000
+ private availablePassthroughKeysCache;
9001
+ /** Host events with custom handlers
9002
+ * (setters or special logic) -
9003
+ * bound to instance for protected method access */
9004
+ private readonly customHandlers;
8045
9005
  constructor(iFrame?: HTMLIFrameElement);
8046
9006
  /**
8047
9007
  * A wrapper over process trigger to
@@ -8052,14 +9012,36 @@ declare class HostEventClient {
8052
9012
  protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
8053
9013
  handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
8054
9014
  hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
9015
+ /**
9016
+ * For getter events that return data. Tries UI passthrough first;
9017
+ * if the app doesn't support it (no response data), falls back to
9018
+ * the legacy host event channel. Real errors are thrown as-is.
9019
+ */
9020
+ private getDataWithPassthroughFallback;
8055
9021
  /**
8056
9022
  * Setter for the iframe element used for host events
8057
9023
  * @param {HTMLIFrameElement} iFrame - the iframe element to set
8058
9024
  */
8059
9025
  setIframeElement(iFrame: HTMLIFrameElement): void;
9026
+ /**
9027
+ * Fetches the list of available UI passthrough keys from the embedded app.
9028
+ * Result is cached for the session. Returns empty array on failure.
9029
+ */
9030
+ private getAvailableUIPassthroughKeys;
8060
9031
  triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
8061
9032
  protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
8062
9033
  protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
9034
+ protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
9035
+ protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
9036
+ /**
9037
+ * Dispatches a host event using the appropriate channel:
9038
+ * 1. If the embedded app supports UI passthrough for this event, use it (custom handler or getter).
9039
+ * 2. Otherwise fall back to the legacy host event channel.
9040
+ *
9041
+ * @param hostEvent - The host event to trigger
9042
+ * @param payload - Optional payload for the event
9043
+ * @param context - Optional context (e.g. vizId) for scoped operations
9044
+ */
8063
9045
  triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
8064
9046
  }
8065
9047
  declare class TsEmbed {
@@ -8395,7 +9377,21 @@ declare class TsEmbed {
8395
9377
  * Triggers an event to the embedded app
8396
9378
  * @param {HostEvent} messageType The event type
8397
9379
  * @param {any} data The payload to send with the message
9380
+ * @param {ContextType} context Optional context type to specify the context from which the event is triggered.
9381
+ * Use ContextType.Search for search answer context, ContextType.Answer for answer/explore context,
9382
+ * ContextType.Liveboard for liveboard context, or ContextType.Spotter for spotter context.
9383
+ * Available from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl
8398
9384
  * @returns A promise that resolves with the response from the embedded app
9385
+ * @example
9386
+ * ```js
9387
+ * // Trigger Pin event with context (SDK: 1.45.2+)
9388
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
9389
+ * embed.trigger(HostEvent.Pin, {
9390
+ * vizId: "123",
9391
+ * liveboardId: "456"
9392
+ * }, ContextType.Search);
9393
+ * ```
9394
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl (for context parameter)
8399
9395
  */
8400
9396
  trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
8401
9397
  /**
@@ -8416,8 +9412,33 @@ declare class TsEmbed {
8416
9412
  getIframeSrc(): string;
8417
9413
  protected handleRenderForPrerender(): Promise<TsEmbed>;
8418
9414
  /**
8419
- * Get the current context of the embedded TS component.
8420
- * @returns The current context object containing the page type and object ids.
9415
+ * Context object for the embedded component.
9416
+ * @returns {ContextObject} The current context object containing the page type and object ids.
9417
+ * @example
9418
+ * ```js
9419
+ * const context = await embed.getCurrentContext();
9420
+ * console.log(context);
9421
+ *
9422
+ * // Example output
9423
+ * {
9424
+ * stack: [
9425
+ * {
9426
+ * name: 'Liveboard',
9427
+ * type: ContextType.Liveboard,
9428
+ * objectIds: {
9429
+ * liveboardId: '123',
9430
+ * },
9431
+ * },
9432
+ * ],
9433
+ * currentContext: {
9434
+ * name: 'Liveboard',
9435
+ * type: ContextType.Liveboard,
9436
+ * objectIds: {
9437
+ * liveboardId: '123',
9438
+ * },
9439
+ * },
9440
+ * }
9441
+ * ```
8421
9442
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
8422
9443
  */
8423
9444
  getCurrentContext(): Promise<ContextObject>;
@@ -9442,9 +10463,31 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9442
10463
  */
9443
10464
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
9444
10465
  }
10466
+ /**
10467
+ * APP_INIT data shape for SpotterEmbed.
10468
+ * @internal
10469
+ */
10470
+ export interface SpotterAppInitData extends DefaultAppInitData {
10471
+ embedParams?: {
10472
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
10473
+ };
10474
+ }
9445
10475
  declare class SpotterEmbed extends TsEmbed {
9446
10476
  protected viewConfig: SpotterEmbedViewConfig;
9447
10477
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
10478
+ /**
10479
+ * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
10480
+ * so the conv-assist app can read sidebar configuration on initialisation.
10481
+ *
10482
+ * Precedence for `enablePastConversationsSidebar`:
10483
+ * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
10484
+ * deprecated top-level `enablePastConversationsSidebar` flag; if the former
10485
+ * is absent the latter is used as a fallback.
10486
+ *
10487
+ * An invalid `spotterDocumentationUrl` triggers a validation error and is
10488
+ * excluded from the payload rather than forwarded to the app.
10489
+ */
10490
+ protected getAppInitData(): Promise<SpotterAppInitData>;
9448
10491
  protected getEmbedParamsObject(): Record<any, any>;
9449
10492
  getIframeSrc(): string;
9450
10493
  render(): Promise<SpotterEmbed>;
@@ -9993,6 +11036,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9993
11036
  * ```
9994
11037
  */
9995
11038
  isPNGInScheduledEmailsEnabled?: boolean;
11039
+ /**
11040
+ * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
11041
+ * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
11042
+ * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
11043
+ *
11044
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
11045
+ * @type {boolean}
11046
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11047
+ * @example
11048
+ * ```js
11049
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
11050
+ * const embed = new <EmbedComponent>('#tsEmbed', {
11051
+ * ... // other embed view config
11052
+ * isContinuousLiveboardPDFEnabled: true,
11053
+ * })
11054
+ * ```
11055
+ */
11056
+ isContinuousLiveboardPDFEnabled?: boolean;
9996
11057
  /**
9997
11058
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
9998
11059
  *
@@ -10161,10 +11222,32 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10161
11222
  */
10162
11223
  enableHomepageAnnouncement?: boolean;
10163
11224
  }
11225
+ /**
11226
+ * APP_INIT data shape for AppEmbed.
11227
+ * @internal
11228
+ */
11229
+ export interface AppEmbedAppInitData extends DefaultAppInitData {
11230
+ embedParams?: {
11231
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
11232
+ };
11233
+ }
10164
11234
  declare class AppEmbed extends V1Embed {
10165
11235
  protected viewConfig: AppViewConfig;
10166
11236
  private defaultHeight;
10167
11237
  constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
11238
+ /**
11239
+ * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
11240
+ * so the conv-assist app can read sidebar configuration on initialisation.
11241
+ *
11242
+ * Precedence for `enablePastConversationsSidebar`:
11243
+ * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
11244
+ * deprecated top-level `enablePastConversationsSidebar` flag; if the former
11245
+ * is absent the latter is used as a fallback.
11246
+ *
11247
+ * An invalid `spotterDocumentationUrl` triggers a validation error and is
11248
+ * excluded from the payload rather than forwarded to the app.
11249
+ */
11250
+ protected getAppInitData(): Promise<AppEmbedAppInitData>;
10168
11251
  /**
10169
11252
  * Constructs a map of parameters to be passed on to the
10170
11253
  * embedded Liveboard or visualization.
@@ -10582,6 +11665,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10582
11665
  * ```
10583
11666
  */
10584
11667
  isPNGInScheduledEmailsEnabled?: boolean;
11668
+ /**
11669
+ * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
11670
+ * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
11671
+ * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
11672
+ *
11673
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
11674
+ * @type {boolean}
11675
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11676
+ * @example
11677
+ * ```js
11678
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
11679
+ * const embed = new <EmbedComponent>('#tsEmbed', {
11680
+ * ... // other embed view config
11681
+ * isContinuousLiveboardPDFEnabled: true,
11682
+ * })
11683
+ * ```
11684
+ */
11685
+ isContinuousLiveboardPDFEnabled?: boolean;
10585
11686
  /**
10586
11687
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
10587
11688
  *