@thoughtspot/visual-embed-sdk 1.25.0-alpha.2 → 1.25.0-alpha.4

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 (155) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +35 -1
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +5 -1
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/app.spec.js +19 -0
  7. package/cjs/src/embed/app.spec.js.map +1 -1
  8. package/cjs/src/embed/liveboard.d.ts +37 -3
  9. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  10. package/cjs/src/embed/liveboard.js +11 -1
  11. package/cjs/src/embed/liveboard.js.map +1 -1
  12. package/cjs/src/embed/liveboard.spec.js +11 -0
  13. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  14. package/cjs/src/embed/sage.d.ts +45 -7
  15. package/cjs/src/embed/sage.d.ts.map +1 -1
  16. package/cjs/src/embed/sage.js +9 -3
  17. package/cjs/src/embed/sage.js.map +1 -1
  18. package/cjs/src/embed/sage.spec.js +85 -6
  19. package/cjs/src/embed/sage.spec.js.map +1 -1
  20. package/cjs/src/embed/search-bar.d.ts +1 -1
  21. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  22. package/cjs/src/embed/search-bar.js.map +1 -1
  23. package/cjs/src/embed/search.d.ts +1 -1
  24. package/cjs/src/embed/search.d.ts.map +1 -1
  25. package/cjs/src/embed/search.js.map +1 -1
  26. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  27. package/cjs/src/embed/ts-embed.js +1 -10
  28. package/cjs/src/embed/ts-embed.js.map +1 -1
  29. package/cjs/src/embed/ts-embed.spec.js +3 -3
  30. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  31. package/cjs/src/types.d.ts +23 -28
  32. package/cjs/src/types.d.ts.map +1 -1
  33. package/cjs/src/types.js +20 -5
  34. package/cjs/src/types.js.map +1 -1
  35. package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -1
  36. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  37. package/cjs/src/utils/graphql/answerService/answerService.js +3 -5
  38. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  39. package/cjs/src/utils/graphql/answerService/answerService.spec.js +1 -1
  40. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  41. package/cjs/src/utils/graphql/sourceService.d.ts.map +1 -1
  42. package/cjs/src/utils/graphql/sourceService.js +3 -1
  43. package/cjs/src/utils/graphql/sourceService.js.map +1 -1
  44. package/cjs/src/utils.js +2 -2
  45. package/cjs/src/utils.js.map +1 -1
  46. package/cjs/src/utils.spec.js +10 -0
  47. package/cjs/src/utils.spec.js.map +1 -1
  48. package/dist/src/embed/app.d.ts +35 -1
  49. package/dist/src/embed/app.d.ts.map +1 -1
  50. package/dist/src/embed/liveboard.d.ts +37 -3
  51. package/dist/src/embed/liveboard.d.ts.map +1 -1
  52. package/dist/src/embed/sage.d.ts +45 -7
  53. package/dist/src/embed/sage.d.ts.map +1 -1
  54. package/dist/src/embed/search-bar.d.ts +1 -1
  55. package/dist/src/embed/search-bar.d.ts.map +1 -1
  56. package/dist/src/embed/search.d.ts +1 -1
  57. package/dist/src/embed/search.d.ts.map +1 -1
  58. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  59. package/dist/src/types.d.ts +23 -28
  60. package/dist/src/types.d.ts.map +1 -1
  61. package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -1
  62. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  63. package/dist/src/utils/graphql/sourceService.d.ts.map +1 -1
  64. package/dist/tsembed-react.es.js +55 -29
  65. package/dist/tsembed-react.js +55 -29
  66. package/dist/tsembed.es.js +55 -29
  67. package/dist/tsembed.js +55 -29
  68. package/dist/visual-embed-sdk-react-full.d.ts +144 -42
  69. package/dist/visual-embed-sdk-react.d.ts +144 -42
  70. package/dist/visual-embed-sdk.d.ts +144 -42
  71. package/lib/package.json +1 -1
  72. package/lib/src/embed/app.d.ts +35 -1
  73. package/lib/src/embed/app.d.ts.map +1 -1
  74. package/lib/src/embed/app.js +5 -1
  75. package/lib/src/embed/app.js.map +1 -1
  76. package/lib/src/embed/app.spec.js +19 -0
  77. package/lib/src/embed/app.spec.js.map +1 -1
  78. package/lib/src/embed/liveboard.d.ts +37 -3
  79. package/lib/src/embed/liveboard.d.ts.map +1 -1
  80. package/lib/src/embed/liveboard.js +11 -1
  81. package/lib/src/embed/liveboard.js.map +1 -1
  82. package/lib/src/embed/liveboard.spec.js +11 -0
  83. package/lib/src/embed/liveboard.spec.js.map +1 -1
  84. package/lib/src/embed/sage.d.ts +45 -7
  85. package/lib/src/embed/sage.d.ts.map +1 -1
  86. package/lib/src/embed/sage.js +9 -3
  87. package/lib/src/embed/sage.js.map +1 -1
  88. package/lib/src/embed/sage.spec.js +85 -6
  89. package/lib/src/embed/sage.spec.js.map +1 -1
  90. package/lib/src/embed/search-bar.d.ts +1 -1
  91. package/lib/src/embed/search-bar.d.ts.map +1 -1
  92. package/lib/src/embed/search-bar.js.map +1 -1
  93. package/lib/src/embed/search.d.ts +1 -1
  94. package/lib/src/embed/search.d.ts.map +1 -1
  95. package/lib/src/embed/search.js.map +1 -1
  96. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  97. package/lib/src/embed/ts-embed.js +1 -10
  98. package/lib/src/embed/ts-embed.js.map +1 -1
  99. package/lib/src/embed/ts-embed.spec.js +3 -3
  100. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  101. package/lib/src/types.d.ts +23 -28
  102. package/lib/src/types.d.ts.map +1 -1
  103. package/lib/src/types.js +20 -5
  104. package/lib/src/types.js.map +1 -1
  105. package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -1
  106. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  107. package/lib/src/utils/graphql/answerService/answerService.js +3 -5
  108. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  109. package/lib/src/utils/graphql/answerService/answerService.spec.js +1 -1
  110. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  111. package/lib/src/utils/graphql/sourceService.d.ts.map +1 -1
  112. package/lib/src/utils/graphql/sourceService.js +3 -1
  113. package/lib/src/utils/graphql/sourceService.js.map +1 -1
  114. package/lib/src/utils.js +2 -2
  115. package/lib/src/utils.js.map +1 -1
  116. package/lib/src/utils.spec.js +10 -0
  117. package/lib/src/utils.spec.js.map +1 -1
  118. package/lib/src/visual-embed-sdk.d.ts +144 -42
  119. package/package.json +1 -1
  120. package/src/embed/app.spec.ts +29 -0
  121. package/src/embed/app.ts +43 -1
  122. package/src/embed/liveboard.spec.ts +16 -0
  123. package/src/embed/liveboard.ts +53 -3
  124. package/src/embed/sage.spec.ts +119 -6
  125. package/src/embed/sage.ts +63 -13
  126. package/src/embed/search-bar.tsx +11 -1
  127. package/src/embed/search.ts +5 -1
  128. package/src/embed/ts-embed.spec.ts +3 -3
  129. package/src/embed/ts-embed.ts +0 -12
  130. package/src/types.ts +21 -26
  131. package/src/utils/graphql/answerService/answerService.spec.ts +1 -1
  132. package/src/utils/graphql/answerService/answerService.ts +3 -5
  133. package/src/utils/graphql/sourceService.ts +4 -1
  134. package/src/utils.spec.ts +13 -0
  135. package/src/utils.ts +2 -2
  136. package/cjs/src/utils/answerService.d.ts +0 -10
  137. package/cjs/src/utils/answerService.d.ts.map +0 -1
  138. package/cjs/src/utils/answerService.js +0 -61
  139. package/cjs/src/utils/answerService.js.map +0 -1
  140. package/cjs/src/utils/answerService.spec.d.ts +0 -2
  141. package/cjs/src/utils/answerService.spec.d.ts.map +0 -1
  142. package/cjs/src/utils/answerService.spec.js +0 -31
  143. package/cjs/src/utils/answerService.spec.js.map +0 -1
  144. package/dist/src/utils/answerService.d.ts +0 -10
  145. package/dist/src/utils/answerService.d.ts.map +0 -1
  146. package/dist/src/utils/answerService.spec.d.ts +0 -2
  147. package/dist/src/utils/answerService.spec.d.ts.map +0 -1
  148. package/lib/src/utils/answerService.d.ts +0 -10
  149. package/lib/src/utils/answerService.d.ts.map +0 -1
  150. package/lib/src/utils/answerService.js +0 -57
  151. package/lib/src/utils/answerService.js.map +0 -1
  152. package/lib/src/utils/answerService.spec.d.ts +0 -2
  153. package/lib/src/utils/answerService.spec.d.ts.map +0 -1
  154. package/lib/src/utils/answerService.spec.js +0 -29
  155. package/lib/src/utils/answerService.spec.js.map +0 -1
@@ -124,7 +124,7 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
124
124
  /**
125
125
  * @group Embed components
126
126
  */
127
- export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
127
+ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
128
128
  /**
129
129
  * The array of data source GUIDs to set on load.
130
130
  * Only a single dataSource supported currently.
@@ -181,7 +181,7 @@ export declare class SearchBarEmbed extends TsEmbed {
181
181
  */
182
182
  export interface SearchOptions {
183
183
  /**
184
- * The tml string to load the answer
184
+ * The query string to pre-fill in natual language search bar
185
185
  */
186
186
  searchQuery: string;
187
187
  /**
@@ -199,15 +199,45 @@ export interface SearchOptions {
199
199
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
200
200
  * @group Embed components
201
201
  */
202
- export interface SageViewConfig extends ViewConfig {
202
+ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
203
203
  /**
204
204
  * If set to true, a list of liveboard and answers related
205
205
  * to the natural language search will be shown below the
206
206
  * AI generated answer.
207
+ *
208
+ * @deprecated Currently liveboard and answers related
209
+ * to the natural language search will not be shown for sage
210
+ * embed
207
211
  */
208
212
  showObjectResults?: boolean;
213
+ /**
214
+ * flag used by the TS product tour page to show the blue search bar
215
+ * even after the search is completed. This is different from TSE Sage Embed
216
+ * experience where it mimics closer to the non-embed case.
217
+ * The Sample questions container is collapsed when this value is set after
218
+ * does a search.
219
+ *
220
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
221
+ * @hidden
222
+ */
223
+ isProductTour?: boolean;
224
+ /**
225
+ * flag to hide search bar title. default false.
226
+ *
227
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
228
+ */
229
+ hideSearchBarTitle?: boolean;
230
+ /**
231
+ * flag to disable Sage Answer header(`AI Answer` title section on top of the Sage
232
+ * answer). default false.
233
+ *
234
+ * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
235
+ */
236
+ hideSageAnswerHeader?: boolean;
209
237
  /**
210
238
  * flag to disable changing worksheet. default false.
239
+ *
240
+ * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
211
241
  */
212
242
  disableWorksheetChange?: boolean;
213
243
  /**
@@ -215,18 +245,24 @@ export interface SageViewConfig extends ViewConfig {
215
245
  */
216
246
  hideWorksheetSelector?: boolean;
217
247
  /**
218
- * If set to true, the search suggestions will contain existing
219
- * liveboards and answers in addition with the autocomplete
248
+ * If set to true, the search bar auto complete search suggestions will not be shown.
249
+ * default false
220
250
  *
251
+ * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
221
252
  */
222
- showObjectSuggestions?: boolean;
253
+ hideAutocompleteSuggestions?: boolean;
223
254
  /**
224
- * The query string to pre-fill in natual language search bar
255
+ * If set to false, the auto complete search suggestions not be shown
256
+ *
257
+ * @deprecated currently, object suggestions will not be shown for sage embed
258
+ * earlier this flag was used to show Auto complete suggestions
225
259
  */
226
- searchQuery?: string;
260
+ showObjectSuggestions?: boolean;
227
261
  /**
228
262
  * If set to true, sample questions would be hidden to user.
229
263
  * These sample questions are autogenerated based on selected datasource.
264
+ *
265
+ * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
230
266
  */
231
267
  hideSampleQuestions?: boolean;
232
268
  /**
@@ -235,6 +271,8 @@ export interface SageViewConfig extends ViewConfig {
235
271
  dataSource?: string;
236
272
  /**
237
273
  * Configuration for search options
274
+ *
275
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
238
276
  */
239
277
  searchOptions?: SearchOptions;
240
278
  }
@@ -297,7 +335,7 @@ export interface SearchOptions {
297
335
  *
298
336
  * @group Embed components
299
337
  */
300
- export interface SearchViewConfig extends ViewConfig {
338
+ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
301
339
  /**
302
340
  * If set to true, the data sources panel is collapsed on load,
303
341
  * but can be expanded manually.
@@ -444,7 +482,7 @@ export declare enum Page {
444
482
  *
445
483
  * @group Embed components
446
484
  */
447
- export interface AppViewConfig extends ViewConfig {
485
+ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
448
486
  /**
449
487
  * If true, the main navigation bar within the ThoughtSpot app
450
488
  * is displayed. By default, the navigation bar is hidden.
@@ -538,6 +576,27 @@ export interface AppViewConfig extends ViewConfig {
538
576
  * @hidden
539
577
  */
540
578
  dataPanelV2?: boolean;
579
+ /**
580
+ * Show or hide Liveboard header
581
+ *
582
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
583
+ * @default false
584
+ */
585
+ hideLiveboardHeader?: boolean;
586
+ /**
587
+ * Show or hide Liveboard title
588
+ *
589
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
590
+ * @default false
591
+ */
592
+ showLiveboardTitle?: boolean;
593
+ /**
594
+ * Show or hide Liveboard description
595
+ *
596
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
597
+ * @default false
598
+ */
599
+ showLiveboardDescription?: boolean;
541
600
  /**
542
601
  * Flag to control new Modular Home experience
543
602
  *
@@ -545,6 +604,19 @@ export interface AppViewConfig extends ViewConfig {
545
604
  * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
546
605
  */
547
606
  modularHomeExperience?: boolean;
607
+ /**
608
+ * Boolean to control if Liveboard header is sticky or not.
609
+ *
610
+ * @example
611
+ * ```js
612
+ * const embed = new AppEmbed('#embed', {
613
+ * ... // other app view config
614
+ * isLiveboardHeaderSticky: true,
615
+ * });
616
+ * ```
617
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
618
+ */
619
+ isLiveboardHeaderSticky?: boolean;
548
620
  }
549
621
  /**
550
622
  * Embeds full ThoughtSpot experience in a host application.
@@ -604,7 +676,7 @@ export declare class AppEmbed extends V1Embed {
604
676
  *
605
677
  * @group Embed components
606
678
  */
607
- export interface LiveboardViewConfig extends ViewConfig {
679
+ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
608
680
  /**
609
681
  * If set to true, the embedded object container dynamically resizes
610
682
  * according to the height of the Liveboard.
@@ -670,7 +742,7 @@ export interface LiveboardViewConfig extends ViewConfig {
670
742
  */
671
743
  liveboardV2?: boolean;
672
744
  /**
673
- * Tab Id of the Liveboard that is supposed to be active
745
+ * Tab ID of the Liveboard that is supposed to be active
674
746
  *
675
747
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
676
748
  */
@@ -682,9 +754,43 @@ export interface LiveboardViewConfig extends ViewConfig {
682
754
  */
683
755
  hideTabPanel?: boolean;
684
756
  /**
685
- * The list of parameter override to apply to a Liveboard.
757
+ * Show or hide Liveboard header
758
+ *
759
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
760
+ * @default false
761
+ */
762
+ hideLiveboardHeader?: boolean;
763
+ /**
764
+ * Show or hide Liveboard title
765
+ *
766
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
767
+ * @default false
768
+ */
769
+ showLiveboardTitle?: boolean;
770
+ /**
771
+ * Show or hide Liveboard description
772
+ *
773
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
774
+ * @default false
775
+ */
776
+ showLiveboardDescription?: boolean;
777
+ /**
778
+ * The list of parameter overrides to apply to a Liveboard.
686
779
  */
687
780
  runtimeParameters?: RuntimeParameter[];
781
+ /**
782
+ * Boolean for sticky Liveboard header.
783
+ *
784
+ * @example
785
+ * ```js
786
+ * const embed = new LiveboardEmbed('#embed', {
787
+ * ... // other liveboard view config
788
+ * isLiveboardHeaderSticky: true,
789
+ * });
790
+ * ```
791
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
792
+ */
793
+ isLiveboardHeaderSticky?: boolean;
688
794
  }
689
795
  /**
690
796
  * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -1727,27 +1833,6 @@ export interface ViewConfig {
1727
1833
  * @hidden
1728
1834
  */
1729
1835
  excludeRuntimeFiltersfromURL?: boolean;
1730
- /**
1731
- * Boolean to hide liveboard header
1732
- *
1733
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1734
- * @default false
1735
- */
1736
- hideLiveboardHeader?: boolean;
1737
- /**
1738
- * Boolean to show liveboard title
1739
- *
1740
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1741
- * @default false
1742
- */
1743
- showLiveboardTitle?: boolean;
1744
- /**
1745
- * Boolean to show liveboard description
1746
- *
1747
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1748
- * @default false
1749
- */
1750
- showLiveboardDescription?: boolean;
1751
1836
  /**
1752
1837
  * The list of tab IDs to hide from the embedded.
1753
1838
  * This Tabs will be hidden from their respective LBs.
@@ -1775,6 +1860,7 @@ export interface ViewConfig {
1775
1860
  /**
1776
1861
  * reordering the home page modules
1777
1862
  * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
1863
+ *
1778
1864
  * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
1779
1865
  */
1780
1866
  reorderedHomepageModules?: HomepageModule[];
@@ -2508,11 +2594,11 @@ export declare enum HostEvent {
2508
2594
  * @param - execute - executes the existing / updated query
2509
2595
  * @example
2510
2596
  * ```js
2511
- * searchEmbed.trigger(HostEvent.Search, {
2512
- * searchQuery: "[sales] by [item type],
2513
- * dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
2514
- * execute: true
2515
- * })
2597
+ * searchembed.trigger(HostEvent.Search, {
2598
+ searchQuery: "[sales] by [item type]",
2599
+ dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
2600
+ execute: true
2601
+ });
2516
2602
  * ```
2517
2603
  */
2518
2604
  Search = "search",
@@ -3266,6 +3352,7 @@ export declare enum Param {
3266
3352
  DisableWorksheetChange = "disableWorksheetChange",
3267
3353
  HideEurekaResults = "hideEurekaResults",
3268
3354
  HideEurekaSuggestions = "hideEurekaSuggestions",
3355
+ HideAutocompleteSuggestions = "hideAutocompleteSuggestions",
3269
3356
  HideLiveboardHeader = "hideLiveboardHeader",
3270
3357
  ShowLiveboardDescription = "showLiveboardDescription",
3271
3358
  ShowLiveboardTitle = "showLiveboardTitle",
@@ -3277,7 +3364,11 @@ export declare enum Param {
3277
3364
  Query = "query",
3278
3365
  HideHomepageLeftNav = "hideHomepageLeftNav",
3279
3366
  ModularHomeExperienceEnabled = "modularHomeExperience",
3280
- PendoTrackingKey = "additionalPendoKey"
3367
+ PendoTrackingKey = "additionalPendoKey",
3368
+ LiveboardHeaderSticky = "isLiveboardHeaderSticky",
3369
+ IsProductTour = "isProductTour",
3370
+ HideSearchBarTitle = "hideSearchBarTitle",
3371
+ HideSageAnswerHeader = "hideSageAnswerHeader"
3281
3372
  }
3282
3373
  /**
3283
3374
  * ThoughtSpot application pages include actions and menu commands
@@ -4113,7 +4204,17 @@ export declare enum Action {
4113
4204
  * ```
4114
4205
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
4115
4206
  */
4116
- PersonalisedViewsDropdown = "personalisedViewsDropdown"
4207
+ PersonalisedViewsDropdown = "personalisedViewsDropdown",
4208
+ /**
4209
+ * Action ID for Liveboard Users ( Recently Visited / social proof )
4210
+ *
4211
+ * @example
4212
+ * ```js
4213
+ * disabledActions: [Action.LiveboardUsers]
4214
+ * ```
4215
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
4216
+ */
4217
+ LiveboardUsers = "liveboardUsers"
4117
4218
  }
4118
4219
  export interface AnswerServiceType {
4119
4220
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -4553,9 +4654,10 @@ export declare class AnswerService {
4553
4654
  *
4554
4655
  * @param userLocale
4555
4656
  * @param omitInfo Omit the download Info on top of the CSV
4657
+ * @param includeInfo
4556
4658
  * @returns Response
4557
4659
  */
4558
- fetchCSVBlob(userLocale?: string, omitInfo?: boolean): Promise<Response>;
4660
+ fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
4559
4661
  getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
4560
4662
  executeQuery(query: string, variables: any): Promise<any>;
4561
4663
  getSession(): SessionInterface;
@@ -113,7 +113,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
113
113
  /**
114
114
  * @group Embed components
115
115
  */
116
- export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
116
+ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
117
117
  /**
118
118
  * The array of data source GUIDs to set on load.
119
119
  * Only a single dataSource supported currently.
@@ -170,7 +170,7 @@ export declare class SearchBarEmbed extends TsEmbed {
170
170
  */
171
171
  export interface SearchOptions {
172
172
  /**
173
- * The tml string to load the answer
173
+ * The query string to pre-fill in natual language search bar
174
174
  */
175
175
  searchQuery: string;
176
176
  /**
@@ -188,15 +188,45 @@ export interface SearchOptions {
188
188
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
189
189
  * @group Embed components
190
190
  */
191
- export interface SageViewConfig extends ViewConfig {
191
+ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
192
192
  /**
193
193
  * If set to true, a list of liveboard and answers related
194
194
  * to the natural language search will be shown below the
195
195
  * AI generated answer.
196
+ *
197
+ * @deprecated Currently liveboard and answers related
198
+ * to the natural language search will not be shown for sage
199
+ * embed
196
200
  */
197
201
  showObjectResults?: boolean;
202
+ /**
203
+ * flag used by the TS product tour page to show the blue search bar
204
+ * even after the search is completed. This is different from TSE Sage Embed
205
+ * experience where it mimics closer to the non-embed case.
206
+ * The Sample questions container is collapsed when this value is set after
207
+ * does a search.
208
+ *
209
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
210
+ * @hidden
211
+ */
212
+ isProductTour?: boolean;
213
+ /**
214
+ * flag to hide search bar title. default false.
215
+ *
216
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
217
+ */
218
+ hideSearchBarTitle?: boolean;
219
+ /**
220
+ * flag to disable Sage Answer header(`AI Answer` title section on top of the Sage
221
+ * answer). default false.
222
+ *
223
+ * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
224
+ */
225
+ hideSageAnswerHeader?: boolean;
198
226
  /**
199
227
  * flag to disable changing worksheet. default false.
228
+ *
229
+ * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
200
230
  */
201
231
  disableWorksheetChange?: boolean;
202
232
  /**
@@ -204,18 +234,24 @@ export interface SageViewConfig extends ViewConfig {
204
234
  */
205
235
  hideWorksheetSelector?: boolean;
206
236
  /**
207
- * If set to true, the search suggestions will contain existing
208
- * liveboards and answers in addition with the autocomplete
237
+ * If set to true, the search bar auto complete search suggestions will not be shown.
238
+ * default false
209
239
  *
240
+ * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
210
241
  */
211
- showObjectSuggestions?: boolean;
242
+ hideAutocompleteSuggestions?: boolean;
212
243
  /**
213
- * The query string to pre-fill in natual language search bar
244
+ * If set to false, the auto complete search suggestions not be shown
245
+ *
246
+ * @deprecated currently, object suggestions will not be shown for sage embed
247
+ * earlier this flag was used to show Auto complete suggestions
214
248
  */
215
- searchQuery?: string;
249
+ showObjectSuggestions?: boolean;
216
250
  /**
217
251
  * If set to true, sample questions would be hidden to user.
218
252
  * These sample questions are autogenerated based on selected datasource.
253
+ *
254
+ * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
219
255
  */
220
256
  hideSampleQuestions?: boolean;
221
257
  /**
@@ -224,6 +260,8 @@ export interface SageViewConfig extends ViewConfig {
224
260
  dataSource?: string;
225
261
  /**
226
262
  * Configuration for search options
263
+ *
264
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
227
265
  */
228
266
  searchOptions?: SearchOptions;
229
267
  }
@@ -286,7 +324,7 @@ export interface SearchOptions {
286
324
  *
287
325
  * @group Embed components
288
326
  */
289
- export interface SearchViewConfig extends ViewConfig {
327
+ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
290
328
  /**
291
329
  * If set to true, the data sources panel is collapsed on load,
292
330
  * but can be expanded manually.
@@ -433,7 +471,7 @@ export declare enum Page {
433
471
  *
434
472
  * @group Embed components
435
473
  */
436
- export interface AppViewConfig extends ViewConfig {
474
+ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
437
475
  /**
438
476
  * If true, the main navigation bar within the ThoughtSpot app
439
477
  * is displayed. By default, the navigation bar is hidden.
@@ -527,6 +565,27 @@ export interface AppViewConfig extends ViewConfig {
527
565
  * @hidden
528
566
  */
529
567
  dataPanelV2?: boolean;
568
+ /**
569
+ * Show or hide Liveboard header
570
+ *
571
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
572
+ * @default false
573
+ */
574
+ hideLiveboardHeader?: boolean;
575
+ /**
576
+ * Show or hide Liveboard title
577
+ *
578
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
579
+ * @default false
580
+ */
581
+ showLiveboardTitle?: boolean;
582
+ /**
583
+ * Show or hide Liveboard description
584
+ *
585
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
586
+ * @default false
587
+ */
588
+ showLiveboardDescription?: boolean;
530
589
  /**
531
590
  * Flag to control new Modular Home experience
532
591
  *
@@ -534,6 +593,19 @@ export interface AppViewConfig extends ViewConfig {
534
593
  * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
535
594
  */
536
595
  modularHomeExperience?: boolean;
596
+ /**
597
+ * Boolean to control if Liveboard header is sticky or not.
598
+ *
599
+ * @example
600
+ * ```js
601
+ * const embed = new AppEmbed('#embed', {
602
+ * ... // other app view config
603
+ * isLiveboardHeaderSticky: true,
604
+ * });
605
+ * ```
606
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
607
+ */
608
+ isLiveboardHeaderSticky?: boolean;
537
609
  }
538
610
  /**
539
611
  * Embeds full ThoughtSpot experience in a host application.
@@ -593,7 +665,7 @@ export declare class AppEmbed extends V1Embed {
593
665
  *
594
666
  * @group Embed components
595
667
  */
596
- export interface LiveboardViewConfig extends ViewConfig {
668
+ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
597
669
  /**
598
670
  * If set to true, the embedded object container dynamically resizes
599
671
  * according to the height of the Liveboard.
@@ -659,7 +731,7 @@ export interface LiveboardViewConfig extends ViewConfig {
659
731
  */
660
732
  liveboardV2?: boolean;
661
733
  /**
662
- * Tab Id of the Liveboard that is supposed to be active
734
+ * Tab ID of the Liveboard that is supposed to be active
663
735
  *
664
736
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
665
737
  */
@@ -671,9 +743,43 @@ export interface LiveboardViewConfig extends ViewConfig {
671
743
  */
672
744
  hideTabPanel?: boolean;
673
745
  /**
674
- * The list of parameter override to apply to a Liveboard.
746
+ * Show or hide Liveboard header
747
+ *
748
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
749
+ * @default false
750
+ */
751
+ hideLiveboardHeader?: boolean;
752
+ /**
753
+ * Show or hide Liveboard title
754
+ *
755
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
756
+ * @default false
757
+ */
758
+ showLiveboardTitle?: boolean;
759
+ /**
760
+ * Show or hide Liveboard description
761
+ *
762
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
763
+ * @default false
764
+ */
765
+ showLiveboardDescription?: boolean;
766
+ /**
767
+ * The list of parameter overrides to apply to a Liveboard.
675
768
  */
676
769
  runtimeParameters?: RuntimeParameter[];
770
+ /**
771
+ * Boolean for sticky Liveboard header.
772
+ *
773
+ * @example
774
+ * ```js
775
+ * const embed = new LiveboardEmbed('#embed', {
776
+ * ... // other liveboard view config
777
+ * isLiveboardHeaderSticky: true,
778
+ * });
779
+ * ```
780
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
781
+ */
782
+ isLiveboardHeaderSticky?: boolean;
677
783
  }
678
784
  /**
679
785
  * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -1436,27 +1542,6 @@ export interface ViewConfig {
1436
1542
  * @hidden
1437
1543
  */
1438
1544
  excludeRuntimeFiltersfromURL?: boolean;
1439
- /**
1440
- * Boolean to hide liveboard header
1441
- *
1442
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1443
- * @default false
1444
- */
1445
- hideLiveboardHeader?: boolean;
1446
- /**
1447
- * Boolean to show liveboard title
1448
- *
1449
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1450
- * @default false
1451
- */
1452
- showLiveboardTitle?: boolean;
1453
- /**
1454
- * Boolean to show liveboard description
1455
- *
1456
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1457
- * @default false
1458
- */
1459
- showLiveboardDescription?: boolean;
1460
1545
  /**
1461
1546
  * The list of tab IDs to hide from the embedded.
1462
1547
  * This Tabs will be hidden from their respective LBs.
@@ -1484,6 +1569,7 @@ export interface ViewConfig {
1484
1569
  /**
1485
1570
  * reordering the home page modules
1486
1571
  * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
1572
+ *
1487
1573
  * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
1488
1574
  */
1489
1575
  reorderedHomepageModules?: HomepageModule[];
@@ -2217,11 +2303,11 @@ export declare enum HostEvent {
2217
2303
  * @param - execute - executes the existing / updated query
2218
2304
  * @example
2219
2305
  * ```js
2220
- * searchEmbed.trigger(HostEvent.Search, {
2221
- * searchQuery: "[sales] by [item type],
2222
- * dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
2223
- * execute: true
2224
- * })
2306
+ * searchembed.trigger(HostEvent.Search, {
2307
+ searchQuery: "[sales] by [item type]",
2308
+ dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
2309
+ execute: true
2310
+ });
2225
2311
  * ```
2226
2312
  */
2227
2313
  Search = "search",
@@ -2975,6 +3061,7 @@ export declare enum Param {
2975
3061
  DisableWorksheetChange = "disableWorksheetChange",
2976
3062
  HideEurekaResults = "hideEurekaResults",
2977
3063
  HideEurekaSuggestions = "hideEurekaSuggestions",
3064
+ HideAutocompleteSuggestions = "hideAutocompleteSuggestions",
2978
3065
  HideLiveboardHeader = "hideLiveboardHeader",
2979
3066
  ShowLiveboardDescription = "showLiveboardDescription",
2980
3067
  ShowLiveboardTitle = "showLiveboardTitle",
@@ -2986,7 +3073,11 @@ export declare enum Param {
2986
3073
  Query = "query",
2987
3074
  HideHomepageLeftNav = "hideHomepageLeftNav",
2988
3075
  ModularHomeExperienceEnabled = "modularHomeExperience",
2989
- PendoTrackingKey = "additionalPendoKey"
3076
+ PendoTrackingKey = "additionalPendoKey",
3077
+ LiveboardHeaderSticky = "isLiveboardHeaderSticky",
3078
+ IsProductTour = "isProductTour",
3079
+ HideSearchBarTitle = "hideSearchBarTitle",
3080
+ HideSageAnswerHeader = "hideSageAnswerHeader"
2990
3081
  }
2991
3082
  /**
2992
3083
  * ThoughtSpot application pages include actions and menu commands
@@ -3822,7 +3913,17 @@ export declare enum Action {
3822
3913
  * ```
3823
3914
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
3824
3915
  */
3825
- PersonalisedViewsDropdown = "personalisedViewsDropdown"
3916
+ PersonalisedViewsDropdown = "personalisedViewsDropdown",
3917
+ /**
3918
+ * Action ID for Liveboard Users ( Recently Visited / social proof )
3919
+ *
3920
+ * @example
3921
+ * ```js
3922
+ * disabledActions: [Action.LiveboardUsers]
3923
+ * ```
3924
+ * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
3925
+ */
3926
+ LiveboardUsers = "liveboardUsers"
3826
3927
  }
3827
3928
  export interface AnswerServiceType {
3828
3929
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -4783,9 +4884,10 @@ export declare class AnswerService {
4783
4884
  *
4784
4885
  * @param userLocale
4785
4886
  * @param omitInfo Omit the download Info on top of the CSV
4887
+ * @param includeInfo
4786
4888
  * @returns Response
4787
4889
  */
4788
- fetchCSVBlob(userLocale?: string, omitInfo?: boolean): Promise<Response>;
4890
+ fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
4789
4891
  getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
4790
4892
  executeQuery(query: string, variables: any): Promise<any>;
4791
4893
  getSession(): SessionInterface;