@thoughtspot/visual-embed-sdk 1.26.1 → 1.27.0-alpha.0

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 (274) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +2 -2
  3. package/cjs/src/auth.d.ts +4 -16
  4. package/cjs/src/auth.d.ts.map +1 -1
  5. package/cjs/src/auth.js +26 -58
  6. package/cjs/src/auth.js.map +1 -1
  7. package/cjs/src/auth.spec.d.ts.map +1 -1
  8. package/cjs/src/auth.spec.js +42 -32
  9. package/cjs/src/auth.spec.js.map +1 -1
  10. package/cjs/src/authToken.d.ts +4 -0
  11. package/cjs/src/authToken.d.ts.map +1 -0
  12. package/cjs/src/authToken.js +61 -0
  13. package/cjs/src/authToken.js.map +1 -0
  14. package/cjs/src/embed/app.d.ts +15 -15
  15. package/cjs/src/embed/app.d.ts.map +1 -1
  16. package/cjs/src/embed/app.js +1 -1
  17. package/cjs/src/embed/app.js.map +1 -1
  18. package/cjs/src/embed/base.d.ts +0 -9
  19. package/cjs/src/embed/base.d.ts.map +1 -1
  20. package/cjs/src/embed/base.js +21 -44
  21. package/cjs/src/embed/base.js.map +1 -1
  22. package/cjs/src/embed/base.spec.js +15 -14
  23. package/cjs/src/embed/base.spec.js.map +1 -1
  24. package/cjs/src/embed/embedConfig.d.ts +18 -0
  25. package/cjs/src/embed/embedConfig.d.ts.map +1 -0
  26. package/cjs/src/embed/embedConfig.js +25 -0
  27. package/cjs/src/embed/embedConfig.js.map +1 -0
  28. package/cjs/src/embed/liveboard.d.ts +28 -23
  29. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  30. package/cjs/src/embed/liveboard.js +4 -3
  31. package/cjs/src/embed/liveboard.js.map +1 -1
  32. package/cjs/src/embed/sage.d.ts +48 -30
  33. package/cjs/src/embed/sage.d.ts.map +1 -1
  34. package/cjs/src/embed/sage.js +1 -1
  35. package/cjs/src/embed/sage.js.map +1 -1
  36. package/cjs/src/embed/search-bar.d.ts +22 -6
  37. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  38. package/cjs/src/embed/search-bar.js.map +1 -1
  39. package/cjs/src/embed/search.d.ts +34 -19
  40. package/cjs/src/embed/search.d.ts.map +1 -1
  41. package/cjs/src/embed/search.js +10 -4
  42. package/cjs/src/embed/search.js.map +1 -1
  43. package/cjs/src/embed/search.spec.js +10 -0
  44. package/cjs/src/embed/search.spec.js.map +1 -1
  45. package/cjs/src/embed/searchEmbed-basic-auth.spec.js +3 -2
  46. package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +1 -1
  47. package/cjs/src/embed/ts-embed.d.ts +1 -0
  48. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  49. package/cjs/src/embed/ts-embed.js +30 -8
  50. package/cjs/src/embed/ts-embed.js.map +1 -1
  51. package/cjs/src/embed/ts-embed.spec.js +145 -22
  52. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  53. package/cjs/src/index.d.ts +2 -1
  54. package/cjs/src/index.d.ts.map +1 -1
  55. package/cjs/src/index.js +2 -1
  56. package/cjs/src/index.js.map +1 -1
  57. package/cjs/src/react/index.spec.js +0 -12
  58. package/cjs/src/react/index.spec.js.map +1 -1
  59. package/cjs/src/tokenizedFetch.d.ts +2 -0
  60. package/cjs/src/tokenizedFetch.d.ts.map +1 -0
  61. package/cjs/src/tokenizedFetch.js +20 -0
  62. package/cjs/src/tokenizedFetch.js.map +1 -0
  63. package/cjs/src/types.d.ts +733 -242
  64. package/cjs/src/types.d.ts.map +1 -1
  65. package/cjs/src/types.js +653 -175
  66. package/cjs/src/types.js.map +1 -1
  67. package/cjs/src/utils/{authService.d.ts → authService/authService.d.ts} +12 -11
  68. package/cjs/src/utils/authService/authService.d.ts.map +1 -0
  69. package/cjs/src/utils/{authService.js → authService/authService.js} +31 -39
  70. package/cjs/src/utils/authService/authService.js.map +1 -0
  71. package/cjs/src/utils/authService/authService.spec.d.ts.map +1 -0
  72. package/cjs/src/utils/{authService.spec.js → authService/authService.spec.js} +11 -12
  73. package/cjs/src/utils/authService/authService.spec.js.map +1 -0
  74. package/cjs/src/utils/authService/index.d.ts +3 -0
  75. package/cjs/src/utils/authService/index.d.ts.map +1 -0
  76. package/cjs/src/utils/authService/index.js +14 -0
  77. package/cjs/src/utils/authService/index.js.map +1 -0
  78. package/cjs/src/utils/authService/tokenizedAuthService.d.ts +11 -0
  79. package/cjs/src/utils/authService/tokenizedAuthService.d.ts.map +1 -0
  80. package/cjs/src/utils/authService/tokenizedAuthService.js +44 -0
  81. package/cjs/src/utils/authService/tokenizedAuthService.js.map +1 -0
  82. package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -4
  83. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  84. package/cjs/src/utils/graphql/answerService/answerService.js +4 -5
  85. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  86. package/cjs/src/utils/graphql/answerService/answerService.spec.js +15 -3
  87. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  88. package/cjs/src/utils/processData.d.ts +6 -0
  89. package/cjs/src/utils/processData.d.ts.map +1 -1
  90. package/cjs/src/utils/processData.js +10 -5
  91. package/cjs/src/utils/processData.js.map +1 -1
  92. package/cjs/src/utils/processData.spec.js +8 -7
  93. package/cjs/src/utils/processData.spec.js.map +1 -1
  94. package/cjs/src/utils/processTrigger.js +1 -1
  95. package/dist/src/auth.d.ts +4 -16
  96. package/dist/src/auth.d.ts.map +1 -1
  97. package/dist/src/auth.spec.d.ts.map +1 -1
  98. package/dist/src/authToken.d.ts +4 -0
  99. package/dist/src/authToken.d.ts.map +1 -0
  100. package/dist/src/embed/app.d.ts +15 -15
  101. package/dist/src/embed/app.d.ts.map +1 -1
  102. package/dist/src/embed/base.d.ts +0 -9
  103. package/dist/src/embed/base.d.ts.map +1 -1
  104. package/dist/src/embed/embedConfig.d.ts +18 -0
  105. package/dist/src/embed/embedConfig.d.ts.map +1 -0
  106. package/dist/src/embed/liveboard.d.ts +28 -23
  107. package/dist/src/embed/liveboard.d.ts.map +1 -1
  108. package/dist/src/embed/sage.d.ts +48 -30
  109. package/dist/src/embed/sage.d.ts.map +1 -1
  110. package/dist/src/embed/search-bar.d.ts +22 -6
  111. package/dist/src/embed/search-bar.d.ts.map +1 -1
  112. package/dist/src/embed/search.d.ts +34 -19
  113. package/dist/src/embed/search.d.ts.map +1 -1
  114. package/dist/src/embed/ts-embed.d.ts +1 -0
  115. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  116. package/dist/src/index.d.ts +2 -1
  117. package/dist/src/index.d.ts.map +1 -1
  118. package/dist/src/tokenizedFetch.d.ts +2 -0
  119. package/dist/src/tokenizedFetch.d.ts.map +1 -0
  120. package/dist/src/types.d.ts +733 -242
  121. package/dist/src/types.d.ts.map +1 -1
  122. package/{lib/src/utils → dist/src/utils/authService}/authService.d.ts +44 -43
  123. package/dist/src/utils/authService/authService.d.ts.map +1 -0
  124. package/dist/src/utils/authService/index.d.ts +3 -0
  125. package/dist/src/utils/authService/index.d.ts.map +1 -0
  126. package/dist/src/utils/authService/tokenizedAuthService.d.ts +11 -0
  127. package/dist/src/utils/authService/tokenizedAuthService.d.ts.map +1 -0
  128. package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -4
  129. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  130. package/dist/src/utils/processData.d.ts +6 -0
  131. package/dist/src/utils/processData.d.ts.map +1 -1
  132. package/dist/tsembed-react.es.js +906 -339
  133. package/dist/tsembed-react.js +905 -338
  134. package/dist/tsembed.es.js +938 -370
  135. package/dist/tsembed.js +936 -368
  136. package/dist/visual-embed-sdk-react-full.d.ts +921 -360
  137. package/dist/visual-embed-sdk-react.d.ts +921 -360
  138. package/dist/visual-embed-sdk.d.ts +921 -360
  139. package/lib/package.json +2 -2
  140. package/lib/src/auth.d.ts +4 -16
  141. package/lib/src/auth.d.ts.map +1 -1
  142. package/lib/src/auth.js +21 -52
  143. package/lib/src/auth.js.map +1 -1
  144. package/lib/src/auth.spec.d.ts.map +1 -1
  145. package/lib/src/auth.spec.js +42 -32
  146. package/lib/src/auth.spec.js.map +1 -1
  147. package/lib/src/authToken.d.ts +4 -0
  148. package/lib/src/authToken.d.ts.map +1 -0
  149. package/lib/src/authToken.js +56 -0
  150. package/lib/src/authToken.js.map +1 -0
  151. package/lib/src/embed/app.d.ts +15 -15
  152. package/lib/src/embed/app.d.ts.map +1 -1
  153. package/lib/src/embed/app.js +1 -1
  154. package/lib/src/embed/app.js.map +1 -1
  155. package/lib/src/embed/base.d.ts +0 -9
  156. package/lib/src/embed/base.d.ts.map +1 -1
  157. package/lib/src/embed/base.js +21 -43
  158. package/lib/src/embed/base.js.map +1 -1
  159. package/lib/src/embed/base.spec.js +15 -14
  160. package/lib/src/embed/base.spec.js.map +1 -1
  161. package/lib/src/embed/embedConfig.d.ts +18 -0
  162. package/lib/src/embed/embedConfig.d.ts.map +1 -0
  163. package/lib/src/embed/embedConfig.js +20 -0
  164. package/lib/src/embed/embedConfig.js.map +1 -0
  165. package/lib/src/embed/liveboard.d.ts +28 -23
  166. package/lib/src/embed/liveboard.d.ts.map +1 -1
  167. package/lib/src/embed/liveboard.js +4 -3
  168. package/lib/src/embed/liveboard.js.map +1 -1
  169. package/lib/src/embed/sage.d.ts +48 -30
  170. package/lib/src/embed/sage.d.ts.map +1 -1
  171. package/lib/src/embed/sage.js +1 -1
  172. package/lib/src/embed/sage.js.map +1 -1
  173. package/lib/src/embed/search-bar.d.ts +22 -6
  174. package/lib/src/embed/search-bar.d.ts.map +1 -1
  175. package/lib/src/embed/search-bar.js.map +1 -1
  176. package/lib/src/embed/search.d.ts +34 -19
  177. package/lib/src/embed/search.d.ts.map +1 -1
  178. package/lib/src/embed/search.js +11 -5
  179. package/lib/src/embed/search.js.map +1 -1
  180. package/lib/src/embed/search.spec.js +10 -0
  181. package/lib/src/embed/search.spec.js.map +1 -1
  182. package/lib/src/embed/searchEmbed-basic-auth.spec.js +3 -2
  183. package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -1
  184. package/lib/src/embed/ts-embed.d.ts +1 -0
  185. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  186. package/lib/src/embed/ts-embed.js +32 -10
  187. package/lib/src/embed/ts-embed.js.map +1 -1
  188. package/lib/src/embed/ts-embed.spec.js +145 -22
  189. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  190. package/lib/src/index.d.ts +2 -1
  191. package/lib/src/index.d.ts.map +1 -1
  192. package/lib/src/index.js +2 -1
  193. package/lib/src/index.js.map +1 -1
  194. package/lib/src/react/index.spec.js +0 -12
  195. package/lib/src/react/index.spec.js.map +1 -1
  196. package/lib/src/tokenizedFetch.d.ts +2 -0
  197. package/lib/src/tokenizedFetch.d.ts.map +1 -0
  198. package/lib/src/tokenizedFetch.js +16 -0
  199. package/lib/src/tokenizedFetch.js.map +1 -0
  200. package/lib/src/types.d.ts +733 -242
  201. package/lib/src/types.d.ts.map +1 -1
  202. package/lib/src/types.js +653 -175
  203. package/lib/src/types.js.map +1 -1
  204. package/{dist/src/utils → lib/src/utils/authService}/authService.d.ts +44 -43
  205. package/lib/src/utils/authService/authService.d.ts.map +1 -0
  206. package/lib/src/utils/{authService.js → authService/authService.js} +26 -32
  207. package/lib/src/utils/authService/authService.js.map +1 -0
  208. package/lib/src/utils/authService/authService.spec.d.ts.map +1 -0
  209. package/lib/src/utils/{authService.spec.js → authService/authService.spec.js} +1 -2
  210. package/lib/src/utils/authService/authService.spec.js.map +1 -0
  211. package/lib/src/utils/authService/index.d.ts +3 -0
  212. package/lib/src/utils/authService/index.d.ts.map +1 -0
  213. package/lib/src/utils/authService/index.js +3 -0
  214. package/lib/src/utils/authService/index.js.map +1 -0
  215. package/lib/src/utils/authService/tokenizedAuthService.d.ts +11 -0
  216. package/lib/src/utils/authService/tokenizedAuthService.d.ts.map +1 -0
  217. package/lib/src/utils/authService/tokenizedAuthService.js +39 -0
  218. package/lib/src/utils/authService/tokenizedAuthService.js.map +1 -0
  219. package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -4
  220. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  221. package/lib/src/utils/graphql/answerService/answerService.js +4 -5
  222. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  223. package/lib/src/utils/graphql/answerService/answerService.spec.js +14 -3
  224. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  225. package/lib/src/utils/processData.d.ts +6 -0
  226. package/lib/src/utils/processData.d.ts.map +1 -1
  227. package/lib/src/utils/processData.js +8 -4
  228. package/lib/src/utils/processData.js.map +1 -1
  229. package/lib/src/utils/processData.spec.js +8 -7
  230. package/lib/src/utils/processData.spec.js.map +1 -1
  231. package/lib/src/utils/processTrigger.js +1 -1
  232. package/lib/src/visual-embed-sdk.d.ts +926 -361
  233. package/package.json +2 -2
  234. package/src/auth.spec.ts +77 -63
  235. package/src/auth.ts +22 -59
  236. package/src/authToken.ts +66 -0
  237. package/src/embed/app.ts +20 -20
  238. package/src/embed/base.spec.ts +18 -17
  239. package/src/embed/base.ts +26 -51
  240. package/src/embed/embedConfig.ts +23 -0
  241. package/src/embed/liveboard.ts +32 -27
  242. package/src/embed/sage.ts +48 -30
  243. package/src/embed/search-bar.tsx +22 -6
  244. package/src/embed/search.spec.ts +13 -0
  245. package/src/embed/search.ts +51 -31
  246. package/src/embed/searchEmbed-basic-auth.spec.ts +3 -2
  247. package/src/embed/ts-embed.spec.ts +189 -45
  248. package/src/embed/ts-embed.ts +33 -24
  249. package/src/index.ts +8 -2
  250. package/src/react/index.spec.tsx +0 -29
  251. package/src/tokenizedFetch.ts +18 -0
  252. package/src/types.ts +761 -266
  253. package/src/utils/{authService.spec.ts → authService/authService.spec.ts} +2 -3
  254. package/src/utils/{authService.ts → authService/authService.ts} +29 -34
  255. package/src/utils/authService/index.ts +9 -0
  256. package/src/utils/authService/tokenizedAuthService.ts +40 -0
  257. package/src/utils/graphql/answerService/answerService.spec.ts +16 -4
  258. package/src/utils/graphql/answerService/answerService.ts +4 -5
  259. package/src/utils/processData.spec.ts +19 -16
  260. package/src/utils/processData.ts +7 -3
  261. package/src/utils/processTrigger.ts +1 -1
  262. package/cjs/src/utils/authService.d.ts.map +0 -1
  263. package/cjs/src/utils/authService.js.map +0 -1
  264. package/cjs/src/utils/authService.spec.d.ts.map +0 -1
  265. package/cjs/src/utils/authService.spec.js.map +0 -1
  266. package/dist/src/utils/authService.d.ts.map +0 -1
  267. package/lib/src/utils/authService.d.ts.map +0 -1
  268. package/lib/src/utils/authService.js.map +0 -1
  269. package/lib/src/utils/authService.spec.d.ts.map +0 -1
  270. package/lib/src/utils/authService.spec.js.map +0 -1
  271. /package/cjs/src/utils/{authService.spec.d.ts → authService/authService.spec.d.ts} +0 -0
  272. /package/dist/src/utils/{authService.spec.d.ts → authService/authService.spec.d.ts} +0 -0
  273. /package/dist/src/utils/{authService.spec.d.ts.map → authService/authService.spec.d.ts.map} +0 -0
  274. /package/lib/src/utils/{authService.spec.d.ts → authService/authService.spec.d.ts} +0 -0
@@ -231,25 +231,41 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
231
231
  export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
232
232
  /**
233
233
  * The array of data source GUIDs to set on load.
234
- * Only a single dataSource supported currently.
234
+ * Only a single data source is supported currently.
235
235
  *
236
- * @deprecated Use dataSource instead
236
+ * @deprecated Use `dataSource` instead
237
237
  */
238
238
  dataSources?: string[];
239
239
  /**
240
240
  * The array of data source GUIDs to set on load.
241
241
  *
242
- * @version: SDK: 1.19.0
242
+ * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
243
243
  */
244
244
  dataSource?: string;
245
245
  /**
246
- * Flag to set if last selected dataSource should be used
246
+ * Boolean to define if the last selected data source should be used
247
247
  *
248
- * @version: SDK: 1.24.0
248
+ * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
249
249
  */
250
250
  useLastSelectedSources?: boolean;
251
251
  /**
252
- * Configuration for search options
252
+ * Configuration for search options.
253
+ * Includes the following properties:
254
+ *
255
+ * `searchTokenString`: Search tokens to pass in the query.
256
+ *
257
+ * `executeSearch`: Boolean to define if the search should be executed or not.
258
+ * If it is executed, the focus is placed on the results.
259
+ * If it’s not executed, the focus is placed at the end of
260
+ * the token string in the search bar.
261
+ *
262
+ * @example
263
+ * ```js
264
+ * searchOptions: {
265
+ * searchTokenString: '[quantity purchased] [region]',
266
+ * executeSearch: true,
267
+ * }
268
+ * ```
253
269
  */
254
270
  searchOptions?: SearchOptions;
255
271
  }
@@ -285,14 +301,14 @@ export declare class SearchBarEmbed extends TsEmbed {
285
301
  */
286
302
  export interface SearchOptions {
287
303
  /**
288
- * The query string to pre-fill in natual language search bar
304
+ * The query string to pass for Natural Language Search.
289
305
  */
290
306
  searchQuery: string;
291
307
  /**
292
- * Boolean to determine if the search should be executed or not.
293
- * if it is executed, put the focus on the results.
294
- * if it’s not executed, put the focus in the search bar - at the end of
295
- * the tokens
308
+ * Boolean to define if the search should be executed or not.
309
+ * If it is executed, the focus is placed on the results.
310
+ * If it’s not executed, the focus is placed at the end of
311
+ * the token string in the search bar.
296
312
  */
297
313
  executeSearch?: boolean;
298
314
  }
@@ -300,16 +316,16 @@ export interface SearchOptions {
300
316
  * The configuration attributes for the embedded Natural language search view. Based on
301
317
  * GPT and LLM.
302
318
  *
303
- * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
319
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
304
320
  * @group Embed components
305
321
  */
306
322
  export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
307
323
  /**
308
- * If set to true, a list of liveboard and answers related
324
+ * If set to true, a list of Liveboard and Answers related
309
325
  * to the natural language search will be shown below the
310
326
  * AI generated answer.
311
327
  *
312
- * @deprecated Currently liveboard and answers related
328
+ * @deprecated Currently Liveboard and Answers related
313
329
  * to the natural language search will not be shown for sage
314
330
  * embed
315
331
  */
@@ -326,63 +342,81 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
326
342
  */
327
343
  isProductTour?: boolean;
328
344
  /**
329
- * flag to hide search bar title. default false.
345
+ * Show or hide the search bar title.
330
346
  *
331
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
347
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
332
348
  */
333
349
  hideSearchBarTitle?: boolean;
334
350
  /**
335
- * flag to disable Sage Answer header(`AI Answer` title section on top of the Sage
336
- * answer). default false.
351
+ * Show or hide the Answer header, that is, the `AI Answer` title
352
+ * at the top of the Answer page.
337
353
  *
338
- * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
354
+ * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
339
355
  */
340
356
  hideSageAnswerHeader?: boolean;
341
357
  /**
342
- * flag to disable changing worksheet. default false.
358
+ * Disable the worksheet selection option.
343
359
  *
344
- * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
360
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
345
361
  */
346
362
  disableWorksheetChange?: boolean;
347
363
  /**
348
- * flag to hide worksheet selector. default false.
364
+ * Hide the worksheet selection panel.
365
+ *
366
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
349
367
  */
350
368
  hideWorksheetSelector?: boolean;
351
369
  /**
352
- * If set to true, the search bar auto complete search suggestions will not be shown.
353
- * default false
370
+ * Show or hide autocomplete suggestions for the search query string.
354
371
  *
355
- * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
372
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
356
373
  */
357
374
  hideAutocompleteSuggestions?: boolean;
358
375
  /**
359
- * If set to false, the auto complete search suggestions not be shown
376
+ * Show or hide autocomplete suggestions for the search query string.
360
377
  *
361
- * @deprecated currently, object suggestions will not be shown for sage embed
362
- * earlier this flag was used to show Auto complete suggestions
378
+ * @deprecated
379
+ * Currently, the object suggestions will not be shown for Natural Language Search.
380
+ * You can use {@link hideAutocompleteSuggestions} instead.
363
381
  */
364
382
  showObjectSuggestions?: boolean;
365
383
  /**
366
- * If set to true, sample questions would be hidden to user.
367
- * These sample questions are autogenerated based on selected datasource.
384
+ * Show or hide sample questions.
385
+ * The sample questions are autogenerated based on the worksheet
386
+ * selected for the search operation.
368
387
  *
369
- * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
388
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
370
389
  */
371
390
  hideSampleQuestions?: boolean;
372
391
  /**
373
- * The data source GUID to set on load.
392
+ * The data source GUID (Worksheet GUID) to set on load.
374
393
  */
375
394
  dataSource?: string;
376
395
  /**
377
- * Configuration for search options
396
+ * Includes the following properties:
378
397
  *
379
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
398
+ * `searchQuery`: The search query string to pass in the search bar.
399
+ * Supports Natural Language Search queries.
400
+ *
401
+ * `executeSearch`: Boolean to define if the search should be executed or not.
402
+ * If it is executed, the focus is placed on the results.
403
+ * If it’s not executed, the focus is placed at the end of
404
+ * the token string in the search bar.
405
+ *
406
+ * @example
407
+ * ```js
408
+ * searchOptions: {
409
+ * searchQuery: 'average sales by country and product type',
410
+ * executeSearch: true,
411
+ * }
412
+ * ```
413
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
380
414
  */
381
415
  searchOptions?: SearchOptions;
382
416
  }
383
417
  export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
384
418
  /**
385
- * Embed ThoughtSpot LLM and GPT based natural language search component.
419
+ * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
386
420
  *
387
421
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
388
422
  * @group Embed components
@@ -402,6 +436,13 @@ export declare class SageEmbed extends V1Embed {
402
436
  * @returns {string} query string
403
437
  */
404
438
  protected getEmbedParams(): string;
439
+ /**
440
+ * Construct the URL of the embedded ThoughtSpot sage to be
441
+ * loaded in the iframe
442
+ *
443
+ * @returns {string} iframe url
444
+ */
445
+ getIFrameSrc(): string;
405
446
  /**
406
447
  * Render the embedded ThoughtSpot Sage
407
448
  *
@@ -419,18 +460,19 @@ export declare class SageEmbed extends V1Embed {
419
460
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
420
461
  */
421
462
  /**
422
- * Configuration for search options
463
+ * Configuration for search options.
464
+ *
423
465
  */
424
466
  export interface SearchOptions {
425
467
  /**
426
- * The tml string to load the answer
468
+ * Search tokens to pass in the query.
427
469
  */
428
470
  searchTokenString: string;
429
471
  /**
430
- * Boolean to determine if the search should be executed or not.
431
- * if it is executed, put the focus on the results.
432
- * if it’s not executed, put the focus in the search bar - at the end of
433
- * the tokens
472
+ * Boolean to define if the search should be executed or not.
473
+ * If it is executed, the focus is placed on the results.
474
+ * If it’s not executed, the focus is placed at the end of
475
+ * the token string in the search bar.
434
476
  */
435
477
  executeSearch?: boolean;
436
478
  }
@@ -446,19 +488,15 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
446
488
  */
447
489
  collapseDataSources?: boolean;
448
490
  /**
449
- * If set to true, hides the data sources panel.
491
+ * Show or hide the data sources panel.
450
492
  */
451
493
  hideDataSources?: boolean;
452
494
  /**
453
- * If set to true, hides the charts and tables in search answers.
495
+ * Show or hide the charts and tables in search answers.
454
496
  * This attribute can be used to create a custom visualization
455
497
  * using raw answer data.
456
498
  */
457
499
  hideResults?: boolean;
458
- /**
459
- * If set to true, expands all the data sources panel.
460
- */
461
- expandAllDataSource?: boolean;
462
500
  /**
463
501
  * If set to true, the Search Assist feature is enabled.
464
502
  *
@@ -472,9 +510,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
472
510
  forceTable?: boolean;
473
511
  /**
474
512
  * The array of data source GUIDs to set on load.
475
- * Only a single dataSource supported currently.
513
+ * Only a single data source is supported currently.
476
514
  *
477
- * @deprecated Use dataSource instead
515
+ * @deprecated Use `dataSource` instead.
478
516
  */
479
517
  dataSources?: string[];
480
518
  /**
@@ -486,11 +524,29 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
486
524
  /**
487
525
  * The initial search query to load the answer with.
488
526
  *
489
- * @deprecated Use {@link searchOptions} instead
527
+ * @deprecated
528
+ *
529
+ * Use {@link searchOptions} instead.
490
530
  */
491
531
  searchQuery?: string;
492
532
  /**
493
- * Configuration for search options
533
+ * Configuration for search options.
534
+ * Includes the following properties:
535
+ *
536
+ * `searchTokenString`: Search tokens to pass in the query.
537
+ *
538
+ * `executeSearch`: Boolean to define if the search should be executed or not.
539
+ * If it is executed, the focus is placed on the results.
540
+ * If it’s not executed, the focus is placed at the end of
541
+ * the token string in the search bar.
542
+ *
543
+ * @example
544
+ * ```js
545
+ * searchOptions: {
546
+ * searchTokenString: '[quantity purchased] [region]',
547
+ * executeSearch: true,
548
+ * }
549
+ * ```
494
550
  */
495
551
  searchOptions?: SearchOptions;
496
552
  /**
@@ -498,10 +554,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
498
554
  */
499
555
  answerId?: string;
500
556
  /**
501
- * If set to true, search page will render without the Search Bar
557
+ * If set to true, the search page will render without the Search Bar
502
558
  * The chart/table should still be visible.
503
559
  *
504
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
560
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
505
561
  */
506
562
  hideSearchBar?: boolean;
507
563
  /**
@@ -532,6 +588,14 @@ export declare class SearchEmbed extends TsEmbed {
532
588
  protected embedComponentType: string;
533
589
  constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
534
590
  protected getEmbedParams(): string;
591
+ /**
592
+ * Construct the URL of the embedded ThoughtSpot search to be
593
+ * loaded in the iframe
594
+ *
595
+ * @param answerId The GUID of a saved answer
596
+ * @param dataSources A list of data source GUIDs
597
+ */
598
+ getIFrameSrc(): string;
535
599
  /**
536
600
  * Render the embedded ThoughtSpot search
537
601
  */
@@ -588,43 +652,43 @@ export declare enum Page {
588
652
  */
589
653
  export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
590
654
  /**
591
- * If true, the main navigation bar within the ThoughtSpot app
655
+ * If true, the top navigation bar within the ThoughtSpot app
592
656
  * is displayed. By default, the navigation bar is hidden.
593
- * This flag also control the homepage left nav-bar.
657
+ * This flag also controls the homepage left navigation bar.
594
658
  */
595
659
  showPrimaryNavbar?: boolean;
596
660
  /**
597
- * Flag to control Homepage Left Nav Bar
598
- * If showPrimaryNavbar is true, ie navigation bar(Global nav-bar) and Homepage left
599
- * nav-bar is visible, this flag will only hide the homepage left nav.
600
- * Precedence of showPrimaryNavbar flag > hideHomepageLeftNav flag.
661
+ * Control the visibility of the left navigation bar on the Homepage.
662
+ * If showPrimaryNavbar is true, that is, if the Global and Homepage
663
+ * nav-bars are visible, this flag will only hide the homepage left nav-bar.
664
+ * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
601
665
  *
602
666
  * @default false
603
667
  * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
604
668
  */
605
669
  hideHomepageLeftNav?: boolean;
606
670
  /**
607
- * If true, help and profile buttons will hide on NavBar. By default,
608
- * they are shown.
671
+ * Control the visibility of the help (?) and profile buttons on the
672
+ * Global nav-bar. By default, these buttons are visible on the nav-bar.
609
673
  */
610
674
  disableProfileAndHelp?: boolean;
611
675
  /**
612
- * If true, application switcher button will hide on NavBar. By default,
613
- * they are shown.
676
+ * Control the visibility of the application switcher button on the nav-bar.
677
+ * By default, the application switcher is shown.
614
678
  */
615
679
  hideApplicationSwitcher?: boolean;
616
680
  /**
617
- * If true, org switcher button will hide on NavBar. By default,
618
- * they are shown.
681
+ * Control the visibility of the Org switcher button on the nav-bar.
682
+ * By default, the Org switcher button is shown.
619
683
  */
620
684
  hideOrgSwitcher?: boolean;
621
685
  /**
622
- * A URL path within the app that is to be embedded.
686
+ * A URL path to the embedded application page
623
687
  * If both path and pageId attributes are defined, the path definition
624
688
  * takes precedence. This is the path post the `#/` in the URL of the standalone
625
689
  * ThoughtSpot app. Use this to open the embedded view to a specific path.
626
690
  *
627
- * For eg, if you want the component to open to a specific liveboard
691
+ * For eg, if you want the component to open to a specific Liveboard
628
692
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
629
693
  *
630
694
  * @example
@@ -736,6 +800,12 @@ export declare class AppEmbed extends V1Embed {
736
800
  * embedded Liveboard or visualization.
737
801
  */
738
802
  protected getEmbedParams(): string;
803
+ /**
804
+ * Constructs the URL of the ThoughtSpot app page to be rendered.
805
+ *
806
+ * @param pageId The ID of the page to be embedded.
807
+ */
808
+ getIFrameSrc(): string;
739
809
  /**
740
810
  * Set the iframe height as per the computed height received
741
811
  * from the ThoughtSpot app.
@@ -789,8 +859,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
789
859
  */
790
860
  fullHeight?: boolean;
791
861
  /**
792
- * This is the minimum height(in pixels) for a full height Liveboard.
793
- * Setting this height helps resolves issues with empty Liveboards and
862
+ * This is the minimum height(in pixels) for a full-height Liveboard.
863
+ * Setting this height helps resolve issues with empty Liveboards and
794
864
  * other screens navigable from a Liveboard.
795
865
  *
796
866
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
@@ -803,7 +873,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
803
873
  enableVizTransformations?: boolean;
804
874
  /**
805
875
  * The Liveboard to display in the embedded view.
806
- * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
876
+ * Use either liveboardId or pinboardId to reference the Liveboard to embed.
807
877
  *
808
878
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
809
879
  */
@@ -822,79 +892,84 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
822
892
  * If set to true, all filter chips from a
823
893
  * Liveboard page will be read-only (no X buttons)
824
894
  *
825
- * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
895
+ * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
826
896
  */
827
897
  preventLiveboardFilterRemoval?: boolean;
828
898
  /**
829
- * Array of viz ids which should be visible when the liveboard
830
- * first renders. This can be changed by triggering the "SetVisibleVizs"
899
+ * Array of visualization IDs which should be visible when the Liveboard
900
+ * renders. This can be changed by triggering the `SetVisibleVizs`
831
901
  * event.
832
902
  *
833
903
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
834
904
  */
835
905
  visibleVizs?: string[];
836
906
  /**
837
- * To support backward compatibilty
907
+ * To support backward compatibility
838
908
  *
839
909
  * @hidden
840
910
  */
841
911
  preventPinboardFilterRemoval?: boolean;
842
912
  /**
843
- * Render embedded Liveboards and visualizations in the new Liveboard experience mode
913
+ * Render embedded Liveboards and visualizations in the
914
+ * new Liveboard experience mode.
844
915
  *
845
916
  * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
846
917
  */
847
918
  liveboardV2?: boolean;
848
919
  /**
849
- * Tab ID of the Liveboard that is supposed to be active
920
+ * Set a Liveboard tab as an active tab.
921
+ * Specify the tab ID.
850
922
  *
851
923
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
852
924
  */
853
925
  activeTabId?: string;
854
926
  /**
855
- * Hide tab Panel of embedded LB
927
+ * Show or hide the tab panel of the embedded Liveboard.
856
928
  *
857
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
929
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
858
930
  */
859
931
  hideTabPanel?: boolean;
860
932
  /**
861
- * Show or hide Liveboard header
933
+ * Show or hide the Liveboard header.
862
934
  *
863
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
935
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
864
936
  * @default false
865
937
  */
866
938
  hideLiveboardHeader?: boolean;
867
939
  /**
868
- * Show or hide Liveboard title
940
+ * Show or hide the Liveboard title.
869
941
  *
870
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
942
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
871
943
  * @default false
872
944
  */
873
945
  showLiveboardTitle?: boolean;
874
946
  /**
875
- * Show or hide Liveboard description
947
+ * Show or hide the Liveboard description.
876
948
  *
877
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
949
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
878
950
  * @default false
879
951
  */
880
952
  showLiveboardDescription?: boolean;
881
953
  /**
882
- * Boolean for sticky Liveboard header.
954
+ * Control the position and visibility of
955
+ * the Liveboard header as the users scroll down the
956
+ * embedded Liveboard page.
883
957
  *
884
958
  * @example
885
959
  * ```js
886
960
  * const embed = new LiveboardEmbed('#embed', {
887
- * ... // other liveboard view config
961
+ * ... // other Liveboard view config
888
962
  * isLiveboardHeaderSticky: true,
889
963
  * });
890
964
  * ```
891
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
965
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
892
966
  */
893
967
  isLiveboardHeaderSticky?: boolean;
894
968
  }
895
969
  /**
896
- * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
897
- * waits for the authentication to complete, so no need to wait for AuthStatus.SUCCESS.
970
+ * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
971
+ * waits for the authentication to complete, so you need not wait for
972
+ * `AuthStatus.SUCCESS`.
898
973
  *
899
974
  * @example
900
975
  * ```js
@@ -998,10 +1073,14 @@ export declare enum AuthType {
998
1073
  */
999
1074
  None = "None",
1000
1075
  /**
1001
- * Passthrough SSO to the embedded App within the iframe. Requires least
1076
+ * Passthrough SSO to the embedded application within the iframe. Requires least
1002
1077
  * configuration, but may not be supported by all IDPs. This will behave like `None`
1003
1078
  * if SSO is not configured on ThoughtSpot.
1004
1079
  *
1080
+ * To use this:
1081
+ * Your SAML or OpenID provider must allow iframe redirects.
1082
+ * For example, if you are using Okta as IdP, you can enable iframe embedding.
1083
+ *
1005
1084
  * @example
1006
1085
  * ```js
1007
1086
  * init({
@@ -1009,12 +1088,7 @@ export declare enum AuthType {
1009
1088
  * authType: AuthType.EmbeddedSSO,
1010
1089
  * });
1011
1090
  * ```
1012
- * Set authentication type as Embedded SSO.
1013
- *
1014
- * To use this:
1015
- * Your SAML or OpenID provider must allow iframe redirects.
1016
- * eg. If you are using okta as IdP, you can enable iFrame embedding.
1017
- * @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
1091
+ * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
1018
1092
  */
1019
1093
  EmbeddedSSO = "EmbeddedSSO",
1020
1094
  /**
@@ -1033,10 +1107,10 @@ export declare enum AuthType {
1033
1107
  SAML = "SSO_SAML",
1034
1108
  /**
1035
1109
  * SSO using SAML
1036
- * Will make the host application redirect to the SAML Idp. Use this
1037
- * when the idp does not allow itself to be embedded.
1110
+ * Makes the host application redirect to the SAML IdP. Use this
1111
+ * if your IdP does not allow itself to be embedded.
1038
1112
  *
1039
- * This redirects the host application to the SAML Idp. The host application
1113
+ * This redirects the host application to the SAML IdP. The host application
1040
1114
  * will be redirected back to the ThoughtSpot app after authentication.
1041
1115
  *
1042
1116
  * @example
@@ -1047,7 +1121,7 @@ export declare enum AuthType {
1047
1121
  * });
1048
1122
  * ```
1049
1123
  *
1050
- * This opens the SAML Idp in a popup window. The popup is triggered
1124
+ * This opens the SAML IdP in a popup window. The popup is triggered
1051
1125
  * when the user clicks the trigger button. The popup window will be
1052
1126
  * closed automatically after authentication.
1053
1127
  * @example
@@ -1061,8 +1135,8 @@ export declare enum AuthType {
1061
1135
  * });
1062
1136
  * ```
1063
1137
  *
1064
- * Can also use event to trigger the popup flow. Works the same
1065
- * as above example.
1138
+ * Can also use the event to trigger the popup flow. Works the same
1139
+ * as the above example.
1066
1140
  * @example
1067
1141
  * ```js
1068
1142
  * const authEE = init({
@@ -1086,7 +1160,7 @@ export declare enum AuthType {
1086
1160
  OIDC = "SSO_OIDC",
1087
1161
  /**
1088
1162
  * SSO using OIDC
1089
- * Will make the host application redirect to the OIDC Idp.
1163
+ * Will make the host application redirect to the OIDC IdP.
1090
1164
  * See code samples in {@link SAMLRedirect}.
1091
1165
  */
1092
1166
  OIDCRedirect = "SSO_OIDC",
@@ -1098,8 +1172,8 @@ export declare enum AuthType {
1098
1172
  */
1099
1173
  AuthServer = "AuthServer",
1100
1174
  /**
1101
- * Trusted authentication server, Use your own authentication server
1102
- * which returns a bearer token, generated using the secret_key obtained
1175
+ * Trusted authentication server. Use your own authentication server
1176
+ * which returns a bearer token, generated using the `secret_key` obtained
1103
1177
  * from ThoughtSpot.
1104
1178
  *
1105
1179
  * @example
@@ -1116,11 +1190,11 @@ export declare enum AuthType {
1116
1190
  */
1117
1191
  TrustedAuthToken = "AuthServer",
1118
1192
  /**
1119
- * Trusted authentication server Cookieless, Use you own authentication
1120
- * server which returns a bearer token, generated using the secret_key
1193
+ * Trusted authentication server Cookieless, Use your own authentication
1194
+ * server which returns a bearer token, generated using the `secret_key`
1121
1195
  * obtained from ThoughtSpot. This uses a cookieless authentication
1122
- * approach, recommended to by pass third-party cookie-blocking restriction
1123
- * implemented by some browsers
1196
+ * approach, recommended to bypass the third-party cookie-blocking restriction
1197
+ * implemented by some browsers.
1124
1198
  *
1125
1199
  * @example
1126
1200
  * ```js
@@ -1133,7 +1207,7 @@ export declare enum AuthType {
1133
1207
  * .then((data) => data.token);
1134
1208
  * }
1135
1209
  * ```
1136
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
1210
+ * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1137
1211
  */
1138
1212
  TrustedAuthTokenCookieless = "AuthServerCookieless",
1139
1213
  /**
@@ -1255,13 +1329,19 @@ export interface EmbedConfig {
1255
1329
  * The ThoughtSpot cluster hostname or IP address.
1256
1330
  */
1257
1331
  thoughtSpotHost: string;
1332
+ /**
1333
+ * If true, all the iframe links will have /v2 added automatically.
1334
+ * If false, all the iframe links will have /v1 added automatically.
1335
+ * If undefined, nothing will be added
1336
+ */
1337
+ enableReactShell?: boolean | undefined;
1258
1338
  /**
1259
1339
  * The authentication mechanism to use.
1260
1340
  */
1261
1341
  authType: AuthType;
1262
1342
  /**
1263
1343
  * [AuthServer] The trusted authentication endpoint to use to get the
1264
- * authentication token. A GET request is made to the
1344
+ * authentication token. A `GET` request is made to the
1265
1345
  * authentication API endpoint, which returns the token
1266
1346
  * as a plaintext response. For trusted authentication,
1267
1347
  * the `authEndpoint` or `getAuthToken` attribute is required.
@@ -1274,8 +1354,8 @@ export interface EmbedConfig {
1274
1354
  * attribute is required.
1275
1355
  *
1276
1356
  * It is advisable to fetch a new token inside this method and not
1277
- * reuse and older issued token, as because when auth expires this is
1278
- * called again and if it is called with an older token the authentication
1357
+ * reuse the old issued token. When auth expires this method is
1358
+ * called again and if it is called with an older token, the authentication
1279
1359
  * will not succeed.
1280
1360
  */
1281
1361
  getAuthToken?: () => Promise<string>;
@@ -1285,7 +1365,7 @@ export interface EmbedConfig {
1285
1365
  */
1286
1366
  username?: string;
1287
1367
  /**
1288
- * [Basic] The ThoughtSpot login password corresponding to the user name
1368
+ * [Basic] The ThoughtSpot login password corresponding to the username
1289
1369
  *
1290
1370
  * Warning: This feature is primarily intended for developer testing. It is
1291
1371
  * strongly advised not to use this authentication method in production.
@@ -1293,7 +1373,7 @@ export interface EmbedConfig {
1293
1373
  password?: string;
1294
1374
  /**
1295
1375
  * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
1296
- * open the SAML auth flow in a popup, instead of redirecting browser in
1376
+ * open the SAML auth flow in a popup, instead of redirecting the browser in
1297
1377
  * place.
1298
1378
  *
1299
1379
  * @default false
@@ -1302,91 +1382,93 @@ export interface EmbedConfig {
1302
1382
  noRedirect?: boolean;
1303
1383
  /**
1304
1384
  * [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
1305
- * the SAML auth flow in a popup, instead of redirecting browser in place.
1385
+ * the SAML auth flow in a popup, instead of redirecting the browser in place.
1306
1386
  *
1307
- * Need to use this with authTriggerContainer. Or manually trigger
1308
- * the AuthEvent.TRIGGER_SSO_POPUP event on a user interaction.
1387
+ * Need to use this with `authTriggerContainer`. Or manually trigger
1388
+ * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
1309
1389
  *
1310
1390
  * @default false
1311
1391
  * @version SDK: 1.18.0
1312
1392
  */
1313
1393
  inPopup?: boolean;
1314
1394
  /**
1315
- * [SSO] For SSO Authentication, one can supply an optional path param,
1316
- * this will be the path on the host origin where the SAML flow will be
1395
+ * [SSO] For SSO Authentication, one can supply an optional path param;
1396
+ * This will be the path on the host origin where the SAML flow will be
1317
1397
  * terminated.
1318
1398
  *
1319
1399
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1320
1400
  *
1321
- * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
1401
+ * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
1322
1402
  */
1323
1403
  redirectPath?: string;
1324
1404
  /** @internal */
1325
1405
  basepath?: string;
1326
1406
  /**
1327
- * Should we encode URL Query Params using base64 encoding which thoughtspot
1328
- * will generate for embedding. This provides additional security to
1329
- * thoughtspot clusters against Cross site scripting attacks.
1407
+ * Boolean to define if the query parameters in the ThoughtSpot URL
1408
+ * should be encoded in base64. This provides additional security to
1409
+ * Thoughtspot clusters against cross-site scripting attacks.
1330
1410
  *
1331
1411
  * @default false
1332
1412
  */
1333
1413
  shouldEncodeUrlQueryParams?: boolean;
1334
1414
  /**
1335
- * Suppress cookie access alert when third party cookies are blocked by the
1336
- * user's browser. Third party cookie blocking is the default behaviour on
1337
- * Safari and opt-in for Firefox/Chrome. If you set this to `true`, you are
1338
- * encouraged to handle `noCookieAccess` event, to show your own treatment
1415
+ * Suppress cookie access alert when third-party cookies are blocked by the
1416
+ * user's browser. Third-party cookie blocking is the default behaviour on
1417
+ * some web browsers like Safari. If you set this attribute to `true`,
1418
+ * you are encouraged to handle `noCookieAccess` event, to show your own treatment
1339
1419
  * in this case.
1340
1420
  *
1341
1421
  * @default false
1342
1422
  */
1343
1423
  suppressNoCookieAccessAlert?: boolean;
1344
1424
  /**
1345
- * Ignore cookie access alert when third party cookies are blocked by the
1425
+ * Ignore the cookie access alert when third-party cookies are blocked by the
1346
1426
  * user's browser. If you set this to `true`, the embedded iframe behaviour
1347
- * persist even in case of non logged in user.
1427
+ * persists even in the case of a non-logged-in user.
1348
1428
  *
1349
1429
  * @default false
1350
1430
  */
1351
1431
  ignoreNoCookieAccess?: boolean;
1352
1432
  /**
1353
- * Re-login when session expires with the previous login options
1433
+ * Re-login a user with the previous login options
1434
+ * when a user session expires.
1354
1435
  *
1355
1436
  * @default false
1356
1437
  */
1357
1438
  autoLogin?: boolean;
1358
1439
  /**
1359
1440
  * Disable redirection to the login page when the embedded session expires
1360
- * This flag is typically used alongside the combination of auth modes such as {@link
1361
- * AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
1441
+ * This flag is typically used alongside the combination of authentication modes such
1442
+ * as {@link AuthType.AuthServer} and auto-login behavior {@link
1443
+ * EmbedConfig.autoLogin}
1362
1444
  *
1363
1445
  * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1364
1446
  * @default false
1365
1447
  */
1366
1448
  disableLoginRedirect?: boolean;
1367
1449
  /**
1368
- * This message is displayed on the embed view when the login fails.
1450
+ * This message is displayed in the embedded view when a user login fails.
1369
1451
  *
1370
1452
  * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1371
1453
  */
1372
1454
  loginFailedMessage?: string;
1373
1455
  /**
1374
- * Calls the prefetch method internally when set to true
1456
+ * Calls the prefetch method internally when set to `true`
1375
1457
  *
1376
1458
  * @default false
1377
1459
  */
1378
1460
  callPrefetch?: boolean;
1379
1461
  /**
1380
- * When there are multiple embeds, queue the render of embed to start
1381
- * after the previous embed's render is complete. This helps in the load
1382
- * performance by decreasing the load on the browser.
1462
+ * When there are multiple objects embedded, queue the rendering of embedded objects
1463
+ * to start after the previous embed's render is complete. This helps improve
1464
+ * performance by decreasing the load on the browser.
1383
1465
  *
1384
1466
  * @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
1385
1467
  * @default false
1386
1468
  */
1387
1469
  queueMultiRenders?: boolean;
1388
1470
  /**
1389
- * Dynamic CSS Url to be injected in the loaded application.
1471
+ * Dynamic CSS URL to be injected in the loaded application.
1390
1472
  * You would also need to set `style-src` in the CSP settings.
1391
1473
  *
1392
1474
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
@@ -1394,9 +1476,9 @@ export interface EmbedConfig {
1394
1476
  */
1395
1477
  customCssUrl?: string;
1396
1478
  /**
1397
- * [AuthServer|Basic] Detect if 3rd party cookies are enabled by doing an
1479
+ * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
1398
1480
  * additional call. This is slower and should be avoided. Listen to the
1399
- * NO_COOKIE_ACCESS event to handle the situation.
1481
+ * `NO_COOKIE_ACCESS` event to handle the situation.
1400
1482
  *
1401
1483
  * This is slightly slower than letting the browser handle the cookie check, as it
1402
1484
  * involves an extra network call.
@@ -1405,26 +1487,26 @@ export interface EmbedConfig {
1405
1487
  */
1406
1488
  detectCookieAccessSlow?: boolean;
1407
1489
  /**
1408
- * Hide beta alert warning message for SearchEmbed.
1490
+ * Hide the `beta` alert warning message for SearchEmbed.
1409
1491
  *
1410
1492
  * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
1411
1493
  */
1412
1494
  suppressSearchEmbedBetaWarning?: boolean;
1413
1495
  /**
1414
- * Hide beta alert warning message for SageEmbed.
1496
+ * Hide `beta` alert warning message for SageEmbed.
1415
1497
  *
1416
1498
  */
1417
1499
  suppressSageEmbedBetaWarning?: boolean;
1418
1500
  /**
1419
1501
  * Custom style params for embed Config.
1420
1502
  *
1421
- * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
1503
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1422
1504
  */
1423
1505
  customizations?: CustomisationsInterface;
1424
1506
  /**
1425
- * For inPopup SAMLRedirect or OIDCRedirect Auth, we need a button which the user
1426
- * click to trigger the flow. This is the containing element
1427
- * for that button.
1507
+ * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
1508
+ * button that the user can click to trigger the flow.
1509
+ * This attribute sets a containing element for that button.
1428
1510
  *
1429
1511
  * @example
1430
1512
  * ```js
@@ -1434,11 +1516,11 @@ export interface EmbedConfig {
1434
1516
  * authTriggerContainer: '#auth-trigger-container'
1435
1517
  * })
1436
1518
  * ```
1437
- * @version SDK: 1.17.0 | ThoughtSpot: *
1519
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1438
1520
  */
1439
1521
  authTriggerContainer?: string | HTMLElement;
1440
1522
  /**
1441
- * Specify that we want to use the AuthEvent.TRIGGER_SSO_POPUP event to trigger
1523
+ * Specify that we want to use the `AuthEvent.TRIGGER_SSO_POPUP` event to trigger
1442
1524
  * SAML popup. This is useful when you want to trigger the popup on a custom user
1443
1525
  * action.
1444
1526
  *
@@ -1446,20 +1528,22 @@ export interface EmbedConfig {
1446
1528
  useEventForSAMLPopup?: boolean;
1447
1529
  /**
1448
1530
  * Text to show in the button which triggers the popup auth flow.
1449
- * Default: "Authorize".
1531
+ * Default: `Authorize`.
1450
1532
  *
1451
- * @version SDK: 1.17.0 | ThoughtSpot: *
1533
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1452
1534
  */
1453
1535
  authTriggerText?: string;
1454
1536
  /**
1455
- * Disable Full App access of Embedded app outside of the iFrame.
1537
+ * Prevent users from accessing the full application or ThoughtSpot application pages
1538
+ * access to the embedded application users
1539
+ * outside of the iframe.
1456
1540
  *
1457
1541
  * @default true
1458
1542
  * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1459
1543
  */
1460
1544
  blockNonEmbedFullAppAccess?: boolean;
1461
1545
  /**
1462
- * Host config incase embedded app is inside TS app itself
1546
+ * Host config in case embedded app is inside TS app itself
1463
1547
  *
1464
1548
  * @hidden
1465
1549
  */
@@ -1475,21 +1559,27 @@ export interface EmbedConfig {
1475
1559
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
1476
1560
  */
1477
1561
  pendoTrackingKey?: string;
1562
+ /**
1563
+ * If passed as true all alerts will be suppressed in the embedded app.
1564
+ *
1565
+ * @version SDK: 1.26.2 | ThoughtSpot: *
1566
+ */
1567
+ suppressErrorAlerts?: boolean;
1478
1568
  }
1479
1569
  export interface LayoutConfig {
1480
1570
  }
1481
1571
  /**
1482
- * Embedded iFrame configuration
1572
+ * Embedded iframe configuration
1483
1573
  *
1484
1574
  * @group Embed components
1485
1575
  */
1486
1576
  export interface FrameParams {
1487
1577
  /**
1488
- * The width of the iFrame (unit is pixels if numeric).
1578
+ * The width of the iframe (unit is pixels if numeric).
1489
1579
  */
1490
1580
  width?: number | string;
1491
1581
  /**
1492
- * The height of the iFrame (unit is pixels if numeric).
1582
+ * The height of the iframe (unit is pixels if numeric).
1493
1583
  */
1494
1584
  height?: number | string;
1495
1585
  /**
@@ -1590,7 +1680,6 @@ export interface ViewConfig {
1590
1680
  */
1591
1681
  runtimeParameters?: RuntimeParameter[];
1592
1682
  /**
1593
- /**
1594
1683
  * The locale/language to use for the embedded view.
1595
1684
  *
1596
1685
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
@@ -1690,31 +1779,29 @@ export interface ViewConfig {
1690
1779
  */
1691
1780
  reorderedHomepageModules?: HomepageModule[];
1692
1781
  /**
1693
- * The list of tab IDs to show in the embedded.
1694
- * Only this Tabs will be shown in their respective LBs.
1695
- * Use this to show an tabID.
1782
+ * The list of tab IDs to show in the embedded Liveboard.
1783
+ * Only the tabs specified in the array will be shown in the Liveboard.
1696
1784
  *
1697
- * Use either this or hiddenTabs.
1785
+ * Use either `visibleTabs` or `hiddenTabs`.
1698
1786
  *
1699
1787
  * @example
1700
1788
  * ```js
1701
- * const embed = new LiveboardEmbed('#embed', {
1702
- * ... // other liveboard view config
1703
- * visibleTabs: [
1789
+ * visibleTabs: [
1704
1790
  * '430496d6-6903-4601-937e-2c691821af3c',
1705
- * 'f547ec54-2a37-4516-a222-2b06719af726']
1706
- * });
1791
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1707
1792
  * ```
1708
1793
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1709
1794
  */
1710
1795
  visibleTabs?: string[];
1711
1796
  /**
1712
- * homepageLeftNavItems : show/hide Homeapage Left Nav Bar Items
1713
- * There are 8 home nav list items, we will send those item as list
1714
- * which we want to hide for TSE.
1715
- * eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
1797
+ * homepageLeftNavItems : Show or hide the left navigation bar items.
1798
+ * There are 8 eight home navigation list items.
1799
+ * To hide these items, specify the string in the array.
1716
1800
  *
1717
- * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
1801
+ * ```js
1802
+ * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
1803
+ * ```
1804
+ * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
1718
1805
  */
1719
1806
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
1720
1807
  /**
@@ -1730,7 +1817,7 @@ export interface ViewConfig {
1730
1817
  * });
1731
1818
  * embed.showPreRender();
1732
1819
  * ```
1733
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1820
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
1734
1821
  */
1735
1822
  preRenderId?: string;
1736
1823
  /**
@@ -1763,7 +1850,7 @@ export type MessagePayload = {
1763
1850
  status?: string;
1764
1851
  };
1765
1852
  /**
1766
- * MessageOptions: By Providing options, getting specific event start / end based on
1853
+ * MessageOptions: By providing options, getting specific event start / end based on
1767
1854
  * option
1768
1855
  *
1769
1856
  * @group Events
@@ -1771,7 +1858,7 @@ export type MessagePayload = {
1771
1858
  export type MessageOptions = {
1772
1859
  /**
1773
1860
  * A boolean value indicating that start status events of this type
1774
- * will be dispatched
1861
+ * will be dispatched.
1775
1862
  */
1776
1863
  start?: boolean;
1777
1864
  };
@@ -1791,7 +1878,7 @@ responder?: (data: any) => void) => void;
1791
1878
  */
1792
1879
  export type MessageCallbackObj = {
1793
1880
  /**
1794
- * options: It contains start, A boolean value indicating that start
1881
+ * options: It contains start, a boolean value indicating that start
1795
1882
  * status events of this type will be dispatched
1796
1883
  */
1797
1884
  options: MessageOptions;
@@ -1863,7 +1950,7 @@ export declare enum RuntimeFilterOp {
1863
1950
  IN = "IN"
1864
1951
  }
1865
1952
  /**
1866
- * Home page module that can be hide
1953
+ * Home page module that can be hidden
1867
1954
  */
1868
1955
  export declare enum HomepageModule {
1869
1956
  /**
@@ -1879,7 +1966,7 @@ export declare enum HomepageModule {
1879
1966
  */
1880
1967
  Favorite = "FAVORITE",
1881
1968
  /**
1882
- * List of answers and liveboards
1969
+ * List of answers and Liveboards
1883
1970
  */
1884
1971
  MyLibrary = "MY_LIBRARY",
1885
1972
  /**
@@ -1912,7 +1999,7 @@ export interface RuntimeFilter {
1912
1999
  values: (number | boolean | string)[];
1913
2000
  }
1914
2001
  /**
1915
- * A filter that can be applied to ThoughtSpot answers, Liveboards, or
2002
+ * A filter that can be applied to ThoughtSpot Answers, Liveboards, or
1916
2003
  * visualizations at runtime.
1917
2004
  */
1918
2005
  export interface RuntimeParameter {
@@ -1948,6 +2035,14 @@ export interface RuntimeParameter {
1948
2035
  export declare enum EmbedEvent {
1949
2036
  /**
1950
2037
  * Rendering has initialized.
2038
+ * @example
2039
+ *```js
2040
+ * liveboardEmbed.on(EmbedEvent.Init, showLoader)
2041
+ * //show a loader
2042
+ * function showLoader() {
2043
+ * document.getElementById("loader");
2044
+ * }
2045
+ *```
1951
2046
  *
1952
2047
  * @returns timestamp - The timestamp when the event was generated.
1953
2048
  */
@@ -1955,69 +2050,162 @@ export declare enum EmbedEvent {
1955
2050
  /**
1956
2051
  * Authentication has either succeeded or failed.
1957
2052
  *
2053
+ * @example
2054
+ *```js
2055
+ * appEmbed.on(EmbedEvent.AuthInit, payload => {
2056
+ * console.log('AuthInit', payload);
2057
+ * })
2058
+ *```
2059
+ *
1958
2060
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
1959
2061
  */
1960
2062
  AuthInit = "authInit",
1961
2063
  /**
1962
2064
  * The embed object container has loaded.
1963
- *
1964
2065
  * @returns timestamp - The timestamp when the event was generated.
2066
+ * @example
2067
+ *```js
2068
+ * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
2069
+ * //hide loader
2070
+ * function hideLoader() {
2071
+ * document.getElementById("loader");
2072
+ * }
2073
+ *```
1965
2074
  */
1966
2075
  Load = "load",
1967
2076
  /**
1968
2077
  * Data pertaining to answer or Liveboard is received
1969
- *
1970
2078
  * @return data - The answer or Liveboard data
2079
+ * @example
2080
+ *```js
2081
+ * liveboardEmbed.on(EmbedEvent.Data, payload => {
2082
+ * console.log('data', payload);
2083
+ * })
2084
+ *```
1971
2085
  * @important
1972
2086
  */
1973
2087
  Data = "data",
1974
2088
  /**
1975
- * Search/answer/Liveboard filters have been applied/updated by the user.
2089
+ * Search/Answer/Liveboard filters have been applied/updated by the user.
1976
2090
  *
1977
2091
  * @hidden
1978
2092
  */
1979
2093
  FiltersChanged = "filtersChanged",
1980
2094
  /**
1981
2095
  * Search query has been updated by the user.
2096
+ *
2097
+ * @example
2098
+ *```js
2099
+ * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
2100
+ *```
2101
+ *
1982
2102
  */
1983
2103
  QueryChanged = "queryChanged",
1984
2104
  /**
1985
- * A drill down operation has been performed.
2105
+ * A drill-down operation has been performed.
1986
2106
  *
1987
2107
  * @returns additionalFilters - Any additional filters applied
1988
2108
  * @returns drillDownColumns - The columns on which drill down was performed
1989
2109
  * @returns nonFilteredColumns - The columns that were not filtered
2110
+ *
2111
+ * @example
2112
+ *```js
2113
+ * searchEmbed.trigger(HostEvent.DrillDown, {
2114
+ * points: {
2115
+ * clickedPoint,
2116
+ * selectedPoints: selectedPoint
2117
+ * },
2118
+ * autoDrillDown: true,
2119
+ * })
2120
+ *```
2121
+ * In this example, `VizPointDoubleClick` event is used for
2122
+ * triggering the `DrillDown` event when an area or specific
2123
+ * data point on a table or chart is double-clicked.
2124
+ *
2125
+ * @example
2126
+ *```js
2127
+ * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
2128
+ * console.log(payload);
2129
+ * const clickedPoint = payload.data.clickedPoint;
2130
+ * const selectedPoint = payload.data.selectedPoints;
2131
+ * console.log('>>> called', clickedPoint);
2132
+ * embed.trigger(HostEvent.DrillDown, {
2133
+ * points: {
2134
+ * clickedPoint,
2135
+ * selectedPoints: selectedPoint
2136
+ * },
2137
+ * autoDrillDown: true,
2138
+ * })
2139
+ * })
2140
+ *```
2141
+ *
1990
2142
  */
1991
2143
  Drilldown = "drillDown",
1992
2144
  /**
1993
2145
  * One or more data sources have been selected.
1994
- *
1995
2146
  * @returns dataSourceIds - the list of data sources
2147
+ *
2148
+ * @example
2149
+ * ```js
2150
+ * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
2151
+ * console.log('DataSourceSelected', payload);
2152
+ * })
2153
+ * ```
2154
+ *
1996
2155
  */
1997
2156
  DataSourceSelected = "dataSourceSelected",
1998
2157
  /**
1999
2158
  * One or more data columns have been selected.
2000
- *
2001
2159
  * @returns columnIds - the list of columns
2002
2160
  * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2161
+ *
2162
+ * @example
2163
+ * ```js
2164
+ * appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
2165
+ * console.log('AddRemoveColumns', payload);
2166
+ * })
2167
+ * ```
2168
+ *
2003
2169
  */
2004
2170
  AddRemoveColumns = "addRemoveColumns",
2005
2171
  /**
2006
- * A custom action has been triggered
2172
+ * A custom action has been triggered.
2007
2173
  *
2008
- * @returns actionId - The id of the custom action
2009
- * @returns data - The answer or Liveboard data
2174
+ * @returns actionId - ID of the custom action
2175
+ * @returns data - Response payload with the Answer or Liveboard data
2176
+ *
2177
+ * @example
2178
+ * ```js
2179
+ * appEmbed.on(EmbedEvent.customAction, payload => {
2180
+ * const data = payload.data;
2181
+ * if (data.id === 'insert Custom Action ID here') {
2182
+ * console.log('Custom Action event:', data.embedAnswerData);
2183
+ * }
2184
+ * })
2185
+ * ```
2010
2186
  */
2011
2187
  CustomAction = "customAction",
2012
2188
  /**
2013
- * Listen to double clicks on a visualization
2189
+ * Listen to double click actions on a visualization.
2190
+ *
2191
+ * @return ContextMenuInputPoints - Data point that is double-clicked
2014
2192
  *
2015
- * @return ContextMenuInputPoints - data point that is double clicked
2016
2193
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
2194
+ *
2195
+ * @example
2196
+ * ```js
2197
+ * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
2198
+ * console.log('VizPointDoubleClick', payload)
2199
+ * })
2200
+ * ```
2017
2201
  */
2018
2202
  VizPointDoubleClick = "vizPointDoubleClick",
2019
2203
  /**
2020
- * Listen to clicks on a visualization in a liveboard or Search result.
2204
+ * Listen to clicks on a visualization in a Liveboard or Search result.
2205
+ *
2206
+ * @return viz, clickedPoint - metadata about the point that is clicked
2207
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2208
+ * @important
2021
2209
  *
2022
2210
  * @example
2023
2211
  * ```js
@@ -2031,25 +2219,46 @@ export declare enum EmbedEvent {
2031
2219
  * )
2032
2220
  * });
2033
2221
  * ```
2034
- * @return viz, clickedPoint - metadata about point that is clicked
2035
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2036
- * @important
2037
2222
  */
2038
2223
  VizPointClick = "vizPointClick",
2039
2224
  /**
2040
2225
  * An error has occurred.
2041
2226
  *
2042
2227
  * @returns error - An error object or message
2228
+ *
2229
+ * @example
2230
+ * ```js
2231
+ * SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
2232
+ * //show error messaage
2233
+ * function showErrorMsg() {
2234
+ * document.getElementById("error");
2235
+ * ```
2236
+ *
2043
2237
  */
2044
2238
  Error = "Error",
2045
2239
  /**
2046
- * The embedded object has sent an alert
2240
+ * The embedded object has sent an alert.
2047
2241
  *
2048
2242
  * @returns alert - An alert object
2243
+ *
2244
+ * @example
2245
+ * ```js
2246
+ * searchEmbed.on(EmbedEvent.Alert)
2247
+ * ```
2248
+ *
2049
2249
  */
2050
2250
  Alert = "alert",
2051
2251
  /**
2052
2252
  * The ThoughtSpot auth session has expired.
2253
+ *
2254
+ * @example
2255
+ *```js
2256
+ * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
2257
+ * //show auth expired banner
2258
+ * function showAuthExpired() {
2259
+ * document.getElementById("authExpiredBanner");
2260
+ * }
2261
+ *```
2053
2262
  */
2054
2263
  AuthExpire = "ThoughtspotAuthExpired",
2055
2264
  /**
@@ -2079,14 +2288,28 @@ export declare enum EmbedEvent {
2079
2288
  */
2080
2289
  EmbedIframeCenter = "EmbedIframeCenter",
2081
2290
  /**
2082
- * Emitted when the "Get Data" button in Search Bar embed
2083
- * is clicked.
2291
+ * Emitted when the **Get Data** action is initiated.
2292
+ * Applicable to `SearchBarEmbed` only.
2084
2293
  *
2085
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
2294
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2295
+ *
2296
+ * @example
2297
+ *```js
2298
+ * searchbarEmbed.on(EmbedEvent.GetDataClick)
2299
+ * .then(data => {
2300
+ * console.log('Answer Data:', data);
2301
+ * })
2302
+ *```
2086
2303
  */
2087
2304
  GetDataClick = "getDataClick",
2088
2305
  /**
2089
2306
  * Detects the route change.
2307
+ *
2308
+ * @example
2309
+ *```js
2310
+ * searchEmbed.on(EmbedEvent.RouteChange, payload =>
2311
+ * console.log('data', payload))
2312
+ *```
2090
2313
  */
2091
2314
  RouteChange = "ROUTE_CHANGE",
2092
2315
  /**
@@ -2096,10 +2319,15 @@ export declare enum EmbedEvent {
2096
2319
  */
2097
2320
  V1Data = "exportVizDataToParent",
2098
2321
  /**
2099
- * Emitted when the embed does not have cookie access. This
2100
- * happens on Safari where third-party cookies are blocked by default.
2322
+ * Emitted when the embed does not have cookie access. This happens
2323
+ * when Safari and other Web browsers block third-party cookies
2324
+ * are blocked by default. `NoCookieAccess` can trigger
2101
2325
  *
2102
- * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
2326
+ * @example
2327
+ *```js
2328
+ * appEmbed.on(EmbedEvent.NoCookieAccess)
2329
+ *```
2330
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
2103
2331
  */
2104
2332
  NoCookieAccess = "noCookieAccess",
2105
2333
  /**
@@ -2111,239 +2339,539 @@ export declare enum EmbedEvent {
2111
2339
  SAMLComplete = "samlComplete",
2112
2340
  /**
2113
2341
  * Emitted when any modal is opened in the app
2114
- *
2115
2342
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2343
+ *
2344
+ * @example
2345
+ *```js
2346
+ * appEmbed.on(EmbedEvent.DialogOpen, payload => {
2347
+ * console.log('dialog open', payload);
2348
+ * })
2349
+ *```
2116
2350
  */
2117
2351
  DialogOpen = "dialog-open",
2118
2352
  /**
2119
2353
  * Emitted when any modal is closed in the app
2120
- *
2121
2354
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2355
+ *
2356
+ * @example
2357
+ *```js
2358
+ * appEmbed.on(EmbedEvent.DialogClose, payload => {
2359
+ * console.log('dialog close', payload);
2360
+ * })
2361
+ *```
2122
2362
  */
2123
2363
  DialogClose = "dialog-close",
2124
2364
  /**
2125
2365
  * Emitted when the Liveboard shell loads.
2126
2366
  * You can use this event as a hook to trigger
2127
2367
  * other events on the rendered Liveboard.
2128
- *
2129
2368
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2369
+ *
2370
+ * @example
2371
+ *```js
2372
+ * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
2373
+ console.log('Liveboard is rendered', payload);
2374
+ })
2375
+ *```
2376
+ * The following example shows how to trigger
2377
+ * `SetVisibleVizs` event using LiveboardRendered embed event:
2378
+ *
2379
+ * @example
2380
+ *```js
2381
+ * const embedRef = useEmbedRef();
2382
+ * const onLiveboardRendered = () => {
2383
+ * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
2384
+ * };
2385
+ *```
2130
2386
  */
2131
2387
  LiveboardRendered = "PinboardRendered",
2132
2388
  /**
2133
2389
  * This can be used to register an event listener which
2134
2390
  * is triggered on all events.
2135
- *
2136
2391
  * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2392
+ *
2393
+ * @example
2394
+ *```js
2395
+ * appEmbed.on(EmbedEvent.ALL, payload => {
2396
+ * console.log('Embed Events', payload)
2397
+ * })
2398
+ *```
2137
2399
  */
2138
2400
  ALL = "*",
2139
2401
  /**
2140
2402
  * Emitted when an Answer is saved in the app
2141
- *
2142
2403
  * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2404
+ * @example
2405
+ *```js
2406
+ * //trigger when action starts
2407
+ * searchEmbed.on(EmbedEvent.Save, payload => {
2408
+ * console.log('Save', payload)
2409
+ * }, {
2410
+ * start: true
2411
+ * })
2412
+ * //trigger when action ends
2413
+ * searchEmbed.on(EmbedEvent.Save, payload => {
2414
+ * console.log('Save', payload)
2415
+ * })
2416
+ *```
2143
2417
  */
2144
2418
  Save = "save",
2145
2419
  /**
2146
2420
  * Emitted when the download action is triggered on an answer
2147
2421
  *
2422
+ * **Note**: This event is deprecated in v1.21.0.
2423
+ * To fire an event when a download action is initiated on a chart or table,
2424
+ * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
2425
+ * or `EmbedEvent.DownloadAsXLSX`
2426
+ *
2148
2427
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2428
+ *
2429
+ * @example
2430
+ *```js
2431
+ * liveboardEmbed.trigger(HostEvent.Download, {
2432
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2433
+ * })
2434
+ *```
2149
2435
  */
2150
2436
  Download = "download",
2151
2437
  /**
2152
2438
  * Emitted when the download action is triggered on an answer
2153
- *
2154
2439
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
2440
+ *
2441
+ * @example
2442
+ *```js
2443
+ * //trigger when action starts
2444
+ * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2445
+ * console.log('download PNG', payload)}, {start: true })
2446
+ * //trigger when action ends
2447
+ * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2448
+ * console.log('download PNG', payload)})
2449
+ *```
2450
+ *
2155
2451
  */
2156
2452
  DownloadAsPng = "downloadAsPng",
2157
2453
  /**
2158
2454
  * Emitted when the Download as PDF action is triggered on an answer
2159
2455
  *
2160
2456
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2457
+ *
2458
+ * @example
2459
+ *```js
2460
+ * //trigger when action starts
2461
+ * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2462
+ * console.log('download PDF', payload)}, {start: true })
2463
+ * //trigger when action ends
2464
+ * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2465
+ * console.log('download PDF', payload)})
2466
+ *```
2467
+ *
2161
2468
  */
2162
2469
  DownloadAsPdf = "downloadAsPdf",
2163
2470
  /**
2164
2471
  * Emitted when the Download as CSV action is triggered on an answer
2165
2472
  *
2166
2473
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2474
+ * @example
2475
+ *```js
2476
+ * //trigger when action starts
2477
+ * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2478
+ * console.log('download CSV', payload)}, {start: true })
2479
+ * //trigger when action ends
2480
+ * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2481
+ * console.log('download CSV', payload)})
2482
+ *```
2167
2483
  */
2168
2484
  DownloadAsCsv = "downloadAsCsv",
2169
2485
  /**
2170
2486
  * Emitted when the Download as XLSX action is triggered on an answer
2171
2487
  *
2172
2488
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2489
+ *
2490
+ * @example
2491
+ *```js
2492
+ * //trigger when action starts
2493
+ * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2494
+ * console.log('download Xlsx', payload)}, { start: true })
2495
+ * //trigger when action ends
2496
+ * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2497
+ * console.log('download Xlsx', payload)})
2498
+ *```
2173
2499
  */
2174
2500
  DownloadAsXlsx = "downloadAsXlsx",
2175
2501
  /**
2176
- * Emitted when an answer is deleted in the app
2502
+ * Emitted when an Answer is deleted in the app
2177
2503
  *
2178
2504
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2505
+ *
2506
+ * @example
2507
+ *```js
2508
+ * //trigger when action starts
2509
+ * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2510
+ * console.log('delete answer', payload)}, {start: true })
2511
+ * //trigger when action is completed
2512
+ * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2513
+ * console.log('delete answer', payload)})
2514
+ *```
2179
2515
  */
2180
2516
  AnswerDelete = "answerDelete",
2181
2517
  /**
2182
2518
  * Emitted when an answer is pinned to a Liveboard
2183
2519
  *
2184
2520
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2521
+ * @example
2522
+ *```js
2523
+ * //trigger when action starts
2524
+ * searchEmbed.on(EmbedEvent.Pin, payload => {
2525
+ * console.log('pin', payload)
2526
+ * }, {
2527
+ * start: true
2528
+ * })
2529
+ * //trigger when action ends
2530
+ * searchEmbed.on(EmbedEvent.Pin, payload => {
2531
+ * console.log('pin', payload)
2532
+ * })
2533
+ *```
2185
2534
  */
2186
2535
  Pin = "pin",
2187
2536
  /**
2188
2537
  * Emitted when SpotIQ analysis is triggered
2189
2538
  *
2190
2539
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2540
+ * @example
2541
+ *```js
2542
+ * //trigger when action starts
2543
+ * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2544
+ * console.log('SpotIQAnalyze', payload)
2545
+ * }, {
2546
+ * start: true
2547
+ * })
2548
+ * //trigger when action ends
2549
+ * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2550
+ * console.log('SpotIQ analyze', payload)
2551
+ * })
2552
+ *```
2191
2553
  */
2192
2554
  SpotIQAnalyze = "spotIQAnalyze",
2193
2555
  /**
2194
2556
  * Emitted when a user shares an object with another user or group
2195
2557
  *
2196
2558
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2559
+ *
2560
+ * @example
2561
+ *```js
2562
+ * //trigger when action starts
2563
+ * searchEmbed.on(EmbedEvent.Share, payload => {
2564
+ * console.log('Share', payload)
2565
+ * }, {
2566
+ * start: true
2567
+ * })
2568
+ * //trigger when action ends
2569
+ * searchEmbed.on(EmbedEvent.Share, payload => {
2570
+ * console.log('Share', payload)
2571
+ * })
2572
+ *```
2197
2573
  */
2198
2574
  Share = "share",
2199
2575
  /**
2200
- * Emitted when a user clicks the Include action to include a specific value or data
2201
- * on a chart or table
2576
+ * Emitted when a user clicks the **Include** action to include a specific value or
2577
+ * data on a chart or table.
2202
2578
  *
2203
2579
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2580
+ * @example
2581
+ *```js
2582
+ * appEmbed.on(EmbedEvent.DrillInclude, payload => {
2583
+ * console.log('Drill include', payload);
2584
+ * })
2585
+ *```
2204
2586
  */
2205
2587
  DrillInclude = "context-menu-item-include",
2206
2588
  /**
2207
- * Emitted when a user clicks the Exclude action to exclude a specific value or data
2208
- * on a chart or table
2589
+ * Emitted when a user clicks the **Exclude** action to exclude a specific value or
2590
+ * data on a chart or table
2209
2591
  *
2210
2592
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2593
+ * @example
2594
+ *```js
2595
+ * appEmbed.on(EmbedEvent.DrillExclude, payload => {
2596
+ * console.log('Drill exclude', payload);
2597
+ * })
2598
+ *```
2211
2599
  */
2212
2600
  DrillExclude = "context-menu-item-exclude",
2213
2601
  /**
2214
- * Emitted when copied column value on the app
2602
+ * Emitted when a column value is copied in the embedded app.
2215
2603
  *
2216
2604
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2605
+ * @example
2606
+ *```js
2607
+ * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2608
+ * console.log('copy to clipboard', payload);
2609
+ * })
2610
+ *```
2217
2611
  */
2218
2612
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
2219
2613
  /**
2220
- * Emitted when a user clicks the Update TML action
2614
+ * Emitted when a user clicks the **Update TML** action
2221
2615
  *
2222
2616
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2617
+ * @example
2618
+ *```js
2619
+ * liveboardEmbed.on(EmbedEvent.UpdateTML)
2620
+ * })
2621
+ *```
2223
2622
  */
2224
2623
  UpdateTML = "updateTSL",
2225
2624
  /**
2226
- * Emitted when a user clicks the Edit TML action
2625
+ * Emitted when a user clicks the **Edit TML** action
2227
2626
  *
2228
2627
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2628
+ * @example
2629
+ *```js
2630
+ * appEmbed.on(EmbedEvent.EditTML, payload => {
2631
+ * console.log('Edit TML', payload);
2632
+ * })
2633
+ *```
2229
2634
  */
2230
2635
  EditTML = "editTSL",
2231
2636
  /**
2232
- * Emitted when ExportTML trigger in answer on the app
2233
- *
2637
+ * Emitted when the **Export TML** action is triggered on an
2638
+ * an embedded object in the app
2234
2639
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2640
+ * @example
2641
+ *```js
2642
+ * //trigger when action starts
2643
+ * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2644
+ * console.log('Export TML', payload)}, { start: true })
2645
+ * //trigger when action ends
2646
+ * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2647
+ * console.log('Export TML', payload)})
2648
+ *```
2235
2649
  */
2236
2650
  ExportTML = "exportTSL",
2237
2651
  /**
2238
- * Emitted when an answer is saved as a view
2652
+ * Emitted when an Answer is saved as a View.
2239
2653
  *
2240
2654
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2655
+ * @example
2656
+ *```js
2657
+ * appEmbed.on(EmbedEvent.SaveAsView, payload => {
2658
+ * console.log('View', payload);
2659
+ * })
2660
+ *```
2241
2661
  */
2242
2662
  SaveAsView = "saveAsView",
2243
2663
  /**
2244
- * Emitted when copy of existing answer on the app
2664
+ * Emitted when the user creates a copy of an Answer
2245
2665
  *
2246
2666
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2667
+ * @example
2668
+ *```js
2669
+ * //trigger when action starts
2670
+ * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2671
+ * console.log('Copy and edit', payload)}, {start: true })
2672
+ * //trigger when action ends
2673
+ * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2674
+ * console.log('Copy and edit', payload)})
2675
+ *```
2247
2676
  */
2248
2677
  CopyAEdit = "copyAEdit",
2249
2678
  /**
2250
- * Emitted when a user clicks Show underlying data on an answe
2679
+ * Emitted when a user clicks Show underlying data on an Answer
2251
2680
  *
2252
2681
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2682
+ * @example
2683
+ *```js
2684
+ * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
2685
+ * console.log('show data', payload);
2686
+ * })
2687
+ *```
2253
2688
  */
2254
2689
  ShowUnderlyingData = "showUnderlyingData",
2255
2690
  /**
2256
- * Emitted when an answer is switched to a chart or table view
2691
+ * Emitted when an answer is switched to a chart or table view.
2257
2692
  *
2258
2693
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2694
+ * @example
2695
+ *```js
2696
+ * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
2697
+ * console.log('switch view', payload);
2698
+ * })
2699
+ *```
2259
2700
  */
2260
2701
  AnswerChartSwitcher = "answerChartSwitcher",
2261
2702
  /**
2262
- * Internal event to communicate the initial settings back to the TS APP
2703
+ * Internal event to communicate the initial settings back to the ThoughtSpot app
2263
2704
  *
2264
2705
  * @hidden
2265
2706
  */
2266
2707
  APP_INIT = "appInit",
2267
2708
  /**
2268
- * Emitted when a user clicks Show Liveboard details on a Liveboard
2709
+ * Emitted when a user clicks **Show Liveboard details** on a Liveboard
2269
2710
  *
2270
2711
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2712
+ * @example
2713
+ *```js
2714
+ * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
2715
+ * console.log('Liveboard details', payload);
2716
+ * })
2717
+ *```
2271
2718
  */
2272
2719
  LiveboardInfo = "pinboardInfo",
2273
2720
  /**
2274
2721
  * Emitted when a user clicks on the Favorite icon on a Liveboard
2275
2722
  *
2276
2723
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2724
+ * @example
2725
+ *```js
2726
+ * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
2727
+ * console.log('favorites', payload);
2728
+ * })
2729
+ *```
2277
2730
  */
2278
2731
  AddToFavorites = "addToFavorites",
2279
2732
  /**
2280
- * Emitted when a user clicks Schedule on a Liveboard
2733
+ * Emitted when a user clicks **Schedule** on a Liveboard
2281
2734
  *
2282
2735
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2736
+ * @example
2737
+ *```js
2738
+ * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
2739
+ * console.log(`Liveboard schedule', payload);
2740
+ * })
2741
+ *```
2283
2742
  */
2284
2743
  Schedule = "subscription",
2285
2744
  /**
2286
- * Emitted when a user clicks Edit on a Liveboard or visualization
2745
+ * Emitted when a user clicks **Edit** on a Liveboard or visualization
2287
2746
  *
2288
2747
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2748
+ * @example
2749
+ *```js
2750
+ * liveboardEmbed.on(EmbedEvent.Edit, payload => {
2751
+ * console.log(`Liveboard edit', payload);
2752
+ * })
2753
+ *```
2289
2754
  */
2290
2755
  Edit = "edit",
2291
2756
  /**
2292
- * Emitted when a user clicks Make a copy on a Liveboard
2757
+ * Emitted when a user clicks *Make a copy* on a Liveboard
2293
2758
  *
2294
2759
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2760
+ * @example
2761
+ *```js
2762
+ * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
2763
+ * console.log(`Copy', payload);
2764
+ * })
2765
+ *```
2295
2766
  */
2296
2767
  MakeACopy = "makeACopy",
2297
2768
  /**
2298
- * Emitted when a user clicks Present on a Liveboard or visualization
2769
+ * Emitted when a user clicks **Present** on a Liveboard or visualization
2299
2770
  *
2300
2771
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2772
+ * @example
2773
+ *```js
2774
+ * liveboardEmbed.trigger(HostEvent.Present)
2775
+ *```
2776
+ *
2777
+ * @example
2778
+ *```js
2779
+ * liveboardEmbed.on(EmbedEvent.Present, {
2780
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2781
+ * })
2782
+ *```
2301
2783
  */
2302
2784
  Present = "present",
2303
2785
  /**
2304
- * Emitted when a user clicks Delete on a Liveboard
2786
+ * Emitted when a user clicks **Delete** on a visualization
2305
2787
  *
2306
2788
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2789
+ * @example
2790
+ *```js
2791
+ * liveboardEmbed.trigger(HostEvent.Delete,
2792
+ * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2793
+ *```
2794
+ *
2307
2795
  */
2308
2796
  Delete = "delete",
2309
2797
  /**
2310
2798
  * Emitted when a user clicks Manage schedules on a Liveboard
2311
2799
  *
2312
2800
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2801
+ *
2802
+ * @example
2803
+ *```js
2804
+ * liveboardEmbed.trigger(HostEvent.SchedulesList)
2805
+ *```
2806
+ *
2313
2807
  */
2314
2808
  SchedulesList = "schedule-list",
2315
2809
  /**
2316
- * Emitted when a user clicks Cancel in edit mode on a Liveboard
2810
+ * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
2317
2811
  *
2318
2812
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2813
+ *
2814
+ * @example
2815
+ *```js
2816
+ * liveboardEmbed.trigger(HostEvent.Cancel)
2817
+ *```
2818
+ *
2319
2819
  */
2320
2820
  Cancel = "cancel",
2321
2821
  /**
2322
- * Emitted when a user clicks Explore on a visualization
2822
+ * Emitted when a user clicks **Explore** on a visualization
2323
2823
  *
2324
2824
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2825
+ *
2826
+ * @example
2827
+ *```js
2828
+ * liveboardEmbed.trigger(HostEvent.Explore, {
2829
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2830
+ *```
2831
+ *
2325
2832
  */
2326
2833
  Explore = "explore",
2327
2834
  /**
2328
- * Emitted when a user clicks Copy link action on a visualization
2835
+ * Emitted when a user clicks **Copy link** action on a visualization
2329
2836
  *
2330
2837
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2838
+ *
2839
+ * @example
2840
+ *```js
2841
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
2842
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2843
+ *```
2844
+ *
2331
2845
  */
2332
2846
  CopyLink = "embedDocument",
2333
2847
  /**
2334
- * Emitted when a user interacts with cross filters on a visualization or liveboard
2848
+ * Emitted when a user interacts with cross filters on a visualization or Liveboard
2849
+ *
2850
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2851
+ *
2852
+ * @example
2853
+ *```js
2854
+ * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
2855
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2856
+ *```
2335
2857
  *
2336
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2337
2858
  */
2338
2859
  CrossFilterChanged = "cross-filter-changed",
2339
2860
  /**
2340
2861
  * Emitted when a user right clicks on a visualization (chart or table)
2341
2862
  *
2342
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2863
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2864
+ *
2865
+ * @example
2866
+ *```js
2867
+ * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
2868
+ * console.log('VizPointClick', payload)
2869
+ * })
2870
+ *```
2343
2871
  */
2344
2872
  VizPointRightClick = "vizPointRightClick",
2345
2873
  /**
2346
- * Emitted when a user clicks on Insert to slide on a visualization
2874
+ * Emitted when a user clicks **Insert to slide** on a visualization
2347
2875
  *
2348
2876
  * @hidden
2349
2877
  */
@@ -2351,52 +2879,53 @@ export declare enum EmbedEvent {
2351
2879
  /**
2352
2880
  * @hidden
2353
2881
  * Emitted when a user changes any filter on a Liveboard.
2354
- * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2882
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
2355
2883
  */
2356
2884
  FilterChanged = "filterChanged",
2357
2885
  /**
2358
- * Emitted when a user click on Go button in Sage Embed
2886
+ * Emitted when a user clicks the **Go** button on the Search page
2359
2887
  *
2360
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2888
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2361
2889
  */
2362
2890
  SageEmbedQuery = "sageEmbedQuery",
2363
2891
  /**
2364
- * Emitten when a user select data source in Sage Embed
2892
+ * Emitted when a user selects a data source.
2893
+ *
2894
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2365
2895
  *
2366
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2367
2896
  */
2368
2897
  SageWorksheetUpdated = "sageWorksheetUpdated",
2369
2898
  /**
2370
- * Emitted when a user updates a connection in Data tab
2899
+ * Emitted when a user updates a connection on the **Data** page
2371
2900
  *
2372
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
2901
+ * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
2373
2902
  */
2374
2903
  UpdateConnection = "updateConnection",
2375
2904
  /**
2376
- * Emitted when a user updates a connection in Data tab
2905
+ * Emitted when a user updates a connection on the **Data** page
2377
2906
  *
2378
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
2907
+ * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
2379
2908
  */
2380
2909
  CreateConnection = "createConnection",
2381
2910
  /**
2382
2911
  * Emitted when name, status (private or public) or filter values of a
2383
- * PersonalisedView is updated.
2912
+ * Personalised view is updated.
2384
2913
  *
2385
2914
  * @returns viewName: string
2386
2915
  * @returns viewId: string
2387
2916
  * @returns liveboardId: string
2388
2917
  * @returns isPublic: boolean
2389
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2918
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2390
2919
  */
2391
2920
  UpdatePersonalisedView = "updatePersonalisedView",
2392
2921
  /**
2393
- * Emitted when a PersonalisedView is saved.
2922
+ * Emitted when a Personalised view is saved.
2394
2923
  *
2395
2924
  * @returns viewName: string
2396
2925
  * @returns viewId: string
2397
2926
  * @returns liveboardId: string
2398
2927
  * @returns isPublic: boolean
2399
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2928
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2400
2929
  */
2401
2930
  SavePersonalisedView = "savePersonalisedView",
2402
2931
  /**
@@ -2406,7 +2935,7 @@ export declare enum EmbedEvent {
2406
2935
  * @returns viewId: string
2407
2936
  * @returns liveboardId: string
2408
2937
  * @returns isPublic: boolean
2409
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2938
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2410
2939
  */
2411
2940
  ResetLiveboard = "resetLiveboard",
2412
2941
  /**
@@ -2414,11 +2943,11 @@ export declare enum EmbedEvent {
2414
2943
  *
2415
2944
  * @returns views: string[]
2416
2945
  * @returns liveboardId: string
2417
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2946
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2418
2947
  */
2419
2948
  DeletePersonalisedView = "deletePersonalisedView",
2420
2949
  /**
2421
- * Emitten when a user creates a new worksheet
2950
+ * Emitted when a user creates a new worksheet
2422
2951
  *
2423
2952
  * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
2424
2953
  */
@@ -2448,15 +2977,16 @@ export declare enum EmbedEvent {
2448
2977
  */
2449
2978
  export declare enum HostEvent {
2450
2979
  /**
2451
- * Triggers a search query in AppEmbed and SearchEmbed
2452
- * deployments.
2980
+ * Triggers a search operation with the search tokens specified in
2981
+ * the search query string.
2982
+ * Supported in `AppEmbed` and `SearchEmbed` deployments.
2453
2983
  * Includes the following properties:
2454
2984
  *
2455
- * @param - dataSourceIds - The data source GUID to Search on
2985
+ * @param - `searchQuery` - query string with search tokens
2986
+ * @param - `dataSources` - Data source GUID to Search on
2456
2987
  * - Although an array, only a single source
2457
2988
  * is supported.
2458
- * @param - searchQuery - Query string with search tokens
2459
- * @param - execute - executes the existing / updated query
2989
+ * @param - `execute` - executes search and updates the existing query
2460
2990
  * @example
2461
2991
  * ```js
2462
2992
  * searchembed.trigger(HostEvent.Search, {
@@ -2476,6 +3006,10 @@ export declare enum HostEvent {
2476
3006
  * @param - columnGuid - Optional. GUID of the column to drill
2477
3007
  * by. If not provided it will auto drill by the configured
2478
3008
  * column.
3009
+ * @param - autoDrillDown - Optional. If true, the drill down will be
3010
+ * done automatically on the most popular column.
3011
+ * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
3012
+ * in case of a liveboard.
2479
3013
  * @example
2480
3014
  * ```js
2481
3015
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2492,6 +3026,25 @@ export declare enum HostEvent {
2492
3026
  * });
2493
3027
  * })
2494
3028
  * ```
3029
+ * @example
3030
+ * ```js
3031
+ * // Works with TS 9.8.0 and above
3032
+ *
3033
+ * liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
3034
+ * console.log(payload);
3035
+ * const clickedPoint = payload.data.clickedPoint;
3036
+ * const selectedPoint = payload.data.selectedPoints;
3037
+ * console.log('>>> called', clickedPoint);
3038
+ * liveboardEmbed.trigger(HostEvent.DrillDown, {
3039
+ * points: {
3040
+ * clickedPoint,
3041
+ * selectedPoints: selectedPoint
3042
+ * },
3043
+ * autoDrillDown: true,
3044
+ * vizId: payload.data.vizId
3045
+ * });
3046
+ * })
3047
+ * ```
2495
3048
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
2496
3049
  */
2497
3050
  DrillDown = "triggerDrillDown",
@@ -2508,7 +3061,7 @@ export declare enum HostEvent {
2508
3061
  */
2509
3062
  Reload = "reload",
2510
3063
  /**
2511
- * Sets the visible visualizations on a Liveboard.
3064
+ * Display specific visualizations on a Liveboard.
2512
3065
  *
2513
3066
  * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
2514
3067
  * in this parameter will be hidden.
@@ -2522,7 +3075,7 @@ export declare enum HostEvent {
2522
3075
  */
2523
3076
  SetVisibleVizs = "SetPinboardVisibleVizs",
2524
3077
  /**
2525
- * Set the Active Tab of a Liveboard.
3078
+ * Set a Liveboard tab as an active tab.
2526
3079
  *
2527
3080
  * @param - tabId - string of id of Tab to show
2528
3081
  * @example
@@ -2535,7 +3088,7 @@ export declare enum HostEvent {
2535
3088
  */
2536
3089
  SetActiveTab = "SetActiveTab",
2537
3090
  /**
2538
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
3091
+ * Update runtime filters applied on a Saved Answer or Liveboard. The
2539
3092
  * runtime filters passed here are appended to the existing runtime
2540
3093
  * filters.
2541
3094
  * Pass an array of runtime filters with the following attributes:
@@ -2561,10 +3114,12 @@ export declare enum HostEvent {
2561
3114
  */
2562
3115
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
2563
3116
  /**
2564
- * Navigate to a specific page in the embedded application without reloading the page.
3117
+ * Navigate to a specific page in the embedded ThoughtSpot application.
2565
3118
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2566
3119
  *
2567
- * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
3120
+ * @param - `path` - the path to navigate to to go forward or back. The path value can
3121
+ * be a number; for example, `1`, `-1`.
3122
+ *
2568
3123
  * @example
2569
3124
  * ```js
2570
3125
  * appEmbed.navigateToPage(-1)
@@ -2573,7 +3128,7 @@ export declare enum HostEvent {
2573
3128
  */
2574
3129
  Navigate = "Navigate",
2575
3130
  /**
2576
- * Opens the filter panel for a particular column.
3131
+ * Open the filter panel for a particular column.
2577
3132
  * Works with Search and Liveboard embed.
2578
3133
  *
2579
3134
  * @param - { columnId: string,
@@ -2591,7 +3146,7 @@ export declare enum HostEvent {
2591
3146
  */
2592
3147
  OpenFilter = "openFilter",
2593
3148
  /**
2594
- * Adds columns to the current search query.
3149
+ * Add columns to the current search query.
2595
3150
  *
2596
3151
  * @param - { columnIds: string[] }
2597
3152
  * @example
@@ -2602,7 +3157,7 @@ export declare enum HostEvent {
2602
3157
  */
2603
3158
  AddColumns = "addColumns",
2604
3159
  /**
2605
- * Removes a column from the current search query.
3160
+ * Remove a column from the current search query.
2606
3161
  *
2607
3162
  * @param - { columnId: string }
2608
3163
  * @example
@@ -2613,27 +3168,29 @@ export declare enum HostEvent {
2613
3168
  */
2614
3169
  RemoveColumn = "removeColumn",
2615
3170
  /**
2616
- * Gets the current Liveboard content.
3171
+ * Get the transient state of a Liveboard as encoded content.
3172
+ * This includes unsaved and ad hoc changes such as
3173
+ * Liveboard filters, runtime filters applied on visualizations on a
3174
+ * Liveboard, and Liveboard layout, changes to visualizations such as
3175
+ * sorting, toggling of legends, and data drill down.
2617
3176
  *
2618
3177
  * @example
2619
3178
  * ```js
2620
- * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
3179
+ * liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
3180
+ * data=>console.log(data))
2621
3181
  * ```
2622
3182
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
2623
3183
  */
2624
3184
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
2625
3185
  /**
2626
- * Triggers the **Pin** action on an embedded object
3186
+ * Trigger the **Pin** action on an embedded object
2627
3187
  *
2628
3188
  * @param - Liveboard embed takes the `vizId` as a
2629
- * key. Can be left undefined when embedding Search, full app or
3189
+ * key. Can be left undefined when embedding Search, full app, or
2630
3190
  * a visualization.
2631
3191
  * @example
2632
3192
  * ```js
2633
- * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2634
- * ```
2635
- * ```js
2636
- * vizEmbed.trigger(HostEvent.Pin)
3193
+ * appEmbed.trigger(HostEvent.Pin)
2637
3194
  * ```
2638
3195
  * ```js
2639
3196
  * searchEmbed.trigger(HostEvent.Pin)
@@ -2642,17 +3199,18 @@ export declare enum HostEvent {
2642
3199
  */
2643
3200
  Pin = "pin",
2644
3201
  /**
2645
- * Triggers the **Show Liveboard details** action on a Liveboard
3202
+ * Trigger the **Show Liveboard details** action
3203
+ * on an embedded Liveboard.
2646
3204
  *
2647
3205
  * @example
2648
- * ```js
2649
- * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
2650
- * ```
3206
+ *```js
3207
+ * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
3208
+ *```
2651
3209
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2652
3210
  */
2653
3211
  LiveboardInfo = "pinboardInfo",
2654
3212
  /**
2655
- * Triggers the **Schedule** action on a Liveboard
3213
+ * Trigger the **Schedule** action on an embedded Liveboard.
2656
3214
  *
2657
3215
  * @example
2658
3216
  * ```js
@@ -2662,7 +3220,7 @@ export declare enum HostEvent {
2662
3220
  */
2663
3221
  Schedule = "subscription",
2664
3222
  /**
2665
- * Triggers the **Manage schedule** action on a Liveboard
3223
+ * Trigger the **Manage schedule** action on an embedded Liveboard
2666
3224
  *
2667
3225
  * @example
2668
3226
  * ```js
@@ -2672,7 +3230,7 @@ export declare enum HostEvent {
2672
3230
  */
2673
3231
  SchedulesList = "schedule-list",
2674
3232
  /**
2675
- * Triggers the **Export TML** action on a Liveboard
3233
+ * Trigger the **Export TML** action on an embedded Liveboard.
2676
3234
  *
2677
3235
  * @example
2678
3236
  * ```js
@@ -2682,7 +3240,7 @@ export declare enum HostEvent {
2682
3240
  */
2683
3241
  ExportTML = "exportTSL",
2684
3242
  /**
2685
- * Triggers the **Edit TML** action on a Liveboard
3243
+ * Trigger the **Edit TML** action on an embedded Liveboard.
2686
3244
  *
2687
3245
  * @example
2688
3246
  * ```js
@@ -2692,7 +3250,7 @@ export declare enum HostEvent {
2692
3250
  */
2693
3251
  EditTML = "editTSL",
2694
3252
  /**
2695
- * Triggers the **Update TML** action on a Liveboard
3253
+ * Trigger the **Update TML** action on an embedded Liveboard.
2696
3254
  *
2697
3255
  * @example
2698
3256
  * ```js
@@ -2702,7 +3260,7 @@ export declare enum HostEvent {
2702
3260
  */
2703
3261
  UpdateTML = "updateTSL",
2704
3262
  /**
2705
- * Triggers the **Download PDF** action on a Liveboard
3263
+ * Trigger the **Download PDF** action on an embedded Liveboard.
2706
3264
  *
2707
3265
  * @example
2708
3266
  * ```js
@@ -2712,8 +3270,8 @@ export declare enum HostEvent {
2712
3270
  */
2713
3271
  DownloadAsPdf = "downloadAsPdf",
2714
3272
  /**
2715
- * Triggers the **Make a copy** action on a Liveboard, Search, or
2716
- * visualization page
3273
+ * Trigger the **Make a copy** action on a Liveboard, Search, or
3274
+ * visualization page.
2717
3275
  *
2718
3276
  * @example
2719
3277
  * ```js
@@ -2729,7 +3287,7 @@ export declare enum HostEvent {
2729
3287
  */
2730
3288
  MakeACopy = "makeACopy",
2731
3289
  /**
2732
- * Triggers the **Delete** action on a Liveboard
3290
+ * Trigger the **Delete** action for a Liveboard.
2733
3291
  *
2734
3292
  * @example
2735
3293
  * ```js
@@ -2739,7 +3297,7 @@ export declare enum HostEvent {
2739
3297
  */
2740
3298
  Remove = "delete",
2741
3299
  /**
2742
- * Triggers the **Explore* action on a visualization
3300
+ * Trigger the **Explore** action on a visualization.
2743
3301
  *
2744
3302
  * @param - an object with `vizId` as a key
2745
3303
  * @example
@@ -2750,7 +3308,7 @@ export declare enum HostEvent {
2750
3308
  */
2751
3309
  Explore = "explore",
2752
3310
  /**
2753
- * Triggers the **Create alert** action on a visualization
3311
+ * Trigger the **Create alert** action on a visualization
2754
3312
  *
2755
3313
  * @param - an object with `vizId` as a key
2756
3314
  * @example
@@ -2763,7 +3321,7 @@ export declare enum HostEvent {
2763
3321
  */
2764
3322
  CreateMonitor = "createMonitor",
2765
3323
  /**
2766
- * Triggers the **Manage alerts** action on a visualization
3324
+ * Trigger the **Manage alerts** action on a visualization
2767
3325
  *
2768
3326
  * @param - an object with `vizId` as a key
2769
3327
  * @example
@@ -2776,7 +3334,7 @@ export declare enum HostEvent {
2776
3334
  */
2777
3335
  ManageMonitor = "manageMonitor",
2778
3336
  /**
2779
- * Triggers the **Edit** action on a Liveboard or visualization
3337
+ * Trigger the **Edit** action on a Liveboard or visualization
2780
3338
  *
2781
3339
  * @param - object - To trigger the action for a specific visualization
2782
3340
  * in Liveboard embed, pass in `vizId` as a key.
@@ -2797,7 +3355,7 @@ export declare enum HostEvent {
2797
3355
  */
2798
3356
  Edit = "edit",
2799
3357
  /**
2800
- * Triggers the **Copy link** action on a Liveboard or visualization
3358
+ * Trigger the **Copy link** action on a Liveboard or visualization
2801
3359
  *
2802
3360
  * @param - object - to trigger the action for a
2803
3361
  * specific visualization in Liveboard embed, pass in `vizId` as a key
@@ -2815,7 +3373,7 @@ export declare enum HostEvent {
2815
3373
  */
2816
3374
  CopyLink = "embedDocument",
2817
3375
  /**
2818
- * Triggers the **Present** action on a Liveboard or visualization
3376
+ * Trigger the **Present** action on a Liveboard or visualization
2819
3377
  *
2820
3378
  * @param - object - to trigger the action for a specific visualization
2821
3379
  * in Liveboard embed, pass in `vizId` as a key
@@ -2833,7 +3391,7 @@ export declare enum HostEvent {
2833
3391
  */
2834
3392
  Present = "present",
2835
3393
  /**
2836
- * Gets TML for the current search.
3394
+ * Get TML for the current search.
2837
3395
  *
2838
3396
  * @example
2839
3397
  * ```js
@@ -2848,7 +3406,7 @@ export declare enum HostEvent {
2848
3406
  */
2849
3407
  GetTML = "getTML",
2850
3408
  /**
2851
- * Triggers the **Show underlying data** action on visualization or search
3409
+ * Trigger the **Show underlying data** action on visualization or search
2852
3410
  *
2853
3411
  * @param - an object with vizId as a key
2854
3412
  * @example
@@ -2866,7 +3424,9 @@ export declare enum HostEvent {
2866
3424
  */
2867
3425
  ShowUnderlyingData = "showUnderlyingData",
2868
3426
  /**
2869
- * Triggers the **Delete** action on visualization or search
3427
+ * Trigger the **Delete** action for a visualization
3428
+ * in an embedded Liveboard, or a chart or table
3429
+ * generated from Search.
2870
3430
  *
2871
3431
  * @param - Liveboard embed takes an object with `vizId` as a key.
2872
3432
  * Can be left empty if embedding Search or visualization.
@@ -2876,16 +3436,13 @@ export declare enum HostEvent {
2876
3436
  * '730496d6-6903-4601-937e-2c691821af3c'})
2877
3437
  * ```
2878
3438
  * ```js
2879
- * vizEmbed.trigger(HostEvent.Delete)
2880
- * ```
2881
- * ```js
2882
3439
  * searchEmbed.trigger(HostEvent.Delete)
2883
3440
  * ```
2884
3441
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2885
3442
  */
2886
3443
  Delete = "onDeleteAnswer",
2887
3444
  /**
2888
- * Triggers the **SpotIQ analyze** action on visualization
3445
+ * Trigger the **SpotIQ analyze** action on visualization
2889
3446
  * or search.
2890
3447
  *
2891
3448
  * @param - Liveboard embed takes `vizId` as a
@@ -2906,7 +3463,7 @@ export declare enum HostEvent {
2906
3463
  */
2907
3464
  SpotIQAnalyze = "spotIQAnalyze",
2908
3465
  /**
2909
- * Triggers the **Download** action on charts in
3466
+ * Trigger the **Download** action on charts in
2910
3467
  * the embedded view.
2911
3468
  *
2912
3469
  * @example
@@ -2915,17 +3472,15 @@ export declare enum HostEvent {
2915
3472
  * '730496d6-6903-4601-937e-2c691821af3c'})
2916
3473
  * ```
2917
3474
  * ```js
2918
- * vizEmbed.trigger(HostEvent.Download)
2919
- * ```
2920
- * ```js
2921
- * searchEmbed.trigger(HostEvent.Download)
3475
+ * embed.trigger(HostEvent.Download)
2922
3476
  * ```
2923
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
3477
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
3478
+ * Use {@link DownloadAsPng}
2924
3479
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2925
3480
  */
2926
3481
  Download = "downloadAsPng",
2927
3482
  /**
2928
- * Triggers the **Download** > **PNG** action on
3483
+ * Trigger the **Download** > **PNG** action on
2929
3484
  * charts in the embedded view.
2930
3485
  *
2931
3486
  * @example
@@ -2941,7 +3496,7 @@ export declare enum HostEvent {
2941
3496
  */
2942
3497
  DownloadAsPng = "downloadAsPng",
2943
3498
  /**
2944
- * Triggers the **Download** > **CSV** action on tables in
3499
+ * Trigger the **Download** > **CSV** action on tables in
2945
3500
  * the embedded view.
2946
3501
  *
2947
3502
  * @example
@@ -2959,7 +3514,7 @@ export declare enum HostEvent {
2959
3514
  */
2960
3515
  DownloadAsCsv = "downloadAsCSV",
2961
3516
  /**
2962
- * Triggers the **Download** > **XLSX** action on tables
3517
+ * Trigger the **Download** > **XLSX** action on tables
2963
3518
  * in the embedded view.
2964
3519
  *
2965
3520
  * @example
@@ -2977,7 +3532,7 @@ export declare enum HostEvent {
2977
3532
  */
2978
3533
  DownloadAsXlsx = "downloadAsXLSX",
2979
3534
  /**
2980
- * Triggers the **Share** action on an embedded
3535
+ * Trigger the **Share** action on an embedded
2981
3536
  * Liveboard or Answer.
2982
3537
  *
2983
3538
  * @example
@@ -2991,7 +3546,7 @@ export declare enum HostEvent {
2991
3546
  */
2992
3547
  Share = "share",
2993
3548
  /**
2994
- * Triggers the **Save** action on a Liveboard or Answer.
3549
+ * Trigger the **Save** action on a Liveboard or Answer.
2995
3550
  * Saves the changes.
2996
3551
  *
2997
3552
  * @example
@@ -3005,7 +3560,7 @@ export declare enum HostEvent {
3005
3560
  */
3006
3561
  Save = "save",
3007
3562
  /**
3008
- * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
3563
+ * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
3009
3564
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
3010
3565
  *
3011
3566
  * @param - an object with `vizId` as a key
@@ -3021,7 +3576,7 @@ export declare enum HostEvent {
3021
3576
  */
3022
3577
  SyncToSheets = "sync-to-sheets",
3023
3578
  /**
3024
- * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
3579
+ * Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
3025
3580
  * Sends data from an Answer or Liveboard visualization to third-party apps such
3026
3581
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
3027
3582
  *
@@ -3038,7 +3593,7 @@ export declare enum HostEvent {
3038
3593
  */
3039
3594
  SyncToOtherApps = "sync-to-other-apps",
3040
3595
  /**
3041
- * Triggers the **Manage pipelines** action on an embedded
3596
+ * Trigger the **Manage pipelines** action on an embedded
3042
3597
  * visualization or Answer.
3043
3598
  * Allows users to manage ThoughtSpot Sync pipelines.
3044
3599
  *
@@ -3055,18 +3610,21 @@ export declare enum HostEvent {
3055
3610
  */
3056
3611
  ManagePipelines = "manage-pipeline",
3057
3612
  /**
3058
- * Triggers the Reset search on the Search page
3613
+ * Reset search operation on the Search or Answer page.
3059
3614
  *
3060
3615
  * @example
3061
3616
  * ```js
3062
3617
  * searchEmbed.trigger(HostEvent.ResetSearch)
3063
3618
  * ```
3619
+ * ```js
3620
+ * appEmbed.trigger(HostEvent.ResetSearch)
3621
+ * ```
3064
3622
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
3065
3623
  */
3066
3624
  ResetSearch = "resetSearch",
3067
3625
  /**
3068
3626
  * @hidden
3069
- * Gets the currents visible and runtime filters applied on a Liveboard
3627
+ * Get the currents visible and runtime filters applied on a Liveboard
3070
3628
  * @example
3071
3629
  * liveboardEmbed.trigger(HostEvent.GetFilters)
3072
3630
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -3074,7 +3632,7 @@ export declare enum HostEvent {
3074
3632
  GetFilters = "getFilters",
3075
3633
  /**
3076
3634
  * @hidden
3077
- * Updates the visible filters on the Liveboard.
3635
+ * Update the visible filters on the Liveboard.
3078
3636
  * @param - filter: filter object containing column name and filter operation and values
3079
3637
  * @example
3080
3638
  *
@@ -3087,7 +3645,7 @@ export declare enum HostEvent {
3087
3645
  */
3088
3646
  UpdateFilters = "updateFilters",
3089
3647
  /**
3090
- * Get Tab for the current Liveboard.
3648
+ * Get tab details for the current Liveboard.
3091
3649
  *
3092
3650
  * @example
3093
3651
  * ```js
@@ -3101,9 +3659,9 @@ export declare enum HostEvent {
3101
3659
  */
3102
3660
  GetTabs = "getTabs",
3103
3661
  /**
3104
- * Set the visible Tabs on a Liveboard.
3662
+ * Set the visible tabs on a Liveboard.
3105
3663
  *
3106
- * @param - an array of ids of Tabs to show, the ids not passed
3664
+ * @param - an array of ids of tabs to show, the IDs not passed
3107
3665
  * will be hidden.
3108
3666
  * @example
3109
3667
  * ```js
@@ -3117,8 +3675,8 @@ export declare enum HostEvent {
3117
3675
  /**
3118
3676
  * Set the hidden tabs on a Liveboard.
3119
3677
  *
3120
- * @param - an array of ids of Tabs to hide, the ids not passed
3121
- * will be shown.
3678
+ * @param - an array of the IDs of the tabs to hide.
3679
+ * The IDs not passed will be shown.
3122
3680
  * @example
3123
3681
  * ```js
3124
3682
  * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
@@ -3129,9 +3687,12 @@ export declare enum HostEvent {
3129
3687
  */
3130
3688
  SetHiddenTabs = "SetPinboardHiddenTabs",
3131
3689
  /**
3132
- * Updates the search query for sage embed.
3690
+ * Updates the search query string for Natural Language Search operations.
3691
+ *
3692
+ * @param - `queryString`: Text string in Natural Language format
3693
+ *
3694
+ * @param - `executeSearch`: Boolean to execute search and update search query
3133
3695
  *
3134
- * @param - searchOptions: an object queryString and option to execute the query.
3135
3696
  * @example
3136
3697
  * ```js
3137
3698
  * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -3139,7 +3700,7 @@ export declare enum HostEvent {
3139
3700
  * executeSearch: true,
3140
3701
  * })
3141
3702
  * ```
3142
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3703
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
3143
3704
  */
3144
3705
  UpdateSageQuery = "updateSageQuery",
3145
3706
  /**
@@ -3152,24 +3713,25 @@ export declare enum HostEvent {
3152
3713
  * vizId: '123', // For Liveboard Visualization.
3153
3714
  * })
3154
3715
  * ```
3716
+ * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
3155
3717
  */
3156
3718
  GetAnswerSession = "getAnswerSession"
3157
3719
  }
3158
3720
  /**
3159
3721
  * The different visual modes that the data sources panel within
3160
- * search could appear in, i.e., hidden, collapsed, or expanded.
3722
+ * search could appear in, such as hidden, collapsed, or expanded.
3161
3723
  */
3162
3724
  export declare enum DataSourceVisualMode {
3163
3725
  /**
3164
- * Data source panel is hidden.
3726
+ * The data source panel is hidden.
3165
3727
  */
3166
3728
  Hidden = "hide",
3167
3729
  /**
3168
- * Data source panel is collapsed, but the user can manually expand it.
3730
+ * The data source panel is collapsed, but the user can manually expand it.
3169
3731
  */
3170
3732
  Collapsed = "collapse",
3171
3733
  /**
3172
- * Data source panel is expanded, but the user can manually collapse it.
3734
+ * The data source panel is expanded, but the user can manually collapse it.
3173
3735
  */
3174
3736
  Expanded = "expand"
3175
3737
  }
@@ -3245,7 +3807,8 @@ export declare enum Param {
3245
3807
  LiveboardHeaderSticky = "isLiveboardHeaderSticky",
3246
3808
  IsProductTour = "isProductTour",
3247
3809
  HideSearchBarTitle = "hideSearchBarTitle",
3248
- HideSageAnswerHeader = "hideSageAnswerHeader"
3810
+ HideSageAnswerHeader = "hideSageAnswerHeader",
3811
+ HideSearchBar = "hideSearchBar"
3249
3812
  }
3250
3813
  /**
3251
3814
  * ThoughtSpot application pages include actions and menu commands
@@ -3305,9 +3868,11 @@ export declare enum Action {
3305
3868
  SaveAsView = "saveAsView",
3306
3869
  /**
3307
3870
  * The **Make a copy** action on a Liveboard or Answer
3308
- * page.
3309
- * Creates a copy of the Liveboard, visualization,
3310
- * or Answer.
3871
+ * page. Creates a copy of the Liveboard.
3872
+ * In LiveboardEmbed, the **Make a copy** action is not available for
3873
+ * visualizations in the embedded Liveboard view.
3874
+ * In AppEmbed, the **Make a copy** action is available on both
3875
+ * Liveboards and visualizations.
3311
3876
  *
3312
3877
  * @example
3313
3878
  * ```js
@@ -3491,7 +4056,7 @@ export declare enum Action {
3491
4056
  */
3492
4057
  DownloadAsPdf = "downloadAsPdf",
3493
4058
  /**
3494
- * The **Download** > **CSV** menu action for tables on a Liveboard
4059
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3495
4060
  * or Answer page.
3496
4061
  * Downloads a visualization or Answer in the XLSX format.
3497
4062
  *
@@ -4022,6 +4587,7 @@ export declare enum Action {
4022
4587
  */
4023
4588
  RenameModalTitleDescription = "renameModalTitleDescription",
4024
4589
  /**
4590
+ *
4025
4591
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
4026
4592
  */
4027
4593
  RequestVerification = "requestVerification",
@@ -4352,6 +4918,7 @@ export declare class TsEmbed {
4352
4918
  * @param args
4353
4919
  */
4354
4920
  render(): TsEmbed;
4921
+ getIframeSrc(): string;
4355
4922
  protected handleRenderForPrerender(): void;
4356
4923
  /**
4357
4924
  * Creates the preRender shell
@@ -4479,14 +5046,6 @@ export interface exportTMLInput {
4479
5046
  edoc_format?: 'YAML' | 'JSON';
4480
5047
  }
4481
5048
  export declare let authPromise: Promise<boolean>;
4482
- /**
4483
- * Gets the configuration embed was initialized with.
4484
- *
4485
- * @returns {@link EmbedConfig} The configuration embed was initialized with.
4486
- * @version SDK: 1.19.0 | ThoughtSpot: *
4487
- * @group Global methods
4488
- */
4489
- export declare const getEmbedConfig: () => EmbedConfig;
4490
5049
  export declare const getAuthPromise: () => Promise<boolean>;
4491
5050
  export { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, };
4492
5051
  /**
@@ -4601,7 +5160,6 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
4601
5160
  console.error(error);
4602
5161
  });
4603
5162
  * ```
4604
- *
4605
5163
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
4606
5164
  * @group Global methods
4607
5165
  */
@@ -4615,17 +5173,6 @@ export declare let loggedInStatus: boolean;
4615
5173
  export declare let samlAuthWindow: Window;
4616
5174
  export declare let samlCompletionPromise: Promise<void>;
4617
5175
  export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
4618
- export declare const EndPoints: {
4619
- AUTH_VERIFICATION: string;
4620
- SAML_LOGIN_TEMPLATE: (targetUrl: string) => string;
4621
- OIDC_LOGIN_TEMPLATE: (targetUrl: string) => string;
4622
- TOKEN_LOGIN: string;
4623
- BASIC_LOGIN: string;
4624
- LOGOUT: string;
4625
- EXECUTE_TML: string;
4626
- EXPORT_TML: string;
4627
- IS_ACTIVE: string;
4628
- };
4629
5176
  interface sessionInfoInterface {
4630
5177
  userGUID: any;
4631
5178
  isPublicUser: any;
@@ -4667,8 +5214,8 @@ export declare enum AuthStatus {
4667
5214
  */
4668
5215
  LOGOUT = "LOGOUT",
4669
5216
  /**
4670
- * Emitted when inPopup: true in the SAMLRedirect flow.
4671
- * And, we are waiting for popup to be triggered either programatically
5217
+ * Emitted when inPopup is true in the SAMLRedirect flow and the
5218
+ * popup is waiting to be triggered either programmatically
4672
5219
  * or by the trigger button.
4673
5220
  *
4674
5221
  * @version SDK: 1.19.0
@@ -4713,8 +5260,8 @@ export interface AuthEventEmitter {
4713
5260
  */
4714
5261
  export declare enum AuthEvent {
4715
5262
  /**
4716
- * Manually trigger the SSO popup. This is useful with
4717
- * authStatus: SAMLRedirect/OIDCRedicre and inPopup: true
5263
+ * Manually trigger the SSO popup. This is useful when
5264
+ * authStatus is SAMLRedirect/OIDCRedirect and inPopup is set to true
4718
5265
  */
4719
5266
  TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
4720
5267
  }
@@ -4757,7 +5304,6 @@ export declare function getReleaseVersion(): string;
4757
5304
  * @group Global methods
4758
5305
  */
4759
5306
  export declare function getSessionInfo(): Promise<sessionInfoInterface>;
4760
- export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<any>;
4761
5307
  /**
4762
5308
  * Perform token based authentication
4763
5309
  *
@@ -5167,8 +5713,7 @@ interface UnderlyingDataPoint {
5167
5713
  * const data = await underlying.fetchData(0, 100);
5168
5714
  * })
5169
5715
  * ```
5170
- * @version
5171
- * ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
5716
+ * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
5172
5717
  * @group Events
5173
5718
  */
5174
5719
  export declare class AnswerService {
@@ -5202,8 +5747,7 @@ export declare class AnswerService {
5202
5747
  * const data = await underlying.fetchData(0, 100);
5203
5748
  * })
5204
5749
  * ```
5205
- * @version
5206
- * ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
5750
+ * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
5207
5751
  */
5208
5752
  getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
5209
5753
  executeQuery(query: string, variables: any): Promise<any>;
@@ -5211,3 +5755,20 @@ export declare class AnswerService {
5211
5755
  }
5212
5756
  export {};
5213
5757
 
5758
+ /**
5759
+ * Gets the configuration embed was initialized with.
5760
+ *
5761
+ * @returns {@link EmbedConfig} The configuration embed was initialized with.
5762
+ * @version SDK: 1.19.0 | ThoughtSpot: *
5763
+ * @group Global methods
5764
+ */
5765
+ export declare const getEmbedConfig: () => EmbedConfig;
5766
+ /**
5767
+ * Sets the configuration embed was initialized with.
5768
+ *
5769
+ * @param newConfig The configuration to set.
5770
+ * @version SDK: 1.27.0 | ThoughtSpot: *
5771
+ * @group Global methods
5772
+ */
5773
+ export declare const setEmbedConfig: (newConfig: EmbedConfig) => void;
5774
+