@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0-test

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 (285) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/config.d.ts +1 -0
  3. package/cjs/src/config.d.ts.map +1 -1
  4. package/cjs/src/config.js +2 -1
  5. package/cjs/src/config.js.map +1 -1
  6. package/cjs/src/css-variables.d.ts +122 -0
  7. package/cjs/src/css-variables.d.ts.map +1 -1
  8. package/cjs/src/embed/app.d.ts +176 -24
  9. package/cjs/src/embed/app.d.ts.map +1 -1
  10. package/cjs/src/embed/app.js +86 -38
  11. package/cjs/src/embed/app.js.map +1 -1
  12. package/cjs/src/embed/app.spec.js +672 -150
  13. package/cjs/src/embed/app.spec.js.map +1 -1
  14. package/cjs/src/embed/base.d.ts +1 -1
  15. package/cjs/src/embed/base.js +1 -1
  16. package/cjs/src/embed/conversation.d.ts +401 -2
  17. package/cjs/src/embed/conversation.d.ts.map +1 -1
  18. package/cjs/src/embed/conversation.js +32 -16
  19. package/cjs/src/embed/conversation.js.map +1 -1
  20. package/cjs/src/embed/conversation.spec.js +346 -17
  21. package/cjs/src/embed/conversation.spec.js.map +1 -1
  22. package/cjs/src/embed/events.spec.js +638 -0
  23. package/cjs/src/embed/events.spec.js.map +1 -1
  24. package/cjs/src/embed/host-events.spec.js +187 -0
  25. package/cjs/src/embed/host-events.spec.js.map +1 -1
  26. package/cjs/src/embed/hostEventClient/contracts.d.ts +51 -14
  27. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  28. package/cjs/src/embed/hostEventClient/contracts.js +11 -1
  29. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  30. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +2 -1
  31. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  32. package/cjs/src/embed/hostEventClient/host-event-client.js +9 -0
  33. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  34. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +236 -0
  35. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  36. package/cjs/src/embed/hostEventClient/utils.d.ts +2 -0
  37. package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -1
  38. package/cjs/src/embed/hostEventClient/utils.js +32 -2
  39. package/cjs/src/embed/hostEventClient/utils.js.map +1 -1
  40. package/cjs/src/embed/hostEventClient/utils.spec.js +178 -0
  41. package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -1
  42. package/cjs/src/embed/liveboard.d.ts +81 -13
  43. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  44. package/cjs/src/embed/liveboard.js +50 -9
  45. package/cjs/src/embed/liveboard.js.map +1 -1
  46. package/cjs/src/embed/liveboard.spec.js +432 -4
  47. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  48. package/cjs/src/embed/spotter-utils.d.ts +15 -1
  49. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  50. package/cjs/src/embed/spotter-utils.js +28 -1
  51. package/cjs/src/embed/spotter-utils.js.map +1 -1
  52. package/cjs/src/embed/spotter-utils.spec.js +129 -0
  53. package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
  54. package/cjs/src/embed/spotter-viz-utils.d.ts +37 -4
  55. package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
  56. package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
  57. package/cjs/src/embed/spotter-viz-utils.spec.js +17 -0
  58. package/cjs/src/embed/spotter-viz-utils.spec.js.map +1 -1
  59. package/cjs/src/embed/ts-embed.d.ts +16 -8
  60. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  61. package/cjs/src/embed/ts-embed.js +96 -37
  62. package/cjs/src/embed/ts-embed.js.map +1 -1
  63. package/cjs/src/embed/ts-embed.spec.js +683 -3
  64. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  65. package/cjs/src/errors.d.ts +1 -0
  66. package/cjs/src/errors.d.ts.map +1 -1
  67. package/cjs/src/errors.js +1 -0
  68. package/cjs/src/errors.js.map +1 -1
  69. package/cjs/src/index.d.ts +3 -3
  70. package/cjs/src/index.d.ts.map +1 -1
  71. package/cjs/src/index.js +4 -2
  72. package/cjs/src/index.js.map +1 -1
  73. package/cjs/src/mixpanel-service.d.ts +4 -0
  74. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  75. package/cjs/src/mixpanel-service.js +4 -0
  76. package/cjs/src/mixpanel-service.js.map +1 -1
  77. package/cjs/src/react/all-types-export.d.ts +1 -1
  78. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  79. package/cjs/src/react/all-types-export.js +2 -1
  80. package/cjs/src/react/all-types-export.js.map +1 -1
  81. package/cjs/src/react/all-types-export.parity.spec.d.ts +2 -0
  82. package/cjs/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  83. package/cjs/src/react/all-types-export.parity.spec.js +194 -0
  84. package/cjs/src/react/all-types-export.parity.spec.js.map +1 -0
  85. package/cjs/src/react/index.d.ts +66 -32
  86. package/cjs/src/react/index.d.ts.map +1 -1
  87. package/cjs/src/react/index.js +5 -3
  88. package/cjs/src/react/index.js.map +1 -1
  89. package/cjs/src/react/index.spec.js +101 -0
  90. package/cjs/src/react/index.spec.js.map +1 -1
  91. package/cjs/src/react/util.spec.js +251 -0
  92. package/cjs/src/react/util.spec.js.map +1 -1
  93. package/cjs/src/types.d.ts +902 -28
  94. package/cjs/src/types.d.ts.map +1 -1
  95. package/cjs/src/types.js +701 -14
  96. package/cjs/src/types.js.map +1 -1
  97. package/cjs/src/utils/processData.spec.js +93 -0
  98. package/cjs/src/utils/processData.spec.js.map +1 -1
  99. package/cjs/src/utils/processTrigger.spec.js +61 -0
  100. package/cjs/src/utils/processTrigger.spec.js.map +1 -1
  101. package/cjs/src/utils.spec.js +4 -0
  102. package/cjs/src/utils.spec.js.map +1 -1
  103. package/dist/{index-B5xoN6Cp.js → index-Bivg-mDx.js} +1 -1
  104. package/dist/src/config.d.ts +1 -0
  105. package/dist/src/config.d.ts.map +1 -1
  106. package/dist/src/css-variables.d.ts +122 -0
  107. package/dist/src/css-variables.d.ts.map +1 -1
  108. package/dist/src/embed/app.d.ts +176 -24
  109. package/dist/src/embed/app.d.ts.map +1 -1
  110. package/dist/src/embed/base.d.ts +1 -1
  111. package/dist/src/embed/conversation.d.ts +401 -2
  112. package/dist/src/embed/conversation.d.ts.map +1 -1
  113. package/dist/src/embed/hostEventClient/contracts.d.ts +51 -14
  114. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  115. package/dist/src/embed/hostEventClient/host-event-client.d.ts +2 -1
  116. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  117. package/dist/src/embed/hostEventClient/utils.d.ts +2 -0
  118. package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -1
  119. package/dist/src/embed/liveboard.d.ts +81 -13
  120. package/dist/src/embed/liveboard.d.ts.map +1 -1
  121. package/dist/src/embed/spotter-utils.d.ts +15 -1
  122. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  123. package/dist/src/embed/spotter-viz-utils.d.ts +37 -4
  124. package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
  125. package/dist/src/embed/ts-embed.d.ts +16 -8
  126. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  127. package/dist/src/errors.d.ts +1 -0
  128. package/dist/src/errors.d.ts.map +1 -1
  129. package/dist/src/index.d.ts +3 -3
  130. package/dist/src/index.d.ts.map +1 -1
  131. package/dist/src/mixpanel-service.d.ts +4 -0
  132. package/dist/src/mixpanel-service.d.ts.map +1 -1
  133. package/dist/src/react/all-types-export.d.ts +1 -1
  134. package/dist/src/react/all-types-export.d.ts.map +1 -1
  135. package/dist/src/react/all-types-export.parity.spec.d.ts +2 -0
  136. package/dist/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  137. package/dist/src/react/index.d.ts +66 -32
  138. package/dist/src/react/index.d.ts.map +1 -1
  139. package/dist/src/types.d.ts +902 -28
  140. package/dist/src/types.d.ts.map +1 -1
  141. package/dist/tsembed-react.es.js +1269 -206
  142. package/dist/tsembed-react.js +1268 -205
  143. package/dist/tsembed.es.js +1364 -304
  144. package/dist/tsembed.js +1362 -302
  145. package/dist/visual-embed-sdk-react-full.d.ts +1867 -157
  146. package/dist/visual-embed-sdk-react.d.ts +1872 -161
  147. package/dist/visual-embed-sdk.d.ts +1815 -127
  148. package/lib/package.json +1 -1
  149. package/lib/src/config.d.ts +1 -0
  150. package/lib/src/config.d.ts.map +1 -1
  151. package/lib/src/config.js +1 -0
  152. package/lib/src/config.js.map +1 -1
  153. package/lib/src/css-variables.d.ts +122 -0
  154. package/lib/src/css-variables.d.ts.map +1 -1
  155. package/lib/src/embed/app.d.ts +176 -24
  156. package/lib/src/embed/app.d.ts.map +1 -1
  157. package/lib/src/embed/app.js +87 -39
  158. package/lib/src/embed/app.js.map +1 -1
  159. package/lib/src/embed/app.spec.js +673 -151
  160. package/lib/src/embed/app.spec.js.map +1 -1
  161. package/lib/src/embed/base.d.ts +1 -1
  162. package/lib/src/embed/base.js +1 -1
  163. package/lib/src/embed/conversation.d.ts +401 -2
  164. package/lib/src/embed/conversation.d.ts.map +1 -1
  165. package/lib/src/embed/conversation.js +33 -17
  166. package/lib/src/embed/conversation.js.map +1 -1
  167. package/lib/src/embed/conversation.spec.js +347 -18
  168. package/lib/src/embed/conversation.spec.js.map +1 -1
  169. package/lib/src/embed/events.spec.js +638 -0
  170. package/lib/src/embed/events.spec.js.map +1 -1
  171. package/lib/src/embed/host-events.spec.js +188 -1
  172. package/lib/src/embed/host-events.spec.js.map +1 -1
  173. package/lib/src/embed/hostEventClient/contracts.d.ts +51 -14
  174. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  175. package/lib/src/embed/hostEventClient/contracts.js +10 -0
  176. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  177. package/lib/src/embed/hostEventClient/host-event-client.d.ts +2 -1
  178. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  179. package/lib/src/embed/hostEventClient/host-event-client.js +10 -1
  180. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  181. package/lib/src/embed/hostEventClient/host-event-client.spec.js +236 -0
  182. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  183. package/lib/src/embed/hostEventClient/utils.d.ts +2 -0
  184. package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -1
  185. package/lib/src/embed/hostEventClient/utils.js +28 -1
  186. package/lib/src/embed/hostEventClient/utils.js.map +1 -1
  187. package/lib/src/embed/hostEventClient/utils.spec.js +179 -1
  188. package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -1
  189. package/lib/src/embed/liveboard.d.ts +81 -13
  190. package/lib/src/embed/liveboard.d.ts.map +1 -1
  191. package/lib/src/embed/liveboard.js +50 -9
  192. package/lib/src/embed/liveboard.js.map +1 -1
  193. package/lib/src/embed/liveboard.spec.js +432 -4
  194. package/lib/src/embed/liveboard.spec.js.map +1 -1
  195. package/lib/src/embed/spotter-utils.d.ts +15 -1
  196. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  197. package/lib/src/embed/spotter-utils.js +25 -0
  198. package/lib/src/embed/spotter-utils.js.map +1 -1
  199. package/lib/src/embed/spotter-utils.spec.js +130 -1
  200. package/lib/src/embed/spotter-utils.spec.js.map +1 -1
  201. package/lib/src/embed/spotter-viz-utils.d.ts +37 -4
  202. package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
  203. package/lib/src/embed/spotter-viz-utils.js.map +1 -1
  204. package/lib/src/embed/spotter-viz-utils.spec.js +17 -0
  205. package/lib/src/embed/spotter-viz-utils.spec.js.map +1 -1
  206. package/lib/src/embed/ts-embed.d.ts +16 -8
  207. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  208. package/lib/src/embed/ts-embed.js +96 -37
  209. package/lib/src/embed/ts-embed.js.map +1 -1
  210. package/lib/src/embed/ts-embed.spec.js +683 -3
  211. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  212. package/lib/src/errors.d.ts +1 -0
  213. package/lib/src/errors.d.ts.map +1 -1
  214. package/lib/src/errors.js +1 -0
  215. package/lib/src/errors.js.map +1 -1
  216. package/lib/src/index.d.ts +3 -3
  217. package/lib/src/index.d.ts.map +1 -1
  218. package/lib/src/index.js +3 -3
  219. package/lib/src/index.js.map +1 -1
  220. package/lib/src/mixpanel-service.d.ts +4 -0
  221. package/lib/src/mixpanel-service.d.ts.map +1 -1
  222. package/lib/src/mixpanel-service.js +4 -0
  223. package/lib/src/mixpanel-service.js.map +1 -1
  224. package/lib/src/react/all-types-export.d.ts +1 -1
  225. package/lib/src/react/all-types-export.d.ts.map +1 -1
  226. package/lib/src/react/all-types-export.js +1 -1
  227. package/lib/src/react/all-types-export.js.map +1 -1
  228. package/lib/src/react/all-types-export.parity.spec.d.ts +2 -0
  229. package/lib/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  230. package/lib/src/react/all-types-export.parity.spec.js +191 -0
  231. package/lib/src/react/all-types-export.parity.spec.js.map +1 -0
  232. package/lib/src/react/index.d.ts +66 -32
  233. package/lib/src/react/index.d.ts.map +1 -1
  234. package/lib/src/react/index.js +5 -3
  235. package/lib/src/react/index.js.map +1 -1
  236. package/lib/src/react/index.spec.js +102 -1
  237. package/lib/src/react/index.spec.js.map +1 -1
  238. package/lib/src/react/util.spec.js +251 -0
  239. package/lib/src/react/util.spec.js.map +1 -1
  240. package/lib/src/types.d.ts +902 -28
  241. package/lib/src/types.d.ts.map +1 -1
  242. package/lib/src/types.js +701 -14
  243. package/lib/src/types.js.map +1 -1
  244. package/lib/src/utils/processData.spec.js +93 -0
  245. package/lib/src/utils/processData.spec.js.map +1 -1
  246. package/lib/src/utils/processTrigger.spec.js +61 -0
  247. package/lib/src/utils/processTrigger.spec.js.map +1 -1
  248. package/lib/src/utils.spec.js +4 -0
  249. package/lib/src/utils.spec.js.map +1 -1
  250. package/lib/src/visual-embed-sdk.d.ts +1815 -127
  251. package/package.json +1 -1
  252. package/src/config.ts +1 -0
  253. package/src/css-variables.ts +150 -0
  254. package/src/embed/app.spec.ts +877 -196
  255. package/src/embed/app.ts +276 -75
  256. package/src/embed/base.ts +1 -1
  257. package/src/embed/conversation.spec.ts +411 -21
  258. package/src/embed/conversation.ts +441 -18
  259. package/src/embed/events.spec.ts +761 -1
  260. package/src/embed/host-events.spec.ts +242 -0
  261. package/src/embed/hostEventClient/contracts.ts +57 -14
  262. package/src/embed/hostEventClient/host-event-client.spec.ts +372 -0
  263. package/src/embed/hostEventClient/host-event-client.ts +18 -2
  264. package/src/embed/hostEventClient/utils.spec.ts +204 -0
  265. package/src/embed/hostEventClient/utils.ts +37 -10
  266. package/src/embed/liveboard.spec.ts +565 -4
  267. package/src/embed/liveboard.ts +155 -28
  268. package/src/embed/spotter-utils.spec.ts +140 -1
  269. package/src/embed/spotter-utils.ts +36 -1
  270. package/src/embed/spotter-viz-utils.spec.ts +17 -0
  271. package/src/embed/spotter-viz-utils.ts +37 -4
  272. package/src/embed/ts-embed.spec.ts +885 -3
  273. package/src/embed/ts-embed.ts +111 -39
  274. package/src/errors.ts +1 -0
  275. package/src/index.ts +45 -2
  276. package/src/mixpanel-service.ts +4 -0
  277. package/src/react/all-types-export.parity.spec.ts +208 -0
  278. package/src/react/all-types-export.ts +22 -0
  279. package/src/react/index.spec.tsx +158 -0
  280. package/src/react/index.tsx +70 -33
  281. package/src/react/util.spec.tsx +255 -0
  282. package/src/types.ts +904 -24
  283. package/src/utils/processData.spec.ts +97 -0
  284. package/src/utils/processTrigger.spec.ts +91 -0
  285. package/src/utils.spec.ts +5 -0
package/cjs/src/types.d.ts CHANGED
@@ -169,7 +169,9 @@ export declare enum AuthType {
169
169
  }
170
170
  /**
171
171
  *
172
- * **Note**: This attribute is not supported in the classic (V1) homepage experience.
172
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
173
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
174
+ * V4 (Focused) home page experiences.
173
175
  *
174
176
  */
175
177
  export declare enum HomeLeftNavItem {
@@ -235,7 +237,14 @@ export declare enum HomeLeftNavItem {
235
237
  * Available in the V3 navigation experience.
236
238
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
237
239
  */
238
- Favorites = "favorites"
240
+ Favorites = "favorites",
241
+ /**
242
+ * The *Collections* menu option in
243
+ * the *Insights* left navigation panel.
244
+ * Shown when collections are enabled on the cluster.
245
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
246
+ */
247
+ Collections = "collections"
239
248
  }
240
249
  export type DOMSelector = string | HTMLElement;
241
250
  /**
@@ -851,6 +860,85 @@ export interface FrameParams {
851
860
  */
852
861
  [key: string]: string | number | boolean | undefined;
853
862
  }
863
+ /**
864
+ * Configuration for the pre-render wrapper element.
865
+ * All properties here mirror the top-level preRender properties on
866
+ * {@link BaseViewConfig} and take precedence over them when both are set,
867
+ * so existing top-level usage continues to work without any changes.
868
+ *
869
+ * @version SDK: 1.52.0
870
+ * @example
871
+ * ```js
872
+ * init({ thoughtSpotHost: '...', authType: AuthType.None });
873
+ * const embed = new LiveboardEmbed('#tsEmbed', {
874
+ * preRenderConfig: {
875
+ * preRenderId: 'my-liveboard',
876
+ * preRenderContainer: '#my-scroll-container',
877
+ * doNotTrackPreRenderSize: false,
878
+ * zIndex: -10,
879
+ * },
880
+ * });
881
+ * embed.preRender();
882
+ * embed.showPreRender();
883
+ * ```
884
+ */
885
+ export interface PreRenderConfig {
886
+ /**
887
+ * Pre-render ID to identify the pre-render instance.
888
+ * Takes precedence over the top-level `preRenderId` when both are set.
889
+ *
890
+ * Matches the embed warmed by `preRender()` to the one revealed by
891
+ * `showPreRender()`. Embeds sharing an ID share one loaded frame: reuse the ID for
892
+ * the same view, and give unrelated views their own or they will collide.
893
+ * Required by `preRender()`, `showPreRender()`, and `hidePreRender()`, which log
894
+ * and do nothing without it.
895
+ *
896
+ * @default undefined
897
+ */
898
+ preRenderId?: string;
899
+ /**
900
+ * The DOM element or CSS selector string specifying the container into
901
+ * which the pre-rendered wrapper is inserted.
902
+ * Takes precedence over the top-level `preRenderContainer` when both are set.
903
+ *
904
+ * Set this when your app scrolls inside an element rather than the page (for
905
+ * example `<body>` has `overflow: hidden`). Point it at the element that actually
906
+ * scrolls, keep that element mounted while the embed is warm, and prefer a
907
+ * selector string — it is re-resolved on reposition and so survives a remount,
908
+ * while a detached element reference cannot be recovered. An invalid selector is
909
+ * logged and falls back to `document.body`.
910
+ * See {@link BaseViewConfig.preRenderContainer} for details, including Shadow DOM.
911
+ *
912
+ * @default document.body
913
+ */
914
+ preRenderContainer?: string | HTMLElement;
915
+ /**
916
+ * Disables the `ResizeObserver` that keeps the wrapper sized to the
917
+ * placeholder element.
918
+ * Takes precedence over the top-level `doNotTrackPreRenderSize` when both are set.
919
+ *
920
+ * Set this only when you size the embed yourself; you then own alignment and must
921
+ * call `syncPreRenderStyle()` after any change that moves or resizes it. Tracking
922
+ * already pauses while hidden, so this is not needed to avoid work then.
923
+ *
924
+ * @default false
925
+ */
926
+ doNotTrackPreRenderSize?: boolean;
927
+ /**
928
+ * CSS `z-index` value applied to the pre-render wrapper when hidden.
929
+ * Override this when the host page's stacking context does not reach `-1000`
930
+ * and the hidden wrapper still appears above other elements.
931
+ *
932
+ * A page that creates its own stacking context — a positioned app shell, a
933
+ * transformed wrapper, a modal layer — can clamp `-1000`, and the hidden wrapper
934
+ * then shows through or swallows clicks meant for your UI. Reach for this when you
935
+ * see a faint panel behind your content, or clicks landing on nothing in the
936
+ * region where the embed will eventually appear.
937
+ *
938
+ * @default -1000
939
+ */
940
+ zIndex?: number;
941
+ }
854
942
  /**
855
943
  * The common configuration object for an embedded view.
856
944
  */
@@ -935,7 +1023,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
935
1023
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
936
1024
  * const embed = new <EmbedComponent>('#tsEmbed', {
937
1025
  * ... // other embed view config
938
- * hiddenActions: [Action.Download, Action.Export],
1026
+ * hiddenActions: [Action.Download, Action.ExportTML],
939
1027
  * });
940
1028
  * ```
941
1029
  * @important
@@ -957,7 +1045,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
957
1045
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
958
1046
  * const embed = new <EmbedComponent>('#tsEmbed', {
959
1047
  * ... // other embed view config
960
- * visibleActions: [Action.Download, Action.Export],
1048
+ * visibleActions: [Action.Download, Action.ExportTML],
961
1049
  * });
962
1050
  * ```
963
1051
  */
@@ -1042,6 +1130,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1042
1130
  *
1043
1131
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1044
1132
  * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1133
+ * @deprecated Use {@link PreRenderConfig.preRenderId} via `preRenderConfig` instead.
1045
1134
  * @example
1046
1135
  * ```js
1047
1136
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1061,6 +1150,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1061
1150
  * @type {boolean}
1062
1151
  * @default false
1063
1152
  * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
1153
+ * @deprecated Use {@link PreRenderConfig.doNotTrackPreRenderSize} via `preRenderConfig` instead.
1064
1154
  * @example
1065
1155
  * ```js
1066
1156
  * // Disable tracking PreRender size in the configuration
@@ -1102,6 +1192,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1102
1192
  *
1103
1193
  * @type {string | HTMLElement}
1104
1194
  * @version SDK: 1.49.2 | ThoughtSpot: *
1195
+ * @deprecated Use {@link PreRenderConfig.preRenderContainer} via `preRenderConfig` instead.
1105
1196
  * @example
1106
1197
  * ```js
1107
1198
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -1112,6 +1203,27 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1112
1203
  * ```
1113
1204
  */
1114
1205
  preRenderContainer?: string | HTMLElement;
1206
+ /**
1207
+ * Configuration for the pre-render wrapper element.
1208
+ * All properties here mirror the top-level preRender properties on
1209
+ * `BaseViewConfig` and take precedence over them when both are set,
1210
+ * so existing top-level usage continues to work without any changes.
1211
+ * See {@link PreRenderConfig} for available options.
1212
+ *
1213
+ * @version SDK: 1.52.0
1214
+ * @example
1215
+ * ```js
1216
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1217
+ * preRenderConfig: {
1218
+ * preRenderId: 'my-liveboard',
1219
+ * zIndex: -10,
1220
+ * },
1221
+ * });
1222
+ * embed.preRender();
1223
+ * embed.showPreRender();
1224
+ * ```
1225
+ */
1226
+ preRenderConfig?: PreRenderConfig;
1115
1227
  /**
1116
1228
  * Enable the V2 shell. This can provide performance benefits
1117
1229
  * due to a lighter-weight shell.
@@ -1182,6 +1294,26 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1182
1294
  * ```
1183
1295
  */
1184
1296
  overrideOrgId?: number;
1297
+ /**
1298
+ * Overrides the browser history behavior for embedding application users.
1299
+ * This parameter changes standard history navigation (pushState) into a
1300
+ * state replacement (replaceState), preventing users from getting trapped in
1301
+ * back-button loops inside the embedded iframe environment.
1302
+ * The overrideHistoryState setting is honored only if the
1303
+ * application is running within an embedded context.
1304
+ *
1305
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1306
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1307
+ * @example
1308
+ * ```js
1309
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
1310
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1311
+ * // ... other embed view config
1312
+ * overrideHistoryState: true,
1313
+ * });
1314
+ * ```
1315
+ */
1316
+ overrideHistoryState?: boolean;
1185
1317
  /**
1186
1318
  * Flag to override the *Open Link in New Tab* context
1187
1319
  * menu option.
@@ -1530,7 +1662,7 @@ export interface HomePageConfig {
1530
1662
  *
1531
1663
  * const embed = new AppEmbed('#tsEmbed', {
1532
1664
  * ... //other embed view config
1533
- * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
1665
+ * hiddenListColumns : [ListPageColumns.Favorites,ListPageColumns.Author],
1534
1666
  * })
1535
1667
  * ```
1536
1668
  */
@@ -1540,7 +1672,9 @@ export interface HomePageConfig {
1540
1672
  * To specify the modules, import the `HomepageModule` enum.
1541
1673
  * For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
1542
1674
  *
1543
- * **Note**: This attribute is not supported in the classic (v1) experience.
1675
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
1676
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
1677
+ * and V4 (Focused) home page experiences.
1544
1678
  *
1545
1679
  * Supported embed types: `AppEmbed`
1546
1680
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1549,7 +1683,7 @@ export interface HomePageConfig {
1549
1683
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
1550
1684
  *
1551
1685
  * const embed = new AppEmbed('#tsEmbed', {
1552
- * ... // V2/V3 navigation and home page experience attributes
1686
+ * ... // V3 navigation and home page experience attributes
1553
1687
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
1554
1688
  * //...other embed view configuration attributes
1555
1689
  * })
@@ -1560,8 +1694,11 @@ export interface HomePageConfig {
1560
1694
  * Reorder home page modules.
1561
1695
  * To specify the modules, import the `HomepageModule` enum.
1562
1696
  * For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
1563
- * HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
1564
- * classic (v1) homepage.
1697
+ * HomepageModule.Watchlist]`
1698
+ *
1699
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
1700
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
1701
+ * and V4 (Focused) home page experiences.
1565
1702
  *
1566
1703
  * Supported embed types: `AppEmbed`
1567
1704
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1570,7 +1707,7 @@ export interface HomePageConfig {
1570
1707
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
1571
1708
  *
1572
1709
  * const embed = new AppEmbed('#tsEmbed', {
1573
- * ...//V2/V3 navigation and home page experience attributes
1710
+ * ...//V3 navigation and home page experience attributes
1574
1711
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
1575
1712
  * //... other embed view configuration attributes
1576
1713
  * })
@@ -1582,7 +1719,9 @@ export interface HomePageConfig {
1582
1719
  * on the home page left navigation panel.
1583
1720
  * To specify the menu items, import the `HomeLeftNavItem` enum.
1584
1721
  *
1585
- * **Note**: This attribute is not supported in the classic (v1) homepage.
1722
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
1723
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
1724
+ * and V4 (Focused) home page experiences.
1586
1725
  *
1587
1726
  * Supported embed types: `AppEmbed`
1588
1727
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1836,6 +1975,25 @@ export interface LiveboardAppEmbedViewConfig {
1836
1975
  * ```
1837
1976
  */
1838
1977
  enable2ColumnLayout?: boolean;
1978
+ /**
1979
+ * This attribute keeps an embedded Liveboard on the 12-column layout at
1980
+ * every width, instead of switching to the two-column or single-column
1981
+ * layout as the container narrows.
1982
+ *
1983
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1984
+ * @type {boolean}
1985
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
1986
+ * @default false
1987
+ * @example
1988
+ * ```js
1989
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
1990
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1991
+ * ... // other embed view config
1992
+ * isLiveboardAlwaysOn12ColLayout: true,
1993
+ * })
1994
+ * ```
1995
+ */
1996
+ isLiveboardAlwaysOn12ColLayout?: boolean;
1839
1997
  /**
1840
1998
  * This flag can be used to enable the compact header in Liveboard
1841
1999
  *
@@ -1940,6 +2098,26 @@ export interface LiveboardAppEmbedViewConfig {
1940
2098
  * ```
1941
2099
  */
1942
2100
  coverAndFilterOptionInPDF?: boolean;
2101
+ /**
2102
+ * Sets the gutter space (in pixels) between the visualization tiles of
2103
+ * an embedded Liveboard grid layout and its outer layout padding.
2104
+ * Accepts a non-negative integer; `0` renders the tiles without any gap
2105
+ * and removes the outer padding. When omitted, the gutter saved in the
2106
+ * Liveboard's styling settings (or the ThoughtSpot default) applies.
2107
+ *
2108
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2109
+ * @type {number}
2110
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
2111
+ * @example
2112
+ * ```js
2113
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
2114
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2115
+ * ... // other embed view config
2116
+ * liveboardGutter: 8,
2117
+ * })
2118
+ * ```
2119
+ */
2120
+ liveboardGutter?: number;
1943
2121
  /**
1944
2122
  * This flag is used to enable or disable the new centralized Liveboard filter UX
1945
2123
  * (v2). When enabled, a unified modal is used to manage and update multiple filters
@@ -1958,6 +2136,24 @@ export interface LiveboardAppEmbedViewConfig {
1958
2136
  * ```
1959
2137
  */
1960
2138
  isCentralizedLiveboardFilterUXEnabled?: boolean;
2139
+ /**
2140
+ * This flag is used to enable or disable scoped Liveboard filtering.
2141
+ * When enabled, filters and parameters can be scoped to a group of
2142
+ * visualizations on a Liveboard, in addition to the Liveboard and
2143
+ * tab levels.
2144
+ *
2145
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2146
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
2147
+ * @example
2148
+ * ```js
2149
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
2150
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2151
+ * ... // other embed view config
2152
+ * isScopedLiveboardFilteringEnabled: true,
2153
+ * })
2154
+ * ```
2155
+ */
2156
+ isScopedLiveboardFilteringEnabled?: boolean;
1961
2157
  /**
1962
2158
  * This flag is used to enable or disable the link parameters in liveboard.
1963
2159
  *
@@ -2156,7 +2352,9 @@ export declare enum RuntimeFilterOp {
2156
2352
  * via `hiddenHomepageModules` and reordered via
2157
2353
  * `reorderedHomepageModules`.
2158
2354
  *
2159
- * **Note**: This option is not supported in the classic (v1) experience.
2355
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
2356
+ * deprecated. These modules apply to V3 (ModularWithStylingChanges) and
2357
+ * V4 (Focused) home page experiences.
2160
2358
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2161
2359
  */
2162
2360
  export declare enum HomepageModule {
@@ -2365,7 +2563,7 @@ export declare enum EmbedEvent {
2365
2563
  * @returns nonFilteredColumns - The columns that were not filtered
2366
2564
  * @example
2367
2565
  * ```js
2368
- * searchEmbed.on(EmbedEvent.DrillDown, {
2566
+ * searchEmbed.on(EmbedEvent.Drilldown, {
2369
2567
  * points: {
2370
2568
  * clickedPoint,
2371
2569
  * selectedPoints: selectedPoint
@@ -2426,7 +2624,7 @@ export declare enum EmbedEvent {
2426
2624
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2427
2625
  * @example
2428
2626
  * ```js
2429
- * appEmbed.on(EmbedEvent.customAction, payload => {
2627
+ * appEmbed.on(EmbedEvent.CustomAction, payload => {
2430
2628
  * const data = payload.data;
2431
2629
  * if (data.id === 'insert Custom Action ID here') {
2432
2630
  * console.log('Custom Action event:', data.embedAnswerData);
@@ -2692,8 +2890,8 @@ export declare enum EmbedEvent {
2692
2890
  *
2693
2891
  * **Note**: This event is deprecated in v1.21.0.
2694
2892
  * To fire an event when a download action is initiated on a chart or table,
2695
- * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
2696
- * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
2893
+ * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPdf`,
2894
+ * `EmbedEvent.DownloadAsCsv`, or `EmbedEvent.DownloadAsXlsx`
2697
2895
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2698
2896
  * @example
2699
2897
  * ```js
@@ -2743,10 +2941,10 @@ export declare enum EmbedEvent {
2743
2941
  * @example
2744
2942
  * ```js
2745
2943
  * //emit when action starts
2746
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2944
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
2747
2945
  * console.log('download CSV', payload)}, {start: true })
2748
2946
  * //emit when action ends
2749
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2947
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
2750
2948
  * console.log('download CSV', payload)})
2751
2949
  * ```
2752
2950
  */
@@ -3145,11 +3343,19 @@ export declare enum EmbedEvent {
3145
3343
  * Emitted when a user changes any filter on a Liveboard.
3146
3344
  * Returns filter type and name, column name and ID, and runtime
3147
3345
  * filter details.
3346
+ * The payload includes an optional `applicability` attribute indicating the
3347
+ * scope of the changed filter. It contains a `level` (`LIVEBOARD`,
3348
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
3349
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
3350
+ * is no `targetId`, since the filter applies to the whole Liveboard.
3351
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3352
+ * ThoughtSpot: 26.10.0.cl.
3148
3353
  * @example
3149
3354
  *
3150
3355
  * ```js
3151
3356
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3152
3357
  * console.log('payload', payload);
3358
+ * // payload.data optionally includes applicability: { level, targetId }
3153
3359
  * })
3154
3360
  * ```
3155
3361
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
@@ -3341,9 +3547,17 @@ export declare enum EmbedEvent {
3341
3547
  /**
3342
3548
  * Emitted when parameter changes in an Answer
3343
3549
  * or Liveboard.
3550
+ * The payload includes an optional `applicability` attribute indicating the
3551
+ * scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
3552
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
3553
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
3554
+ * is no `targetId`, since the parameter applies to the whole Liveboard.
3555
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3556
+ * ThoughtSpot: 26.10.0.cl.
3344
3557
  * ```js
3345
3558
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
3346
3559
  * console.log('payload', payload);
3560
+ * // payload.data optionally includes applicability: { level, targetId }
3347
3561
  * })
3348
3562
  * ```
3349
3563
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
@@ -3645,6 +3859,158 @@ export declare enum EmbedEvent {
3645
3859
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
3646
3860
  */
3647
3861
  SpotterConversationDeleted = "spotterConversationDeleted",
3862
+ /**
3863
+ * Emitted when the header Share button is clicked. Fires `Start` then `End`
3864
+ * to bracket the interaction. App→host counterpart of the
3865
+ * `ShareSpotterConversation` host event (user-driven vs programmatic open).
3866
+ * @example
3867
+ * ```js
3868
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
3869
+ * // payload: { convId: string }
3870
+ * })
3871
+ * ```
3872
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3873
+ */
3874
+ SpotterShareConversationButtonHeaderClicked = "spotterShareConversationButtonHeaderClicked",
3875
+ /**
3876
+ * Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
3877
+ * to bracket the interaction.
3878
+ * @example
3879
+ * ```js
3880
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
3881
+ * // payload: { convId: string }
3882
+ * })
3883
+ * ```
3884
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3885
+ */
3886
+ SpotterShareConversationMenuItemSidebarClicked = "spotterShareConversationMenuItemSidebarClicked",
3887
+ /**
3888
+ * Emitted when a Spotter conversation is shared (recipients added, or a new
3889
+ * share created). The host builds its own link from shareId/convId + its
3890
+ * configured CONVERSATION_URL — no link string is sent. Distinct from
3891
+ * `SpotterShareModalConfirmButtonClicked`, which fires at click time before
3892
+ * the save resolves.
3893
+ * @example
3894
+ * ```js
3895
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
3896
+ * // payload: { convId: string, shareId: string,
3897
+ * // recipientsAdded: string[], recipientsRemoved: string[] }
3898
+ * })
3899
+ * ```
3900
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3901
+ */
3902
+ SpotterConversationShared = "spotterConversationShared",
3903
+ /**
3904
+ * Emitted when access to a shared Spotter conversation is revoked
3905
+ * (recipients removed). `fullyRevoked` is true when the last sharee is removed
3906
+ * and the share is deleted entirely.
3907
+ * @example
3908
+ * ```js
3909
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
3910
+ * // payload: { convId: string, shareId: string,
3911
+ * // recipientsRemoved: string[], fullyRevoked: boolean }
3912
+ * })
3913
+ * ```
3914
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3915
+ */
3916
+ SpotterConversationShareRevoked = "spotterConversationShareRevoked",
3917
+ /**
3918
+ * Emitted when a recipient opens a shared Spotter conversation (read-only
3919
+ * view). No shareId available viewer-side.
3920
+ * @example
3921
+ * ```js
3922
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
3923
+ * // payload: { convId: string, sourceConvId: string }
3924
+ * // convId = resolved snapshot conv id; sourceConvId = the shared URL id
3925
+ * })
3926
+ * ```
3927
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3928
+ */
3929
+ SpotterSharedConversationViewed = "spotterSharedConversationViewed",
3930
+ /**
3931
+ * Emitted when the user toggles the share-modal "include new messages since
3932
+ * last shared version" checkbox.
3933
+ * @example
3934
+ * ```js
3935
+ * spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
3936
+ * // payload: { convId: string, includeNewMessages: boolean }
3937
+ * })
3938
+ * ```
3939
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3940
+ */
3941
+ SpotterShareIncludeNewMessagesCheckboxToggled = "spotterShareIncludeNewMessagesCheckboxToggled",
3942
+ /**
3943
+ * Emitted when the user dismisses the stale-snapshot info banner via its
3944
+ * cross (distinct from the include-new-messages checkbox toggle).
3945
+ * @example
3946
+ * ```js
3947
+ * spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
3948
+ * // payload: { convId: string }
3949
+ * })
3950
+ * ```
3951
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3952
+ */
3953
+ SpotterShareStaleInfoBannerDismissed = "spotterShareStaleInfoBannerDismissed",
3954
+ /**
3955
+ * Emitted when the modal Share (confirm) button is clicked — fires at click
3956
+ * time, before the save resolves. Distinct from the `SpotterConversationShared`
3957
+ * / `SpotterConversationShareRevoked` result events.
3958
+ * @example
3959
+ * ```js
3960
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
3961
+ * // payload: { convId: string }
3962
+ * })
3963
+ * ```
3964
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3965
+ */
3966
+ SpotterShareModalConfirmButtonClicked = "spotterShareModalConfirmButtonClicked",
3967
+ /**
3968
+ * Emitted when the share modal is dismissed via the Cancel button.
3969
+ * @example
3970
+ * ```js
3971
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
3972
+ * // payload: { convId: string }
3973
+ * })
3974
+ * ```
3975
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3976
+ */
3977
+ SpotterShareModalCancelButtonClicked = "spotterShareModalCancelButtonClicked",
3978
+ /**
3979
+ * Emitted when a recipient leaves the read-only shared view via the Exit
3980
+ * button.
3981
+ * @example
3982
+ * ```js
3983
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
3984
+ * // payload: { convId: string }
3985
+ * })
3986
+ * ```
3987
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3988
+ */
3989
+ SpotterSharedConversationExitButtonClicked = "spotterSharedConversationExitButtonClicked",
3990
+ /**
3991
+ * Emitted when a Spotter conversation is pinned.
3992
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
3993
+ * @example
3994
+ * ```js
3995
+ * spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
3996
+ * console.log('Conversation pinned', payload);
3997
+ * // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
3998
+ * })
3999
+ * ```
4000
+ */
4001
+ SpotterConversationPinned = "spotterConversationPinned",
4002
+ /**
4003
+ * Emitted when a Spotter conversation is unpinned.
4004
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4005
+ * @example
4006
+ * ```js
4007
+ * spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
4008
+ * console.log('Conversation unpinned', payload);
4009
+ * // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
4010
+ * })
4011
+ * ```
4012
+ */
4013
+ SpotterConversationUnpinned = "spotterConversationUnpinned",
3648
4014
  /**
3649
4015
  * Emitted when a Spotter conversation is selected/clicked.
3650
4016
  * @example
@@ -3657,6 +4023,30 @@ export declare enum EmbedEvent {
3657
4023
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
3658
4024
  */
3659
4025
  SpotterConversationSelected = "spotterConversationSelected",
4026
+ /**
4027
+ * Emitted when the Spotter agent finishes streaming/rendering a response.
4028
+ * Includes the conversation and message identifiers so the host app can
4029
+ * fetch the full conversation history via the REST API if needed.
4030
+ *
4031
+ * The payload data has the shape `{ convId: string, messageId: string }`.
4032
+ *
4033
+ * Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
4034
+ * inside the full application).
4035
+ * @example
4036
+ * ```js
4037
+ * spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
4038
+ * console.log('Spotter response complete', payload);
4039
+ * })
4040
+ * ```
4041
+ * @example
4042
+ * ```js
4043
+ * appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
4044
+ * console.log('Spotter response complete', payload);
4045
+ * })
4046
+ * ```
4047
+ * @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
4048
+ */
4049
+ SpotterResponseComplete = "spotterResponseComplete",
3660
4050
  /**
3661
4051
  * @hidden
3662
4052
  * Emitted when the auth token is about to get expired and needs to be refreshed.
@@ -4010,6 +4400,7 @@ export declare enum HostEvent {
4010
4400
  * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
4011
4401
  * console.log("iFrameURL", url);
4012
4402
  * ```
4403
+ * @returns iframeUrl - The URL currently loaded in the embedded iframe.
4013
4404
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4014
4405
  */
4015
4406
  GetIframeUrl = "GetIframeUrl",
@@ -4136,6 +4527,17 @@ export declare enum HostEvent {
4136
4527
  * name: string,
4137
4528
  * type: ATTRIBUTE/MEASURE,
4138
4529
  * dataType: INT64/CHAR/DATE }
4530
+ *
4531
+ * `applicability` - Optional. Scopes the filter to a specific target,
4532
+ * for example, a single Liveboard tab, so the panel for the correct
4533
+ * scoped filter is opened. Available from SDK: 1.53.0 |
4534
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
4535
+ *
4536
+ * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
4537
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
4538
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
4539
+ * `level` is `LIVEBOARD`, since the filter applies to the whole
4540
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
4139
4541
  * @example
4140
4542
  * ```js
4141
4543
  * searchEmbed.trigger(HostEvent.OpenFilter,
@@ -4148,6 +4550,14 @@ export declare enum HostEvent {
4148
4550
  * ```
4149
4551
  * @example
4150
4552
  * ```js
4553
+ * // Open a filter scoped to a specific Liveboard tab
4554
+ * liveboardEmbed.trigger(HostEvent.OpenFilter, {
4555
+ * column: { columnId: '<column-GUID>' },
4556
+ * applicability: { level: 'TAB', targetId: '<tab-GUID>' }
4557
+ * });
4558
+ * ```
4559
+ * @example
4560
+ * ```js
4151
4561
  * // Open filter from search context
4152
4562
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4153
4563
  * searchEmbed.trigger(HostEvent.OpenFilter, {
@@ -4157,6 +4567,73 @@ export declare enum HostEvent {
4157
4567
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4158
4568
  */
4159
4569
  OpenFilter = "openFilter",
4570
+ /**
4571
+ * Open the add-filter modal of a Liveboard, the same dialog that the
4572
+ * *Add filter* button in the Liveboard edit header opens, so the host
4573
+ * app can start the add-filter flow from its own UI.
4574
+ *
4575
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
4576
+ * Hiding the *Add filter* button with `hiddenActions:
4577
+ * [Action.AddFilter]` does not block this event, but disabling it with
4578
+ * `disabledActions` does.
4579
+ *
4580
+ * Unlike {@link HostEvent.OpenFilter}, which opens the panel of an
4581
+ * existing filter, this event starts the creation of a new filter.
4582
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4583
+ * @example
4584
+ * ```js
4585
+ * liveboardEmbed.trigger(HostEvent.OpenAddFilterModal);
4586
+ * ```
4587
+ */
4588
+ OpenAddFilterModal = "openAddFilterModal",
4589
+ /**
4590
+ * Open the add-parameter panel of a Liveboard, the same panel that the
4591
+ * *Add parameter* button in the Liveboard edit header opens.
4592
+ * Mirrors {@link HostEvent.OpenAddFilterModal} for parameters.
4593
+ *
4594
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
4595
+ * Hiding the *Add parameter* button with `hiddenActions:
4596
+ * [Action.AddParameter]` does not block this event, but disabling it
4597
+ * with `disabledActions` does.
4598
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4599
+ * @example
4600
+ * ```js
4601
+ * liveboardEmbed.trigger(HostEvent.OpenAddParameterModal);
4602
+ * ```
4603
+ */
4604
+ OpenAddParameterModal = "openAddParameterModal",
4605
+ /**
4606
+ * Open the parameter panel for a particular parameter on a Liveboard.
4607
+ * Mirrors {@link HostEvent.OpenFilter} for parameters.
4608
+ * @param - Includes the following keys:
4609
+ * - `parameter`: An object identifying the parameter to open, for
4610
+ * example, `{ parameterId: '<parameter-GUID>' }`.
4611
+ * - `applicability`: Optional. Scopes the parameter to a specific target,
4612
+ * for example, a single Liveboard tab, so the panel for the correct
4613
+ * scoped parameter is opened. Includes the following attributes:
4614
+ *
4615
+ * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
4616
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
4617
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
4618
+ * `level` is `LIVEBOARD`, since the parameter applies to the whole
4619
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
4620
+ * @example
4621
+ * ```js
4622
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
4623
+ * parameter: { parameterId: '<parameter-GUID>' }
4624
+ * });
4625
+ * ```
4626
+ * @example
4627
+ * ```js
4628
+ * // Open a parameter scoped to a specific group
4629
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
4630
+ * parameter: { parameterId: '<parameter-GUID>' },
4631
+ * applicability: { level: 'GROUP', targetId: '<group-GUID>' }
4632
+ * });
4633
+ * ```
4634
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
4635
+ */
4636
+ OpenParameter = "openParameter",
4160
4637
  /**
4161
4638
  * Add columns to the current search query.
4162
4639
  * @param - { columnIds: string[] }
@@ -4206,6 +4683,10 @@ export declare enum HostEvent {
4206
4683
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
4207
4684
  * data=>console.log(data))
4208
4685
  * ```
4686
+ * @returns data - Object with a `v2Content` string: the export request
4687
+ * payload for the current Liveboard.
4688
+ * @returns type - The passthrough event name,
4689
+ * `getExportRequestForCurrentPinboard`.
4209
4690
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
4210
4691
  */
4211
4692
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
@@ -4308,6 +4789,9 @@ export declare enum HostEvent {
4308
4789
  * }, ContextType.Spotter);
4309
4790
  * ```
4310
4791
  *
4792
+ * @returns liveboardId - GUID of the Liveboard the Answer was pinned to.
4793
+ * @returns tabId - GUID of the tab within that Liveboard.
4794
+ * @returns vizId - GUID of the newly created visualization.
4311
4795
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4312
4796
  */
4313
4797
  Pin = "pin",
@@ -4346,13 +4830,13 @@ export declare enum HostEvent {
4346
4830
  * Trigger the **Manage schedule** action on an embedded Liveboard
4347
4831
  * @example
4348
4832
  * ```js
4349
- * liveboardEmbed.trigger(HostEvent.ScheduleList)
4833
+ * liveboardEmbed.trigger(HostEvent.SchedulesList)
4350
4834
  * ```
4351
4835
  * @example
4352
4836
  * ```js
4353
4837
  * // Manage schedules from liveboard context
4354
4838
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4355
- * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
4839
+ * liveboardEmbed.trigger(HostEvent.SchedulesList, {}, ContextType.Liveboard);
4356
4840
  * ```
4357
4841
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4358
4842
  */
@@ -4797,6 +5281,7 @@ export declare enum HostEvent {
4797
5281
  * console.log(tml.answer);
4798
5282
  * });
4799
5283
  * ```
5284
+ * @returns The TML representation of the current Answer, as an object.
4800
5285
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4801
5286
  * @important
4802
5287
  */
@@ -5220,6 +5705,14 @@ export declare enum HostEvent {
5220
5705
  /**
5221
5706
  * Get details of filters applied on the Liveboard.
5222
5707
  * Returns arrays containing Liveboard filter and runtime filter elements.
5708
+ * Each Liveboard filter includes an optional `applicability` attribute
5709
+ * indicating the scope of the filter. It contains a `level`
5710
+ * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
5711
+ * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
5712
+ * level there is no `targetId`, since the filter applies to the
5713
+ * whole Liveboard.
5714
+ * The `applicability` attribute is available from SDK: 1.53.0 |
5715
+ * ThoughtSpot: 26.10.0.cl.
5223
5716
  * @example
5224
5717
  * ```js
5225
5718
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -5232,6 +5725,8 @@ export declare enum HostEvent {
5232
5725
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
5233
5726
  * console.log('filters', data);
5234
5727
  * ```
5728
+ * @returns liveboardFilters - Filters applied on the Liveboard.
5729
+ * @returns runtimeFilters - Runtime filters applied on the Liveboard.
5235
5730
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5236
5731
  */
5237
5732
  GetFilters = "getFilters",
@@ -5259,6 +5754,16 @@ export declare enum HostEvent {
5259
5754
  *
5260
5755
  * `type` - To update filters for date time, specify the date format type.
5261
5756
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
5757
+ *
5758
+ * `applicability` - Optional. Scopes the filter to a specific target,
5759
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
5760
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
5761
+ *
5762
+ * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
5763
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
5764
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
5765
+ * `level` is `LIVEBOARD`, since the filter applies to the whole
5766
+ * Liveboard.
5262
5767
  * @example
5263
5768
  * ```js
5264
5769
  *
@@ -5335,6 +5840,21 @@ export declare enum HostEvent {
5335
5840
  * }
5336
5841
  * }, ContextType.Liveboard);
5337
5842
  * ```
5843
+ * @example
5844
+ * ```js
5845
+ * // Scope the filter to a specific Liveboard tab
5846
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
5847
+ * filter: {
5848
+ * column: "item type",
5849
+ * oper: "IN",
5850
+ * values: ["bags", "shirts"],
5851
+ * applicability: {
5852
+ * level: "TAB",
5853
+ * targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
5854
+ * }
5855
+ * }
5856
+ * });
5857
+ * ```
5338
5858
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5339
5859
  */
5340
5860
  UpdateFilters = "updateFilters",
@@ -5356,9 +5876,37 @@ export declare enum HostEvent {
5356
5876
  * console.log('tabs', tabDetails);
5357
5877
  * });
5358
5878
  * ```
5879
+ * @returns orderedTabIds - Tab GUIDs in the order they appear.
5880
+ * @returns numberOfTabs - Total number of tabs on the Liveboard.
5881
+ * @returns Tabs - Tab details, each with at least `id` and `name`.
5359
5882
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5360
5883
  */
5361
5884
  GetTabs = "getTabs",
5885
+ /**
5886
+ * Get group details for the current Liveboard.
5887
+ * Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
5888
+ * @example
5889
+ * ```js
5890
+ * liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
5891
+ * console.log(
5892
+ * groupDetails // GroupDetails of current Liveboard
5893
+ * );
5894
+ * })
5895
+ * ```
5896
+ * @example
5897
+ * ```js
5898
+ * // Get groups from liveboard context
5899
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5900
+ * liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
5901
+ * console.log('groups', groupDetails);
5902
+ * });
5903
+ * ```
5904
+ * @returns orderedGroupIds - Group GUIDs in the order they appear.
5905
+ * @returns numberOfGroups - Total number of groups on the Liveboard.
5906
+ * @returns Groups - Group details, each with at least `id` and `name`.
5907
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
5908
+ */
5909
+ GetGroups = "getGroups",
5362
5910
  /**
5363
5911
  * Set the visible tabs on a Liveboard.
5364
5912
  * @param - an array of ids of tabs to show, the IDs not passed
@@ -5430,6 +5978,9 @@ export declare enum HostEvent {
5430
5978
  * // Alternative direct usage (not recommended)
5431
5979
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
5432
5980
  * ```
5981
+ * @returns session - Session identifier for the Answer, for use with the
5982
+ * `AnswerService`.
5983
+ * @returns embedAnswerData - Data backing the Answer, when available.
5433
5984
  * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
5434
5985
  */
5435
5986
  GetAnswerSession = "getAnswerSession",
@@ -5486,6 +6037,15 @@ export declare enum HostEvent {
5486
6037
  * - `name`: Name of the parameter.
5487
6038
  * - `value`: The value to set for the parameter.
5488
6039
  * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
6040
+ * - `applicability`: Optional. Scopes the parameter to a specific target,
6041
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
6042
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
6043
+ *
6044
+ * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
6045
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
6046
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
6047
+ * `level` is `LIVEBOARD`, since the parameter applies to the whole
6048
+ * Liveboard.
5489
6049
  *
5490
6050
  * @example
5491
6051
  * ```js
@@ -5497,6 +6057,18 @@ export declare enum HostEvent {
5497
6057
  * ```
5498
6058
  * @example
5499
6059
  * ```js
6060
+ * // Scope the parameter to a specific Liveboard tab
6061
+ * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
6062
+ * name: "Integer Range Param",
6063
+ * value: 10,
6064
+ * applicability: {
6065
+ * level: "TAB",
6066
+ * targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
6067
+ * }
6068
+ * }])
6069
+ * ```
6070
+ * @example
6071
+ * ```js
5500
6072
  * // Update parameters from liveboard context
5501
6073
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5502
6074
  * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -5510,6 +6082,14 @@ export declare enum HostEvent {
5510
6082
  UpdateParameters = "UpdateParameters",
5511
6083
  /**
5512
6084
  * Triggers GetParameters to fetch the runtime Parameters.
6085
+ * Each parameter includes an optional `applicability` attribute
6086
+ * indicating the scope of the parameter. It contains a `level`
6087
+ * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
6088
+ * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
6089
+ * level there is no `targetId`, since the parameter applies to the
6090
+ * whole Liveboard.
6091
+ * The `applicability` attribute is available from SDK: 1.53.0 |
6092
+ * ThoughtSpot: 26.10.0.cl.
5513
6093
  * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5514
6094
  * ```js
5515
6095
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
@@ -5534,12 +6114,16 @@ export declare enum HostEvent {
5534
6114
  * console.log('parameters', parameters);
5535
6115
  * });
5536
6116
  * ```
6117
+ * @returns parameters - Parameters currently applied on the Liveboard.
5537
6118
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5538
6119
  */
5539
6120
  GetParameters = "GetParameters",
5540
6121
  /**
5541
6122
  * Triggers an event to update a personalized view of a Liveboard.
5542
- * This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
6123
+ * This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
6124
+ * which additionally accepts a `viewName`, resets to the original view when
6125
+ * called with an empty payload, and reports an error when a named view
6126
+ * cannot be found.
5543
6127
  * ```js
5544
6128
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5545
6129
  * ```
@@ -5557,10 +6141,15 @@ export declare enum HostEvent {
5557
6141
  UpdatePersonalisedView = "UpdatePersonalisedView",
5558
6142
  /**
5559
6143
  * Triggers an event to update a personalized view of a Liveboard.
6144
+ * This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
6145
+ * which additionally accepts a `viewName`, resets to the original view when
6146
+ * called with an empty payload, and reports an error when a named view
6147
+ * cannot be found.
5560
6148
  * ```js
5561
6149
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5562
6150
  * ```
5563
6151
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6152
+ * @deprecated SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
5564
6153
  */
5565
6154
  UpdatePersonalizedView = "UpdatePersonalisedView",
5566
6155
  /**
@@ -5663,6 +6252,10 @@ export declare enum HostEvent {
5663
6252
  * description: "Generated from Spotter"
5664
6253
  * }, ContextType.Spotter);
5665
6254
  * ```
6255
+ * @returns answerId - GUID of the saved Answer.
6256
+ * @returns saveResponse - Raw response from the save operation.
6257
+ * @returns shareResponse - Raw response from the share operation, when the
6258
+ * Answer was also made discoverable.
5666
6259
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5667
6260
  */
5668
6261
  SaveAnswer = "saveAnswer",
@@ -5776,6 +6369,36 @@ export declare enum HostEvent {
5776
6369
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5777
6370
  */
5778
6371
  ResetSpotterConversation = "ResetSpotterConversation",
6372
+ /**
6373
+ * Opens the Spotter share-conversation modal for the given conversation.
6374
+ * `conversationId` is **mandatory** — you must pass the id of the
6375
+ * conversation to share. Also no-op when sharing is disabled
6376
+ * (enableShareConversation off) or when already in the read-only shared view.
6377
+ * @example
6378
+ * ```js
6379
+ * spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
6380
+ * ```
6381
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6382
+ */
6383
+ ShareSpotterConversation = "ShareSpotterConversation",
6384
+ /**
6385
+ * Closes the Spotter share-conversation modal. No-op if none is open.
6386
+ * @example
6387
+ * ```js
6388
+ * spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
6389
+ * ```
6390
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6391
+ */
6392
+ CloseSpotterShareConversation = "CloseSpotterShareConversation",
6393
+ /**
6394
+ * Exits the read-only shared-conversation view.
6395
+ * @example
6396
+ * ```js
6397
+ * spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
6398
+ * ```
6399
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6400
+ */
6401
+ ExitSpotterSharedConversation = "ExitSpotterSharedConversation",
5779
6402
  /**
5780
6403
  * Deletes the last prompt in spotter embed.
5781
6404
  * @example
@@ -5871,6 +6494,41 @@ export declare enum HostEvent {
5871
6494
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5872
6495
  */
5873
6496
  StartNewSpotterConversation = "StartNewSpotterConversation",
6497
+ /**
6498
+ * Pins a saved Spotter conversation so it floats to the top of the past
6499
+ * conversations sidebar. The `conversationId` of the conversation to pin is
6500
+ * required.
6501
+ *
6502
+ * This feature is available only when chat history is enabled on your ThoughtSpot
6503
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
6504
+ * instance.
6505
+ *
6506
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6507
+ * @example
6508
+ * ```js
6509
+ * spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
6510
+ * conversationId: '<conversation-id>',
6511
+ * });
6512
+ * ```
6513
+ */
6514
+ PinSpotterConversation = "PinSpotterConversation",
6515
+ /**
6516
+ * Unpins a previously pinned Spotter conversation. The `conversationId` of the
6517
+ * conversation to unpin is required.
6518
+ *
6519
+ * This feature is available only when chat history is enabled on your ThoughtSpot
6520
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
6521
+ * instance.
6522
+ *
6523
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6524
+ * @example
6525
+ * ```js
6526
+ * spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
6527
+ * conversationId: '<conversation-id>',
6528
+ * });
6529
+ * ```
6530
+ */
6531
+ UnpinSpotterConversation = "UnpinSpotterConversation",
5874
6532
  /**
5875
6533
  * @hidden
5876
6534
  * Get the current context of the embedded page.
@@ -6071,6 +6729,7 @@ export declare enum Param {
6071
6729
  NumberFormatLocale = "numberFormatLocale",
6072
6730
  CurrencyFormat = "currencyFormat",
6073
6731
  Enable2ColumnLayout = "enable2ColumnLayout",
6732
+ IsLiveboardAlwaysOn12ColLayout = "isLiveboardAlwaysOn12ColLayout",
6074
6733
  IsFullAppEmbed = "isFullAppEmbed",
6075
6734
  IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
6076
6735
  FocusSearchBarOnRender = "focusSearchBarOnRender",
@@ -6084,6 +6743,7 @@ export declare enum Param {
6084
6743
  SpotterEnabled = "isSpotterExperienceEnabled",
6085
6744
  IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled",
6086
6745
  OverrideOrgId = "orgId",
6746
+ OverrideHistoryState = "overrideHistoryState",
6087
6747
  OauthPollingInterval = "oAuthPollingInterval",
6088
6748
  IsForceRedirect = "isForceRedirect",
6089
6749
  DataSourceId = "dataSourceId",
@@ -6093,6 +6753,7 @@ export declare enum Param {
6093
6753
  PrimaryAction = "primaryAction",
6094
6754
  isSpotterAgentEmbed = "isSpotterAgentEmbed",
6095
6755
  IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
6756
+ LiveboardGutter = "liveboardGutter",
6096
6757
  IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
6097
6758
  RootMarginForLazyLoad = "rootMarginForLazyLoad",
6098
6759
  isPNGInScheduledEmailsEnabled = "isPNGInScheduledEmailsEnabled",
@@ -6101,9 +6762,12 @@ export declare enum Param {
6101
6762
  isGranularXLSXCSVSchedulesEnabled = "isGranularXLSXCSVSchedulesEnabled",
6102
6763
  isSendNowLiveboardSchedulingEnabled = "isSendNowLiveboardSchedulingEnabled",
6103
6764
  isCentralizedLiveboardFilterUXEnabled = "isCentralizedLiveboardFilterUXEnabled",
6765
+ isScopedLiveboardFilteringEnabled = "isScopedLiveboardFilteringEnabled",
6104
6766
  isLinkParametersEnabled = "isLinkParametersEnabled",
6105
6767
  EnablePastConversationsSidebar = "enablePastConversationsSidebar",
6106
6768
  UpdatedSpotterChatPrompt = "updatedSpotterChatPrompt",
6769
+ ShowSpotterRadiance = "showSpotterRadiance",
6770
+ DefaultQueryMode = "defaultQueryMode",
6107
6771
  EnableStopAnswerGenerationEmbed = "enableStopAnswerGenerationEmbed",
6108
6772
  SpotterSidebarTitle = "spotterSidebarTitle",
6109
6773
  SpotterSidebarDefaultExpanded = "spotterSidebarDefaultExpanded",
@@ -6122,7 +6786,11 @@ export declare enum Param {
6122
6786
  EnableLiveboardDataCache = "enableLiveboardDataCache",
6123
6787
  SpotterFileUploadEnabled = "spotterFileUploadEnabled",
6124
6788
  SpotterFileUploadFileTypes = "spotterFileUploadFileTypes",
6125
- IsStarterPromptsEnabled = "enableStarterPrompts"
6789
+ IsStarterPromptsEnabled = "enableStarterPrompts",
6790
+ UpdatedSpotterExperience = "updatedSpotterExperience",
6791
+ SpotterDataSources = "spotterDataSources",
6792
+ AnalystId = "analystId",
6793
+ OpenSpotterOnLiveboardByDefault = "openSpotterOnLiveboardByDefault"
6126
6794
  }
6127
6795
  /**
6128
6796
  * Configuration for allowed file types in Spotter file upload.
@@ -6135,9 +6803,10 @@ export type SpotterFileUploadFileTypes = {
6135
6803
  * ThoughtSpot application pages include actions and menu commands
6136
6804
  * for various user-initiated operations. These actions are represented
6137
6805
  * as enumeration members in the SDK. To control actions in the embedded view:
6138
- * - disabledActions — the action is grayed out and still visible, but non-interactive (user can see but not click).
6139
- * - hiddenActions — the action is completely removed from the UI (user cannot see it at all).
6140
- * - visibleActions — allowlist, only these actions are shown; all others are hidden.
6806
+ * - disabledActions — the action is grayed out and still visible, but non-interactive
6807
+ * (user can see but not click). - hiddenActions — the action is completely removed from
6808
+ * the UI (user cannot see it at all). - visibleActions — allowlist, only these actions
6809
+ * are shown; all others are hidden.
6141
6810
  *
6142
6811
  * Use disabledActions to disable (gray out) an action.
6143
6812
  * Use hiddenActions to hide (fully remove) an action.
@@ -6190,6 +6859,17 @@ export declare enum Action {
6190
6859
  * ```
6191
6860
  */
6192
6861
  SaveAsView = "saveAsView",
6862
+ /**
6863
+ * The **EditInputTable** action on a Liveboard
6864
+ * page. Allows users to edit an input table used in an Answer directly from
6865
+ * a Liveboard.
6866
+ * @example
6867
+ * ```js
6868
+ * disabledActions: [Action.EditInputTable]
6869
+ * ```
6870
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6871
+ */
6872
+ EditInputTable = "editInputTable",
6193
6873
  /**
6194
6874
  * The **Make a copy** action on a Liveboard or Answer
6195
6875
  * page. Creates a copy of the Liveboard.
@@ -7391,6 +8071,19 @@ export declare enum Action {
7391
8071
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
7392
8072
  */
7393
8073
  ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
8074
+ /**
8075
+ * Action ID to show, hide, or disable all filter surfaces on a Liveboard,
8076
+ * including filter, parameter, and cross-filter chips at the liveboard,
8077
+ * tab, and group levels. Parameter and cross-filter chips are hide-only.
8078
+ *
8079
+ * @example
8080
+ * ```js
8081
+ * hiddenActions: [Action.AllLiveboardFilters]
8082
+ * disabledActions: [Action.AllLiveboardFilters]
8083
+ * ```
8084
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
8085
+ */
8086
+ AllLiveboardFilters = "allLiveboardFilters",
7394
8087
  /**
7395
8088
  * The **Data model instructions** button on the Spotter interface.
7396
8089
  * Allows opening the data model instructions modal.
@@ -7492,6 +8185,10 @@ export declare enum Action {
7492
8185
  * The **Add to Coaching** feature allows adding reference questions and
7493
8186
  * business terms to improve Spotter’s responses. This feature is generally available
7494
8187
  * (GA) from version 26.2.0.cl and enabled by default on embed deployments.
8188
+ *
8189
+ * This action governs both the answer-card **Add to memory** CTA and its
8190
+ * Spotter 3 successor, the response-footer **Remember this** CTA
8191
+ * (they are mutually exclusive).
7495
8192
  * @example
7496
8193
  * ```js
7497
8194
  * hiddenAction: [Action.InConversationTraining]
@@ -7726,6 +8423,89 @@ export declare enum Action {
7726
8423
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7727
8424
  */
7728
8425
  SpotterChatRename = "spotterChatRename",
8426
+ /**
8427
+ * Controls visibility and disable state of the Spotter conversation Share
8428
+ * button in the chat header. Only takes effect once sharing is enabled
8429
+ * (enableShareConversation on).
8430
+ * @example
8431
+ * ```js
8432
+ * disabledActions: [Action.SpotterShareConversationButtonHeader]
8433
+ * ```
8434
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8435
+ */
8436
+ SpotterShareConversationButtonHeader = "spotterShareConversationButtonHeader",
8437
+ /**
8438
+ * Controls visibility and disable state of the Share item in the Spotter
8439
+ * conversation history (sidebar) edit menu. Independent of the header button
8440
+ * above, so a host can show Share in one entry point and hide it in the other.
8441
+ * @example
8442
+ * ```js
8443
+ * disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
8444
+ * ```
8445
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8446
+ */
8447
+ SpotterShareConversationMenuItemSidebar = "spotterShareConversationMenuItemSidebar",
8448
+ /**
8449
+ * Controls visibility of the entire read-only shared-conversation data-access
8450
+ * banner shown when a recipient opens a shared view. Hide-only.
8451
+ * @example
8452
+ * ```js
8453
+ * hiddenActions: [Action.SpotterSharedConversationBanner]
8454
+ * ```
8455
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8456
+ */
8457
+ SpotterSharedConversationBanner = "spotterSharedConversationBanner",
8458
+ /**
8459
+ * Controls visibility and disable state of the cross/close button on the
8460
+ * read-only shared-conversation data-access banner (keeps the banner itself).
8461
+ * @example
8462
+ * ```js
8463
+ * hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
8464
+ * ```
8465
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8466
+ */
8467
+ SpotterSharedConversationBannerDismissButton = "spotterSharedConversationBannerDismissButton",
8468
+ /**
8469
+ * Controls visibility and disable state of the Exit button in the read-only
8470
+ * shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
8471
+ * host event.
8472
+ * @example
8473
+ * ```js
8474
+ * hiddenActions: [Action.SpotterSharedConversationExitButton]
8475
+ * ```
8476
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8477
+ */
8478
+ SpotterSharedConversationExitButton = "spotterSharedConversationExitButton",
8479
+ /**
8480
+ * Controls visibility of the share-modal footer note ("Chat will be shared up
8481
+ * to the current moment…"). Hide-only.
8482
+ * @example
8483
+ * ```js
8484
+ * hiddenActions: [Action.SpotterShareUpToCurrentInfo]
8485
+ * ```
8486
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8487
+ */
8488
+ SpotterShareUpToCurrentInfo = "spotterShareUpToCurrentInfo",
8489
+ /**
8490
+ * Controls visibility and disable state of the share-modal "include new
8491
+ * messages since last shared version" checkbox.
8492
+ * @example
8493
+ * ```js
8494
+ * disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
8495
+ * ```
8496
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8497
+ */
8498
+ SpotterShareIncludeNewMessagesCheckbox = "spotterShareIncludeNewMessagesCheckbox",
8499
+ /**
8500
+ * Controls visibility and disable state of the cross on the share-modal
8501
+ * stale-snapshot info banner.
8502
+ * @example
8503
+ * ```js
8504
+ * hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
8505
+ * ```
8506
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8507
+ */
8508
+ SpotterShareStaleInfoBannerDismissButton = "spotterShareStaleInfoBannerDismissButton",
7729
8509
  /**
7730
8510
  * Controls visibility and disable state of the delete action
7731
8511
  * in the Spotter conversation edit menu.
@@ -7736,6 +8516,16 @@ export declare enum Action {
7736
8516
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7737
8517
  */
7738
8518
  SpotterChatDelete = "spotterChatDelete",
8519
+ /**
8520
+ * Controls visibility and disable state of the pin/unpin action
8521
+ * in the Spotter conversation edit menu.
8522
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
8523
+ * @example
8524
+ * ```js
8525
+ * disabledActions: [Action.SpotterChatPin]
8526
+ * ```
8527
+ */
8528
+ SpotterChatPin = "spotterChatPin",
7739
8529
  /**
7740
8530
  * Controls visibility and disable state of the documentation/best practices
7741
8531
  * link in the Spotter sidebar footer.
@@ -7779,6 +8569,56 @@ export declare enum Action {
7779
8569
  * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
7780
8570
  */
7781
8571
  SpotterChatModeSwitcher = "spotterChatModeSwitcher",
8572
+ /**
8573
+ * The **Basic Search** starter prompt pill.
8574
+ *
8575
+ * Starter prompt pills are the row of category buttons shown above the
8576
+ * Spotter chat input before a conversation starts. They give a new user
8577
+ * ready-made questions to click instead of typing one from scratch, and
8578
+ * disappear once the conversation begins. There are three, one per action
8579
+ * below.
8580
+ *
8581
+ * Clicking this pill opens a card of suggested simple questions; picking one
8582
+ * submits it to Spotter right away. Visible by default, and hidden along
8583
+ * with the other pills when the surface itself is off (see
8584
+ * {@link SpotterChatViewConfig.starterPrompts}).
8585
+ * @example
8586
+ * ```js
8587
+ * hiddenActions: [Action.QuickSearchPill]
8588
+ * ```
8589
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8590
+ */
8591
+ QuickSearchPill = "quickSearchPill",
8592
+ /**
8593
+ * The **Deep Analysis** starter prompt pill, next to
8594
+ * {@link Action.QuickSearchPill} above the Spotter chat input.
8595
+ *
8596
+ * Clicking it opens a card of suggested investigative questions ("why did
8597
+ * revenue drop?"). Picking one fills the chat input in Deep Analysis mode
8598
+ * rather than submitting immediately, so the user can edit it first.
8599
+ * Visible by default.
8600
+ * @example
8601
+ * ```js
8602
+ * hiddenActions: [Action.DeepAnalysisPill]
8603
+ * ```
8604
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8605
+ */
8606
+ DeepAnalysisPill = "deepAnalysisPill",
8607
+ /**
8608
+ * The **Data Literacy** starter prompt pill, next to
8609
+ * {@link Action.QuickSearchPill} above the Spotter chat input.
8610
+ *
8611
+ * Unlike the other two pills it opens no card: clicking it submits a prompt
8612
+ * that describes the data the model can answer over, helping a user who does
8613
+ * not yet know what is in the data source. The prompt text always comes from
8614
+ * ThoughtSpot, so only its label is customizable. Visible by default.
8615
+ * @example
8616
+ * ```js
8617
+ * hiddenActions: [Action.DataLiteracyPill]
8618
+ * ```
8619
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8620
+ */
8621
+ DataLiteracyPill = "dataLiteracyPill",
7782
8622
  /**
7783
8623
  * The **Include current period** checkbox for date filters.
7784
8624
  * Controls the visibility and availability of the option to include
@@ -7926,7 +8766,39 @@ export declare enum Action {
7926
8766
  * disabledActions: [Action.SpotterAnalystSidebar]
7927
8767
  * ```
7928
8768
  */
7929
- SpotterAnalystSidebar = "spotterAnalystSidebar"
8769
+ SpotterAnalystSidebar = "spotterAnalystSidebar",
8770
+ /**
8771
+ * Controls visibility and disable state of the analyst list
8772
+ * ("Show all") in the Spotter Analyst interface.
8773
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
8774
+ * @example
8775
+ * ```js
8776
+ * hiddenActions: [Action.SpotterAnalystList]
8777
+ * disabledActions: [Action.SpotterAnalystList]
8778
+ * ```
8779
+ */
8780
+ SpotterAnalystList = "spotterAnalystList",
8781
+ /**
8782
+ * Controls visibility and disable state of the default Spotter analyst
8783
+ * entry in the Spotter Analyst interface.
8784
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
8785
+ * @example
8786
+ * ```js
8787
+ * hiddenActions: [Action.SpotterDefaultAnalyst]
8788
+ * disabledActions: [Action.SpotterDefaultAnalyst]
8789
+ * ```
8790
+ */
8791
+ SpotterDefaultAnalyst = "spotterDefaultAnalyst",
8792
+ /**
8793
+ * The **Spotter** button in the Liveboard header.
8794
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
8795
+ * @example
8796
+ * ```js
8797
+ * hiddenActions: [Action.SpotterOnLiveboard]
8798
+ * disabledActions: [Action.SpotterOnLiveboard]
8799
+ * ```
8800
+ */
8801
+ SpotterOnLiveboard = "spotterOnLiveboard"
7930
8802
  }
7931
8803
  export interface AnswerServiceType {
7932
8804
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -8267,7 +9139,9 @@ export declare enum EmbedErrorCodes {
8267
9139
  /** UpdateFilters payload is invalid - missing or malformed filter/filters */
8268
9140
  UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
8269
9141
  /** DrillDown payload is invalid - missing or malformed points */
8270
- DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
9142
+ DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD",
9143
+ /** UpdateParameters payload is invalid - malformed applicability */
9144
+ UPDATEPARAMETERS_INVALID_PAYLOAD = "UPDATEPARAMETERS_INVALID_PAYLOAD"
8271
9145
  }
8272
9146
  /**
8273
9147
  * Error event object emitted when an error occurs in an embedded component.
@@ -8420,7 +9294,7 @@ export type ApiInterceptFlags = {
8420
9294
  * const embed = new LiveboardEmbed('#embed', {
8421
9295
  * ...viewConfig,
8422
9296
  * enableApiIntercept: true,
8423
- * interceptUrls: [InterceptedApiType.DATA],
9297
+ * interceptUrls: [InterceptedApiType.LiveboardData],
8424
9298
  * })
8425
9299
  * ```
8426
9300
  *