@thoughtspot/visual-embed-sdk 1.40.1-alpha.1 → 1.41.0-pre-render-1

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

@@ -354,6 +354,8 @@ export function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
                 query: string;
                 message: {
                         worksheetId: string;
+                        convId: any;
+                        messageId: any;
                         sessionId: any;
                         genNo: any;
                         acSessionId: any;
@@ -650,6 +652,7 @@ export declare class SearchBarEmbed extends TsEmbed {
         protected viewConfig: SearchBarViewConfig;
         protected embedComponentType: string;
         constructor(domSelector: string, viewConfig: SearchBarViewConfig);
+        protected getEmbedParamsObject(): Record<any, any>;
         /**
             * Render the embedded ThoughtSpot search
             */
@@ -802,6 +805,7 @@ export declare class SageEmbed extends V1Embed {
             */
         protected viewConfig: SageViewConfig;
         constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
+        protected getEmbedParamsObject(): Record<any, any>;
         /**
             * Constructs a map of parameters to be passed on to the
             * embedded Eureka or Sage search page.
@@ -1139,6 +1143,7 @@ export declare class SearchEmbed extends TsEmbed {
                 };
         };
         protected getAppInitData(): Promise<SearchAppInitData>;
+        protected getEmbedParamsObject(): Record<any, any>;
         protected getEmbedParams(): string;
         /**
             * Construct the URL of the embedded ThoughtSpot search to be
@@ -2119,6 +2124,17 @@ export declare class LiveboardEmbed extends V1Embed {
             * embedded Liveboard or visualization.
             */
         protected getEmbedParams(): string;
+        protected getEmbedParamsObject(): any;
+        /**
+            * @hidden
+            * Internal state to track the current liveboard id.
+            * This is used to navigate to the correct liveboard when the prerender is visible.
+            */
+        currentLiveboardState: {
+                liveboardId: string;
+                vizId: string;
+                activeTabId: string;
+        };
         protected beforePrerenderVisible(): void;
         protected handleRenderForPrerender(): Promise<TsEmbed>;
         /**
@@ -2176,10 +2192,13 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
         genNo: number;
         acSessionId: string;
         acGenNo: number;
+        convId: string;
+        messageId: string;
 }
 export declare class ConversationMessage extends TsEmbed {
         protected viewConfig: SpotterAgentMessageViewConfig;
         constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
+        protected getEmbedParamsObject(): Record<any, any>;
         getIframeSrc(): string;
         render(): Promise<ConversationMessage>;
 }
@@ -2223,6 +2242,8 @@ export declare class SpotterAgentEmbed {
                 data?: undefined;
         } | {
                 data: {
+                        convId: any;
+                        messageId: any;
                         sessionId: any;
                         genNo: any;
                         acSessionId: any;
@@ -3262,12 +3283,14 @@ export interface HomePageConfig {
             * Hide list page columns
             * For example: hiddenListColumns = [ListPageColumns.Author]
             *
-            * **Note**: This option is available only in full app embedding.
+            * **Note**: This option is available only in full app embedding. To use it, you need to import `ListPageColumns` enum.
             *
             * Supported embed types: `AppEmbed`
             * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
             * @example
             * ```js
+            * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
+            *
             * const embed = new AppEmbed('#tsEmbed', {
             *    ... //other embed view config
             *    hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
@@ -3282,11 +3305,14 @@ export interface HomePageConfig {
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
             * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+            * To use it, you need to import `HomepageModule` enum.
             *
             * Supported embed types: `AppEmbed`
             * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
             * @example
             * ```js
+            * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
+            *
             * const embed = new AppEmbed('#tsEmbed', {
             *    ... //other embed view config
             *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
@@ -3301,11 +3327,14 @@ export interface HomePageConfig {
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
             * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+            * To use it, you need to import `HomepageModule` enum.
             *
             * Supported embed types: `AppEmbed`
             * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
             * @example
             * ```js
+            * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
+            *
             * const embed = new AppEmbed('#tsEmbed', {
             *    ... //other embed view config
             *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
@@ -3321,6 +3350,8 @@ export interface HomePageConfig {
             * Supported embed types: `AppEmbed`
             * @example
             * ```js
+            * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
+            *
             * const embed = new AppEmbed('#tsEmbed', {
             *    ... //other embed view config
             *    hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
@@ -3330,6 +3361,7 @@ export interface HomePageConfig {
             * **Note**: This option does not apply to the classic homepage.
             * To access the updated modular homepage, set
             * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+            * To use it, you need to import `HomeLeftNavItem` enum.
             * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -4538,7 +4570,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
+            * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
             *    console.log('Liveboard details', payload);
             * })
             *```
@@ -4911,7 +4943,96 @@ export declare enum EmbedEvent {
             * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
             * @hidden
             */
-        RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates"
+        RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
+        /**
+            * Emitted when Spotter response is text data
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        SpotterData = "SpotterData",
+        /**
+            * Emitted when user opens up the worksheet preview modal in Spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        PreviewSpotterData = "PreviewSpotterData",
+        /**
+            * Emitted when the Spotter query is triggered in Spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        SpotterQueryTriggered = "SpotterQueryTriggered",
+        /**
+            * Emitted when the last Spotter query is edited in Spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        LastPromptEdited = "LastPromptEdited",
+        /**
+            * Emitted when the last Spotter query is deleted in Spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        LastPromptDeleted = "LastPromptDeleted",
+        /**
+            * Emitted when the coversation is reset in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        ResetSpotterConversation = "ResetSpotterConversation",
+        /**
+            * Emitted when the *Spotter* is initialized.
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        SpotterInit = "spotterInit",
+        /**
+            * @hidden
+            * Triggers when the embed listener is ready to receive events.
+            * This is used to trigger events after the embed container is loaded.
+            * @example
+            * ```js
+            * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
+            *     console.log('EmbedListenerReady');
+            * })
+            * ```
+            */
+        EmbedListenerReady = "EmbedListenerReady"
 }
 /**
     * Event types that can be triggered by the host application
@@ -4929,7 +5050,7 @@ export declare enum EmbedEvent {
     * // create the liveboard embed.
     *
     * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
-    *   { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
+    *   { columnName: 'state', operator: RuntimeFilterOp.EQ, values: ["california"]}
     * ]);
     * ```
     * @example
@@ -4999,6 +5120,7 @@ export declare enum HostEvent {
             * done automatically on the most popular column.
             * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
             * in case of a Liveboard.
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -5137,12 +5259,12 @@ export declare enum HostEvent {
             * Works with Search and Liveboard embed.
             * @param - { columnId: string,
             *  name: string,
-            *  type: INT64/CHAR/DATE,
-            *  dataType: ATTRIBUTE/MEASURE }
+            *  type: ATTRIBUTE/MEASURE,
+            *  dataType: INT64/CHAR/DATE }
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.OpenFilter,
-            *  {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
+            *  {column: { columnId: '<column-GUID>', name: 'column name', type: 'ATTRIBUTE', dataType: 'INT64'}})
             * ```
             * @example
             * ```js
@@ -5200,6 +5322,7 @@ export declare enum HostEvent {
             * @param
             * `vizId`-  GUID of the saved Answer or visualization to pin to a Liveboard.
             *  Optional when pinning a new chart or table generated from a Search query.
+            *  **Required** in Spotter Embed.
             * @param
             * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,
             *  specify the `newLiveboardName` parameter to create a new Liveboard.
@@ -5247,6 +5370,12 @@ export declare enum HostEvent {
             * ```js
             * appEmbed.trigger(HostEvent.Pin)
             * ```
+            * @example
+            * ```js
+            * const pinResponse = await spotterEmbed.trigger(HostEvent.Pin, {
+            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+            *  });
+            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         Pin = "pin",
@@ -5311,12 +5440,21 @@ export declare enum HostEvent {
             * Trigger the **Download PDF** action on an embedded Liveboard,
             * visualization or Answer.
             *
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+            *
             * **NOTE**: The **Download** > **PDF** action is available on
             * visualizations and Answers if the data is in tabular format.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
             * ```
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
+            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+            *  });
+            * ```
+            *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         DownloadAsPdf = "downloadAsPdf",
@@ -5340,6 +5478,12 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.MakeACopy)
             * ```
+            * @example
+            * ```js
+            * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
+            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+            *  });
+            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         MakeACopy = "makeACopy",
@@ -5412,6 +5556,8 @@ export declare enum HostEvent {
             * This event is not supported in visualization embed and search embed.
             * @param - object - To trigger the action for a specific visualization
             * in Liveboard embed, pass in `vizId` as a key.
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5420,6 +5566,18 @@ export declare enum HostEvent {
             * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
             * '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
+            * @example
+            * ```js
+            * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {
+            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+            *  });
+            * ```
+            * @example
+            * ```js
+            * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
+            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+            *  });
+            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         Edit = "edit",
@@ -5467,6 +5625,16 @@ export declare enum HostEvent {
             *   );
             * })
             * ```
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.GetTML, {
+            *   vizId: '730496d6-6903-4601-937e-2c691821af3c'
+            * }).then((tml) => {
+            *   console.log(
+            *      tml.answer.search_query // TML representation of the search query
+            *   );
+            * })
+            * ```
             * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
             * @important
             */
@@ -5530,6 +5698,7 @@ export declare enum HostEvent {
         /**
             * Trigger the **Download** action on charts in
             * the embedded view.
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -5538,6 +5707,11 @@ export declare enum HostEvent {
             * ```js
             * embed.trigger(HostEvent.Download)
             * ```
+            * ```js
+            * spotterEmbed.trigger(HostEvent.Download, {
+            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+            *  });
+            * ```
             * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
             * Use {@link DownloadAsPng}
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -5554,13 +5728,19 @@ export declare enum HostEvent {
             * vizEmbed.trigger(HostEvent.DownloadAsPng)
             *
             * searchEmbed.trigger(HostEvent.DownloadAsPng)
+            *
+            * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
+            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+            * })
             * ```
+            *
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
             */
         DownloadAsPng = "downloadAsPng",
         /**
             * Trigger the **Download** > **CSV**  action on tables in
             * the embedded view.
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -5572,12 +5752,18 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.DownloadAsCsv)
             * ```
+            * ```js
+            * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
+            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+            * })
+            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         DownloadAsCsv = "downloadAsCSV",
         /**
             * Trigger the **Download** > **XLSX**  action on tables
             * in the embedded view.
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -5589,6 +5775,11 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
             * ```
+            * ```js
+            * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
+            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+            * })
+            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         DownloadAsXlsx = "downloadAsXLSX",
@@ -5608,6 +5799,7 @@ export declare enum HostEvent {
         /**
             * Trigger the **Save**  action on a Liveboard or Answer.
             * Saves the changes.
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Save)
@@ -5615,6 +5807,11 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.Save)
             * ```
+            * ```js
+            * spotterEmbed.trigger(HostEvent.Save, {
+            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+            * })
+            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         Save = "save",
@@ -5898,7 +6095,7 @@ export declare enum HostEvent {
         ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
         /**
             * Triggers an action to update Parameter values on embedded
-            * Answers and Liveboard.
+            * Answers, Liveboard and Spotter answer in Edit mode.
             *
             * @example
             * ```js
@@ -5912,11 +6109,19 @@ export declare enum HostEvent {
         UpdateParameters = "UpdateParameters",
         /**
             * Triggers GetParameters to fetch the runtime Parameters.
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
             * ```js
             * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
             *  console.log('parameters', parameter);
             * });
             *```
+            *```js
+            * spotterEmbed.trigger(HostEvent.GetParameters, {
+            *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
+            * }).then((parameter) => {
+            *  console.log('parameters', parameter);
+            * });
+            *```
             * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
             */
         GetParameters = "GetParameters",
@@ -5948,7 +6153,7 @@ export declare enum HostEvent {
             * @param - optional attributes to set Answer properties.
             *  `name` - Name string for the Answer.
             *  `description` - Description text for the Answer.
-            *
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
             * @example
             * ```js
             * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -5956,6 +6161,14 @@ export declare enum HostEvent {
             *      description: "Total sales by states in MidWest"
             *   });
             * ```
+            * @example
+            * ```js
+            * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
+            *      vizId: '730496d6-6903-4601-937e-2c691821af3c',
+            *      name: "Sales by states",
+            *      description: "Total sales by states in MidWest"
+            * });
+            * ```
             * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
             */
         SaveAnswer = "saveAnswer",
@@ -5984,6 +6197,70 @@ export declare enum HostEvent {
             * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
             */
         TransformTableVizData = "TransformTableVizData",
+        /**
+            * Triggers a search operation with the search tokens specified in
+            * the search query string in spotter embed.
+            * @param - `query`: Text string in Natural Language format
+            * @param - `executeSearch`: Boolean to execute search and update search query
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.SpotterSearch, {
+            *  query: 'revenue per year',
+            *  executeSearch: true,
+            * })
+            * ```
+            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+            */
+        SpotterSearch = "SpotterSearch",
+        /**
+            * Edits the last prompt in spotter embed.
+            * @param - `query`: Text string
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
+            * ```
+            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+            */
+        EditLastPrompt = "EditLastPrompt",
+        /**
+            * Opens the Worksheet preview modal in Spotter Embed.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
+            * ```
+            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+            */
+        PreviewSpotterData = "PreviewSpotterData",
+        /**
+            * Resets the Spotter Embed Conversation.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
+            * ```
+            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+            */
+        ResetSpotterConversation = "ResetSpotterConversation",
+        /**
+            * Deletes the last prompt in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
+            * ```
+            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+            */
+        DeleteLastPrompt = "DeleteLastPrompt",
+        /**
+            * Toggle the visualization to chart or table view.
+            * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
+            *          vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
+            * });
+            *```
+            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+            */
+        AnswerChartSwitcher = "answerChartSwitcher",
         /**
             * @hidden
             * Trigger exit from presentation mode when user exits fullscreen.
@@ -6006,7 +6283,28 @@ export declare enum HostEvent {
             *
             * @hidden
             */
-        VisibleEmbedCoordinates = "visibleEmbedCoordinates"
+        VisibleEmbedCoordinates = "visibleEmbedCoordinates",
+        /**
+            * Trigger the *Ask Spotter* action for visualizations
+            * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.AskSpotter,
+            * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+            * ```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        AskSpotter = "AskSpotter",
+        /**
+            * @hidden
+            * Triggers the update of the embed params.
+            *
+            * @example
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
+            * ```
+            */
+        UpdateEmbedParams = "updateEmbedParams"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -6294,27 +6592,27 @@ export declare enum Action {
             */
         ConfigureFilter = "configureFilter",
         /**
-         * The **Collapse data sources** icon on the Search page.
-         * Collapses the panel showing data sources.
-         *
-         * @example
-         * ```js
-         * disabledActions: [Action.CollapseDataPanel]
-         * ```
-         * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
-         */
+            * The **Collapse data sources** icon on the Search page.
+            * Collapses the panel showing data sources.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.CollapseDataPanel]
+            * ```
+            * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
+            */
         CollapseDataSources = "collapseDataSources",
         /**
-         * The **Collapse data panel** icon on the Search page.
-         * Collapses the data panel view.
-         *
-         * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
-         *
-         * @example
-         * ```js
-         * disabledActions: [Action.CollapseDataPanel]
-         * ```
-         */
+            * The **Collapse data panel** icon on the Search page.
+            * Collapses the data panel view.
+            *
+            * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.CollapseDataPanel]
+            * ```
+            */
         CollapseDataPanel = "collapseDataPanel",
         /**
             * The **Choose sources** button on Search page.
@@ -7010,6 +7308,17 @@ export declare enum Action {
             * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
             */
         EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
+        /**
+            * Action ID to hide or disable Iterative Change Analysis option
+            * on contextual change analysis  Inisght charts context menu
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.EnableIterativeChangeAnalysis]
+            * ```
+            * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
+            */
+        EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis",
         /**
             * Action ID to hide or disable Natural Language Search query.
             *
@@ -7378,7 +7687,40 @@ export declare enum Action {
             * ```
             *  @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
             */
-        InConversationTraining = "InConversationTraining"
+        InConversationTraining = "InConversationTraining",
+        /**
+            * Action ID to hide the warnings banner in
+            * Spotter results. It's an EA feature and
+            * handled by LD.
+            *  @example
+            * ```js
+            * hiddenAction: [Action.SpotterWarningsBanner]
+            * ```
+            *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
+            */
+        SpotterWarningsBanner = "SpotterWarningsBanner",
+        /**
+            * Action ID to hide the warnings border on the knowledge
+            * card in Spotter results. It's an EA feature and
+            * handled by LD.
+            *  @example
+            * ```js
+            * hiddenAction: [Action.SpotterWarningsOnTokens]
+            * ```
+            *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
+            */
+        SpotterWarningsOnTokens = "SpotterWarningsOnTokens",
+        /**
+            * Action ID to disable the click event handler on knowledge
+            * card in Spotter results. It's an EA feature and
+            * handled by LD.
+            *  @example
+            * ```js
+            * hiddenAction: [Action.SpotterTokenQuickEdit]
+            * ```
+            *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
+            */
+        SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -7572,7 +7914,8 @@ export interface SearchOptions {
     */
 export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
         /**
-            * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
+            * The ID of the data source object. For example, Model, View, or Table. Spotter uses
+            * this object to query data and generate Answers.
             */
         worksheetId: string;
         /**
@@ -7655,6 +7998,66 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
             * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
             */
         hideSampleQuestions?: boolean;
+        /**
+            * The list of runtime filters to apply to a search Answer,
+            * visualization, or Liveboard.
+            *
+            * Supported embed types: `SpotterEmbed`
+            * @example
+            * ```js
+            * const embed = new SpotterEmbed('#tsEmbed', {
+            *    // other embed view config
+            *    runtimeFilters: [
+            *           {
+            *             columnName: 'color',
+            *             operator: RuntimeFilterOp.EQ,
+            *             values: ['red'],
+            *           },
+            *       ],
+            * })
+            * ```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+            */
+        runtimeFilters?: RuntimeFilter[];
+        /**
+            * Flag to control whether runtime filters should be included in the URL.
+            * If true, filters will be passed via app initialization payload instead.
+            * If false/undefined, filters will be added to URL (default behavior).
+            *
+            * Supported embed types: `SpotterEmbed`
+            * @default false
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+            */
+        excludeRuntimeFiltersfromURL?: boolean;
+        /**
+            * The list of runtime parameters to apply to the conversation.
+            *
+            * Supported embed types: `SpotterEmbed`
+            * @example
+            * ```js
+            * const embed = new SpotterEmbed('#tsEmbed', {
+            *    // other embed view config
+            *    runtimeParameters: [
+            *           {
+            *             name: 'Integer Param',
+            *             value: 10,
+            *           },
+            *       ],
+            * })
+            * ```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+            */
+        runtimeParameters?: RuntimeParameter[];
+        /**
+            * Flag to control whether runtime parameters should be included in the URL.
+            * If true, parameters will be passed via app initialization payload instead.
+            * If false/undefined, parameters will be added to URL (default behavior).
+            *
+            * Supported embed types: `SpotterEmbed`
+            * @default false
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+            */
+        excludeRuntimeParametersfromURL?: boolean;
 }
 /**
     * The configuration for the embedded spotterEmbed options.
@@ -7682,6 +8085,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
 export declare class SpotterEmbed extends TsEmbed {
         protected viewConfig: SpotterEmbedViewConfig;
         constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
+        protected getEmbedParamsObject(): Record<any, any>;
         getIframeSrc(): string;
         render(): Promise<SpotterEmbed>;
 }
@@ -7791,6 +8195,7 @@ export declare class TsEmbed {
             * @param query
             */
         protected getEmbedBasePath(query: string): string;
+        protected getUpdateEmbedParamsObject(): Record<any, any>;
         /**
             * Common query params set for all the embed modes.
             * @param queryParams
@@ -7806,6 +8211,7 @@ export declare class TsEmbed {
             */
         protected getV1EmbedBasePath(queryString: string): string;
         protected getEmbedParams(): string;
+        protected getEmbedParamsObject(): Record<any, any>;
         protected getRootIframeSrc(): string;
         protected createIframeEl(frameSrc: string): HTMLIFrameElement;
         protected handleInsertionIntoDOM(child: string | Node): void;
@@ -7897,6 +8303,19 @@ export declare class TsEmbed {
             * ```
             */
         off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
+        /**
+         * @hidden
+         * Internal state to track if the embed container is loaded.
+         * This is used to trigger events after the embed container is loaded.
+         */
+        isEmbedContainerLoaded: boolean;
+        protected getPreRenderObj<T extends TsEmbed>(): T;
+        /**
+            * Executes a callback after the embed container is loaded.
+            * @param callback The callback to execute
+            */
+        protected executeAfterEmbedContainerLoaded(callback: () => void): void;
+        protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void;
         /**
             * Triggers an event to the embedded app
             * @param {HostEvent} messageType The event type
@@ -8498,6 +8917,322 @@ export interface CustomCssVariables {
             * Background color of checkbox.
             */
         '--ts-var-checkbox-background-color'?: string;
+        /**
+            * Height of the tiles in the Liveboard.
+            */
+        '--ts-var-viz-tile-height'?: string;
+        /**
+            * Background color of the layout in the Liveboard.
+            */
+        '--ts-var-liveboard-layout-background'?: string;
+        /**
+            * Font color of the title of the layout in the Liveboard.
+            */
+        '--ts-var-liveboard-layout-title-color'?: string;
+        /**
+            * Font size of the title of the layout in the Liveboard.
+            */
+        '--ts-var-liveboard-layout-title-fontsize'?: string;
+        /**
+            * Background color of the header in the Liveboard.
+            */
+        '--ts-var-liveboard-header-background'?: string;
+        /**
+            * Font size of the header in the Liveboard.
+            */
+        '--ts-var-liveboard-header-fontsize'?: string;
+        /**
+            * Font color of the header in the Liveboard.
+            */
+        '--ts-var-liveboard-header-font-color'?: string;
+        /**
+            * Border color of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-border-color'?: string;
+        /**
+            * Background color of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-background'?: string;
+        /**
+            * Border radius of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-border-radius'?: string;
+        /**
+            * Padding of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-padding'?: string;
+        /**
+            * Background color of the table header in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-table-header-background'?: string;
+        /**
+            * Padding of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-padding'?: string;
+        /**
+            * Padding of the title of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-title-padding'?: string;
+        /**
+            * Font size of the title of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-title-font-size'?: string;
+        /**
+            * Font weight of the title of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-title-font-weight'?: string;
+        /**
+            * Font size of the title of the tiles inside the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-tile-title-font-size'?: string;
+        /**
+            * Font weight of the title of the tiles inside the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-tile-title-font-weight'?: string;
+        /**
+            * Font size of the description of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-description-font-size'?: string;
+        /**
+            * Font weight of the description of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-description-font-weight'?: string;
+        /**
+            * Border of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-group-tile-border'?: string;
+        /**
+            * Padding of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-group-tile-padding'?: string;
+        /**
+            * Padding of the answer viz in the Liveboard.
+            */
+        '--ts-var-liveboard-answer-viz-padding'?: string;
+        /**
+            * Background color of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-background'?: string;
+        /**
+            * Border color of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-border-color'?: string;
+        /**
+            * Font color of the heading of the note title in the Liveboard.
+            */
+        '--ts-var-liveboard-notetitle-heading-font-color'?: string;
+        /**
+            * Font color of the body of the note title in the Liveboard.
+            */
+        '--ts-var-liveboard-notetitle-body-font-color'?: string;
+        /**
+            * Font color of the title of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-title-font-color'?: string;
+        /**
+            * Font color of the description of the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-description-font-color'?: string;
+        /**
+            * Font color of the title of the tiles inside the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-tile-title-font-color'?: string;
+        /**
+            * Background color of the tiles inside the groups in the Liveboard.
+            */
+        '--ts-var-liveboard-group-tile-background'?: string;
+        /**
+            * Background color of the chips in the Liveboard.
+            */
+        '--ts-var-liveboard-chip-background'?: string;
+        /**
+            * Font color of the chips in the Liveboard.
+            */
+        '--ts-var-liveboard-chip-color'?: string;
+        /**
+            * Background color of the chips in the Liveboard on hover.
+            */
+        '--ts-var-liveboard-chip--hover-background'?: string;
+        /**
+            * Font color of the chips in the Liveboard on hover.
+            */
+        '--ts-var-liveboard-chip--hover-color'?: string;
+        /**
+            * Background color of the chips in the Liveboard on active.
+            */
+        '--ts-var-liveboard-chip--active-background'?: string;
+        /**
+            * Font color of the chips in the Liveboard on active.
+            */
+        '--ts-var-liveboard-chip--active-color'?: string;
+        /**
+            * Width of the side panel in the Liveboard.
+            */
+        '--ts-var-side-panel-width'?: string;
+        /**
+            * Background color of the edit bar in the Liveboard.
+            */
+        '--ts-var-liveboard-edit-bar-background'?: string;
+        /**
+            * Breakpoint for the dual column layout in the Liveboard.
+            */
+        '--ts-var-liveboard-dual-column-breakpoint'?: string;
+        /**
+            * Breakpoint for the single column layout in the Liveboard.
+            */
+        '--ts-var-liveboard-single-column-breakpoint'?: string;
+        /**
+            * Background color of the cross filter layout in the Liveboard.
+            */
+        '--ts-var-liveboard-cross-filter-layout-background'?: string;
+        /**
+            * Border color of the active tab in the Liveboard.
+            */
+        '--ts-var-liveboard-tab-active-border-color'?: string;
+        /**
+            * Font color of the hover tab in the Liveboard.
+            */
+        '--ts-var-liveboard-tab-hover-color'?: string;
+        /**
+            * Font size of the title of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-title-fontsize'?: string;
+        /**
+            * Font weight of the title of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-title-fontweight'?: string;
+        /**
+            * Font weight of the description of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-description-font-weight'?: string;
+        /**
+            * Opacity of the description of the tiles in the Liveboard.
+            */
+        '--ts-var-liveboard-tile-description-opacity'?: string;
+        /**
+            * Background color of the parameter chips in the Liveboard.
+            */
+        '--ts-var-parameter-chip-background'?: string;
+        /**
+            * Font color of the parameter chips in the Liveboard.
+            */
+        '--ts-var-parameter-chip-text-color'?: string;
+        /**
+            * Background color of the parameter chips in the Liveboard on hover.
+            */
+        '--ts-var-parameter-chip-hover-background'?: string;
+        /**
+            * Font color of the parameter chips in the Liveboard on hover.
+            */
+        '--ts-var-parameter-chip-hover-text-color'?: string;
+        /**
+            * Background color of the parameter chips in the Liveboard on active.
+            */
+        '--ts-var-parameter-chip-active-background'?: string;
+        /**
+            * Font color of the parameter chips in the Liveboard on active.
+            */
+        '--ts-var-parameter-chip-active-text-color'?: string;
+        /**
+            * Background color of the action button in the Liveboard header.
+            */
+        '--ts-var-liveboard-header-action-button-background'?: string;
+        /**
+            * Font color of the action button in the Liveboard header.
+            */
+        '--ts-var-liveboard-header-action-button-font-color'?: string;
+        /**
+            * Font color of the action button in the Liveboard header on hover.
+            */
+        '--ts-var-liveboard-header-action-button-hover-color'?: string;
+        /**
+            * Font color of the action button in the Liveboard header on active.
+            */
+        '--ts-var-liveboard-header-action-button-active-color'?: string;
+        /**
+            * Background color of the badge in the Liveboard header.
+            */
+        '--ts-var-liveboard-header-badge-background'?: string;
+        /**
+            * Font color of the badge in the Liveboard header.
+            */
+        '--ts-var-liveboard-header-badge-font-color'?: string;
+        /**
+            * Background color of the modified badge in the Liveboard header.
+            */
+        '--ts-var-liveboard-header-badge-modified-background'?: string;
+        /**
+            * Font color of the modified badge in the Liveboard header.
+            */
+        '--ts-var-liveboard-header-badge-modified-font-color'?: string;
+        /**
+            * Font color of the badge in the Liveboard header on hover.
+            */
+        '--ts-var-liveboard-header-badge-hover-color'?: string;
+        /**
+            * Font color of the badge in the Liveboard header on active.
+            */
+        '--ts-var-liveboard-header-badge-active-color'?: string;
+        /**
+            * Font color of the hero text in the KPI widget.
+            */
+        '--ts-var-kpi-hero-color'?: string;
+        /**
+            * Font color of the comparison text in the KPI widget.
+            */
+        '--ts-var-kpi-comparison-color'?: string;
+        /**
+            * Font color of the analyze text in the KPI widget.
+            */
+        '--ts-var-kpi-analyze-text-color'?: string;
+        /**
+            * Font color of the legend title in the heatmap chart.
+            */
+        '--ts-var-chart-heatmap-legend-title-color'?: string;
+        /**
+            * Font color of the legend label in the heatmap chart.
+            */
+        '--ts-var-chart-heatmap-legend-label-color'?: string;
+        /**
+            * Font color of the legend title in the treemap chart.
+            */
+        '--ts-var-chart-treemap-legend-title-color'?: string;
+        /**
+            * Font color of the legend label in the treemap chart.
+            */
+        '--ts-var-chart-treemap-legend-label-color'?: string;
+        /**
+            * Color of the positive change in the KPI.
+            */
+        '--ts-var-kpi-positive-change-color'?: string;
+        /**
+            * Color of the negative change in the KPI.
+            */
+        '--ts-var-kpi-negative-change-color'?: string;
+        /**
+            * Background color of the change analysis insights.
+            */
+        '--ts-var-change-analysis-insights-background'?: string;
+        /**
+            * Background color of the forecasting card in the SpotIQ analyze.
+            */
+        '--ts-var-spotiq-analyze-forecasting-card-background'?: string;
+        /**
+            * Background color of the outlier card in the SpotIQ analyze.
+            */
+        '--ts-var-spotiq-analyze-outlier-card-background'?: string;
+        /**
+            * Background color of the trend card in the SpotIQ analyze.
+            */
+        '--ts-var-spotiq-analyze-trend-card-background'?: string;
+        /**
+            * Background color of the crosscorrelation card in the SpotIQ analyze.
+            */
+        '--ts-var-spotiq-analyze-crosscorrelation-card-background'?: string;
+        /**
+            * Background color of the summary header in the CCA modal.
+            */
+        '--ts-var-cca-modal-summary-header-background'?: string;
 }
 
 export interface SessionInterface {
@@ -9069,16 +9804,31 @@ export declare const getAnswerFromQuery: (query: string, worksheetId: string) =>
 }>;
 
 /**
-  * Create a liveboard with the given answers
-  * @param answers AnswerService[]
-  * @param name string
+  * Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances.
+  *
+  * Each answer will be added as a visualization to the newly created Liveboard.
+  *
+  * @param {AnswerService[]} answers - An array of initialized `AnswerService` instances
+  * representing the answers to be added to the Liveboard.
+  * @param {string} name - The name of the Liveboard to create.
   * @returns result Promise
   * @version SDK: 1.33.1 | ThoughtSpot: *
   * @example
   * ```js
-  *   const lb = createLiveboardWithAnswers([
-  *      new AnswerService(session, null, 'tshost'),
-  *   ], "my-liveboard");
+  * import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk";
+  *
+  * embed.on(EmbedEvent.Data, async () => {
+  *   try {
+  *     const answerService = await embed.getAnswerService();
+  *     const lb = await createLiveboardWithAnswers(
+  *       [answerService],
+  *       "My Liveboard"
+  *     );
+  *     console.log("Liveboard created:", lb);
+  *   } catch (err) {
+  *     console.error("Failed to create liveboard:", err);
+  *   }
+  * });
   * ```
   */
 export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;