@thoughtspot/visual-embed-sdk 1.46.3 → 1.46.5-beta.1

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 (172) 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 +51 -17
  9. package/cjs/src/css-variables.d.ts.map +1 -1
  10. package/cjs/src/embed/app.d.ts +1 -0
  11. package/cjs/src/embed/app.d.ts.map +1 -1
  12. package/cjs/src/embed/app.js +10 -1
  13. package/cjs/src/embed/app.js.map +1 -1
  14. package/cjs/src/embed/app.spec.js +46 -1
  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/events.spec.js +72 -0
  20. package/cjs/src/embed/events.spec.js.map +1 -1
  21. package/cjs/src/embed/hostEventClient/contracts.d.ts +74 -3
  22. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  23. package/cjs/src/embed/hostEventClient/contracts.js +7 -0
  24. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  25. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +10 -0
  26. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  27. package/cjs/src/embed/hostEventClient/host-event-client.js +46 -9
  28. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  29. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +155 -0
  30. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  31. package/cjs/src/embed/liveboard.d.ts +1 -0
  32. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  33. package/cjs/src/embed/liveboard.js +11 -2
  34. package/cjs/src/embed/liveboard.js.map +1 -1
  35. package/cjs/src/embed/liveboard.spec.js +96 -2
  36. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  37. package/cjs/src/embed/sage.d.ts.map +1 -1
  38. package/cjs/src/embed/sage.js.map +1 -1
  39. package/cjs/src/embed/search.spec.js.map +1 -1
  40. package/cjs/src/embed/ts-embed.d.ts +41 -2
  41. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  42. package/cjs/src/embed/ts-embed.js +41 -2
  43. package/cjs/src/embed/ts-embed.js.map +1 -1
  44. package/cjs/src/react/index.d.ts.map +1 -1
  45. package/cjs/src/react/index.js +58 -53
  46. package/cjs/src/react/index.js.map +1 -1
  47. package/cjs/src/types.d.ts +730 -32
  48. package/cjs/src/types.d.ts.map +1 -1
  49. package/cjs/src/types.js +734 -3
  50. package/cjs/src/types.js.map +1 -1
  51. package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
  52. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  53. package/cjs/src/utils/graphql/answerService/answerService.js +4 -2
  54. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  55. package/cjs/src/utils/graphql/preview-service.d.ts.map +1 -1
  56. package/cjs/src/utils/graphql/preview-service.js.map +1 -1
  57. package/cjs/src/utils/processData.d.ts.map +1 -1
  58. package/cjs/src/utils/processData.js.map +1 -1
  59. package/dist/{index-DyX-x6uN.js → index-DW2wEHqy.js} +1 -1
  60. package/dist/src/auth.d.ts +2 -1
  61. package/dist/src/auth.d.ts.map +1 -1
  62. package/dist/src/authToken.d.ts.map +1 -1
  63. package/dist/src/css-variables.d.ts +51 -17
  64. package/dist/src/css-variables.d.ts.map +1 -1
  65. package/dist/src/embed/app.d.ts +1 -0
  66. package/dist/src/embed/app.d.ts.map +1 -1
  67. package/dist/src/embed/base.d.ts.map +1 -1
  68. package/dist/src/embed/hostEventClient/contracts.d.ts +74 -3
  69. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  70. package/dist/src/embed/hostEventClient/host-event-client.d.ts +10 -0
  71. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  72. package/dist/src/embed/liveboard.d.ts +1 -0
  73. package/dist/src/embed/liveboard.d.ts.map +1 -1
  74. package/dist/src/embed/sage.d.ts.map +1 -1
  75. package/dist/src/embed/ts-embed.d.ts +41 -2
  76. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  77. package/dist/src/react/index.d.ts.map +1 -1
  78. package/dist/src/types.d.ts +730 -32
  79. package/dist/src/types.d.ts.map +1 -1
  80. package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
  81. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  82. package/dist/src/utils/graphql/preview-service.d.ts.map +1 -1
  83. package/dist/src/utils/processData.d.ts.map +1 -1
  84. package/dist/tsembed-react.es.js +917 -77
  85. package/dist/tsembed-react.js +915 -75
  86. package/dist/tsembed.es.js +859 -24
  87. package/dist/tsembed.js +857 -22
  88. package/dist/visual-embed-sdk-react-full.d.ts +892 -54
  89. package/dist/visual-embed-sdk-react.d.ts +892 -54
  90. package/dist/visual-embed-sdk.d.ts +912 -56
  91. package/lib/package.json +3 -3
  92. package/lib/src/auth.d.ts +2 -1
  93. package/lib/src/auth.d.ts.map +1 -1
  94. package/lib/src/auth.js +2 -1
  95. package/lib/src/auth.js.map +1 -1
  96. package/lib/src/authToken.d.ts.map +1 -1
  97. package/lib/src/authToken.js.map +1 -1
  98. package/lib/src/css-variables.d.ts +51 -17
  99. package/lib/src/css-variables.d.ts.map +1 -1
  100. package/lib/src/embed/app.d.ts +1 -0
  101. package/lib/src/embed/app.d.ts.map +1 -1
  102. package/lib/src/embed/app.js +10 -1
  103. package/lib/src/embed/app.js.map +1 -1
  104. package/lib/src/embed/app.spec.js +46 -1
  105. package/lib/src/embed/app.spec.js.map +1 -1
  106. package/lib/src/embed/base.d.ts.map +1 -1
  107. package/lib/src/embed/base.js.map +1 -1
  108. package/lib/src/embed/base.spec.js.map +1 -1
  109. package/lib/src/embed/events.spec.js +73 -1
  110. package/lib/src/embed/events.spec.js.map +1 -1
  111. package/lib/src/embed/hostEventClient/contracts.d.ts +74 -3
  112. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  113. package/lib/src/embed/hostEventClient/contracts.js +7 -0
  114. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  115. package/lib/src/embed/hostEventClient/host-event-client.d.ts +10 -0
  116. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  117. package/lib/src/embed/hostEventClient/host-event-client.js +46 -9
  118. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  119. package/lib/src/embed/hostEventClient/host-event-client.spec.js +155 -0
  120. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  121. package/lib/src/embed/liveboard.d.ts +1 -0
  122. package/lib/src/embed/liveboard.d.ts.map +1 -1
  123. package/lib/src/embed/liveboard.js +11 -2
  124. package/lib/src/embed/liveboard.js.map +1 -1
  125. package/lib/src/embed/liveboard.spec.js +96 -2
  126. package/lib/src/embed/liveboard.spec.js.map +1 -1
  127. package/lib/src/embed/sage.d.ts.map +1 -1
  128. package/lib/src/embed/sage.js.map +1 -1
  129. package/lib/src/embed/search.spec.js.map +1 -1
  130. package/lib/src/embed/ts-embed.d.ts +41 -2
  131. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  132. package/lib/src/embed/ts-embed.js +42 -3
  133. package/lib/src/embed/ts-embed.js.map +1 -1
  134. package/lib/src/react/index.d.ts.map +1 -1
  135. package/lib/src/react/index.js +58 -53
  136. package/lib/src/react/index.js.map +1 -1
  137. package/lib/src/types.d.ts +730 -32
  138. package/lib/src/types.d.ts.map +1 -1
  139. package/lib/src/types.js +734 -3
  140. package/lib/src/types.js.map +1 -1
  141. package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
  142. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  143. package/lib/src/utils/graphql/answerService/answerService.js +4 -2
  144. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  145. package/lib/src/utils/graphql/preview-service.d.ts.map +1 -1
  146. package/lib/src/utils/graphql/preview-service.js.map +1 -1
  147. package/lib/src/utils/processData.d.ts.map +1 -1
  148. package/lib/src/utils/processData.js.map +1 -1
  149. package/lib/src/visual-embed-sdk.d.ts +973 -116
  150. package/package.json +3 -3
  151. package/src/auth.spec.ts +1 -1
  152. package/src/auth.ts +2 -1
  153. package/src/authToken.ts +0 -1
  154. package/src/css-variables.ts +51 -17
  155. package/src/embed/app.spec.ts +62 -3
  156. package/src/embed/app.ts +10 -1
  157. package/src/embed/base.spec.ts +1 -2
  158. package/src/embed/base.ts +1 -4
  159. package/src/embed/events.spec.ts +88 -0
  160. package/src/embed/hostEventClient/contracts.ts +74 -2
  161. package/src/embed/hostEventClient/host-event-client.spec.ts +257 -0
  162. package/src/embed/hostEventClient/host-event-client.ts +70 -15
  163. package/src/embed/liveboard.spec.ts +126 -2
  164. package/src/embed/liveboard.ts +11 -2
  165. package/src/embed/sage.ts +0 -1
  166. package/src/embed/search.spec.ts +0 -2
  167. package/src/embed/ts-embed.ts +43 -3
  168. package/src/react/index.tsx +76 -72
  169. package/src/types.ts +739 -31
  170. package/src/utils/graphql/answerService/answerService.ts +4 -5
  171. package/src/utils/graphql/preview-service.ts +0 -1
  172. package/src/utils/processData.ts +0 -5
@@ -1,3 +1,4 @@
1
+ declare module '@thoughtspot/visual-embed-sdk' {
1
2
  // Generated by dts-bundle-generator v9.5.1
2
3
 
3
4
  /**
@@ -426,37 +427,49 @@ export interface CustomCssVariables {
426
427
  /**
427
428
  * Padding of the groups in the Liveboard.
428
429
  *
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.
430
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
431
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
432
+ * this CSS variable.
430
433
  */
431
434
  "--ts-var-liveboard-group-padding"?: string;
432
435
  /**
433
436
  * Font size of the title of the groups in the Liveboard.
434
437
  *
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.
438
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
439
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
440
+ * this CSS variable.
436
441
  */
437
442
  "--ts-var-liveboard-group-title-font-size"?: string;
438
443
  /**
439
444
  * Font weight of the title of the groups in the Liveboard.
440
445
  *
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.
446
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
447
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
448
+ * this CSS variable.
442
449
  */
443
450
  "--ts-var-liveboard-group-title-font-weight"?: string;
444
451
  /**
445
452
  * Font size of the title of the tiles inside the groups in the Liveboard.
446
453
  *
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.
454
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
455
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
456
+ * this CSS variable.
448
457
  */
449
458
  "--ts-var-liveboard-group-tile-title-font-size"?: string;
450
459
  /**
451
460
  * Font weight of the title of the tiles inside the groups in the Liveboard.
452
461
  *
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.
462
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
463
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
464
+ * this CSS variable.
454
465
  */
455
466
  "--ts-var-liveboard-group-tile-title-font-weight"?: string;
456
467
  /**
457
468
  * Padding of the group tiles in the Liveboard.
458
469
  *
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.
470
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
471
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
472
+ * this CSS variable.
460
473
  */
461
474
  "--ts-var-liveboard-group-tile-padding"?: string;
462
475
  /**
@@ -466,13 +479,17 @@ export interface CustomCssVariables {
466
479
  /**
467
480
  * Background color of the groups in the Liveboard.
468
481
  *
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.
482
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
483
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
484
+ * this CSS variable.
470
485
  */
471
486
  "--ts-var-liveboard-group-background"?: string;
472
487
  /**
473
488
  * Border color of the groups in the Liveboard.
474
489
  *
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.
490
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
491
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
492
+ * this CSS variable.
476
493
  */
477
494
  "--ts-var-liveboard-group-border-color"?: string;
478
495
  /**
@@ -486,55 +503,73 @@ export interface CustomCssVariables {
486
503
  /**
487
504
  * Font color of the title of the groups in the Liveboard.
488
505
  *
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.
506
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
507
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
508
+ * this CSS variable.
490
509
  */
491
510
  "--ts-var-liveboard-group-title-font-color"?: string;
492
511
  /**
493
512
  * Font color of the description of the groups in the Liveboard.
494
513
  *
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.
514
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
515
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
516
+ * this CSS variable.
496
517
  */
497
518
  "--ts-var-liveboard-group-description-font-color"?: string;
498
519
  /**
499
520
  * Font color of the title of the tiles inside the groups in the Liveboard.
500
521
  *
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.
522
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
523
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
524
+ * this CSS variable.
502
525
  */
503
526
  "--ts-var-liveboard-group-tile-title-font-color"?: string;
504
527
  /**
505
528
  * Font color of the description of the tiles inside the groups in the Liveboard.
506
529
  *
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.
530
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
531
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
532
+ * this CSS variable.
508
533
  */
509
534
  "--ts-var-liveboard-group-tile-description-font-color"?: string;
510
535
  /**
511
536
  * Background color of the tiles inside the groups in the Liveboard.
512
537
  *
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.
538
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
539
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
540
+ * this CSS variable.
514
541
  */
515
542
  "--ts-var-liveboard-group-tile-background"?: string;
516
543
  /**
517
544
  * Background color of the filter chips in the Liveboard.
518
545
  *
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.
546
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
547
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
548
+ * this CSS variable.
520
549
  */
521
550
  "--ts-var-liveboard-chip-background"?: string;
522
551
  /**
523
552
  * Font color of the filter chips in the Liveboard.
524
553
  *
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.
554
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
555
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
556
+ * this CSS variable.
526
557
  */
527
558
  "--ts-var-liveboard-chip-color"?: string;
528
559
  /**
529
560
  * Background color of the filter chips in the Liveboard on hover.
530
561
  *
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.
562
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
563
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
564
+ * this CSS variable.
532
565
  */
533
566
  "--ts-var-liveboard-chip--hover-background"?: string;
534
567
  /**
535
568
  * Background color of the filter chips in the Liveboard on active.
536
569
  *
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.
570
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and
571
+ * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying
572
+ * this CSS variable.
538
573
  */
539
574
  "--ts-var-liveboard-chip--active-background"?: string;
540
575
  /**
@@ -772,9 +807,11 @@ export interface UnderlyingDataPoint {
772
807
  * You can use this service to:
773
808
  *
774
809
  * - Add or remove columns from Answers (`addColumns`, `removeColumns`,
775
- * `addColumnsByName`) - Apply filters to Answers (`addFilter`)
810
+ * `addColumnsByName`)
811
+ * - Apply filters to Answers (`addFilter`)
776
812
  * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`,
777
- * `fetchCSVBlob`, `fetchPNGBlob`) - Get data for specific points in visualizations
813
+ * `fetchCSVBlob`, `fetchPNGBlob`)
814
+ * - Get data for specific points in visualizations
778
815
  * (`getUnderlyingDataForPoint`)
779
816
  * - Run custom queries (`executeQuery`)
780
817
  * - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`)
@@ -811,7 +848,7 @@ export interface UnderlyingDataPoint {
811
848
  * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
812
849
  * @group Events
813
850
  */
814
- export declare class AnswerService {
851
+ export class AnswerService {
815
852
  private session;
816
853
  private thoughtSpotHost;
817
854
  private selectedPoints?;
@@ -953,7 +990,7 @@ export declare class AnswerService {
953
990
  * the embedded app
954
991
  * @group Authentication / Init
955
992
  */
956
- export declare enum AuthType {
993
+ export enum AuthType {
957
994
  /**
958
995
  * No authentication on the SDK. Pass-through to the embedded App. Alias for
959
996
  * `Passthrough`.
@@ -1113,7 +1150,7 @@ export declare enum AuthType {
1113
1150
  * **Note**: This attribute is not supported in the classic (V1) homepage experience.
1114
1151
  *
1115
1152
  */
1116
- export declare enum HomeLeftNavItem {
1153
+ export enum HomeLeftNavItem {
1117
1154
  /**
1118
1155
  * The *Search data* option in
1119
1156
  * the *Insights* left navigation panel.
@@ -2931,7 +2968,7 @@ responder?: (data: any) => void) => void;
2931
2968
  /**
2932
2969
  * A map of the supported runtime filter operations
2933
2970
  */
2934
- export declare enum RuntimeFilterOp {
2971
+ export enum RuntimeFilterOp {
2935
2972
  /**
2936
2973
  * Equals
2937
2974
  */
@@ -3001,7 +3038,7 @@ export declare enum RuntimeFilterOp {
3001
3038
  * **Note**: This option is not supported in the classic (v1) experience.
3002
3039
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3003
3040
  */
3004
- export declare enum HomepageModule {
3041
+ export enum HomepageModule {
3005
3042
  /**
3006
3043
  * Search bar
3007
3044
  */
@@ -3032,7 +3069,7 @@ export declare enum HomepageModule {
3032
3069
  * **Note**: This option is applicable to full app embedding only.
3033
3070
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3034
3071
  */
3035
- export declare enum ListPageColumns {
3072
+ export enum ListPageColumns {
3036
3073
  /**
3037
3074
  * Favorites
3038
3075
  */
@@ -3136,7 +3173,7 @@ export interface RuntimeParameter {
3136
3173
  * ```
3137
3174
  * @group Events
3138
3175
  */
3139
- export declare enum EmbedEvent {
3176
+ export enum EmbedEvent {
3140
3177
  /**
3141
3178
  * Rendering has initialized.
3142
3179
  * @example
@@ -3996,22 +4033,45 @@ export declare enum EmbedEvent {
3996
4033
  /**
3997
4034
  * Emitted when name, status (private or public) or filter values of a
3998
4035
  * Personalised view is updated.
4036
+ * This event is deprecated. Use {@link EmbedEvent.UpdatePersonalizedView} instead.
3999
4037
  * @returns viewName: string
4000
4038
  * @returns viewId: string
4001
4039
  * @returns liveboardId: string
4002
4040
  * @returns isPublic: boolean
4003
4041
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4042
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4004
4043
  */
4005
4044
  UpdatePersonalisedView = "updatePersonalisedView",
4045
+ /**
4046
+ * Emitted when name, status (private or public) or filter values of a
4047
+ * Personalized view is updated.
4048
+ * @returns viewName: string
4049
+ * @returns viewId: string
4050
+ * @returns liveboardId: string
4051
+ * @returns isPublic: boolean
4052
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4053
+ */
4054
+ UpdatePersonalizedView = "updatePersonalisedView",
4006
4055
  /**
4007
4056
  * Emitted when a Personalised view is saved.
4057
+ * This event is deprecated. Use {@link EmbedEvent.SavePersonalizedView} instead.
4008
4058
  * @returns viewName: string
4009
4059
  * @returns viewId: string
4010
4060
  * @returns liveboardId: string
4011
4061
  * @returns isPublic: boolean
4012
4062
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4063
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4013
4064
  */
4014
4065
  SavePersonalisedView = "savePersonalisedView",
4066
+ /**
4067
+ * Emitted when a Personalized view is saved.
4068
+ * @returns viewName: string
4069
+ * @returns viewId: string
4070
+ * @returns liveboardId: string
4071
+ * @returns isPublic: boolean
4072
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4073
+ */
4074
+ SavePersonalizedView = "savePersonalisedView",
4015
4075
  /**
4016
4076
  * Emitted when a Liveboard is reset.
4017
4077
  * @returns viewName: string
@@ -4023,11 +4083,41 @@ export declare enum EmbedEvent {
4023
4083
  ResetLiveboard = "resetLiveboard",
4024
4084
  /**
4025
4085
  * Emitted when a PersonalisedView is deleted.
4086
+ * This event is deprecated. Use {@link EmbedEvent.DeletePersonalizedView} instead.
4026
4087
  * @returns views: string[]
4027
4088
  * @returns liveboardId: string
4028
4089
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4090
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4029
4091
  */
4030
4092
  DeletePersonalisedView = "deletePersonalisedView",
4093
+ /**
4094
+ * Emitted when a PersonalizedView is deleted.
4095
+ * @returns views: string[]
4096
+ * @returns liveboardId: string
4097
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4098
+ */
4099
+ DeletePersonalizedView = "deletePersonalisedView",
4100
+ /**
4101
+ * Emitted when a user selects a different Personalized View or
4102
+ * resets to the original/default view on a Liveboard.
4103
+ * @example
4104
+ * ```js
4105
+ * liveboardEmbed.on(EmbedEvent.ChangePersonalizedView, (data) => {
4106
+ * console.log(data.viewName); // 'Q4 Revenue' or 'Original View'
4107
+ * console.log(data.viewId); // '2a021a12-...' or null (default)
4108
+ * console.log(data.liveboardId); // 'abc123...'
4109
+ * console.log(data.isPublic); // true | false
4110
+ * })
4111
+ * ```
4112
+ * @returns viewName: string - Name of the selected view,
4113
+ * or 'Original View' when reset to default.
4114
+ * @returns viewId: string | null - GUID of the selected view,
4115
+ * or null when reset to default.
4116
+ * @returns liveboardId: string
4117
+ * @returns isPublic: boolean
4118
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4119
+ */
4120
+ ChangePersonalizedView = "changePersonalisedView",
4031
4121
  /**
4032
4122
  * Emitted when a user creates a Worksheet.
4033
4123
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
@@ -4061,7 +4151,8 @@ export declare enum EmbedEvent {
4061
4151
  * @param - Includes the following parameters:
4062
4152
  * - `payload`: The payload received from the embed related to the Data API call.
4063
4153
  * - `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.
4154
+ * will run or block the search operation, and if blocked, which error message to
4155
+ * provide.
4065
4156
  * - `execute` - When `execute` returns `true`, the search is run.
4066
4157
  * When `execute` returns `false`, the search is not executed.
4067
4158
  * - `error` - Developers can customize the user-facing error message when `execute`
@@ -4495,9 +4586,28 @@ export declare enum EmbedEvent {
4495
4586
  * );
4496
4587
  * }
4497
4588
  * ```
4589
+ *
4590
+ * **Context Parameter (SDK: 1.45.2+)**
4591
+ *
4592
+ * Starting from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl, you can optionally pass a
4593
+ * `ContextType` as the third parameter to the `trigger` method to specify the context
4594
+ * from which the event is triggered. This helps ThoughtSpot understand the current page
4595
+ * context (Search, Answer, Liveboard, or Spotter) for better event handling.
4596
+ *
4597
+ * @example
4598
+ * ```js
4599
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
4600
+ *
4601
+ * // Trigger Pin event with Search context
4602
+ * appEmbed.trigger(HostEvent.Pin, {
4603
+ * vizId: "123",
4604
+ * liveboardId: "456"
4605
+ * }, ContextType.Search);
4606
+ * ```
4607
+ *
4498
4608
  * @group Events
4499
4609
  */
4500
- export declare enum HostEvent {
4610
+ export enum HostEvent {
4501
4611
  /**
4502
4612
  * Triggers a search operation with the search tokens specified in
4503
4613
  * the search query string.
@@ -4516,6 +4626,16 @@ export declare enum HostEvent {
4516
4626
  execute: true
4517
4627
  });
4518
4628
  * ```
4629
+ * @example
4630
+ * ```js
4631
+ * // Trigger search from search context
4632
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4633
+ * appEmbed.trigger(HostEvent.Search, {
4634
+ * searchQuery: "[revenue] by [region]",
4635
+ * dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
4636
+ * execute: true
4637
+ * }, ContextType.Search);
4638
+ * ```
4519
4639
  */
4520
4640
  Search = "search",
4521
4641
  /**
@@ -4566,6 +4686,24 @@ export declare enum HostEvent {
4566
4686
  * });
4567
4687
  * })
4568
4688
  * ```
4689
+ * @example
4690
+ * ```js
4691
+ * // Drill down from answer context
4692
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4693
+ * appEmbed.trigger(HostEvent.DrillDown, {
4694
+ * points: { clickedPoint, selectedPoints },
4695
+ * autoDrillDown: true
4696
+ * }, ContextType.Answer);
4697
+ * ```
4698
+ * @example
4699
+ * ```js
4700
+ * // Drill down from search context
4701
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4702
+ * searchEmbed.trigger(HostEvent.DrillDown, {
4703
+ * points: { clickedPoint, selectedPoints },
4704
+ * columnGuid: "column-guid"
4705
+ * }, ContextType.Search);
4706
+ * ```
4569
4707
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
4570
4708
  */
4571
4709
  DrillDown = "triggerDrillDown",
@@ -4586,6 +4724,13 @@ export declare enum HostEvent {
4586
4724
  * const url = embed.trigger(HostEvent.GetIframeUrl);
4587
4725
  * console.log("iFrameURL",url);
4588
4726
  * ```
4727
+ * @example
4728
+ * ```js
4729
+ * // Get iframe URL from specific context
4730
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4731
+ * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
4732
+ * console.log("iFrameURL", url);
4733
+ * ```
4589
4734
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4590
4735
  */
4591
4736
  GetIframeUrl = "GetIframeUrl",
@@ -4599,6 +4744,15 @@ export declare enum HostEvent {
4599
4744
  * '730496d6-6903-4601-937e-2c691821af3c',
4600
4745
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
4601
4746
  * ```
4747
+ * @example
4748
+ * ```js
4749
+ * // Set visible vizs from liveboard context
4750
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4751
+ * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
4752
+ * '730496d6-6903-4601-937e-2c691821af3c',
4753
+ * 'd547ec54-2a37-4516-a222-2b06719af726'
4754
+ * ], ContextType.Liveboard);
4755
+ * ```
4602
4756
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
4603
4757
  */
4604
4758
  SetVisibleVizs = "SetPinboardVisibleVizs",
@@ -4611,6 +4765,14 @@ export declare enum HostEvent {
4611
4765
  * tabId:'730496d6-6903-4601-937e-2c691821af3c'
4612
4766
  * })
4613
4767
  * ```
4768
+ * @example
4769
+ * ```js
4770
+ * // Set active tab from liveboard context
4771
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4772
+ * liveboardEmbed.trigger(HostEvent.SetActiveTab, {
4773
+ * tabId: '730496d6-6903-4601-937e-2c691821af3c'
4774
+ * }, ContextType.Liveboard);
4775
+ * ```
4614
4776
  * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw
4615
4777
  */
4616
4778
  SetActiveTab = "SetActiveTab",
@@ -4644,6 +4806,15 @@ export declare enum HostEvent {
4644
4806
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
4645
4807
  * ])
4646
4808
  * ```
4809
+ * @example
4810
+ * ```js
4811
+ * // Update runtime filters from liveboard context
4812
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4813
+ * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
4814
+ * {columnName: "region", operator: RuntimeFilterOp.EQ, values: ["west"]},
4815
+ * {columnName: "product", operator: RuntimeFilterOp.IN, values: ["shoes", "boots"]}
4816
+ * ], ContextType.Liveboard);
4817
+ * ```
4647
4818
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
4648
4819
  * @important
4649
4820
  */
@@ -4677,6 +4848,14 @@ export declare enum HostEvent {
4677
4848
  * LiveboardEmbed.trigger(HostEvent.OpenFilter,
4678
4849
  * { column: {columnId: '<column-GUID>'}})
4679
4850
  * ```
4851
+ * @example
4852
+ * ```js
4853
+ * // Open filter from search context
4854
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4855
+ * searchEmbed.trigger(HostEvent.OpenFilter, {
4856
+ * column: { columnId: '<column-GUID>', name: 'region', type: 'ATTRIBUTE', dataType: 'CHAR'}
4857
+ * }, ContextType.Search);
4858
+ * ```
4680
4859
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4681
4860
  */
4682
4861
  OpenFilter = "openFilter",
@@ -4687,6 +4866,14 @@ export declare enum HostEvent {
4687
4866
  * ```js
4688
4867
  * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
4689
4868
  * ```
4869
+ * @example
4870
+ * ```js
4871
+ * // Add columns from search context
4872
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4873
+ * searchEmbed.trigger(HostEvent.AddColumns, {
4874
+ * columnIds: ['col-guid-1', 'col-guid-2']
4875
+ * }, ContextType.Search);
4876
+ * ```
4690
4877
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4691
4878
  */
4692
4879
  AddColumns = "addColumns",
@@ -4697,6 +4884,14 @@ export declare enum HostEvent {
4697
4884
  * ```js
4698
4885
  * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
4699
4886
  * ```
4887
+ * @example
4888
+ * ```js
4889
+ * // Remove column from search context
4890
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4891
+ * searchEmbed.trigger(HostEvent.RemoveColumn, {
4892
+ * columnId: 'column-guid'
4893
+ * }, ContextType.Search);
4894
+ * ```
4700
4895
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4701
4896
  */
4702
4897
  RemoveColumn = "removeColumn",
@@ -4783,6 +4978,37 @@ export declare enum HostEvent {
4783
4978
  *
4784
4979
  * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
4785
4980
  * ```
4981
+ * @example
4982
+ * ```js
4983
+ * // Using context parameter to specify the context type (SDK: 1.45.2+)
4984
+ * // Pin from a search answer context
4985
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4986
+ * appEmbed.trigger(HostEvent.Pin, {
4987
+ * vizId: "123",
4988
+ * newVizName: "Sales by region",
4989
+ * liveboardId: "456"
4990
+ * }, ContextType.Search);
4991
+ * ```
4992
+ * @example
4993
+ * ```js
4994
+ * // Pin from an answer context (explore modal/page) (SDK: 1.45.2+)
4995
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4996
+ * appEmbed.trigger(HostEvent.Pin, {
4997
+ * vizId: "789",
4998
+ * newVizName: "Revenue trends",
4999
+ * liveboardId: "456"
5000
+ * }, ContextType.Answer);
5001
+ * ```
5002
+ * @example
5003
+ * ```js
5004
+ * // Pin from a spotter context (SDK: 1.45.2+)
5005
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5006
+ * appEmbed.trigger(HostEvent.Pin, {
5007
+ * vizId: latestSpotterVizId,
5008
+ * newVizName: "AI-generated insights",
5009
+ * liveboardId: "456"
5010
+ * }, ContextType.Spotter);
5011
+ * ```
4786
5012
  *
4787
5013
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4788
5014
  */
@@ -4793,6 +5019,12 @@ export declare enum HostEvent {
4793
5019
  * @example
4794
5020
  * ```js
4795
5021
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
5022
+ *```
5023
+ * @example
5024
+ * ```js
5025
+ * // Show liveboard info from liveboard context
5026
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5027
+ * liveboardEmbed.trigger(HostEvent.LiveboardInfo, {}, ContextType.Liveboard);
4796
5028
  * ```
4797
5029
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4798
5030
  */
@@ -4803,6 +5035,12 @@ export declare enum HostEvent {
4803
5035
  * ```js
4804
5036
  * liveboardEmbed.trigger(HostEvent.Schedule)
4805
5037
  * ```
5038
+ * @example
5039
+ * ```js
5040
+ * // Schedule from liveboard context
5041
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5042
+ * liveboardEmbed.trigger(HostEvent.Schedule, {}, ContextType.Liveboard);
5043
+ * ```
4806
5044
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4807
5045
  */
4808
5046
  Schedule = "subscription",
@@ -4812,6 +5050,12 @@ export declare enum HostEvent {
4812
5050
  * ```js
4813
5051
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
4814
5052
  * ```
5053
+ * @example
5054
+ * ```js
5055
+ * // Manage schedules from liveboard context
5056
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5057
+ * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
5058
+ * ```
4815
5059
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4816
5060
  */
4817
5061
  SchedulesList = "schedule-list",
@@ -4822,6 +5066,18 @@ export declare enum HostEvent {
4822
5066
  * ```js
4823
5067
  * liveboardEmbed.trigger(HostEvent.ExportTML)
4824
5068
  * ```
5069
+ * @example
5070
+ * ```js
5071
+ * // Export TML from liveboard context
5072
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5073
+ * liveboardEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Liveboard);
5074
+ * ```
5075
+ * @example
5076
+ * ```js
5077
+ * // Export TML from search-answer context
5078
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5079
+ * appEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Search);
5080
+ * ```
4825
5081
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4826
5082
  */
4827
5083
  ExportTML = "exportTSL",
@@ -4832,6 +5088,18 @@ export declare enum HostEvent {
4832
5088
  * ```js
4833
5089
  * liveboardEmbed.trigger(HostEvent.EditTML)
4834
5090
  * ```
5091
+ * @example
5092
+ * ```js
5093
+ * // Edit TML from liveboard context
5094
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5095
+ * liveboardEmbed.trigger(HostEvent.EditTML, {}, ContextType.Liveboard);
5096
+ * ```
5097
+ * @example
5098
+ * ```js
5099
+ * // Edit TML from search-answer context
5100
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5101
+ * appEmbed.trigger(HostEvent.EditTML, {}, ContextType.Search);
5102
+ * ```
4835
5103
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4836
5104
  */
4837
5105
  EditTML = "editTSL",
@@ -4841,6 +5109,12 @@ export declare enum HostEvent {
4841
5109
  * ```js
4842
5110
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
4843
5111
  * ```
5112
+ * @example
5113
+ * ```js
5114
+ * // Update TML from liveboard context
5115
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5116
+ * liveboardEmbed.trigger(HostEvent.UpdateTML, {}, ContextType.Liveboard);
5117
+ * ```
4844
5118
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4845
5119
  */
4846
5120
  UpdateTML = "updateTSL",
@@ -4867,6 +5141,18 @@ export declare enum HostEvent {
4867
5141
  *
4868
5142
  * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
4869
5143
  * ```
5144
+ * @example
5145
+ * ```js
5146
+ * // Download as PDF from search-answer context
5147
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5148
+ * appEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Search);
5149
+ * ```
5150
+ * @example
5151
+ * ```js
5152
+ * // Download as PDF from liveboard context
5153
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5154
+ * liveboardEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Liveboard);
5155
+ * ```
4870
5156
  *
4871
5157
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4872
5158
  */
@@ -4911,6 +5197,18 @@ export declare enum HostEvent {
4911
5197
  *
4912
5198
  * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
4913
5199
  * ```
5200
+ * @example
5201
+ * ```js
5202
+ * // Make a copy from answer context
5203
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5204
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Answer);
5205
+ * ```
5206
+ * @example
5207
+ * ```js
5208
+ * // Make a copy from search context
5209
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5210
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Search);
5211
+ * ```
4914
5212
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4915
5213
  */
4916
5214
  MakeACopy = "makeACopy",
@@ -4935,6 +5233,14 @@ export declare enum HostEvent {
4935
5233
  * ```js
4936
5234
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4937
5235
  * ```
5236
+ * @example
5237
+ * ```js
5238
+ * // Explore from liveboard context
5239
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5240
+ * liveboardEmbed.trigger(HostEvent.Explore, {
5241
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5242
+ * }, ContextType.Liveboard);
5243
+ * ```
4938
5244
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4939
5245
  */
4940
5246
  Explore = "explore",
@@ -4952,6 +5258,20 @@ export declare enum HostEvent {
4952
5258
  * ```js
4953
5259
  * searchEmbed.trigger(HostEvent.CreateMonitor)
4954
5260
  * ```
5261
+ * @example
5262
+ * ```js
5263
+ * // Create monitor from answer context
5264
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5265
+ * appEmbed.trigger(HostEvent.CreateMonitor, {}, ContextType.Answer);
5266
+ * ```
5267
+ * @example
5268
+ * ```js
5269
+ * // Create monitor from liveboard context
5270
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5271
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
5272
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5273
+ * }, ContextType.Liveboard);
5274
+ * ```
4955
5275
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4956
5276
  */
4957
5277
  CreateMonitor = "createMonitor",
@@ -4973,6 +5293,20 @@ export declare enum HostEvent {
4973
5293
  * ```js
4974
5294
  * vizEmbed.trigger(HostEvent.ManageMonitor)
4975
5295
  * ```
5296
+ * @example
5297
+ * ```js
5298
+ * // Manage monitor from answer context
5299
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5300
+ * appEmbed.trigger(HostEvent.ManageMonitor, {}, ContextType.Answer);
5301
+ * ```
5302
+ * @example
5303
+ * ```js
5304
+ * // Manage monitor from liveboard context
5305
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5306
+ * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
5307
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5308
+ * }, ContextType.Liveboard);
5309
+ * ```
4976
5310
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4977
5311
  */
4978
5312
  ManageMonitor = "manageMonitor",
@@ -4998,6 +5332,26 @@ export declare enum HostEvent {
4998
5332
  * ```js
4999
5333
  * spotterEmbed.trigger(HostEvent.Edit);
5000
5334
  * ```
5335
+ * @example
5336
+ * ```js
5337
+ * // Using context parameter to edit liveboard context
5338
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5339
+ * liveboardEmbed.trigger(HostEvent.Edit, {}, ContextType.Liveboard);
5340
+ * ```
5341
+ * @example
5342
+ * ```js
5343
+ * // Edit from search context
5344
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5345
+ * appEmbed.trigger(HostEvent.Edit, {}, ContextType.Search);
5346
+ * ```
5347
+ * * @example
5348
+ * ```js
5349
+ * // Edit from spotter context
5350
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5351
+ * appEmbed.trigger(HostEvent.Edit, {
5352
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5353
+ * }, ContextType.Spotter);
5354
+ * ```
5001
5355
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5002
5356
  */
5003
5357
  Edit = "edit",
@@ -5015,6 +5369,20 @@ export declare enum HostEvent {
5015
5369
  * ```js
5016
5370
  * vizEmbed.trigger(HostEvent.CopyLink)
5017
5371
  * ```
5372
+ * @example
5373
+ * ```js
5374
+ * // Copy link from liveboard context
5375
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5376
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
5377
+ * ```
5378
+ * @example
5379
+ * ```js
5380
+ * // Copy link from liveboard visualization context
5381
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5382
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
5383
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5384
+ * }, ContextType.Liveboard);
5385
+ * ```
5018
5386
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5019
5387
  */
5020
5388
  CopyLink = "embedDocument",
@@ -5032,6 +5400,20 @@ export declare enum HostEvent {
5032
5400
  * ```js
5033
5401
  * vizEmbed.trigger(HostEvent.Present)
5034
5402
  * ```
5403
+ * @example
5404
+ * ```js
5405
+ * // Present from liveboard visualization context
5406
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5407
+ * liveboardEmbed.trigger(HostEvent.Present, {
5408
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5409
+ * }, ContextType.Liveboard);
5410
+ * ```
5411
+ * @example
5412
+ * ```js
5413
+ * // Present from liveboard context
5414
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5415
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5416
+ * ```
5035
5417
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5036
5418
  */
5037
5419
  Present = "present",
@@ -5060,6 +5442,22 @@ export declare enum HostEvent {
5060
5442
  * tml.answer.search_query // TML representation of the search query
5061
5443
  * );
5062
5444
  * })
5445
+ * ```
5446
+ * @example
5447
+ * ```js
5448
+ * // Get TML from search context
5449
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5450
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
5451
+ * console.log(tml.answer.search_query);
5452
+ * });
5453
+ * ```
5454
+ * @example
5455
+ * ```js
5456
+ * // Get TML from search-answer context
5457
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5458
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
5459
+ * console.log(tml.answer);
5460
+ * });
5063
5461
  * ```
5064
5462
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5065
5463
  * @important
@@ -5081,6 +5479,20 @@ export declare enum HostEvent {
5081
5479
  * ```js
5082
5480
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
5083
5481
  * ```
5482
+ * @example
5483
+ * ```js
5484
+ * // Show underlying data from liveboard visualization context
5485
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5486
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {
5487
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5488
+ * }, ContextType.Liveboard);
5489
+ * ```
5490
+ * @example
5491
+ * ```js
5492
+ * // Show underlying data from search context
5493
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5494
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {}, ContextType.Search);
5495
+ * ```
5084
5496
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5085
5497
  */
5086
5498
  ShowUnderlyingData = "showUnderlyingData",
@@ -5098,6 +5510,18 @@ export declare enum HostEvent {
5098
5510
  * ```js
5099
5511
  * searchEmbed.trigger(HostEvent.Delete)
5100
5512
  * ```
5513
+ * @example
5514
+ * ```js
5515
+ * // Delete from liveboard context
5516
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5517
+ * liveboardEmbed.trigger(HostEvent.Delete, {}, ContextType.Liveboard);
5518
+ * ```
5519
+ * @example
5520
+ * ```js
5521
+ * // Delete from search context
5522
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5523
+ * appEmbed.trigger(HostEvent.Delete, {}, ContextType.Search);
5524
+ * ```
5101
5525
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5102
5526
  */
5103
5527
  Delete = "onDeleteAnswer",
@@ -5118,6 +5542,20 @@ export declare enum HostEvent {
5118
5542
  * ```js
5119
5543
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
5120
5544
  * ```
5545
+ * @example
5546
+ * ```js
5547
+ * // SpotIQ analyze from search-answer context
5548
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5549
+ * appEmbed.trigger(HostEvent.SpotIQAnalyze, { vizId: '730496d6-6903-4601-937e-2c691821af3c' }, ContextType.Search);
5550
+ * ```
5551
+ * @example
5552
+ * ```js
5553
+ * // SpotIQ analyze from search context
5554
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5555
+ * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {
5556
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5557
+ * }, ContextType.Liveboard);
5558
+ * ```
5121
5559
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5122
5560
  */
5123
5561
  SpotIQAnalyze = "spotIQAnalyze",
@@ -5169,6 +5607,12 @@ export declare enum HostEvent {
5169
5607
  *
5170
5608
  * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
5171
5609
  * ```
5610
+ * @example
5611
+ * ```js
5612
+ * // Download as PNG from search-answer context
5613
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5614
+ * appEmbed.trigger(HostEvent.DownloadAsPng, {}, ContextType.Search);
5615
+ * ```
5172
5616
  *
5173
5617
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
5174
5618
  */
@@ -5197,6 +5641,18 @@ export declare enum HostEvent {
5197
5641
  *
5198
5642
  * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
5199
5643
  * ```
5644
+ * @example
5645
+ * ```js
5646
+ * // Download as CSV from search-answer context
5647
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5648
+ * appEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
5649
+ * ```
5650
+ * @example
5651
+ * ```js
5652
+ * // Download as CSV from search context
5653
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5654
+ * searchEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
5655
+ * ```
5200
5656
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5201
5657
  */
5202
5658
  DownloadAsCsv = "downloadAsCSV",
@@ -5224,6 +5680,18 @@ export declare enum HostEvent {
5224
5680
  *
5225
5681
  * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
5226
5682
  * ```
5683
+ * @example
5684
+ * ```js
5685
+ * // Download as XLSX from answer context
5686
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5687
+ * appEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Answer);
5688
+ * ```
5689
+ * @example
5690
+ * ```js
5691
+ * // Download as XLSX from search context
5692
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5693
+ * searchEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Search);
5694
+ * ```
5227
5695
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5228
5696
  */
5229
5697
  DownloadAsXlsx = "downloadAsXLSX",
@@ -5237,6 +5705,18 @@ export declare enum HostEvent {
5237
5705
  * ```js
5238
5706
  * searchEmbed.trigger(HostEvent.Share)
5239
5707
  * ```
5708
+ * @example
5709
+ * ```js
5710
+ * // Share from Liveboard context
5711
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5712
+ * liveboardEmbed.trigger(HostEvent.Share, {}, ContextType.Liveboard);
5713
+ * ```
5714
+ * @example
5715
+ * ```js
5716
+ * // Share from search-answer context
5717
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5718
+ * appEmbed.trigger(HostEvent.Share, {}, ContextType.Search);
5719
+ * ```
5240
5720
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5241
5721
  */
5242
5722
  Share = "share",
@@ -5276,6 +5756,18 @@ export declare enum HostEvent {
5276
5756
  *
5277
5757
  * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
5278
5758
  * ```
5759
+ * @example
5760
+ * ```js
5761
+ * // Save from answer context
5762
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5763
+ * appEmbed.trigger(HostEvent.Save, {}, ContextType.Answer);
5764
+ * ```
5765
+ * @example
5766
+ * ```js
5767
+ * // Save from search context
5768
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5769
+ * searchEmbed.trigger(HostEvent.Save, {}, ContextType.Search);
5770
+ * ```
5279
5771
  *
5280
5772
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5281
5773
  */
@@ -5292,6 +5784,20 @@ export declare enum HostEvent {
5292
5784
  * ```js
5293
5785
  * vizEmbed.trigger(HostEvent.SyncToSheets)
5294
5786
  * ```
5787
+ * @example
5788
+ * ```js
5789
+ * // Sync to sheets from answer context
5790
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5791
+ * appEmbed.trigger(HostEvent.SyncToSheets, {}, ContextType.Answer);
5792
+ * ```
5793
+ * @example
5794
+ * ```js
5795
+ * // Sync to sheets from liveboard context
5796
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5797
+ * liveboardEmbed.trigger(HostEvent.SyncToSheets, {
5798
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5799
+ * }, ContextType.Liveboard);
5800
+ * ```
5295
5801
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5296
5802
  */
5297
5803
  SyncToSheets = "sync-to-sheets",
@@ -5308,6 +5814,20 @@ export declare enum HostEvent {
5308
5814
  * ```js
5309
5815
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
5310
5816
  * ```
5817
+ * @example
5818
+ * ```js
5819
+ * // Sync to other apps from answer context
5820
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5821
+ * appEmbed.trigger(HostEvent.SyncToOtherApps, {}, ContextType.Answer);
5822
+ * ```
5823
+ * @example
5824
+ * ```js
5825
+ * // Sync to other apps from liveboard context
5826
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5827
+ * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {
5828
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5829
+ * }, ContextType.Liveboard);
5830
+ * ```
5311
5831
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5312
5832
  */
5313
5833
  SyncToOtherApps = "sync-to-other-apps",
@@ -5324,6 +5844,20 @@ export declare enum HostEvent {
5324
5844
  * ```js
5325
5845
  * vizEmbed.trigger(HostEvent.ManagePipelines)
5326
5846
  * ```
5847
+ * @example
5848
+ * ```js
5849
+ * // Manage pipelines from answer context
5850
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5851
+ * appEmbed.trigger(HostEvent.ManagePipelines, {}, ContextType.Answer);
5852
+ * ```
5853
+ * @example
5854
+ * ```js
5855
+ * // Manage pipelines from liveboard context
5856
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5857
+ * liveboardEmbed.trigger(HostEvent.ManagePipelines, {
5858
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5859
+ * }, ContextType.Liveboard);
5860
+ * ```
5327
5861
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5328
5862
  */
5329
5863
  ManagePipelines = "manage-pipeline",
@@ -5336,6 +5870,12 @@ export declare enum HostEvent {
5336
5870
  * ```js
5337
5871
  * appEmbed.trigger(HostEvent.ResetSearch)
5338
5872
  * ```
5873
+ * @example
5874
+ * ```js
5875
+ * // Reset search from search context
5876
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5877
+ * searchEmbed.trigger(HostEvent.ResetSearch, {}, ContextType.Search);
5878
+ * ```
5339
5879
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
5340
5880
  */
5341
5881
  ResetSearch = "resetSearch",
@@ -5347,6 +5887,13 @@ export declare enum HostEvent {
5347
5887
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
5348
5888
  * console.log('data', data);
5349
5889
  * ```
5890
+ * @example
5891
+ * ```js
5892
+ * // Get filters from liveboard context
5893
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5894
+ * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
5895
+ * console.log('filters', data);
5896
+ * ```
5350
5897
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5351
5898
  */
5352
5899
  GetFilters = "getFilters",
@@ -5354,7 +5901,8 @@ export declare enum HostEvent {
5354
5901
  * Update one or several filters applied on a Liveboard.
5355
5902
  * @param - Includes the following keys:
5356
5903
  * - `filter`: A single filter object containing column name, filter operator, and
5357
- * values. - `filters`: Multiple filter objects with column name, filter operator,
5904
+ * values.
5905
+ * - `filters`: Multiple filter objects with column name, filter operator,
5358
5906
  * and values for each.
5359
5907
  *
5360
5908
  * Each filter object must include the following attributes:
@@ -5437,6 +5985,18 @@ export declare enum HostEvent {
5437
5985
  * }]
5438
5986
  * });
5439
5987
  * ```
5988
+ * @example
5989
+ * ```js
5990
+ * // Update filters from liveboard context
5991
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5992
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
5993
+ * filter: {
5994
+ * column: "item type",
5995
+ * oper: "IN",
5996
+ * values: ["shoes", "boots"]
5997
+ * }
5998
+ * }, ContextType.Liveboard);
5999
+ * ```
5440
6000
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5441
6001
  */
5442
6002
  UpdateFilters = "updateFilters",
@@ -5450,6 +6010,14 @@ export declare enum HostEvent {
5450
6010
  * );
5451
6011
  * })
5452
6012
  * ```
6013
+ * @example
6014
+ * ```js
6015
+ * // Get tabs from liveboard context
6016
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6017
+ * liveboardEmbed.trigger(HostEvent.GetTabs, {}, ContextType.Liveboard).then((tabDetails) => {
6018
+ * console.log('tabs', tabDetails);
6019
+ * });
6020
+ * ```
5453
6021
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5454
6022
  */
5455
6023
  GetTabs = "getTabs",
@@ -5463,6 +6031,15 @@ export declare enum HostEvent {
5463
6031
  * '430496d6-6903-4601-937e-2c691821af3c',
5464
6032
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
5465
6033
  * ```
6034
+ * @example
6035
+ * ```js
6036
+ * // Set visible tabs from liveboard context
6037
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6038
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
6039
+ * '430496d6-6903-4601-937e-2c691821af3c',
6040
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
6041
+ * ], ContextType.Liveboard);
6042
+ * ```
5466
6043
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5467
6044
  */
5468
6045
  SetVisibleTabs = "SetPinboardVisibleTabs",
@@ -5476,6 +6053,15 @@ export declare enum HostEvent {
5476
6053
  * '630496d6-6903-4601-937e-2c691821af3c',
5477
6054
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
5478
6055
  * ```
6056
+ * @example
6057
+ * ```js
6058
+ * // Set hidden tabs from liveboard context
6059
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6060
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
6061
+ * '630496d6-6903-4601-937e-2c691821af3c',
6062
+ * 'i547ec54-2a37-4516-a222-2b06719af726'
6063
+ * ], ContextType.Liveboard);
6064
+ * ```
5479
6065
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5480
6066
  */
5481
6067
  SetHiddenTabs = "SetPinboardHiddenTabs",
@@ -5552,13 +6138,24 @@ export declare enum HostEvent {
5552
6138
  UpdateCrossFilter = "UpdateCrossFilter",
5553
6139
  /**
5554
6140
  * Trigger reset action for a personalized Liveboard view.
6141
+ * This event is deprecated. Use {@link HostEvent.ResetLiveboardPersonalizedView} instead.
5555
6142
  * @example
5556
6143
  * ```js
5557
6144
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
5558
6145
  * ```
5559
6146
  * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
6147
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5560
6148
  */
5561
6149
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
6150
+ /**
6151
+ * Trigger reset action for a personalized Liveboard view.
6152
+ * @example
6153
+ * ```js
6154
+ * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalizedView);
6155
+ * ```
6156
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6157
+ */
6158
+ ResetLiveboardPersonalizedView = "ResetLiveboardPersonalisedView",
5562
6159
  /**
5563
6160
  * Triggers an action to update Parameter values on embedded
5564
6161
  * Answers, Liveboard, and Spotter answer in Edit mode.
@@ -5575,6 +6172,16 @@ export declare enum HostEvent {
5575
6172
  * isVisibleToUser: false
5576
6173
  * }])
5577
6174
  * ```
6175
+ * @example
6176
+ * ```js
6177
+ * // Update parameters from liveboard context
6178
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6179
+ * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
6180
+ * name: "Region Param",
6181
+ * value: "West",
6182
+ * isVisibleToUser: true
6183
+ * }], ContextType.Liveboard);
6184
+ * ```
5578
6185
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5579
6186
  */
5580
6187
  UpdateParameters = "UpdateParameters",
@@ -5594,18 +6201,77 @@ export declare enum HostEvent {
5594
6201
  * });
5595
6202
  *
5596
6203
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
6204
+ *```
6205
+ * @example
6206
+ * ```js
6207
+ * // Get parameters from liveboard context
6208
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6209
+ * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
6210
+ * console.log('parameters', parameters);
6211
+ * });
5597
6212
  * ```
5598
6213
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5599
6214
  */
5600
6215
  GetParameters = "GetParameters",
5601
6216
  /**
5602
6217
  * Triggers an event to update a personalized view of a Liveboard.
6218
+ * This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
5603
6219
  * ```js
5604
6220
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5605
6221
  * ```
6222
+ * @example
6223
+ * ```js
6224
+ * // Update personalized view from liveboard context
6225
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6226
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {
6227
+ * viewId: '1234'
6228
+ * }, ContextType.Liveboard);
6229
+ * ```
5606
6230
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
6231
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5607
6232
  */
5608
6233
  UpdatePersonalisedView = "UpdatePersonalisedView",
6234
+ /**
6235
+ * Triggers an event to update a personalized view of a Liveboard.
6236
+ * ```js
6237
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
6238
+ * ```
6239
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6240
+ */
6241
+ UpdatePersonalizedView = "UpdatePersonalisedView",
6242
+ /**
6243
+ * Triggers selection of a specific Personalized View on a
6244
+ * Liveboard without reloading the embed. Pass either a
6245
+ * `viewId` (GUID) or `viewName`. If both are provided, `viewId` takes precedence.
6246
+ * If neither is provided, the Liveboard resets to the original/default view.
6247
+ * When a `viewName` is provided and multiple views share
6248
+ * the same name, the first match is selected.
6249
+ * @example
6250
+ * ```js
6251
+ * liveboardEmbed.trigger(
6252
+ * HostEvent.SelectPersonalizedView,
6253
+ * { viewId: '2a021a12-1aed-425d-984b-141ee916ce72' },
6254
+ * )
6255
+ * ```
6256
+ * @example
6257
+ * ```js
6258
+ * // Select by name
6259
+ * liveboardEmbed.trigger(
6260
+ * HostEvent.SelectPersonalizedView,
6261
+ * { viewName: 'Dr Smith Cardiology' },
6262
+ * )
6263
+ * ```
6264
+ * @example
6265
+ * ```js
6266
+ * // Reset to default view
6267
+ * liveboardEmbed.trigger(
6268
+ * HostEvent.SelectPersonalizedView,
6269
+ * {},
6270
+ * )
6271
+ * ```
6272
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6273
+ */
6274
+ SelectPersonalizedView = "SelectPersonalisedView",
5609
6275
  /**
5610
6276
  * @hidden
5611
6277
  * Notify when info call is completed successfully
@@ -5625,7 +6291,8 @@ export declare enum HostEvent {
5625
6291
  * add a name and description for the Answer.
5626
6292
  * @param - Includes the following keys:
5627
6293
  * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
5628
- * embed. - `name`: Optional. Name string for the Answer.
6294
+ * embed.
6295
+ * - `name`: Optional. Name string for the Answer.
5629
6296
  * - `description`: Optional. Description text for the Answer.
5630
6297
  * @example
5631
6298
  * ```js
@@ -5644,6 +6311,34 @@ export declare enum HostEvent {
5644
6311
  *
5645
6312
  * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
5646
6313
  * ```
6314
+ * @example
6315
+ * ```js
6316
+ * // Using context parameter to save answer from search context
6317
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6318
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6319
+ * name: "Regional sales analysis",
6320
+ * description: "Sales breakdown by region"
6321
+ * }, ContextType.Search);
6322
+ * ```
6323
+ * @example
6324
+ * ```js
6325
+ * // Save answer from answer context (explore modal)
6326
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6327
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6328
+ * name: "Modified analysis",
6329
+ * description: "Updated from explore view"
6330
+ * }, ContextType.Answer);
6331
+ * ```
6332
+ * @example
6333
+ * ```js
6334
+ * // Save answer from spotter context
6335
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6336
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
6337
+ * vizId: latestSpotterVizId,
6338
+ * name: "AI insights",
6339
+ * description: "Generated from Spotter"
6340
+ * }, ContextType.Spotter);
6341
+ * ```
5647
6342
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5648
6343
  */
5649
6344
  SaveAnswer = "saveAnswer",
@@ -5685,6 +6380,15 @@ export declare enum HostEvent {
5685
6380
  * executeSearch: true,
5686
6381
  * })
5687
6382
  * ```
6383
+ * @example
6384
+ * ```js
6385
+ * // Spotter search from spotter context
6386
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6387
+ * spotterEmbed.trigger(HostEvent.SpotterSearch, {
6388
+ * query: 'sales by region',
6389
+ * executeSearch: true
6390
+ * }, ContextType.Spotter);
6391
+ * ```
5688
6392
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5689
6393
  */
5690
6394
  SpotterSearch = "SpotterSearch",
@@ -5695,6 +6399,12 @@ export declare enum HostEvent {
5695
6399
  * ```js
5696
6400
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
5697
6401
  * ```
6402
+ * @example
6403
+ * ```js
6404
+ * // Edit last prompt from spotter context
6405
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6406
+ * spotterEmbed.trigger(HostEvent.EditLastPrompt, "sales by region", ContextType.Spotter);
6407
+ * ```
5698
6408
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5699
6409
  */
5700
6410
  EditLastPrompt = "EditLastPrompt",
@@ -5704,6 +6414,12 @@ export declare enum HostEvent {
5704
6414
  * ```js
5705
6415
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
5706
6416
  * ```
6417
+ * @example
6418
+ * ```js
6419
+ * // Preview spotter data from spotter context
6420
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6421
+ * spotterEmbed.trigger(HostEvent.PreviewSpotterData, {}, ContextType.Spotter);
6422
+ * ```
5707
6423
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5708
6424
  */
5709
6425
  PreviewSpotterData = "PreviewSpotterData",
@@ -5847,7 +6563,7 @@ export declare enum HostEvent {
5847
6563
  * The different visual modes that the data sources panel within
5848
6564
  * search could appear in, such as hidden, collapsed, or expanded.
5849
6565
  */
5850
- export declare enum DataSourceVisualMode {
6566
+ export enum DataSourceVisualMode {
5851
6567
  /**
5852
6568
  * The data source panel is hidden.
5853
6569
  */
@@ -5888,7 +6604,7 @@ export declare enum DataSourceVisualMode {
5888
6604
  * ```
5889
6605
  * See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
5890
6606
  */
5891
- export declare enum Action {
6607
+ export enum Action {
5892
6608
  /**
5893
6609
  * The **Save** action on an Answer or Liveboard.
5894
6610
  * Allows users to save the changes.
@@ -6816,13 +7532,25 @@ export declare enum Action {
6816
7532
  /**
6817
7533
  * The Liveboard Personalised Views dropdown.
6818
7534
  * Allows navigating to a personalized Liveboard View.
7535
+ * This action is deprecated. Use {@link Action.PersonalizedViewsDropdown} instead.
6819
7536
  * @example
6820
7537
  * ```js
6821
7538
  * disabledActions: [Action.PersonalisedViewsDropdown]
6822
7539
  * ```
6823
7540
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
7541
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6824
7542
  */
6825
7543
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
7544
+ /**
7545
+ * The Liveboard Personalized Views dropdown.
7546
+ * Allows navigating to a personalized Liveboard View.
7547
+ * @example
7548
+ * ```js
7549
+ * disabledActions: [Action.PersonalizedViewsDropdown]
7550
+ * ```
7551
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7552
+ */
7553
+ PersonalizedViewsDropdown = "personalisedViewsDropdown",
6826
7554
  /**
6827
7555
  * Action ID for show or hide the user details on a
6828
7556
  * Liveboard (Recently visited / social proof)
@@ -6910,14 +7638,27 @@ export declare enum Action {
6910
7638
  /**
6911
7639
  * The **Organize Favourites** action on Homepage
6912
7640
  * *Favorites* module.
7641
+ * This action is deprecated. Use {@link Action.OrganizeFavorites} instead.
6913
7642
  *
6914
7643
  * @example
6915
7644
  * ```js
6916
7645
  * disabledActions: [Action.OrganiseFavourites]
6917
7646
  * ```
6918
7647
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
7648
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6919
7649
  */
6920
7650
  OrganiseFavourites = "organiseFavourites",
7651
+ /**
7652
+ * The **Organize Favorites** action on Homepage
7653
+ * *Favorites* module.
7654
+ *
7655
+ * @example
7656
+ * ```js
7657
+ * disabledActions: [Action.OrganizeFavorites]
7658
+ * ```
7659
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7660
+ */
7661
+ OrganizeFavorites = "organiseFavourites",
6921
7662
  /**
6922
7663
  * The **AI Highlights** action on a Liveboard.
6923
7664
  *
@@ -7386,7 +8127,7 @@ export declare enum Action {
7386
8127
  */
7387
8128
  IncludeCurrentPeriod = "includeCurrentPeriod"
7388
8129
  }
7389
- export declare enum PrefetchFeatures {
8130
+ export enum PrefetchFeatures {
7390
8131
  FullApp = "FullApp",
7391
8132
  SearchEmbed = "SearchEmbed",
7392
8133
  LiveboardEmbed = "LiveboardEmbed",
@@ -7396,7 +8137,7 @@ export declare enum PrefetchFeatures {
7396
8137
  * Enum for options to change context trigger.
7397
8138
  * The `BOTH_CLICKS` option is available from 10.8.0.cl.
7398
8139
  */
7399
- export declare enum ContextMenuTriggerOptions {
8140
+ export enum ContextMenuTriggerOptions {
7400
8141
  LEFT_CLICK = "left-click",
7401
8142
  RIGHT_CLICK = "right-click",
7402
8143
  BOTH_CLICKS = "both-clicks"
@@ -7463,7 +8204,7 @@ export interface CustomAction {
7463
8204
  * Enum options to show custom actions at different
7464
8205
  * positions in the application.
7465
8206
  */
7466
- export declare enum CustomActionsPosition {
8207
+ export enum CustomActionsPosition {
7467
8208
  /**
7468
8209
  * Shows the action as a primary button
7469
8210
  * in the toolbar area of the embed.
@@ -7489,7 +8230,7 @@ export declare enum CustomActionsPosition {
7489
8230
  * associated with, and also controls which positions and scoping options
7490
8231
  * are available.
7491
8232
  */
7492
- export declare enum CustomActionTarget {
8233
+ export enum CustomActionTarget {
7493
8234
  /**
7494
8235
  * Action applies at the Liveboard level.
7495
8236
  * Supported positions:
@@ -7545,7 +8286,7 @@ export declare enum CustomActionTarget {
7545
8286
  * This attribute doesn't support suppressing
7546
8287
  * browser warnings or errors.
7547
8288
  */
7548
- export declare enum LogLevel {
8289
+ export enum LogLevel {
7549
8290
  /**
7550
8291
  * No application or SDK-related logs will be logged
7551
8292
  * in the console output.
@@ -7651,7 +8392,7 @@ export declare enum LogLevel {
7651
8392
  * });
7652
8393
  * ```
7653
8394
  */
7654
- export declare enum ErrorDetailsTypes {
8395
+ export enum ErrorDetailsTypes {
7655
8396
  /** API call failure */
7656
8397
  API = "API",
7657
8398
  /** General validation error */
@@ -7690,7 +8431,7 @@ export declare enum ErrorDetailsTypes {
7690
8431
  * });
7691
8432
  * ```
7692
8433
  * */
7693
- export declare enum EmbedErrorCodes {
8434
+ export enum EmbedErrorCodes {
7694
8435
  /** Worksheet ID not found or does not exist */
7695
8436
  WORKSHEET_ID_NOT_FOUND = "WORKSHEET_ID_NOT_FOUND",
7696
8437
  /** Required Liveboard ID is missing from configuration */
@@ -7729,7 +8470,8 @@ export declare enum EmbedErrorCodes {
7729
8470
  *
7730
8471
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
7731
8472
  * - **message**: Human-readable error description (string or array of strings for
7732
- * multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
8473
+ * multiple errors)
8474
+ * - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
7733
8475
  * values
7734
8476
  * - **[key: string]**: Additional context-specific for backward compatibility
7735
8477
  *
@@ -7777,7 +8519,23 @@ export interface EmbedErrorDetailsEvent {
7777
8519
  /** Additional context-specific for backward compatibility */
7778
8520
  [key: string]: any;
7779
8521
  }
7780
- export declare enum ContextType {
8522
+ /**
8523
+ * Context types for specifying the page context when triggering host events.
8524
+ * Used as the third parameter in the `trigger` method to help ThoughtSpot
8525
+ * understand the current page context for better event handling.
8526
+ *
8527
+ * @example
8528
+ * ```js
8529
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
8530
+ *
8531
+ * // Trigger an event with specific context
8532
+ * embed.trigger(HostEvent.Pin, { vizId: "123", liveboardId: "456" }, ContextType.Search);
8533
+ * ```
8534
+ *
8535
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
8536
+ * @group Events
8537
+ */
8538
+ export enum ContextType {
7781
8539
  /**
7782
8540
  * Search answer context for search page or edit viz dialog on liveboard page.
7783
8541
  */
@@ -7793,7 +8551,11 @@ export declare enum ContextType {
7793
8551
  /**
7794
8552
  * Spotter context for spotter modal/page.
7795
8553
  */
7796
- Spotter = "spotter"
8554
+ Spotter = "spotter",
8555
+ /**
8556
+ * Other context for any other generic page.
8557
+ */
8558
+ Other = "other"
7797
8559
  }
7798
8560
  export interface DefaultAppInitData {
7799
8561
  customisations: CustomisationsInterface;
@@ -7813,7 +8575,7 @@ export interface DefaultAppInitData {
7813
8575
  /**
7814
8576
  * Enum for the type of API intercepted
7815
8577
  */
7816
- export declare enum InterceptedApiType {
8578
+ export enum InterceptedApiType {
7817
8579
  /**
7818
8580
  * The apis that are use to get the data for the embed
7819
8581
  */
@@ -7896,33 +8658,6 @@ export interface ObjectIds {
7896
8658
  */
7897
8659
  modalTitle?: string;
7898
8660
  }
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
8661
  export interface ContextObject {
7927
8662
  /**
7928
8663
  * Stack of context objects.
@@ -7953,14 +8688,26 @@ export interface ContextObject {
7953
8688
  objectIds: ObjectIds;
7954
8689
  };
7955
8690
  }
7956
- export declare enum UIPassthroughEvent {
8691
+ export interface LiveboardTab {
8692
+ id: string;
8693
+ name: string;
8694
+ [key: string]: any;
8695
+ }
8696
+ export enum UIPassthroughEvent {
7957
8697
  PinAnswerToLiveboard = "addVizToPinboard",
7958
8698
  SaveAnswer = "saveAnswer",
7959
8699
  GetDiscoverabilityStatus = "getDiscoverabilityStatus",
7960
8700
  GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
7961
8701
  GetAnswerConfig = "getAnswerPageConfig",
7962
8702
  GetLiveboardConfig = "getPinboardPageConfig",
7963
- GetUnsavedAnswerTML = "getUnsavedAnswerTML"
8703
+ GetUnsavedAnswerTML = "getUnsavedAnswerTML",
8704
+ GetAnswerSession = "getAnswerSession",
8705
+ GetFilters = "getFilters",
8706
+ GetIframeUrl = "getIframeUrl",
8707
+ GetParameters = "getParameters",
8708
+ GetTML = "getTML",
8709
+ GetTabs = "getTabs",
8710
+ GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
7964
8711
  }
7965
8712
  export type UIPassthroughContractBase = {
7966
8713
  [UIPassthroughEvent.PinAnswerToLiveboard]: {
@@ -8024,24 +8771,86 @@ export type UIPassthroughContractBase = {
8024
8771
  tml: string;
8025
8772
  };
8026
8773
  };
8774
+ [UIPassthroughEvent.GetAnswerSession]: {
8775
+ request: {
8776
+ vizId?: string;
8777
+ };
8778
+ response: {
8779
+ session: SessionInterface;
8780
+ embedAnswerData?: Record<string, any>;
8781
+ };
8782
+ };
8783
+ [UIPassthroughEvent.GetFilters]: {
8784
+ request: {
8785
+ vizId?: string;
8786
+ };
8787
+ response: {
8788
+ liveboardFilters: Record<string, any>[];
8789
+ runtimeFilters: RuntimeFilter[];
8790
+ };
8791
+ };
8792
+ [UIPassthroughEvent.GetIframeUrl]: {
8793
+ request: Record<string, never>;
8794
+ response: {
8795
+ iframeUrl: string;
8796
+ };
8797
+ };
8798
+ [UIPassthroughEvent.GetParameters]: {
8799
+ request: Record<string, never>;
8800
+ response: {
8801
+ parameters: Record<string, any>[];
8802
+ };
8803
+ };
8804
+ [UIPassthroughEvent.GetTML]: {
8805
+ request: {
8806
+ vizId?: string;
8807
+ includeNonExecutedSearchTokens?: boolean;
8808
+ };
8809
+ response: Record<string, any>;
8810
+ };
8811
+ [UIPassthroughEvent.GetTabs]: {
8812
+ request: Record<string, never>;
8813
+ response: {
8814
+ orderedTabIds: string[];
8815
+ numberOfTabs: number;
8816
+ Tabs: LiveboardTab[];
8817
+ };
8818
+ };
8819
+ [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
8820
+ request: Record<string, never>;
8821
+ response: {
8822
+ v2Content: string;
8823
+ };
8824
+ };
8027
8825
  };
8028
8826
  export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
8029
8827
  export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
8030
8828
  export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> = Array<{
8031
- redId?: string;
8829
+ refId?: string;
8032
8830
  value?: UIPassthroughResponse<ApiName>;
8033
8831
  error?: any;
8034
8832
  }>;
8035
8833
  export type EmbedApiHostEventMapping = {
8036
8834
  [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
8037
8835
  [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
8836
+ [HostEvent.GetAnswerSession]: UIPassthroughEvent.GetAnswerSession;
8837
+ [HostEvent.GetFilters]: UIPassthroughEvent.GetFilters;
8838
+ [HostEvent.GetIframeUrl]: UIPassthroughEvent.GetIframeUrl;
8839
+ [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
8840
+ [HostEvent.GetTML]: UIPassthroughEvent.GetTML;
8841
+ [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
8842
+ [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
8038
8843
  };
8039
8844
  export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
8040
8845
  export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
8041
8846
  export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
8042
8847
  export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
8043
- declare class HostEventClient {
8848
+ class HostEventClient {
8044
8849
  iFrame: HTMLIFrameElement;
8850
+ /** Host events with custom handlers
8851
+ * (setters or special logic) -
8852
+ * bound to instance for protected method access */
8853
+ private readonly customHandlers;
8045
8854
  constructor(iFrame?: HTMLIFrameElement);
8046
8855
  /**
8047
8856
  * A wrapper over process trigger to
@@ -8052,6 +8861,12 @@ declare class HostEventClient {
8052
8861
  protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
8053
8862
  handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
8054
8863
  hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
8864
+ /**
8865
+ * For getter events that return data. Tries UI passthrough first;
8866
+ * if the app doesn't support it (no response data), falls back to
8867
+ * the legacy host event channel. Real errors are thrown as-is.
8868
+ */
8869
+ private getDataWithPassthroughFallback;
8055
8870
  /**
8056
8871
  * Setter for the iframe element used for host events
8057
8872
  * @param {HTMLIFrameElement} iFrame - the iframe element to set
@@ -8062,7 +8877,7 @@ declare class HostEventClient {
8062
8877
  protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
8063
8878
  triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
8064
8879
  }
8065
- declare class TsEmbed {
8880
+ class TsEmbed {
8066
8881
  /**
8067
8882
  * The DOM node which was inserted by the SDK to either
8068
8883
  * render the iframe or display an error message.
@@ -8395,7 +9210,21 @@ declare class TsEmbed {
8395
9210
  * Triggers an event to the embedded app
8396
9211
  * @param {HostEvent} messageType The event type
8397
9212
  * @param {any} data The payload to send with the message
9213
+ * @param {ContextType} context Optional context type to specify the context from which the event is triggered.
9214
+ * Use ContextType.Search for search answer context, ContextType.Answer for answer/explore context,
9215
+ * ContextType.Liveboard for liveboard context, or ContextType.Spotter for spotter context.
9216
+ * Available from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl
8398
9217
  * @returns A promise that resolves with the response from the embedded app
9218
+ * @example
9219
+ * ```js
9220
+ * // Trigger Pin event with context (SDK: 1.45.2+)
9221
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
9222
+ * embed.trigger(HostEvent.Pin, {
9223
+ * vizId: "123",
9224
+ * liveboardId: "456"
9225
+ * }, ContextType.Search);
9226
+ * ```
9227
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl (for context parameter)
8399
9228
  */
8400
9229
  trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
8401
9230
  /**
@@ -8416,8 +9245,33 @@ declare class TsEmbed {
8416
9245
  getIframeSrc(): string;
8417
9246
  protected handleRenderForPrerender(): Promise<TsEmbed>;
8418
9247
  /**
8419
- * Get the current context of the embedded TS component.
8420
- * @returns The current context object containing the page type and object ids.
9248
+ * Context object for the embedded component.
9249
+ * @returns {ContextObject} The current context object containing the page type and object ids.
9250
+ * @example
9251
+ * ```js
9252
+ * const context = await embed.getCurrentContext();
9253
+ * console.log(context);
9254
+ *
9255
+ * // Example output
9256
+ * {
9257
+ * stack: [
9258
+ * {
9259
+ * name: 'Liveboard',
9260
+ * type: ContextType.Liveboard,
9261
+ * objectIds: {
9262
+ * liveboardId: '123',
9263
+ * },
9264
+ * },
9265
+ * ],
9266
+ * currentContext: {
9267
+ * name: 'Liveboard',
9268
+ * type: ContextType.Liveboard,
9269
+ * objectIds: {
9270
+ * liveboardId: '123',
9271
+ * },
9272
+ * },
9273
+ * }
9274
+ * ```
8421
9275
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
8422
9276
  */
8423
9277
  getCurrentContext(): Promise<ContextObject>;
@@ -8500,7 +9354,7 @@ declare class TsEmbed {
8500
9354
  */
8501
9355
  private removeFullscreenChangeHandler;
8502
9356
  }
8503
- declare class V1Embed extends TsEmbed {
9357
+ class V1Embed extends TsEmbed {
8504
9358
  protected viewConfig: AllEmbedViewConfig;
8505
9359
  constructor(domSelector: DOMSelector, viewConfig: AllEmbedViewConfig);
8506
9360
  /**
@@ -8882,7 +9736,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
8882
9736
  * conversation.render();
8883
9737
  * ```
8884
9738
  */
8885
- export declare class SpotterEmbed extends TsEmbed {
9739
+ export class SpotterEmbed extends TsEmbed {
8886
9740
  protected viewConfig: SpotterEmbedViewConfig;
8887
9741
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
8888
9742
  protected getEmbedParamsObject(): Record<any, any>;
@@ -8906,14 +9760,14 @@ export declare class SpotterEmbed extends TsEmbed {
8906
9760
  * conversation.render();
8907
9761
  * ```
8908
9762
  */
8909
- export declare class ConversationEmbed extends SpotterEmbed {
9763
+ export class ConversationEmbed extends SpotterEmbed {
8910
9764
  protected viewConfig: ConversationViewConfig;
8911
9765
  constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
8912
9766
  }
8913
9767
  /**
8914
9768
  * Pages within the ThoughtSpot app that can be embedded.
8915
9769
  */
8916
- export declare enum Page {
9770
+ export enum Page {
8917
9771
  /**
8918
9772
  * Home page
8919
9773
  */
@@ -8951,7 +9805,7 @@ export declare enum Page {
8951
9805
  * Define the initial state of column custom group accordions
8952
9806
  * in data panel v2.
8953
9807
  */
8954
- export declare enum DataPanelCustomColumnGroupsAccordionState {
9808
+ export enum DataPanelCustomColumnGroupsAccordionState {
8955
9809
  /**
8956
9810
  * Expand all the accordion initially in data panel v2.
8957
9811
  */
@@ -8965,7 +9819,7 @@ export declare enum DataPanelCustomColumnGroupsAccordionState {
8965
9819
  */
8966
9820
  EXPAND_FIRST = "EXPAND_FIRST"
8967
9821
  }
8968
- export declare enum HomePageSearchBarMode {
9822
+ export enum HomePageSearchBarMode {
8969
9823
  OBJECT_SEARCH = "objectSearch",
8970
9824
  AI_ANSWER = "aiAnswer",
8971
9825
  NONE = "none"
@@ -8974,7 +9828,7 @@ export declare enum HomePageSearchBarMode {
8974
9828
  * Define the version of the primary navbar
8975
9829
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
8976
9830
  */
8977
- export declare enum PrimaryNavbarVersion {
9831
+ export enum PrimaryNavbarVersion {
8978
9832
  /**
8979
9833
  * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
8980
9834
  * along with updates to the top navigation bar.
@@ -8986,7 +9840,7 @@ export declare enum PrimaryNavbarVersion {
8986
9840
  * Define the version of the home page
8987
9841
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
8988
9842
  */
8989
- export declare enum HomePage {
9843
+ export enum HomePage {
8990
9844
  /**
8991
9845
  * Modular (v2) introduces the updated Modular Home Experience.
8992
9846
  * It serves as the foundational version of the home page.
@@ -9002,7 +9856,7 @@ export declare enum HomePage {
9002
9856
  * Define the version of the list page
9003
9857
  * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
9004
9858
  */
9005
- export declare enum ListPage {
9859
+ export enum ListPage {
9006
9860
  /**
9007
9861
  * List (v2) is the traditional List Experience.
9008
9862
  * It serves as the foundational version of the list page.
@@ -9634,7 +10488,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9634
10488
  * Embeds full ThoughtSpot experience in a host application.
9635
10489
  * @group Embed components
9636
10490
  */
9637
- export declare class AppEmbed extends V1Embed {
10491
+ export class AppEmbed extends V1Embed {
9638
10492
  protected viewConfig: AppViewConfig;
9639
10493
  private defaultHeight;
9640
10494
  constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
@@ -9656,6 +10510,7 @@ export declare class AppEmbed extends V1Embed {
9656
10510
  * @param pageId The ID of the page to be embedded.
9657
10511
  */
9658
10512
  getIFrameSrc(): string;
10513
+ private HEIGHT_CHANAGE_THRESHOLD;
9659
10514
  /**
9660
10515
  * Set the iframe height as per the computed height received
9661
10516
  * from the ThoughtSpot app.
@@ -9708,7 +10563,7 @@ export declare class AppEmbed extends V1Embed {
9708
10563
  * This value is passed to the listener for {@link AuthStatus.FAILURE}.
9709
10564
  * @group Authentication / Init
9710
10565
  */
9711
- export declare enum AuthFailureType {
10566
+ export enum AuthFailureType {
9712
10567
  /**
9713
10568
  * Authentication failed in the SDK authentication flow.
9714
10569
  *
@@ -9727,7 +10582,8 @@ export declare enum AuthFailureType {
9727
10582
  /**
9728
10583
  * The current authentication token or session has expired.
9729
10584
  *
9730
- * Emitted when the embed receives an auth-expiry signal and starts auth refresh handling.
10585
+ * Emitted when the embed receives an auth-expiry signal and starts auth refresh
10586
+ * handling.
9731
10587
  */
9732
10588
  EXPIRY = "EXPIRY",
9733
10589
  /**
@@ -9753,7 +10609,7 @@ export declare enum AuthFailureType {
9753
10609
  * Enum for auth status emitted by the emitter returned from {@link init}.
9754
10610
  * @group Authentication / Init
9755
10611
  */
9756
- export declare enum AuthStatus {
10612
+ export enum AuthStatus {
9757
10613
  /**
9758
10614
  * Emits when the SDK fails to authenticate.
9759
10615
  */
@@ -9856,7 +10712,7 @@ export interface AuthEventEmitter {
9856
10712
  * Events which can be triggered on the emitter returned from {@link init}.
9857
10713
  * @group Authentication / Init
9858
10714
  */
9859
- export declare enum AuthEvent {
10715
+ export enum AuthEvent {
9860
10716
  /**
9861
10717
  * Manually trigger the SSO popup. This is useful when
9862
10718
  * authStatus is SAMLRedirect/OIDCRedirect and inPopup is set to true
@@ -9887,7 +10743,7 @@ export interface exportTMLInput {
9887
10743
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
9888
10744
  * @group Global methods
9889
10745
  */
9890
- export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], additionalFlags?: {
10746
+ export const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], additionalFlags?: {
9891
10747
  [key: string]: string | number | boolean;
9892
10748
  }) => void;
9893
10749
  /**
@@ -9910,7 +10766,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
9910
10766
  * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
9911
10767
  * @group Authentication / Init
9912
10768
  */
9913
- export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter | null;
10769
+ export const init: (embedConfig: EmbedConfig) => AuthEventEmitter | null;
9914
10770
  /**
9915
10771
  * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
9916
10772
  * prevent the SDK from automatically logging in again.
@@ -9922,7 +10778,7 @@ export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter | null
9922
10778
  * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
9923
10779
  * @group Global methods
9924
10780
  */
9925
- export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
10781
+ export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
9926
10782
  /**
9927
10783
  * Imports TML representation of the metadata objects into ThoughtSpot.
9928
10784
  * @param data
@@ -9946,7 +10802,7 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
9946
10802
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
9947
10803
  * @group Global methods
9948
10804
  */
9949
- export declare const executeTML: (data: executeTMLInput) => Promise<any>;
10805
+ export const executeTML: (data: executeTMLInput) => Promise<any>;
9950
10806
  /**
9951
10807
  * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
9952
10808
  * format.
@@ -9977,14 +10833,14 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
9977
10833
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
9978
10834
  * @group Global methods
9979
10835
  */
9980
- export declare const exportTML: (data: exportTMLInput) => Promise<any>;
10836
+ export const exportTML: (data: exportTMLInput) => Promise<any>;
9981
10837
  /**
9982
10838
  * Reloads the ThoughtSpot iframe.
9983
10839
  * @version SDK: 1.43.1
9984
10840
  * @param iFrame
9985
10841
  * @group Global methods
9986
10842
  */
9987
- export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
10843
+ export const reloadIframe: (iFrame: HTMLIFrameElement) => void;
9988
10844
  /**
9989
10845
  * The configuration for the embedded Liveboard or visualization page view.
9990
10846
  * @group Embed components
@@ -10473,7 +11329,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10473
11329
  * })
10474
11330
  * ```
10475
11331
  */
10476
- export declare class LiveboardEmbed extends V1Embed {
11332
+ export class LiveboardEmbed extends V1Embed {
10477
11333
  protected viewConfig: LiveboardViewConfig;
10478
11334
  private defaultHeight;
10479
11335
  constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
@@ -10497,6 +11353,7 @@ export declare class LiveboardEmbed extends V1Embed {
10497
11353
  * to be loaded within the iFrame.
10498
11354
  */
10499
11355
  private getIFrameSrc;
11356
+ private HEIGHT_CHANAGE_THRESHOLD;
10500
11357
  /**
10501
11358
  * Set the iframe height as per the computed height received
10502
11359
  * from the ThoughtSpot app.
@@ -10552,7 +11409,7 @@ export declare class LiveboardEmbed extends V1Embed {
10552
11409
  /**
10553
11410
  * @hidden
10554
11411
  */
10555
- export declare class PinboardEmbed extends LiveboardEmbed {
11412
+ export class PinboardEmbed extends LiveboardEmbed {
10556
11413
  }
10557
11414
  interface SearchOptions$1 {
10558
11415
  /**
@@ -10567,7 +11424,7 @@ interface SearchOptions$1 {
10567
11424
  */
10568
11425
  executeSearch?: boolean;
10569
11426
  }
10570
- declare enum DataPanelCustomColumnGroupsAccordionState$1 {
11427
+ enum DataPanelCustomColumnGroupsAccordionState$1 {
10571
11428
  /**
10572
11429
  * Expand all the accordion initially in data panel v2.
10573
11430
  */
@@ -10839,7 +11696,7 @@ export interface SearchAppInitData extends DefaultAppInitData {
10839
11696
  * Embed ThoughtSpot search
10840
11697
  * @group Embed components
10841
11698
  */
10842
- export declare class SearchEmbed extends TsEmbed {
11699
+ export class SearchEmbed extends TsEmbed {
10843
11700
  /**
10844
11701
  * The view configuration for the embedded ThoughtSpot search.
10845
11702
  */
@@ -10970,7 +11827,7 @@ interface SearchAppInitData$1 extends DefaultAppInitData {
10970
11827
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
10971
11828
  * @group Embed components
10972
11829
  */
10973
- export declare class SearchBarEmbed extends TsEmbed {
11830
+ export class SearchBarEmbed extends TsEmbed {
10974
11831
  /**
10975
11832
  * The view configuration for the embedded ThoughtSpot search bar.
10976
11833
  */
@@ -11019,7 +11876,7 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
11019
11876
  convId: string;
11020
11877
  messageId: string;
11021
11878
  }
11022
- declare class ConversationMessage extends TsEmbed {
11879
+ class ConversationMessage extends TsEmbed {
11023
11880
  protected viewConfig: SpotterAgentMessageViewConfig;
11024
11881
  constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
11025
11882
  protected getEmbedParamsObject(): Record<any, any>;
@@ -11045,7 +11902,7 @@ declare class ConversationMessage extends TsEmbed {
11045
11902
  * document.body.appendChild(container); // or to any other element
11046
11903
  * ```
11047
11904
  */
11048
- export declare class SpotterAgentEmbed {
11905
+ export class SpotterAgentEmbed {
11049
11906
  private viewConfig;
11050
11907
  private conversationService;
11051
11908
  constructor(viewConfig: SpotterAgentEmbedViewConfig);
@@ -11098,7 +11955,7 @@ export declare class SpotterAgentEmbed {
11098
11955
  * document.body.appendChild(container); // or to any other element
11099
11956
  * ```
11100
11957
  */
11101
- export declare class BodylessConversation extends SpotterAgentEmbed {
11958
+ export class BodylessConversation extends SpotterAgentEmbed {
11102
11959
  constructor(viewConfig: BodylessConversationViewConfig);
11103
11960
  }
11104
11961
  export type SessionInfo = {
@@ -11124,7 +11981,7 @@ export type SessionInfo = {
11124
11981
  * @version SDK: 1.28.3 | ThoughtSpot: *
11125
11982
  * @returns {Promise<SessionInfo>} The session info object.
11126
11983
  */
11127
- export declare function getSessionInfo(): Promise<SessionInfo>;
11984
+ export function getSessionInfo(): Promise<SessionInfo>;
11128
11985
  interface SearchOptions$2 {
11129
11986
  /**
11130
11987
  * The query string to pass for Natural Language Search.
@@ -11250,7 +12107,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
11250
12107
  * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
11251
12108
  * @group Embed components
11252
12109
  */
11253
- export declare class SageEmbed extends V1Embed {
12110
+ export class SageEmbed extends V1Embed {
11254
12111
  /**
11255
12112
  * The view configuration for the embedded ThoughtSpot sage.
11256
12113
  *
@@ -11327,12 +12184,12 @@ export declare class SageEmbed extends V1Embed {
11327
12184
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later
11328
12185
  * @group Global methods
11329
12186
  */
11330
- declare const getEmbedConfig: () => EmbedConfig;
12187
+ const getEmbedConfig: () => EmbedConfig;
11331
12188
  /**
11332
12189
  * Enum of mixpanel events
11333
12190
  * @hidden
11334
12191
  */
11335
- export declare const MIXPANEL_EVENT: {
12192
+ export const MIXPANEL_EVENT: {
11336
12193
  VISUAL_SDK_RENDER_START: string;
11337
12194
  VISUAL_SDK_CALLED_INIT: string;
11338
12195
  VISUAL_SDK_RENDER_COMPLETE: string;
@@ -11348,7 +12205,7 @@ export declare const MIXPANEL_EVENT: {
11348
12205
  * @param eventId
11349
12206
  * @param eventProps
11350
12207
  */
11351
- export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): void;
12208
+ export function uploadMixpanelEvent(eventId: string, eventProps?: {}): void;
11352
12209
  /**
11353
12210
  * Fetch wrapper that adds the authentication token to the request.
11354
12211
  * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
@@ -11364,7 +12221,7 @@ export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): v
11364
12221
  * @version SDK: 1.28.0
11365
12222
  * @group Global methods
11366
12223
  */
11367
- export declare const tokenizedFetch: typeof fetch;
12224
+ export const tokenizedFetch: typeof fetch;
11368
12225
  /**
11369
12226
  * Get answer from natural language query
11370
12227
  * @param query string
@@ -11376,7 +12233,7 @@ export declare const tokenizedFetch: typeof fetch;
11376
12233
  * const { answer } = await getAnswerFromQuery('revenue', 'worksheetId');
11377
12234
  * ```
11378
12235
  */
11379
- export declare const getAnswerFromQuery: (query: string, worksheetId: string) => Promise<{
12236
+ export const getAnswerFromQuery: (query: string, worksheetId: string) => Promise<{
11380
12237
  answer: AnswerService;
11381
12238
  suggestion: any;
11382
12239
  }>;
@@ -11408,7 +12265,7 @@ export declare const getAnswerFromQuery: (query: string, worksheetId: string) =>
11408
12265
  * });
11409
12266
  * ```
11410
12267
  */
11411
- export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
12268
+ export const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
11412
12269
  /**
11413
12270
  * Resets the auth token and a new token will be fetched on the next request.
11414
12271
  * @example
@@ -11418,7 +12275,7 @@ export declare const createLiveboardWithAnswers: (answers: AnswerService[], name
11418
12275
  * @version SDK: 1.28.0 | ThoughtSpot: *
11419
12276
  * @group Authentication / Init
11420
12277
  */
11421
- export declare const resetCachedAuthToken: () => void;
12278
+ export const resetCachedAuthToken: () => void;
11422
12279
  /**
11423
12280
  * Starts an automatic renderer that watches the DOM for iframes containing
11424
12281
  * the `tsmcp=true` query parameter and replaces them with fully configured
@@ -11457,10 +12314,10 @@ export declare const resetCachedAuthToken: () => void;
11457
12314
  * Detailed example of how to use the auto-frame renderer:
11458
12315
  * [Python React Agent Simple UI](https://github.com/thoughtspot/developer-examples/tree/main/mcp/python-react-agent-simple-ui)
11459
12316
  */
11460
- export declare function startAutoMCPFrameRenderer(viewConfig?: AutoMCPFrameRendererViewConfig): MutationObserver;
12317
+ export function startAutoMCPFrameRenderer(viewConfig?: AutoMCPFrameRendererViewConfig): MutationObserver;
11461
12318
 
11462
12319
  export {
11463
12320
  getEmbedConfig as getInitConfig,
11464
12321
  };
11465
12322
 
11466
- export {};
12323
+ }