@thoughtspot/visual-embed-sdk 1.28.4 → 1.28.5-alpha-1

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

@@ -517,6 +517,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', {
@@ -530,6 +531,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', {
@@ -545,6 +547,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', {
@@ -554,14 +557,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', {
@@ -576,6 +576,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', {
@@ -589,6 +590,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', {
@@ -602,6 +604,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', {
@@ -643,6 +646,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', {
@@ -657,6 +661,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', {
@@ -671,6 +676,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', {
@@ -792,6 +798,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', {
@@ -807,7 +814,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).
@@ -827,9 +833,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', {
@@ -843,7 +849,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).
@@ -864,7 +869,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).
@@ -891,6 +895,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', {
@@ -908,6 +913,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', {
@@ -936,6 +942,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', {
@@ -958,9 +965,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', {
@@ -975,6 +983,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', {
@@ -997,6 +1006,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', {
@@ -1011,6 +1021,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', {
@@ -1025,6 +1036,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', {
@@ -1183,6 +1195,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', {
@@ -1211,6 +1224,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', {
@@ -1218,6 +1232,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             *    enableVizTransformations:true,
             * })
             * ```
+            *
             * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
             */
         enableVizTransformations?: boolean;
@@ -1244,6 +1259,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', {
@@ -1273,6 +1289,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', {
@@ -1322,6 +1339,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', {
@@ -1347,9 +1365,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', {
@@ -1361,9 +1379,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', {
@@ -1639,7 +1657,6 @@ export declare enum AuthType {
             *      .then((data) => data.token);
             *  }
             * });
-            * });
             * ```
             */
         TrustedAuthToken = "AuthServer",
@@ -2081,6 +2098,23 @@ export interface EmbedConfig {
             * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
             */
         currencyFormat?: string;
+        /**
+            * This flag is used to disable the token verification in the SDK.
+            * Enabling this flag will also disable the caching of the token.
+            *
+            * @hidden
+            *
+            * @example
+            * ```js
+            * init({
+            *   ...embedConfig,
+            *   disableTokenVerification : true
+            * })
+            * ```
+            *
+            * @version SDK: 1.28.5 | Thoughtspot: *
+            */
+        disableTokenVerification?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -2123,6 +2157,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', {
@@ -2161,7 +2196,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
@@ -2179,6 +2213,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', {
@@ -2199,6 +2234,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', {
@@ -2212,6 +2248,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', {
@@ -2226,6 +2263,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', {
@@ -2246,6 +2284,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', {
@@ -2280,7 +2319,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', {
@@ -2309,6 +2347,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', {
@@ -2394,8 +2433,6 @@ 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.5.cl).
@@ -2408,13 +2445,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).
@@ -2437,6 +2474,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', {
@@ -2462,8 +2500,6 @@ 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).
@@ -2496,6 +2532,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
@@ -2899,8 +2936,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.
             *
@@ -6840,7 +6876,7 @@ export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promi
   * ```js
   * resetCachedAuthToken();
   * ```
-  * @version SDK: 1.28.2 | ThoughtSpot: *
+  * @version SDK: 1.28.0 | ThoughtSpot: *
   * @group Authentication / Init
   */
 export declare const resetCachedAuthToken: () => void;