@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
@@ -426,37 +426,49 @@ export interface CustomCssVariables {
426
426
  /**
427
427
  * Padding of the groups in the Liveboard.
428
428
  *
429
- * 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.
429
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
430
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
431
+ * this CSS variable.
430
432
  */
431
433
  "--ts-var-liveboard-group-padding"?: string;
432
434
  /**
433
435
  * Font size of the title of the groups in the Liveboard.
434
436
  *
435
- * 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.
437
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
438
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
439
+ * this CSS variable.
436
440
  */
437
441
  "--ts-var-liveboard-group-title-font-size"?: string;
438
442
  /**
439
443
  * Font weight of the title of the groups in the Liveboard.
440
444
  *
441
- * 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.
445
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
446
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
447
+ * this CSS variable.
442
448
  */
443
449
  "--ts-var-liveboard-group-title-font-weight"?: string;
444
450
  /**
445
451
  * Font size of the title of the tiles inside the groups in the Liveboard.
446
452
  *
447
- * 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.
453
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
454
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
455
+ * this CSS variable.
448
456
  */
449
457
  "--ts-var-liveboard-group-tile-title-font-size"?: string;
450
458
  /**
451
459
  * Font weight of the title of the tiles inside the groups in the Liveboard.
452
460
  *
453
- * 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.
461
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
462
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
463
+ * this CSS variable.
454
464
  */
455
465
  "--ts-var-liveboard-group-tile-title-font-weight"?: string;
456
466
  /**
457
467
  * Padding of the group tiles in the Liveboard.
458
468
  *
459
- * 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.
469
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
470
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
471
+ * this CSS variable.
460
472
  */
461
473
  "--ts-var-liveboard-group-tile-padding"?: string;
462
474
  /**
@@ -466,13 +478,17 @@ export interface CustomCssVariables {
466
478
  /**
467
479
  * Background color of the groups in the Liveboard.
468
480
  *
469
- * 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.
481
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
482
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
483
+ * this CSS variable.
470
484
  */
471
485
  "--ts-var-liveboard-group-background"?: string;
472
486
  /**
473
487
  * Border color of the groups in the Liveboard.
474
488
  *
475
- * 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.
489
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
490
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
491
+ * this CSS variable.
476
492
  */
477
493
  "--ts-var-liveboard-group-border-color"?: string;
478
494
  /**
@@ -486,55 +502,73 @@ export interface CustomCssVariables {
486
502
  /**
487
503
  * Font color of the title of the groups in the Liveboard.
488
504
  *
489
- * 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.
505
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
506
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
507
+ * this CSS variable.
490
508
  */
491
509
  "--ts-var-liveboard-group-title-font-color"?: string;
492
510
  /**
493
511
  * Font color of the description of the groups in the Liveboard.
494
512
  *
495
- * 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.
513
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
514
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
515
+ * this CSS variable.
496
516
  */
497
517
  "--ts-var-liveboard-group-description-font-color"?: string;
498
518
  /**
499
519
  * Font color of the title of the tiles inside the groups in the Liveboard.
500
520
  *
501
- * 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.
521
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
522
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
523
+ * this CSS variable.
502
524
  */
503
525
  "--ts-var-liveboard-group-tile-title-font-color"?: string;
504
526
  /**
505
527
  * Font color of the description of the tiles inside the groups in the Liveboard.
506
528
  *
507
- * 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.
529
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
530
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
531
+ * this CSS variable.
508
532
  */
509
533
  "--ts-var-liveboard-group-tile-description-font-color"?: string;
510
534
  /**
511
535
  * Background color of the tiles inside the groups in the Liveboard.
512
536
  *
513
- * 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.
537
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
538
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
539
+ * this CSS variable.
514
540
  */
515
541
  "--ts-var-liveboard-group-tile-background"?: string;
516
542
  /**
517
543
  * Background color of the filter chips in the Liveboard.
518
544
  *
519
- * 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.
545
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
546
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
547
+ * this CSS variable.
520
548
  */
521
549
  "--ts-var-liveboard-chip-background"?: string;
522
550
  /**
523
551
  * Font color of the filter chips in the Liveboard.
524
552
  *
525
- * 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.
553
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
554
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
555
+ * this CSS variable.
526
556
  */
527
557
  "--ts-var-liveboard-chip-color"?: string;
528
558
  /**
529
559
  * Background color of the filter chips in the Liveboard on hover.
530
560
  *
531
- * 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.
561
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
562
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
563
+ * this CSS variable.
532
564
  */
533
565
  "--ts-var-liveboard-chip--hover-background"?: string;
534
566
  /**
535
567
  * Background color of the filter chips in the Liveboard on active.
536
568
  *
537
- * 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.
569
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
570
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
571
+ * this CSS variable.
538
572
  */
539
573
  "--ts-var-liveboard-chip--active-background"?: string;
540
574
  /**
@@ -749,6 +783,42 @@ export interface CustomCssVariables {
749
783
  * Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar.
750
784
  */
751
785
  "--ts-var-saved-chats-section-title-color"?: string;
786
+ /**
787
+ * Text color of the styling panel in the Liveboard.
788
+ */
789
+ "--ts-var-liveboard-styling-panel-text-color"?: string;
790
+ /**
791
+ * Border color of the styling panel in the Liveboard.
792
+ */
793
+ "--ts-var-liveboard-styling-panel-border-color"?: string;
794
+ /**
795
+ * Background color of the styling button in the Liveboard.
796
+ */
797
+ "--ts-var-liveboard-styling-button-background"?: string;
798
+ /**
799
+ * Text color of the styling button in the Liveboard.
800
+ */
801
+ "--ts-var-liveboard-styling-button-text-color"?: string;
802
+ /**
803
+ * Background color of the styling button in the Liveboard on hover.
804
+ */
805
+ "--ts-var-liveboard-styling-button-hover-background"?: string;
806
+ /**
807
+ * Background color of the styling button in the Liveboard when active.
808
+ */
809
+ "--ts-var-liveboard-styling-button-active-background"?: string;
810
+ /**
811
+ * Text color of the styling button in the Liveboard on hover.
812
+ */
813
+ "--ts-var-liveboard-styling-button-hover-text-color"?: string;
814
+ /**
815
+ * Box shadow of the styling button in the Liveboard.
816
+ */
817
+ "--ts-var-liveboard-styling-button-shadow"?: string;
818
+ /**
819
+ * Background color of the color palette in the Liveboard styling panel.
820
+ */
821
+ "--ts-var-liveboard-styling-color-palette-background"?: string;
752
822
  }
753
823
  export interface SessionInterface {
754
824
  sessionId: string;
@@ -772,9 +842,11 @@ export interface UnderlyingDataPoint {
772
842
  * You can use this service to:
773
843
  *
774
844
  * - Add or remove columns from Answers (`addColumns`, `removeColumns`,
775
- * `addColumnsByName`) - Apply filters to Answers (`addFilter`)
845
+ * `addColumnsByName`)
846
+ * - Apply filters to Answers (`addFilter`)
776
847
  * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`,
777
- * `fetchCSVBlob`, `fetchPNGBlob`) - Get data for specific points in visualizations
848
+ * `fetchCSVBlob`, `fetchPNGBlob`)
849
+ * - Get data for specific points in visualizations
778
850
  * (`getUnderlyingDataForPoint`)
779
851
  * - Run custom queries (`executeQuery`)
780
852
  * - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`)
@@ -3593,6 +3665,17 @@ export declare enum EmbedEvent {
3593
3665
  * ```
3594
3666
  */
3595
3667
  DownloadAsXlsx = "downloadAsXlsx",
3668
+ /**
3669
+ * Emitted when the Download Liveboard as Continuous PDF action is triggered
3670
+ * on a Liveboard.
3671
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3672
+ * @example
3673
+ * ```js
3674
+ * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
3675
+ * console.log('download liveboard as continuous PDF', payload)})
3676
+ * ```
3677
+ */
3678
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
3596
3679
  /**
3597
3680
  * Emitted when an Answer is deleted in the app
3598
3681
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
@@ -3996,22 +4079,45 @@ export declare enum EmbedEvent {
3996
4079
  /**
3997
4080
  * Emitted when name, status (private or public) or filter values of a
3998
4081
  * Personalised view is updated.
4082
+ * This event is deprecated. Use {@link EmbedEvent.UpdatePersonalizedView} instead.
3999
4083
  * @returns viewName: string
4000
4084
  * @returns viewId: string
4001
4085
  * @returns liveboardId: string
4002
4086
  * @returns isPublic: boolean
4003
4087
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4088
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4004
4089
  */
4005
4090
  UpdatePersonalisedView = "updatePersonalisedView",
4091
+ /**
4092
+ * Emitted when name, status (private or public) or filter values of a
4093
+ * Personalized view is updated.
4094
+ * @returns viewName: string
4095
+ * @returns viewId: string
4096
+ * @returns liveboardId: string
4097
+ * @returns isPublic: boolean
4098
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4099
+ */
4100
+ UpdatePersonalizedView = "updatePersonalisedView",
4006
4101
  /**
4007
4102
  * Emitted when a Personalised view is saved.
4103
+ * This event is deprecated. Use {@link EmbedEvent.SavePersonalizedView} instead.
4008
4104
  * @returns viewName: string
4009
4105
  * @returns viewId: string
4010
4106
  * @returns liveboardId: string
4011
4107
  * @returns isPublic: boolean
4012
4108
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4109
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4013
4110
  */
4014
4111
  SavePersonalisedView = "savePersonalisedView",
4112
+ /**
4113
+ * Emitted when a Personalized view is saved.
4114
+ * @returns viewName: string
4115
+ * @returns viewId: string
4116
+ * @returns liveboardId: string
4117
+ * @returns isPublic: boolean
4118
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4119
+ */
4120
+ SavePersonalizedView = "savePersonalisedView",
4015
4121
  /**
4016
4122
  * Emitted when a Liveboard is reset.
4017
4123
  * @returns viewName: string
@@ -4023,11 +4129,41 @@ export declare enum EmbedEvent {
4023
4129
  ResetLiveboard = "resetLiveboard",
4024
4130
  /**
4025
4131
  * Emitted when a PersonalisedView is deleted.
4132
+ * This event is deprecated. Use {@link EmbedEvent.DeletePersonalizedView} instead.
4026
4133
  * @returns views: string[]
4027
4134
  * @returns liveboardId: string
4028
4135
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4136
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4029
4137
  */
4030
4138
  DeletePersonalisedView = "deletePersonalisedView",
4139
+ /**
4140
+ * Emitted when a PersonalizedView is deleted.
4141
+ * @returns views: string[]
4142
+ * @returns liveboardId: string
4143
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4144
+ */
4145
+ DeletePersonalizedView = "deletePersonalisedView",
4146
+ /**
4147
+ * Emitted when a user selects a different Personalized View or
4148
+ * resets to the original/default view on a Liveboard.
4149
+ * @example
4150
+ * ```js
4151
+ * liveboardEmbed.on(EmbedEvent.ChangePersonalizedView, (data) => {
4152
+ * console.log(data.viewName); // 'Q4 Revenue' or 'Original View'
4153
+ * console.log(data.viewId); // '2a021a12-...' or null (default)
4154
+ * console.log(data.liveboardId); // 'abc123...'
4155
+ * console.log(data.isPublic); // true | false
4156
+ * })
4157
+ * ```
4158
+ * @returns viewName: string - Name of the selected view,
4159
+ * or 'Original View' when reset to default.
4160
+ * @returns viewId: string | null - GUID of the selected view,
4161
+ * or null when reset to default.
4162
+ * @returns liveboardId: string
4163
+ * @returns isPublic: boolean
4164
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4165
+ */
4166
+ ChangePersonalizedView = "changePersonalisedView",
4031
4167
  /**
4032
4168
  * Emitted when a user creates a Worksheet.
4033
4169
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
@@ -4061,7 +4197,8 @@ export declare enum EmbedEvent {
4061
4197
  * @param - Includes the following parameters:
4062
4198
  * - `payload`: The payload received from the embed related to the Data API call.
4063
4199
  * - `responder`: Contains elements that let developers define whether ThoughtSpot
4064
- * will run or block the search operation, and if blocked, which error message to provide.
4200
+ * will run or block the search operation, and if blocked, which error message to
4201
+ * provide.
4065
4202
  * - `execute` - When `execute` returns `true`, the search is run.
4066
4203
  * When `execute` returns `false`, the search is not executed.
4067
4204
  * - `error` - Developers can customize the user-facing error message when `execute`
@@ -4495,6 +4632,25 @@ export declare enum EmbedEvent {
4495
4632
  * );
4496
4633
  * }
4497
4634
  * ```
4635
+ *
4636
+ * **Context Parameter (SDK: 1.45.2+)**
4637
+ *
4638
+ * Starting from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl, you can optionally pass a
4639
+ * `ContextType` as the third parameter to the `trigger` method to specify the context
4640
+ * from which the event is triggered. This helps ThoughtSpot understand the current page
4641
+ * context (Search, Answer, Liveboard, or Spotter) for better event handling.
4642
+ *
4643
+ * @example
4644
+ * ```js
4645
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
4646
+ *
4647
+ * // Trigger Pin event with Search context
4648
+ * appEmbed.trigger(HostEvent.Pin, {
4649
+ * vizId: "123",
4650
+ * liveboardId: "456"
4651
+ * }, ContextType.Search);
4652
+ * ```
4653
+ *
4498
4654
  * @group Events
4499
4655
  */
4500
4656
  export declare enum HostEvent {
@@ -4516,6 +4672,16 @@ export declare enum HostEvent {
4516
4672
  execute: true
4517
4673
  });
4518
4674
  * ```
4675
+ * @example
4676
+ * ```js
4677
+ * // Trigger search from search context
4678
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4679
+ * appEmbed.trigger(HostEvent.Search, {
4680
+ * searchQuery: "[revenue] by [region]",
4681
+ * dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
4682
+ * execute: true
4683
+ * }, ContextType.Search);
4684
+ * ```
4519
4685
  */
4520
4686
  Search = "search",
4521
4687
  /**
@@ -4566,6 +4732,24 @@ export declare enum HostEvent {
4566
4732
  * });
4567
4733
  * })
4568
4734
  * ```
4735
+ * @example
4736
+ * ```js
4737
+ * // Drill down from answer context
4738
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4739
+ * appEmbed.trigger(HostEvent.DrillDown, {
4740
+ * points: { clickedPoint, selectedPoints },
4741
+ * autoDrillDown: true
4742
+ * }, ContextType.Answer);
4743
+ * ```
4744
+ * @example
4745
+ * ```js
4746
+ * // Drill down from search context
4747
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4748
+ * searchEmbed.trigger(HostEvent.DrillDown, {
4749
+ * points: { clickedPoint, selectedPoints },
4750
+ * columnGuid: "column-guid"
4751
+ * }, ContextType.Search);
4752
+ * ```
4569
4753
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
4570
4754
  */
4571
4755
  DrillDown = "triggerDrillDown",
@@ -4586,6 +4770,13 @@ export declare enum HostEvent {
4586
4770
  * const url = embed.trigger(HostEvent.GetIframeUrl);
4587
4771
  * console.log("iFrameURL",url);
4588
4772
  * ```
4773
+ * @example
4774
+ * ```js
4775
+ * // Get iframe URL from specific context
4776
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4777
+ * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
4778
+ * console.log("iFrameURL", url);
4779
+ * ```
4589
4780
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4590
4781
  */
4591
4782
  GetIframeUrl = "GetIframeUrl",
@@ -4599,6 +4790,15 @@ export declare enum HostEvent {
4599
4790
  * '730496d6-6903-4601-937e-2c691821af3c',
4600
4791
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
4601
4792
  * ```
4793
+ * @example
4794
+ * ```js
4795
+ * // Set visible vizs from liveboard context
4796
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4797
+ * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
4798
+ * '730496d6-6903-4601-937e-2c691821af3c',
4799
+ * 'd547ec54-2a37-4516-a222-2b06719af726'
4800
+ * ], ContextType.Liveboard);
4801
+ * ```
4602
4802
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
4603
4803
  */
4604
4804
  SetVisibleVizs = "SetPinboardVisibleVizs",
@@ -4611,6 +4811,14 @@ export declare enum HostEvent {
4611
4811
  * tabId:'730496d6-6903-4601-937e-2c691821af3c'
4612
4812
  * })
4613
4813
  * ```
4814
+ * @example
4815
+ * ```js
4816
+ * // Set active tab from liveboard context
4817
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4818
+ * liveboardEmbed.trigger(HostEvent.SetActiveTab, {
4819
+ * tabId: '730496d6-6903-4601-937e-2c691821af3c'
4820
+ * }, ContextType.Liveboard);
4821
+ * ```
4614
4822
  * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw
4615
4823
  */
4616
4824
  SetActiveTab = "SetActiveTab",
@@ -4644,6 +4852,15 @@ export declare enum HostEvent {
4644
4852
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
4645
4853
  * ])
4646
4854
  * ```
4855
+ * @example
4856
+ * ```js
4857
+ * // Update runtime filters from liveboard context
4858
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4859
+ * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
4860
+ * {columnName: "region", operator: RuntimeFilterOp.EQ, values: ["west"]},
4861
+ * {columnName: "product", operator: RuntimeFilterOp.IN, values: ["shoes", "boots"]}
4862
+ * ], ContextType.Liveboard);
4863
+ * ```
4647
4864
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
4648
4865
  * @important
4649
4866
  */
@@ -4677,6 +4894,14 @@ export declare enum HostEvent {
4677
4894
  * LiveboardEmbed.trigger(HostEvent.OpenFilter,
4678
4895
  * { column: {columnId: '<column-GUID>'}})
4679
4896
  * ```
4897
+ * @example
4898
+ * ```js
4899
+ * // Open filter from search context
4900
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4901
+ * searchEmbed.trigger(HostEvent.OpenFilter, {
4902
+ * column: { columnId: '<column-GUID>', name: 'region', type: 'ATTRIBUTE', dataType: 'CHAR'}
4903
+ * }, ContextType.Search);
4904
+ * ```
4680
4905
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4681
4906
  */
4682
4907
  OpenFilter = "openFilter",
@@ -4687,6 +4912,14 @@ export declare enum HostEvent {
4687
4912
  * ```js
4688
4913
  * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
4689
4914
  * ```
4915
+ * @example
4916
+ * ```js
4917
+ * // Add columns from search context
4918
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4919
+ * searchEmbed.trigger(HostEvent.AddColumns, {
4920
+ * columnIds: ['col-guid-1', 'col-guid-2']
4921
+ * }, ContextType.Search);
4922
+ * ```
4690
4923
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4691
4924
  */
4692
4925
  AddColumns = "addColumns",
@@ -4697,6 +4930,14 @@ export declare enum HostEvent {
4697
4930
  * ```js
4698
4931
  * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
4699
4932
  * ```
4933
+ * @example
4934
+ * ```js
4935
+ * // Remove column from search context
4936
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4937
+ * searchEmbed.trigger(HostEvent.RemoveColumn, {
4938
+ * columnId: 'column-guid'
4939
+ * }, ContextType.Search);
4940
+ * ```
4700
4941
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4701
4942
  */
4702
4943
  RemoveColumn = "removeColumn",
@@ -4783,6 +5024,37 @@ export declare enum HostEvent {
4783
5024
  *
4784
5025
  * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
4785
5026
  * ```
5027
+ * @example
5028
+ * ```js
5029
+ * // Using context parameter to specify the context type (SDK: 1.45.2+)
5030
+ * // Pin from a search answer context
5031
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5032
+ * appEmbed.trigger(HostEvent.Pin, {
5033
+ * vizId: "123",
5034
+ * newVizName: "Sales by region",
5035
+ * liveboardId: "456"
5036
+ * }, ContextType.Search);
5037
+ * ```
5038
+ * @example
5039
+ * ```js
5040
+ * // Pin from an answer context (explore modal/page) (SDK: 1.45.2+)
5041
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5042
+ * appEmbed.trigger(HostEvent.Pin, {
5043
+ * vizId: "789",
5044
+ * newVizName: "Revenue trends",
5045
+ * liveboardId: "456"
5046
+ * }, ContextType.Answer);
5047
+ * ```
5048
+ * @example
5049
+ * ```js
5050
+ * // Pin from a spotter context (SDK: 1.45.2+)
5051
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5052
+ * appEmbed.trigger(HostEvent.Pin, {
5053
+ * vizId: latestSpotterVizId,
5054
+ * newVizName: "AI-generated insights",
5055
+ * liveboardId: "456"
5056
+ * }, ContextType.Spotter);
5057
+ * ```
4786
5058
  *
4787
5059
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4788
5060
  */
@@ -4793,6 +5065,12 @@ export declare enum HostEvent {
4793
5065
  * @example
4794
5066
  * ```js
4795
5067
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
5068
+ *```
5069
+ * @example
5070
+ * ```js
5071
+ * // Show liveboard info from liveboard context
5072
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5073
+ * liveboardEmbed.trigger(HostEvent.LiveboardInfo, {}, ContextType.Liveboard);
4796
5074
  * ```
4797
5075
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4798
5076
  */
@@ -4803,6 +5081,12 @@ export declare enum HostEvent {
4803
5081
  * ```js
4804
5082
  * liveboardEmbed.trigger(HostEvent.Schedule)
4805
5083
  * ```
5084
+ * @example
5085
+ * ```js
5086
+ * // Schedule from liveboard context
5087
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5088
+ * liveboardEmbed.trigger(HostEvent.Schedule, {}, ContextType.Liveboard);
5089
+ * ```
4806
5090
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4807
5091
  */
4808
5092
  Schedule = "subscription",
@@ -4812,6 +5096,12 @@ export declare enum HostEvent {
4812
5096
  * ```js
4813
5097
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
4814
5098
  * ```
5099
+ * @example
5100
+ * ```js
5101
+ * // Manage schedules from liveboard context
5102
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5103
+ * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
5104
+ * ```
4815
5105
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4816
5106
  */
4817
5107
  SchedulesList = "schedule-list",
@@ -4822,6 +5112,18 @@ export declare enum HostEvent {
4822
5112
  * ```js
4823
5113
  * liveboardEmbed.trigger(HostEvent.ExportTML)
4824
5114
  * ```
5115
+ * @example
5116
+ * ```js
5117
+ * // Export TML from liveboard context
5118
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5119
+ * liveboardEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Liveboard);
5120
+ * ```
5121
+ * @example
5122
+ * ```js
5123
+ * // Export TML from search-answer context
5124
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5125
+ * appEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Search);
5126
+ * ```
4825
5127
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4826
5128
  */
4827
5129
  ExportTML = "exportTSL",
@@ -4832,6 +5134,18 @@ export declare enum HostEvent {
4832
5134
  * ```js
4833
5135
  * liveboardEmbed.trigger(HostEvent.EditTML)
4834
5136
  * ```
5137
+ * @example
5138
+ * ```js
5139
+ * // Edit TML from liveboard context
5140
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5141
+ * liveboardEmbed.trigger(HostEvent.EditTML, {}, ContextType.Liveboard);
5142
+ * ```
5143
+ * @example
5144
+ * ```js
5145
+ * // Edit TML from search-answer context
5146
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5147
+ * appEmbed.trigger(HostEvent.EditTML, {}, ContextType.Search);
5148
+ * ```
4835
5149
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4836
5150
  */
4837
5151
  EditTML = "editTSL",
@@ -4841,6 +5155,12 @@ export declare enum HostEvent {
4841
5155
  * ```js
4842
5156
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
4843
5157
  * ```
5158
+ * @example
5159
+ * ```js
5160
+ * // Update TML from liveboard context
5161
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5162
+ * liveboardEmbed.trigger(HostEvent.UpdateTML, {}, ContextType.Liveboard);
5163
+ * ```
4844
5164
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4845
5165
  */
4846
5166
  UpdateTML = "updateTSL",
@@ -4867,10 +5187,34 @@ export declare enum HostEvent {
4867
5187
  *
4868
5188
  * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
4869
5189
  * ```
5190
+ * @example
5191
+ * ```js
5192
+ * // Download as PDF from search-answer context
5193
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5194
+ * appEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Search);
5195
+ * ```
5196
+ * @example
5197
+ * ```js
5198
+ * // Download as PDF from liveboard context
5199
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5200
+ * liveboardEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Liveboard);
5201
+ * ```
4870
5202
  *
4871
5203
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4872
5204
  */
4873
5205
  DownloadAsPdf = "downloadAsPdf",
5206
+ /**
5207
+ * Trigger the **Download Liveboard as Continuous PDF** action on an
5208
+ * embedded Liveboard.
5209
+ *
5210
+ * @example
5211
+ * ```js
5212
+ * liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
5213
+ * ```
5214
+ *
5215
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5216
+ */
5217
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
4874
5218
  /**
4875
5219
  * Trigger the **AI Highlights** action on an embedded Liveboard
4876
5220
  *
@@ -4911,6 +5255,18 @@ export declare enum HostEvent {
4911
5255
  *
4912
5256
  * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
4913
5257
  * ```
5258
+ * @example
5259
+ * ```js
5260
+ * // Make a copy from answer context
5261
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5262
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Answer);
5263
+ * ```
5264
+ * @example
5265
+ * ```js
5266
+ * // Make a copy from search context
5267
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5268
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Search);
5269
+ * ```
4914
5270
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4915
5271
  */
4916
5272
  MakeACopy = "makeACopy",
@@ -4935,6 +5291,14 @@ export declare enum HostEvent {
4935
5291
  * ```js
4936
5292
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4937
5293
  * ```
5294
+ * @example
5295
+ * ```js
5296
+ * // Explore from liveboard context
5297
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5298
+ * liveboardEmbed.trigger(HostEvent.Explore, {
5299
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5300
+ * }, ContextType.Liveboard);
5301
+ * ```
4938
5302
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4939
5303
  */
4940
5304
  Explore = "explore",
@@ -4952,6 +5316,20 @@ export declare enum HostEvent {
4952
5316
  * ```js
4953
5317
  * searchEmbed.trigger(HostEvent.CreateMonitor)
4954
5318
  * ```
5319
+ * @example
5320
+ * ```js
5321
+ * // Create monitor from answer context
5322
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5323
+ * appEmbed.trigger(HostEvent.CreateMonitor, {}, ContextType.Answer);
5324
+ * ```
5325
+ * @example
5326
+ * ```js
5327
+ * // Create monitor from liveboard context
5328
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5329
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
5330
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5331
+ * }, ContextType.Liveboard);
5332
+ * ```
4955
5333
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4956
5334
  */
4957
5335
  CreateMonitor = "createMonitor",
@@ -4973,6 +5351,20 @@ export declare enum HostEvent {
4973
5351
  * ```js
4974
5352
  * vizEmbed.trigger(HostEvent.ManageMonitor)
4975
5353
  * ```
5354
+ * @example
5355
+ * ```js
5356
+ * // Manage monitor from answer context
5357
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5358
+ * appEmbed.trigger(HostEvent.ManageMonitor, {}, ContextType.Answer);
5359
+ * ```
5360
+ * @example
5361
+ * ```js
5362
+ * // Manage monitor from liveboard context
5363
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5364
+ * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
5365
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5366
+ * }, ContextType.Liveboard);
5367
+ * ```
4976
5368
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4977
5369
  */
4978
5370
  ManageMonitor = "manageMonitor",
@@ -4998,6 +5390,26 @@ export declare enum HostEvent {
4998
5390
  * ```js
4999
5391
  * spotterEmbed.trigger(HostEvent.Edit);
5000
5392
  * ```
5393
+ * @example
5394
+ * ```js
5395
+ * // Using context parameter to edit liveboard context
5396
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5397
+ * liveboardEmbed.trigger(HostEvent.Edit, {}, ContextType.Liveboard);
5398
+ * ```
5399
+ * @example
5400
+ * ```js
5401
+ * // Edit from search context
5402
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5403
+ * appEmbed.trigger(HostEvent.Edit, {}, ContextType.Search);
5404
+ * ```
5405
+ * * @example
5406
+ * ```js
5407
+ * // Edit from spotter context
5408
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5409
+ * appEmbed.trigger(HostEvent.Edit, {
5410
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5411
+ * }, ContextType.Spotter);
5412
+ * ```
5001
5413
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5002
5414
  */
5003
5415
  Edit = "edit",
@@ -5015,6 +5427,34 @@ export declare enum HostEvent {
5015
5427
  * ```js
5016
5428
  * vizEmbed.trigger(HostEvent.CopyLink)
5017
5429
  * ```
5430
+ * @example
5431
+ * ```js
5432
+ * // Copy link from liveboard context
5433
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5434
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
5435
+ * ```
5436
+ * @example
5437
+ * ```js
5438
+ * // Copy link from liveboard visualization context
5439
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5440
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
5441
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5442
+ * }, ContextType.Liveboard);
5443
+ * ```
5444
+ * @example
5445
+ * ```js
5446
+ * // Copy link from liveboard context
5447
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5448
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
5449
+ * ```
5450
+ * @example
5451
+ * ```js
5452
+ * // Copy link from liveboard visualization context
5453
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5454
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
5455
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5456
+ * }, ContextType.Liveboard);
5457
+ * ```
5018
5458
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5019
5459
  */
5020
5460
  CopyLink = "embedDocument",
@@ -5032,6 +5472,34 @@ export declare enum HostEvent {
5032
5472
  * ```js
5033
5473
  * vizEmbed.trigger(HostEvent.Present)
5034
5474
  * ```
5475
+ * @example
5476
+ * ```js
5477
+ * // Present from liveboard visualization context
5478
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5479
+ * liveboardEmbed.trigger(HostEvent.Present, {
5480
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5481
+ * }, ContextType.Liveboard);
5482
+ * ```
5483
+ * @example
5484
+ * ```js
5485
+ * // Present from liveboard context
5486
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5487
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5488
+ * ```
5489
+ * @example
5490
+ * ```js
5491
+ * // Present from liveboard visualization context
5492
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5493
+ * liveboardEmbed.trigger(HostEvent.Present, {
5494
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5495
+ * }, ContextType.Liveboard);
5496
+ * ```
5497
+ * @example
5498
+ * ```js
5499
+ * // Present from liveboard context
5500
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5501
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5502
+ * ```
5035
5503
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5036
5504
  */
5037
5505
  Present = "present",
@@ -5060,6 +5528,22 @@ export declare enum HostEvent {
5060
5528
  * tml.answer.search_query // TML representation of the search query
5061
5529
  * );
5062
5530
  * })
5531
+ * ```
5532
+ * @example
5533
+ * ```js
5534
+ * // Get TML from search context
5535
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5536
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
5537
+ * console.log(tml.answer.search_query);
5538
+ * });
5539
+ * ```
5540
+ * @example
5541
+ * ```js
5542
+ * // Get TML from search-answer context
5543
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5544
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
5545
+ * console.log(tml.answer);
5546
+ * });
5063
5547
  * ```
5064
5548
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5065
5549
  * @important
@@ -5081,6 +5565,20 @@ export declare enum HostEvent {
5081
5565
  * ```js
5082
5566
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
5083
5567
  * ```
5568
+ * @example
5569
+ * ```js
5570
+ * // Show underlying data from liveboard visualization context
5571
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5572
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {
5573
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5574
+ * }, ContextType.Liveboard);
5575
+ * ```
5576
+ * @example
5577
+ * ```js
5578
+ * // Show underlying data from search context
5579
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5580
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {}, ContextType.Search);
5581
+ * ```
5084
5582
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5085
5583
  */
5086
5584
  ShowUnderlyingData = "showUnderlyingData",
@@ -5098,6 +5596,18 @@ export declare enum HostEvent {
5098
5596
  * ```js
5099
5597
  * searchEmbed.trigger(HostEvent.Delete)
5100
5598
  * ```
5599
+ * @example
5600
+ * ```js
5601
+ * // Delete from liveboard context
5602
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5603
+ * liveboardEmbed.trigger(HostEvent.Delete, {}, ContextType.Liveboard);
5604
+ * ```
5605
+ * @example
5606
+ * ```js
5607
+ * // Delete from search context
5608
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5609
+ * appEmbed.trigger(HostEvent.Delete, {}, ContextType.Search);
5610
+ * ```
5101
5611
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5102
5612
  */
5103
5613
  Delete = "onDeleteAnswer",
@@ -5118,6 +5628,20 @@ export declare enum HostEvent {
5118
5628
  * ```js
5119
5629
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
5120
5630
  * ```
5631
+ * @example
5632
+ * ```js
5633
+ * // SpotIQ analyze from search-answer context
5634
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5635
+ * appEmbed.trigger(HostEvent.SpotIQAnalyze, { vizId: '730496d6-6903-4601-937e-2c691821af3c' }, ContextType.Search);
5636
+ * ```
5637
+ * @example
5638
+ * ```js
5639
+ * // SpotIQ analyze from search context
5640
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5641
+ * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {
5642
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5643
+ * }, ContextType.Liveboard);
5644
+ * ```
5121
5645
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5122
5646
  */
5123
5647
  SpotIQAnalyze = "spotIQAnalyze",
@@ -5169,6 +5693,12 @@ export declare enum HostEvent {
5169
5693
  *
5170
5694
  * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
5171
5695
  * ```
5696
+ * @example
5697
+ * ```js
5698
+ * // Download as PNG from search-answer context
5699
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5700
+ * appEmbed.trigger(HostEvent.DownloadAsPng, {}, ContextType.Search);
5701
+ * ```
5172
5702
  *
5173
5703
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
5174
5704
  */
@@ -5197,6 +5727,18 @@ export declare enum HostEvent {
5197
5727
  *
5198
5728
  * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
5199
5729
  * ```
5730
+ * @example
5731
+ * ```js
5732
+ * // Download as CSV from search-answer context
5733
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5734
+ * appEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
5735
+ * ```
5736
+ * @example
5737
+ * ```js
5738
+ * // Download as CSV from search context
5739
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5740
+ * searchEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
5741
+ * ```
5200
5742
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5201
5743
  */
5202
5744
  DownloadAsCsv = "downloadAsCSV",
@@ -5224,6 +5766,18 @@ export declare enum HostEvent {
5224
5766
  *
5225
5767
  * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
5226
5768
  * ```
5769
+ * @example
5770
+ * ```js
5771
+ * // Download as XLSX from answer context
5772
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5773
+ * appEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Answer);
5774
+ * ```
5775
+ * @example
5776
+ * ```js
5777
+ * // Download as XLSX from search context
5778
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5779
+ * searchEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Search);
5780
+ * ```
5227
5781
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5228
5782
  */
5229
5783
  DownloadAsXlsx = "downloadAsXLSX",
@@ -5237,6 +5791,18 @@ export declare enum HostEvent {
5237
5791
  * ```js
5238
5792
  * searchEmbed.trigger(HostEvent.Share)
5239
5793
  * ```
5794
+ * @example
5795
+ * ```js
5796
+ * // Share from Liveboard context
5797
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5798
+ * liveboardEmbed.trigger(HostEvent.Share, {}, ContextType.Liveboard);
5799
+ * ```
5800
+ * @example
5801
+ * ```js
5802
+ * // Share from search-answer context
5803
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5804
+ * appEmbed.trigger(HostEvent.Share, {}, ContextType.Search);
5805
+ * ```
5240
5806
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5241
5807
  */
5242
5808
  Share = "share",
@@ -5276,6 +5842,18 @@ export declare enum HostEvent {
5276
5842
  *
5277
5843
  * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
5278
5844
  * ```
5845
+ * @example
5846
+ * ```js
5847
+ * // Save from answer context
5848
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5849
+ * appEmbed.trigger(HostEvent.Save, {}, ContextType.Answer);
5850
+ * ```
5851
+ * @example
5852
+ * ```js
5853
+ * // Save from search context
5854
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5855
+ * searchEmbed.trigger(HostEvent.Save, {}, ContextType.Search);
5856
+ * ```
5279
5857
  *
5280
5858
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5281
5859
  */
@@ -5292,6 +5870,20 @@ export declare enum HostEvent {
5292
5870
  * ```js
5293
5871
  * vizEmbed.trigger(HostEvent.SyncToSheets)
5294
5872
  * ```
5873
+ * @example
5874
+ * ```js
5875
+ * // Sync to sheets from answer context
5876
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5877
+ * appEmbed.trigger(HostEvent.SyncToSheets, {}, ContextType.Answer);
5878
+ * ```
5879
+ * @example
5880
+ * ```js
5881
+ * // Sync to sheets from liveboard context
5882
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5883
+ * liveboardEmbed.trigger(HostEvent.SyncToSheets, {
5884
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5885
+ * }, ContextType.Liveboard);
5886
+ * ```
5295
5887
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5296
5888
  */
5297
5889
  SyncToSheets = "sync-to-sheets",
@@ -5302,11 +5894,25 @@ export declare enum HostEvent {
5302
5894
  * @param - an object with vizId as a key
5303
5895
  * @example
5304
5896
  * ```js
5305
- * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
5306
- * '730496d6-6903-4601-937e-2c691821af3c'})
5897
+ * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
5898
+ * '730496d6-6903-4601-937e-2c691821af3c'})
5899
+ * ```
5900
+ * ```js
5901
+ * vizEmbed.trigger(HostEvent.SyncToOtherApps)
5902
+ * ```
5903
+ * @example
5904
+ * ```js
5905
+ * // Sync to other apps from answer context
5906
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5907
+ * appEmbed.trigger(HostEvent.SyncToOtherApps, {}, ContextType.Answer);
5307
5908
  * ```
5909
+ * @example
5308
5910
  * ```js
5309
- * vizEmbed.trigger(HostEvent.SyncToOtherApps)
5911
+ * // Sync to other apps from liveboard context
5912
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5913
+ * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {
5914
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5915
+ * }, ContextType.Liveboard);
5310
5916
  * ```
5311
5917
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5312
5918
  */
@@ -5324,6 +5930,20 @@ export declare enum HostEvent {
5324
5930
  * ```js
5325
5931
  * vizEmbed.trigger(HostEvent.ManagePipelines)
5326
5932
  * ```
5933
+ * @example
5934
+ * ```js
5935
+ * // Manage pipelines from answer context
5936
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5937
+ * appEmbed.trigger(HostEvent.ManagePipelines, {}, ContextType.Answer);
5938
+ * ```
5939
+ * @example
5940
+ * ```js
5941
+ * // Manage pipelines from liveboard context
5942
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5943
+ * liveboardEmbed.trigger(HostEvent.ManagePipelines, {
5944
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5945
+ * }, ContextType.Liveboard);
5946
+ * ```
5327
5947
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5328
5948
  */
5329
5949
  ManagePipelines = "manage-pipeline",
@@ -5336,6 +5956,12 @@ export declare enum HostEvent {
5336
5956
  * ```js
5337
5957
  * appEmbed.trigger(HostEvent.ResetSearch)
5338
5958
  * ```
5959
+ * @example
5960
+ * ```js
5961
+ * // Reset search from search context
5962
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5963
+ * searchEmbed.trigger(HostEvent.ResetSearch, {}, ContextType.Search);
5964
+ * ```
5339
5965
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
5340
5966
  */
5341
5967
  ResetSearch = "resetSearch",
@@ -5347,6 +5973,13 @@ export declare enum HostEvent {
5347
5973
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
5348
5974
  * console.log('data', data);
5349
5975
  * ```
5976
+ * @example
5977
+ * ```js
5978
+ * // Get filters from liveboard context
5979
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5980
+ * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
5981
+ * console.log('filters', data);
5982
+ * ```
5350
5983
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5351
5984
  */
5352
5985
  GetFilters = "getFilters",
@@ -5354,7 +5987,8 @@ export declare enum HostEvent {
5354
5987
  * Update one or several filters applied on a Liveboard.
5355
5988
  * @param - Includes the following keys:
5356
5989
  * - `filter`: A single filter object containing column name, filter operator, and
5357
- * values. - `filters`: Multiple filter objects with column name, filter operator,
5990
+ * values.
5991
+ * - `filters`: Multiple filter objects with column name, filter operator,
5358
5992
  * and values for each.
5359
5993
  *
5360
5994
  * Each filter object must include the following attributes:
@@ -5437,6 +6071,18 @@ export declare enum HostEvent {
5437
6071
  * }]
5438
6072
  * });
5439
6073
  * ```
6074
+ * @example
6075
+ * ```js
6076
+ * // Update filters from liveboard context
6077
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6078
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
6079
+ * filter: {
6080
+ * column: "item type",
6081
+ * oper: "IN",
6082
+ * values: ["shoes", "boots"]
6083
+ * }
6084
+ * }, ContextType.Liveboard);
6085
+ * ```
5440
6086
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5441
6087
  */
5442
6088
  UpdateFilters = "updateFilters",
@@ -5450,6 +6096,14 @@ export declare enum HostEvent {
5450
6096
  * );
5451
6097
  * })
5452
6098
  * ```
6099
+ * @example
6100
+ * ```js
6101
+ * // Get tabs from liveboard context
6102
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6103
+ * liveboardEmbed.trigger(HostEvent.GetTabs, {}, ContextType.Liveboard).then((tabDetails) => {
6104
+ * console.log('tabs', tabDetails);
6105
+ * });
6106
+ * ```
5453
6107
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5454
6108
  */
5455
6109
  GetTabs = "getTabs",
@@ -5463,6 +6117,15 @@ export declare enum HostEvent {
5463
6117
  * '430496d6-6903-4601-937e-2c691821af3c',
5464
6118
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
5465
6119
  * ```
6120
+ * @example
6121
+ * ```js
6122
+ * // Set visible tabs from liveboard context
6123
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6124
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
6125
+ * '430496d6-6903-4601-937e-2c691821af3c',
6126
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
6127
+ * ], ContextType.Liveboard);
6128
+ * ```
5466
6129
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5467
6130
  */
5468
6131
  SetVisibleTabs = "SetPinboardVisibleTabs",
@@ -5476,6 +6139,15 @@ export declare enum HostEvent {
5476
6139
  * '630496d6-6903-4601-937e-2c691821af3c',
5477
6140
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
5478
6141
  * ```
6142
+ * @example
6143
+ * ```js
6144
+ * // Set hidden tabs from liveboard context
6145
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6146
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
6147
+ * '630496d6-6903-4601-937e-2c691821af3c',
6148
+ * 'i547ec54-2a37-4516-a222-2b06719af726'
6149
+ * ], ContextType.Liveboard);
6150
+ * ```
5479
6151
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5480
6152
  */
5481
6153
  SetHiddenTabs = "SetPinboardHiddenTabs",
@@ -5552,13 +6224,24 @@ export declare enum HostEvent {
5552
6224
  UpdateCrossFilter = "UpdateCrossFilter",
5553
6225
  /**
5554
6226
  * Trigger reset action for a personalized Liveboard view.
6227
+ * This event is deprecated. Use {@link HostEvent.ResetLiveboardPersonalizedView} instead.
5555
6228
  * @example
5556
6229
  * ```js
5557
6230
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
5558
6231
  * ```
5559
6232
  * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
6233
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5560
6234
  */
5561
6235
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
6236
+ /**
6237
+ * Trigger reset action for a personalized Liveboard view.
6238
+ * @example
6239
+ * ```js
6240
+ * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalizedView);
6241
+ * ```
6242
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6243
+ */
6244
+ ResetLiveboardPersonalizedView = "ResetLiveboardPersonalisedView",
5562
6245
  /**
5563
6246
  * Triggers an action to update Parameter values on embedded
5564
6247
  * Answers, Liveboard, and Spotter answer in Edit mode.
@@ -5575,6 +6258,16 @@ export declare enum HostEvent {
5575
6258
  * isVisibleToUser: false
5576
6259
  * }])
5577
6260
  * ```
6261
+ * @example
6262
+ * ```js
6263
+ * // Update parameters from liveboard context
6264
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6265
+ * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
6266
+ * name: "Region Param",
6267
+ * value: "West",
6268
+ * isVisibleToUser: true
6269
+ * }], ContextType.Liveboard);
6270
+ * ```
5578
6271
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5579
6272
  */
5580
6273
  UpdateParameters = "UpdateParameters",
@@ -5594,18 +6287,77 @@ export declare enum HostEvent {
5594
6287
  * });
5595
6288
  *
5596
6289
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
6290
+ *```
6291
+ * @example
6292
+ * ```js
6293
+ * // Get parameters from liveboard context
6294
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6295
+ * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
6296
+ * console.log('parameters', parameters);
6297
+ * });
5597
6298
  * ```
5598
6299
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5599
6300
  */
5600
6301
  GetParameters = "GetParameters",
5601
6302
  /**
5602
6303
  * Triggers an event to update a personalized view of a Liveboard.
6304
+ * This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
5603
6305
  * ```js
5604
6306
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5605
6307
  * ```
6308
+ * @example
6309
+ * ```js
6310
+ * // Update personalized view from liveboard context
6311
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6312
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {
6313
+ * viewId: '1234'
6314
+ * }, ContextType.Liveboard);
6315
+ * ```
5606
6316
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
6317
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5607
6318
  */
5608
6319
  UpdatePersonalisedView = "UpdatePersonalisedView",
6320
+ /**
6321
+ * Triggers an event to update a personalized view of a Liveboard.
6322
+ * ```js
6323
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
6324
+ * ```
6325
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6326
+ */
6327
+ UpdatePersonalizedView = "UpdatePersonalisedView",
6328
+ /**
6329
+ * Triggers selection of a specific Personalized View on a
6330
+ * Liveboard without reloading the embed. Pass either a
6331
+ * `viewId` (GUID) or `viewName`. If both are provided, `viewId` takes precedence.
6332
+ * If neither is provided, the Liveboard resets to the original/default view.
6333
+ * When a `viewName` is provided and multiple views share
6334
+ * the same name, the first match is selected.
6335
+ * @example
6336
+ * ```js
6337
+ * liveboardEmbed.trigger(
6338
+ * HostEvent.SelectPersonalizedView,
6339
+ * { viewId: '2a021a12-1aed-425d-984b-141ee916ce72' },
6340
+ * )
6341
+ * ```
6342
+ * @example
6343
+ * ```js
6344
+ * // Select by name
6345
+ * liveboardEmbed.trigger(
6346
+ * HostEvent.SelectPersonalizedView,
6347
+ * { viewName: 'Dr Smith Cardiology' },
6348
+ * )
6349
+ * ```
6350
+ * @example
6351
+ * ```js
6352
+ * // Reset to default view
6353
+ * liveboardEmbed.trigger(
6354
+ * HostEvent.SelectPersonalizedView,
6355
+ * {},
6356
+ * )
6357
+ * ```
6358
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6359
+ */
6360
+ SelectPersonalizedView = "SelectPersonalisedView",
5609
6361
  /**
5610
6362
  * @hidden
5611
6363
  * Notify when info call is completed successfully
@@ -5625,7 +6377,8 @@ export declare enum HostEvent {
5625
6377
  * add a name and description for the Answer.
5626
6378
  * @param - Includes the following keys:
5627
6379
  * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
5628
- * embed. - `name`: Optional. Name string for the Answer.
6380
+ * embed.
6381
+ * - `name`: Optional. Name string for the Answer.
5629
6382
  * - `description`: Optional. Description text for the Answer.
5630
6383
  * @example
5631
6384
  * ```js
@@ -5644,6 +6397,34 @@ export declare enum HostEvent {
5644
6397
  *
5645
6398
  * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
5646
6399
  * ```
6400
+ * @example
6401
+ * ```js
6402
+ * // Using context parameter to save answer from search context
6403
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6404
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6405
+ * name: "Regional sales analysis",
6406
+ * description: "Sales breakdown by region"
6407
+ * }, ContextType.Search);
6408
+ * ```
6409
+ * @example
6410
+ * ```js
6411
+ * // Save answer from answer context (explore modal)
6412
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6413
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6414
+ * name: "Modified analysis",
6415
+ * description: "Updated from explore view"
6416
+ * }, ContextType.Answer);
6417
+ * ```
6418
+ * @example
6419
+ * ```js
6420
+ * // Save answer from spotter context
6421
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6422
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6423
+ * vizId: latestSpotterVizId,
6424
+ * name: "AI insights",
6425
+ * description: "Generated from Spotter"
6426
+ * }, ContextType.Spotter);
6427
+ * ```
5647
6428
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5648
6429
  */
5649
6430
  SaveAnswer = "saveAnswer",
@@ -5685,6 +6466,15 @@ export declare enum HostEvent {
5685
6466
  * executeSearch: true,
5686
6467
  * })
5687
6468
  * ```
6469
+ * @example
6470
+ * ```js
6471
+ * // Spotter search from spotter context
6472
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6473
+ * spotterEmbed.trigger(HostEvent.SpotterSearch, {
6474
+ * query: 'sales by region',
6475
+ * executeSearch: true
6476
+ * }, ContextType.Spotter);
6477
+ * ```
5688
6478
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5689
6479
  */
5690
6480
  SpotterSearch = "SpotterSearch",
@@ -5695,6 +6485,12 @@ export declare enum HostEvent {
5695
6485
  * ```js
5696
6486
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
5697
6487
  * ```
6488
+ * @example
6489
+ * ```js
6490
+ * // Edit last prompt from spotter context
6491
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6492
+ * spotterEmbed.trigger(HostEvent.EditLastPrompt, "sales by region", ContextType.Spotter);
6493
+ * ```
5698
6494
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5699
6495
  */
5700
6496
  EditLastPrompt = "EditLastPrompt",
@@ -5704,6 +6500,12 @@ export declare enum HostEvent {
5704
6500
  * ```js
5705
6501
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
5706
6502
  * ```
6503
+ * @example
6504
+ * ```js
6505
+ * // Preview spotter data from spotter context
6506
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6507
+ * spotterEmbed.trigger(HostEvent.PreviewSpotterData, {}, ContextType.Spotter);
6508
+ * ```
5707
6509
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5708
6510
  */
5709
6511
  PreviewSpotterData = "PreviewSpotterData",
@@ -6183,6 +6985,16 @@ export declare enum Action {
6183
6985
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
6184
6986
  */
6185
6987
  DownloadLiveboard = "downloadLiveboard",
6988
+ /**
6989
+ * The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
6990
+ * Allows downloading the entire Liveboard as a continuous PDF.
6991
+ * @example
6992
+ * ```js
6993
+ * disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
6994
+ * ```
6995
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6996
+ */
6997
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
6186
6998
  /**
6187
6999
  * @hidden
6188
7000
  */
@@ -6816,13 +7628,25 @@ export declare enum Action {
6816
7628
  /**
6817
7629
  * The Liveboard Personalised Views dropdown.
6818
7630
  * Allows navigating to a personalized Liveboard View.
7631
+ * This action is deprecated. Use {@link Action.PersonalizedViewsDropdown} instead.
6819
7632
  * @example
6820
7633
  * ```js
6821
7634
  * disabledActions: [Action.PersonalisedViewsDropdown]
6822
7635
  * ```
6823
7636
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
7637
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6824
7638
  */
6825
7639
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
7640
+ /**
7641
+ * The Liveboard Personalized Views dropdown.
7642
+ * Allows navigating to a personalized Liveboard View.
7643
+ * @example
7644
+ * ```js
7645
+ * disabledActions: [Action.PersonalizedViewsDropdown]
7646
+ * ```
7647
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7648
+ */
7649
+ PersonalizedViewsDropdown = "personalisedViewsDropdown",
6826
7650
  /**
6827
7651
  * Action ID for show or hide the user details on a
6828
7652
  * Liveboard (Recently visited / social proof)
@@ -6910,14 +7734,27 @@ export declare enum Action {
6910
7734
  /**
6911
7735
  * The **Organize Favourites** action on Homepage
6912
7736
  * *Favorites* module.
7737
+ * This action is deprecated. Use {@link Action.OrganizeFavorites} instead.
6913
7738
  *
6914
7739
  * @example
6915
7740
  * ```js
6916
7741
  * disabledActions: [Action.OrganiseFavourites]
6917
7742
  * ```
6918
7743
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
7744
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6919
7745
  */
6920
7746
  OrganiseFavourites = "organiseFavourites",
7747
+ /**
7748
+ * The **Organize Favorites** action on Homepage
7749
+ * *Favorites* module.
7750
+ *
7751
+ * @example
7752
+ * ```js
7753
+ * disabledActions: [Action.OrganizeFavorites]
7754
+ * ```
7755
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7756
+ */
7757
+ OrganizeFavorites = "organiseFavourites",
6921
7758
  /**
6922
7759
  * The **AI Highlights** action on a Liveboard.
6923
7760
  *
@@ -7373,6 +8210,39 @@ export declare enum Action {
7373
8210
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7374
8211
  */
7375
8212
  SpotterDocs = "spotterDocs",
8213
+ /**
8214
+ * Controls visibility and disable state of the connector resources
8215
+ * section in the Spotter chat interface.
8216
+ * @example
8217
+ * ```js
8218
+ * hiddenActions: [Action.SpotterChatConnectorResources]
8219
+ * disabledActions: [Action.SpotterChatConnectorResources]
8220
+ * ```
8221
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8222
+ */
8223
+ SpotterChatConnectorResources = "spotterChatConnectorResources",
8224
+ /**
8225
+ * Controls visibility and disable state of the connectors
8226
+ * in the Spotter chat interface.
8227
+ * @example
8228
+ * ```js
8229
+ * hiddenActions: [Action.SpotterChatConnectors]
8230
+ * disabledActions: [Action.SpotterChatConnectors]
8231
+ * ```
8232
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8233
+ */
8234
+ SpotterChatConnectors = "spotterChatConnectors",
8235
+ /**
8236
+ * Controls visibility and disable state of the mode switcher
8237
+ * in the Spotter chat interface.
8238
+ * @example
8239
+ * ```js
8240
+ * hiddenActions: [Action.SpotterChatModeSwitcher]
8241
+ * disabledActions: [Action.SpotterChatModeSwitcher]
8242
+ * ```
8243
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8244
+ */
8245
+ SpotterChatModeSwitcher = "spotterChatModeSwitcher",
7376
8246
  /**
7377
8247
  * The **Include current period** checkbox for date filters.
7378
8248
  * Controls the visibility and availability of the option to include
@@ -7716,7 +8586,13 @@ export declare enum EmbedErrorCodes {
7716
8586
  /** Failed to update embed parameters during pre-render */
7717
8587
  UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
7718
8588
  /** Invalid URL provided in configuration */
7719
- INVALID_URL = "INVALID_URL"
8589
+ INVALID_URL = "INVALID_URL",
8590
+ /** Host event payload validation failed */
8591
+ HOST_EVENT_VALIDATION = "HOST_EVENT_VALIDATION",
8592
+ /** UpdateFilters payload is invalid - missing or malformed filter/filters */
8593
+ UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
8594
+ /** DrillDown payload is invalid - missing or malformed points */
8595
+ DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
7720
8596
  }
7721
8597
  /**
7722
8598
  * Error event object emitted when an error occurs in an embedded component.
@@ -7729,7 +8605,8 @@ export declare enum EmbedErrorCodes {
7729
8605
  *
7730
8606
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
7731
8607
  * - **message**: Human-readable error description (string or array of strings for
7732
- * multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
8608
+ * multiple errors)
8609
+ * - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
7733
8610
  * values
7734
8611
  * - **[key: string]**: Additional context-specific for backward compatibility
7735
8612
  *
@@ -7777,6 +8654,22 @@ export interface EmbedErrorDetailsEvent {
7777
8654
  /** Additional context-specific for backward compatibility */
7778
8655
  [key: string]: any;
7779
8656
  }
8657
+ /**
8658
+ * Context types for specifying the page context when triggering host events.
8659
+ * Used as the third parameter in the `trigger` method to help ThoughtSpot
8660
+ * understand the current page context for better event handling.
8661
+ *
8662
+ * @example
8663
+ * ```js
8664
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
8665
+ *
8666
+ * // Trigger an event with specific context
8667
+ * embed.trigger(HostEvent.Pin, { vizId: "123", liveboardId: "456" }, ContextType.Search);
8668
+ * ```
8669
+ *
8670
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
8671
+ * @group Events
8672
+ */
7780
8673
  export declare enum ContextType {
7781
8674
  /**
7782
8675
  * Search answer context for search page or edit viz dialog on liveboard page.
@@ -7793,7 +8686,11 @@ export declare enum ContextType {
7793
8686
  /**
7794
8687
  * Spotter context for spotter modal/page.
7795
8688
  */
7796
- Spotter = "spotter"
8689
+ Spotter = "spotter",
8690
+ /**
8691
+ * Other context for any other generic page.
8692
+ */
8693
+ Other = "other"
7797
8694
  }
7798
8695
  export interface DefaultAppInitData {
7799
8696
  customisations: CustomisationsInterface;
@@ -7896,33 +8793,6 @@ export interface ObjectIds {
7896
8793
  */
7897
8794
  modalTitle?: string;
7898
8795
  }
7899
- /**
7900
- * Context object for the embedded component.
7901
- * @example
7902
- * ```js
7903
- * const context = await embed.getCurrentContext();
7904
- * console.log(context);
7905
- * {
7906
- * stack: [
7907
- * {
7908
- * name: 'Liveboard',
7909
- * type: ContextType.Liveboard,
7910
- * objectIds: {
7911
- * liveboardId: '123',
7912
- * },
7913
- * },
7914
- * ],
7915
- * currentContext: {
7916
- * name: 'Liveboard',
7917
- * type: ContextType.Liveboard,
7918
- * objectIds: {
7919
- * liveboardId: '123',
7920
- * },
7921
- * },
7922
- * }
7923
- * ```
7924
- * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
7925
- */
7926
8796
  export interface ContextObject {
7927
8797
  /**
7928
8798
  * Stack of context objects.
@@ -7953,6 +8823,11 @@ export interface ContextObject {
7953
8823
  objectIds: ObjectIds;
7954
8824
  };
7955
8825
  }
8826
+ export interface LiveboardTab {
8827
+ id: string;
8828
+ name: string;
8829
+ [key: string]: any;
8830
+ }
7956
8831
  export declare enum UIPassthroughEvent {
7957
8832
  PinAnswerToLiveboard = "addVizToPinboard",
7958
8833
  SaveAnswer = "saveAnswer",
@@ -7960,7 +8835,16 @@ export declare enum UIPassthroughEvent {
7960
8835
  GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
7961
8836
  GetAnswerConfig = "getAnswerPageConfig",
7962
8837
  GetLiveboardConfig = "getPinboardPageConfig",
7963
- GetUnsavedAnswerTML = "getUnsavedAnswerTML"
8838
+ GetUnsavedAnswerTML = "getUnsavedAnswerTML",
8839
+ UpdateFilters = "updateFilters",
8840
+ Drilldown = "drillDown",
8841
+ GetAnswerSession = "getAnswerSession",
8842
+ GetFilters = "getFilters",
8843
+ GetIframeUrl = "getIframeUrl",
8844
+ GetParameters = "getParameters",
8845
+ GetTML = "getTML",
8846
+ GetTabs = "getTabs",
8847
+ GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
7964
8848
  }
7965
8849
  export type UIPassthroughContractBase = {
7966
8850
  [UIPassthroughEvent.PinAnswerToLiveboard]: {
@@ -8024,17 +8908,104 @@ export type UIPassthroughContractBase = {
8024
8908
  tml: string;
8025
8909
  };
8026
8910
  };
8911
+ [UIPassthroughEvent.GetAnswerSession]: {
8912
+ request: {
8913
+ vizId?: string;
8914
+ };
8915
+ response: {
8916
+ session: SessionInterface;
8917
+ embedAnswerData?: Record<string, any>;
8918
+ };
8919
+ };
8920
+ [UIPassthroughEvent.GetFilters]: {
8921
+ request: {
8922
+ vizId?: string;
8923
+ };
8924
+ response: {
8925
+ liveboardFilters: Record<string, any>[];
8926
+ runtimeFilters: RuntimeFilter[];
8927
+ };
8928
+ };
8929
+ [UIPassthroughEvent.GetIframeUrl]: {
8930
+ request: Record<string, never>;
8931
+ response: {
8932
+ iframeUrl: string;
8933
+ };
8934
+ };
8935
+ [UIPassthroughEvent.GetParameters]: {
8936
+ request: Record<string, never>;
8937
+ response: {
8938
+ parameters: Record<string, any>[];
8939
+ };
8940
+ };
8941
+ [UIPassthroughEvent.GetTML]: {
8942
+ request: {
8943
+ vizId?: string;
8944
+ includeNonExecutedSearchTokens?: boolean;
8945
+ };
8946
+ response: Record<string, any>;
8947
+ };
8948
+ [UIPassthroughEvent.GetTabs]: {
8949
+ request: Record<string, never>;
8950
+ response: {
8951
+ orderedTabIds: string[];
8952
+ numberOfTabs: number;
8953
+ Tabs: LiveboardTab[];
8954
+ };
8955
+ };
8956
+ [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
8957
+ request: Record<string, never>;
8958
+ response: {
8959
+ v2Content: string;
8960
+ };
8961
+ };
8962
+ [UIPassthroughEvent.UpdateFilters]: {
8963
+ request: {
8964
+ filter?: {
8965
+ column: string;
8966
+ oper: string;
8967
+ values: string[];
8968
+ type?: string;
8969
+ };
8970
+ filters?: {
8971
+ column: string;
8972
+ oper: string;
8973
+ values: string[];
8974
+ type?: string;
8975
+ }[];
8976
+ };
8977
+ response: unknown;
8978
+ };
8979
+ [UIPassthroughEvent.Drilldown]: {
8980
+ request: {
8981
+ points: {
8982
+ selectedPoints?: string[];
8983
+ clickedPoint?: string;
8984
+ };
8985
+ columnGuid?: string;
8986
+ autoDrillDown?: boolean;
8987
+ vizId?: string;
8988
+ };
8989
+ response: unknown;
8990
+ };
8027
8991
  };
8028
8992
  export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
8029
8993
  export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
8030
8994
  export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> = Array<{
8031
- redId?: string;
8995
+ refId?: string;
8032
8996
  value?: UIPassthroughResponse<ApiName>;
8033
8997
  error?: any;
8034
8998
  }>;
8035
8999
  export type EmbedApiHostEventMapping = {
8036
9000
  [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
8037
9001
  [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
9002
+ [HostEvent.GetAnswerSession]: UIPassthroughEvent.GetAnswerSession;
9003
+ [HostEvent.GetFilters]: UIPassthroughEvent.GetFilters;
9004
+ [HostEvent.GetIframeUrl]: UIPassthroughEvent.GetIframeUrl;
9005
+ [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
9006
+ [HostEvent.GetTML]: UIPassthroughEvent.GetTML;
9007
+ [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
9008
+ [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
8038
9009
  };
8039
9010
  export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
8040
9011
  export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
@@ -8042,6 +9013,12 @@ export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT |
8042
9013
  export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
8043
9014
  declare class HostEventClient {
8044
9015
  iFrame: HTMLIFrameElement;
9016
+ /** Cached list of available UI passthrough keys from the embedded app */
9017
+ private availablePassthroughKeysCache;
9018
+ /** Host events with custom handlers
9019
+ * (setters or special logic) -
9020
+ * bound to instance for protected method access */
9021
+ private readonly customHandlers;
8045
9022
  constructor(iFrame?: HTMLIFrameElement);
8046
9023
  /**
8047
9024
  * A wrapper over process trigger to
@@ -8052,14 +9029,36 @@ declare class HostEventClient {
8052
9029
  protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
8053
9030
  handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
8054
9031
  hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
9032
+ /**
9033
+ * For getter events that return data. Tries UI passthrough first;
9034
+ * if the app doesn't support it (no response data), falls back to
9035
+ * the legacy host event channel. Real errors are thrown as-is.
9036
+ */
9037
+ private getDataWithPassthroughFallback;
8055
9038
  /**
8056
9039
  * Setter for the iframe element used for host events
8057
9040
  * @param {HTMLIFrameElement} iFrame - the iframe element to set
8058
9041
  */
8059
9042
  setIframeElement(iFrame: HTMLIFrameElement): void;
9043
+ /**
9044
+ * Fetches the list of available UI passthrough keys from the embedded app.
9045
+ * Result is cached for the session. Returns empty array on failure.
9046
+ */
9047
+ private getAvailableUIPassthroughKeys;
8060
9048
  triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
8061
9049
  protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
8062
9050
  protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
9051
+ protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
9052
+ protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
9053
+ /**
9054
+ * Dispatches a host event using the appropriate channel:
9055
+ * 1. If the embedded app supports UI passthrough for this event, use it (custom handler or getter).
9056
+ * 2. Otherwise fall back to the legacy host event channel.
9057
+ *
9058
+ * @param hostEvent - The host event to trigger
9059
+ * @param payload - Optional payload for the event
9060
+ * @param context - Optional context (e.g. vizId) for scoped operations
9061
+ */
8063
9062
  triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
8064
9063
  }
8065
9064
  declare class TsEmbed {
@@ -8395,7 +9394,21 @@ declare class TsEmbed {
8395
9394
  * Triggers an event to the embedded app
8396
9395
  * @param {HostEvent} messageType The event type
8397
9396
  * @param {any} data The payload to send with the message
9397
+ * @param {ContextType} context Optional context type to specify the context from which the event is triggered.
9398
+ * Use ContextType.Search for search answer context, ContextType.Answer for answer/explore context,
9399
+ * ContextType.Liveboard for liveboard context, or ContextType.Spotter for spotter context.
9400
+ * Available from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl
8398
9401
  * @returns A promise that resolves with the response from the embedded app
9402
+ * @example
9403
+ * ```js
9404
+ * // Trigger Pin event with context (SDK: 1.45.2+)
9405
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
9406
+ * embed.trigger(HostEvent.Pin, {
9407
+ * vizId: "123",
9408
+ * liveboardId: "456"
9409
+ * }, ContextType.Search);
9410
+ * ```
9411
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl (for context parameter)
8399
9412
  */
8400
9413
  trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
8401
9414
  /**
@@ -8416,8 +9429,33 @@ declare class TsEmbed {
8416
9429
  getIframeSrc(): string;
8417
9430
  protected handleRenderForPrerender(): Promise<TsEmbed>;
8418
9431
  /**
8419
- * Get the current context of the embedded TS component.
8420
- * @returns The current context object containing the page type and object ids.
9432
+ * Context object for the embedded component.
9433
+ * @returns {ContextObject} The current context object containing the page type and object ids.
9434
+ * @example
9435
+ * ```js
9436
+ * const context = await embed.getCurrentContext();
9437
+ * console.log(context);
9438
+ *
9439
+ * // Example output
9440
+ * {
9441
+ * stack: [
9442
+ * {
9443
+ * name: 'Liveboard',
9444
+ * type: ContextType.Liveboard,
9445
+ * objectIds: {
9446
+ * liveboardId: '123',
9447
+ * },
9448
+ * },
9449
+ * ],
9450
+ * currentContext: {
9451
+ * name: 'Liveboard',
9452
+ * type: ContextType.Liveboard,
9453
+ * objectIds: {
9454
+ * liveboardId: '123',
9455
+ * },
9456
+ * },
9457
+ * }
9458
+ * ```
8421
9459
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
8422
9460
  */
8423
9461
  getCurrentContext(): Promise<ContextObject>;
@@ -8867,6 +9905,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8867
9905
  */
8868
9906
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
8869
9907
  }
9908
+ /**
9909
+ * APP_INIT data shape for SpotterEmbed.
9910
+ * @internal
9911
+ */
9912
+ export interface SpotterAppInitData extends DefaultAppInitData {
9913
+ embedParams?: {
9914
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
9915
+ };
9916
+ }
8870
9917
  /**
8871
9918
  * Embed ThoughtSpot AI Conversation.
8872
9919
  * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
@@ -8885,6 +9932,19 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
8885
9932
  export declare class SpotterEmbed extends TsEmbed {
8886
9933
  protected viewConfig: SpotterEmbedViewConfig;
8887
9934
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
9935
+ /**
9936
+ * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
9937
+ * so the conv-assist app can read sidebar configuration on initialisation.
9938
+ *
9939
+ * Precedence for `enablePastConversationsSidebar`:
9940
+ * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
9941
+ * deprecated top-level `enablePastConversationsSidebar` flag; if the former
9942
+ * is absent the latter is used as a fallback.
9943
+ *
9944
+ * An invalid `spotterDocumentationUrl` triggers a validation error and is
9945
+ * excluded from the payload rather than forwarded to the app.
9946
+ */
9947
+ protected getAppInitData(): Promise<SpotterAppInitData>;
8888
9948
  protected getEmbedParamsObject(): Record<any, any>;
8889
9949
  getIframeSrc(): string;
8890
9950
  render(): Promise<SpotterEmbed>;
@@ -9462,6 +10522,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9462
10522
  * ```
9463
10523
  */
9464
10524
  isPNGInScheduledEmailsEnabled?: boolean;
10525
+ /**
10526
+ * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
10527
+ * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
10528
+ * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
10529
+ *
10530
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
10531
+ * @type {boolean}
10532
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
10533
+ * @example
10534
+ * ```js
10535
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
10536
+ * const embed = new <EmbedComponent>('#tsEmbed', {
10537
+ * ... // other embed view config
10538
+ * isContinuousLiveboardPDFEnabled: true,
10539
+ * })
10540
+ * ```
10541
+ */
10542
+ isContinuousLiveboardPDFEnabled?: boolean;
9465
10543
  /**
9466
10544
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
9467
10545
  *
@@ -9630,6 +10708,15 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9630
10708
  */
9631
10709
  enableHomepageAnnouncement?: boolean;
9632
10710
  }
10711
+ /**
10712
+ * APP_INIT data shape for AppEmbed.
10713
+ * @internal
10714
+ */
10715
+ export interface AppEmbedAppInitData extends DefaultAppInitData {
10716
+ embedParams?: {
10717
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
10718
+ };
10719
+ }
9633
10720
  /**
9634
10721
  * Embeds full ThoughtSpot experience in a host application.
9635
10722
  * @group Embed components
@@ -9638,6 +10725,19 @@ export declare class AppEmbed extends V1Embed {
9638
10725
  protected viewConfig: AppViewConfig;
9639
10726
  private defaultHeight;
9640
10727
  constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
10728
+ /**
10729
+ * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
10730
+ * so the conv-assist app can read sidebar configuration on initialisation.
10731
+ *
10732
+ * Precedence for `enablePastConversationsSidebar`:
10733
+ * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
10734
+ * deprecated top-level `enablePastConversationsSidebar` flag; if the former
10735
+ * is absent the latter is used as a fallback.
10736
+ *
10737
+ * An invalid `spotterDocumentationUrl` triggers a validation error and is
10738
+ * excluded from the payload rather than forwarded to the app.
10739
+ */
10740
+ protected getAppInitData(): Promise<AppEmbedAppInitData>;
9641
10741
  /**
9642
10742
  * Constructs a map of parameters to be passed on to the
9643
10743
  * embedded Liveboard or visualization.
@@ -9727,7 +10827,8 @@ export declare enum AuthFailureType {
9727
10827
  /**
9728
10828
  * The current authentication token or session has expired.
9729
10829
  *
9730
- * Emitted when the embed receives an auth-expiry signal and starts auth refresh handling.
10830
+ * Emitted when the embed receives an auth-expiry signal and starts auth refresh
10831
+ * handling.
9731
10832
  */
9732
10833
  EXPIRY = "EXPIRY",
9733
10834
  /**
@@ -10337,6 +11438,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10337
11438
  * ```
10338
11439
  */
10339
11440
  isPNGInScheduledEmailsEnabled?: boolean;
11441
+ /**
11442
+ * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
11443
+ * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
11444
+ * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
11445
+ *
11446
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
11447
+ * @type {boolean}
11448
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11449
+ * @example
11450
+ * ```js
11451
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
11452
+ * const embed = new <EmbedComponent>('#tsEmbed', {
11453
+ * ... // other embed view config
11454
+ * isContinuousLiveboardPDFEnabled: true,
11455
+ * })
11456
+ * ```
11457
+ */
11458
+ isContinuousLiveboardPDFEnabled?: boolean;
10340
11459
  /**
10341
11460
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
10342
11461
  *