@thoughtspot/visual-embed-sdk 1.24.0-sage.2 → 1.24.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 (199) hide show
  1. package/README.md +2 -2
  2. package/cjs/package.json +9 -1
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +4 -3
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/css-variables.d.ts +38 -0
  7. package/cjs/src/css-variables.d.ts.map +1 -1
  8. package/cjs/src/embed/app.d.ts +41 -2
  9. package/cjs/src/embed/app.d.ts.map +1 -1
  10. package/cjs/src/embed/app.js +13 -9
  11. package/cjs/src/embed/app.js.map +1 -1
  12. package/cjs/src/embed/app.spec.js +56 -0
  13. package/cjs/src/embed/app.spec.js.map +1 -1
  14. package/cjs/src/embed/base.d.ts +13 -0
  15. package/cjs/src/embed/base.d.ts.map +1 -1
  16. package/cjs/src/embed/base.js +15 -2
  17. package/cjs/src/embed/base.js.map +1 -1
  18. package/cjs/src/embed/liveboard.d.ts +5 -1
  19. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  20. package/cjs/src/embed/liveboard.js +5 -2
  21. package/cjs/src/embed/liveboard.js.map +1 -1
  22. package/cjs/src/embed/liveboard.spec.js +23 -7
  23. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  24. package/cjs/src/embed/sage.d.ts +25 -2
  25. package/cjs/src/embed/sage.d.ts.map +1 -1
  26. package/cjs/src/embed/sage.js +10 -5
  27. package/cjs/src/embed/sage.js.map +1 -1
  28. package/cjs/src/embed/sage.spec.js +26 -0
  29. package/cjs/src/embed/sage.spec.js.map +1 -1
  30. package/cjs/src/embed/search-bar.d.ts +7 -1
  31. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  32. package/cjs/src/embed/search-bar.js +5 -2
  33. package/cjs/src/embed/search-bar.js.map +1 -1
  34. package/cjs/src/embed/search.d.ts +22 -1
  35. package/cjs/src/embed/search.d.ts.map +1 -1
  36. package/cjs/src/embed/search.js +9 -2
  37. package/cjs/src/embed/search.js.map +1 -1
  38. package/cjs/src/embed/search.spec.js +60 -1
  39. package/cjs/src/embed/search.spec.js.map +1 -1
  40. package/cjs/src/embed/ts-embed.d.ts +3 -1
  41. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  42. package/cjs/src/embed/ts-embed.js +28 -8
  43. package/cjs/src/embed/ts-embed.js.map +1 -1
  44. package/cjs/src/embed/ts-embed.spec.js +139 -3
  45. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  46. package/cjs/src/index.d.ts +2 -2
  47. package/cjs/src/index.d.ts.map +1 -1
  48. package/cjs/src/index.js +3 -1
  49. package/cjs/src/index.js.map +1 -1
  50. package/cjs/src/mixpanel-service.d.ts +1 -0
  51. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  52. package/cjs/src/mixpanel-service.js +10 -3
  53. package/cjs/src/mixpanel-service.js.map +1 -1
  54. package/cjs/src/mixpanel-service.spec.js +12 -3
  55. package/cjs/src/mixpanel-service.spec.js.map +1 -1
  56. package/cjs/src/react/index.d.ts +15 -15
  57. package/cjs/src/react/index.d.ts.map +1 -1
  58. package/cjs/src/react/index.js +7 -3
  59. package/cjs/src/react/index.js.map +1 -1
  60. package/cjs/src/react/index.spec.js +13 -1
  61. package/cjs/src/react/index.spec.js.map +1 -1
  62. package/cjs/src/types.d.ts +202 -18
  63. package/cjs/src/types.d.ts.map +1 -1
  64. package/cjs/src/types.js +140 -13
  65. package/cjs/src/types.js.map +1 -1
  66. package/cjs/src/utils.d.ts +7 -1
  67. package/cjs/src/utils.d.ts.map +1 -1
  68. package/cjs/src/utils.js +20 -1
  69. package/cjs/src/utils.js.map +1 -1
  70. package/cjs/src/utils.spec.js +24 -0
  71. package/cjs/src/utils.spec.js.map +1 -1
  72. package/dist/src/auth.d.ts.map +1 -1
  73. package/dist/src/css-variables.d.ts +38 -0
  74. package/dist/src/css-variables.d.ts.map +1 -1
  75. package/dist/src/embed/app.d.ts +41 -2
  76. package/dist/src/embed/app.d.ts.map +1 -1
  77. package/dist/src/embed/base.d.ts +13 -0
  78. package/dist/src/embed/base.d.ts.map +1 -1
  79. package/dist/src/embed/liveboard.d.ts +5 -1
  80. package/dist/src/embed/liveboard.d.ts.map +1 -1
  81. package/dist/src/embed/sage.d.ts +25 -2
  82. package/dist/src/embed/sage.d.ts.map +1 -1
  83. package/dist/src/embed/search-bar.d.ts +7 -1
  84. package/dist/src/embed/search-bar.d.ts.map +1 -1
  85. package/dist/src/embed/search.d.ts +22 -1
  86. package/dist/src/embed/search.d.ts.map +1 -1
  87. package/dist/src/embed/ts-embed.d.ts +3 -1
  88. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  89. package/dist/src/index.d.ts +2 -2
  90. package/dist/src/index.d.ts.map +1 -1
  91. package/dist/src/mixpanel-service.d.ts +1 -0
  92. package/dist/src/mixpanel-service.d.ts.map +1 -1
  93. package/dist/src/react/index.d.ts +15 -15
  94. package/dist/src/react/index.d.ts.map +1 -1
  95. package/dist/src/types.d.ts +202 -18
  96. package/dist/src/types.d.ts.map +1 -1
  97. package/dist/src/utils.d.ts +7 -1
  98. package/dist/src/utils.d.ts.map +1 -1
  99. package/dist/tsembed-react.es.js +329 -17329
  100. package/dist/tsembed-react.js +322 -17328
  101. package/dist/tsembed.es.js +353 -17342
  102. package/dist/tsembed.js +346 -17341
  103. package/dist/visual-embed-sdk-react-full.d.ts +754 -424
  104. package/dist/visual-embed-sdk-react.d.ts +703 -373
  105. package/dist/visual-embed-sdk.d.ts +354 -25
  106. package/lib/package.json +9 -1
  107. package/lib/src/auth.d.ts.map +1 -1
  108. package/lib/src/auth.js +4 -2
  109. package/lib/src/auth.js.map +1 -1
  110. package/lib/src/css-variables.d.ts +38 -0
  111. package/lib/src/css-variables.d.ts.map +1 -1
  112. package/lib/src/embed/app.d.ts +41 -2
  113. package/lib/src/embed/app.d.ts.map +1 -1
  114. package/lib/src/embed/app.js +13 -9
  115. package/lib/src/embed/app.js.map +1 -1
  116. package/lib/src/embed/app.spec.js +56 -0
  117. package/lib/src/embed/app.spec.js.map +1 -1
  118. package/lib/src/embed/base.d.ts +13 -0
  119. package/lib/src/embed/base.d.ts.map +1 -1
  120. package/lib/src/embed/base.js +15 -2
  121. package/lib/src/embed/base.js.map +1 -1
  122. package/lib/src/embed/liveboard.d.ts +5 -1
  123. package/lib/src/embed/liveboard.d.ts.map +1 -1
  124. package/lib/src/embed/liveboard.js +6 -3
  125. package/lib/src/embed/liveboard.js.map +1 -1
  126. package/lib/src/embed/liveboard.spec.js +23 -7
  127. package/lib/src/embed/liveboard.spec.js.map +1 -1
  128. package/lib/src/embed/sage.d.ts +25 -2
  129. package/lib/src/embed/sage.d.ts.map +1 -1
  130. package/lib/src/embed/sage.js +10 -5
  131. package/lib/src/embed/sage.js.map +1 -1
  132. package/lib/src/embed/sage.spec.js +26 -0
  133. package/lib/src/embed/sage.spec.js.map +1 -1
  134. package/lib/src/embed/search-bar.d.ts +7 -1
  135. package/lib/src/embed/search-bar.d.ts.map +1 -1
  136. package/lib/src/embed/search-bar.js +6 -3
  137. package/lib/src/embed/search-bar.js.map +1 -1
  138. package/lib/src/embed/search.d.ts +22 -1
  139. package/lib/src/embed/search.d.ts.map +1 -1
  140. package/lib/src/embed/search.js +10 -3
  141. package/lib/src/embed/search.js.map +1 -1
  142. package/lib/src/embed/search.spec.js +60 -1
  143. package/lib/src/embed/search.spec.js.map +1 -1
  144. package/lib/src/embed/ts-embed.d.ts +3 -1
  145. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  146. package/lib/src/embed/ts-embed.js +29 -9
  147. package/lib/src/embed/ts-embed.js.map +1 -1
  148. package/lib/src/embed/ts-embed.spec.js +140 -4
  149. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  150. package/lib/src/index.d.ts +2 -2
  151. package/lib/src/index.d.ts.map +1 -1
  152. package/lib/src/index.js +2 -2
  153. package/lib/src/index.js.map +1 -1
  154. package/lib/src/mixpanel-service.d.ts +1 -0
  155. package/lib/src/mixpanel-service.d.ts.map +1 -1
  156. package/lib/src/mixpanel-service.js +10 -3
  157. package/lib/src/mixpanel-service.js.map +1 -1
  158. package/lib/src/mixpanel-service.spec.js +12 -3
  159. package/lib/src/mixpanel-service.spec.js.map +1 -1
  160. package/lib/src/react/index.d.ts +15 -15
  161. package/lib/src/react/index.d.ts.map +1 -1
  162. package/lib/src/react/index.js +5 -3
  163. package/lib/src/react/index.js.map +1 -1
  164. package/lib/src/react/index.spec.js +14 -2
  165. package/lib/src/react/index.spec.js.map +1 -1
  166. package/lib/src/types.d.ts +202 -18
  167. package/lib/src/types.d.ts.map +1 -1
  168. package/lib/src/types.js +139 -12
  169. package/lib/src/types.js.map +1 -1
  170. package/lib/src/utils.d.ts +7 -1
  171. package/lib/src/utils.d.ts.map +1 -1
  172. package/lib/src/utils.js +18 -0
  173. package/lib/src/utils.js.map +1 -1
  174. package/lib/src/utils.spec.js +25 -1
  175. package/lib/src/utils.spec.js.map +1 -1
  176. package/lib/src/visual-embed-sdk.d.ts +357 -28
  177. package/package.json +9 -1
  178. package/src/auth.ts +7 -5
  179. package/src/css-variables.ts +47 -0
  180. package/src/embed/app.spec.ts +78 -0
  181. package/src/embed/app.ts +61 -16
  182. package/src/embed/base.ts +18 -5
  183. package/src/embed/liveboard.spec.ts +29 -10
  184. package/src/embed/liveboard.ts +11 -2
  185. package/src/embed/sage.spec.ts +32 -0
  186. package/src/embed/sage.ts +38 -5
  187. package/src/embed/search-bar.tsx +19 -6
  188. package/src/embed/search.spec.ts +76 -1
  189. package/src/embed/search.ts +43 -2
  190. package/src/embed/ts-embed.spec.ts +162 -8
  191. package/src/embed/ts-embed.ts +30 -9
  192. package/src/index.ts +4 -0
  193. package/src/mixpanel-service.spec.ts +12 -3
  194. package/src/mixpanel-service.ts +10 -3
  195. package/src/react/index.spec.tsx +34 -3
  196. package/src/react/index.tsx +37 -26
  197. package/src/types.ts +277 -102
  198. package/src/utils.spec.ts +31 -0
  199. package/src/utils.ts +23 -0
@@ -21,7 +21,7 @@ interface SearchProps extends EmbedProps, SearchViewConfig {
21
21
  * }
22
22
  * ```
23
23
  */
24
- export const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<TsEmbed>>;
24
+ export const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<_SearchEmbed>>;
25
25
  interface AppProps extends EmbedProps, AppViewConfig {
26
26
  }
27
27
  /**
@@ -38,7 +38,7 @@ interface AppProps extends EmbedProps, AppViewConfig {
38
38
  * }
39
39
  * ```
40
40
  */
41
- export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<TsEmbed>>;
41
+ export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<_AppEmbed>>;
42
42
  interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
43
43
  }
44
44
  /**
@@ -56,8 +56,8 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
56
56
  * }
57
57
  * ```
58
58
  */
59
- export const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
60
- export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
59
+ export const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
60
+ export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
61
61
  interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
62
62
  }
63
63
  /**
@@ -73,7 +73,7 @@ interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
73
73
  * }
74
74
  * ```
75
75
  */
76
- export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<TsEmbed>>;
76
+ export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<_SearchBarEmbed>>;
77
77
  interface SageEmbedProps extends EmbedProps, SageViewConfig {
78
78
  }
79
79
  /**
@@ -89,7 +89,8 @@ interface SageEmbedProps extends EmbedProps, SageViewConfig {
89
89
  * }
90
90
  * ```
91
91
  */
92
- export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<TsEmbed>>;
92
+ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<_SageEmbed>>;
93
+ type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
93
94
  /**
94
95
  * Get a reference to the embed component to trigger events on the component.
95
96
  *
@@ -105,14 +106,14 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
105
106
  * return <LiveboardEmbed ref={ref} liveboardId={<id>} />
106
107
  * }
107
108
  * ```
108
- * @returns {React.MutableRefObject<TsEmbed>} ref
109
+ * @returns {React.MutableRefObject<T extends TsEmbed>} ref
109
110
  */
110
- export const useEmbedRef: () => React.MutableRefObject<TsEmbed>;
111
+ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<React.ComponentRef<T>>;
111
112
 
112
113
  /**
113
114
  * @group Embed components
114
115
  */
115
- export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
116
+ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
116
117
  /**
117
118
  * The array of data source GUIDs to set on load.
118
119
  * Only a single dataSource supported currently.
@@ -126,6 +127,12 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
126
127
  * @version: SDK: 1.19.0
127
128
  */
128
129
  dataSource?: string;
130
+ /**
131
+ * Flag to set if last selected dataSource should be used
132
+ *
133
+ * @version: SDK: 1.24.0
134
+ */
135
+ useLastSelectedSources?: boolean;
129
136
  /**
130
137
  * Configuration for search options
131
138
  */
@@ -157,6 +164,22 @@ export declare class SearchBarEmbed extends TsEmbed {
157
164
  * @summary TS Sage embed
158
165
  * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
159
166
  */
167
+ /**
168
+ * Configuration for search options
169
+ */
170
+ export interface SearchOptions {
171
+ /**
172
+ * The tml string to load the answer
173
+ */
174
+ searchQuery: string;
175
+ /**
176
+ * Boolean to determine if the search should be executed or not.
177
+ * if it is executed, put the focus on the results.
178
+ * if it’s not executed, put the focus in the search bar - at the end of
179
+ * the tokens
180
+ */
181
+ executeSearch?: boolean;
182
+ }
160
183
  /**
161
184
  * The configuration attributes for the embedded Natural language search view. Based on
162
185
  * GPT and LLM.
@@ -166,7 +189,9 @@ export declare class SearchBarEmbed extends TsEmbed {
166
189
  */
167
190
  export interface SageViewConfig extends ViewConfig {
168
191
  /**
169
- * If set to true, object results are shown.
192
+ * If set to true, a list of liveboard and answers related
193
+ * to the natural language search will be shown below the
194
+ * AI generated answer.
170
195
  */
171
196
  showObjectResults?: boolean;
172
197
  /**
@@ -178,7 +203,8 @@ export interface SageViewConfig extends ViewConfig {
178
203
  */
179
204
  hideWorksheetSelector?: boolean;
180
205
  /**
181
- * If set to true, the object search suggestions are not shown
206
+ * If set to true, the search suggestions will contain existing
207
+ * liveboards and answers in addition with the autocomplete
182
208
  *
183
209
  */
184
210
  showObjectSuggestions?: boolean;
@@ -195,6 +221,10 @@ export interface SageViewConfig extends ViewConfig {
195
221
  * The data source GUID to set on load.
196
222
  */
197
223
  dataSource?: string;
224
+ /**
225
+ * Configuration for search options
226
+ */
227
+ searchOptions?: SearchOptions;
198
228
  }
199
229
  export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
200
230
  /**
@@ -270,6 +300,10 @@ export interface SearchViewConfig extends ViewConfig {
270
300
  * using raw answer data.
271
301
  */
272
302
  hideResults?: boolean;
303
+ /**
304
+ * If set to true, expands all the data sources panel.
305
+ */
306
+ expandAllDataSource?: boolean;
273
307
  /**
274
308
  * If set to true, the Search Assist feature is enabled.
275
309
  *
@@ -315,6 +349,23 @@ export interface SearchViewConfig extends ViewConfig {
315
349
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
316
350
  */
317
351
  hideSearchBar?: boolean;
352
+ /**
353
+ * Flag to control Data panel experience
354
+ *
355
+ * @default false
356
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
357
+ */
358
+ dataPanelV2?: boolean;
359
+ /**
360
+ * Flag to set if last selected dataSource should be used
361
+ *
362
+ * @version: SDK: 1.24.0
363
+ */
364
+ useLastSelectedSources?: boolean;
365
+ /**
366
+ * The list of parameter override to apply to a search answer.
367
+ */
368
+ runtimeParameters?: RuntimeParameter[];
318
369
  }
319
370
  export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
320
371
  /**
@@ -376,7 +427,7 @@ export declare enum Page {
376
427
  /**
377
428
  * SpotIQ listing page
378
429
  */
379
- SpotIQ = "spotiq"
430
+ SpotIQ = "insights"
380
431
  }
381
432
  /**
382
433
  * The view configuration for full app embedding.
@@ -387,8 +438,19 @@ export interface AppViewConfig extends ViewConfig {
387
438
  /**
388
439
  * If true, the main navigation bar within the ThoughtSpot app
389
440
  * is displayed. By default, the navigation bar is hidden.
441
+ * This flag also control the homepage left nav-bar.
390
442
  */
391
443
  showPrimaryNavbar?: boolean;
444
+ /**
445
+ * Flag to control Homepage Left Nav Bar
446
+ * If showPrimaryNavbar is true, ie navigation bar(Global nav-bar) and Homepage left
447
+ * nav-bar is visible, this flag will only hide the homepage left nav.
448
+ * Precedence of showPrimaryNavbar flag > hideHomepageLeftNav flag.
449
+ *
450
+ * @default false
451
+ * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
452
+ */
453
+ hideHomepageLeftNav?: boolean;
392
454
  /**
393
455
  * If true, help and profile buttons will hide on NavBar. By default,
394
456
  * they are shown.
@@ -407,12 +469,24 @@ export interface AppViewConfig extends ViewConfig {
407
469
  /**
408
470
  * A URL path within the app that is to be embedded.
409
471
  * If both path and pageId attributes are defined, the path definition
410
- * takes precedence.
472
+ * takes precedence. This is the path post the `#/` in the URL of the standalone
473
+ * ThoughtSpot app. Use this to open the embedded view to a specific path.
474
+ *
475
+ * For eg, if you want the component to open to a specific liveboard
476
+ * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
477
+ *
478
+ * @example
479
+ * ```
480
+ * <AppEmbed path="pinboard/1234/tab/7464" />
481
+ * ```
411
482
  */
412
483
  path?: string;
413
484
  /**
414
485
  * The application page to set as the start page
415
486
  * in the embedded view.
487
+ *
488
+ * Use this to open to particular page in the app. To open to a specific
489
+ * path within the app, use the `path` attribute which is more flexible.
416
490
  */
417
491
  pageId?: Page;
418
492
  /**
@@ -446,6 +520,21 @@ export interface AppViewConfig extends ViewConfig {
446
520
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
447
521
  */
448
522
  fullHeight?: boolean;
523
+ /**
524
+ * Flag to control Data panel experience
525
+ *
526
+ * @default false
527
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
528
+ * @hidden
529
+ */
530
+ dataPanelV2?: boolean;
531
+ /**
532
+ * Flag to control new Modular Home experience
533
+ *
534
+ * @default false
535
+ * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
536
+ */
537
+ modularHomeExperience?: boolean;
449
538
  }
450
539
  /**
451
540
  * Embeds full ThoughtSpot experience in a host application.
@@ -581,6 +670,10 @@ export interface LiveboardViewConfig extends ViewConfig {
581
670
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
582
671
  */
583
672
  hideTabPanel?: boolean;
673
+ /**
674
+ * The list of parameter override to apply to a Liveboard.
675
+ */
676
+ runtimeParameters?: RuntimeParameter[];
584
677
  }
585
678
  /**
586
679
  * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -627,233 +720,6 @@ export declare class LiveboardEmbed extends V1Embed {
627
720
  export declare class PinboardEmbed extends LiveboardEmbed {
628
721
  }
629
722
 
630
- /**
631
- * Copyright (c) 2022
632
- *
633
- * Base classes
634
- *
635
- * @summary Base classes
636
- * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
637
- */
638
- /**
639
- * Global prefix for all Thoughtspot postHash Params.
640
- */
641
- export declare const THOUGHTSPOT_PARAM_PREFIX = "ts-";
642
- /**
643
- * Base class for embedding v2 experience
644
- * Note: the v2 version of ThoughtSpot Blink is built on the new stack:
645
- * React+GraphQL
646
- */
647
- export declare class TsEmbed {
648
- protected isAppInitialized: boolean;
649
- /**
650
- * A reference to the iframe within which the ThoughtSpot app
651
- * will be rendered.
652
- */
653
- protected iFrame: HTMLIFrameElement;
654
- protected viewConfig: ViewConfig;
655
- protected embedConfig: EmbedConfig;
656
- /**
657
- * The ThoughtSpot hostname or IP address
658
- */
659
- protected thoughtSpotHost: string;
660
- protected thoughtSpotV2Base: string;
661
- constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
662
- /**
663
- * Handles errors within the SDK
664
- *
665
- * @param error The error message or object
666
- */
667
- protected handleError(error: string | Record<string, unknown>): void;
668
- /**
669
- * Constructs the base URL string to load the ThoughtSpot app.
670
- *
671
- * @param query
672
- */
673
- protected getEmbedBasePath(query: string): string;
674
- /**
675
- * Common query params set for all the embed modes.
676
- *
677
- * @param queryParams
678
- * @returns queryParams
679
- */
680
- protected getBaseQueryParams(queryParams?: {}): {};
681
- /**
682
- * Constructs the base URL string to load v1 of the ThoughtSpot app.
683
- * This is used for embedding Liveboards, visualizations, and full application.
684
- *
685
- * @param queryString The query string to append to the URL.
686
- * @param isAppEmbed A Boolean parameter to specify if you are embedding
687
- * the full application.
688
- */
689
- protected getV1EmbedBasePath(queryString: string): string;
690
- protected getEmbedParams(): string;
691
- protected getRootIframeSrc(): string;
692
- protected createIframeEl(frameSrc: string): HTMLIFrameElement;
693
- /**
694
- * Renders the embedded ThoughtSpot app in an iframe and sets up
695
- * event listeners.
696
- *
697
- * @param url
698
- * @param frameOptions
699
- */
700
- protected renderIFrame(url: string): Promise<any>;
701
- protected insertIntoDOM(child: string | Node): void;
702
- /**
703
- * Sets the height of the iframe
704
- *
705
- * @param height The height in pixels
706
- */
707
- protected setIFrameHeight(height: number | string): void;
708
- /**
709
- * Executes all registered event handlers for a particular event type
710
- *
711
- * @param eventType The event type
712
- * @param data The payload invoked with the event handler
713
- * @param eventPort The event Port for a specific MessageChannel
714
- */
715
- protected executeCallbacks(eventType: EmbedEvent, data: any, eventPort?: MessagePort | void): void;
716
- /**
717
- * Returns the ThoughtSpot hostname or IP address.
718
- */
719
- protected getThoughtSpotHost(): string;
720
- /**
721
- * Gets the v1 event type (if applicable) for the EmbedEvent type
722
- *
723
- * @param eventType The v2 event type
724
- * @returns The corresponding v1 event type if one exists
725
- * or else the v2 event type itself
726
- */
727
- protected getCompatibleEventType(eventType: EmbedEvent): EmbedEvent;
728
- /**
729
- * Calculates the iframe center for the current visible viewPort
730
- * of iframe using Scroll position of Host App, offsetTop for iframe
731
- * in Host app. ViewPort height of the tab.
732
- *
733
- * @returns iframe Center in visible viewport,
734
- * Iframe height,
735
- * View port height.
736
- */
737
- protected getIframeCenter(): {
738
- iframeCenter: number;
739
- iframeScrolled: number;
740
- iframeHeight: number;
741
- viewPortHeight: number;
742
- iframeVisibleViewPort: number;
743
- };
744
- /**
745
- * Registers an event listener to trigger an alert when the ThoughtSpot app
746
- * sends an event of a particular message type to the host application.
747
- *
748
- * @param messageType The message type
749
- * @param callback A callback as a function
750
- * @param options The message options
751
- * @example
752
- * ```js
753
- * tsEmbed.on(EmbedEvent.Error, (data) => {
754
- * console.error(data);
755
- * });
756
- * ```
757
- * @example
758
- * ```js
759
- * tsEmbed.on(EmbedEvent.Save, (data) => {
760
- * console.log("Answer save clicked", data);
761
- * }, {
762
- * start: true // This will trigger the callback on start of save
763
- * });
764
- * ```
765
- */
766
- on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
767
- /**
768
- * Removes an event listener for a particular event type.
769
- *
770
- * @param messageType The message type
771
- * @param callback The callback to remove
772
- * @example
773
- * ```js
774
- * const errorHandler = (data) => { console.error(data); };
775
- * tsEmbed.on(EmbedEvent.Error, errorHandler);
776
- * tsEmbed.off(EmbedEvent.Error, errorHandler);
777
- * ```
778
- */
779
- off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
780
- /**
781
- * Triggers an event to the embedded app
782
- *
783
- * @param messageType The event type
784
- * @param data The payload to send with the message
785
- */
786
- trigger(messageType: HostEvent, data?: any): Promise<any>;
787
- /**
788
- * Marks the ThoughtSpot object to have been rendered
789
- * Needs to be overridden by subclasses to do the actual
790
- * rendering of the iframe.
791
- *
792
- * @param args
793
- */
794
- render(): TsEmbed;
795
- /**
796
- * Get the Post Url Params for THOUGHTSPOT from the current
797
- * host app URL.
798
- * THOUGHTSPOT URL params starts with a prefix "ts-"
799
- *
800
- * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
801
- */
802
- getThoughtSpotPostUrlParams(): string;
803
- /**
804
- * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
805
- *
806
- * @version SDK: 1.19.1 | ThoughtSpot: *
807
- */
808
- destroy(): void;
809
- getUnderlyingFrameElement(): HTMLIFrameElement;
810
- /**
811
- * Prerenders a generic instance of the TS component.
812
- * This means without the path but with the flags already applied.
813
- * This is useful for prerendering the component in the background.
814
- *
815
- * @version SDK: 1.22.0
816
- * @returns
817
- */
818
- prerenderGeneric(): Promise<any>;
819
- }
820
- /**
821
- * Base class for embedding v1 experience
822
- * Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
823
- * which is currently under migration to v2
824
- *
825
- * @inheritdoc
826
- */
827
- export declare class V1Embed extends TsEmbed {
828
- protected viewConfig: ViewConfig;
829
- constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
830
- /**
831
- * Render the app in an iframe and set up event handlers
832
- *
833
- * @param iframeSrc
834
- */
835
- protected renderV1Embed(iframeSrc: string): any;
836
- protected getRootIframeSrc(): string;
837
- /**
838
- * @inheritdoc
839
- * @example
840
- * ```js
841
- * tsEmbed.on(EmbedEvent.Error, (data) => {
842
- * console.error(data);
843
- * });
844
- * ```
845
- * @example
846
- * ```js
847
- * tsEmbed.on(EmbedEvent.Save, (data) => {
848
- * console.log("Answer save clicked", data);
849
- * }, {
850
- * start: true // This will trigger the callback on start of save
851
- * });
852
- * ```
853
- */
854
- on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
855
- }
856
-
857
723
  export type EmbedEventHandlers = {
858
724
  [key in keyof typeof EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
859
725
  };
@@ -881,7 +747,7 @@ export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewCon
881
747
  * @summary ThoughtSpot Visual Embed SDK
882
748
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
883
749
  */
884
- export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
750
+ export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
885
751
 
886
752
  /**
887
753
  * Copyright (c) 2023
@@ -1058,6 +924,17 @@ export declare enum AuthType {
1058
924
  */
1059
925
  Basic = "Basic"
1060
926
  }
927
+ export declare enum HomeLeftNavItem {
928
+ QueryBuilder = "query-builder",
929
+ Home = "insights-home",
930
+ Liveboards = "liveboards",
931
+ Answers = "answers",
932
+ MonitorSubscription = "monitor-alerts",
933
+ SpotIQAnalysis = "spotiq-analysis",
934
+ Tutorials = "tutorials",
935
+ Documentation = "documentation",
936
+ Community = "community"
937
+ }
1061
938
  export type DOMSelector = string | HTMLElement;
1062
939
  /**
1063
940
  * inline customCSS within the {@link CustomisationsInterface}.
@@ -1137,6 +1014,9 @@ export interface CustomStyles {
1137
1014
  export interface CustomisationsInterface {
1138
1015
  style?: CustomStyles;
1139
1016
  content?: {
1017
+ /**
1018
+ * @version SDK: 1.26.0 | 9.7.0.cl
1019
+ */
1140
1020
  strings?: Record<string, any>;
1141
1021
  [key: string]: any;
1142
1022
  };
@@ -1360,12 +1240,21 @@ export interface EmbedConfig {
1360
1240
  blockNonEmbedFullAppAccess?: boolean;
1361
1241
  /**
1362
1242
  * Host config incase embedded app is inside TS app itself
1243
+ *
1244
+ * @hidden
1363
1245
  */
1364
1246
  hostConfig?: {
1365
1247
  hostUserGuid: string;
1366
1248
  hostClusterId: string;
1367
1249
  hostClusterName: string;
1368
1250
  };
1251
+ /**
1252
+ * Pendo API key to enable Pendo tracking to your own subscription, the key
1253
+ * is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
1254
+ *
1255
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
1256
+ */
1257
+ pendoTrackingKey?: string;
1369
1258
  }
1370
1259
  export interface LayoutConfig {
1371
1260
  }
@@ -1473,6 +1362,11 @@ export interface ViewConfig {
1473
1362
  * visualization, or Liveboard.
1474
1363
  */
1475
1364
  runtimeFilters?: RuntimeFilter[];
1365
+ /**
1366
+ * The list of parameter override to apply to a search answer,
1367
+ * visualization, or Liveboard.
1368
+ */
1369
+ runtimeParameters?: RuntimeParameter[];
1476
1370
  /**
1477
1371
  * The locale/language to use for the embedded view.
1478
1372
  *
@@ -1544,21 +1438,21 @@ export interface ViewConfig {
1544
1438
  /**
1545
1439
  * Boolean to hide liveboard header
1546
1440
  *
1547
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1441
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1548
1442
  * @default false
1549
1443
  */
1550
1444
  hideLiveboardHeader?: boolean;
1551
1445
  /**
1552
1446
  * Boolean to show liveboard title
1553
1447
  *
1554
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1448
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1555
1449
  * @default false
1556
1450
  */
1557
1451
  showLiveboardTitle?: boolean;
1558
1452
  /**
1559
1453
  * Boolean to show liveboard description
1560
1454
  *
1561
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1455
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1562
1456
  * @default false
1563
1457
  */
1564
1458
  showLiveboardDescription?: boolean;
@@ -1576,9 +1470,16 @@ export interface ViewConfig {
1576
1470
  * 'f547ec54-2a37-4516-a222-2b06719af726']
1577
1471
  * });
1578
1472
  * ```
1579
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1473
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1580
1474
  */
1581
1475
  hiddenTabs?: string[];
1476
+ /**
1477
+ * Hide the home page modules
1478
+ * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
1479
+ *
1480
+ * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
1481
+ */
1482
+ hiddenHomepageModules?: HomepageModule[];
1582
1483
  /**
1583
1484
  * The list of tab IDs to show in the embedded.
1584
1485
  * Only this Tabs will be shown in their respective LBs.
@@ -1595,9 +1496,18 @@ export interface ViewConfig {
1595
1496
  * 'f547ec54-2a37-4516-a222-2b06719af726']
1596
1497
  * });
1597
1498
  * ```
1598
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1499
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1599
1500
  */
1600
1501
  visibleTabs?: string[];
1502
+ /**
1503
+ * homepageLeftNavItems : show/hide Homeapage Left Nav Bar Items
1504
+ * There are 8 home nav list items, we will send those item as list
1505
+ * which we want to hide for TSE.
1506
+ * eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
1507
+ *
1508
+ * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
1509
+ */
1510
+ hiddenHomeLeftNavItems?: HomeLeftNavItem[];
1601
1511
  }
1602
1512
  /**
1603
1513
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1709,6 +1619,35 @@ export declare enum RuntimeFilterOp {
1709
1619
  */
1710
1620
  IN = "IN"
1711
1621
  }
1622
+ /**
1623
+ * Home page module that can be hide
1624
+ */
1625
+ export declare enum HomepageModule {
1626
+ /**
1627
+ * Search bar
1628
+ */
1629
+ Search = "search",
1630
+ /**
1631
+ * kPI watchlist module
1632
+ */
1633
+ Watchlist = "watchlist",
1634
+ /**
1635
+ * favorite objects
1636
+ */
1637
+ Favorite = "favorite",
1638
+ /**
1639
+ * List of answers and liveboards
1640
+ */
1641
+ MyLibrary = "mylibrary",
1642
+ /**
1643
+ * Trending list
1644
+ */
1645
+ Trending = "trending",
1646
+ /**
1647
+ * Learning videos
1648
+ */
1649
+ Learning = "learning"
1650
+ }
1712
1651
  /**
1713
1652
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
1714
1653
  * visualizations at runtime.
@@ -1729,6 +1668,20 @@ export interface RuntimeFilter {
1729
1668
  */
1730
1669
  values: (number | boolean | string)[];
1731
1670
  }
1671
+ /**
1672
+ * A filter that can be applied to ThoughtSpot answers, Liveboards, or
1673
+ * visualizations at runtime.
1674
+ */
1675
+ export interface RuntimeParameter {
1676
+ /**
1677
+ * The name of the runtime parameter to filter on (case-sensitive)
1678
+ */
1679
+ name: string;
1680
+ /**
1681
+ * Values
1682
+ */
1683
+ value: number | boolean | string;
1684
+ }
1732
1685
  /**
1733
1686
  * Event types emitted by the embedded ThoughtSpot application.
1734
1687
  *
@@ -2153,23 +2106,74 @@ export declare enum EmbedEvent {
2153
2106
  */
2154
2107
  InsertIntoSlide = "insertInToSlide",
2155
2108
  /**
2109
+ * @hidden
2156
2110
  * Emitted when a user changes any filter on a Liveboard.
2157
- *
2158
2111
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2159
2112
  */
2160
2113
  FilterChanged = "filterChanged",
2161
2114
  /**
2162
2115
  * Emitted when a user click on Go button in Sage Embed
2163
2116
  *
2164
- * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2117
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2118
+ */
2119
+ SageEmbedQuery = "sageEmbedQuery",
2120
+ /**
2121
+ * Emitten when a user select data source in Sage Embed
2122
+ *
2123
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2124
+ */
2125
+ SageWorksheetUpdated = "sageWorksheetUpdated",
2126
+ /**
2127
+ * Emitten when a user updates a connection in Data tab
2128
+ *
2129
+ * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
2130
+ */
2131
+ UpdateConnection = "updateConnection",
2132
+ /**
2133
+ * Emitted when name, status (private or public) or filter values of a
2134
+ * PersonalisedView is updated.
2135
+ *
2136
+ * @returns viewName: string
2137
+ * @returns viewId: string
2138
+ * @returns liveboardId: string
2139
+ * @returns isPublic: boolean
2140
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2141
+ */
2142
+ UpdatePersonalisedView = "updatePersonalisedView",
2143
+ /**
2144
+ * Emitted when a PersonalisedView is saved.
2145
+ *
2146
+ * @returns viewName: string
2147
+ * @returns viewId: string
2148
+ * @returns liveboardId: string
2149
+ * @returns isPublic: boolean
2150
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2151
+ */
2152
+ SavePersonalisedView = "savePersonalisedView",
2153
+ /**
2154
+ * Emitted when a Liveboard is reset.
2155
+ *
2156
+ * @returns viewName: string
2157
+ * @returns viewId: string
2158
+ * @returns liveboardId: string
2159
+ * @returns isPublic: boolean
2160
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2161
+ */
2162
+ ResetLiveboard = "resetLiveboard",
2163
+ /**
2164
+ * Emitted when a PersonalisedView is deleted.
2165
+ *
2166
+ * @returns views: string[]
2167
+ * @returns liveboardId: string
2168
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
2165
2169
  */
2166
- SageEmbedQuery = "sageEmbedQuery",
2170
+ DeletePersonalisedView = "deletePersonalisedView",
2167
2171
  /**
2168
- * Emitten when a user select data source in Sage Embed
2172
+ * Emitten when a user creates a new worksheet
2169
2173
  *
2170
- * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2174
+ * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
2171
2175
  */
2172
- SageWorksheetUpdated = "sageWorksheetUpdated"
2176
+ CreateWorksheet = "createWorksheet"
2173
2177
  }
2174
2178
  /**
2175
2179
  * Event types that can be triggered by the host application
@@ -2812,16 +2816,16 @@ export declare enum HostEvent {
2812
2816
  */
2813
2817
  ResetSearch = "resetSearch",
2814
2818
  /**
2819
+ * @hidden
2815
2820
  * Gets the currents visible and runtime filters applied on a Liveboard
2816
- *
2817
2821
  * @example
2818
2822
  * liveboardEmbed.trigger(HostEvent.GetFilters)
2819
2823
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2820
2824
  */
2821
2825
  GetFilters = "getFilters",
2822
2826
  /**
2827
+ * @hidden
2823
2828
  * Updates the visible filters on the Liveboard.
2824
- *
2825
2829
  * @param - filter: filter object containing column name and filter operation and values
2826
2830
  * @example
2827
2831
  *
@@ -2833,6 +2837,19 @@ export declare enum HostEvent {
2833
2837
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2834
2838
  */
2835
2839
  UpdateFilters = "updateFilters",
2840
+ /**
2841
+ * Get Tab for the current Liveboard.
2842
+ *
2843
+ * @example
2844
+ * ```js
2845
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
2846
+ * console.log(
2847
+ * tabDetails // TabDetails of current LB
2848
+ * );
2849
+ * })
2850
+ * ```
2851
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2852
+ */
2836
2853
  GetTabs = "getTabs",
2837
2854
  /**
2838
2855
  * Set the visible Tabs on a Liveboard.
@@ -2845,7 +2862,7 @@ export declare enum HostEvent {
2845
2862
  * '430496d6-6903-4601-937e-2c691821af3c',
2846
2863
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
2847
2864
  * ```
2848
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2865
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2849
2866
  */
2850
2867
  SetVisibleTabs = "SetPinboardVisibleTabs",
2851
2868
  /**
@@ -2859,7 +2876,7 @@ export declare enum HostEvent {
2859
2876
  * '630496d6-6903-4601-937e-2c691821af3c',
2860
2877
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
2861
2878
  * ```
2862
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2879
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2863
2880
  */
2864
2881
  SetHiddenTabs = "SetPinboardHiddenTabs",
2865
2882
  /**
@@ -2870,7 +2887,7 @@ export declare enum HostEvent {
2870
2887
  * ```js
2871
2888
  * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
2872
2889
  * queryString: 'revenue per year',
2873
- * execute: true,
2890
+ * executeSearch: true,
2874
2891
  * })
2875
2892
  * ```
2876
2893
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
@@ -2930,6 +2947,7 @@ export declare enum Param {
2930
2947
  DisableLoginRedirect = "disableLoginRedirect",
2931
2948
  visibleVizs = "pinboardVisibleVizs",
2932
2949
  LiveboardV2Enabled = "isPinboardV2Enabled",
2950
+ DataPanelV2Enabled = "enableDataPanelV2",
2933
2951
  ShowAlerts = "showAlerts",
2934
2952
  Locale = "locale",
2935
2953
  CustomStyle = "customStyle",
@@ -2958,7 +2976,10 @@ export declare enum Param {
2958
2976
  HideTabPanel = "hideTabPanel",
2959
2977
  HideSampleQuestions = "hideSampleQuestions",
2960
2978
  WorksheetId = "worksheet",
2961
- Query = "query"
2979
+ Query = "query",
2980
+ HideHomepageLeftNav = "hideHomepageLeftNav",
2981
+ ModularHomeExperienceEnabled = "modularHomeExperience",
2982
+ PendoTrackingKey = "additionalPendoKey"
2962
2983
  }
2963
2984
  /**
2964
2985
  * ThoughtSpot application pages include actions and menu commands
@@ -3461,7 +3482,7 @@ export declare enum Action {
3461
3482
  * disabledActions: [Action.QueryDetailsButtons]
3462
3483
  * ```
3463
3484
  */
3464
- QueryDetailsButtons = "QueryDetailsButtons",
3485
+ QueryDetailsButtons = "queryDetailsButtons",
3465
3486
  /**
3466
3487
  * The **Delete** action for Answers.
3467
3488
  *
@@ -3637,163 +3658,421 @@ export declare enum Action {
3637
3658
  */
3638
3659
  AxisMenuSort = "axisMenuSort",
3639
3660
  /**
3640
- * The **Group** option in the chart axis or table column
3641
- * customization menu.
3642
- * Allows grouping data points if the axes use the same
3643
- * unit of measurement and a similar scale.
3661
+ * The **Group** option in the chart axis or table column
3662
+ * customization menu.
3663
+ * Allows grouping data points if the axes use the same
3664
+ * unit of measurement and a similar scale.
3665
+ *
3666
+ * @example
3667
+ * ```js
3668
+ * disabledActions: [Action.AxisMenuGroup]
3669
+ * ```
3670
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3671
+ */
3672
+ AxisMenuGroup = "axisMenuGroup",
3673
+ /**
3674
+ * The **Position** option in the axis customization menu.
3675
+ * Allows changing the position of the axis to the
3676
+ * left or right side of the chart.
3677
+ *
3678
+ * @example
3679
+ * ```js
3680
+ * disabledActions: [Action.AxisMenuPosition]
3681
+ * ```
3682
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3683
+ */
3684
+ AxisMenuPosition = "axisMenuPosition",
3685
+ /**
3686
+ * The **Rename** option in the chart axis or table column customization menu.
3687
+ * Renames the axis label on a chart or the column header on a table.
3688
+ *
3689
+ * @example
3690
+ * ```js
3691
+ * disabledActions: [Action.AxisMenuRename]
3692
+ * ```
3693
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3694
+ */
3695
+ AxisMenuRename = "axisMenuRename",
3696
+ /**
3697
+ * The **Edit** action in the axis customization menu.
3698
+ * Allows editing the axis name, position, minimum and maximum values,
3699
+ * and format of a column.
3700
+ *
3701
+ * @example
3702
+ * ```js
3703
+ * disabledActions: [Action.AxisMenuEdit]
3704
+ * ```
3705
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3706
+ */
3707
+ AxisMenuEdit = "axisMenuEdit",
3708
+ /**
3709
+ * The **Number format** action to customize the format of
3710
+ * the data labels on a chart or table.
3711
+ *
3712
+ * @example
3713
+ * ```js
3714
+ * disabledActions: [Action.AxisMenuNumberFormat]
3715
+ * ```
3716
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3717
+ */
3718
+ AxisMenuNumberFormat = "axisMenuNumberFormat",
3719
+ /**
3720
+ * The **Text wrapping** action on a table.
3721
+ * Wraps or clips column text on a table.
3722
+ *
3723
+ * @example
3724
+ * ```js
3725
+ * disabledActions: [Action.AxisMenuTextWrapping]
3726
+ * ```
3727
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3728
+ */
3729
+ AxisMenuTextWrapping = "axisMenuTextWrapping",
3730
+ /**
3731
+ * The **Remove** action in the chart axis or table column
3732
+ * customization menu.
3733
+ * Removes the data labels from a chart or the column of a
3734
+ * table visualization.
3735
+ *
3736
+ * @example
3737
+ * ```js
3738
+ * disabledActions: [Action.AxisMenuRemove]
3739
+ * ```
3740
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3741
+ */
3742
+ AxisMenuRemove = "axisMenuRemove",
3743
+ /**
3744
+ * @hidden
3745
+ */
3746
+ InsertInToSlide = "insertInToSlide",
3747
+ /**
3748
+ * The **Rename** menu action on Liveboards and visualizations.
3749
+ * Allows renaming a Liveboard or visualization.
3750
+ *
3751
+ * @example
3752
+ * ```js
3753
+ * disabledActions: [Action.RenameModalTitleDescription]
3754
+ * ```
3755
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3756
+ */
3757
+ RenameModalTitleDescription = "renameModalTitleDescription",
3758
+ /**
3759
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3760
+ */
3761
+ RequestVerification = "requestVerification",
3762
+ /**
3763
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3764
+ */
3765
+ MarkAsVerified = "markAsVerified",
3766
+ /**
3767
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3768
+ */
3769
+ AddTab = "addTab",
3770
+ /**
3771
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3772
+ */
3773
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
3774
+ /**
3775
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3776
+ */
3777
+ ShowSageQuery = "showSageQuery",
3778
+ /**
3779
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3780
+ */
3781
+ EditSageAnswer = "editSageAnswer",
3782
+ /**
3783
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3784
+ */
3785
+ SageAnswerFeedback = "sageAnswerFeedback",
3786
+ /**
3787
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3788
+ */
3789
+ ModifySageAnswer = "modifySageAnswer",
3790
+ /**
3791
+ * The **Move to Tab** menu action on visualizations in liveboard edit mode.
3792
+ * Allows moving a visualization to a different tab.
3793
+ *
3794
+ * @example
3795
+ * ```js
3796
+ * disabledActions: [Action.MoveToTab]
3797
+ * ```
3798
+ */
3799
+ MoveToTab = "onContainerMove",
3800
+ /**
3801
+ * The **Manage Alertsb** menu action on KPI visualizations.
3802
+ *
3803
+ * @example
3804
+ * ```js
3805
+ * disabledActions: [Action.ManageMonitor]
3806
+ * ```
3807
+ */
3808
+ ManageMonitor = "ManageMonitor",
3809
+ /**
3810
+ * Action ID for Liveboard Personalised Views dropdown
3811
+ *
3812
+ * @example
3813
+ * ```js
3814
+ * disabledActions: [Action.PersonalisedViewsDropdown]
3815
+ * ```
3816
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
3817
+ */
3818
+ PersonalisedViewsDropdown = "personalisedViewsDropdown"
3819
+ }
3820
+ export interface SessionInterface {
3821
+ sessionId: string;
3822
+ genNo: number;
3823
+ acSession: {
3824
+ sessionId: string;
3825
+ genNo: number;
3826
+ };
3827
+ }
3828
+ export declare enum OperationType {
3829
+ GetChartWithData = "GetChartWithData",
3830
+ GetTableWithHeadlineData = "GetTableWithHeadlineData"
3831
+ }
3832
+ export interface AnswerServiceType {
3833
+ getAnswer?: (offset: number, batchSize: number) => any;
3834
+ }
3835
+ export declare enum PrefetchFeatures {
3836
+ FullApp = "FullApp",
3837
+ SearchEmbed = "SearchEmbed",
3838
+ LiveboardEmbed = "LiveboardEmbed",
3839
+ VizEmbed = "VizEmbed"
3840
+ }
3841
+ /**
3842
+ * Enum for options to change context trigger
3843
+ */
3844
+ export declare enum ContextMenuTriggerOptions {
3845
+ LEFT_CLICK = "left-click",
3846
+ RIGHT_CLICK = "right-click"
3847
+ }
3848
+
3849
+ /**
3850
+ * Copyright (c) 2022
3851
+ *
3852
+ * Base classes
3853
+ *
3854
+ * @summary Base classes
3855
+ * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
3856
+ */
3857
+ /**
3858
+ * Global prefix for all Thoughtspot postHash Params.
3859
+ */
3860
+ export declare const THOUGHTSPOT_PARAM_PREFIX = "ts-";
3861
+ /**
3862
+ * Base class for embedding v2 experience
3863
+ * Note: the v2 version of ThoughtSpot Blink is built on the new stack:
3864
+ * React+GraphQL
3865
+ */
3866
+ export declare class TsEmbed {
3867
+ protected isAppInitialized: boolean;
3868
+ /**
3869
+ * A reference to the iframe within which the ThoughtSpot app
3870
+ * will be rendered.
3871
+ */
3872
+ protected iFrame: HTMLIFrameElement;
3873
+ protected viewConfig: ViewConfig;
3874
+ protected embedConfig: EmbedConfig;
3875
+ /**
3876
+ * The ThoughtSpot hostname or IP address
3877
+ */
3878
+ protected thoughtSpotHost: string;
3879
+ protected thoughtSpotV2Base: string;
3880
+ constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
3881
+ /**
3882
+ * Handles errors within the SDK
3883
+ *
3884
+ * @param error The error message or object
3885
+ */
3886
+ protected handleError(error: string | Record<string, unknown>): void;
3887
+ /**
3888
+ * Constructs the base URL string to load the ThoughtSpot app.
3889
+ *
3890
+ * @param query
3891
+ */
3892
+ protected getEmbedBasePath(query: string): string;
3893
+ /**
3894
+ * Common query params set for all the embed modes.
3895
+ *
3896
+ * @param queryParams
3897
+ * @returns queryParams
3898
+ */
3899
+ protected getBaseQueryParams(queryParams?: {}): {};
3900
+ /**
3901
+ * Constructs the base URL string to load v1 of the ThoughtSpot app.
3902
+ * This is used for embedding Liveboards, visualizations, and full application.
3903
+ *
3904
+ * @param queryString The query string to append to the URL.
3905
+ * @param isAppEmbed A Boolean parameter to specify if you are embedding
3906
+ * the full application.
3907
+ */
3908
+ protected getV1EmbedBasePath(queryString: string): string;
3909
+ protected getEmbedParams(): string;
3910
+ protected getRootIframeSrc(): string;
3911
+ protected createIframeEl(frameSrc: string): HTMLIFrameElement;
3912
+ /**
3913
+ * Renders the embedded ThoughtSpot app in an iframe and sets up
3914
+ * event listeners.
3644
3915
  *
3645
- * @example
3646
- * ```js
3647
- * disabledActions: [Action.AxisMenuGroup]
3648
- * ```
3649
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3916
+ * @param url
3917
+ * @param frameOptions
3650
3918
  */
3651
- AxisMenuGroup = "axisMenuGroup",
3919
+ protected renderIFrame(url: string): Promise<any>;
3920
+ protected insertIntoDOM(child: string | Node): void;
3652
3921
  /**
3653
- * The **Position** option in the axis customization menu.
3654
- * Allows changing the position of the axis to the
3655
- * left or right side of the chart.
3922
+ * Sets the height of the iframe
3656
3923
  *
3657
- * @example
3658
- * ```js
3659
- * disabledActions: [Action.AxisMenuPosition]
3660
- * ```
3661
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3924
+ * @param height The height in pixels
3662
3925
  */
3663
- AxisMenuPosition = "axisMenuPosition",
3926
+ protected setIFrameHeight(height: number | string): void;
3664
3927
  /**
3665
- * The **Rename** option in the chart axis or table column customization menu.
3666
- * Renames the axis label on a chart or the column header on a table.
3928
+ * Executes all registered event handlers for a particular event type
3667
3929
  *
3668
- * @example
3669
- * ```js
3670
- * disabledActions: [Action.AxisMenuRename]
3671
- * ```
3672
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3930
+ * @param eventType The event type
3931
+ * @param data The payload invoked with the event handler
3932
+ * @param eventPort The event Port for a specific MessageChannel
3673
3933
  */
3674
- AxisMenuRename = "axisMenuRename",
3934
+ protected executeCallbacks(eventType: EmbedEvent, data: any, eventPort?: MessagePort | void): void;
3675
3935
  /**
3676
- * The **Edit** action in the axis customization menu.
3677
- * Allows editing the axis name, position, minimum and maximum values,
3678
- * and format of a column.
3936
+ * Returns the ThoughtSpot hostname or IP address.
3937
+ */
3938
+ protected getThoughtSpotHost(): string;
3939
+ /**
3940
+ * Gets the v1 event type (if applicable) for the EmbedEvent type
3679
3941
  *
3680
- * @example
3681
- * ```js
3682
- * disabledActions: [Action.AxisMenuEdit]
3683
- * ```
3684
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3942
+ * @param eventType The v2 event type
3943
+ * @returns The corresponding v1 event type if one exists
3944
+ * or else the v2 event type itself
3685
3945
  */
3686
- AxisMenuEdit = "axisMenuEdit",
3946
+ protected getCompatibleEventType(eventType: EmbedEvent): EmbedEvent;
3687
3947
  /**
3688
- * The **Number format** action to customize the format of
3689
- * the data labels on a chart or table.
3948
+ * Calculates the iframe center for the current visible viewPort
3949
+ * of iframe using Scroll position of Host App, offsetTop for iframe
3950
+ * in Host app. ViewPort height of the tab.
3690
3951
  *
3691
- * @example
3692
- * ```js
3693
- * disabledActions: [Action.AxisMenuNumberFormat]
3694
- * ```
3695
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3952
+ * @returns iframe Center in visible viewport,
3953
+ * Iframe height,
3954
+ * View port height.
3696
3955
  */
3697
- AxisMenuNumberFormat = "axisMenuNumberFormat",
3956
+ protected getIframeCenter(): {
3957
+ iframeCenter: number;
3958
+ iframeScrolled: number;
3959
+ iframeHeight: number;
3960
+ viewPortHeight: number;
3961
+ iframeVisibleViewPort: number;
3962
+ };
3698
3963
  /**
3699
- * The **Text wrapping** action on a table.
3700
- * Wraps or clips column text on a table.
3964
+ * Registers an event listener to trigger an alert when the ThoughtSpot app
3965
+ * sends an event of a particular message type to the host application.
3701
3966
  *
3967
+ * @param messageType The message type
3968
+ * @param callback A callback as a function
3969
+ * @param options The message options
3970
+ * @param isSelf
3971
+ * @param isRegisteredBySDK
3702
3972
  * @example
3703
3973
  * ```js
3704
- * disabledActions: [Action.AxisMenuTextWrapping]
3974
+ * tsEmbed.on(EmbedEvent.Error, (data) => {
3975
+ * console.error(data);
3976
+ * });
3705
3977
  * ```
3706
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3707
- */
3708
- AxisMenuTextWrapping = "axisMenuTextWrapping",
3709
- /**
3710
- * The **Remove** action in the chart axis or table column
3711
- * customization menu.
3712
- * Removes the data labels from a chart or the column of a
3713
- * table visualization.
3714
- *
3715
3978
  * @example
3716
3979
  * ```js
3717
- * disabledActions: [Action.AxisMenuRemove]
3980
+ * tsEmbed.on(EmbedEvent.Save, (data) => {
3981
+ * console.log("Answer save clicked", data);
3982
+ * }, {
3983
+ * start: true // This will trigger the callback on start of save
3984
+ * });
3718
3985
  * ```
3719
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3720
- */
3721
- AxisMenuRemove = "axisMenuRemove",
3722
- /**
3723
- * @hidden
3724
3986
  */
3725
- InsertInToSlide = "insertInToSlide",
3987
+ on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
3726
3988
  /**
3727
- * The **Rename** menu action on Liveboards and visualizations.
3728
- * Allows renaming a Liveboard or visualization.
3989
+ * Removes an event listener for a particular event type.
3729
3990
  *
3991
+ * @param messageType The message type
3992
+ * @param callback The callback to remove
3730
3993
  * @example
3731
3994
  * ```js
3732
- * disabledActions: [Action.RenameModalTitleDescription]
3995
+ * const errorHandler = (data) => { console.error(data); };
3996
+ * tsEmbed.on(EmbedEvent.Error, errorHandler);
3997
+ * tsEmbed.off(EmbedEvent.Error, errorHandler);
3733
3998
  * ```
3734
- * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3735
- */
3736
- RenameModalTitleDescription = "renameModalTitleDescription",
3737
- /**
3738
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3739
3999
  */
3740
- RequestVerification = "requestVerification",
4000
+ off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
3741
4001
  /**
3742
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
4002
+ * Triggers an event to the embedded app
4003
+ *
4004
+ * @param messageType The event type
4005
+ * @param data The payload to send with the message
3743
4006
  */
3744
- MarkAsVerified = "markAsVerified",
4007
+ trigger(messageType: HostEvent, data?: any): Promise<any>;
3745
4008
  /**
3746
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
4009
+ * Marks the ThoughtSpot object to have been rendered
4010
+ * Needs to be overridden by subclasses to do the actual
4011
+ * rendering of the iframe.
4012
+ *
4013
+ * @param args
3747
4014
  */
3748
- AddTab = "addTab",
4015
+ render(): TsEmbed;
3749
4016
  /**
3750
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
4017
+ * Get the Post Url Params for THOUGHTSPOT from the current
4018
+ * host app URL.
4019
+ * THOUGHTSPOT URL params starts with a prefix "ts-"
4020
+ *
4021
+ * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
3751
4022
  */
3752
- EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
4023
+ getThoughtSpotPostUrlParams(): string;
3753
4024
  /**
3754
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4025
+ * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
4026
+ *
4027
+ * @version SDK: 1.19.1 | ThoughtSpot: *
3755
4028
  */
3756
- ShowSageQuery = "showSageQuery",
4029
+ destroy(): void;
4030
+ getUnderlyingFrameElement(): HTMLIFrameElement;
3757
4031
  /**
3758
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4032
+ * Prerenders a generic instance of the TS component.
4033
+ * This means without the path but with the flags already applied.
4034
+ * This is useful for prerendering the component in the background.
4035
+ *
4036
+ * @version SDK: 1.22.0
4037
+ * @returns
3759
4038
  */
3760
- EditSageAnswer = "editSageAnswer",
4039
+ prerenderGeneric(): Promise<any>;
4040
+ }
4041
+ /**
4042
+ * Base class for embedding v1 experience
4043
+ * Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
4044
+ * which is currently under migration to v2
4045
+ *
4046
+ * @inheritdoc
4047
+ */
4048
+ export declare class V1Embed extends TsEmbed {
4049
+ protected viewConfig: ViewConfig;
4050
+ constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
3761
4051
  /**
3762
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4052
+ * Render the app in an iframe and set up event handlers
4053
+ *
4054
+ * @param iframeSrc
3763
4055
  */
3764
- SageAnswerFeedback = "sageAnswerFeedback",
4056
+ protected renderV1Embed(iframeSrc: string): any;
4057
+ protected getRootIframeSrc(): string;
3765
4058
  /**
3766
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4059
+ * @inheritdoc
4060
+ * @example
4061
+ * ```js
4062
+ * tsEmbed.on(EmbedEvent.Error, (data) => {
4063
+ * console.error(data);
4064
+ * });
4065
+ * ```
4066
+ * @example
4067
+ * ```js
4068
+ * tsEmbed.on(EmbedEvent.Save, (data) => {
4069
+ * console.log("Answer save clicked", data);
4070
+ * }, {
4071
+ * start: true // This will trigger the callback on start of save
4072
+ * });
4073
+ * ```
3767
4074
  */
3768
- ModifySageAnswer = "modifySageAnswer"
3769
- }
3770
- export interface SessionInterface {
3771
- sessionId: string;
3772
- genNo: number;
3773
- acSession: {
3774
- sessionId: string;
3775
- genNo: number;
3776
- };
3777
- }
3778
- export declare enum OperationType {
3779
- GetChartWithData = "GetChartWithData",
3780
- GetTableWithHeadlineData = "GetTableWithHeadlineData"
3781
- }
3782
- export interface AnswerServiceType {
3783
- getAnswer?: (offset: number, batchSize: number) => any;
3784
- }
3785
- export declare enum PrefetchFeatures {
3786
- FullApp = "FullApp",
3787
- SearchEmbed = "SearchEmbed",
3788
- LiveboardEmbed = "LiveboardEmbed",
3789
- VizEmbed = "VizEmbed"
3790
- }
3791
- /**
3792
- * Enum for options to change context trigger
3793
- */
3794
- export declare enum ContextMenuTriggerOptions {
3795
- LEFT_CLICK = "left-click",
3796
- RIGHT_CLICK = "right-click"
4075
+ on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
3797
4076
  }
3798
4077
 
3799
4078
  export interface executeTMLInput {
@@ -3882,7 +4161,20 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
3882
4161
  * @param fn The function being registered
3883
4162
  */
3884
4163
  export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
4164
+ /**
4165
+ * Imports TML representation of the metadata objects into ThoughtSpot.
4166
+ *
4167
+ * @param data
4168
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
4169
+ */
3885
4170
  export declare const executeTML: (data: executeTMLInput) => Promise<any>;
4171
+ /**
4172
+ * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
4173
+ * format.
4174
+ *
4175
+ * @param data
4176
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
4177
+ */
3886
4178
  export declare const exportTML: (data: exportTMLInput) => Promise<any>;
3887
4179
  /**
3888
4180
  *
@@ -4093,6 +4385,12 @@ export interface CustomCssVariables {
4093
4385
  * Text transformation specification for UI elements in the app.
4094
4386
  */
4095
4387
  '--ts-var-root-text-transform'?: string;
4388
+ /**
4389
+ * application color, it replaces #2770EF which is rd-color(blue,base) and
4390
+ * its similar colors like rd-color(blue,60), rd-color(accent, base) and
4391
+ * rd-color(text, accent) in the app.
4392
+ */
4393
+ '--ts-var-application-color'?: string;
4096
4394
  /**
4097
4395
  * Background color of the top navigation panel.
4098
4396
  */
@@ -4353,6 +4651,10 @@ export interface CustomCssVariables {
4353
4651
  * Background color for menu items on hover.
4354
4652
  */
4355
4653
  '--ts-var-menu--hover-background'?: string;
4654
+ /**
4655
+ * Text color for selected menu items.
4656
+ */
4657
+ '--ts-var-menu-selected-text-color'?: string;
4356
4658
  /**
4357
4659
  * Background color of the dialogs.
4358
4660
  */
@@ -4373,5 +4675,33 @@ export interface CustomCssVariables {
4373
4675
  * Background color of the footer area on dialogs.
4374
4676
  */
4375
4677
  '--ts-var-dialog-footer-background'?: string;
4678
+ /**
4679
+ * Background for selected state in list
4680
+ */
4681
+ '--ts-var-list-selected-background'?: string;
4682
+ /**
4683
+ * Background for hover state in list
4684
+ */
4685
+ '--ts-var-list-hover-background'?: string;
4686
+ /**
4687
+ * Background for hover state in segment control.
4688
+ */
4689
+ '--ts-var-segment-control-hover-background'?: string;
4690
+ /**
4691
+ * Text color for slected item in modular home's watchlist.
4692
+ */
4693
+ '--ts-var-home-watchlist-selected-text-color'?: string;
4694
+ /**
4695
+ * Text color for favorite carousel find your favorites card in modular home.
4696
+ */
4697
+ '--ts-var-home-favorite-suggestion-card-text-color'?: string;
4698
+ /**
4699
+ * Icon color for favorite carousel find your favorites card in modular home.
4700
+ */
4701
+ '--ts-var-home-favorite-suggestion-card-icon-color'?: string;
4702
+ /**
4703
+ * Background for favorite carousel find your favorites card in modular home.
4704
+ */
4705
+ '--ts-var-home-favorite-suggestion-card-background'?: string;
4376
4706
  }
4377
4707