@thoughtspot/visual-embed-sdk 1.20.0-alpha.2 → 1.20.0-prerender.0

package/lib/src/visual-embed-sdk.d.ts

@@ -17,9 +17,9 @@ declare module '@thoughtspot/visual-embed-sdk' {
     import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from '@thoughtspot/visual-embed-sdk/embed/liveboard';
     import { SearchEmbed, SearchViewConfig } from '@thoughtspot/visual-embed-sdk/embed/search';
     import { SearchBarEmbed, SearchBarViewConfig } from '@thoughtspot/visual-embed-sdk/embed/search-bar';
-    import { AuthFailureType, AuthStatus, AuthEvent, getSessionInfo } from '@thoughtspot/visual-embed-sdk/auth';
-    import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures } from '@thoughtspot/visual-embed-sdk/types';
-    export { init, logout, prefetch, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, };
+    import { AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, getSessionInfo } from '@thoughtspot/visual-embed-sdk/auth';
+    import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface } from '@thoughtspot/visual-embed-sdk/types';
+    export { init, logout, prefetch, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, };
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/app' {
@@ -70,7 +70,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
     }
     /**
         * The view configuration for full app embedding.
-        * @Category App Embed
+        *
+        * @group Embed components
         */
     export interface AppViewConfig extends ViewConfig {
             /**
@@ -95,8 +96,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 */
             pageId?: Page;
             /**
-                * This puts a filter tag on the application. All metadata lists in the application, such as
-                * Liveboards and answers, would be filtered by this tag.
+                * This puts a filter tag on the application. All metadata lists in the
+                * application, such as Liveboards and answers, would be filtered by this
+                * tag.
                 */
             tag?: string;
             /**
@@ -106,35 +108,47 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
             /**
                 * Render liveboards using the new v2 rendering mode
                 * This is a transient flag which is primarily meant for internal use
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 * @hidden
                 */
             liveboardV2?: 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
                 */
             enableSearchAssist?: boolean;
     }
     /**
         * Embeds full ThoughtSpot experience in a host application.
-        * @Category App Embed
+        *
+        * @group Embed components
         */
     export class AppEmbed extends V1Embed {
             protected viewConfig: AppViewConfig;
             constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
+            /**
+                * Constructs a map of parameters to be passed on to the
+                * embedded Liveboard or visualization.
+                */
+            protected getEmbedParams(): string;
             /**
                 * Navigate to particular page for app embed. eg:answers/pinboards/home
-                * This is used for embedding answers, pinboards, visualizations and full application only.
+                * This is used for embedding answers, pinboards, visualizations and full application
+                * only.
+                *
                 * @param path string | number The string, set to iframe src and navigate to new page
                 * eg: appEmbed.navigateToPage('pinboards')
-                * When used with `noReload` this can also be a number like 1/-1 to go forward/back.
+                * When used with `noReload` (default: true) this can also be a number
+                * like 1/-1 to go forward/back.
                 * @param noReload boolean Trigger the navigation without reloading the page
                 * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
                 */
             navigateToPage(path: string | number, noReload?: boolean): void;
             /**
                 * Renders the embedded application pages in the ThoughtSpot app.
+                *
                 * @param renderOptions An object containing the page ID
                 * to be embedded.
                 */
@@ -143,18 +157,16 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/base' {
+    import { EmbedConfig, PrefetchFeatures } from '@thoughtspot/visual-embed-sdk/types';
+    import { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, AuthEventEmitter } from '@thoughtspot/visual-embed-sdk/auth';
+    export let authPromise: Promise<boolean>;
     /**
-        * Copyright (c) 2022
-        *
-        * Base classes
+        * Gets the configuration embed was initialized with.
         *
-        * @summary Base classes
-        * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+        * @returns {@link EmbedConfig} The configuration embed was initialized with.
+        * @version SDK: 1.19.0 | ThoughtSpot: *
+        * @group Global methods
         */
-    import EventEmitter from 'eventemitter3';
-    import { EmbedConfig, PrefetchFeatures } from '@thoughtspot/visual-embed-sdk/types';
-    import { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout } from '@thoughtspot/visual-embed-sdk/auth';
-    export let authPromise: Promise<boolean>;
     export const getEmbedConfig: () => EmbedConfig;
     export const getAuthPromise: () => Promise<boolean>;
     export { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, };
@@ -163,41 +175,63 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
         */
     export const handleAuth: () => Promise<boolean>;
     /**
-        * Prefetches static resources from the specified URL. Web browsers can then cache the prefetched resources and serve them from the user's local disk to provide faster access to your app.
+        * Prefetches static resources from the specified URL. Web browsers can then cache the
+        * prefetched resources and serve them from the user's local disk to provide faster access
+        * to your app.
+        *
         * @param url The URL provided for prefetch
         * @param prefetchFeatures Specify features which needs to be prefetched.
         * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
+        * @group Global methods
         */
     export const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[]) => void;
     /**
         * Initializes the Visual Embed SDK globally and perform
         * authentication if applicable.
+        *
         * @param embedConfig The configuration object containing ThoughtSpot host,
         * authentication mechanism and so on.
-        * example: authStatus = init(config);
-        * authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
-        * @returns event emitter which emits events on authentication success, failure and logout. See {@link AuthStatus}
+        * @example
+        * ```js
+        *   const authStatus = init({
+        *     thoughtSpotHost: 'https://my.thoughtspot.cloud',
+        *     authType: AuthType.None,
+        *   });
+        *   authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
+        * ```
+        * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success,
+        *      failure and logout. See {@link AuthStatus}
         * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
+        * @group Authentication / Init
+        */
+    export const init: (embedConfig: EmbedConfig) => AuthEventEmitter;
+    /**
+        *
         */
-    export const init: (embedConfig: EmbedConfig) => EventEmitter;
     export function disableAutoLogin(): void;
     /**
-        * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to prevent
-        * the SDK from automatically logging in again.
+        * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
+        * prevent the SDK from automatically logging in again.
         *
-        * You can call the `init` method again to re login, if autoLogin is set to true in this
-        * second call it will be honored.
+        * You can call the `init` method again to re login, if autoLogin is set to
+        * true in this second call it will be honored.
         *
         * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
         * @returns Promise which resolves when logout completes.
         * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
+        * @group Global methods
         */
     export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
     /**
-        * Renders functions in a queue, resolves to next function only after the callback next is called
+        * Renders functions in a queue, resolves to next function only after the callback next
+        * is called
+        *
         * @param fn The function being registered
         */
     export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
+    /**
+        *
+        */
     export function reset(): void;
 }
 
@@ -216,12 +250,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
     import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
         * The configuration for the embedded Liveboard or visualization page view.
-        * @Category Liveboards and Charts
+        *
+        * @group Embed components
         */
     export interface LiveboardViewConfig extends ViewConfig {
             /**
                 * If set to true, the embedded object container dynamically resizes
                 * according to the height of the Liveboard.
+                *
                 * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
                 */
             fullHeight?: boolean;
@@ -229,6 +265,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * This is the minimum height(in pixels) for a full height Liveboard.
                 * Setting this height helps resolves issues with empty Liveboards and
                 * other screens navigable from a Liveboard.
+                *
                 * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
                 * @default 500
                 */
@@ -240,11 +277,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             /**
                 * The Liveboard to display in the embedded view.
                 * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
+                *
                 * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
                 */
             liveboardId?: string;
             /**
                 * To support backward compatibility
+                *
                 * @hidden
                 */
             pinboardId?: string;
@@ -255,6 +294,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             /**
                 * If set to true, all filter chips from a
                 * Liveboard page will be read-only (no X buttons)
+                *
                 * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
                 */
             preventLiveboardFilterRemoval?: boolean;
@@ -262,44 +302,57 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * Array of viz ids which should be visible when the liveboard
                 * first renders. This can be changed by triggering the "SetVisibleVizs"
                 * event.
+                *
                 * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
                 */
             visibleVizs?: string[];
             /**
                 * To support backward compatibilty
+                *
                 * @hidden
                 */
             preventPinboardFilterRemoval?: boolean;
             /**
                 * Render embedded Liveboards and visualizations in the new Liveboard experience mode
+                *
                 * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
                 */
             liveboardV2?: boolean;
             /**
                 * Tab Id of the Liveboard that is supposed to be active
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             activeTabId?: string;
     }
     /**
         * Embed a ThoughtSpot Liveboard or visualization
-        * @Category Liveboards and Charts
+        *
+        * @group Embed components
         */
     export class LiveboardEmbed extends V1Embed {
             protected viewConfig: LiveboardViewConfig;
             constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
+            /**
+                * Construct a map of params to be passed on to the
+                * embedded Liveboard or visualization.
+                */
+            protected getEmbedParams(): string;
             /**
                 * Triggers an event to the embedded app
+                *
                 * @param messageType The event type
                 * @param data The payload to send with the message
                 */
             trigger(messageType: HostEvent, data?: any): Promise<any>;
             /**
                 * Render an embedded ThoughtSpot Liveboard or visualization
+                *
                 * @param renderOptions An object specifying the Liveboard ID,
                 * visualization ID and the runtime filters.
                 */
             render(): LiveboardEmbed;
+            navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
     }
     /**
         * @hidden
@@ -330,14 +383,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             /**
                 * Boolean to determine if the search should be executed or not.
                 * if it is executed, put the focus on the results.
-                * if it’s not executed, put the focus in the search bar - at the end of the tokens
+                * if it’s not executed, put the focus in the search bar - at the end of
+                * the tokens
                 */
             executeSearch?: boolean;
     }
     /**
         * The configuration attributes for the embedded search view.
         *
-        * @Category Search Embed
+        * @group Embed components
         */
     export interface SearchViewConfig extends ViewConfig {
             /**
@@ -357,6 +411,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             hideResults?: 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
                 */
             enableSearchAssist?: boolean;
@@ -368,16 +423,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             /**
                 * The array of data source GUIDs to set on load.
                 * Only a single dataSource supported currently.
+                *
                 * @deprecated Use dataSource instead
                 */
             dataSources?: string[];
             /**
                 * The array of data source GUIDs to set on load.
+                *
                 * @version: SDK: 1.19.0
                 */
             dataSource?: string;
             /**
                 * The initial search query to load the answer with.
+                *
                 * @deprecated Use {@link searchOptions} instead
                 */
             searchQuery?: string;
@@ -392,6 +450,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             /**
                 * If set to true, search page will render without the Search Bar
                 * The chart/table should still be visible.
+                *
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             hideSearchBar?: boolean;
@@ -400,7 +459,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
     /**
         * Embed ThoughtSpot search
         *
-        * @Category Search Embed
+        * @group Embed components
         */
     export class SearchEmbed extends TsEmbed {
             /**
@@ -408,6 +467,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 */
             protected viewConfig: SearchViewConfig;
             constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
+            protected getEmbedParams(): string;
             /**
                 * Render the embedded ThoughtSpot search
                 */
@@ -419,15 +479,20 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
     import { ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     import { SearchOptions } from '@thoughtspot/visual-embed-sdk/embed/search';
+    /**
+        * @group Embed components
+        */
     export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
             /**
                 * The array of data source GUIDs to set on load.
                 * Only a single dataSource supported currently.
+                *
                 * @deprecated Use dataSource instead
                 */
             dataSources?: string[];
             /**
                 * The array of data source GUIDs to set on load.
+                *
                 * @version: SDK: 1.19.0
                 */
             dataSource?: string;
@@ -439,8 +504,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
     /**
         * Embed ThoughtSpot search bar
         *
-        * @Category Search Embed
         * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+        * @group Embed components
         */
     export class SearchBarEmbed extends TsEmbed {
             /**
@@ -470,12 +535,23 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
             BASIC_LOGIN: string;
             LOGOUT: string;
     };
+    /**
+        * Enum for auth failure types. This is the parameter passed to the listner
+        * of {@link AuthStatus.FAILURE}.
+        *
+        * @group Authentication / Init
+        */
     export enum AuthFailureType {
             SDK = "SDK",
             NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
             EXPIRY = "EXPIRY",
             OTHER = "OTHER"
     }
+    /**
+        * Enum for auth status emitted by the emitter returned from {@link init}.
+        *
+        * @group Authentication / Init
+        */
     export enum AuthStatus {
             /**
                 * Emits when the SDK fails to authenticate
@@ -497,40 +573,97 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
                 * Emitted when inPopup: true in the SAMLRedirect flow.
                 * And, we are waiting for popup to be triggered either programatically
                 * or by the trigger button.
+                *
                 * @version SDK: 1.19.0
                 */
             WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
     }
+    /**
+        * Event emitter returned from {@link init}.
+        *
+        * @group Authentication / Init
+        */
+    export interface AuthEventEmitter {
+            /**
+                * Registed a listener on Auth failure.
+                *
+                * @param event
+                * @param listener
+                */
+            on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
+            on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+            on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
+            /**
+                * Trigger an event on the emitter returned from init.
+                *
+                * @param {@link AuthEvent}
+                */
+            emit(event: AuthEvent): void;
+    }
+    /**
+        * Events which can be triggered on the emitter returned from {@link init}.
+        *
+        * @group Authentication / Init
+        */
     export enum AuthEvent {
             /**
-                * Manually trigger the SSO popup.
+                * Manually trigger the SSO popup. This is useful with
+                * authStatus: SAMLRedirect/OIDCRedicre and inPopup: true
                 */
             TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
     }
-    export function getAuthEE(): EventEmitter;
-    export function setAuthEE(eventEmitter: EventEmitter): void;
+    /**
+        *
+        */
+    export function getAuthEE(): EventEmitter<AuthStatus | AuthEvent>;
+    /**
+        *
+        * @param eventEmitter
+        */
+    export function setAuthEE(eventEmitter: EventEmitter<AuthStatus | AuthEvent>): void;
+    /**
+        *
+        */
     export function notifyAuthSDKSuccess(): void;
+    /**
+        *
+        */
     export function notifyAuthSuccess(): void;
+    /**
+        *
+        * @param failureType
+        */
     export function notifyAuthFailure(failureType: AuthFailureType): void;
+    /**
+        *
+        */
     export function notifyLogout(): void;
     /**
         * Return releaseVersion if available
         */
     export function getReleaseVersion(): string;
     /**
-        * Return a promise that resolves with the session info when authentication is
-        * successful. And info is available.
+        * Return a promise that resolves with the session information when
+        * authentication is successful. And info is available.
+        *
+        * @group Global methods
         */
     export function getSessionInfo(): Promise<any>;
+    /**
+        *
+        * @param sessionDetails
+        */
     export function initSession(sessionDetails: any): void;
     export const getAuthenticaionToken: (embedConfig: EmbedConfig) => Promise<any>;
     /**
         * Perform token based authentication
+        *
         * @param embedConfig The embed configuration
         */
     export const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
     /**
         * Validate embedConfig parameters required for cookielessTokenAuth
+        *
         * @param embedConfig The embed configuration
         */
     export const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
@@ -540,6 +673,7 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
         *
         * Warning: This feature is primarily intended for developer testing. It is
         * strongly advised not to use this authentication method in production.
+        *
         * @param embedConfig The embed configuration
         */
     export const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
@@ -548,6 +682,7 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
     export const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
     /**
         * Perform authentication on the ThoughtSpot cluster
+        *
         * @param embedConfig The embed configuration
         */
     export const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
@@ -561,26 +696,33 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
     /**
         * The authentication mechanism for allowing access to the
         * the embedded app
+        *
+        * @group Authentication / Init
         */
     export enum AuthType {
             /**
-                * No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
+                * No authentication on the SDK. Passthrough to the embedded App. Alias for
+                * `Passthrough`.
                 */
             None = "None",
             /**
-                * Passthrough SSO to the embedded App within the iframe. Requires least configuration, but may not
-                * be supported by all IDPs. This will behave like `None` if SSO is not configured on ThoughtSpot.
+                * Passthrough SSO to the embedded App within the iframe. Requires least
+                * configuration, but may not be supported by all IDPs. This will behave like `None`
+                * if SSO is not configured on ThoughtSpot.
+                *
                 * @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
                 */
             EmbeddedSSO = "EmbeddedSSO",
             /**
                 * SSO using SAML
+                *
                 * @deprecated Use {@link SAMLRedirect} instead
                 * @hidden
                 */
             SSO = "SSO_SAML",
             /**
                 * SSO using SAML
+                *
                 * @deprecated Use {@link SAMLRedirect} instead
                 * @hidden
                 */
@@ -588,10 +730,21 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * SSO using SAML
                 * Will make the host application redirect to the SAML Idp.
+                *
+                * @example
+                * ```js
+                * init({
+                *   // ...
+                *   authType: AuthType.SAMLRedirect,
+                *   authTriggerText: 'Login with SAML',
+                *   authTriggerContainer: '#embed-container',
+                *  });
+                * ```
                 */
             SAMLRedirect = "SSO_SAML",
             /**
                 * SSO using OIDC
+                *
                 * @hidden
                 * @deprecated Use {@link OIDCRedirect} instead
                 */
@@ -603,21 +756,35 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             OIDCRedirect = "SSO_OIDC",
             /**
                 * Trusted authentication server
+                *
                 * @hidden
                 * @deprecated Use {@link TrustedAuth} instead
                 */
             AuthServer = "AuthServer",
             /**
                 * Trusted authentication server, Use your own authentication server
-                * which returns a bearer token, generated using the secret_key obtained from
-                * ThoughtSpot.
+                * which returns a bearer token, generated using the secret_key obtained
+                * from ThoughtSpot.
+                *
+                * @example
+                * ```js
+                * init({
+                *  // ...
+                *  authType: AuthType.TrustedAuthToken,
+                *  getAuthToken: () => {
+                *    return fetch('https://my-backend.app/ts-token')
+                *      .then((response) => response.json())
+                *      .then((data) => data.token);
+                *  }
+                * ```
                 */
             TrustedAuthToken = "AuthServer",
             /**
-                * Trusted authentication server Cookieless, Use you own authentication server
-                * which returns a bearer token, generated using the secret_key obtained from
-                * ThoughtSpot. This uses a cookieless authentication approach, recommended
-                * to by pass third-party cookie-blocking restriction implemented by some browsers
+                * Trusted authentication server Cookieless, Use you own authentication
+                * server which returns a bearer token, generated using the secret_key
+                * obtained from ThoughtSpot. This uses a cookieless authentication
+                * approach, recommended to by pass third-party cookie-blocking restriction
+                * implemented by some browsers
                 */
             TrustedAuthTokenCookieless = "AuthServerCookieless",
             /**
@@ -629,7 +796,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Basic = "Basic"
     }
     export type DOMSelector = string | HTMLElement;
-    interface customCssInterface {
+    /**
+        * inline customCSS within the {@link CustomisationsInterface}.
+        */
+    export interface customCssInterface {
             variables?: {
                     [variableName: string]: string;
             };
@@ -639,10 +809,38 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                     };
             };
     }
-    interface CustomStyles {
+    /**
+        * Styles within the {@link CustomisationsInterface}.
+        */
+    export interface CustomStyles {
             customCSSUrl?: string;
             customCSS?: customCssInterface;
     }
+    /**
+        * Configuration to define the customization on the Embedded
+        * Thoughtspot components.
+        *
+        * @example
+        * ```js
+        *  init({
+        *    // ...
+        *    customizations: {
+        *     style: {
+        *       customCSS: {
+        *         variables: {},
+        *         rules_UNSTABLE: {}
+        *       }
+        *     },
+        *     content: {
+        *      strings: {
+        *        'LIVEBOARDS': 'Dashboards'
+        *      }
+        *     },
+        *     iconSpriteUrl: 'https://my-custom-icon-sprite.svg'
+        *    }
+        *  })
+        * ```
+        */
     export interface CustomisationsInterface {
             style?: CustomStyles;
             content?: {
@@ -656,6 +854,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
         * It includes the ThoughtSpot hostname or IP address,
         * the type of authentication, and the authentication endpoint
         * if a trusted authentication server is used.
+        *
+        * @group Authentication / Init
         */
     export interface EmbedConfig {
             /**
@@ -687,8 +887,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             getAuthToken?: () => Promise<string>;
             /**
-                * [AuthServer / Basic] The user name of the ThoughtSpot user. This attribute is
-                * required for trusted authentication.
+                * [AuthServer / Basic] The user name of the ThoughtSpot user. This
+                * attribute is required for trusted authentication.
                 */
             username?: string;
             /**
@@ -699,16 +899,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             password?: string;
             /**
-                * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will open the SAML auth
-                * flow in a popup, instead of redirecting browser in place.
+                * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
+                * open the SAML auth flow in a popup, instead of redirecting browser in
+                * place.
                 *
                 * @default false
                 * @deprecated
                 */
             noRedirect?: boolean;
             /**
-                * [SSO] For SSO Authentication, if `inPopup` is set to true, it will open the SAML auth
-                * flow in a popup, instead of redirecting browser in place.
+                * [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
+                * the SAML auth flow in a popup, instead of redirecting browser in place.
                 *
                 * @default false
                 * @version SDK: 1.18.0
@@ -720,6 +921,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * terminated.
                 *
                 * Eg: "/dashboard", "#/foo" [Do not include the host]
+                *
                 * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
                 */
             redirectPath?: string;
@@ -729,43 +931,52 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * Should we encode URL Query Params using base64 encoding which thoughtspot
                 * will generate for embedding. This provides additional security to
                 * thoughtspot clusters against Cross site scripting attacks.
+                *
                 * @default false
                 */
             shouldEncodeUrlQueryParams?: boolean;
             /**
-                * Suppress cookie access alert when third party cookies are blocked by the user's browser.
-                * Third party cookie blocking is the default behaviour on Safari and opt-in for Firefox/Chrome.
-                * If you set this to `true`, you are encouraged to handle `noCookieAccess` event, to show your own treatment
+                * Suppress cookie access alert when third party cookies are blocked by the
+                * user's browser. Third party cookie blocking is the default behaviour on
+                * Safari and opt-in for Firefox/Chrome. If you set this to `true`, you are
+                * encouraged to handle `noCookieAccess` event, to show your own treatment
                 * in this case.
+                *
                 * @default false
                 */
             suppressNoCookieAccessAlert?: boolean;
             /**
                 * Re-login when session expires with the previous login options
+                *
                 * @default false
                 */
             autoLogin?: boolean;
             /**
                 * Disable redirection to the login page when the embedded session expires
-                * This flag is typically used alongside the combination of auth modes such as {@link AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
+                * This flag is typically used alongside the combination of auth modes such as {@link
+                * AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
+                *
                 * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
                 * @default false
                 */
             disableLoginRedirect?: boolean;
             /**
                 * This message is displayed on the embed view when the login fails.
+                *
                 * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
                 */
             loginFailedMessage?: string;
             /**
                 * Calls the prefetch method internally when set to true
+                *
                 * @default false
                 */
             callPrefetch?: boolean;
             /**
                 * When there are multiple embeds, queue the render of embed to start
-                *  after the previous embed's render is complete. This helps in the load performance
-                *  by decreasing the load on the browser.
+                *  after the previous embed's render is complete. This helps in the load
+                *  performance by decreasing the load on the browser.
+                *
                 *  @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
                 * @default false
                 */
@@ -773,15 +984,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Dynamic CSS Url to be injected in the loaded application.
                 * You would also need to set `style-src` in the CSP settings.
+                *
                 * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
                 * @default ''
                 */
             customCssUrl?: string;
             /**
-                * [AuthServer|Basic] Detect if 3rd party cookies are enabled by doing an additional call. This is slower
-                * and should be avoided. Listen to the NO_COOKIE_ACCESS event to handle the situation.
+                * [AuthServer|Basic] Detect if 3rd party cookies are enabled by doing an
+                * additional call. This is slower and should be avoided. Listen to the
+                * NO_COOKIE_ACCESS event to handle the situation.
+                *
+                * This is slightly slower than letting the browser handle the cookie check, as it
+                * involves an extra network call.
                 *
-                * This is slightly slower than letting the browser handle the cookie check, as it involves an extra network call.
                 * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
                 */
             detectCookieAccessSlow?: boolean;
@@ -808,6 +1023,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Text to show in the button which triggers the popup auth flow.
                 * Default: "Authorize".
+                *
                 * @version SDK: 1.17.0 | ThoughtSpot: *
                 */
             authTriggerText?: string;
@@ -816,6 +1032,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
     }
     /**
         * Embedded iFrame configuration
+        *
+        * @group Embed components
         */
     export interface FrameParams {
             /**
@@ -826,6 +1044,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * The height of the iFrame (unit is pixels if numeric).
                 */
             height?: number | string;
+            /**
+                * Set to 'lazy' to enable lazy loading of the embedded TS frame.
+                * This will defer loading of the frame until it comes into the
+                * viewport. This is useful for performance optimization.
+                */
+            loading?: 'lazy' | 'eager' | 'auto';
             /**
                 * This parameters will be passed on the iframe
                 * as is.
@@ -841,7 +1065,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             layoutConfig?: LayoutConfig;
             /**
-                * The <b>width</b> and <b>height</b> dimensions to render an embedded object inside your app.  Specify the values in pixels or percentage.
+                * The <b>width</b> and <b>height</b> dimensions to render an embedded
+                * object inside your app.  Specify the values in pixels or percentage.
                 */
             frameParams?: FrameParams;
             /**
@@ -869,11 +1094,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * The list of actions to display from the primary menu, more menu
                 * (...), and the contextual menu.
+                *
                 * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
                 */
             visibleActions?: Action[];
             /**
                 * Show alert messages and toast messages in the embedded view.
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             showAlerts?: boolean;
@@ -884,6 +1111,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             runtimeFilters?: RuntimeFilter[];
             /**
                 * The locale/language to use for the embedded view.
+                *
                 * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
                 */
             locale?: string;
@@ -894,6 +1122,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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.
+                *
                 * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
                 */
             additionalFlags?: {
@@ -902,33 +1131,47 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Dynamic CSSUrl and customCSS to be injected in the loaded application.
                 * You would also need to set `style-src` in the CSP settings.
+                *
                 * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
                 * @default ''
                 */
             customizations?: CustomisationsInterface;
             /**
-                * Insert as a sibling of the target container, instead of appending to a child inside it.
+                * Insert as a sibling of the target container, instead of appending to a
+                * child inside it.
                 */
             insertAsSibling?: boolean;
             /**
                 * flag to set ContextMenu Trigger to either left or right click.
+                *
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             contextMenuTrigger?: ContextMenuTriggerOptions;
             /**
                 * flag to override openNew tab context menu link
+                *
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             linkOverride?: boolean;
             /**
                 * flag to enable insert into slides action
+                *
                 * @hidden
                 * @private
                 */
             insertInToSlide?: boolean;
+            /**
+                * Use a pre-rendered iframe from a pool of pre-rendered iframes
+                * if available and matches the configuration.
+                *
+                * See [docs]() on how to create a prerender pool.
+                */
+            usePrerenderedIfAvailable?: boolean;
     }
     /**
         * MessagePayload: Embed event payload: message type, data and status (start/end)
+        *
+        * @group Events
         */
     export type MessagePayload = {
             type: string;
@@ -936,19 +1179,37 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             status?: string;
     };
     /**
-        * MessageOptions: By Providing options, getting specific event start / end based on option
+        * MessageOptions: By Providing options, getting specific event start / end based on
+        * option
+        *
+        * @group Events
         */
     export type MessageOptions = {
+            /**
+                *  A boolean value indicating that start status events of this type
+                *  will be dispatched
+                */
             start?: boolean;
     };
     /**
         * MessageCallback: Embed event message callback
+        *
+        * @group Events
+        */
+    export type MessageCallback = (payload: MessagePayload, 
+    /**
+        *  responder: Message callback function triggered when embed event
+        *  initiated
         */
-    export type MessageCallback = (payload: MessagePayload, responder?: (data: any) => void) => void;
+    responder?: (data: any) => void) => void;
     /**
         * MessageCallbackObj: contains message options & callback function
         */
     export type MessageCallbackObj = {
+            /**
+                *  options: It contains start, A boolean value indicating that start
+                *  status events of this type will be dispatched
+                */
             options: MessageOptions;
             callback: MessageCallback;
     };
@@ -1032,36 +1293,47 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             operator: RuntimeFilterOp;
             /**
                 * The list of operands. Some operators like EQ, LE accept
-                * a single operand, whereas other operators like BW and IN accept multiple operands.
+                * a single operand, whereas other operators like BW and IN accept multiple
+                * operands.
                 */
             values: (number | boolean | string)[];
     }
     /**
         * Event types emitted by the embedded ThoughtSpot application.
+        *
+        * To add an event listener use the corresponding
+        * {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
+        *
+        * @group Events
         */
     export enum EmbedEvent {
             /**
                 * Rendering has initialized.
-                * @return timestamp - The timestamp when the event was generated.
+                *
+                * @returns timestamp - The timestamp when the event was generated.
                 */
             Init = "init",
             /**
                 * Authentication has either succeeded or failed.
-                * @return isLoggedIn - A Boolean specifying whether authentication was successful.
+                *
+                * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
                 */
             AuthInit = "authInit",
             /**
                 * The embed object container has loaded.
-                * @return timestamp - The timestamp when the event was generated.
+                *
+                * @returns timestamp - The timestamp when the event was generated.
                 */
             Load = "load",
             /**
                 * Data pertaining to answer or Liveboard is received
-                * @return data - The answer or Liveboard data
+                *
+                * @returns data - The answer or Liveboard data
                 */
             Data = "data",
             /**
                 * Search/answer/Liveboard filters have been applied/updated
+                *
                 * @hidden
                 */
             FiltersChanged = "filtersChanged",
@@ -1071,48 +1343,56 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             QueryChanged = "queryChanged",
             /**
                 * A drill down operation has been performed.
-                * @return additionalFilters - Any additional filters applied
-                * @return drillDownColumns - The columns on which drill down was performed
-                * @return nonFilteredColumns - The columns that were not filtered
+                *
+                * @returns additionalFilters - Any additional filters applied
+                * @returns drillDownColumns - The columns on which drill down was performed
+                * @returns nonFilteredColumns - The columns that were not filtered
                 */
             Drilldown = "drillDown",
             /**
                 * One or more data sources have been selected.
-                * @return dataSourceIds - the list of data sources
+                *
+                * @returns dataSourceIds - the list of data sources
                 */
             DataSourceSelected = "dataSourceSelected",
             /**
                 * One or more data columns have been selected.
-                * @return columnIds - the list of columns
+                *
+                * @returns columnIds - the list of columns
                 * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
                 */
             AddRemoveColumns = "addRemoveColumns",
             /**
                 * A custom action has been triggered
-                * @return actionId - The id of the custom action
-                * @return data - The answer or Liveboard data
+                *
+                * @returns actionId - The id of the custom action
+                * @returns data - The answer or Liveboard data
                 */
             CustomAction = "customAction",
             /**
                 * A double click has been triggered on table/chart
-                * @return ContextMenuInputPoints - data point that is double clicked
+                *
+                * @returns ContextMenuInputPoints - data point that is double clicked
                 * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
                 */
             VizPointDoubleClick = "vizPointDoubleClick",
             /**
                 * A click has been triggered on table/chart
-                * @return ContextMenuInputPoints - data point that is clicked
+                *
+                * @returns ContextMenuInputPoints - data point that is clicked
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             VizPointClick = "vizPointClick",
             /**
                 * An error has occurred.
-                * @return error - An error object or message
+                *
+                * @returns error - An error object or message
                 */
             Error = "Error",
             /**
                 * The embedded object has sent an alert
-                * @return alert - An alert object
+                *
+                * @returns alert - An alert object
                 */
             Alert = "alert",
             /**
@@ -1121,29 +1401,34 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             AuthExpire = "ThoughtspotAuthExpired",
             /**
                 * ThoughtSpot failed to validate the auth session.
+                *
                 * @hidden
                 */
             AuthFailure = "ThoughtspotAuthFailure",
             /**
                 * ThoughtSpot failed to validate the auth session.
+                *
                 * @hidden
                 */
             AuthLogout = "ThoughtspotAuthLogout",
             /**
                 * The height of the embedded Liveboard or visualization has been computed.
-                * @return data - The height of the embedded Liveboard or visualization
+                *
+                * @returns data - The height of the embedded Liveboard or visualization
                 * @hidden
                 */
             EmbedHeight = "EMBED_HEIGHT",
             /**
                 * The center of visible iframe viewport is calculated.
-                * @return data - The center of the visible Iframe viewport.
+                *
+                * @returns data - The center of the visible Iframe viewport.
                 * @hidden
                 */
             EmbedIframeCenter = "EmbedIframeCenter",
             /**
                 * Emitted when  the "Get Data" button in Search Bar embed
                 * is clicked.
+                *
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
                 */
             GetDataClick = "getDataClick",
@@ -1153,6 +1438,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             RouteChange = "ROUTE_CHANGE",
             /**
                 * The v1 event type for Data
+                *
                 * @hidden
                 */
             V1Data = "exportVizDataToParent",
@@ -1165,17 +1451,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             NoCookieAccess = "noCookieAccess",
             /**
                 * Emitted when SAML is complete
+                *
                 * @private
                 * @hidden
                 */
             SAMLComplete = "samlComplete",
             /**
                 * Emitted when any modal is opened in the app
+                *
                 * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
                 */
             DialogOpen = "dialog-open",
             /**
                 * Emitted when any modal is closed in the app
+                *
                 * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
                 */
             DialogClose = "dialog-close",
@@ -1183,414 +1472,569 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * Emitted when the Liveboard shell loads.
                 * You can use this event as a hook to trigger
                 * other events on the rendered Liveboard.
+                *
                 * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
                 */
             LiveboardRendered = "PinboardRendered",
             /**
                 * This can be used to register an event listener which
                 * is triggered on all events.
+                *
                 * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
                 */
             ALL = "*",
             /**
                 * Emitted when answer is saved in the app
+                *
                 * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             Save = "save",
             /**
                 * Emitted when the download action is triggered on an answer
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             Download = "download",
             /**
                 * Emitted when the Download as PDF action is triggered on an answer
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             DownloadAsPdf = "downloadAsPdf",
             /**
                 * Emitted when the Download as CSV action is triggered on an answer
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             DownloadAsCsv = "downloadAsCsv",
             /**
                 * Emitted when the Download as XLSX action is triggered on an answer
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             DownloadAsXlsx = "downloadAsXlsx",
             /**
                 * Emitted when an answer is deleted in the app
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             AnswerDelete = "answerDelete",
             /**
                 * Emitted when an answer is pinned to a Liveboard
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             Pin = "pin",
             /**
                 * Emitted when SpotIQ analysis is triggered
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             SpotIQAnalyze = "spotIQAnalyze",
             /**
                 * Emitted when a user shares an object with another user or group
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             Share = "share",
             /**
-                * Emitted when a user clicks the Include action to include a specific value or data on a chart or table
+                * Emitted when a user clicks the Include action to include a specific value or data
+                * on a chart or table
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             DrillInclude = "context-menu-item-include",
             /**
-                * Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table
+                * Emitted when a user clicks the Exclude action to exclude a specific value or data
+                * on a chart or table
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             DrillExclude = "context-menu-item-exclude",
             /**
                 * Emitted when copied column value on the app
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             CopyToClipboard = "context-menu-item-copy-to-clipboard",
             /**
                 * Emitted when a user clicks the Update TML action
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             UpdateTML = "updateTSL",
             /**
                 * Emitted when a user clicks the Edit TML action
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             EditTML = "editTSL",
             /**
                 * Emitted when ExportTML trigger in answer on the app
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             ExportTML = "exportTSL",
             /**
                 * Emitted when an answer is saved as a view
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             SaveAsView = "saveAsView",
             /**
                 * Emitted when copy of existing answer on the app
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             CopyAEdit = "copyAEdit",
             /**
                 * Emitted when a user clicks Show underlying data on an answe
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             ShowUnderlyingData = "showUnderlyingData",
             /**
                 * Emitted when an answer is switched to a chart or table view
+                *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
                 */
             AnswerChartSwitcher = "answerChartSwitcher",
             /**
                 * Internal event to communicate the initial settings back to the TS APP
+                *
                 * @hidden
                 */
             APP_INIT = "appInit",
             /**
                 * Emitted when a user clicks Show Liveboard details on a Liveboard
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             LiveboardInfo = "pinboardInfo",
             /**
                 * Emitted when a user clicks on the Favorite icon on a Liveboard
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             AddToFavorites = "addToFavorites",
             /**
                 * Emitted when a user clicks Schedule on a Liveboard
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Schedule = "subscription",
             /**
                 * Emitted when a user clicks Edit on a Liveboard or visualization
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Edit = "edit",
             /**
                 * Emitted when a user clicks Make a copy on a Liveboard
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             MakeACopy = "makeACopy",
             /**
                 * Emitted when a user clicks Present on a Liveboard or visualization
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Present = "present",
             /**
                 * Emitted when a user clicks Delete on a Liveboard
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Delete = "delete",
             /**
                 * Emitted when a user clicks Manage schedules on a Liveboard
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             SchedulesList = "schedule-list",
             /**
                 * Emitted when a user clicks Cancel in edit mode on a Liveboard
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Cancel = "cancel",
             /**
                 * Emitted when a user clicks Explore on a visualization
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Explore = "explore",
             /**
                 * Emitted when a user clicks Copy link action on a visualization
+                *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             CopyLink = "embedDocument",
             /**
                 * Emitted when a user interacts with cross filters on a visualization or liveboard
+                *
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             CrossFilterChanged = "cross-filter-changed",
             /**
                 * Emitted when a user right clicks on chart or table
+                *
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
-            VizPointRightClick = "vizPointRightClick"
+            VizPointRightClick = "vizPointRightClick",
+            /**
+                * Emitted when a user clicks on Insert to slide on a visualization
+                *
+                * @hidden
+                */
+            InsertIntoSlide = "insertInToSlide"
     }
     /**
         * Event types that can be triggered by the host application
         * to the embedded ThoughtSpot app
         *
         * To trigger an event use the corresponding
-        * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link SearchEmbed.trigger} method.
+        * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
+        * SearchEmbed.trigger} method.
+        *
+        * @group Events
         */
     export enum HostEvent {
             /**
                 * Trigger a search
+                *
                 * @param - dataSourceIds - The data source GUID to Search on
                 *                        - Although an array, only a single source
                 *                          is supported at this time.
                 * @param - searchQuery - The search query
                 * @param - execute - execute the existing / updated query
                 * @example
+                * ```js
                 * searchEmbed.trigger(HostEvent.Search, {
-                * searchQuery: "[sales] by [item type],
-                * "dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
-                * "execute": true
+                *   searchQuery: "[sales] by [item type],
+                *   dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
+                *   execute: true
                 * })
+                * ```
                 */
             Search = "search",
             /**
                 * Trigger a drill on certain points by certain column
+                *
                 * @param - points - an object containing selectedPoints/clickedPoints
                 *              eg. { selectedPoints: []}
                 * @param - columnGuid - a string guid of the column to drill by. This is optional,
-                *                     if not provided it will auto drill by the configured column.
-                * @example searchEmbed.trigger(HostEvent.DrillDown, {
-                * points: clickedPointData,
-                * autoDrillDown: true,
+                *                     if not provided it will auto drill by the configured
+                *                     column.
+                * @example
+                * ```js
+                * searchEmbed.trigger(HostEvent.DrillDown, {
+                *   points: clickedPointData,
+                *   autoDrillDown: true,
                 * })
+                * ```
                 * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
                 */
             DrillDown = "triggerDrillDown",
             /**
                 * Apply filters
+                *
                 * @hidden
                 */
             Filter = "filter",
             /**
                 * Reload the answer or visualization
+                *
                 * @hidden
                 */
             Reload = "reload",
             /**
                 * Set the visible visualizations on a Liveboard.
+                *
                 * @param - an array of ids of visualizations to show, the ids not passed
                 *          will be hidden.
                 * @example
-                * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['730496d6-6903-4601-937e-2c691821af3c', 'd547ec54-2a37-4516-a222-2b06719af726'])
+                * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
+                *  '730496d6-6903-4601-937e-2c691821af3c',
+                *  'd547ec54-2a37-4516-a222-2b06719af726'])
                 * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
                 */
             SetVisibleVizs = "SetPinboardVisibleVizs",
             /**
                 * Update the runtime filters. The runtime filters passed here are extended
                 * on to the existing runtime filters if they exist.
+                *
                 * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
                 * @example
                 * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
                 * {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]},
-                * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
-                * ])
+                * {columnName: "item type",operator: RuntimeFilterOp.EQ,values:
+                * ["Jackets"]} ])
                 * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
                 */
             UpdateRuntimeFilters = "UpdateRuntimeFilters",
             /**
                 * Navigate to a specific page in App embed without any reload.
                 * This is the same as calling `appEmbed.navigateToPage(path, true)`
+                *
                 * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
-                * @example appEmbed.navigateToPage(-1)
+                * @example
+                * ```js
+                * appEmbed.navigateToPage(-1)
+                * ```
                 * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
                 */
             Navigate = "Navigate",
             /**
                 * Opens the filter panel for a particular column.
                 * Works with Search embed.
-                * @param - { columnId: string, name: string, type: INT64/CHAR/DATE, dataType: ATTRIBUTE/MEASURE }
-                * @example searchEmbed.trigger(HostEvent.OpenFilter, { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
+                *
+                * @param - { columnId: string,
+                *  name: string,
+                *  type: INT64/CHAR/DATE,
+                *  dataType: ATTRIBUTE/MEASURE }
+                * @example
+                * ```js
+                * searchEmbed.trigger(HostEvent.OpenFilter,
+                *  { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
+                * ```
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             OpenFilter = "openFilter",
             /**
                 * Adds the columns to the current Search.
+                *
                 * @param - { columnIds: string[] }
-                * @example searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
+                * @example
+                * ```js
+                * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
+                * ```
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             AddColumns = "addColumns",
             /**
                 * Removes a column from the current Search.
+                *
                 * @param - { columnId: string }
-                * @example - searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
+                * @example
+                * ```js
+                * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
+                * ```
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             RemoveColumn = "removeColumn",
             /**
                 * Gets the current pinboard content.
-                * @example liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
+                * ```
                 * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
                 */
             getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
             /**
                 * Triggers the Pin action on an embedded object
+                *
                 * @param - incase of Liveboard embed, takes in an object with vizId as a key
                 * can be left empty for search and visualization embeds
                 * @example
+                * ```js
                 * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.Pin)
                 * searchEmbed.trigger(HostEvent.Pin)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Pin = "pin",
             /**
                 * Triggers the Show Liveboard details action on a Liveboard
-                * @example liveboardEmbed.trigger(HostEvent.LiveboardInfo)
+                *
+                * @example
+                * ```js
+                *  liveboardEmbed.trigger(HostEvent.LiveboardInfo)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             LiveboardInfo = "pinboardInfo",
             /**
                 * Triggers the Schedule action on a Liveboard
-                * @example liveboardEmbed.trigger(HostEvent.Schedule)
+                *
+                * @example
+                * ```js
+                *  liveboardEmbed.trigger(HostEvent.Schedule)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Schedule = "subscription",
             /**
                 * Triggers the Manage schedule action on a Liveboard
-                * @example liveboardEmbed.trigger(HostEvent.ScheduleList)
+                *
+                * @example
+                * ```js
+                *  liveboardEmbed.trigger(HostEvent.ScheduleList)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             SchedulesList = "schedule-list",
             /**
                 * Triggers the Export TML action on a Liveboard
-                * @example liveboardEmbed.trigger(HostEvent.ExportTML)
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.ExportTML)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             ExportTML = "exportTSL",
             /**
                 * Triggers the Edit TML action on a Liveboard
-                * @example liveboardEmbed.trigger(HostEvent.EditTML)
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.EditTML)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             EditTML = "editTSL",
             /**
                 * Triggers the Update TML action on a Liveboard
-                * @example liveboardEmbed.trigger(HostEvent.UpdateTML)
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.UpdateTML)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             UpdateTML = "updateTSL",
             /**
                 * Triggers the Download PDF action on a Liveboard
-                * @example liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             DownloadAsPdf = "downloadAsPdf",
             /**
                 * Triggers the Make a copy action on a Liveboard, search or visualization
+                *
                 * @example
+                * ```js
                 * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.MakeACopy)
                 * searchEmbed.trigger(HostEvent.MakeACopy)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             MakeACopy = "makeACopy",
             /**
                 * Triggers the Delete action on a Liveboard
-                * @example appEmbed.trigger(HostEvent.Remove)
+                *
+                * @example
+                * ```js
+                * appEmbed.trigger(HostEvent.Remove)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Remove = "delete",
             /**
                 * Triggers the Explore action on a visualization
+                *
                 * @param - an object with vizId as a key
-                * @example liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Explore = "explore",
             /**
                 * Triggers the Create alert action on a visualization
+                *
                 * @param - an object with vizId as a key
-                * @example liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.CreateMonitor {
+                *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
+                * })
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             CreateMonitor = "createMonitor",
             /**
                 * Triggers the Manage alert action on a visualization
+                *
                 * @param - an object with vizId as a key
-                * @example liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
+                *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
+                * })
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             ManageMonitor = "manageMonitor",
             /**
                 * Triggers the Edit action on a Liveboard or visualization
-                * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+                *
+                * @param - object - to trigger the action for a specfic visualization
+                *   in Liveboard embed, pass in vizId as a key
                 * @example
                 * liveboardEmbed.trigger(HostEvent.Edit)
-                * liveboardEmbed.trigger(HostEvent.Edit, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger((HostEvent.Edit)
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Edit = "edit",
             /**
                 * Triggers the Copy link action on a Liveboard or visualization
-                * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+                *
+                * @param - object - to trigger the action for a s
+                *  pecfic visualization in Liveboard embed, pass in vizId as a key
                 * @example
+                * ```js
                 * liveboardEmbed.trigger(HostEvent.CopyLink)
                 * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger((HostEvent.CopyLink)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             CopyLink = "embedDocument",
             /**
                 * Triggers the Present action on a Liveboard or visualization
-                * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+                *
+                * @param - object - to trigger the action for a specfic visualization
+                *  in Liveboard embed, pass in vizId as a key
                 * @example
+                * ```js
                 * liveboardEmbed.trigger(HostEvent.Present)
                 * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger((HostEvent.Present)
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             Present = "present",
             /**
                 * Get TML for the current search.
-                * @example searchEmbed.trigger(HostEvent.GetTML)
+                *
+                * @example
+                * ```js
+                * searchEmbed.trigger(HostEvent.GetTML)
+                * ```
                 * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
                 */
             GetTML = "getTML",
             /**
                 * Triggers the ShowUnderlyingData action on visualization or search
+                *
                 * @param - an object with vizId as a key
                 * @example
-                * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
                 * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
@@ -1598,10 +2042,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             ShowUnderlyingData = "showUnderlyingData",
             /**
                 * Triggers the Delete action on visualization or search
+                *
                 * @param - incase of Liveboard embed, takes in an object with vizId as a key
                 * can be left empty for search and visualization embeds
                 * @example
-                * liveboardEmbed.trigger(HostEvent.Delete, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.Delete)
                 * searchEmbed.trigger(HostEvent.Delete)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
@@ -1609,10 +2055,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Delete = "delete",
             /**
                 * Triggers the SpotIQAnalyze action on visualization or search
+                *
                 * @param - incase of Liveboard embed, takes in an object with vizId as a key
                 * can be left empty for search and visualization embeds
                 * @example
-                * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
                 * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
@@ -1620,26 +2068,34 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             SpotIQAnalyze = "spotIQAnalyze",
             /**
                 * Triggers the Download action on visualization or search when Displaymode is Chart
+                *
                 * @example
-                * liveboardEmbed.trigger(HostEvent.Download, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.Download, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.Download)
                 * searchEmbed.trigger(HostEvent.Download)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
                 */
             Download = "download",
             /**
-                * Triggers the downloadAsCSV action on visualization or search when Displaymode is Table
+                * Triggers the downloadAsCSV action on visualization or search when Displaymode is
+                * Table
+                *
                 * @example
-                * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.DownloadAsCsv)
                 * searchEmbed.trigger(HostEvent.DownloadAsCsv)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
                 */
             DownloadAsCsv = "downloadAsCSV",
             /**
-                * Triggers the downloadAsXLSX action on visualization or search when Displaymode is Table
+                * Triggers the downloadAsXLSX action on visualization or search when Displaymode is
+                * Table
+                *
                 * @example
-                * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
                 * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
@@ -1647,6 +2103,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             DownloadAsXlsx = "downloadAsXLSX",
             /**
                 * Triggers the Share action on a liveboard or answer
+                *
                 * @example
                 * liveboardEmbed.trigger(HostEvent.Share)
                 * searchEmbed.trigger(HostEvent.Share)
@@ -1655,6 +2112,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Share = "share",
             /**
                 * Trigger the Save action on a liveboard or answer
+                *
                 * @example
                 * liveboardEmbed.trigger(HostEvent.Save)
                 * searchEmbed.trigger(HostEvent.Save)
@@ -1663,33 +2121,40 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Save = "save",
             /**
                 * Triggers the SyncToSheets action on visualization
+                *
                 * @param - an object with vizId as a key
                 * @example
-                * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.SyncToSheets)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
                 */
             SyncToSheets = "sync-to-sheets",
             /**
                 * Triggers the SyncToOtherApps action on visualization
+                *
                 * @param - an object with vizId as a key
                 * @example
-                * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.SyncToOtherApps)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
                 */
             SyncToOtherApps = "sync-to-other-apps",
             /**
                 * Triggers the ManagePipelines action on visualization
+                *
                 * @param - an object with vizId as a key
                 * @example
-                * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+                * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
+                * '730496d6-6903-4601-937e-2c691821af3c'})
                 * vizEmbed.trigger(HostEvent.ManagePipelines)
                 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
                 */
             ManagePipelines = "manage-pipeline",
             /**
                 * Triggers the Reset search in answer
+                *
                 * @example
                 * searchEmbed.trigger(HostEvent.SearchReset
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
@@ -1719,6 +2184,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
         * containing configuration and/or visual information.
         */
     export enum Param {
+            EmbedApp = "embedApp",
             DataSources = "dataSources",
             DataSourceMode = "dataSourceMode",
             DisableActions = "disableAction",
@@ -1757,7 +2223,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             cookieless = "cookieless",
             ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
             LinkOverride = "linkOverride",
-            ShowInsertToSlide = "insertInToSlide"
+            ShowInsertToSlide = "insertInToSlide",
+            PrimaryNavHidden = "primaryNavHidden",
+            HideProfleAndHelp = "profileAndHelpInNavBarHidden"
     }
     /**
         * The list of actions that can be performed on visual ThoughtSpot
@@ -1991,7 +2459,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             LEFT_CLICK = "left-click",
             RIGHT_CLICK = "right-click"
     }
-    export {};
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
@@ -2003,7 +2470,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
         * @summary Base classes
         * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
         */
-    import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig, FrameParams } from '@thoughtspot/visual-embed-sdk/types';
+    import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     /**
         * Global prefix for all Thoughtspot postHash Params.
         */
@@ -2014,6 +2481,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
         * React+GraphQL
         */
     export class TsEmbed {
+            protected isAppInitialized: boolean;
             /**
                 * A reference to the iframe within which the ThoughtSpot app
                 * will be rendered.
@@ -2029,41 +2497,53 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
             constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
             /**
                 * Handles errors within the SDK
+                *
                 * @param error The error message or object
                 */
             protected handleError(error: string | Record<string, unknown>): void;
             /**
                 * Constructs the base URL string to load the ThoughtSpot app.
+                *
+                * @param query
                 */
             protected getEmbedBasePath(query: string): string;
             /**
                 * Common query params set for all the embed modes.
+                *
+                * @param queryParams
                 * @returns queryParams
                 */
-            protected getBaseQueryParams(): {};
+            protected getBaseQueryParams(queryParams?: {}): {};
             /**
                 * Constructs the base URL string to load v1 of the ThoughtSpot app.
                 * This is used for embedding Liveboards, visualizations, and full application.
+                *
                 * @param queryString The query string to append to the URL.
                 * @param isAppEmbed A Boolean parameter to specify if you are embedding
                 * the full application.
                 */
-            protected getV1EmbedBasePath(queryString: string, showPrimaryNavbar?: boolean, disableProfileAndHelp?: boolean, isAppEmbed?: boolean, enableSearchAssist?: boolean): string;
+            protected getV1EmbedBasePath(queryString: string): string;
+            protected getEmbedParams(): string;
+            protected getRootIframeSrc(): string;
+            protected createIframeEl(frameSrc: string): HTMLIFrameElement;
             /**
                 * Renders the embedded ThoughtSpot app in an iframe and sets up
                 * event listeners.
+                *
                 * @param url
                 * @param frameOptions
                 */
-            protected renderIFrame(url: string, frameOptions?: FrameParams): Promise<any>;
+            protected renderIFrame(url: string): Promise<any>;
             protected insertIntoDOM(child: string | Node): void;
             /**
                 * Sets the height of the iframe
+                *
                 * @param height The height in pixels
                 */
             protected setIFrameHeight(height: number): void;
             /**
                 * Executes all registered event handlers for a particular event type
+                *
                 * @param eventType The event type
                 * @param data The payload invoked with the event handler
                 * @param eventPort The event Port for a specific MessageChannel
@@ -2075,6 +2555,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
             protected getThoughtSpotHost(): string;
             /**
                 * Gets the v1 event type (if applicable) for the EmbedEvent type
+                *
                 * @param eventType The v2 event type
                 * @returns The corresponding v1 event type if one exists
                 * or else the v2 event type itself
@@ -2084,6 +2565,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * Calculates the iframe center for the current visible viewPort
                 * of iframe using Scroll position of Host App, offsetTop for iframe
                 * in Host app. ViewPort height of the tab.
+                *
                 * @returns iframe Center in visible viewport,
                 *  Iframe height,
                 *  View port height.
@@ -2102,10 +2584,25 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * @param messageType The message type
                 * @param callback A callback as a function
                 * @param options The message options
+                * @example
+                * ```js
+                * tsEmbed.on(EmbedEvent.Error, (data) => {
+                *   console.error(data);
+                * });
+                * ```
+                * @example
+                * ```js
+                * tsEmbed.on(EmbedEvent.Save, (data) => {
+                *   console.log("Answer save clicked", data);
+                * }, {
+                *   start: true // This will trigger the callback on start of save
+                * });
+                * ```
                 */
             on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
             /**
                 * Triggers an event to the embedded app
+                *
                 * @param messageType The event type
                 * @param data The payload to send with the message
                 */
@@ -2114,6 +2611,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * Marks the ThoughtSpot object to have been rendered
                 * Needs to be overridden by subclasses to do the actual
                 * rendering of the iframe.
+                *
                 * @param args
                 */
             render(): TsEmbed;
@@ -2121,28 +2619,53 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * Get the Post Url Params for THOUGHTSPOT from the current
                 * host app URL.
                 * THOUGHTSPOT URL params starts with a prefix "ts-"
+                *
                 * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
                 */
             getThoughtSpotPostUrlParams(): string;
             /**
                 * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
+                *
                 * @version SDK: 1.19.1 | ThoughtSpot: *
                 */
             destroy(): void;
+            getUnderlyingFrameElement(): HTMLIFrameElement;
+            prerenderGeneric(): Promise<any>;
     }
     /**
         * Base class for embedding v1 experience
         * Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
         * which is currently under migration to v2
+        *
+        * @inheritdoc
         */
     export class V1Embed extends TsEmbed {
             protected viewConfig: ViewConfig;
             constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
             /**
-                * Render the app in an iframe and set up event handlers
+                * Render the ap    p in an iframe and set up event handlers
+                *
                 * @param iframeSrc
                 */
             protected renderV1Embed(iframeSrc: string): any;
+            protected getRootIframeSrc(): string;
+            /**
+                * @inheritdoc
+                * @example
+                * ```js
+                * tsEmbed.on(EmbedEvent.Error, (data) => {
+                *   console.error(data);
+                * });
+                * ```
+                * @example
+                * ```js
+                * tsEmbed.on(EmbedEvent.Save, (data) => {
+                *   console.log("Answer save clicked", data);
+                * }, {
+                *   start: true // This will trigger the callback on start of save
+                * });
+                * ```
+                */
             on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
     }
 }