@thoughtspot/visual-embed-sdk 1.53.0 → 1.53.2-beta

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 (203) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/auth.d.ts.map +1 -1
  3. package/cjs/src/auth.js +25 -6
  4. package/cjs/src/auth.js.map +1 -1
  5. package/cjs/src/auth.spec.js +40 -8
  6. package/cjs/src/auth.spec.js.map +1 -1
  7. package/cjs/src/contracts/contracts.spec.js +169 -2
  8. package/cjs/src/contracts/contracts.spec.js.map +1 -1
  9. package/cjs/src/contracts/embed-event-payloads.d.ts +212 -14
  10. package/cjs/src/contracts/embed-event-payloads.d.ts.map +1 -1
  11. package/cjs/src/contracts/host-event-contracts.d.ts +11 -0
  12. package/cjs/src/contracts/host-event-contracts.d.ts.map +1 -1
  13. package/cjs/src/css-variables.d.ts +140 -0
  14. package/cjs/src/css-variables.d.ts.map +1 -1
  15. package/cjs/src/embed/app.d.ts +1 -0
  16. package/cjs/src/embed/app.d.ts.map +1 -1
  17. package/cjs/src/embed/app.js.map +1 -1
  18. package/cjs/src/embed/auto-frame-renderer.d.ts +14 -1
  19. package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -1
  20. package/cjs/src/embed/auto-frame-renderer.js +91 -2
  21. package/cjs/src/embed/auto-frame-renderer.js.map +1 -1
  22. package/cjs/src/embed/auto-frame-renderer.spec.js +112 -7
  23. package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -1
  24. package/cjs/src/embed/conversation.d.ts +14 -0
  25. package/cjs/src/embed/conversation.d.ts.map +1 -1
  26. package/cjs/src/embed/conversation.js.map +1 -1
  27. package/cjs/src/embed/conversation.spec.js +22 -0
  28. package/cjs/src/embed/conversation.spec.js.map +1 -1
  29. package/cjs/src/embed/host-events.spec.js +50 -0
  30. package/cjs/src/embed/host-events.spec.js.map +1 -1
  31. package/cjs/src/embed/liveboard.d.ts +2 -16
  32. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  33. package/cjs/src/embed/liveboard.js +29 -10
  34. package/cjs/src/embed/liveboard.js.map +1 -1
  35. package/cjs/src/embed/liveboard.spec.js +139 -0
  36. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  37. package/cjs/src/embed/spotter-utils.d.ts +1 -0
  38. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  39. package/cjs/src/embed/spotter-utils.js +7 -1
  40. package/cjs/src/embed/spotter-utils.js.map +1 -1
  41. package/cjs/src/embed/spotter-utils.spec.js +19 -0
  42. package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
  43. package/cjs/src/embed/ts-embed.d.ts +21 -16
  44. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  45. package/cjs/src/embed/ts-embed.js +77 -63
  46. package/cjs/src/embed/ts-embed.js.map +1 -1
  47. package/cjs/src/embed/ts-embed.spec.js +240 -7
  48. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  49. package/cjs/src/index.d.ts +2 -2
  50. package/cjs/src/index.d.ts.map +1 -1
  51. package/cjs/src/index.js.map +1 -1
  52. package/cjs/src/react/all-types-export.d.ts +1 -1
  53. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  54. package/cjs/src/react/all-types-export.js.map +1 -1
  55. package/cjs/src/react/util.d.ts +8 -1
  56. package/cjs/src/react/util.d.ts.map +1 -1
  57. package/cjs/src/react/util.js.map +1 -1
  58. package/cjs/src/types.d.ts +249 -2
  59. package/cjs/src/types.d.ts.map +1 -1
  60. package/cjs/src/types.js +247 -0
  61. package/cjs/src/types.js.map +1 -1
  62. package/cjs/src/utils/runtimeTelemetry.d.ts +11 -0
  63. package/cjs/src/utils/runtimeTelemetry.d.ts.map +1 -0
  64. package/cjs/src/utils/runtimeTelemetry.js +34 -0
  65. package/cjs/src/utils/runtimeTelemetry.js.map +1 -0
  66. package/cjs/src/utils/runtimeTelemetry.spec.d.ts +2 -0
  67. package/cjs/src/utils/runtimeTelemetry.spec.d.ts.map +1 -0
  68. package/cjs/src/utils/runtimeTelemetry.spec.js +124 -0
  69. package/cjs/src/utils/runtimeTelemetry.spec.js.map +1 -0
  70. package/dist/{index-CyDR8j_0.js → index-DQ7r5f1z.js} +1 -1
  71. package/dist/src/auth.d.ts.map +1 -1
  72. package/dist/src/contracts/embed-event-payloads.d.ts +212 -14
  73. package/dist/src/contracts/embed-event-payloads.d.ts.map +1 -1
  74. package/dist/src/contracts/host-event-contracts.d.ts +11 -0
  75. package/dist/src/contracts/host-event-contracts.d.ts.map +1 -1
  76. package/dist/src/css-variables.d.ts +140 -0
  77. package/dist/src/css-variables.d.ts.map +1 -1
  78. package/dist/src/embed/app.d.ts +1 -0
  79. package/dist/src/embed/app.d.ts.map +1 -1
  80. package/dist/src/embed/auto-frame-renderer.d.ts +14 -1
  81. package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -1
  82. package/dist/src/embed/conversation.d.ts +14 -0
  83. package/dist/src/embed/conversation.d.ts.map +1 -1
  84. package/dist/src/embed/liveboard.d.ts +2 -16
  85. package/dist/src/embed/liveboard.d.ts.map +1 -1
  86. package/dist/src/embed/spotter-utils.d.ts +1 -0
  87. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  88. package/dist/src/embed/ts-embed.d.ts +21 -16
  89. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  90. package/dist/src/index.d.ts +2 -2
  91. package/dist/src/index.d.ts.map +1 -1
  92. package/dist/src/react/all-types-export.d.ts +1 -1
  93. package/dist/src/react/all-types-export.d.ts.map +1 -1
  94. package/dist/src/react/util.d.ts +8 -1
  95. package/dist/src/react/util.d.ts.map +1 -1
  96. package/dist/src/types.d.ts +249 -2
  97. package/dist/src/types.d.ts.map +1 -1
  98. package/dist/src/utils/runtimeTelemetry.d.ts +11 -0
  99. package/dist/src/utils/runtimeTelemetry.d.ts.map +1 -0
  100. package/dist/src/utils/runtimeTelemetry.spec.d.ts +2 -0
  101. package/dist/src/utils/runtimeTelemetry.spec.d.ts.map +1 -0
  102. package/dist/tsembed-react.es.js +474 -84
  103. package/dist/tsembed-react.js +473 -83
  104. package/dist/tsembed.es.js +542 -85
  105. package/dist/tsembed.js +541 -84
  106. package/dist/visual-embed-sdk-react-full.d.ts +649 -30
  107. package/dist/visual-embed-sdk-react.d.ts +646 -28
  108. package/dist/visual-embed-sdk.d.ts +642 -44
  109. package/lib/package.json +1 -1
  110. package/lib/src/auth.d.ts.map +1 -1
  111. package/lib/src/auth.js +25 -6
  112. package/lib/src/auth.js.map +1 -1
  113. package/lib/src/auth.spec.js +40 -8
  114. package/lib/src/auth.spec.js.map +1 -1
  115. package/lib/src/contracts/contracts.spec.js +169 -2
  116. package/lib/src/contracts/contracts.spec.js.map +1 -1
  117. package/lib/src/contracts/embed-event-payloads.d.ts +212 -14
  118. package/lib/src/contracts/embed-event-payloads.d.ts.map +1 -1
  119. package/lib/src/contracts/host-event-contracts.d.ts +11 -0
  120. package/lib/src/contracts/host-event-contracts.d.ts.map +1 -1
  121. package/lib/src/css-variables.d.ts +140 -0
  122. package/lib/src/css-variables.d.ts.map +1 -1
  123. package/lib/src/embed/app.d.ts +1 -0
  124. package/lib/src/embed/app.d.ts.map +1 -1
  125. package/lib/src/embed/app.js.map +1 -1
  126. package/lib/src/embed/auto-frame-renderer.d.ts +14 -1
  127. package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -1
  128. package/lib/src/embed/auto-frame-renderer.js +91 -2
  129. package/lib/src/embed/auto-frame-renderer.js.map +1 -1
  130. package/lib/src/embed/auto-frame-renderer.spec.js +113 -8
  131. package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -1
  132. package/lib/src/embed/conversation.d.ts +14 -0
  133. package/lib/src/embed/conversation.d.ts.map +1 -1
  134. package/lib/src/embed/conversation.js.map +1 -1
  135. package/lib/src/embed/conversation.spec.js +22 -0
  136. package/lib/src/embed/conversation.spec.js.map +1 -1
  137. package/lib/src/embed/host-events.spec.js +50 -0
  138. package/lib/src/embed/host-events.spec.js.map +1 -1
  139. package/lib/src/embed/liveboard.d.ts +2 -16
  140. package/lib/src/embed/liveboard.d.ts.map +1 -1
  141. package/lib/src/embed/liveboard.js +28 -10
  142. package/lib/src/embed/liveboard.js.map +1 -1
  143. package/lib/src/embed/liveboard.spec.js +139 -0
  144. package/lib/src/embed/liveboard.spec.js.map +1 -1
  145. package/lib/src/embed/spotter-utils.d.ts +1 -0
  146. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  147. package/lib/src/embed/spotter-utils.js +7 -1
  148. package/lib/src/embed/spotter-utils.js.map +1 -1
  149. package/lib/src/embed/spotter-utils.spec.js +19 -0
  150. package/lib/src/embed/spotter-utils.spec.js.map +1 -1
  151. package/lib/src/embed/ts-embed.d.ts +21 -16
  152. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  153. package/lib/src/embed/ts-embed.js +78 -64
  154. package/lib/src/embed/ts-embed.js.map +1 -1
  155. package/lib/src/embed/ts-embed.spec.js +240 -7
  156. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  157. package/lib/src/index.d.ts +2 -2
  158. package/lib/src/index.d.ts.map +1 -1
  159. package/lib/src/index.js.map +1 -1
  160. package/lib/src/react/all-types-export.d.ts +1 -1
  161. package/lib/src/react/all-types-export.d.ts.map +1 -1
  162. package/lib/src/react/all-types-export.js.map +1 -1
  163. package/lib/src/react/util.d.ts +8 -1
  164. package/lib/src/react/util.d.ts.map +1 -1
  165. package/lib/src/react/util.js.map +1 -1
  166. package/lib/src/types.d.ts +249 -2
  167. package/lib/src/types.d.ts.map +1 -1
  168. package/lib/src/types.js +247 -0
  169. package/lib/src/types.js.map +1 -1
  170. package/lib/src/utils/runtimeTelemetry.d.ts +11 -0
  171. package/lib/src/utils/runtimeTelemetry.d.ts.map +1 -0
  172. package/lib/src/utils/runtimeTelemetry.js +28 -0
  173. package/lib/src/utils/runtimeTelemetry.js.map +1 -0
  174. package/lib/src/utils/runtimeTelemetry.spec.d.ts +2 -0
  175. package/lib/src/utils/runtimeTelemetry.spec.d.ts.map +1 -0
  176. package/lib/src/utils/runtimeTelemetry.spec.js +122 -0
  177. package/lib/src/utils/runtimeTelemetry.spec.js.map +1 -0
  178. package/lib/src/visual-embed-sdk.d.ts +642 -44
  179. package/package.json +1 -1
  180. package/src/auth.spec.ts +47 -11
  181. package/src/auth.ts +35 -6
  182. package/src/contracts/contracts.spec.ts +186 -3
  183. package/src/contracts/embed-event-payloads.ts +281 -14
  184. package/src/contracts/host-event-contracts.ts +14 -0
  185. package/src/css-variables.ts +168 -0
  186. package/src/embed/app.ts +1 -0
  187. package/src/embed/auto-frame-renderer.spec.ts +134 -8
  188. package/src/embed/auto-frame-renderer.ts +103 -2
  189. package/src/embed/conversation.spec.ts +24 -0
  190. package/src/embed/conversation.ts +14 -0
  191. package/src/embed/host-events.spec.ts +68 -0
  192. package/src/embed/liveboard.spec.ts +156 -0
  193. package/src/embed/liveboard.ts +34 -10
  194. package/src/embed/spotter-utils.spec.ts +20 -0
  195. package/src/embed/spotter-utils.ts +12 -1
  196. package/src/embed/ts-embed.spec.ts +297 -8
  197. package/src/embed/ts-embed.ts +79 -64
  198. package/src/index.ts +2 -0
  199. package/src/react/all-types-export.ts +1 -0
  200. package/src/react/util.ts +13 -1
  201. package/src/types.ts +249 -0
  202. package/src/utils/runtimeTelemetry.spec.ts +148 -0
  203. package/src/utils/runtimeTelemetry.ts +50 -0
package/lib/src/types.js CHANGED
@@ -454,6 +454,7 @@ export var EmbedEvent;
454
454
  * })
455
455
  * ```
456
456
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
457
+ * Payload: {@link AuthInitPayload}.
457
458
  */
458
459
  EmbedEvent["AuthInit"] = "authInit";
459
460
  /**
@@ -473,6 +474,7 @@ export var EmbedEvent;
473
474
  /**
474
475
  * Data pertaining to an Answer, Liveboard or Spotter visualization is received.
475
476
  * The event payload includes the raw data of the object.
477
+ * Payload: {@link DataEventPayload}.
476
478
  * @return data - Answer of Liveboard data
477
479
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
478
480
  * @example
@@ -486,6 +488,7 @@ export var EmbedEvent;
486
488
  EmbedEvent["Data"] = "data";
487
489
  /**
488
490
  * Search query has been updated by the user.
491
+ * Payload: {@link QueryChangedPayload} or a string.
489
492
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
490
493
  * @example
491
494
  * ```js
@@ -528,6 +531,7 @@ export var EmbedEvent;
528
531
  * })
529
532
  * })
530
533
  * ```
534
+ * Payload: {@link DrilldownPayload}.
531
535
  */
532
536
  EmbedEvent["Drilldown"] = "drillDown";
533
537
  /**
@@ -540,6 +544,7 @@ export var EmbedEvent;
540
544
  * console.log('DataSourceSelected', payload);
541
545
  * })
542
546
  * ```
547
+ * Payload: {@link DataSourceSelectedPayload} or string[].
543
548
  */
544
549
  EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
545
550
  /**
@@ -552,6 +557,7 @@ export var EmbedEvent;
552
557
  * console.log('AddRemoveColumns', payload);
553
558
  * })
554
559
  * ```
560
+ * Payload: string[].
555
561
  */
556
562
  EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
557
563
  /**
@@ -569,6 +575,7 @@ export var EmbedEvent;
569
575
  * }
570
576
  * })
571
577
  * ```
578
+ * Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
572
579
  */
573
580
  EmbedEvent["CustomAction"] = "customAction";
574
581
  /**
@@ -581,6 +588,7 @@ export var EmbedEvent;
581
588
  * console.log('VizPointDoubleClick', payload);
582
589
  * })
583
590
  * ```
591
+ * Payload: {@link VizInteractionPayload}.
584
592
  */
585
593
  EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
586
594
  /**
@@ -600,6 +608,7 @@ export var EmbedEvent;
600
608
  * )
601
609
  * });
602
610
  * ```
611
+ * Payload: {@link VizInteractionPayload}.
603
612
  */
604
613
  EmbedEvent["VizPointClick"] = "vizPointClick";
605
614
  /**
@@ -652,6 +661,7 @@ export var EmbedEvent;
652
661
  * // { errorType: "API", message: '...', code: '...' }
653
662
  * });
654
663
  * ```
664
+ * Payload: {@link EmbedErrorPayload} or a string.
655
665
  */
656
666
  EmbedEvent["Error"] = "Error";
657
667
  /**
@@ -702,6 +712,7 @@ export var EmbedEvent;
702
712
  * The center of visible iframe viewport is calculated.
703
713
  * @returns data - The center of the visible Iframe viewport.
704
714
  * @hidden
715
+ * Payload: none.
705
716
  */
706
717
  EmbedEvent["EmbedIframeCenter"] = "EmbedIframeCenter";
707
718
  /**
@@ -758,6 +769,7 @@ export var EmbedEvent;
758
769
  * console.log('dialog open', payload);
759
770
  * })
760
771
  * ```
772
+ * Payload: none.
761
773
  */
762
774
  EmbedEvent["DialogOpen"] = "dialog-open";
763
775
  /**
@@ -769,6 +781,7 @@ export var EmbedEvent;
769
781
  * console.log('dialog close', payload);
770
782
  * })
771
783
  * ```
784
+ * Payload: none.
772
785
  */
773
786
  EmbedEvent["DialogClose"] = "dialog-close";
774
787
  /**
@@ -791,6 +804,7 @@ export var EmbedEvent;
791
804
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
792
805
  * };
793
806
  * ```
807
+ * Payload: none.
794
808
  */
795
809
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
796
810
  /**
@@ -821,6 +835,7 @@ export var EmbedEvent;
821
835
  * console.log('Save', payload)
822
836
  * })
823
837
  * ```
838
+ * Payload: {@link SaveEventPayload}.
824
839
  */
825
840
  EmbedEvent["Save"] = "save";
826
841
  /**
@@ -837,6 +852,7 @@ export var EmbedEvent;
837
852
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
838
853
  * })
839
854
  * ```
855
+ * Payload: {@link VizScope}.
840
856
  */
841
857
  EmbedEvent["Download"] = "download";
842
858
  /**
@@ -856,6 +872,7 @@ export var EmbedEvent;
856
872
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
857
873
  * console.log('download PNG', payload)})
858
874
  * ```
875
+ * Payload: {@link DownloadEventPayload}.
859
876
  */
860
877
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
861
878
  /**
@@ -875,6 +892,7 @@ export var EmbedEvent;
875
892
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
876
893
  * console.log('download PDF', payload)})
877
894
  * ```
895
+ * Payload: {@link DownloadEventPayload}.
878
896
  */
879
897
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
880
898
  /**
@@ -894,6 +912,7 @@ export var EmbedEvent;
894
912
  * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
895
913
  * console.log('download CSV', payload)})
896
914
  * ```
915
+ * Payload: {@link DownloadEventPayload}.
897
916
  */
898
917
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
899
918
  /**
@@ -913,6 +932,7 @@ export var EmbedEvent;
913
932
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
914
933
  * console.log('download Xlsx', payload)})
915
934
  * ```
935
+ * Payload: {@link DownloadEventPayload}.
916
936
  */
917
937
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
918
938
  /**
@@ -924,6 +944,7 @@ export var EmbedEvent;
924
944
  * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
925
945
  * console.log('download liveboard as continuous PDF', payload)})
926
946
  * ```
947
+ * Payload: {@link LiveboardScope}.
927
948
  */
928
949
  EmbedEvent["DownloadLiveboardAsContinuousPDF"] = "downloadLiveboardAsContinuousPDF";
929
950
  /**
@@ -940,6 +961,7 @@ export var EmbedEvent;
940
961
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
941
962
  * console.log('delete answer', payload)})
942
963
  * ```
964
+ * Payload: {@link AnswerScope}.
943
965
  */
944
966
  EmbedEvent["AnswerDelete"] = "answerDelete";
945
967
  /**
@@ -951,6 +973,7 @@ export var EmbedEvent;
951
973
  * console.log('AI Highlights', payload);
952
974
  * })
953
975
  * ```
976
+ * Payload: {@link LiveboardScope}.
954
977
  */
955
978
  EmbedEvent["AIHighlights"] = "AIHighlights";
956
979
  /**
@@ -972,6 +995,7 @@ export var EmbedEvent;
972
995
  * console.log('pin', payload)
973
996
  * })
974
997
  * ```
998
+ * Payload: {@link PinEventPayload}.
975
999
  */
976
1000
  EmbedEvent["Pin"] = "pin";
977
1001
  /**
@@ -990,6 +1014,7 @@ export var EmbedEvent;
990
1014
  * console.log('SpotIQ analyze', payload)
991
1015
  * })
992
1016
  * ```
1017
+ * Payload: {@link AnswerScope}.
993
1018
  */
994
1019
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
995
1020
  /**
@@ -1043,6 +1068,7 @@ export var EmbedEvent;
1043
1068
  * console.log('copy to clipboard', payload);
1044
1069
  * })
1045
1070
  * ```
1071
+ * Payload: {@link CopyToClipboardPayload}.
1046
1072
  */
1047
1073
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
1048
1074
  /**
@@ -1054,6 +1080,7 @@ export var EmbedEvent;
1054
1080
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
1055
1081
  * })
1056
1082
  * ```
1083
+ * Payload: {@link TmlEventPayload}.
1057
1084
  */
1058
1085
  EmbedEvent["UpdateTML"] = "updateTSL";
1059
1086
  /**
@@ -1066,6 +1093,7 @@ export var EmbedEvent;
1066
1093
  * console.log('Edit TML', payload);
1067
1094
  * })
1068
1095
  * ```
1096
+ * Payload: {@link TmlEventPayload}.
1069
1097
  */
1070
1098
  EmbedEvent["EditTML"] = "editTSL";
1071
1099
  /**
@@ -1083,6 +1111,7 @@ export var EmbedEvent;
1083
1111
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
1084
1112
  * console.log('Export TML', payload)})
1085
1113
  * ```
1114
+ * Payload: {@link TmlEventPayload}.
1086
1115
  */
1087
1116
  EmbedEvent["ExportTML"] = "exportTSL";
1088
1117
  /**
@@ -1121,6 +1150,7 @@ export var EmbedEvent;
1121
1150
  * console.log('show data', payload);
1122
1151
  * })
1123
1152
  * ```
1153
+ * Payload: {@link AnswerScope}.
1124
1154
  */
1125
1155
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
1126
1156
  /**
@@ -1132,6 +1162,7 @@ export var EmbedEvent;
1132
1162
  * console.log('switch view', payload);
1133
1163
  * })
1134
1164
  * ```
1165
+ * Payload: {@link AnswerChartSwitcherPayload}.
1135
1166
  */
1136
1167
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
1137
1168
  /**
@@ -1153,6 +1184,7 @@ export var EmbedEvent;
1153
1184
  * console.log('Liveboard details', payload);
1154
1185
  * })
1155
1186
  * ```
1187
+ * Payload: {@link LiveboardScope}.
1156
1188
  */
1157
1189
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
1158
1190
  /**
@@ -1164,6 +1196,7 @@ export var EmbedEvent;
1164
1196
  * console.log('favorites', payload);
1165
1197
  * })
1166
1198
  * ```
1199
+ * Payload: {@link FavoritePayload}.
1167
1200
  */
1168
1201
  EmbedEvent["AddToFavorites"] = "addToFavorites";
1169
1202
  /**
@@ -1175,6 +1208,7 @@ export var EmbedEvent;
1175
1208
  * console.log('Liveboard schedule', payload);
1176
1209
  * })
1177
1210
  * ```
1211
+ * Payload: {@link LiveboardScope}.
1178
1212
  */
1179
1213
  EmbedEvent["Schedule"] = "subscription";
1180
1214
  /**
@@ -1189,6 +1223,7 @@ export var EmbedEvent;
1189
1223
  * console.log('Liveboard edit', payload);
1190
1224
  * })
1191
1225
  * ```
1226
+ * Payload: {@link LiveboardVizScope}.
1192
1227
  */
1193
1228
  EmbedEvent["Edit"] = "edit";
1194
1229
  /**
@@ -1230,6 +1265,7 @@ export var EmbedEvent;
1230
1265
  * console.log('Copy', payload);
1231
1266
  * })
1232
1267
  * ```
1268
+ * Payload: {@link MakeACopyPayload}.
1233
1269
  */
1234
1270
  EmbedEvent["MakeACopy"] = "makeACopy";
1235
1271
  /**
@@ -1245,6 +1281,7 @@ export var EmbedEvent;
1245
1281
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1246
1282
  * })
1247
1283
  * ```
1284
+ * Payload: {@link LiveboardVizScope}.
1248
1285
  */
1249
1286
  EmbedEvent["Present"] = "present";
1250
1287
  /**
@@ -1255,6 +1292,7 @@ export var EmbedEvent;
1255
1292
  * liveboardEmbed.on(EmbedEvent.Delete,
1256
1293
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1257
1294
  * ```
1295
+ * Payload: {@link LiveboardScope}.
1258
1296
  */
1259
1297
  EmbedEvent["Delete"] = "delete";
1260
1298
  /**
@@ -1264,6 +1302,7 @@ export var EmbedEvent;
1264
1302
  * ```js
1265
1303
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
1266
1304
  * ```
1305
+ * Payload: {@link LiveboardScope}.
1267
1306
  */
1268
1307
  EmbedEvent["SchedulesList"] = "schedule-list";
1269
1308
  /**
@@ -1273,6 +1312,7 @@ export var EmbedEvent;
1273
1312
  * ```js
1274
1313
  * liveboardEmbed.on(EmbedEvent.Cancel)
1275
1314
  * ```
1315
+ * Payload: {@link LiveboardScope}.
1276
1316
  */
1277
1317
  EmbedEvent["Cancel"] = "cancel";
1278
1318
  /**
@@ -1283,6 +1323,7 @@ export var EmbedEvent;
1283
1323
  * liveboardEmbed.on(EmbedEvent.Explore, {
1284
1324
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1285
1325
  * ```
1326
+ * Payload: {@link LiveboardVizScope}.
1286
1327
  */
1287
1328
  EmbedEvent["Explore"] = "explore";
1288
1329
  /**
@@ -1293,6 +1334,7 @@ export var EmbedEvent;
1293
1334
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
1294
1335
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1295
1336
  * ```
1337
+ * Payload: {@link CopyLinkPayload}.
1296
1338
  */
1297
1339
  EmbedEvent["CopyLink"] = "embedDocument";
1298
1340
  /**
@@ -1304,6 +1346,7 @@ export var EmbedEvent;
1304
1346
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
1305
1347
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1306
1348
  * ```
1349
+ * Payload: {@link CrossFilterChangedPayload}.
1307
1350
  */
1308
1351
  EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
1309
1352
  /**
@@ -1315,6 +1358,7 @@ export var EmbedEvent;
1315
1358
  * console.log('VizPointClick', payload)
1316
1359
  * })
1317
1360
  * ```
1361
+ * Payload: {@link VizInteractionPayload}.
1318
1362
  */
1319
1363
  EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
1320
1364
  /**
@@ -1342,6 +1386,7 @@ export var EmbedEvent;
1342
1386
  * })
1343
1387
  * ```
1344
1388
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
1389
+ * Payload: {@link FilterChangedPayload}.
1345
1390
  */
1346
1391
  EmbedEvent["FilterChanged"] = "filterChanged";
1347
1392
  /**
@@ -1364,6 +1409,7 @@ export var EmbedEvent;
1364
1409
  * @returns isPublic: boolean
1365
1410
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1366
1411
  * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
1412
+ * Payload: {@link PersonalisedViewPayload}.
1367
1413
  */
1368
1414
  EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
1369
1415
  /**
@@ -1385,6 +1431,7 @@ export var EmbedEvent;
1385
1431
  * @returns isPublic: boolean
1386
1432
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1387
1433
  * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
1434
+ * Payload: {@link PersonalisedViewPayload}.
1388
1435
  */
1389
1436
  EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
1390
1437
  /**
@@ -1459,6 +1506,7 @@ export var EmbedEvent;
1459
1506
  /**
1460
1507
  * Emitted when a Liveboard or visualization is renamed.
1461
1508
  * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
1509
+ * Payload: {@link RenamePayload}.
1462
1510
  */
1463
1511
  EmbedEvent["Rename"] = "rename";
1464
1512
  /**
@@ -1544,6 +1592,7 @@ export var EmbedEvent;
1544
1592
  * })
1545
1593
  * ```
1546
1594
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
1595
+ * Payload: {@link ParameterChangedPayload}.
1547
1596
  */
1548
1597
  EmbedEvent["ParameterChanged"] = "parameterChanged";
1549
1598
  /**
@@ -1587,6 +1636,7 @@ export var EmbedEvent;
1587
1636
  * })
1588
1637
  * ```
1589
1638
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
1639
+ * Payload: {@link TableVizRenderedPayload}.
1590
1640
  */
1591
1641
  EmbedEvent["TableVizRendered"] = "TableVizRendered";
1592
1642
  /**
@@ -1611,12 +1661,14 @@ export var EmbedEvent;
1611
1661
  * @hidden
1612
1662
  * Emitted when a user exits present mode.
1613
1663
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1664
+ * Payload: {@link ExitPresentModePayload}.
1614
1665
  */
1615
1666
  EmbedEvent["ExitPresentMode"] = "exitPresentMode";
1616
1667
  /**
1617
1668
  * Emitted when a user requests the full height lazy load data.
1618
1669
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1619
1670
  * @hidden
1671
+ * Payload: none.
1620
1672
  */
1621
1673
  EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
1622
1674
  /**
@@ -1650,6 +1702,7 @@ export var EmbedEvent;
1650
1702
  * })
1651
1703
  * ```
1652
1704
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
1705
+ * Payload: {@link VizScope}.
1653
1706
  */
1654
1707
  EmbedEvent["AddToCoaching"] = "addToCoaching";
1655
1708
  /**
@@ -1739,6 +1792,7 @@ export var EmbedEvent;
1739
1792
  * console.log('EmbedListenerReady');
1740
1793
  * })
1741
1794
  * ```
1795
+ * Payload: none.
1742
1796
  */
1743
1797
  EmbedEvent["EmbedListenerReady"] = "EmbedListenerReady";
1744
1798
  /**
@@ -2113,6 +2167,7 @@ export var EmbedEvent;
2113
2167
  * })
2114
2168
  * ```
2115
2169
  * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
2170
+ * Payload: {@link TestScheduleEmailPayload}.
2116
2171
  */
2117
2172
  EmbedEvent["SendTestScheduleEmail"] = "sendTestScheduleEmail";
2118
2173
  /**
@@ -2624,6 +2679,19 @@ export var HostEvent;
2624
2679
  * ```
2625
2680
  */
2626
2681
  HostEvent["OpenAddParameterModal"] = "openAddParameterModal";
2682
+ /**
2683
+ * Add a tab to the Liveboard, the same action as the *Tab* option in the
2684
+ * *Add* dropdown in the Liveboard edit header.
2685
+ *
2686
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
2687
+ *
2688
+ * @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
2689
+ * @example
2690
+ * ```js
2691
+ * liveboardEmbed.trigger(HostEvent.OpenAddTabModal);
2692
+ * ```
2693
+ */
2694
+ HostEvent["OpenAddTabModal"] = "openAddTabModal";
2627
2695
  /**
2628
2696
  * Open the parameter panel for a particular parameter on a Liveboard.
2629
2697
  * Mirrors {@link HostEvent.OpenFilter} for parameters.
@@ -3221,6 +3289,17 @@ export var HostEvent;
3221
3289
  * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
3222
3290
  */
3223
3291
  HostEvent["EditVisualization"] = "editVisualization";
3292
+ /**
3293
+ * Exits Liveboard edit mode , equivalent to clicking the
3294
+ * *Cancel* button in the Liveboard edit header. The Liveboard returns to
3295
+ * view mode and the embedded app emits the {@link EmbedEvent.Cancel} event.
3296
+ * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
3297
+ * @example
3298
+ * ```js
3299
+ * liveboardEmbed.trigger(HostEvent.ExitEditMode);
3300
+ * ```
3301
+ */
3302
+ HostEvent["ExitEditMode"] = "exitEditMode";
3224
3303
  /**
3225
3304
  * Trigger the **Copy link** action on a Liveboard or visualization
3226
3305
  * Payload: {@link VizScopedRequest}.
@@ -4756,6 +4835,39 @@ export var HostEvent;
4756
4835
  * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
4757
4836
  */
4758
4837
  HostEvent["RefreshLiveboardBrowserCache"] = "refreshLiveboardBrowserCache";
4838
+ /**
4839
+ * Switch the embed between dark appearance and its default appearance
4840
+ * while it is open, without reloading it.
4841
+ * Payload: {@link UpdateThemeRequest}.
4842
+ *
4843
+ * Use it to keep the embed in step with a theme switch in your
4844
+ * application; the appearance the embed loads with is set by `isDarkMode`.
4845
+ * The event resolves with the applied value, such as `{ isDarkMode: true }`.
4846
+ * When dark appearance is not available in the embed, the embed does not
4847
+ * change and the event rejects with an error message instead.
4848
+ * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
4849
+ * @param - `isDarkMode` - `true` for dark appearance, `false` for the
4850
+ * default appearance.
4851
+ * @example
4852
+ * ```js
4853
+ * appEmbed.trigger(HostEvent.UpdateTheme, { isDarkMode: true });
4854
+ * ```
4855
+ * @example
4856
+ * ```js
4857
+ * // Follow a theme switch in your application
4858
+ * const themeSwitch = document.querySelector('#theme-switch');
4859
+ * themeSwitch.addEventListener('change', async (event) => {
4860
+ * try {
4861
+ * await appEmbed.trigger(HostEvent.UpdateTheme, {
4862
+ * isDarkMode: event.target.checked,
4863
+ * });
4864
+ * } catch (error) {
4865
+ * console.warn(error);
4866
+ * }
4867
+ * });
4868
+ * ```
4869
+ */
4870
+ HostEvent["UpdateTheme"] = "UpdateTheme";
4759
4871
  })(HostEvent || (HostEvent = {}));
4760
4872
  /**
4761
4873
  * The different visual modes that the data sources panel within
@@ -4799,6 +4911,7 @@ export var Param;
4799
4911
  * @version SDK: 1.52.2 | ThoughtSpot Cloud: 26.9.0.cl
4800
4912
  */
4801
4913
  Param["TsmcpAnswerIndex"] = "tsmcpAnswerIndex";
4914
+ Param["IsMcpAnswerEmbed"] = "isMcpAnswerEmbed";
4802
4915
  Param["EmbedApp"] = "embedApp";
4803
4916
  Param["DataSources"] = "dataSources";
4804
4917
  Param["DataSourceMode"] = "dataSourceMode";
@@ -5001,6 +5114,21 @@ export var Param;
5001
5114
  export var Action;
5002
5115
  (function (Action) {
5003
5116
  /**
5117
+ * The **Add** button on a Liveboard in edit mode.
5118
+ * Controls the visibility and disabled state of the Add panel button
5119
+ * in the Liveboard edit toolbar, which allows users to add
5120
+ * visualizations, filters, parameters, and tabs.
5121
+ * @example
5122
+ * ```js
5123
+ * hiddenActions: [Action.LiveboardAddPanel]
5124
+ * // or
5125
+ * disabledActions: [Action.LiveboardAddPanel]
5126
+ * ```
5127
+ * @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
5128
+ */
5129
+ Action["LiveboardAddPanel"] = "liveboardAddPanel";
5130
+ /**
5131
+ *
5004
5132
  * The **Save** action on an Answer or Liveboard.
5005
5133
  * Allows users to save the changes.
5006
5134
  * @example
@@ -7231,6 +7359,125 @@ export var Action;
7231
7359
  * ```
7232
7360
  */
7233
7361
  Action["CustomizeHomepage"] = "customizeHomepage";
7362
+ /**
7363
+ * Controls the visibility and disabled state of the *Cancel* button in the
7364
+ * Liveboard edit header, the button that discards the changes made in edit
7365
+ * mode and returns the Liveboard to view mode. The button is shown only
7366
+ * while the Liveboard is in edit mode.
7367
+ * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
7368
+ * @example
7369
+ * ```js
7370
+ * const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
7371
+ * ... // other embed view config
7372
+ * hiddenActions: [Action.Cancel],
7373
+ * });
7374
+ * ```
7375
+ * @example
7376
+ * ```js
7377
+ * const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
7378
+ * ... // other embed view config
7379
+ * disabledActions: [Action.Cancel],
7380
+ * disabledActionReason: 'Save your changes to leave edit mode',
7381
+ * });
7382
+ * ```
7383
+ */
7384
+ Action["Cancel"] = "cancel";
7385
+ /**
7386
+ * Controls the visibility and disabled state of the "Version history" menu item for a Liveboard or Answer.
7387
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
7388
+ * @example
7389
+ * ```js
7390
+ * {
7391
+ * hiddenActions: [Action.ShowVersionHistory],
7392
+ * disabledActions: [Action.ShowVersionHistory],
7393
+ * }
7394
+ * ```
7395
+ */
7396
+ Action["ShowVersionHistory"] = "showVersionHistory";
7397
+ /**
7398
+ * Controls the visibility and disabled state of the "Enable version control" menu item for a Liveboard or Answer.
7399
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
7400
+ * @example
7401
+ * ```js
7402
+ * {
7403
+ * hiddenActions: [Action.EnableVersionControl],
7404
+ * disabledActions: [Action.EnableVersionControl],
7405
+ * }
7406
+ * ```
7407
+ */
7408
+ Action["EnableVersionControl"] = "enableVersionControl";
7409
+ /**
7410
+ * Controls the visibility and disabled state of the "Disable version control" menu item for a Liveboard or Answer.
7411
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
7412
+ * @example
7413
+ * ```js
7414
+ * {
7415
+ * hiddenActions: [Action.DisableVersionControl],
7416
+ * disabledActions: [Action.DisableVersionControl],
7417
+ * }
7418
+ * ```
7419
+ */
7420
+ Action["DisableVersionControl"] = "disableVersionControl";
7421
+ /**
7422
+ * Controls the visibility and disabled state of the "Withdraw verification" menu item for a verified Liveboard.
7423
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
7424
+ * @example
7425
+ * ```js
7426
+ * {
7427
+ * hiddenActions: [Action.WithdrawVerification],
7428
+ * disabledActions: [Action.WithdrawVerification],
7429
+ * }
7430
+ * ```
7431
+ */
7432
+ Action["WithdrawVerification"] = "withdrawVerification";
7433
+ /**
7434
+ * Controls the visibility and disabled state of the "Switch to new chart experience" menu item on an Answer.
7435
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
7436
+ * @example
7437
+ * ```js
7438
+ * {
7439
+ * hiddenActions: [Action.SwitchToNewChartExperience],
7440
+ * disabledActions: [Action.SwitchToNewChartExperience],
7441
+ * }
7442
+ * ```
7443
+ */
7444
+ Action["SwitchToNewChartExperience"] = "switchToNewChartExperience";
7445
+ /**
7446
+ * Controls the visibility and disabled state of the "Switch to classic chart experience" menu item on an Answer.
7447
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
7448
+ * @example
7449
+ * ```js
7450
+ * {
7451
+ * hiddenActions: [Action.SwitchToClassicChartExperience],
7452
+ * disabledActions: [Action.SwitchToClassicChartExperience],
7453
+ * }
7454
+ * ```
7455
+ */
7456
+ Action["SwitchToClassicChartExperience"] = "switchToClassicChartExperience";
7457
+ /**
7458
+ * Controls the visibility and disabled state of the "Monitor" menu item on an Answer, which includes the alert options.
7459
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.5.0.cl
7460
+ * @example
7461
+ * ```js
7462
+ * {
7463
+ * hiddenActions: [Action.Monitor],
7464
+ * disabledActions: [Action.Monitor],
7465
+ * }
7466
+ * ```
7467
+ */
7468
+ Action["Monitor"] = "monitor";
7469
+ /**
7470
+ * Controls the visibility and disabled state of the "View explanation" button in the footer of a Spotter answer, which opens the explanation and verification details.
7471
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
7472
+ * @example
7473
+ * ```js
7474
+ * {
7475
+ * hiddenActions: [Action.SpotterViewExplanation],
7476
+ * disabledActions: [Action.SpotterViewExplanation],
7477
+ * }
7478
+ * ```
7479
+ */
7480
+ Action["SpotterViewExplanation"] = "spotterViewExplanation";
7234
7481
  })(Action || (Action = {}));
7235
7482
  export var PrefetchFeatures;
7236
7483
  (function (PrefetchFeatures) {