@thoughtspot/visual-embed-sdk 1.28.3 → 1.29.0-alpha.3

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

@@ -363,7 +363,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
         showObjectResults?: boolean;
         /**
             * flag used by the TS product tour page to show the blue search bar
-            * even after the search is completed. This is different from TSE Sage Embed
+            * even after the search is completed. This is different from Thoughtspot Embedded Sage Embed
             * experience where it mimics closer to the non-embed case.
             * The Sample questions container is collapsed when this value is set after
             * does a search.
@@ -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', {
@@ -686,6 +692,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * @version: SDK: 1.24.0
             */
         useLastSelectedSources?: boolean;
+        /**
+            * To set the initial state of the search bar in case of saved-answers.
+            *
+            * @default false
+            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            */
+        collapseSearchBarInitially?: boolean;
 }
 export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
@@ -770,6 +783,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', {
@@ -785,7 +799,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).
@@ -805,9 +818,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', {
@@ -821,7 +834,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).
@@ -842,7 +854,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).
@@ -869,6 +880,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', {
@@ -886,6 +898,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', {
@@ -914,6 +927,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', {
@@ -936,9 +950,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', {
@@ -953,6 +968,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', {
@@ -975,6 +991,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', {
@@ -989,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', {
@@ -1003,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', {
@@ -1047,6 +1066,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * @default false
             */
         enableAskSage?: boolean;
+        /**
+            * To set the initial state of the search bar in case of saved-answers.
+            *
+            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            * @default false
+            */
+        collapseSearchBarInitially?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -1123,6 +1149,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', {
@@ -1151,6 +1178,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', {
@@ -1158,6 +1186,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             *    enableVizTransformations:true,
             * })
             * ```
+            *
             * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
             */
         enableVizTransformations?: boolean;
@@ -1184,6 +1213,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', {
@@ -1213,6 +1243,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', {
@@ -1262,6 +1293,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', {
@@ -1287,9 +1319,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', {
@@ -1301,9 +1333,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', {
@@ -1563,7 +1595,6 @@ export declare enum AuthType {
             *      .then((data) => data.token);
             *  }
             * });
-            * });
             * ```
             */
         TrustedAuthToken = "AuthServer",
@@ -1987,6 +2018,24 @@ export interface EmbedConfig {
             * @version SDK: 1.27.9
             */
         disableSDKTracking?: boolean;
+        /**
+            * Overrides default/user preffered locale for date formatting
+            *
+            * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+            */
+        dateFormatLocale?: string;
+        /**
+            * Overrides default/user preffered locale for number formatting
+            *
+            * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+            */
+        numberFormatLocale?: string;
+        /**
+            * Format to be used for currency when currency format is set to infer from browser
+            *
+            * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+            */
+        currencyFormat?: string;
 }
 export interface LayoutConfig {
 }
@@ -2029,6 +2078,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', {
@@ -2067,7 +2117,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
@@ -2085,6 +2134,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', {
@@ -2105,6 +2155,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', {
@@ -2118,6 +2169,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', {
@@ -2132,6 +2184,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', {
@@ -2152,6 +2205,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', {
@@ -2186,7 +2240,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', {
@@ -2215,6 +2268,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', {
@@ -2300,8 +2354,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).
@@ -2314,13 +2366,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).
@@ -2343,6 +2395,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', {
@@ -2368,8 +2421,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).
@@ -2402,6 +2453,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
@@ -2805,8 +2857,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.
             *
@@ -4447,7 +4498,11 @@ export declare enum Param {
         HideSearchBar = "hideSearchBar",
         ClientLogLevel = "clientLogLevel",
         OverrideNativeConsole = "overrideConsoleLogs",
-        enableAskSage = "enableAskSage"
+        enableAskSage = "enableAskSage",
+        CollapseSearchBarInitially = "collapseSearchBarInitially",
+        DateFormatLocale = "dateFormatLocale",
+        NumberFormatLocale = "numberFormatLocale",
+        CurrencyFormat = "currencyFormat"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -4583,6 +4638,18 @@ export declare enum Action {
             * ```
             */
         AddFilter = "addFilter",
+        /**
+            * The **Add Data Panel Objects** action on the data panel v2.
+            * Allows to show action menu to add different objects (like
+            * formulas, parameters) in data panel v2.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.AddDataPanelObjects]
+            * ```
+            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            */
+        AddDataPanelObjects = "addDataPanelObjects",
         /**
             * Filter configuration options on a Liveboard and Search page.
             * Allows configuring filter options when adding filters to a
@@ -4625,6 +4692,28 @@ export declare enum Action {
             * ```
             */
         AddParameter = "addParameter",
+        /**
+            * The **Add Column Set** action on a Answer.
+            * Allows adding column sets to a Answer.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.AddColumnSet]
+            * ```
+            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            */
+        AddColumnSet = "addSimpleCohort",
+        /**
+            * The **Add Query Set** action on a Answer.
+            * Allows adding query sets to a Answer.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.AddQuerySet]
+            * ```
+            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            */
+        AddQuerySet = "addAdvancedCohort",
         /**
             * @hidden
             */
@@ -5056,6 +5145,28 @@ export declare enum Action {
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
             */
         CrossFilter = "context-menu-item-cross-filter",
+        /**
+            * The **Sync to Slack** action on Liveboard visualizations.
+            * Allows sending data to third-party apps Slack
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.SyncToSlack]
+            * ```
+            * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
+            */
+        SyncToSlack = "syncToSlack",
+        /**
+            * The **Sync to Teams** action on Liveboard visualizations.
+            * Allows sending data to third-party apps Team
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.SyncToTeams]
+            * ```
+            * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
+            */
+        SyncToTeams = "syncToTeams",
         /**
             * The **Remove** action that appears when cross filters are applied
             * on a Liveboard.
@@ -5367,6 +5478,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
             *
@@ -6683,7 +6804,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;