@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/src/types.ts CHANGED
@@ -2680,6 +2680,7 @@ export enum EmbedEvent {
2680
2680
  * })
2681
2681
  * ```
2682
2682
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
2683
+ * Payload: {@link AuthInitPayload}.
2683
2684
  */
2684
2685
  AuthInit = 'authInit',
2685
2686
  /**
@@ -2699,6 +2700,7 @@ export enum EmbedEvent {
2699
2700
  /**
2700
2701
  * Data pertaining to an Answer, Liveboard or Spotter visualization is received.
2701
2702
  * The event payload includes the raw data of the object.
2703
+ * Payload: {@link DataEventPayload}.
2702
2704
  * @return data - Answer of Liveboard data
2703
2705
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2704
2706
  * @example
@@ -2712,6 +2714,7 @@ export enum EmbedEvent {
2712
2714
  Data = 'data',
2713
2715
  /**
2714
2716
  * Search query has been updated by the user.
2717
+ * Payload: {@link QueryChangedPayload} or a string.
2715
2718
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2716
2719
  * @example
2717
2720
  * ```js
@@ -2754,6 +2757,7 @@ export enum EmbedEvent {
2754
2757
  * })
2755
2758
  * })
2756
2759
  * ```
2760
+ * Payload: {@link DrilldownPayload}.
2757
2761
  */
2758
2762
  Drilldown = 'drillDown',
2759
2763
  /**
@@ -2766,6 +2770,7 @@ export enum EmbedEvent {
2766
2770
  * console.log('DataSourceSelected', payload);
2767
2771
  * })
2768
2772
  * ```
2773
+ * Payload: {@link DataSourceSelectedPayload} or string[].
2769
2774
  */
2770
2775
  DataSourceSelected = 'dataSourceSelected',
2771
2776
  /**
@@ -2778,6 +2783,7 @@ export enum EmbedEvent {
2778
2783
  * console.log('AddRemoveColumns', payload);
2779
2784
  * })
2780
2785
  * ```
2786
+ * Payload: string[].
2781
2787
  */
2782
2788
  AddRemoveColumns = 'addRemoveColumns',
2783
2789
  /**
@@ -2795,6 +2801,7 @@ export enum EmbedEvent {
2795
2801
  * }
2796
2802
  * })
2797
2803
  * ```
2804
+ * Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
2798
2805
  */
2799
2806
  CustomAction = 'customAction',
2800
2807
  /**
@@ -2807,6 +2814,7 @@ export enum EmbedEvent {
2807
2814
  * console.log('VizPointDoubleClick', payload);
2808
2815
  * })
2809
2816
  * ```
2817
+ * Payload: {@link VizInteractionPayload}.
2810
2818
  */
2811
2819
  VizPointDoubleClick = 'vizPointDoubleClick',
2812
2820
  /**
@@ -2826,6 +2834,7 @@ export enum EmbedEvent {
2826
2834
  * )
2827
2835
  * });
2828
2836
  * ```
2837
+ * Payload: {@link VizInteractionPayload}.
2829
2838
  */
2830
2839
  VizPointClick = 'vizPointClick',
2831
2840
  /**
@@ -2878,6 +2887,7 @@ export enum EmbedEvent {
2878
2887
  * // { errorType: "API", message: '...', code: '...' }
2879
2888
  * });
2880
2889
  * ```
2890
+ * Payload: {@link EmbedErrorPayload} or a string.
2881
2891
  */
2882
2892
  Error = 'Error',
2883
2893
  /**
@@ -2930,6 +2940,7 @@ export enum EmbedEvent {
2930
2940
  * The center of visible iframe viewport is calculated.
2931
2941
  * @returns data - The center of the visible Iframe viewport.
2932
2942
  * @hidden
2943
+ * Payload: none.
2933
2944
  */
2934
2945
  EmbedIframeCenter = 'EmbedIframeCenter',
2935
2946
  /**
@@ -2986,6 +2997,7 @@ export enum EmbedEvent {
2986
2997
  * console.log('dialog open', payload);
2987
2998
  * })
2988
2999
  * ```
3000
+ * Payload: none.
2989
3001
  */
2990
3002
  DialogOpen = 'dialog-open',
2991
3003
  /**
@@ -2997,6 +3009,7 @@ export enum EmbedEvent {
2997
3009
  * console.log('dialog close', payload);
2998
3010
  * })
2999
3011
  * ```
3012
+ * Payload: none.
3000
3013
  */
3001
3014
  DialogClose = 'dialog-close',
3002
3015
  /**
@@ -3019,6 +3032,7 @@ export enum EmbedEvent {
3019
3032
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
3020
3033
  * };
3021
3034
  * ```
3035
+ * Payload: none.
3022
3036
  */
3023
3037
  LiveboardRendered = 'PinboardRendered',
3024
3038
  /**
@@ -3049,6 +3063,7 @@ export enum EmbedEvent {
3049
3063
  * console.log('Save', payload)
3050
3064
  * })
3051
3065
  * ```
3066
+ * Payload: {@link SaveEventPayload}.
3052
3067
  */
3053
3068
  Save = 'save',
3054
3069
  /**
@@ -3065,6 +3080,7 @@ export enum EmbedEvent {
3065
3080
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
3066
3081
  * })
3067
3082
  * ```
3083
+ * Payload: {@link VizScope}.
3068
3084
  */
3069
3085
  Download = 'download',
3070
3086
  /**
@@ -3084,6 +3100,7 @@ export enum EmbedEvent {
3084
3100
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
3085
3101
  * console.log('download PNG', payload)})
3086
3102
  * ```
3103
+ * Payload: {@link DownloadEventPayload}.
3087
3104
  */
3088
3105
  DownloadAsPng = 'downloadAsPng',
3089
3106
  /**
@@ -3103,6 +3120,7 @@ export enum EmbedEvent {
3103
3120
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
3104
3121
  * console.log('download PDF', payload)})
3105
3122
  * ```
3123
+ * Payload: {@link DownloadEventPayload}.
3106
3124
  */
3107
3125
  DownloadAsPdf = 'downloadAsPdf',
3108
3126
  /**
@@ -3122,6 +3140,7 @@ export enum EmbedEvent {
3122
3140
  * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
3123
3141
  * console.log('download CSV', payload)})
3124
3142
  * ```
3143
+ * Payload: {@link DownloadEventPayload}.
3125
3144
  */
3126
3145
  DownloadAsCsv = 'downloadAsCsv',
3127
3146
  /**
@@ -3141,6 +3160,7 @@ export enum EmbedEvent {
3141
3160
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
3142
3161
  * console.log('download Xlsx', payload)})
3143
3162
  * ```
3163
+ * Payload: {@link DownloadEventPayload}.
3144
3164
  */
3145
3165
  DownloadAsXlsx = 'downloadAsXlsx',
3146
3166
  /**
@@ -3152,6 +3172,7 @@ export enum EmbedEvent {
3152
3172
  * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
3153
3173
  * console.log('download liveboard as continuous PDF', payload)})
3154
3174
  * ```
3175
+ * Payload: {@link LiveboardScope}.
3155
3176
  */
3156
3177
  DownloadLiveboardAsContinuousPDF = 'downloadLiveboardAsContinuousPDF',
3157
3178
  /**
@@ -3168,6 +3189,7 @@ export enum EmbedEvent {
3168
3189
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3169
3190
  * console.log('delete answer', payload)})
3170
3191
  * ```
3192
+ * Payload: {@link AnswerScope}.
3171
3193
  */
3172
3194
  AnswerDelete = 'answerDelete',
3173
3195
  /**
@@ -3179,6 +3201,7 @@ export enum EmbedEvent {
3179
3201
  * console.log('AI Highlights', payload);
3180
3202
  * })
3181
3203
  * ```
3204
+ * Payload: {@link LiveboardScope}.
3182
3205
  */
3183
3206
  AIHighlights = 'AIHighlights',
3184
3207
  /**
@@ -3200,6 +3223,7 @@ export enum EmbedEvent {
3200
3223
  * console.log('pin', payload)
3201
3224
  * })
3202
3225
  * ```
3226
+ * Payload: {@link PinEventPayload}.
3203
3227
  */
3204
3228
  Pin = 'pin',
3205
3229
  /**
@@ -3218,6 +3242,7 @@ export enum EmbedEvent {
3218
3242
  * console.log('SpotIQ analyze', payload)
3219
3243
  * })
3220
3244
  * ```
3245
+ * Payload: {@link AnswerScope}.
3221
3246
  */
3222
3247
  SpotIQAnalyze = 'spotIQAnalyze',
3223
3248
  /**
@@ -3271,6 +3296,7 @@ export enum EmbedEvent {
3271
3296
  * console.log('copy to clipboard', payload);
3272
3297
  * })
3273
3298
  * ```
3299
+ * Payload: {@link CopyToClipboardPayload}.
3274
3300
  */
3275
3301
  CopyToClipboard = 'context-menu-item-copy-to-clipboard',
3276
3302
  /**
@@ -3282,6 +3308,7 @@ export enum EmbedEvent {
3282
3308
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
3283
3309
  * })
3284
3310
  * ```
3311
+ * Payload: {@link TmlEventPayload}.
3285
3312
  */
3286
3313
  UpdateTML = 'updateTSL',
3287
3314
  /**
@@ -3294,6 +3321,7 @@ export enum EmbedEvent {
3294
3321
  * console.log('Edit TML', payload);
3295
3322
  * })
3296
3323
  * ```
3324
+ * Payload: {@link TmlEventPayload}.
3297
3325
  */
3298
3326
  EditTML = 'editTSL',
3299
3327
  /**
@@ -3311,6 +3339,7 @@ export enum EmbedEvent {
3311
3339
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
3312
3340
  * console.log('Export TML', payload)})
3313
3341
  * ```
3342
+ * Payload: {@link TmlEventPayload}.
3314
3343
  */
3315
3344
  ExportTML = 'exportTSL',
3316
3345
  /**
@@ -3349,6 +3378,7 @@ export enum EmbedEvent {
3349
3378
  * console.log('show data', payload);
3350
3379
  * })
3351
3380
  * ```
3381
+ * Payload: {@link AnswerScope}.
3352
3382
  */
3353
3383
  ShowUnderlyingData = 'showUnderlyingData',
3354
3384
  /**
@@ -3360,6 +3390,7 @@ export enum EmbedEvent {
3360
3390
  * console.log('switch view', payload);
3361
3391
  * })
3362
3392
  * ```
3393
+ * Payload: {@link AnswerChartSwitcherPayload}.
3363
3394
  */
3364
3395
  AnswerChartSwitcher = 'answerChartSwitcher',
3365
3396
  /**
@@ -3381,6 +3412,7 @@ export enum EmbedEvent {
3381
3412
  * console.log('Liveboard details', payload);
3382
3413
  * })
3383
3414
  * ```
3415
+ * Payload: {@link LiveboardScope}.
3384
3416
  */
3385
3417
  LiveboardInfo = 'pinboardInfo',
3386
3418
  /**
@@ -3392,6 +3424,7 @@ export enum EmbedEvent {
3392
3424
  * console.log('favorites', payload);
3393
3425
  * })
3394
3426
  * ```
3427
+ * Payload: {@link FavoritePayload}.
3395
3428
  */
3396
3429
  AddToFavorites = 'addToFavorites',
3397
3430
  /**
@@ -3403,6 +3436,7 @@ export enum EmbedEvent {
3403
3436
  * console.log('Liveboard schedule', payload);
3404
3437
  * })
3405
3438
  * ```
3439
+ * Payload: {@link LiveboardScope}.
3406
3440
  */
3407
3441
  Schedule = 'subscription',
3408
3442
  /**
@@ -3417,6 +3451,7 @@ export enum EmbedEvent {
3417
3451
  * console.log('Liveboard edit', payload);
3418
3452
  * })
3419
3453
  * ```
3454
+ * Payload: {@link LiveboardVizScope}.
3420
3455
  */
3421
3456
  Edit = 'edit',
3422
3457
  /**
@@ -3458,6 +3493,7 @@ export enum EmbedEvent {
3458
3493
  * console.log('Copy', payload);
3459
3494
  * })
3460
3495
  * ```
3496
+ * Payload: {@link MakeACopyPayload}.
3461
3497
  */
3462
3498
  MakeACopy = 'makeACopy',
3463
3499
  /**
@@ -3473,6 +3509,7 @@ export enum EmbedEvent {
3473
3509
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3474
3510
  * })
3475
3511
  * ```
3512
+ * Payload: {@link LiveboardVizScope}.
3476
3513
  */
3477
3514
  Present = 'present',
3478
3515
  /**
@@ -3483,6 +3520,7 @@ export enum EmbedEvent {
3483
3520
  * liveboardEmbed.on(EmbedEvent.Delete,
3484
3521
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3485
3522
  * ```
3523
+ * Payload: {@link LiveboardScope}.
3486
3524
  */
3487
3525
  Delete = 'delete',
3488
3526
  /**
@@ -3492,6 +3530,7 @@ export enum EmbedEvent {
3492
3530
  * ```js
3493
3531
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
3494
3532
  * ```
3533
+ * Payload: {@link LiveboardScope}.
3495
3534
  */
3496
3535
  SchedulesList = 'schedule-list',
3497
3536
  /**
@@ -3501,6 +3540,7 @@ export enum EmbedEvent {
3501
3540
  * ```js
3502
3541
  * liveboardEmbed.on(EmbedEvent.Cancel)
3503
3542
  * ```
3543
+ * Payload: {@link LiveboardScope}.
3504
3544
  */
3505
3545
  Cancel = 'cancel',
3506
3546
  /**
@@ -3511,6 +3551,7 @@ export enum EmbedEvent {
3511
3551
  * liveboardEmbed.on(EmbedEvent.Explore, {
3512
3552
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3513
3553
  * ```
3554
+ * Payload: {@link LiveboardVizScope}.
3514
3555
  */
3515
3556
  Explore = 'explore',
3516
3557
  /**
@@ -3521,6 +3562,7 @@ export enum EmbedEvent {
3521
3562
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
3522
3563
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3523
3564
  * ```
3565
+ * Payload: {@link CopyLinkPayload}.
3524
3566
  */
3525
3567
  CopyLink = 'embedDocument',
3526
3568
  /**
@@ -3532,6 +3574,7 @@ export enum EmbedEvent {
3532
3574
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
3533
3575
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3534
3576
  * ```
3577
+ * Payload: {@link CrossFilterChangedPayload}.
3535
3578
  */
3536
3579
  CrossFilterChanged = 'cross-filter-changed',
3537
3580
  /**
@@ -3543,6 +3586,7 @@ export enum EmbedEvent {
3543
3586
  * console.log('VizPointClick', payload)
3544
3587
  * })
3545
3588
  * ```
3589
+ * Payload: {@link VizInteractionPayload}.
3546
3590
  */
3547
3591
  VizPointRightClick = 'vizPointRightClick',
3548
3592
  /**
@@ -3570,6 +3614,7 @@ export enum EmbedEvent {
3570
3614
  * })
3571
3615
  * ```
3572
3616
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3617
+ * Payload: {@link FilterChangedPayload}.
3573
3618
  */
3574
3619
  FilterChanged = 'filterChanged',
3575
3620
  /**
@@ -3592,6 +3637,7 @@ export enum EmbedEvent {
3592
3637
  * @returns isPublic: boolean
3593
3638
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3594
3639
  * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3640
+ * Payload: {@link PersonalisedViewPayload}.
3595
3641
  */
3596
3642
  UpdatePersonalisedView = 'updatePersonalisedView',
3597
3643
  /**
@@ -3613,6 +3659,7 @@ export enum EmbedEvent {
3613
3659
  * @returns isPublic: boolean
3614
3660
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3615
3661
  * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3662
+ * Payload: {@link PersonalisedViewPayload}.
3616
3663
  */
3617
3664
  SavePersonalisedView = 'savePersonalisedView',
3618
3665
  /**
@@ -3687,6 +3734,7 @@ export enum EmbedEvent {
3687
3734
  /**
3688
3735
  * Emitted when a Liveboard or visualization is renamed.
3689
3736
  * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3737
+ * Payload: {@link RenamePayload}.
3690
3738
  */
3691
3739
  Rename = 'rename',
3692
3740
  /**
@@ -3772,6 +3820,7 @@ export enum EmbedEvent {
3772
3820
  * })
3773
3821
  * ```
3774
3822
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3823
+ * Payload: {@link ParameterChangedPayload}.
3775
3824
  */
3776
3825
  ParameterChanged = 'parameterChanged',
3777
3826
  /**
@@ -3815,6 +3864,7 @@ export enum EmbedEvent {
3815
3864
  * })
3816
3865
  * ```
3817
3866
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
3867
+ * Payload: {@link TableVizRenderedPayload}.
3818
3868
  */
3819
3869
  TableVizRendered = 'TableVizRendered',
3820
3870
  /**
@@ -3839,12 +3889,14 @@ export enum EmbedEvent {
3839
3889
  * @hidden
3840
3890
  * Emitted when a user exits present mode.
3841
3891
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3892
+ * Payload: {@link ExitPresentModePayload}.
3842
3893
  */
3843
3894
  ExitPresentMode = 'exitPresentMode',
3844
3895
  /**
3845
3896
  * Emitted when a user requests the full height lazy load data.
3846
3897
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3847
3898
  * @hidden
3899
+ * Payload: none.
3848
3900
  */
3849
3901
  RequestVisibleEmbedCoordinates = 'requestVisibleEmbedCoordinates',
3850
3902
  /**
@@ -3878,6 +3930,7 @@ export enum EmbedEvent {
3878
3930
  * })
3879
3931
  * ```
3880
3932
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3933
+ * Payload: {@link VizScope}.
3881
3934
  */
3882
3935
  AddToCoaching = 'addToCoaching',
3883
3936
  /**
@@ -3967,6 +4020,7 @@ export enum EmbedEvent {
3967
4020
  * console.log('EmbedListenerReady');
3968
4021
  * })
3969
4022
  * ```
4023
+ * Payload: none.
3970
4024
  */
3971
4025
  EmbedListenerReady = 'EmbedListenerReady',
3972
4026
  /**
@@ -4346,6 +4400,7 @@ export enum EmbedEvent {
4346
4400
  * })
4347
4401
  * ```
4348
4402
  * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
4403
+ * Payload: {@link TestScheduleEmailPayload}.
4349
4404
  */
4350
4405
  SendTestScheduleEmail = 'sendTestScheduleEmail',
4351
4406
 
@@ -4865,6 +4920,20 @@ export enum HostEvent {
4865
4920
  * ```
4866
4921
  */
4867
4922
  OpenAddParameterModal = 'openAddParameterModal',
4923
+
4924
+ /**
4925
+ * Add a tab to the Liveboard, the same action as the *Tab* option in the
4926
+ * *Add* dropdown in the Liveboard edit header.
4927
+ *
4928
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
4929
+ *
4930
+ * @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
4931
+ * @example
4932
+ * ```js
4933
+ * liveboardEmbed.trigger(HostEvent.OpenAddTabModal);
4934
+ * ```
4935
+ */
4936
+ OpenAddTabModal = 'openAddTabModal',
4868
4937
  /**
4869
4938
  * Open the parameter panel for a particular parameter on a Liveboard.
4870
4939
  * Mirrors {@link HostEvent.OpenFilter} for parameters.
@@ -5462,6 +5531,17 @@ export enum HostEvent {
5462
5531
  * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
5463
5532
  */
5464
5533
  EditVisualization = 'editVisualization',
5534
+ /**
5535
+ * Exits Liveboard edit mode , equivalent to clicking the
5536
+ * *Cancel* button in the Liveboard edit header. The Liveboard returns to
5537
+ * view mode and the embedded app emits the {@link EmbedEvent.Cancel} event.
5538
+ * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
5539
+ * @example
5540
+ * ```js
5541
+ * liveboardEmbed.trigger(HostEvent.ExitEditMode);
5542
+ * ```
5543
+ */
5544
+ ExitEditMode = 'exitEditMode',
5465
5545
  /**
5466
5546
  * Trigger the **Copy link** action on a Liveboard or visualization
5467
5547
  * Payload: {@link VizScopedRequest}.
@@ -7006,6 +7086,40 @@ export enum HostEvent {
7006
7086
  * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
7007
7087
  */
7008
7088
  RefreshLiveboardBrowserCache = 'refreshLiveboardBrowserCache',
7089
+
7090
+ /**
7091
+ * Switch the embed between dark appearance and its default appearance
7092
+ * while it is open, without reloading it.
7093
+ * Payload: {@link UpdateThemeRequest}.
7094
+ *
7095
+ * Use it to keep the embed in step with a theme switch in your
7096
+ * application; the appearance the embed loads with is set by `isDarkMode`.
7097
+ * The event resolves with the applied value, such as `{ isDarkMode: true }`.
7098
+ * When dark appearance is not available in the embed, the embed does not
7099
+ * change and the event rejects with an error message instead.
7100
+ * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
7101
+ * @param - `isDarkMode` - `true` for dark appearance, `false` for the
7102
+ * default appearance.
7103
+ * @example
7104
+ * ```js
7105
+ * appEmbed.trigger(HostEvent.UpdateTheme, { isDarkMode: true });
7106
+ * ```
7107
+ * @example
7108
+ * ```js
7109
+ * // Follow a theme switch in your application
7110
+ * const themeSwitch = document.querySelector('#theme-switch');
7111
+ * themeSwitch.addEventListener('change', async (event) => {
7112
+ * try {
7113
+ * await appEmbed.trigger(HostEvent.UpdateTheme, {
7114
+ * isDarkMode: event.target.checked,
7115
+ * });
7116
+ * } catch (error) {
7117
+ * console.warn(error);
7118
+ * }
7119
+ * });
7120
+ * ```
7121
+ */
7122
+ UpdateTheme = 'UpdateTheme',
7009
7123
  }
7010
7124
 
7011
7125
  /**
@@ -7051,6 +7165,7 @@ export enum Param {
7051
7165
  * @version SDK: 1.52.2 | ThoughtSpot Cloud: 26.9.0.cl
7052
7166
  */
7053
7167
  TsmcpAnswerIndex = 'tsmcpAnswerIndex',
7168
+ IsMcpAnswerEmbed = 'isMcpAnswerEmbed',
7054
7169
  EmbedApp = 'embedApp',
7055
7170
  DataSources = 'dataSources',
7056
7171
  DataSourceMode = 'dataSourceMode',
@@ -7262,6 +7377,21 @@ export type SpotterFileUploadFileTypes = {
7262
7377
 
7263
7378
  export enum Action {
7264
7379
  /**
7380
+ * The **Add** button on a Liveboard in edit mode.
7381
+ * Controls the visibility and disabled state of the Add panel button
7382
+ * in the Liveboard edit toolbar, which allows users to add
7383
+ * visualizations, filters, parameters, and tabs.
7384
+ * @example
7385
+ * ```js
7386
+ * hiddenActions: [Action.LiveboardAddPanel]
7387
+ * // or
7388
+ * disabledActions: [Action.LiveboardAddPanel]
7389
+ * ```
7390
+ * @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
7391
+ */
7392
+ LiveboardAddPanel = 'liveboardAddPanel',
7393
+ /**
7394
+ *
7265
7395
  * The **Save** action on an Answer or Liveboard.
7266
7396
  * Allows users to save the changes.
7267
7397
  * @example
@@ -9515,6 +9645,125 @@ export enum Action {
9515
9645
  * ```
9516
9646
  */
9517
9647
  CustomizeHomepage = 'customizeHomepage',
9648
+ /**
9649
+ * Controls the visibility and disabled state of the *Cancel* button in the
9650
+ * Liveboard edit header, the button that discards the changes made in edit
9651
+ * mode and returns the Liveboard to view mode. The button is shown only
9652
+ * while the Liveboard is in edit mode.
9653
+ * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
9654
+ * @example
9655
+ * ```js
9656
+ * const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
9657
+ * ... // other embed view config
9658
+ * hiddenActions: [Action.Cancel],
9659
+ * });
9660
+ * ```
9661
+ * @example
9662
+ * ```js
9663
+ * const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
9664
+ * ... // other embed view config
9665
+ * disabledActions: [Action.Cancel],
9666
+ * disabledActionReason: 'Save your changes to leave edit mode',
9667
+ * });
9668
+ * ```
9669
+ */
9670
+ Cancel = 'cancel',
9671
+ /**
9672
+ * Controls the visibility and disabled state of the "Version history" menu item for a Liveboard or Answer.
9673
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
9674
+ * @example
9675
+ * ```js
9676
+ * {
9677
+ * hiddenActions: [Action.ShowVersionHistory],
9678
+ * disabledActions: [Action.ShowVersionHistory],
9679
+ * }
9680
+ * ```
9681
+ */
9682
+ ShowVersionHistory = 'showVersionHistory',
9683
+ /**
9684
+ * Controls the visibility and disabled state of the "Enable version control" menu item for a Liveboard or Answer.
9685
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
9686
+ * @example
9687
+ * ```js
9688
+ * {
9689
+ * hiddenActions: [Action.EnableVersionControl],
9690
+ * disabledActions: [Action.EnableVersionControl],
9691
+ * }
9692
+ * ```
9693
+ */
9694
+ EnableVersionControl = 'enableVersionControl',
9695
+ /**
9696
+ * Controls the visibility and disabled state of the "Disable version control" menu item for a Liveboard or Answer.
9697
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
9698
+ * @example
9699
+ * ```js
9700
+ * {
9701
+ * hiddenActions: [Action.DisableVersionControl],
9702
+ * disabledActions: [Action.DisableVersionControl],
9703
+ * }
9704
+ * ```
9705
+ */
9706
+ DisableVersionControl = 'disableVersionControl',
9707
+ /**
9708
+ * Controls the visibility and disabled state of the "Withdraw verification" menu item for a verified Liveboard.
9709
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
9710
+ * @example
9711
+ * ```js
9712
+ * {
9713
+ * hiddenActions: [Action.WithdrawVerification],
9714
+ * disabledActions: [Action.WithdrawVerification],
9715
+ * }
9716
+ * ```
9717
+ */
9718
+ WithdrawVerification = 'withdrawVerification',
9719
+ /**
9720
+ * Controls the visibility and disabled state of the "Switch to new chart experience" menu item on an Answer.
9721
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
9722
+ * @example
9723
+ * ```js
9724
+ * {
9725
+ * hiddenActions: [Action.SwitchToNewChartExperience],
9726
+ * disabledActions: [Action.SwitchToNewChartExperience],
9727
+ * }
9728
+ * ```
9729
+ */
9730
+ SwitchToNewChartExperience = 'switchToNewChartExperience',
9731
+ /**
9732
+ * Controls the visibility and disabled state of the "Switch to classic chart experience" menu item on an Answer.
9733
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
9734
+ * @example
9735
+ * ```js
9736
+ * {
9737
+ * hiddenActions: [Action.SwitchToClassicChartExperience],
9738
+ * disabledActions: [Action.SwitchToClassicChartExperience],
9739
+ * }
9740
+ * ```
9741
+ */
9742
+ SwitchToClassicChartExperience = 'switchToClassicChartExperience',
9743
+ /**
9744
+ * Controls the visibility and disabled state of the "Monitor" menu item on an Answer, which includes the alert options.
9745
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.5.0.cl
9746
+ * @example
9747
+ * ```js
9748
+ * {
9749
+ * hiddenActions: [Action.Monitor],
9750
+ * disabledActions: [Action.Monitor],
9751
+ * }
9752
+ * ```
9753
+ */
9754
+ Monitor = 'monitor',
9755
+ /**
9756
+ * 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.
9757
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
9758
+ * @example
9759
+ * ```js
9760
+ * {
9761
+ * hiddenActions: [Action.SpotterViewExplanation],
9762
+ * disabledActions: [Action.SpotterViewExplanation],
9763
+ * }
9764
+ * ```
9765
+ */
9766
+ SpotterViewExplanation = 'spotterViewExplanation',
9518
9767
  }
9519
9768
  export interface AnswerServiceType {
9520
9769
  getAnswer?: (offset: number, batchSize: number) => any;