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

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

@@ -528,6 +528,7 @@ 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', {
@@ -541,6 +542,7 @@ 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', {
@@ -556,6 +558,7 @@ 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', {
@@ -565,14 +568,11 @@ 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,6 +587,7 @@ 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', {
@@ -600,6 +601,7 @@ 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', {
@@ -613,6 +615,7 @@ 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', {
@@ -654,6 +657,7 @@ 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', {
@@ -668,6 +672,7 @@ 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', {
@@ -682,6 +687,7 @@ 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', {
@@ -781,6 +787,7 @@ 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', {
@@ -796,7 +803,6 @@ 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).
@@ -816,9 +822,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', {
@@ -832,7 +838,6 @@ 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).
@@ -853,7 +858,6 @@ 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).
@@ -880,6 +884,7 @@ 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', {
@@ -897,6 +902,7 @@ 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', {
@@ -925,6 +931,7 @@ 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', {
@@ -947,9 +954,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
         liveboardV2?: boolean;
         /**
             * If set to true, the Search Assist feature is enabled.
-            *
             * @default true
+            *
             * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+            *
             * @example
             * ```js
             * const embed = new AppEmbed('#tsEmbed', {
@@ -964,6 +972,7 @@ 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', {
@@ -986,6 +995,7 @@ 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', {
@@ -1000,6 +1010,7 @@ 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,6 +1025,7 @@ 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', {
@@ -1134,6 +1146,7 @@ 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', {
@@ -1162,6 +1175,7 @@ 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', {
@@ -1169,6 +1183,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             *    enableVizTransformations:true,
             * })
             * ```
+            *
             * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
             */
         enableVizTransformations?: boolean;
@@ -1195,6 +1210,7 @@ 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', {
@@ -1224,6 +1240,7 @@ 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', {
@@ -1273,6 +1290,7 @@ 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', {
@@ -1298,9 +1316,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', {
@@ -1312,9 +1330,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', {
@@ -1888,7 +1906,6 @@ export declare enum AuthType {
             *      .then((data) => data.token);
             *  }
             * });
-            * });
             * ```
             */
         TrustedAuthToken = "AuthServer",
@@ -2354,6 +2371,7 @@ 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', {
@@ -2392,7 +2410,6 @@ 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
@@ -2410,6 +2427,7 @@ 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', {
@@ -2430,6 +2448,7 @@ export interface ViewConfig {
             *
             * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
             * @important
+            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -2443,6 +2462,7 @@ 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', {
@@ -2457,6 +2477,7 @@ 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', {
@@ -2477,6 +2498,7 @@ 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', {
@@ -2511,7 +2533,6 @@ 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', {
@@ -2540,6 +2561,7 @@ 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', {
@@ -2600,7 +2622,7 @@ export interface ViewConfig {
             * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
             * embedded view.
             *
-            * @default true
+            * @default false
             * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
             */
         excludeRuntimeFiltersfromURL?: boolean;
@@ -2625,11 +2647,9 @@ 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 as Early Access feature in 9.12.0.cl).
+            * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
             *
             * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             * @example
@@ -2639,13 +2659,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).
@@ -2668,6 +2688,7 @@ 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', {
@@ -2685,8 +2706,7 @@ export interface ViewConfig {
             * There are 8 eight home navigation list items.
             * 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
@@ -2694,11 +2714,9 @@ 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).
+            * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
             *
             * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
             */
@@ -2728,6 +2746,7 @@ 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
@@ -3131,8 +3150,7 @@ 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.
             *
@@ -5673,6 +5691,16 @@ 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
             *
@@ -6350,6 +6378,15 @@ 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
     *