@thoughtspot/visual-embed-sdk 1.28.1-alpha.1 → 1.28.1

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

@@ -517,7 +517,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', {
@@ -531,7 +530,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', {
@@ -547,7 +545,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', {
@@ -557,11 +554,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', {
@@ -576,7 +576,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', {
@@ -590,7 +589,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', {
@@ -604,7 +602,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', {
@@ -646,7 +643,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', {
@@ -661,7 +657,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', {
@@ -676,7 +671,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', {
@@ -776,7 +770,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', {
@@ -792,6 +785,7 @@ 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 as Early Access feature in 9.12.5.cl).
@@ -811,9 +805,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', {
@@ -827,6 +821,7 @@ 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 as Early Access feature in 9.12.5.cl).
@@ -847,6 +842,7 @@ 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 as Early Access feature in 9.12.5.cl).
@@ -873,7 +869,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', {
@@ -891,7 +886,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', {
@@ -920,7 +914,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', {
@@ -943,10 +936,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', {
@@ -961,7 +953,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', {
@@ -984,7 +975,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', {
@@ -999,7 +989,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', {
@@ -1014,7 +1003,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', {
@@ -1135,7 +1123,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', {
@@ -1164,7 +1151,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', {
@@ -1172,7 +1158,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             *    enableVizTransformations:true,
             * })
             * ```
-            *
             * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
             */
         enableVizTransformations?: boolean;
@@ -1199,7 +1184,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', {
@@ -1229,7 +1213,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', {
@@ -1279,7 +1262,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', {
@@ -1305,9 +1287,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', {
@@ -1319,9 +1301,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', {
@@ -1581,6 +1563,7 @@ export declare enum AuthType {
             *      .then((data) => data.token);
             *  }
             * });
+            * });
             * ```
             */
         TrustedAuthToken = "AuthServer",
@@ -2046,7 +2029,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', {
@@ -2085,6 +2067,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
@@ -2102,7 +2085,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', {
@@ -2123,7 +2105,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', {
@@ -2137,7 +2118,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', {
@@ -2152,7 +2132,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', {
@@ -2173,7 +2152,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', {
@@ -2208,6 +2186,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', {
@@ -2236,7 +2215,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', {
@@ -2322,9 +2300,15 @@ 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
+<<<<<<< HEAD
+            * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.0.cl).
+=======
             * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+>>>>>>> 64e22666... typo fixes
             *
             * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             * @example
@@ -2334,13 +2318,13 @@ 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 as Early Access feature in 9.12.5.cl).
@@ -2363,7 +2347,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', {
@@ -2389,6 +2372,8 @@ export interface ViewConfig {
             * })
             * ```
             *
+            *
+            *
             * **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).
@@ -2421,7 +2406,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
@@ -2825,7 +2809,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.
             *
@@ -5366,16 +5351,6 @@ export declare enum Action {
             * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
             */
         CopyKpiLink = "copyKpiLink",
-        /**
-            * The **Organise Favourites** action on Homepage Favourite Module.
-            *
-            * @example
-            * ```js
-            * disabledActions: [Action.OrganiseFavourites]
-            * ```
-            * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
-            */
-        OrganiseFavourites = "organiseFavourites",
         /**
             * Action ID for AI Highlights button
             *
@@ -6684,12 +6659,3 @@ 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;
-