@thoughtspot/visual-embed-sdk 1.28.0-alpha.2 → 1.28.0-alpha.3

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 (212) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/auth.d.ts +16 -1
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +5 -1
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/auth.spec.d.ts.map +1 -1
  7. package/cjs/src/auth.spec.js +9 -0
  8. package/cjs/src/auth.spec.js.map +1 -1
  9. package/cjs/src/embed/app.d.ts +18 -4
  10. package/cjs/src/embed/app.d.ts.map +1 -1
  11. package/cjs/src/embed/app.js +2 -2
  12. package/cjs/src/embed/app.js.map +1 -1
  13. package/cjs/src/embed/app.spec.js +19 -1
  14. package/cjs/src/embed/app.spec.js.map +1 -1
  15. package/cjs/src/embed/base.d.ts.map +1 -1
  16. package/cjs/src/embed/base.js +0 -3
  17. package/cjs/src/embed/base.js.map +1 -1
  18. package/cjs/src/embed/embed.spec.js +0 -15
  19. package/cjs/src/embed/embed.spec.js.map +1 -1
  20. package/cjs/src/embed/liveboard.d.ts +7 -1
  21. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  22. package/cjs/src/embed/liveboard.js +2 -2
  23. package/cjs/src/embed/liveboard.js.map +1 -1
  24. package/cjs/src/embed/liveboard.spec.js +20 -1
  25. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  26. package/cjs/src/embed/pinboard.spec.js +20 -1
  27. package/cjs/src/embed/pinboard.spec.js.map +1 -1
  28. package/cjs/src/embed/sage.d.ts +6 -6
  29. package/cjs/src/embed/sage.d.ts.map +1 -1
  30. package/cjs/src/embed/sage.js +18 -3
  31. package/cjs/src/embed/sage.js.map +1 -1
  32. package/cjs/src/embed/sage.spec.js +11 -11
  33. package/cjs/src/embed/sage.spec.js.map +1 -1
  34. package/cjs/src/embed/search-bar.d.ts +1 -1
  35. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  36. package/cjs/src/embed/search-bar.js +2 -2
  37. package/cjs/src/embed/search-bar.js.map +1 -1
  38. package/cjs/src/embed/search.d.ts +1 -1
  39. package/cjs/src/embed/search.d.ts.map +1 -1
  40. package/cjs/src/embed/search.js +3 -3
  41. package/cjs/src/embed/search.js.map +1 -1
  42. package/cjs/src/embed/search.spec.js +25 -1
  43. package/cjs/src/embed/search.spec.js.map +1 -1
  44. package/cjs/src/embed/ts-embed-trigger.spec.d.ts +2 -0
  45. package/cjs/src/embed/ts-embed-trigger.spec.d.ts.map +1 -0
  46. package/cjs/src/embed/ts-embed-trigger.spec.js +34 -0
  47. package/cjs/src/embed/ts-embed-trigger.spec.js.map +1 -0
  48. package/cjs/src/embed/ts-embed.d.ts +1 -1
  49. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  50. package/cjs/src/embed/ts-embed.js +14 -11
  51. package/cjs/src/embed/ts-embed.js.map +1 -1
  52. package/cjs/src/embed/ts-embed.spec.js +47 -17
  53. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  54. package/cjs/src/index.d.ts +2 -1
  55. package/cjs/src/index.d.ts.map +1 -1
  56. package/cjs/src/index.js +3 -1
  57. package/cjs/src/index.js.map +1 -1
  58. package/cjs/src/react/index.spec.js +1 -1
  59. package/cjs/src/react/index.spec.js.map +1 -1
  60. package/cjs/src/test/test-utils.d.ts +1 -0
  61. package/cjs/src/test/test-utils.d.ts.map +1 -1
  62. package/cjs/src/test/test-utils.js +10 -1
  63. package/cjs/src/test/test-utils.js.map +1 -1
  64. package/cjs/src/tokenizedFetch.d.ts +9 -0
  65. package/cjs/src/tokenizedFetch.d.ts.map +1 -1
  66. package/cjs/src/tokenizedFetch.js +9 -0
  67. package/cjs/src/tokenizedFetch.js.map +1 -1
  68. package/cjs/src/types.d.ts +150 -35
  69. package/cjs/src/types.d.ts.map +1 -1
  70. package/cjs/src/types.js +110 -19
  71. package/cjs/src/types.js.map +1 -1
  72. package/cjs/src/utils/authService/authService.d.ts.map +1 -1
  73. package/cjs/src/utils/authService/authService.js +9 -3
  74. package/cjs/src/utils/authService/authService.js.map +1 -1
  75. package/cjs/src/utils/authService/authService.spec.js +22 -0
  76. package/cjs/src/utils/authService/authService.spec.js.map +1 -1
  77. package/dist/src/auth.d.ts +16 -1
  78. package/dist/src/auth.d.ts.map +1 -1
  79. package/dist/src/auth.spec.d.ts.map +1 -1
  80. package/dist/src/embed/app.d.ts +18 -4
  81. package/dist/src/embed/app.d.ts.map +1 -1
  82. package/dist/src/embed/base.d.ts.map +1 -1
  83. package/dist/src/embed/liveboard.d.ts +7 -1
  84. package/dist/src/embed/liveboard.d.ts.map +1 -1
  85. package/dist/src/embed/sage.d.ts +6 -6
  86. package/dist/src/embed/sage.d.ts.map +1 -1
  87. package/dist/src/embed/search-bar.d.ts +1 -1
  88. package/dist/src/embed/search-bar.d.ts.map +1 -1
  89. package/dist/src/embed/search.d.ts +1 -1
  90. package/dist/src/embed/search.d.ts.map +1 -1
  91. package/dist/src/embed/ts-embed-trigger.spec.d.ts +2 -0
  92. package/dist/src/embed/ts-embed-trigger.spec.d.ts.map +1 -0
  93. package/dist/src/embed/ts-embed.d.ts +1 -1
  94. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  95. package/dist/src/index.d.ts +2 -1
  96. package/dist/src/index.d.ts.map +1 -1
  97. package/dist/src/test/test-utils.d.ts +1 -0
  98. package/dist/src/test/test-utils.d.ts.map +1 -1
  99. package/dist/src/tokenizedFetch.d.ts +9 -0
  100. package/dist/src/tokenizedFetch.d.ts.map +1 -1
  101. package/dist/src/types.d.ts +150 -35
  102. package/dist/src/types.d.ts.map +1 -1
  103. package/dist/src/utils/authService/authService.d.ts.map +1 -1
  104. package/dist/tsembed-react.es.js +173 -46
  105. package/dist/tsembed-react.js +173 -46
  106. package/dist/tsembed.es.js +174 -50
  107. package/dist/tsembed.js +174 -49
  108. package/dist/visual-embed-sdk-react-full.d.ts +211 -50
  109. package/dist/visual-embed-sdk-react.d.ts +211 -50
  110. package/dist/visual-embed-sdk.d.ts +211 -50
  111. package/lib/package.json +1 -1
  112. package/lib/src/auth.d.ts +16 -1
  113. package/lib/src/auth.d.ts.map +1 -1
  114. package/lib/src/auth.js +5 -1
  115. package/lib/src/auth.js.map +1 -1
  116. package/lib/src/auth.spec.d.ts.map +1 -1
  117. package/lib/src/auth.spec.js +9 -0
  118. package/lib/src/auth.spec.js.map +1 -1
  119. package/lib/src/embed/app.d.ts +18 -4
  120. package/lib/src/embed/app.d.ts.map +1 -1
  121. package/lib/src/embed/app.js +2 -2
  122. package/lib/src/embed/app.js.map +1 -1
  123. package/lib/src/embed/app.spec.js +19 -1
  124. package/lib/src/embed/app.spec.js.map +1 -1
  125. package/lib/src/embed/base.d.ts.map +1 -1
  126. package/lib/src/embed/base.js +0 -3
  127. package/lib/src/embed/base.js.map +1 -1
  128. package/lib/src/embed/embed.spec.js +2 -17
  129. package/lib/src/embed/embed.spec.js.map +1 -1
  130. package/lib/src/embed/liveboard.d.ts +7 -1
  131. package/lib/src/embed/liveboard.d.ts.map +1 -1
  132. package/lib/src/embed/liveboard.js +2 -2
  133. package/lib/src/embed/liveboard.js.map +1 -1
  134. package/lib/src/embed/liveboard.spec.js +20 -1
  135. package/lib/src/embed/liveboard.spec.js.map +1 -1
  136. package/lib/src/embed/pinboard.spec.js +20 -1
  137. package/lib/src/embed/pinboard.spec.js.map +1 -1
  138. package/lib/src/embed/sage.d.ts +6 -6
  139. package/lib/src/embed/sage.d.ts.map +1 -1
  140. package/lib/src/embed/sage.js +18 -3
  141. package/lib/src/embed/sage.js.map +1 -1
  142. package/lib/src/embed/sage.spec.js +11 -11
  143. package/lib/src/embed/sage.spec.js.map +1 -1
  144. package/lib/src/embed/search-bar.d.ts +1 -1
  145. package/lib/src/embed/search-bar.d.ts.map +1 -1
  146. package/lib/src/embed/search-bar.js +2 -2
  147. package/lib/src/embed/search-bar.js.map +1 -1
  148. package/lib/src/embed/search.d.ts +1 -1
  149. package/lib/src/embed/search.d.ts.map +1 -1
  150. package/lib/src/embed/search.js +3 -3
  151. package/lib/src/embed/search.js.map +1 -1
  152. package/lib/src/embed/search.spec.js +25 -1
  153. package/lib/src/embed/search.spec.js.map +1 -1
  154. package/lib/src/embed/ts-embed-trigger.spec.d.ts +2 -0
  155. package/lib/src/embed/ts-embed-trigger.spec.d.ts.map +1 -0
  156. package/lib/src/embed/ts-embed-trigger.spec.js +32 -0
  157. package/lib/src/embed/ts-embed-trigger.spec.js.map +1 -0
  158. package/lib/src/embed/ts-embed.d.ts +1 -1
  159. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  160. package/lib/src/embed/ts-embed.js +14 -11
  161. package/lib/src/embed/ts-embed.js.map +1 -1
  162. package/lib/src/embed/ts-embed.spec.js +41 -11
  163. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  164. package/lib/src/index.d.ts +2 -1
  165. package/lib/src/index.d.ts.map +1 -1
  166. package/lib/src/index.js +2 -1
  167. package/lib/src/index.js.map +1 -1
  168. package/lib/src/react/index.spec.js +1 -1
  169. package/lib/src/react/index.spec.js.map +1 -1
  170. package/lib/src/test/test-utils.d.ts +1 -0
  171. package/lib/src/test/test-utils.d.ts.map +1 -1
  172. package/lib/src/test/test-utils.js +8 -0
  173. package/lib/src/test/test-utils.js.map +1 -1
  174. package/lib/src/tokenizedFetch.d.ts +9 -0
  175. package/lib/src/tokenizedFetch.d.ts.map +1 -1
  176. package/lib/src/tokenizedFetch.js +9 -0
  177. package/lib/src/tokenizedFetch.js.map +1 -1
  178. package/lib/src/types.d.ts +150 -35
  179. package/lib/src/types.d.ts.map +1 -1
  180. package/lib/src/types.js +110 -19
  181. package/lib/src/types.js.map +1 -1
  182. package/lib/src/utils/authService/authService.d.ts.map +1 -1
  183. package/lib/src/utils/authService/authService.js +9 -3
  184. package/lib/src/utils/authService/authService.js.map +1 -1
  185. package/lib/src/utils/authService/authService.spec.js +22 -0
  186. package/lib/src/utils/authService/authService.spec.js.map +1 -1
  187. package/lib/src/visual-embed-sdk.d.ts +215 -51
  188. package/package.json +1 -1
  189. package/src/auth.spec.ts +10 -0
  190. package/src/auth.ts +21 -2
  191. package/src/embed/app.spec.ts +24 -1
  192. package/src/embed/app.ts +19 -5
  193. package/src/embed/base.ts +1 -5
  194. package/src/embed/embed.spec.ts +0 -18
  195. package/src/embed/liveboard.spec.ts +24 -1
  196. package/src/embed/liveboard.ts +8 -2
  197. package/src/embed/pinboard.spec.ts +24 -1
  198. package/src/embed/sage.spec.ts +11 -11
  199. package/src/embed/sage.ts +19 -6
  200. package/src/embed/search-bar.tsx +2 -2
  201. package/src/embed/search.spec.ts +29 -1
  202. package/src/embed/search.ts +3 -3
  203. package/src/embed/ts-embed-trigger.spec.ts +39 -0
  204. package/src/embed/ts-embed.spec.ts +49 -16
  205. package/src/embed/ts-embed.ts +21 -16
  206. package/src/index.ts +2 -0
  207. package/src/react/index.spec.tsx +1 -0
  208. package/src/test/test-utils.ts +9 -0
  209. package/src/tokenizedFetch.ts +9 -0
  210. package/src/types.ts +151 -32
  211. package/src/utils/authService/authService.spec.ts +27 -0
  212. package/src/utils/authService/authService.ts +14 -13
@@ -285,7 +285,7 @@ export declare class SearchBarEmbed extends TsEmbed {
285
285
  /**
286
286
  * Render the embedded ThoughtSpot search
287
287
  */
288
- render(): SearchBarEmbed;
288
+ render(): Promise<SearchBarEmbed>;
289
289
  }
290
290
 
291
291
  /**
@@ -343,17 +343,15 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
343
343
  isProductTour?: boolean;
344
344
  /**
345
345
  * Show or hide the search bar title.
346
- * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
347
346
  *
348
- * @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
347
+ * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
349
348
  */
350
349
  hideSearchBarTitle?: boolean;
351
350
  /**
352
351
  * Show or hide the Answer header, that is, the `AI Answer` title
353
352
  * at the top of the Answer page.
354
- * @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
355
353
  *
356
- * @deprecated Thoughtspot: 9.12.0.cl | sage answer doesn't have the header from 9.12.0.cl
354
+ * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
357
355
  */
358
356
  hideSageAnswerHeader?: boolean;
359
357
  /**
@@ -386,6 +384,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
386
384
  * Show or hide sample questions.
387
385
  * The sample questions are autogenerated based on the worksheet
388
386
  * selected for the search operation.
387
+ *
389
388
  * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
390
389
  */
391
390
  hideSampleQuestions?: boolean;
@@ -415,6 +414,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
415
414
  */
416
415
  searchOptions?: SearchOptions;
417
416
  }
417
+ export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
418
418
  /**
419
419
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
420
420
  *
@@ -447,7 +447,7 @@ export declare class SageEmbed extends V1Embed {
447
447
  *
448
448
  * @returns {SageEmbed} Eureka/Sage embed
449
449
  */
450
- render(): SageEmbed;
450
+ render(): Promise<SageEmbed>;
451
451
  }
452
452
 
453
453
  /**
@@ -597,7 +597,7 @@ export declare class SearchEmbed extends TsEmbed {
597
597
  /**
598
598
  * Render the embedded ThoughtSpot search
599
599
  */
600
- render(): SearchEmbed;
600
+ render(): Promise<SearchEmbed>;
601
601
  }
602
602
 
603
603
  /**
@@ -661,8 +661,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
661
661
  * nav-bars are visible, this flag will only hide the homepage left nav-bar.
662
662
  * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
663
663
  *
664
+ * **Note**: This option does not apply to the classic homepage.
665
+ * To access the updated modular homepage, set
666
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
667
+ *
664
668
  * @default false
665
- * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
669
+ * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
666
670
  */
667
671
  hideHomepageLeftNav?: boolean;
668
672
  /**
@@ -673,11 +677,21 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
673
677
  /**
674
678
  * Control the visibility of the application switcher button on the nav-bar.
675
679
  * By default, the application switcher is shown.
680
+ *
681
+ * **Note**: This option does not apply to the classic homepage.
682
+ * To access the updated modular homepage, set
683
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
684
+ *
676
685
  */
677
686
  hideApplicationSwitcher?: boolean;
678
687
  /**
679
688
  * Control the visibility of the Org switcher button on the nav-bar.
680
689
  * By default, the Org switcher button is shown.
690
+ *
691
+ * **Note**: This option does not apply to the classic homepage.
692
+ * To access the updated modular homepage, set
693
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
694
+ *
681
695
  */
682
696
  hideOrgSwitcher?: boolean;
683
697
  /**
@@ -764,10 +778,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
764
778
  */
765
779
  showLiveboardDescription?: boolean;
766
780
  /**
767
- * Flag to control new Modular Home experience
781
+ * Flag to control new Modular Home experience.
768
782
  *
769
783
  * @default false
770
- * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
784
+ * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
771
785
  */
772
786
  modularHomeExperience?: boolean;
773
787
  /**
@@ -836,7 +850,7 @@ export declare class AppEmbed extends V1Embed {
836
850
  * @param renderOptions An object containing the page ID
837
851
  * to be embedded.
838
852
  */
839
- render(): AppEmbed;
853
+ render(): Promise<AppEmbed>;
840
854
  }
841
855
 
842
856
  /**
@@ -858,6 +872,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
858
872
  /**
859
873
  * If set to true, the embedded object container dynamically resizes
860
874
  * according to the height of the Liveboard.
875
+ * **Note**: Using fullHeight loads all visualizations on the
876
+ * Liveboard simultaneously, which results in multiple warehouse
877
+ * queries and potentially a longer wait for the topmost
878
+ * visualizations to display on the screen.
879
+ * Setting `fullHeight` to `false` fetches visualizations
880
+ * incrementally as users scroll the page to view the charts and tables.
861
881
  *
862
882
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
863
883
  */
@@ -1016,7 +1036,7 @@ export declare class LiveboardEmbed extends V1Embed {
1016
1036
  * @param renderOptions An object specifying the Liveboard ID,
1017
1037
  * visualization ID and the runtime filters.
1018
1038
  */
1019
- render(): LiveboardEmbed;
1039
+ render(): Promise<LiveboardEmbed>;
1020
1040
  navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
1021
1041
  }
1022
1042
  /**
@@ -1052,7 +1072,7 @@ export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewCon
1052
1072
  * @summary ThoughtSpot Visual Embed SDK
1053
1073
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
1054
1074
  */
1055
- export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, VizPoint, CustomActionPayload, };
1075
+ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, VizPoint, CustomActionPayload, };
1056
1076
 
1057
1077
  /**
1058
1078
  * Copyright (c) 2023
@@ -1230,15 +1250,30 @@ export declare enum AuthType {
1230
1250
  Basic = "Basic"
1231
1251
  }
1232
1252
  export declare enum HomeLeftNavItem {
1233
- QueryBuilder = "query-builder",
1253
+ /**
1254
+ * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1255
+ */
1256
+ SearchData = "search-data",
1257
+ /**
1258
+ * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1259
+ */
1234
1260
  Home = "insights-home",
1261
+ /**
1262
+ * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1263
+ */
1235
1264
  Liveboards = "liveboards",
1265
+ /**
1266
+ * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1267
+ */
1236
1268
  Answers = "answers",
1269
+ /**
1270
+ * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1271
+ */
1237
1272
  MonitorSubscription = "monitor-alerts",
1238
- SpotIQAnalysis = "spotiq-analysis",
1239
- Tutorials = "tutorials",
1240
- Documentation = "documentation",
1241
- Community = "community"
1273
+ /**
1274
+ * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1275
+ */
1276
+ SpotIQAnalysis = "spotiq-analysis"
1242
1277
  }
1243
1278
  export type DOMSelector = string | HTMLElement;
1244
1279
  /**
@@ -1294,6 +1329,8 @@ export interface CustomStyles {
1294
1329
  /**
1295
1330
  * Configuration to define the customization on the Embedded
1296
1331
  * Thoughtspot components.
1332
+ * You can customize styles, text strings, and icons.
1333
+ * For more information, see https://developers.thoughtspot.com/docs/custom-css.
1297
1334
  *
1298
1335
  * @example
1299
1336
  * ```js
@@ -1308,7 +1345,12 @@ export interface CustomStyles {
1308
1345
  * },
1309
1346
  * content: {
1310
1347
  * strings: {
1311
- * 'LIVEBOARDS': 'Dashboards'
1348
+ * 'LIVEBOARDS': 'Dashboards',
1349
+ * 'ANSWERS': 'Visualizations',
1350
+ * 'Edit': 'Modify',
1351
+ * 'Show underlying data': 'Show source data',
1352
+ * 'SpotIQ': 'Insights',
1353
+ * 'Monitor': 'Alerts',
1312
1354
  * }
1313
1355
  * },
1314
1356
  * iconSpriteUrl: 'https://my-custom-icon-sprite.svg'
@@ -1340,12 +1382,6 @@ export interface EmbedConfig {
1340
1382
  * The ThoughtSpot cluster hostname or IP address.
1341
1383
  */
1342
1384
  thoughtSpotHost: string;
1343
- /**
1344
- * If true, all the iframe links will have /v2 added automatically.
1345
- * If false, all the iframe links will have /v1 added automatically.
1346
- * If undefined, nothing will be added
1347
- */
1348
- enableReactShell?: boolean | undefined;
1349
1385
  /**
1350
1386
  * The authentication mechanism to use.
1351
1387
  */
@@ -1590,6 +1626,12 @@ export interface EmbedConfig {
1590
1626
  * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
1591
1627
  */
1592
1628
  logLevel?: LogLevel;
1629
+ /**
1630
+ * Disables the Mixpanel tracking from the SDK.
1631
+ *
1632
+ * @version SDK: 1.27.9
1633
+ */
1634
+ disableSDKTracking?: boolean;
1593
1635
  }
1594
1636
  export interface LayoutConfig {
1595
1637
  }
@@ -1767,9 +1809,14 @@ export interface ViewConfig {
1767
1809
  usePrerenderedIfAvailable?: boolean;
1768
1810
  /**
1769
1811
  * Boolean to exclude runtimeFilters in the URL
1812
+ * By default it is true, this flag removes runtime filters from the URL
1813
+ * when set to false, runtime filters will be included in the URL.
1770
1814
  *
1771
- * @default false
1772
- * @hidden
1815
+ * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
1816
+ * embedded view.
1817
+ *
1818
+ * @default true
1819
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
1773
1820
  */
1774
1821
  excludeRuntimeFiltersfromURL?: boolean;
1775
1822
  /**
@@ -1791,16 +1838,24 @@ export interface ViewConfig {
1791
1838
  hiddenTabs?: string[];
1792
1839
  /**
1793
1840
  * Hide the home page modules
1794
- * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
1841
+ * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
1842
+ *
1843
+ * **Note**: This option does not apply to the classic homepage.
1844
+ * To access the updated modular homepage, set
1845
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
1795
1846
  *
1796
- * @version SDK: 1.27.0 | Thoughtspot: 9.12.0.cl
1847
+ * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
1797
1848
  */
1798
1849
  hiddenHomepageModules?: HomepageModule[];
1799
1850
  /**
1800
1851
  * reordering the home page modules
1801
1852
  * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
1802
1853
  *
1803
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.0.cl
1854
+ * **Note**: This option does not apply to the classic homepage.
1855
+ * To access the updated modular homepage, set
1856
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl onwards).
1857
+ *
1858
+ * @version SDK: 1.27.9| Thoughtspot: 9.12.0.cl
1804
1859
  */
1805
1860
  reorderedHomepageModules?: HomepageModule[];
1806
1861
  /**
@@ -1827,7 +1882,11 @@ export interface ViewConfig {
1827
1882
  * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
1828
1883
  * ```
1829
1884
  *
1830
- * @version SDK: 1.27.0 | Thoughtspot: 9.12.0.cl
1885
+ * **Note**: This option does not apply to the classic homepage.
1886
+ * To access the updated modular homepage, set
1887
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
1888
+ *
1889
+ * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
1831
1890
  */
1832
1891
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
1833
1892
  /**
@@ -2003,6 +2062,10 @@ export declare enum HomepageModule {
2003
2062
  MyLibrary = "MY_LIBRARY",
2004
2063
  /**
2005
2064
  * Trending list
2065
+ *
2066
+ * **Note**: This option does not apply to the classic homepage.
2067
+ * To access the updated modular homepage, set
2068
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl onwards).
2006
2069
  */
2007
2070
  Trending = "TRENDING",
2008
2071
  /**
@@ -2141,7 +2204,7 @@ export declare enum EmbedEvent {
2141
2204
  * @returns nonFilteredColumns - The columns that were not filtered
2142
2205
  * @example
2143
2206
  *```js
2144
- * searchEmbed.trigger(HostEvent.DrillDown, {
2207
+ * searchEmbed.trigger(EmbedEvent.DrillDown, {
2145
2208
  * points: {
2146
2209
  * clickedPoint,
2147
2210
  * selectedPoints: selectedPoint
@@ -2233,7 +2296,7 @@ export declare enum EmbedEvent {
2233
2296
  * @important
2234
2297
  * @example
2235
2298
  * ```js
2236
- * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
2299
+ * embed.on(EmbedEvent.VizPointClick, ({data}) => {
2237
2300
  * console.log(
2238
2301
  * data.vizId, // viz id
2239
2302
  * data.clickedPoint.selectedAttributes[0].value,
@@ -2248,19 +2311,20 @@ export declare enum EmbedEvent {
2248
2311
  /**
2249
2312
  * An error has occurred. This event is fired for the following error types:
2250
2313
  *
2251
- * `API` - API call failure error.
2314
+ * API - API call failure error.
2252
2315
  *
2253
- * `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
2316
+ * FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
2254
2317
  *
2255
- * `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
2318
+ * SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
2256
2319
  *
2257
- * `NON_EXIST_FILTER` - Error due to a non-existent filter.
2320
+ * NON_EXIST_FILTER - Error due to a non-existent filter.
2258
2321
  *
2259
- * `INVALID_DATE_VALUE` - Invalid date value error.
2322
+ * INVALID_DATE_VALUE - Invalid date value error.
2260
2323
  *
2261
- * `INVALID_OPERATOR` - Use of invalid operator during filter application.
2324
+ * INVALID_OPERATOR - Use of invalid operator during filter application.
2262
2325
  *
2263
2326
  * For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
2327
+ *
2264
2328
  * @returns error - An error object or message
2265
2329
  * @example
2266
2330
  * ```js
@@ -2825,7 +2889,7 @@ export declare enum EmbedEvent {
2825
2889
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2826
2890
  * @example
2827
2891
  *```js
2828
- * liveboardEmbed.trigger(HostEvent.Delete,
2892
+ * liveboardEmbed.trigger(EmbedEvent.Delete,
2829
2893
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2830
2894
  *```
2831
2895
  */
@@ -2836,7 +2900,7 @@ export declare enum EmbedEvent {
2836
2900
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2837
2901
  * @example
2838
2902
  *```js
2839
- * liveboardEmbed.trigger(HostEvent.SchedulesList)
2903
+ * liveboardEmbed.trigger(EmbedEvent.SchedulesList)
2840
2904
  *```
2841
2905
  */
2842
2906
  SchedulesList = "schedule-list",
@@ -2846,7 +2910,7 @@ export declare enum EmbedEvent {
2846
2910
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2847
2911
  * @example
2848
2912
  *```js
2849
- * liveboardEmbed.trigger(HostEvent.Cancel)
2913
+ * liveboardEmbed.trigger(EmbedEvent.Cancel)
2850
2914
  *```
2851
2915
  */
2852
2916
  Cancel = "cancel",
@@ -2856,7 +2920,7 @@ export declare enum EmbedEvent {
2856
2920
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2857
2921
  * @example
2858
2922
  *```js
2859
- * liveboardEmbed.trigger(HostEvent.Explore, {
2923
+ * liveboardEmbed.trigger(EmbedEvent.Explore, {
2860
2924
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2861
2925
  *```
2862
2926
  */
@@ -2867,7 +2931,7 @@ export declare enum EmbedEvent {
2867
2931
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2868
2932
  * @example
2869
2933
  *```js
2870
- * liveboardEmbed.trigger(HostEvent.CopyLink, {
2934
+ * liveboardEmbed.trigger(EmbedEvent.CopyLink, {
2871
2935
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2872
2936
  *```
2873
2937
  */
@@ -3136,10 +3200,13 @@ export declare enum HostEvent {
3136
3200
  * _String_. The name of the column to filter on.
3137
3201
  * `operator`
3138
3202
  * Runtime filter operator to apply. For information,
3139
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
3203
+ * see https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator.
3140
3204
  * `values`
3141
3205
  * List of operands. Some operators such as EQ, LE allow a single value, whereas
3142
3206
  * operators such as BW and IN accept multiple operands.
3207
+ * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
3208
+ * Search embedding (SearchEmbed) and Natural Language Search
3209
+ * embedding (SageEmbed).
3143
3210
  *
3144
3211
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
3145
3212
  * @example
@@ -3664,6 +3731,7 @@ export declare enum HostEvent {
3664
3731
  /**
3665
3732
  *
3666
3733
  * Get the currents visible and runtime filters applied on a Liveboard
3734
+ *
3667
3735
  * @example
3668
3736
  * liveboardEmbed.trigger(HostEvent.GetFilters)
3669
3737
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -3672,12 +3740,13 @@ export declare enum HostEvent {
3672
3740
  /**
3673
3741
  *
3674
3742
  * Update the visible filters on the Liveboard.
3743
+ *
3675
3744
  * @param - filter: filter object containing column name and filter operation and values
3676
3745
  * @example
3677
3746
  *
3678
3747
  * ```js
3679
3748
  * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
3680
- * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
3749
+ * filter: { column: 'column name', oper: 'IN', values: [1,2,3], is_mandatory: false }
3681
3750
  * })
3682
3751
  * ```
3683
3752
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -3763,7 +3832,33 @@ export declare enum HostEvent {
3763
3832
  * ```
3764
3833
  * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
3765
3834
  */
3766
- AskSage = "AskSage"
3835
+ AskSage = "AskSage",
3836
+ /**
3837
+ * Trigger UpdateCrossFilter for Liveboard
3838
+ *
3839
+ * @example
3840
+ * ```js
3841
+ * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
3842
+ * vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e',
3843
+ * conditions: [
3844
+ * { columnName: 'Category', values: ['mfgr#12','mfgr#14'] },
3845
+ * { columnName: 'color', values: ['mint','hot'] },
3846
+ * ],
3847
+ * });
3848
+ * ```
3849
+ * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
3850
+ */
3851
+ UpdateCrossFilter = "UpdateCrossFilter",
3852
+ /**
3853
+ * Trigger ResetLiveboardPersonalisedView for Liveboard
3854
+ *
3855
+ * @example
3856
+ * ```js
3857
+ * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
3858
+ * ```
3859
+ * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
3860
+ */
3861
+ ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
3767
3862
  }
3768
3863
  /**
3769
3864
  * The different visual modes that the data sources panel within
@@ -4728,7 +4823,47 @@ export declare enum Action {
4728
4823
  * ```
4729
4824
  * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
4730
4825
  */
4731
- AskAi = "AskAi"
4826
+ AskAi = "AskAi",
4827
+ /**
4828
+ * The **Add KPI to Watchlist** action on Home page watchlist.
4829
+ *
4830
+ * @example
4831
+ * ```js
4832
+ * disabledActions: [Action.AddToWatchlist]
4833
+ * ```
4834
+ * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
4835
+ */
4836
+ AddToWatchlist = "addToWatchlist",
4837
+ /**
4838
+ * The **Remove from watchlist** menu action on KPI watchlist.
4839
+ *
4840
+ * @example
4841
+ * ```js
4842
+ * disabledActions: [Action.RemoveFromWatchlist]
4843
+ * ```
4844
+ * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
4845
+ */
4846
+ RemoveFromWatchlist = "removeFromWatchlist",
4847
+ /**
4848
+ * The **Copy KPI Link** menu action on KPI watchlist.
4849
+ *
4850
+ * @example
4851
+ * ```js
4852
+ * disabledActions: [Action.CopyKpiLink]
4853
+ * ```
4854
+ * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
4855
+ */
4856
+ CopyKpiLink = "copyKpiLink",
4857
+ /**
4858
+ * Action ID for AI Highlights button
4859
+ *
4860
+ * @example
4861
+ * ```js
4862
+ * hiddenAction: [Action.AIHighlights]
4863
+ * ```
4864
+ * @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
4865
+ */
4866
+ AIHighlights = "AIHighlights"
4732
4867
  }
4733
4868
  export interface AnswerServiceType {
4734
4869
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -5060,7 +5195,7 @@ export declare class TsEmbed {
5060
5195
  *
5061
5196
  * @param args
5062
5197
  */
5063
- render(): TsEmbed;
5198
+ render(): Promise<TsEmbed>;
5064
5199
  getIframeSrc(): string;
5065
5200
  protected handleRenderForPrerender(): void;
5066
5201
  /**
@@ -5394,7 +5529,22 @@ export interface AuthEventEmitter {
5394
5529
  *
5395
5530
  * @param {@link AuthEvent}
5396
5531
  */
5397
- emit(event: AuthEvent): void;
5532
+ emit(event: AuthEvent, ...args: any[]): boolean;
5533
+ /**
5534
+ * Remove listener from the emitter returned from init.
5535
+ *
5536
+ * @param event
5537
+ * @param listener
5538
+ * @param context
5539
+ * @param once
5540
+ */
5541
+ off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
5542
+ /**
5543
+ * Remove all the event listeners
5544
+ *
5545
+ * @param event
5546
+ */
5547
+ removeAllListeners(event: AuthStatus): this;
5398
5548
  }
5399
5549
  /**
5400
5550
  * Events which can be triggered on the emitter returned from {@link init}.
@@ -6001,3 +6151,14 @@ export declare function initMixpanel(sessionInfo: any): void;
6001
6151
  */
6002
6152
  export declare function testResetMixpanel(): void;
6003
6153
 
6154
+ /**
6155
+ * Fetch wrapper that adds the authentication token to the request.
6156
+ * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
6157
+ *
6158
+ * @param input
6159
+ * @param init
6160
+ * @version SDK: 1.28.0
6161
+ * @group Global methods
6162
+ */
6163
+ export declare const tokenizedFetch: typeof fetch;
6164
+