@thoughtspot/visual-embed-sdk 1.38.0 → 1.38.1

package/lib/src/types.d.ts

@@ -79,7 +79,7 @@ export declare enum AuthType {
      *   // ...
      *   authType: AuthType.SAMLRedirect,
      *   authTriggerText: 'Login with SAML',
-     *   authTriggerContainer: '#embed-container',
+     *   authTriggerContainer: '#tsEmbed',
      *   inPopup: true,
      * });
      * ```
@@ -204,13 +204,13 @@ export declare enum HomeLeftNavItem {
     /**
      * Create new options in the insights left navigation,
      * available when new navigation V3 is enabled.
-     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     Create = "create",
     /**
      * Spotter option in the insights left navigation,
      * available when new navigation V3 is enabled.
-     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     Spotter = "spotter"
 }
@@ -618,6 +618,20 @@ export interface EmbedConfig {
      */
     customVariablesForThirdPartyTools?: Record<string, any>;
     disablePreauthCache?: boolean;
+    /**
+     * Disable fullscreen presentation mode functionality. When enabled, prevents entering
+     * and exiting fullscreen mode for embedded visualizations during presentations.
+     * @default true (feature is disabled by default)
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     * @example
+     * ```js
+     * init({
+     *   ... // other embed config options
+     *   disableFullscreenPresentation: false, // enables the feature
+     * })
+     * ```
+     */
+    disableFullscreenPresentation?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -647,9 +661,9 @@ export interface FrameParams {
     [key: string]: string | number | boolean | undefined;
 }
 /**
- * The configuration object for an embedded view.
+ * The common configuration object for an embedded view.
  */
-export interface ViewConfig {
+export interface BaseViewConfig {
     /**
      * @hidden
      */
@@ -657,16 +671,19 @@ export interface ViewConfig {
     /**
      * The width and height dimensions to render an embedded
      * object inside your app.  Specify the values in pixels or percentage.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   frameParams: {
-     *     width: '500px' | '50%',
-     *      height: '400px' | '60%',
-     *   },
-     * });
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    frameParams: {
+     *        width: '500px' | '50%',
+     *        height: '400px' | '60%',
+     *    },
+     * })
      * ```
      */
     frameParams?: FrameParams;
@@ -683,38 +700,31 @@ export interface ViewConfig {
      * (...), and the contextual menu. These actions will be disabled
      * for the user.
      * Use this to disable actions.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   disabledActions: [Action.Download, Action.Save]
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    disabledActions: [Action.Download, Action.Save],
      * });
      * ```
      */
     disabledActions?: Action[];
-    /**
-     * The primary action to display on top of the viz for Liveboard and App Embed.
-     * Use this to set the primary action.
-     * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   primaryAction: Action.Download
-     * });
-     * ```
-     */
-    primaryAction?: Action | string;
     /**
      * The tooltip to display for disabled actions.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   disabledActions: [Action.Download, Action.Save]
-     *   disabledActionReason: "Reason for disabling",
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    disabledActions: [Action.Download, Action.Save],
+     *    disabledActionReason: "Reason for disabling",
      * });
      * ```
      */
@@ -723,12 +733,15 @@ export interface ViewConfig {
      * The list of actions to hide from the embedded.
      * This actions will be hidden from the user.
      * Use this to hide an action.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   hiddenActions: [Action.Download, Action.Export]
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    hiddenActions: [Action.Download, Action.Export],
      * });
      * ```
      * @important
@@ -741,74 +754,30 @@ export interface ViewConfig {
      * Use this to hide all actions except the ones you want to show.
      *
      * Use either this or hiddenActions.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @important
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   visibleActions: [Action.Download, Action.Export]
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    visibleActions: [Action.Download, Action.Export],
      * });
      * ```
      */
     visibleActions?: Action[];
-    /**
-     * Show alert messages and toast messages in the embedded
-     * view in full app embed.
-     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-     * @example
-     * ```js
-     * const embed = new AppEmbed('#embed-container', {
-     *    ... // other options
-     *    showAlerts:true,
-     * })
-     * ```
-     */
-    showAlerts?: boolean;
-    /**
-     * The list of runtime filters to apply to a search Answer,
-     * 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', {
-     *    ... // other options
-     *    runtimeFilters: [
-     *           {
-     *             columnName: 'value',
-     *              operator: RuntimeFilterOp.EQ,
-     *             values: ['string' | 123 | true],
-     *           },
-     *       ],
-     * })
-     * ```
-     */
-    runtimeFilters?: RuntimeFilter[];
-    /**
-     * The list of parameter override to apply to a search Answer,
-     * 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', {
-     *    ... // other options
-     *    runtimeParameters: [
-     *     {
-     *       name: 'value',
-     *       value: 'string' | 123 | true,
-     *     },
-     *   ],
-     * })
-     * ```
-     */
-    runtimeParameters?: RuntimeParameter[];
     /**
      * The locale settings to apply to the embedded view.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
      *    locale:'en',
      * })
      * ```
@@ -822,14 +791,17 @@ 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.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
      *   additionalFlags: {
      *        flag1: 'value1',
      *        flag2: 'value2'
-     *     }
+     *     },
      * });
      * ```
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
@@ -847,82 +819,187 @@ export interface ViewConfig {
     /**
      * Insert as a sibling of the target container, instead of appending to a
      * child inside it.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
      *    insertAsSibling:true,
      * })
      * ```
      */
     insertAsSibling?: boolean;
     /**
-     * flag to set ContextMenu Trigger to either left or right click.
+     * Use a pre-rendered iframe from a pool of pre-rendered iframes
+     * if available and matches the configuration.
+     * @version SDK: 1.22.0
+     * @hidden
+     *
+     * See [docs]() on how to create a prerender pool.
+     */
+    usePrerenderedIfAvailable?: boolean;
+    /**
+     * PreRender id to be used for PreRendering the embed.
+     * Use PreRender to render the embed in the background and then
+     * show or hide the rendered embed using showPreRender or hidePreRender respectively.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#tsEmbed', {
-     *    ... // other options
-     *    contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
-     * })
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *   preRenderId: "preRenderId-123",
+     * });
+     * embed.showPreRender();
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
      */
-    contextMenuTrigger?: ContextMenuTriggerOptions;
+    preRenderId?: string;
+    /**
+     * Determines if the PreRender component should dynamically track the size
+     * of its embedding element and adjust its own size accordingly.
+     * Enabling this option allows the PreRender component to automatically adapt
+     * its dimensions based on changes to the size of the embedding element.
+     * @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
+     * const config = {
+     *   doNotTrackPreRenderSize: true,
+     * };
+     *
+     * // Instantiate an object with the configuration
+     * const myComponent = new MyComponent(config);
+     * ```
+     */
+    doNotTrackPreRenderSize?: boolean;
+    /**
+     * Enable the V2 shell. This can provide performance benefits
+     * due to a lighterweight shell.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *   enableV2Shell_experimental: true,
+     * });
+     * ```
+     * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
+     */
+    enableV2Shell_experimental?: boolean;
+    /**
+     * For internal tracking of the embed component type.
+     * @hidden
+     */
+    embedComponentType?: string;
+    /**
+     * This flag can be used to expose translation IDs on the embedded app.
+     * @default false
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+     */
+    exposeTranslationIDs?: boolean;
+    /**
+     * This flag can be used to disable links inside the embedded app,
+     * and disable redirection of links in a new tab.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *   ... // other embed view config
+     *   disableRedirectionLinksInNewTab: true,
+     * });
+     * ```
+     * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
+     */
+    disableRedirectionLinksInNewTab?: boolean;
+    /**
+     * Overrides an Org context for embedding application users.
+     * This parameter allows a user authenticated to one Org to view the
+     * objects from another Org.
+     * The `overrideOrgId` setting is honoured only if the
+     * Per Org URL feature is enabled on your ThoughtSpot instance.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *   ... // other embed view config
+     *   overrideOrgId: 142536,
+     * });
+     * ```
+     * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
+     */
+    overrideOrgId?: number;
     /**
      * Flag to override the *Open Link in New Tab* context menu option.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
      *    linkOverride:false,
      * })
      * ```
      */
     linkOverride?: boolean;
+    /**
+     * The primary action to display on top of the viz for Liveboard and App Embed.
+     * Use this to set the primary action.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *   primaryAction: Action.Download
+     * });
+     * ```
+     */
+    primaryAction?: Action | string;
     /**
      * flag to enable insert into slides action
      * @hidden
      * @private
      */
     insertInToSlide?: boolean;
+}
+/**
+ * The configuration object for Home page embeds configs.
+ */
+export interface HomePageConfig {
     /**
-     * Use a pre-rendered iframe from a pool of pre-rendered iframes
-     * if available and matches the configuration.
-     * @version SDK: 1.22.0
-     * @hidden
+     * Hide list page columns
+     * For example: hiddenListColumns = [ListPageColumns.Author]
      *
-     * See [docs]() on how to create a prerender pool.
-     */
-    usePrerenderedIfAvailable?: boolean;
-    /**
-     * Boolean to exclude runtimeFilters in the URL
-     * By default it is true, this flag removes runtime filters from the URL
-     * when set to false, runtime filters will be included in the URL.
+     * **Note**: This option is available only in full app embedding.
      *
-     * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
-     * embedded view.
-     * @default false
-     * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
-     */
-    excludeRuntimeFiltersfromURL?: boolean;
-    /**
-     * The list of tab IDs to hide from the embedded.
-     * This Tabs will be hidden from their respective LBs.
-     * Use this to hide an tabID.
+     * Supported embed types: `AppEmbed`
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   hiddenTabs: [
-     * '430496d6-6903-4601-937e-2c691821af3c',
-     *  'f547ec54-2a37-4516-a222-2b06719af726']
-     * });
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... //other embed view config
+     *    hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
+     * })
      * ```
-     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
      */
-    hiddenTabs?: string[];
+    hiddenListColumns?: ListPageColumns[];
     /**
      * Hide the home page modules
      * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
@@ -930,11 +1007,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 as Early Access feature in 9.12.5.cl).
+     *
+     * Supported embed types: `AppEmbed`
      * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
-     *    ... // other options
+     *    ... //other embed view config
      *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
      * })
      * ```
@@ -947,42 +1026,28 @@ 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).
+     *
+     * Supported embed types: `AppEmbed`
      * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
-     *    ... // other options
-     *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
+     *    ... //other embed view config
+     *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
      * })
      * ```
      */
     reorderedHomepageModules?: HomepageModule[];
-    /**
-     * The list of tab IDs to show in the embedded Liveboard.
-     * Only the tabs specified in the array will be shown in the Liveboard.
-     *
-     * Use either `visibleTabs` or `hiddenTabs`.
-     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
-     *    visibleTabs: [
-     *       '430496d6-6903-4601-937e-2c691821af3c',
-     *       'f547ec54-2a37-4516-a222-2b06719af726'
-     *     ]
-     * })
-     * ```
-     */
-    visibleTabs?: string[];
     /**
      * homepageLeftNavItems : Show or hide the left navigation bar items.
      * There are 8 eight home navigation list items.
      * To hide these items, specify the string in the array.
+     *
+     * Supported embed types: `AppEmbed`
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
-     *    ... // other options
+     *    ... //other embed view config
      *    hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
      * })
      * ```
@@ -993,46 +1058,80 @@ export interface ViewConfig {
      * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
      */
     hiddenHomeLeftNavItems?: HomeLeftNavItem[];
+}
+/**
+ * The configuration object for common Search and Liveboard embeds configs.
+ */
+export interface SearchLiveboardCommonViewConfig {
     /**
-     * PreRender id to be used for PreRendering the embed.
-     * Use PreRender to render the embed in the background and then
-     * show or hide the rendered embed using showPreRender or hidePreRender respectively.
+     * The list of runtime filters to apply to a search Answer,
+     * visualization, or Liveboard.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
+     * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   preRenderId: "preRenderId-123"
-     * });
-     * embed.showPreRender();
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    runtimeFilters: [
+     *           {
+     *             columnName: 'value',
+     *              operator: RuntimeFilterOp.EQ,
+     *             values: ['string' | 123 | true],
+     *           },
+     *       ],
+     * })
      * ```
-     * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
      */
-    preRenderId?: string;
+    runtimeFilters?: RuntimeFilter[];
     /**
-     * Determines if the PreRender component should dynamically track the size
-     * of its embedding element and adjust its own size accordingly.
-     * Enabling this option allows the PreRender component to automatically adapt
-     * its dimensions based on changes to the size of the embedding element.
-     * @type {boolean}
-     * @default false
-     * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
+     * The list of parameter override to apply to a search Answer,
+     * visualization, or Liveboard.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
+     * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      * @example
      * ```js
-     * // Disable tracking PreRender size in the configuration
-     * const config = {
-     *   doNotTrackPreRenderSize: true,
-     * };
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    runtimeParameters: [
+     *     {
+     *       name: 'value',
+     *       value: 'string' | 123 | true,
+     *     },
+     *   ]
+     * })
+     * ```
+     */
+    runtimeParameters?: RuntimeParameter[];
+    /**
+     * flag to set ContextMenu Trigger to either left or right click.
      *
-     * // Instantiate an object with the configuration
-     * const myComponent = new MyComponent(config);
+     * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
+     * })
      * ```
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
-    doNotTrackPreRenderSize?: boolean;
+    contextMenuTrigger?: ContextMenuTriggerOptions;
     /**
-     * For internal tracking of the embed component type.
-     * @hidden
+     * Boolean to exclude runtimeFilters in the URL
+     * By default it is true, this flag removes runtime filters from the URL
+     * when set to false, runtime filters will be included in the URL.
+     *
+     * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
+     * embedded view.
+     * @default false
+     * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
      */
-    embedComponentType?: string;
+    excludeRuntimeFiltersfromURL?: boolean;
     /**
      * Boolean to exclude runtimeParameters from the URL
      * when set to true, this flag removes runtime parameters from the URL.
@@ -1044,105 +1143,220 @@ export interface ViewConfig {
      */
     excludeRuntimeParametersfromURL?: boolean;
     /**
-     * Enable the V2 shell. This can provide performance benefits
-     * due to a lighterweight shell.
+     * To set the initial state of the search bar in case of saved Answers.
+     *
+     * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`
+     * @default true
+     * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   liveboardId: '123',
-     *   enableV2Shell_experimental: true
+     * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *   collapseSearchBar: true,
      * });
+     */
+    collapseSearchBar?: boolean;
+    /**
+     * Flag to control Data panel experience
+     *
+     * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
+     * @default false
+     * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    dataPanelV2: true,
+     * })
      * ```
-     * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
      */
-    enableV2Shell_experimental?: boolean;
+    dataPanelV2?: boolean;
     /**
-     * To set the initial state of the search bar in case of saved Answers.
-     * @default true
-     * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
+     * To enable custom column groups in data panel v2
+     *
+     * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
+     * @default false
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   liveboardId: '123',
-     *   collapseSearchBar: true
+     * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *   ... // other embed view config
+     *   enableCustomColumnGroups: true,
      * });
+     * ```
      */
-    collapseSearchBar?: boolean;
+    enableCustomColumnGroups?: boolean;
+}
+/**
+ * The configuration object for common Liveboard and App embeds configs.
+ */
+export interface LiveboardAppEmbedViewConfig {
     /**
-     * This flag can be used to expose translation IDs on the embedded app.
+     * Show or hide Liveboard header
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
-     * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    hideLiveboardHeader : true,
+     * })
+     * ```
      */
-    exposeTranslationIDs?: boolean;
+    hideLiveboardHeader?: boolean;
     /**
-     * This flag can be used to disable links inside the embedded app,
-     * and disable redirection of links in a new tab.
+     * Show or hide Liveboard title
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @default false
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   disableRedirectionLinksInNewTab: true
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    showLiveboardTitle:true,
+     * })
+     * ```
+     */
+    showLiveboardTitle?: boolean;
+    /**
+     * Show or hide Liveboard description
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @default false
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    showLiveboardDescription:true,
+     * })
+     * ```
+     */
+    showLiveboardDescription?: boolean;
+    /**
+     * Boolean to control if Liveboard header is sticky or not.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#embed', {
+     *   ... // other app view config
+     *   isLiveboardHeaderSticky: true,
      * });
      * ```
-     * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
-    disableRedirectionLinksInNewTab?: boolean;
+    isLiveboardHeaderSticky?: boolean;
     /**
-     * Flag to control Data panel experience
+     * This attribute can be used to enable the two-column layout on an embedded Liveboard
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @type {boolean}
      * @default false
-     * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
      * @example
      * ```js
-     * const embed = new AppEmbed('#tsEmbed', {
-     *    ... // other options
-     *    dataPanelV2: true,
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    enable2ColumnLayout: true,
      * })
      * ```
      */
-    dataPanelV2?: boolean;
+    enable2ColumnLayout?: boolean;
     /**
-     * To enable custom column groups in data panel v2
-     * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
+     * This flag can be used to enable the compact header in Liveboard
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @type {boolean}
      * @default false
+     * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
      * @example
      * ```js
-     * const embed = new SearchEmbed('#tsEmbed', {
-     *   ... // other options
-     *   enableCustomColumnGroups: true,
-     * });
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isLiveboardCompactHeaderEnabled: true,
+     * })
      * ```
      */
-    enableCustomColumnGroups?: boolean;
+    isLiveboardCompactHeaderEnabled?: boolean;
     /**
-     * Overrides an Org context for embedding application users.
-     * This parameter allows a user authenticated to one Org to view the
-     * objects from another Org.
-     * The `overrideOrgId` setting is honoured only if the
-     * Per Org URL feature is enabled on your ThoughtSpot instance.
+     * This flag can be used to show or hide the Liveboard verified icon in the compact header.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+     * @default true
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other options
-     *   overrideOrgId: 142536
-     * });
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    showLiveboardVerifiedBadge: true,
+     * })
      * ```
-     * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
      */
-    overrideOrgId?: number;
+    showLiveboardVerifiedBadge?: boolean;
     /**
-     * Hide list page columns
-     * For example: hiddenListColumns = [ListPageColumns.Author]
+     * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
      *
-     * **Note**: This option is available only in full app embedding.
-     * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
+     * @default false
      * @example
      * ```js
-     * const embed = new AppEmbed('#tsEmbed', {
-     *    ... // other options
-     *    hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    hideIrrelevantChipsInLiveboardTabs: true,
      * })
      * ```
      */
-    hiddenListColumns?: ListPageColumns[];
+    hideIrrelevantChipsInLiveboardTabs?: boolean;
+    /**
+     * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+     * @default true
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    showLiveboardReverifyBanner: true,
+     * })
+     * ```
+     */
+    showLiveboardReverifyBanner?: boolean;
+    /**
+     * enable or disable ask sage
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+     * @default false
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SpotterEmbed, or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    enableAskSage:true,
+     * })
+     * ```
+     */
+    enableAskSage?: boolean;
+}
+export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
 }
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1535,7 +1749,7 @@ export declare enum EmbedEvent {
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @example
      * ```js
-     * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
+     * LiveboardEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
      *      console.log('VizPointDoubleClick', payload);
      * })
      * ```
@@ -2394,7 +2608,13 @@ export declare enum EmbedEvent {
      * Emitted when a user creates a Model.
      * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
      */
-    CreateModel = "createModel"
+    CreateModel = "createModel",
+    /**
+     * @hidden
+     * Emitted when a user exits present mode.
+     * @version SDK : 1.40.0 | ThoughtSpot : 10.11.0.cl
+     */
+    ExitPresentMode = "exitPresentMode"
 }
 /**
  * Event types that can be triggered by the host application
@@ -3466,7 +3686,17 @@ export declare enum HostEvent {
      * ```
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-    TransformTableVizData = "TransformTableVizData"
+    TransformTableVizData = "TransformTableVizData",
+    /**
+     * @hidden
+     * Trigger exit from presentation mode when user exits fullscreen.
+     * This is automatically triggered by the SDK when fullscreen mode is exited.
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
+     *```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     */
+    ExitPresentMode = "exitPresentMode"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -3598,7 +3828,8 @@ export declare enum Param {
     ShowSpotterLimitations = "showSpotterLimitations",
     CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
     PrimaryAction = "primaryAction",
-    isSpotterAgentEmbed = "isSpotterAgentEmbed"
+    isSpotterAgentEmbed = "isSpotterAgentEmbed",
+    IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
 }
 /**
  * ThoughtSpot application pages include actions and menu commands
@@ -3609,8 +3840,8 @@ export declare enum Param {
  * or `hiddenActions` array.
  * @example
  * ```js
- * const embed = new LiveboardEmbed('#embed-container', {
- *    ... // other options
+ * const embed = new LiveboardEmbed('#tsEmbed', {
+ *    ... //other embed view config
  *    visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
  *    disabledActions: [Action.Download],
  *    //hiddenActions: [], // Set either this or visibleActions
@@ -3618,8 +3849,8 @@ export declare enum Param {
  * ```
  * @example
  * ```js
- * const embed = new LiveboardEmbed('#embed-container', {
- *    ... // other options
+ * const embed = new LiveboardEmbed('#tsEmbed', {
+ *    ... //other embed view config
  *    //visibleActions: [],
  *    disabledActions: [Action.Download],
  *    hiddenActions: [Action.Edit, ActionAction.Explore],
@@ -4891,7 +5122,7 @@ export declare enum LogLevel {
      * @example
      * ```js
      * init({
-     *   ... // other options,
+     *   ... //other embed view config,
      *  logLevel: LogLevel.SILENT,
      * })
      * ```
@@ -4903,7 +5134,7 @@ export declare enum LogLevel {
      * @example
      * ```js
      * init({
-     *   ... // other options,
+     *   ... //other embed view config,
      *  logLevel: LogLevel.ERROR,
      * })
      * ```
@@ -4915,7 +5146,7 @@ export declare enum LogLevel {
      * @example
      * ```js
      * init({
-     *   ... // other options,
+     *   ... //other embed view config,
      *  logLevel: LogLevel.WARN,
      * })
      * ```
@@ -4928,7 +5159,7 @@ export declare enum LogLevel {
      * @example
      * ```js
      * init({
-     *   ... // other options,
+     *   ... //other embed view config,
      *  logLevel: LogLevel.INFO,
      * })
      * ```
@@ -4941,7 +5172,7 @@ export declare enum LogLevel {
      * @example
      * ```js
      * init({
-     *   ... // other options,
+     *   ... //other embed view config,
      *  logLevel: LogLevel.DEBUG,
      * })
      * ```
@@ -4953,7 +5184,7 @@ export declare enum LogLevel {
      * @example
      * ```js
      * init({
-     *   ... // other options,
+     *   ... //other embed view config,
      *  logLevel: LogLevel.TRACE,
      * })
      * ```