@thoughtspot/visual-embed-sdk 1.50.1 → 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 (238) 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 +63 -0
  7. package/cjs/src/css-variables.d.ts.map +1 -1
  8. package/cjs/src/embed/app.d.ts +148 -25
  9. package/cjs/src/embed/app.d.ts.map +1 -1
  10. package/cjs/src/embed/app.js +74 -37
  11. package/cjs/src/embed/app.js.map +1 -1
  12. package/cjs/src/embed/app.spec.js +571 -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 +375 -2
  17. package/cjs/src/embed/conversation.d.ts.map +1 -1
  18. package/cjs/src/embed/conversation.js +21 -15
  19. package/cjs/src/embed/conversation.js.map +1 -1
  20. package/cjs/src/embed/conversation.spec.js +323 -17
  21. package/cjs/src/embed/conversation.spec.js.map +1 -1
  22. package/cjs/src/embed/events.spec.js +45 -0
  23. package/cjs/src/embed/events.spec.js.map +1 -1
  24. package/cjs/src/embed/host-events.spec.js +81 -0
  25. package/cjs/src/embed/host-events.spec.js.map +1 -1
  26. package/cjs/src/embed/hostEventClient/contracts.d.ts +15 -0
  27. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  28. package/cjs/src/embed/hostEventClient/contracts.js +1 -0
  29. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  30. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +1 -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 +1 -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 +27 -0
  35. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  36. package/cjs/src/embed/liveboard.d.ts +76 -14
  37. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  38. package/cjs/src/embed/liveboard.js +50 -9
  39. package/cjs/src/embed/liveboard.js.map +1 -1
  40. package/cjs/src/embed/liveboard.spec.js +432 -4
  41. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  42. package/cjs/src/embed/spotter-utils.d.ts +15 -1
  43. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  44. package/cjs/src/embed/spotter-utils.js +28 -1
  45. package/cjs/src/embed/spotter-utils.js.map +1 -1
  46. package/cjs/src/embed/spotter-utils.spec.js +129 -0
  47. package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
  48. package/cjs/src/embed/spotter-viz-utils.d.ts +9 -10
  49. package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
  50. package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
  51. package/cjs/src/embed/ts-embed.d.ts +16 -8
  52. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  53. package/cjs/src/embed/ts-embed.js +82 -30
  54. package/cjs/src/embed/ts-embed.js.map +1 -1
  55. package/cjs/src/embed/ts-embed.spec.js +537 -3
  56. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  57. package/cjs/src/index.d.ts +3 -3
  58. package/cjs/src/index.d.ts.map +1 -1
  59. package/cjs/src/index.js +3 -2
  60. package/cjs/src/index.js.map +1 -1
  61. package/cjs/src/mixpanel-service.d.ts +4 -0
  62. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  63. package/cjs/src/mixpanel-service.js +4 -0
  64. package/cjs/src/mixpanel-service.js.map +1 -1
  65. package/cjs/src/react/all-types-export.d.ts +1 -1
  66. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  67. package/cjs/src/react/all-types-export.js +2 -1
  68. package/cjs/src/react/all-types-export.js.map +1 -1
  69. package/cjs/src/react/all-types-export.parity.spec.d.ts +2 -0
  70. package/cjs/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  71. package/cjs/src/react/all-types-export.parity.spec.js +194 -0
  72. package/cjs/src/react/all-types-export.parity.spec.js.map +1 -0
  73. package/cjs/src/react/index.d.ts +66 -32
  74. package/cjs/src/react/index.d.ts.map +1 -1
  75. package/cjs/src/react/index.js +5 -3
  76. package/cjs/src/react/index.js.map +1 -1
  77. package/cjs/src/react/index.spec.js +101 -0
  78. package/cjs/src/react/index.spec.js.map +1 -1
  79. package/cjs/src/types.d.ts +789 -32
  80. package/cjs/src/types.d.ts.map +1 -1
  81. package/cjs/src/types.js +610 -20
  82. package/cjs/src/types.js.map +1 -1
  83. package/cjs/src/utils.spec.js +4 -0
  84. package/cjs/src/utils.spec.js.map +1 -1
  85. package/dist/{index-fCne7kmU.js → index-Bivg-mDx.js} +1 -1
  86. package/dist/src/config.d.ts +1 -0
  87. package/dist/src/config.d.ts.map +1 -1
  88. package/dist/src/css-variables.d.ts +63 -0
  89. package/dist/src/css-variables.d.ts.map +1 -1
  90. package/dist/src/embed/app.d.ts +148 -25
  91. package/dist/src/embed/app.d.ts.map +1 -1
  92. package/dist/src/embed/base.d.ts +1 -1
  93. package/dist/src/embed/conversation.d.ts +375 -2
  94. package/dist/src/embed/conversation.d.ts.map +1 -1
  95. package/dist/src/embed/hostEventClient/contracts.d.ts +15 -0
  96. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  97. package/dist/src/embed/hostEventClient/host-event-client.d.ts +1 -1
  98. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  99. package/dist/src/embed/liveboard.d.ts +76 -14
  100. package/dist/src/embed/liveboard.d.ts.map +1 -1
  101. package/dist/src/embed/spotter-utils.d.ts +15 -1
  102. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  103. package/dist/src/embed/spotter-viz-utils.d.ts +9 -10
  104. package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
  105. package/dist/src/embed/ts-embed.d.ts +16 -8
  106. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  107. package/dist/src/index.d.ts +3 -3
  108. package/dist/src/index.d.ts.map +1 -1
  109. package/dist/src/mixpanel-service.d.ts +4 -0
  110. package/dist/src/mixpanel-service.d.ts.map +1 -1
  111. package/dist/src/react/all-types-export.d.ts +1 -1
  112. package/dist/src/react/all-types-export.d.ts.map +1 -1
  113. package/dist/src/react/all-types-export.parity.spec.d.ts +2 -0
  114. package/dist/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  115. package/dist/src/react/index.d.ts +66 -32
  116. package/dist/src/react/index.d.ts.map +1 -1
  117. package/dist/src/types.d.ts +789 -32
  118. package/dist/src/types.d.ts.map +1 -1
  119. package/dist/tsembed-react.es.js +878 -120
  120. package/dist/tsembed-react.js +877 -119
  121. package/dist/tsembed.es.js +936 -181
  122. package/dist/tsembed.js +938 -183
  123. package/dist/visual-embed-sdk-react-full.d.ts +1553 -128
  124. package/dist/visual-embed-sdk-react.d.ts +1555 -129
  125. package/dist/visual-embed-sdk.d.ts +1499 -100
  126. package/lib/package.json +1 -1
  127. package/lib/src/config.d.ts +1 -0
  128. package/lib/src/config.d.ts.map +1 -1
  129. package/lib/src/config.js +1 -0
  130. package/lib/src/config.js.map +1 -1
  131. package/lib/src/css-variables.d.ts +63 -0
  132. package/lib/src/css-variables.d.ts.map +1 -1
  133. package/lib/src/embed/app.d.ts +148 -25
  134. package/lib/src/embed/app.d.ts.map +1 -1
  135. package/lib/src/embed/app.js +75 -38
  136. package/lib/src/embed/app.js.map +1 -1
  137. package/lib/src/embed/app.spec.js +572 -151
  138. package/lib/src/embed/app.spec.js.map +1 -1
  139. package/lib/src/embed/base.d.ts +1 -1
  140. package/lib/src/embed/base.js +1 -1
  141. package/lib/src/embed/conversation.d.ts +375 -2
  142. package/lib/src/embed/conversation.d.ts.map +1 -1
  143. package/lib/src/embed/conversation.js +23 -17
  144. package/lib/src/embed/conversation.js.map +1 -1
  145. package/lib/src/embed/conversation.spec.js +323 -17
  146. package/lib/src/embed/conversation.spec.js.map +1 -1
  147. package/lib/src/embed/events.spec.js +45 -0
  148. package/lib/src/embed/events.spec.js.map +1 -1
  149. package/lib/src/embed/host-events.spec.js +81 -0
  150. package/lib/src/embed/host-events.spec.js.map +1 -1
  151. package/lib/src/embed/hostEventClient/contracts.d.ts +15 -0
  152. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  153. package/lib/src/embed/hostEventClient/contracts.js +1 -0
  154. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  155. package/lib/src/embed/hostEventClient/host-event-client.d.ts +1 -1
  156. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  157. package/lib/src/embed/hostEventClient/host-event-client.js +1 -0
  158. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  159. package/lib/src/embed/hostEventClient/host-event-client.spec.js +27 -0
  160. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  161. package/lib/src/embed/liveboard.d.ts +76 -14
  162. package/lib/src/embed/liveboard.d.ts.map +1 -1
  163. package/lib/src/embed/liveboard.js +50 -9
  164. package/lib/src/embed/liveboard.js.map +1 -1
  165. package/lib/src/embed/liveboard.spec.js +432 -4
  166. package/lib/src/embed/liveboard.spec.js.map +1 -1
  167. package/lib/src/embed/spotter-utils.d.ts +15 -1
  168. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  169. package/lib/src/embed/spotter-utils.js +25 -0
  170. package/lib/src/embed/spotter-utils.js.map +1 -1
  171. package/lib/src/embed/spotter-utils.spec.js +130 -1
  172. package/lib/src/embed/spotter-utils.spec.js.map +1 -1
  173. package/lib/src/embed/spotter-viz-utils.d.ts +9 -10
  174. package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
  175. package/lib/src/embed/spotter-viz-utils.js.map +1 -1
  176. package/lib/src/embed/ts-embed.d.ts +16 -8
  177. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  178. package/lib/src/embed/ts-embed.js +82 -30
  179. package/lib/src/embed/ts-embed.js.map +1 -1
  180. package/lib/src/embed/ts-embed.spec.js +537 -3
  181. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  182. package/lib/src/index.d.ts +3 -3
  183. package/lib/src/index.d.ts.map +1 -1
  184. package/lib/src/index.js +2 -2
  185. package/lib/src/index.js.map +1 -1
  186. package/lib/src/mixpanel-service.d.ts +4 -0
  187. package/lib/src/mixpanel-service.d.ts.map +1 -1
  188. package/lib/src/mixpanel-service.js +4 -0
  189. package/lib/src/mixpanel-service.js.map +1 -1
  190. package/lib/src/react/all-types-export.d.ts +1 -1
  191. package/lib/src/react/all-types-export.d.ts.map +1 -1
  192. package/lib/src/react/all-types-export.js +1 -1
  193. package/lib/src/react/all-types-export.js.map +1 -1
  194. package/lib/src/react/all-types-export.parity.spec.d.ts +2 -0
  195. package/lib/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  196. package/lib/src/react/all-types-export.parity.spec.js +191 -0
  197. package/lib/src/react/all-types-export.parity.spec.js.map +1 -0
  198. package/lib/src/react/index.d.ts +66 -32
  199. package/lib/src/react/index.d.ts.map +1 -1
  200. package/lib/src/react/index.js +5 -3
  201. package/lib/src/react/index.js.map +1 -1
  202. package/lib/src/react/index.spec.js +102 -1
  203. package/lib/src/react/index.spec.js.map +1 -1
  204. package/lib/src/types.d.ts +789 -32
  205. package/lib/src/types.d.ts.map +1 -1
  206. package/lib/src/types.js +610 -20
  207. package/lib/src/types.js.map +1 -1
  208. package/lib/src/utils.spec.js +4 -0
  209. package/lib/src/utils.spec.js.map +1 -1
  210. package/lib/src/visual-embed-sdk.d.ts +1499 -100
  211. package/package.json +1 -1
  212. package/src/config.ts +1 -0
  213. package/src/css-variables.ts +77 -0
  214. package/src/embed/app.spec.ts +729 -188
  215. package/src/embed/app.ts +240 -75
  216. package/src/embed/base.ts +1 -1
  217. package/src/embed/conversation.spec.ts +379 -20
  218. package/src/embed/conversation.ts +412 -18
  219. package/src/embed/events.spec.ts +56 -0
  220. package/src/embed/host-events.spec.ts +118 -0
  221. package/src/embed/hostEventClient/contracts.ts +16 -0
  222. package/src/embed/hostEventClient/host-event-client.spec.ts +46 -0
  223. package/src/embed/hostEventClient/host-event-client.ts +3 -2
  224. package/src/embed/liveboard.spec.ts +565 -4
  225. package/src/embed/liveboard.ts +150 -29
  226. package/src/embed/spotter-utils.spec.ts +140 -1
  227. package/src/embed/spotter-utils.ts +36 -1
  228. package/src/embed/spotter-viz-utils.ts +9 -10
  229. package/src/embed/ts-embed.spec.ts +699 -3
  230. package/src/embed/ts-embed.ts +99 -35
  231. package/src/index.ts +44 -2
  232. package/src/mixpanel-service.ts +4 -0
  233. package/src/react/all-types-export.parity.spec.ts +208 -0
  234. package/src/react/all-types-export.ts +22 -0
  235. package/src/react/index.spec.tsx +158 -0
  236. package/src/react/index.tsx +70 -33
  237. package/src/types.ts +791 -30
  238. package/src/utils.spec.ts +5 -0
package/lib/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 {
@@ -858,6 +860,85 @@ export interface FrameParams {
858
860
  */
859
861
  [key: string]: string | number | boolean | undefined;
860
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
+ }
861
942
  /**
862
943
  * The common configuration object for an embedded view.
863
944
  */
@@ -942,7 +1023,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
942
1023
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
943
1024
  * const embed = new <EmbedComponent>('#tsEmbed', {
944
1025
  * ... // other embed view config
945
- * hiddenActions: [Action.Download, Action.Export],
1026
+ * hiddenActions: [Action.Download, Action.ExportTML],
946
1027
  * });
947
1028
  * ```
948
1029
  * @important
@@ -964,7 +1045,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
964
1045
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
965
1046
  * const embed = new <EmbedComponent>('#tsEmbed', {
966
1047
  * ... // other embed view config
967
- * visibleActions: [Action.Download, Action.Export],
1048
+ * visibleActions: [Action.Download, Action.ExportTML],
968
1049
  * });
969
1050
  * ```
970
1051
  */
@@ -1049,6 +1130,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1049
1130
  *
1050
1131
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1051
1132
  * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1133
+ * @deprecated Use {@link PreRenderConfig.preRenderId} via `preRenderConfig` instead.
1052
1134
  * @example
1053
1135
  * ```js
1054
1136
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1068,6 +1150,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1068
1150
  * @type {boolean}
1069
1151
  * @default false
1070
1152
  * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
1153
+ * @deprecated Use {@link PreRenderConfig.doNotTrackPreRenderSize} via `preRenderConfig` instead.
1071
1154
  * @example
1072
1155
  * ```js
1073
1156
  * // Disable tracking PreRender size in the configuration
@@ -1109,6 +1192,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1109
1192
  *
1110
1193
  * @type {string | HTMLElement}
1111
1194
  * @version SDK: 1.49.2 | ThoughtSpot: *
1195
+ * @deprecated Use {@link PreRenderConfig.preRenderContainer} via `preRenderConfig` instead.
1112
1196
  * @example
1113
1197
  * ```js
1114
1198
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -1119,6 +1203,27 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1119
1203
  * ```
1120
1204
  */
1121
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;
1122
1227
  /**
1123
1228
  * Enable the V2 shell. This can provide performance benefits
1124
1229
  * due to a lighter-weight shell.
@@ -1557,7 +1662,7 @@ export interface HomePageConfig {
1557
1662
  *
1558
1663
  * const embed = new AppEmbed('#tsEmbed', {
1559
1664
  * ... //other embed view config
1560
- * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
1665
+ * hiddenListColumns : [ListPageColumns.Favorites,ListPageColumns.Author],
1561
1666
  * })
1562
1667
  * ```
1563
1668
  */
@@ -1567,7 +1672,9 @@ export interface HomePageConfig {
1567
1672
  * To specify the modules, import the `HomepageModule` enum.
1568
1673
  * For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
1569
1674
  *
1570
- * **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.
1571
1678
  *
1572
1679
  * Supported embed types: `AppEmbed`
1573
1680
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1576,7 +1683,7 @@ export interface HomePageConfig {
1576
1683
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
1577
1684
  *
1578
1685
  * const embed = new AppEmbed('#tsEmbed', {
1579
- * ... // V2/V3 navigation and home page experience attributes
1686
+ * ... // V3 navigation and home page experience attributes
1580
1687
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
1581
1688
  * //...other embed view configuration attributes
1582
1689
  * })
@@ -1587,8 +1694,11 @@ export interface HomePageConfig {
1587
1694
  * Reorder home page modules.
1588
1695
  * To specify the modules, import the `HomepageModule` enum.
1589
1696
  * For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
1590
- * HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
1591
- * 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.
1592
1702
  *
1593
1703
  * Supported embed types: `AppEmbed`
1594
1704
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1597,7 +1707,7 @@ export interface HomePageConfig {
1597
1707
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
1598
1708
  *
1599
1709
  * const embed = new AppEmbed('#tsEmbed', {
1600
- * ...//V2/V3 navigation and home page experience attributes
1710
+ * ...//V3 navigation and home page experience attributes
1601
1711
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
1602
1712
  * //... other embed view configuration attributes
1603
1713
  * })
@@ -1609,7 +1719,9 @@ export interface HomePageConfig {
1609
1719
  * on the home page left navigation panel.
1610
1720
  * To specify the menu items, import the `HomeLeftNavItem` enum.
1611
1721
  *
1612
- * **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.
1613
1725
  *
1614
1726
  * Supported embed types: `AppEmbed`
1615
1727
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1863,6 +1975,25 @@ export interface LiveboardAppEmbedViewConfig {
1863
1975
  * ```
1864
1976
  */
1865
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;
1866
1997
  /**
1867
1998
  * This flag can be used to enable the compact header in Liveboard
1868
1999
  *
@@ -1967,6 +2098,26 @@ export interface LiveboardAppEmbedViewConfig {
1967
2098
  * ```
1968
2099
  */
1969
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;
1970
2121
  /**
1971
2122
  * This flag is used to enable or disable the new centralized Liveboard filter UX
1972
2123
  * (v2). When enabled, a unified modal is used to manage and update multiple filters
@@ -1985,6 +2136,24 @@ export interface LiveboardAppEmbedViewConfig {
1985
2136
  * ```
1986
2137
  */
1987
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;
1988
2157
  /**
1989
2158
  * This flag is used to enable or disable the link parameters in liveboard.
1990
2159
  *
@@ -2183,7 +2352,9 @@ export declare enum RuntimeFilterOp {
2183
2352
  * via `hiddenHomepageModules` and reordered via
2184
2353
  * `reorderedHomepageModules`.
2185
2354
  *
2186
- * **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.
2187
2358
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2188
2359
  */
2189
2360
  export declare enum HomepageModule {
@@ -2392,7 +2563,7 @@ export declare enum EmbedEvent {
2392
2563
  * @returns nonFilteredColumns - The columns that were not filtered
2393
2564
  * @example
2394
2565
  * ```js
2395
- * searchEmbed.on(EmbedEvent.DrillDown, {
2566
+ * searchEmbed.on(EmbedEvent.Drilldown, {
2396
2567
  * points: {
2397
2568
  * clickedPoint,
2398
2569
  * selectedPoints: selectedPoint
@@ -2453,7 +2624,7 @@ export declare enum EmbedEvent {
2453
2624
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2454
2625
  * @example
2455
2626
  * ```js
2456
- * appEmbed.on(EmbedEvent.customAction, payload => {
2627
+ * appEmbed.on(EmbedEvent.CustomAction, payload => {
2457
2628
  * const data = payload.data;
2458
2629
  * if (data.id === 'insert Custom Action ID here') {
2459
2630
  * console.log('Custom Action event:', data.embedAnswerData);
@@ -2719,8 +2890,8 @@ export declare enum EmbedEvent {
2719
2890
  *
2720
2891
  * **Note**: This event is deprecated in v1.21.0.
2721
2892
  * To fire an event when a download action is initiated on a chart or table,
2722
- * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
2723
- * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
2893
+ * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPdf`,
2894
+ * `EmbedEvent.DownloadAsCsv`, or `EmbedEvent.DownloadAsXlsx`
2724
2895
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2725
2896
  * @example
2726
2897
  * ```js
@@ -2770,10 +2941,10 @@ export declare enum EmbedEvent {
2770
2941
  * @example
2771
2942
  * ```js
2772
2943
  * //emit when action starts
2773
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2944
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
2774
2945
  * console.log('download CSV', payload)}, {start: true })
2775
2946
  * //emit when action ends
2776
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2947
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
2777
2948
  * console.log('download CSV', payload)})
2778
2949
  * ```
2779
2950
  */
@@ -3172,11 +3343,19 @@ export declare enum EmbedEvent {
3172
3343
  * Emitted when a user changes any filter on a Liveboard.
3173
3344
  * Returns filter type and name, column name and ID, and runtime
3174
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.
3175
3353
  * @example
3176
3354
  *
3177
3355
  * ```js
3178
3356
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3179
3357
  * console.log('payload', payload);
3358
+ * // payload.data optionally includes applicability: { level, targetId }
3180
3359
  * })
3181
3360
  * ```
3182
3361
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
@@ -3368,9 +3547,17 @@ export declare enum EmbedEvent {
3368
3547
  /**
3369
3548
  * Emitted when parameter changes in an Answer
3370
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.
3371
3557
  * ```js
3372
3558
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
3373
3559
  * console.log('payload', payload);
3560
+ * // payload.data optionally includes applicability: { level, targetId }
3374
3561
  * })
3375
3562
  * ```
3376
3563
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
@@ -3672,6 +3859,158 @@ export declare enum EmbedEvent {
3672
3859
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
3673
3860
  */
3674
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",
3675
4014
  /**
3676
4015
  * Emitted when a Spotter conversation is selected/clicked.
3677
4016
  * @example
@@ -4061,6 +4400,7 @@ export declare enum HostEvent {
4061
4400
  * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
4062
4401
  * console.log("iFrameURL", url);
4063
4402
  * ```
4403
+ * @returns iframeUrl - The URL currently loaded in the embedded iframe.
4064
4404
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4065
4405
  */
4066
4406
  GetIframeUrl = "GetIframeUrl",
@@ -4187,6 +4527,17 @@ export declare enum HostEvent {
4187
4527
  * name: string,
4188
4528
  * type: ATTRIBUTE/MEASURE,
4189
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.
4190
4541
  * @example
4191
4542
  * ```js
4192
4543
  * searchEmbed.trigger(HostEvent.OpenFilter,
@@ -4199,6 +4550,14 @@ export declare enum HostEvent {
4199
4550
  * ```
4200
4551
  * @example
4201
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
4202
4561
  * // Open filter from search context
4203
4562
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4204
4563
  * searchEmbed.trigger(HostEvent.OpenFilter, {
@@ -4208,6 +4567,73 @@ export declare enum HostEvent {
4208
4567
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4209
4568
  */
4210
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",
4211
4637
  /**
4212
4638
  * Add columns to the current search query.
4213
4639
  * @param - { columnIds: string[] }
@@ -4257,6 +4683,10 @@ export declare enum HostEvent {
4257
4683
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
4258
4684
  * data=>console.log(data))
4259
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`.
4260
4690
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
4261
4691
  */
4262
4692
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
@@ -4359,6 +4789,9 @@ export declare enum HostEvent {
4359
4789
  * }, ContextType.Spotter);
4360
4790
  * ```
4361
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.
4362
4795
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4363
4796
  */
4364
4797
  Pin = "pin",
@@ -4397,13 +4830,13 @@ export declare enum HostEvent {
4397
4830
  * Trigger the **Manage schedule** action on an embedded Liveboard
4398
4831
  * @example
4399
4832
  * ```js
4400
- * liveboardEmbed.trigger(HostEvent.ScheduleList)
4833
+ * liveboardEmbed.trigger(HostEvent.SchedulesList)
4401
4834
  * ```
4402
4835
  * @example
4403
4836
  * ```js
4404
4837
  * // Manage schedules from liveboard context
4405
4838
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4406
- * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
4839
+ * liveboardEmbed.trigger(HostEvent.SchedulesList, {}, ContextType.Liveboard);
4407
4840
  * ```
4408
4841
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4409
4842
  */
@@ -4848,6 +5281,7 @@ export declare enum HostEvent {
4848
5281
  * console.log(tml.answer);
4849
5282
  * });
4850
5283
  * ```
5284
+ * @returns The TML representation of the current Answer, as an object.
4851
5285
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4852
5286
  * @important
4853
5287
  */
@@ -5271,13 +5705,13 @@ export declare enum HostEvent {
5271
5705
  /**
5272
5706
  * Get details of filters applied on the Liveboard.
5273
5707
  * Returns arrays containing Liveboard filter and runtime filter elements.
5274
- * Each Liveboard filter may include an `applicability` attribute
5708
+ * Each Liveboard filter includes an optional `applicability` attribute
5275
5709
  * indicating the scope of the filter. It contains a `level`
5276
5710
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
5277
5711
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
5278
5712
  * level there is no `targetId`, since the filter applies to the
5279
5713
  * whole Liveboard.
5280
- * The `applicability` attribute is available from SDK: 1.51.0 |
5714
+ * The `applicability` attribute is available from SDK: 1.53.0 |
5281
5715
  * ThoughtSpot: 26.10.0.cl.
5282
5716
  * @example
5283
5717
  * ```js
@@ -5291,6 +5725,8 @@ export declare enum HostEvent {
5291
5725
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
5292
5726
  * console.log('filters', data);
5293
5727
  * ```
5728
+ * @returns liveboardFilters - Filters applied on the Liveboard.
5729
+ * @returns runtimeFilters - Runtime filters applied on the Liveboard.
5294
5730
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5295
5731
  */
5296
5732
  GetFilters = "getFilters",
@@ -5320,7 +5756,7 @@ export declare enum HostEvent {
5320
5756
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
5321
5757
  *
5322
5758
  * `applicability` - Optional. Scopes the filter to a specific target,
5323
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
5759
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
5324
5760
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
5325
5761
  *
5326
5762
  * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -5440,9 +5876,37 @@ export declare enum HostEvent {
5440
5876
  * console.log('tabs', tabDetails);
5441
5877
  * });
5442
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`.
5443
5882
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5444
5883
  */
5445
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",
5446
5910
  /**
5447
5911
  * Set the visible tabs on a Liveboard.
5448
5912
  * @param - an array of ids of tabs to show, the IDs not passed
@@ -5514,6 +5978,9 @@ export declare enum HostEvent {
5514
5978
  * // Alternative direct usage (not recommended)
5515
5979
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
5516
5980
  * ```
5981
+ * @returns session - Session identifier for the Answer, for use with the
5982
+ * `AnswerService`.
5983
+ * @returns embedAnswerData - Data backing the Answer, when available.
5517
5984
  * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
5518
5985
  */
5519
5986
  GetAnswerSession = "getAnswerSession",
@@ -5571,7 +6038,7 @@ export declare enum HostEvent {
5571
6038
  * - `value`: The value to set for the parameter.
5572
6039
  * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
5573
6040
  * - `applicability`: Optional. Scopes the parameter to a specific target,
5574
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
6041
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
5575
6042
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
5576
6043
  *
5577
6044
  * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -5615,13 +6082,13 @@ export declare enum HostEvent {
5615
6082
  UpdateParameters = "UpdateParameters",
5616
6083
  /**
5617
6084
  * Triggers GetParameters to fetch the runtime Parameters.
5618
- * Each parameter may include an `applicability` attribute
6085
+ * Each parameter includes an optional `applicability` attribute
5619
6086
  * indicating the scope of the parameter. It contains a `level`
5620
6087
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
5621
6088
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
5622
6089
  * level there is no `targetId`, since the parameter applies to the
5623
6090
  * whole Liveboard.
5624
- * The `applicability` attribute is available from SDK: 1.51.0 |
6091
+ * The `applicability` attribute is available from SDK: 1.53.0 |
5625
6092
  * ThoughtSpot: 26.10.0.cl.
5626
6093
  * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5627
6094
  * ```js
@@ -5647,12 +6114,16 @@ export declare enum HostEvent {
5647
6114
  * console.log('parameters', parameters);
5648
6115
  * });
5649
6116
  * ```
6117
+ * @returns parameters - Parameters currently applied on the Liveboard.
5650
6118
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5651
6119
  */
5652
6120
  GetParameters = "GetParameters",
5653
6121
  /**
5654
6122
  * Triggers an event to update a personalized view of a Liveboard.
5655
- * 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.
5656
6127
  * ```js
5657
6128
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5658
6129
  * ```
@@ -5670,10 +6141,15 @@ export declare enum HostEvent {
5670
6141
  UpdatePersonalisedView = "UpdatePersonalisedView",
5671
6142
  /**
5672
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.
5673
6148
  * ```js
5674
6149
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5675
6150
  * ```
5676
6151
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6152
+ * @deprecated SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
5677
6153
  */
5678
6154
  UpdatePersonalizedView = "UpdatePersonalisedView",
5679
6155
  /**
@@ -5776,6 +6252,10 @@ export declare enum HostEvent {
5776
6252
  * description: "Generated from Spotter"
5777
6253
  * }, ContextType.Spotter);
5778
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.
5779
6259
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5780
6260
  */
5781
6261
  SaveAnswer = "saveAnswer",
@@ -5889,6 +6369,36 @@ export declare enum HostEvent {
5889
6369
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5890
6370
  */
5891
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",
5892
6402
  /**
5893
6403
  * Deletes the last prompt in spotter embed.
5894
6404
  * @example
@@ -5984,6 +6494,41 @@ export declare enum HostEvent {
5984
6494
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5985
6495
  */
5986
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",
5987
6532
  /**
5988
6533
  * @hidden
5989
6534
  * Get the current context of the embedded page.
@@ -6184,6 +6729,7 @@ export declare enum Param {
6184
6729
  NumberFormatLocale = "numberFormatLocale",
6185
6730
  CurrencyFormat = "currencyFormat",
6186
6731
  Enable2ColumnLayout = "enable2ColumnLayout",
6732
+ IsLiveboardAlwaysOn12ColLayout = "isLiveboardAlwaysOn12ColLayout",
6187
6733
  IsFullAppEmbed = "isFullAppEmbed",
6188
6734
  IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
6189
6735
  FocusSearchBarOnRender = "focusSearchBarOnRender",
@@ -6207,6 +6753,7 @@ export declare enum Param {
6207
6753
  PrimaryAction = "primaryAction",
6208
6754
  isSpotterAgentEmbed = "isSpotterAgentEmbed",
6209
6755
  IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
6756
+ LiveboardGutter = "liveboardGutter",
6210
6757
  IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
6211
6758
  RootMarginForLazyLoad = "rootMarginForLazyLoad",
6212
6759
  isPNGInScheduledEmailsEnabled = "isPNGInScheduledEmailsEnabled",
@@ -6215,9 +6762,11 @@ export declare enum Param {
6215
6762
  isGranularXLSXCSVSchedulesEnabled = "isGranularXLSXCSVSchedulesEnabled",
6216
6763
  isSendNowLiveboardSchedulingEnabled = "isSendNowLiveboardSchedulingEnabled",
6217
6764
  isCentralizedLiveboardFilterUXEnabled = "isCentralizedLiveboardFilterUXEnabled",
6765
+ isScopedLiveboardFilteringEnabled = "isScopedLiveboardFilteringEnabled",
6218
6766
  isLinkParametersEnabled = "isLinkParametersEnabled",
6219
6767
  EnablePastConversationsSidebar = "enablePastConversationsSidebar",
6220
6768
  UpdatedSpotterChatPrompt = "updatedSpotterChatPrompt",
6769
+ ShowSpotterRadiance = "showSpotterRadiance",
6221
6770
  DefaultQueryMode = "defaultQueryMode",
6222
6771
  EnableStopAnswerGenerationEmbed = "enableStopAnswerGenerationEmbed",
6223
6772
  SpotterSidebarTitle = "spotterSidebarTitle",
@@ -6237,7 +6786,11 @@ export declare enum Param {
6237
6786
  EnableLiveboardDataCache = "enableLiveboardDataCache",
6238
6787
  SpotterFileUploadEnabled = "spotterFileUploadEnabled",
6239
6788
  SpotterFileUploadFileTypes = "spotterFileUploadFileTypes",
6240
- IsStarterPromptsEnabled = "enableStarterPrompts"
6789
+ IsStarterPromptsEnabled = "enableStarterPrompts",
6790
+ UpdatedSpotterExperience = "updatedSpotterExperience",
6791
+ SpotterDataSources = "spotterDataSources",
6792
+ AnalystId = "analystId",
6793
+ OpenSpotterOnLiveboardByDefault = "openSpotterOnLiveboardByDefault"
6241
6794
  }
6242
6795
  /**
6243
6796
  * Configuration for allowed file types in Spotter file upload.
@@ -6250,9 +6803,10 @@ export type SpotterFileUploadFileTypes = {
6250
6803
  * ThoughtSpot application pages include actions and menu commands
6251
6804
  * for various user-initiated operations. These actions are represented
6252
6805
  * as enumeration members in the SDK. To control actions in the embedded view:
6253
- * - disabledActions — the action is grayed out and still visible, but non-interactive (user can see but not click).
6254
- * - hiddenActions — the action is completely removed from the UI (user cannot see it at all).
6255
- * - 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.
6256
6810
  *
6257
6811
  * Use disabledActions to disable (gray out) an action.
6258
6812
  * Use hiddenActions to hide (fully remove) an action.
@@ -6305,6 +6859,17 @@ export declare enum Action {
6305
6859
  * ```
6306
6860
  */
6307
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",
6308
6873
  /**
6309
6874
  * The **Make a copy** action on a Liveboard or Answer
6310
6875
  * page. Creates a copy of the Liveboard.
@@ -7506,6 +8071,19 @@ export declare enum Action {
7506
8071
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
7507
8072
  */
7508
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",
7509
8087
  /**
7510
8088
  * The **Data model instructions** button on the Spotter interface.
7511
8089
  * Allows opening the data model instructions modal.
@@ -7607,6 +8185,10 @@ export declare enum Action {
7607
8185
  * The **Add to Coaching** feature allows adding reference questions and
7608
8186
  * business terms to improve Spotter’s responses. This feature is generally available
7609
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).
7610
8192
  * @example
7611
8193
  * ```js
7612
8194
  * hiddenAction: [Action.InConversationTraining]
@@ -7841,6 +8423,89 @@ export declare enum Action {
7841
8423
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7842
8424
  */
7843
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",
7844
8509
  /**
7845
8510
  * Controls visibility and disable state of the delete action
7846
8511
  * in the Spotter conversation edit menu.
@@ -7851,6 +8516,16 @@ export declare enum Action {
7851
8516
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7852
8517
  */
7853
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",
7854
8529
  /**
7855
8530
  * Controls visibility and disable state of the documentation/best practices
7856
8531
  * link in the Spotter sidebar footer.
@@ -7894,6 +8569,56 @@ export declare enum Action {
7894
8569
  * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
7895
8570
  */
7896
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",
7897
8622
  /**
7898
8623
  * The **Include current period** checkbox for date filters.
7899
8624
  * Controls the visibility and availability of the option to include
@@ -8041,7 +8766,39 @@ export declare enum Action {
8041
8766
  * disabledActions: [Action.SpotterAnalystSidebar]
8042
8767
  * ```
8043
8768
  */
8044
- 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"
8045
8802
  }
8046
8803
  export interface AnswerServiceType {
8047
8804
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -8537,7 +9294,7 @@ export type ApiInterceptFlags = {
8537
9294
  * const embed = new LiveboardEmbed('#embed', {
8538
9295
  * ...viewConfig,
8539
9296
  * enableApiIntercept: true,
8540
- * interceptUrls: [InterceptedApiType.DATA],
9297
+ * interceptUrls: [InterceptedApiType.LiveboardData],
8541
9298
  * })
8542
9299
  * ```
8543
9300
  *