@thoughtspot/visual-embed-sdk 1.28.0-alpha.5 → 1.28.0

package/dist/visual-embed-sdk-react-full.d.ts

@@ -528,7 +528,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * but can be expanded manually.
             *
             * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -542,7 +541,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * Show or hide the data sources panel.
             *
             * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -558,7 +556,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * using raw answer data.
             *
             * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -568,11 +565,14 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * ```
             */
         hideResults?: boolean;
+        /**
+            * If set to true, expands all the data sources panel.
+            */
+        expandAllDataSource?: boolean;
         /**
             * If set to true, the Search Assist feature is enabled.
             *
             * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -587,7 +587,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * format for presenting search data.
             *
             * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -601,7 +600,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * Only a single data source is supported currently.
             *
             * @deprecated Use `dataSource` instead.
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -615,7 +613,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * The array of data source GUIDs to set on load.
             *
             * @version: SDK: 1.19.0
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -657,7 +654,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * The GUID of a saved answer to load initially.
             *
             * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -672,7 +668,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * The chart/table should still be visible.
             *
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -687,7 +682,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             *
             * @default false
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            *
             * @example
             * ```js
             * const embed = new SearchEmbed('#tsEmbed', {
@@ -787,7 +781,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @default true
             * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -803,12 +796,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * nav-bars are visible, this flag will only hide the homepage left nav-bar.
             * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
             *
+            *
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
-            * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+            * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
             *
             * @default false
-            * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             *
             * @example
             * ```js
@@ -822,9 +816,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
         /**
             * Control the visibility of the help (?) and profile buttons on the
             * Global nav-bar. By default, these buttons are visible on the nav-bar.
+            *
             * @default false
             * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -838,12 +832,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * Control the visibility of the application switcher button on the nav-bar.
             * By default, the application switcher is shown.
             *
+            *
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
-            * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+            * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
             *
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             * @default false
-            * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
             *
             * @example
             * ```js
@@ -858,13 +853,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * Control the visibility of the Org switcher button on the nav-bar.
             * By default, the Org switcher button is shown.
             *
+            *
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
-            * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
-            *
+            * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
             *
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             * @default true
-            * @version SDK: 1.2.0 | Thoughtspot: 9.4.0.cl
             *
             * @example
             * ```js
@@ -885,7 +880,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
             *
             * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -903,7 +897,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * path within the app, use the `path` attribute which is more flexible.
             *
             * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -932,7 +925,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * The array of GUIDs to be hidden
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -955,10 +947,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
         liveboardV2?: boolean;
         /**
             * If set to true, the Search Assist feature is enabled.
-            * @default true
             *
+            * @default true
             * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -973,7 +964,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * according to the height of the pages which support fullHeight mode.
             *
             * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -996,7 +986,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1011,7 +1000,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1026,7 +1014,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             * @default false
-            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -1040,7 +1027,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * Flag to control new Modular Home experience.
             *
             * @default false
-            * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             *
             * @example
             * ```js
@@ -1147,7 +1134,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * incrementally as users scroll the page to view the charts and tables.
             *
             * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -1176,7 +1162,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         defaultHeight?: number;
         /**
             * @Deprecated If set to true, the context menu in visualizations will be enabled.
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -1184,7 +1169,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             *    enableVizTransformations:true,
             * })
             * ```
-            *
             * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
             */
         enableVizTransformations?: boolean;
@@ -1211,7 +1195,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * The visualization within the Liveboard to display.
             *
             * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -1241,7 +1224,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * event.
             *
             * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -1291,7 +1273,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * Show or hide the tab panel of the embedded Liveboard.
             *
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -1317,9 +1298,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         hideLiveboardHeader?: boolean;
         /**
             * Show or hide the Liveboard title.
+            *
             * @default false
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -1331,9 +1312,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         showLiveboardTitle?: boolean;
         /**
             * Show or hide the Liveboard description.
+            *
             * @default false
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -1907,6 +1888,7 @@ export declare enum AuthType {
             *      .then((data) => data.token);
             *  }
             * });
+            * });
             * ```
             */
         TrustedAuthToken = "AuthServer",
@@ -1939,29 +1921,37 @@ export declare enum AuthType {
             */
         Basic = "Basic"
 }
+/**
+    *
+    * This option does not apply to the classic homepage experience.
+    * To access the updated modular homepage,
+    * set `modularHomeExperience` to `true`
+    * (available as Early Access feature in 9.12.5.cl).
+    *
+    */
 export declare enum HomeLeftNavItem {
         /**
-            * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
             */
         SearchData = "search-data",
         /**
-            * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
             */
         Home = "insights-home",
         /**
-            * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
             */
         Liveboards = "liveboards",
         /**
-            * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
             */
         Answers = "answers",
         /**
-            * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
             */
         MonitorSubscription = "monitor-alerts",
         /**
-            * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
             */
         SpotIQAnalysis = "spotiq-analysis"
 }
@@ -2364,7 +2354,6 @@ export interface ViewConfig {
             * object inside your app.  Specify the values in pixels or percentage.
             *
             * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -2403,6 +2392,7 @@ export interface ViewConfig {
         disabledActions?: Action[];
         /**
             * The tooltip to display for disabled actions.
+            *
             * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
             * @example
             * ```js
@@ -2420,7 +2410,6 @@ export interface ViewConfig {
             * Use this to hide an action.
             *
             * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -2441,7 +2430,6 @@ export interface ViewConfig {
             *
             * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
             * @important
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -2455,7 +2443,6 @@ export interface ViewConfig {
             * Show alert messages and toast messages in the embedded view.
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -2470,7 +2457,6 @@ export interface ViewConfig {
             * visualization, or Liveboard.
             *
             * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -2491,7 +2477,6 @@ export interface ViewConfig {
             * visualization, or Liveboard.
             *
             * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -2526,6 +2511,7 @@ export interface ViewConfig {
             * Warning: This option is for advanced use only and is used internally
             * to control embed behavior in non-regular ways. We do not publish the
             * list of supported keys and values associated with each.
+            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -2554,7 +2540,6 @@ export interface ViewConfig {
             * child inside it.
             *
             * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -2640,11 +2625,13 @@ export interface ViewConfig {
             * Hide the home page modules
             * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
             *
+            *
+            *
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
-            * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+            * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.0.cl).
             *
-            * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -2652,18 +2639,18 @@ export interface ViewConfig {
             *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
             * })
             * ```
-            *
             */
         hiddenHomepageModules?: HomepageModule[];
         /**
             * reordering the home page modules
             * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
             *
+            *
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
-            * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl onwards).
+            * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
             *
-            * @version SDK: 1.27.9| Thoughtspot: 9.12.0.cl
+            * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
             *
             * @example
             * ```js
@@ -2681,7 +2668,6 @@ export interface ViewConfig {
             * Use either `visibleTabs` or `hiddenTabs`.
             *
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed-container', {
@@ -2700,8 +2686,7 @@ export interface ViewConfig {
             * To hide these items, specify the string in the array.
             *
             * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
-            *
-            * * @example
+            * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
             *    ... // other options
@@ -2709,11 +2694,13 @@ export interface ViewConfig {
             * })
             * ```
             *
+            *
+            *
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
             * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
             *
-            * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
         /**
@@ -2741,7 +2728,6 @@ export interface ViewConfig {
             * @type {boolean}
             * @default false
             * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
-            *
             * @example
             * ```js
             * // Disable tracking PreRender size in the configuration
@@ -2872,7 +2858,12 @@ export declare enum RuntimeFilterOp {
         IN = "IN"
 }
 /**
-    * Home page module that can be hidden
+    * Home page module that can be hidden.
+    * **Note**: This option does not apply to the classic homepage.
+    * To access the updated modular homepage, set
+    * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+    *
+    * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
     */
 export declare enum HomepageModule {
         /**
@@ -2893,10 +2884,6 @@ export declare enum HomepageModule {
         MyLibrary = "MY_LIBRARY",
         /**
             * Trending list
-            *
-            * **Note**: This option does not apply to the classic homepage.
-            * To access the updated modular homepage, set
-            * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl onwards).
             */
         Trending = "TRENDING",
         /**
@@ -3144,7 +3131,8 @@ export declare enum EmbedEvent {
             *
             *  API - API call failure error.
             *
-            *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
+            *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen
+            *  mode.
             *
             *  SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
             *
@@ -6362,15 +6350,6 @@ export declare function testResetMixpanel(): void;
   */
 export declare const tokenizedFetch: typeof fetch;
 
-export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
-/**
-  * Resets the auth token and a new token will be fetched on the next request.
-  *
-  * @version SDK: 1.28.0 | ThoughtSpot: *
-  * @group Authentication / Init
-  */
-export declare const resetCachedAuthToken: () => void;
-
 /**
     * Copyright (c) 2022
     *