@thoughtspot/visual-embed-sdk 1.24.0-sage.3 → 1.24.1

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

@@ -21,7 +21,7 @@ interface SearchProps extends EmbedProps, SearchViewConfig {
     * }
     * ```
     */
-export const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<TsEmbed>>;
+export const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<_SearchEmbed>>;
 interface AppProps extends EmbedProps, AppViewConfig {
 }
 /**
@@ -38,7 +38,7 @@ interface AppProps extends EmbedProps, AppViewConfig {
     * }
     * ```
     */
-export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<TsEmbed>>;
+export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<_AppEmbed>>;
 interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
 }
 /**
@@ -56,8 +56,8 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
     * }
     * ```
     */
-export const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
-export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
+export const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
+export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
 interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
 }
 /**
@@ -73,7 +73,7 @@ interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
     * }
     * ```
     */
-export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<TsEmbed>>;
+export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<_SearchBarEmbed>>;
 interface SageEmbedProps extends EmbedProps, SageViewConfig {
 }
 /**
@@ -89,7 +89,8 @@ interface SageEmbedProps extends EmbedProps, SageViewConfig {
     * }
     * ```
     */
-export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<TsEmbed>>;
+export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<_SageEmbed>>;
+type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
 /**
     * Get a reference to the embed component to trigger events on the component.
     *
@@ -105,9 +106,9 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
     * return <LiveboardEmbed ref={ref} liveboardId={<id>} />
     * }
     * ```
-    * @returns {React.MutableRefObject<TsEmbed>} ref
+    * @returns {React.MutableRefObject<T extends TsEmbed>} ref
     */
-export const useEmbedRef: () => React.MutableRefObject<TsEmbed>;
+export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<React.ComponentRef<T>>;
 
 /**
     * @group Embed components
@@ -126,6 +127,12 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
             * @version: SDK: 1.19.0
             */
         dataSource?: string;
+        /**
+            * Flag to set if last selected dataSource should be used
+            *
+            * @version: SDK: 1.24.0
+            */
+        useLastSelectedSources?: boolean;
         /**
             * Configuration for search options
             */
@@ -142,6 +149,7 @@ export declare class SearchBarEmbed extends TsEmbed {
             * The view configuration for the embedded ThoughtSpot search bar.
             */
         protected viewConfig: SearchBarViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: string, viewConfig: SearchBarViewConfig);
         /**
             * Render the embedded ThoughtSpot search
@@ -232,6 +240,7 @@ export declare class SageEmbed extends V1Embed {
             *
             */
         protected viewConfig: SageViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
         /**
             * Constructs a map of parameters to be passed on to the
@@ -293,6 +302,10 @@ export interface SearchViewConfig extends ViewConfig {
             * using raw answer data.
             */
         hideResults?: boolean;
+        /**
+            * If set to true, expands all the data sources panel.
+            */
+        expandAllDataSource?: boolean;
         /**
             * If set to true, the Search Assist feature is enabled.
             *
@@ -343,9 +356,18 @@ export interface SearchViewConfig extends ViewConfig {
             *
             * @default false
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            * @hidden
             */
         dataPanelV2?: boolean;
+        /**
+            * Flag to set if last selected dataSource should be used
+            *
+            * @version: SDK: 1.24.0
+            */
+        useLastSelectedSources?: boolean;
+        /**
+            * The list of parameter override to apply to a search answer.
+            */
+        runtimeParameters?: RuntimeParameter[];
 }
 export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
@@ -358,6 +380,7 @@ export declare class SearchEmbed extends TsEmbed {
             * The view configuration for the embedded ThoughtSpot search.
             */
         protected viewConfig: SearchViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
         protected getEmbedParams(): string;
         /**
@@ -418,8 +441,19 @@ export interface AppViewConfig extends ViewConfig {
         /**
             * If true, the main navigation bar within the ThoughtSpot app
             * is displayed. By default, the navigation bar is hidden.
+            * This flag also control the homepage left nav-bar.
             */
         showPrimaryNavbar?: boolean;
+        /**
+            * Flag to control Homepage Left Nav Bar
+            * If showPrimaryNavbar is true, ie navigation bar(Global nav-bar) and Homepage left
+            * nav-bar is visible, this flag will only hide the homepage left nav.
+            * Precedence of showPrimaryNavbar flag > hideHomepageLeftNav flag.
+            *
+            * @default false
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        hideHomepageLeftNav?: boolean;
         /**
             * If true, help and profile buttons will hide on NavBar. By default,
             * they are shown.
@@ -438,12 +472,24 @@ export interface AppViewConfig extends ViewConfig {
         /**
             * A URL path within the app that is to be embedded.
             * If both path and pageId attributes are defined, the path definition
-            * takes precedence.
+            * takes precedence. This is the path post the `#/` in the URL of the standalone
+            * ThoughtSpot app. Use this to open the embedded view to a specific path.
+            *
+            * For eg, if you want the component to open to a specific liveboard
+            * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
+            *
+            * @example
+            * ```
+            * <AppEmbed path="pinboard/1234/tab/7464" />
+            * ```
             */
         path?: string;
         /**
             * The application page to set as the start page
             * in the embedded view.
+            *
+            * Use this to open to particular page in the app. To open to a specific
+            * path within the app, use the `path` attribute which is more flexible.
             */
         pageId?: Page;
         /**
@@ -485,6 +531,13 @@ export interface AppViewConfig extends ViewConfig {
             * @hidden
             */
         dataPanelV2?: boolean;
+        /**
+            * Flag to control new Modular Home experience
+            *
+            * @default false
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        modularHomeExperience?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -493,6 +546,7 @@ export interface AppViewConfig extends ViewConfig {
     */
 export declare class AppEmbed extends V1Embed {
         protected viewConfig: AppViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
         /**
             * Constructs a map of parameters to be passed on to the
@@ -620,6 +674,10 @@ export interface LiveboardViewConfig extends ViewConfig {
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         hideTabPanel?: boolean;
+        /**
+            * The list of parameter override to apply to a Liveboard.
+            */
+        runtimeParameters?: RuntimeParameter[];
 }
 /**
     * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -638,6 +696,7 @@ export interface LiveboardViewConfig extends ViewConfig {
     */
 export declare class LiveboardEmbed extends V1Embed {
         protected viewConfig: LiveboardViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
         /**
             * Construct a map of params to be passed on to the
@@ -666,233 +725,6 @@ export declare class LiveboardEmbed extends V1Embed {
 export declare class PinboardEmbed extends LiveboardEmbed {
 }
 
-/**
-    * Copyright (c) 2022
-    *
-    * Base classes
-    *
-    * @summary Base classes
-    * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
-    */
-/**
-    * Global prefix for all Thoughtspot postHash Params.
-    */
-export declare const THOUGHTSPOT_PARAM_PREFIX = "ts-";
-/**
-    * Base class for embedding v2 experience
-    * Note: the v2 version of ThoughtSpot Blink is built on the new stack:
-    * React+GraphQL
-    */
-export declare class TsEmbed {
-        protected isAppInitialized: boolean;
-        /**
-            * A reference to the iframe within which the ThoughtSpot app
-            * will be rendered.
-            */
-        protected iFrame: HTMLIFrameElement;
-        protected viewConfig: ViewConfig;
-        protected embedConfig: EmbedConfig;
-        /**
-            * The ThoughtSpot hostname or IP address
-            */
-        protected thoughtSpotHost: string;
-        protected thoughtSpotV2Base: string;
-        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(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): 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): Promise<any>;
-        protected insertIntoDOM(child: string | Node): void;
-        /**
-            * Sets the height of the iframe
-            *
-            * @param height The height in pixels
-            */
-        protected setIFrameHeight(height: number | string): 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
-            */
-        protected executeCallbacks(eventType: EmbedEvent, data: any, eventPort?: MessagePort | void): void;
-        /**
-            * Returns the ThoughtSpot hostname or IP address.
-            */
-        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
-            */
-        protected getCompatibleEventType(eventType: EmbedEvent): EmbedEvent;
-        /**
-            * 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.
-            */
-        protected getIframeCenter(): {
-                iframeCenter: number;
-                iframeScrolled: number;
-                iframeHeight: number;
-                viewPortHeight: number;
-                iframeVisibleViewPort: number;
-        };
-        /**
-            * Registers an event listener to trigger an alert when the ThoughtSpot app
-            * sends an event of a particular message type to the host application.
-            *
-            * @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;
-        /**
-            * Removes an event listener for a particular event type.
-            *
-            * @param messageType The message type
-            * @param callback The callback to remove
-            * @example
-            * ```js
-            * const errorHandler = (data) => { console.error(data); };
-            * tsEmbed.on(EmbedEvent.Error, errorHandler);
-            * tsEmbed.off(EmbedEvent.Error, errorHandler);
-            * ```
-            */
-        off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
-        /**
-            * 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>;
-        /**
-            * 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;
-        /**
-            * 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;
-        /**
-            * Prerenders a generic instance of the TS component.
-            * This means without the path but with the flags already applied.
-            * This is useful for prerendering the component in the background.
-            *
-            * @version SDK: 1.22.0
-            * @returns
-            */
-        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 declare class V1Embed extends TsEmbed {
-        protected viewConfig: ViewConfig;
-        constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
-        /**
-            * Render the app 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;
-}
-
 export type EmbedEventHandlers = {
     [key in keyof typeof EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
 };
@@ -920,7 +752,7 @@ export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewCon
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
 
 /**
     * Copyright (c) 2023
@@ -1097,8 +929,19 @@ export declare enum AuthType {
             */
         Basic = "Basic"
 }
-export type DOMSelector = string | HTMLElement;
-/**
+export declare enum HomeLeftNavItem {
+        QueryBuilder = "query-builder",
+        Home = "insights-home",
+        Liveboards = "liveboards",
+        Answers = "answers",
+        MonitorSubscription = "monitor-alerts",
+        SpotIQAnalysis = "spotiq-analysis",
+        Tutorials = "tutorials",
+        Documentation = "documentation",
+        Community = "community"
+}
+export type DOMSelector = string | HTMLElement;
+/**
     * inline customCSS within the {@link CustomisationsInterface}.
     * Use {@link CustomCssVariables} or css rules.
     */
@@ -1402,12 +1245,21 @@ export interface EmbedConfig {
         blockNonEmbedFullAppAccess?: boolean;
         /**
             * Host config incase embedded app is inside TS app itself
+            *
+            * @hidden
             */
         hostConfig?: {
                 hostUserGuid: string;
                 hostClusterId: string;
                 hostClusterName: string;
         };
+        /**
+            * Pendo API key to enable Pendo tracking to your own subscription, the key
+            * is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
+            *
+            * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
+            */
+        pendoTrackingKey?: string;
 }
 export interface LayoutConfig {
 }
@@ -1515,6 +1367,11 @@ export interface ViewConfig {
             * visualization, or Liveboard.
             */
         runtimeFilters?: RuntimeFilter[];
+        /**
+            * The list of parameter override to apply to a search answer,
+            * visualization, or Liveboard.
+            */
+        runtimeParameters?: RuntimeParameter[];
         /**
             * The locale/language to use for the embedded view.
             *
@@ -1621,6 +1478,19 @@ export interface ViewConfig {
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         hiddenTabs?: string[];
+        /**
+            * Hide the home page modules
+            * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+            *
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        hiddenHomepageModules?: HomepageModule[];
+        /**
+            * reordering the home page modules
+            * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
+            * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
+            */
+        reorderedHomepageModules?: HomepageModule[];
         /**
             * The list of tab IDs to show in the embedded.
             * Only this Tabs will be shown in their respective LBs.
@@ -1640,6 +1510,15 @@ export interface ViewConfig {
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         visibleTabs?: string[];
+        /**
+            * homepageLeftNavItems : show/hide Homeapage Left Nav Bar Items
+            * There are 8 home nav list items, we will send those item as list
+            * which we want to hide for TSE.
+            * eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
+            *
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        hiddenHomeLeftNavItems?: HomeLeftNavItem[];
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1751,6 +1630,35 @@ export declare enum RuntimeFilterOp {
             */
         IN = "IN"
 }
+/**
+    * Home page module that can be hide
+    */
+export declare enum HomepageModule {
+        /**
+            * Search bar
+            */
+        Search = "SEARCH",
+        /**
+            * kPI watchlist module
+            */
+        Watchlist = "WATCHLIST",
+        /**
+            * favorite objects
+            */
+        Favorite = "FAVORITE",
+        /**
+            * List of answers and liveboards
+            */
+        MyLibrary = "MY_LIBRARY",
+        /**
+            * Trending list
+            */
+        Trending = "TRENDING",
+        /**
+            * Learning videos
+            */
+        Learning = "LEARNING"
+}
 /**
     * A filter that can be applied to ThoughtSpot answers, Liveboards, or
     * visualizations at runtime.
@@ -1771,6 +1679,20 @@ export interface RuntimeFilter {
             */
         values: (number | boolean | string)[];
 }
+/**
+    * A filter that can be applied to ThoughtSpot answers, Liveboards, or
+    * visualizations at runtime.
+    */
+export interface RuntimeParameter {
+        /**
+            * The name of the runtime parameter to filter on (case-sensitive)
+            */
+        name: string;
+        /**
+            * Values
+            */
+        value: number | boolean | string;
+}
 /**
     * Event types emitted by the embedded ThoughtSpot application.
     *
@@ -2195,23 +2117,74 @@ export declare enum EmbedEvent {
             */
         InsertIntoSlide = "insertInToSlide",
         /**
+            * @hidden
             * Emitted when a user changes any filter on a Liveboard.
-            *
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         FilterChanged = "filterChanged",
         /**
             *  Emitted when a user click on Go button in Sage Embed
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageEmbedQuery = "sageEmbedQuery",
         /**
             * Emitten when a user select data source in Sage Embed
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
-        SageWorksheetUpdated = "sageWorksheetUpdated"
+        SageWorksheetUpdated = "sageWorksheetUpdated",
+        /**
+            * Emitten when a user updates a connection in Data tab
+            *
+            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        UpdateConnection = "updateConnection",
+        /**
+            * Emitted when name, status (private or public) or filter values of a
+            * PersonalisedView is updated.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        UpdatePersonalisedView = "updatePersonalisedView",
+        /**
+            * Emitted when a PersonalisedView is saved.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        SavePersonalisedView = "savePersonalisedView",
+        /**
+            * Emitted when a Liveboard is reset.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        ResetLiveboard = "resetLiveboard",
+        /**
+            * Emitted when a PersonalisedView is deleted.
+            *
+            * @returns views: string[]
+            * @returns liveboardId: string
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        DeletePersonalisedView = "deletePersonalisedView",
+        /**
+            * Emitten when a user creates a new worksheet
+            *
+            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        CreateWorksheet = "createWorksheet"
 }
 /**
     * Event types that can be triggered by the host application
@@ -2854,16 +2827,16 @@ export declare enum HostEvent {
             */
         ResetSearch = "resetSearch",
         /**
+            * @hidden
             * Gets the currents visible and runtime filters applied on a Liveboard
-            *
             * @example
             * liveboardEmbed.trigger(HostEvent.GetFilters)
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         GetFilters = "getFilters",
         /**
+            * @hidden
             * Updates the visible filters on the Liveboard.
-            *
             * @param - filter: filter object containing column name and filter operation and values
             * @example
             *
@@ -3014,7 +2987,10 @@ export declare enum Param {
         HideTabPanel = "hideTabPanel",
         HideSampleQuestions = "hideSampleQuestions",
         WorksheetId = "worksheet",
-        Query = "query"
+        Query = "query",
+        HideHomepageLeftNav = "hideHomepageLeftNav",
+        ModularHomeExperienceEnabled = "modularHomeExperience",
+        PendoTrackingKey = "additionalPendoKey"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -3517,7 +3493,7 @@ export declare enum Action {
             * disabledActions: [Action.QueryDetailsButtons]
             * ```
             */
-        QueryDetailsButtons = "QueryDetailsButtons",
+        QueryDetailsButtons = "queryDetailsButtons",
         /**
             * The **Delete** action for Answers.
             *
@@ -3821,19 +3797,36 @@ export declare enum Action {
         /**
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
-        ModifySageAnswer = "modifySageAnswer"
-}
-export interface SessionInterface {
-        sessionId: string;
-        genNo: number;
-        acSession: {
-                sessionId: string;
-                genNo: number;
-        };
-}
-export declare enum OperationType {
-        GetChartWithData = "GetChartWithData",
-        GetTableWithHeadlineData = "GetTableWithHeadlineData"
+        ModifySageAnswer = "modifySageAnswer",
+        /**
+            * The **Move to Tab** menu action on visualizations in liveboard edit mode.
+            * Allows moving a visualization to a different tab.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.MoveToTab]
+            * ```
+            */
+        MoveToTab = "onContainerMove",
+        /**
+            * The **Manage Alertsb** menu action on KPI visualizations.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.ManageMonitor]
+            * ```
+            */
+        ManageMonitor = "ManageMonitor",
+        /**
+            * Action ID for Liveboard Personalised Views dropdown
+            *
+            *  @example
+            * ```js
+            * disabledActions: [Action.PersonalisedViewsDropdown]
+            * ```
+            *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        PersonalisedViewsDropdown = "personalisedViewsDropdown"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -3851,6 +3844,269 @@ export declare enum ContextMenuTriggerOptions {
         LEFT_CLICK = "left-click",
         RIGHT_CLICK = "right-click"
 }
+export interface ColumnValue {
+        column: {
+                id: string;
+                name: string;
+                dataType: string;
+                [key: string]: any;
+        };
+        value: string | number | boolean;
+}
+export interface VizPoint {
+        selectedAttributes: ColumnValue[];
+        selectedMeasures: ColumnValue[];
+}
+export interface CustomActionPayload {
+        contextMenuPoints?: {
+                clickedPoint: VizPoint;
+                selectedPoints: VizPoint[];
+        };
+        embedAnswerData: {
+                name: string;
+                id: string;
+                sources: {
+                        header: {
+                                guid: string;
+                        };
+                };
+                columns: any[];
+                data: any[];
+                [key: string]: any;
+        };
+        session: SessionInterface;
+        vizId?: string;
+}
+
+/**
+    * Copyright (c) 2022
+    *
+    * Base classes
+    *
+    * @summary Base classes
+    * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+    */
+/**
+    * Global prefix for all Thoughtspot postHash Params.
+    */
+export declare const THOUGHTSPOT_PARAM_PREFIX = "ts-";
+/**
+    * Base class for embedding v2 experience
+    * Note: the v2 version of ThoughtSpot Blink is built on the new stack:
+    * React+GraphQL
+    */
+export declare class TsEmbed {
+        protected isAppInitialized: boolean;
+        /**
+            * A reference to the iframe within which the ThoughtSpot app
+            * will be rendered.
+            */
+        protected iFrame: HTMLIFrameElement;
+        protected viewConfig: ViewConfig;
+        protected embedConfig: EmbedConfig;
+        /**
+            * The ThoughtSpot hostname or IP address
+            */
+        protected thoughtSpotHost: string;
+        protected thoughtSpotV2Base: string;
+        protected embedComponentType: string;
+        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(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): 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): Promise<any>;
+        protected insertIntoDOM(child: string | Node): void;
+        /**
+            * Sets the height of the iframe
+            *
+            * @param height The height in pixels
+            */
+        protected setIFrameHeight(height: number | string): 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
+            */
+        protected executeCallbacks(eventType: EmbedEvent, data: any, eventPort?: MessagePort | void): void;
+        /**
+            * Returns the ThoughtSpot hostname or IP address.
+            */
+        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
+            */
+        protected getCompatibleEventType(eventType: EmbedEvent): EmbedEvent;
+        /**
+            * 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.
+            */
+        protected getIframeCenter(): {
+                iframeCenter: number;
+                iframeScrolled: number;
+                iframeHeight: number;
+                viewPortHeight: number;
+                iframeVisibleViewPort: number;
+        };
+        /**
+            * Registers an event listener to trigger an alert when the ThoughtSpot app
+            * sends an event of a particular message type to the host application.
+            *
+            * @param messageType The message type
+            * @param callback A callback as a function
+            * @param options The message options
+            * @param isSelf
+            * @param isRegisteredBySDK
+            * @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, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
+        /**
+            * Removes an event listener for a particular event type.
+            *
+            * @param messageType The message type
+            * @param callback The callback to remove
+            * @example
+            * ```js
+            * const errorHandler = (data) => { console.error(data); };
+            * tsEmbed.on(EmbedEvent.Error, errorHandler);
+            * tsEmbed.off(EmbedEvent.Error, errorHandler);
+            * ```
+            */
+        off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
+        /**
+            * 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>;
+        /**
+            * 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;
+        /**
+            * 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;
+        /**
+            * Prerenders a generic instance of the TS component.
+            * This means without the path but with the flags already applied.
+            * This is useful for prerendering the component in the background.
+            *
+            * @version SDK: 1.22.0
+            * @returns
+            */
+        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 declare class V1Embed extends TsEmbed {
+        protected viewConfig: ViewConfig;
+        constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
+        /**
+            * Render the app 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;
+}
 
 export interface executeTMLInput {
         metadata_tmls: string[];
@@ -3940,14 +4196,19 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
 export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
 /**
     * Imports TML representation of the metadata objects into ThoughtSpot.
+    *
     * @param data
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    * @group Global methods
     */
 export declare const executeTML: (data: executeTMLInput) => Promise<any>;
 /**
-    * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format.
+    * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
+    * format.
+    *
     * @param data
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    * @group Global methods
     */
 export declare const exportTML: (data: exportTMLInput) => Promise<any>;
 /**
@@ -4159,6 +4420,12 @@ export interface CustomCssVariables {
             * Text transformation specification for UI elements in the app.
             */
         '--ts-var-root-text-transform'?: string;
+        /**
+            * application color, it replaces #2770EF which is rd-color(blue,base) and
+            * its similar colors like rd-color(blue,60), rd-color(accent, base) and
+            * rd-color(text, accent) in the app.
+            */
+        '--ts-var-application-color'?: string;
         /**
             * Background color of the top navigation panel.
             */
@@ -4419,6 +4686,10 @@ export interface CustomCssVariables {
             * Background color for menu items on hover.
             */
         '--ts-var-menu--hover-background'?: string;
+        /**
+            * Text color for selected menu items.
+            */
+        '--ts-var-menu-selected-text-color'?: string;
         /**
             * Background color of the dialogs.
             */
@@ -4439,5 +4710,89 @@ export interface CustomCssVariables {
             * Background color of the footer area on dialogs.
             */
         '--ts-var-dialog-footer-background'?: string;
+        /**
+            * Background for selected state in list
+            */
+        '--ts-var-list-selected-background'?: string;
+        /**
+            * Background for hover state in list
+            */
+        '--ts-var-list-hover-background'?: string;
+        /**
+            * Background for hover state in segment control.
+            */
+        '--ts-var-segment-control-hover-background'?: string;
+        /**
+            * Text color for slected item in modular home's watchlist.
+            */
+        '--ts-var-home-watchlist-selected-text-color'?: string;
+        /**
+            * Text color for favorite carousel find your favorites card in modular home.
+            */
+        '--ts-var-home-favorite-suggestion-card-text-color'?: string;
+        /**
+            * Icon color for favorite carousel find your favorites card in modular home.
+            */
+        '--ts-var-home-favorite-suggestion-card-icon-color'?: string;
+        /**
+            * Background for favorite carousel find your favorites card in modular home.
+            */
+        '--ts-var-home-favorite-suggestion-card-background'?: string;
 }
 
+export interface SessionInterface {
+        sessionId: string;
+        genNo: number;
+        acSession: {
+                sessionId: string;
+                genNo: number;
+        };
+}
+export declare enum OperationType {
+        GetChartWithData = "GetChartWithData",
+        GetTableWithHeadlineData = "GetTableWithHeadlineData"
+}
+interface UnderlyingDataPoint {
+        columnId: string;
+        dataValue: any;
+}
+/**
+    * Class representing the answer service provided with the
+    * custom action payload. This service could be used to run
+    * graphql queries in the context of the answer on which the
+    * custom action was triggered.
+    *
+    * @example
+    * ```js
+    *  embed.on(EmbedEvent.CustomAction, e => {
+    *     const underlying = await e.answerService.getUnderlyingDataForPoint([
+    *       'col name 1'
+    *     ]);
+    *     const data = await underlying.fetchData(0, 100);
+    *  })
+    * ```
+    * @version
+    * ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
+    */
+export declare class AnswerService {
+        constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]);
+        getSourceDetail(): Promise<any>;
+        removeColumns(columnIds: string[]): Promise<any>;
+        addColumns(columnIds: string[]): Promise<any>;
+        fetchData(offset?: number, size?: number): Promise<{
+                columns: any;
+                data: any;
+        }>;
+        /**
+            *
+            * @param userLocale
+            * @param omitInfo Omit the download Info on top of the CSV
+            * @returns Response
+            */
+        fetchCSVBlob(userLocale?: string, omitInfo?: boolean): Promise<Response>;
+        getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
+        executeQuery(query: string, variables: any): Promise<any>;
+        getSession(): SessionInterface;
+}
+export {};
+