@thoughtspot/visual-embed-sdk 1.40.0 → 1.40.1-alpha.2

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

@@ -652,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
             */
@@ -804,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.
@@ -1141,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
@@ -2121,6 +2124,7 @@ export declare class LiveboardEmbed extends V1Embed {
             * embedded Liveboard or visualization.
             */
         protected getEmbedParams(): string;
+        protected getEmbedParamsObject(): any;
         protected beforePrerenderVisible(): void;
         protected handleRenderForPrerender(): Promise<TsEmbed>;
         /**
@@ -2141,7 +2145,8 @@ export declare class LiveboardEmbed extends V1Embed {
             * visualization ID and the runtime filters.
             */
         render(): Promise<LiveboardEmbed>;
-        navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
+        currentLiveboardId: string;
+        navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, onNavigateCalled?: () => void): void;
         /**
             * Returns the full url of the Liveboard/visualization which can be used to open
             * this Liveboard inside the full ThoughtSpot application in a new tab.
@@ -2184,6 +2189,7 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
 export declare class ConversationMessage extends TsEmbed {
         protected viewConfig: SpotterAgentMessageViewConfig;
         constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
+        protected getEmbedParamsObject(): Record<any, any>;
         getIframeSrc(): string;
         render(): Promise<ConversationMessage>;
 }
@@ -4544,7 +4550,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
+            * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
             *    console.log('Liveboard details', payload);
             * })
             *```
@@ -4919,58 +4925,58 @@ export declare enum EmbedEvent {
             */
         RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
         /**
-            * Emitted when Spotter response is text data
+            * 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
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
         SpotterData = "SpotterData",
         /**
-            * Emitted when user opens up the worksheet preview modal in Spotter embed.
+            * 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
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
         PreviewSpotterData = "PreviewSpotterData",
         /**
-            * Emitted when the Spotter query is triggered in Spotter embed.
+            * 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
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
         SpotterQueryTriggered = "SpotterQueryTriggered",
         /**
-            * Emitted when the last Spotter query is edited in Spotter embed.
+            * 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
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
         LastPromptEdited = "LastPromptEdited",
         /**
-            * Emitted when the last Spotter query is deleted in Spotter embed.
+            * 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
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
         LastPromptDeleted = "LastPromptDeleted",
         /**
@@ -4981,7 +4987,7 @@ export declare enum EmbedEvent {
             *     console.log('payload', payload);
             * })
             *```
-            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
         ResetSpotterConversation = "ResetSpotterConversation",
         /**
@@ -4994,7 +5000,7 @@ export declare enum EmbedEvent {
             *```
             * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
-        SpotterInit = "spotterInit"
+        SpotterInit = "SpotterInit"
 }
 /**
     * Event types that can be triggered by the host application
@@ -5082,7 +5088,6 @@ 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) => {
@@ -5402,21 +5407,12 @@ 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",
@@ -5518,8 +5514,7 @@ 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.
-            *
+            * **Required** in Spotter embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5534,12 +5529,6 @@ export declare enum HostEvent {
             *     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",
@@ -5660,7 +5649,6 @@ 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:
@@ -5669,11 +5657,6 @@ 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
@@ -5702,7 +5685,6 @@ export declare enum HostEvent {
         /**
             * 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:
@@ -5725,7 +5707,6 @@ export declare enum HostEvent {
         /**
             * 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:
@@ -5761,7 +5742,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.
+            * @param - `vizId` is required in Spotter Embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Save)
@@ -6071,7 +6052,6 @@ 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);
@@ -6115,7 +6095,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, {
@@ -6123,14 +6103,6 @@ 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",
@@ -6162,7 +6134,7 @@ export declare enum HostEvent {
         /**
             * 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 - `queryString`: Text string in Natural Language format
             * @param - `executeSearch`: Boolean to execute search and update search query
             * @example
             * ```js
@@ -6171,7 +6143,6 @@ export declare enum HostEvent {
             *  executeSearch: true,
             * })
             * ```
-            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
         SpotterSearch = "SpotterSearch",
         /**
@@ -6181,7 +6152,6 @@ export declare enum HostEvent {
             * ```js
             * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
             * ```
-            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
         EditLastPrompt = "EditLastPrompt",
         /**
@@ -6190,7 +6160,6 @@ export declare enum HostEvent {
             * ```js
             * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
             * ```
-            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
         PreviewSpotterData = "PreviewSpotterData",
         /**
@@ -6199,7 +6168,6 @@ export declare enum HostEvent {
             * ```js
             * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
             * ```
-            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
         ResetSpotterConversation = "ResetSpotterConversation",
         /**
@@ -6208,19 +6176,17 @@ export declare enum HostEvent {
             * ```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.
+            * @param - `vizId ` In Spotter Embed, vizId is required.
             * @example
             * ```js
             * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
-            *          vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
+            *          vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
             * });
             *```
-            * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
         AnswerChartSwitcher = "answerChartSwitcher",
         /**
@@ -6247,16 +6213,25 @@ export declare enum HostEvent {
             */
         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.
+            * Trigger the *Ask Sage* action for visualizations
             * @example
             * ```js
-            * spotterEmbed.trigger(HostEvent.AskSpotter,
-            * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+            * liveboardEmbed.trigger(HostEvent.AskSpotter,
+            * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
             * ```
             * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
-        AskSpotter = "AskSpotter"
+        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
@@ -7932,6 +7907,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>;
 }
@@ -8027,20 +8003,25 @@ export declare class TsEmbed {
         protected isRendered: boolean;
         protected hostEventClient: HostEventClient;
         protected isReadyForRenderPromise: Promise<void>;
+        id: 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;
+        isEmbedContainerLoaded: boolean;
         protected getAuthTokenForCookielessInit(): Promise<string>;
         protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
         protected getAppInitData(): Promise<DefaultAppInitData>;
+        protected getPreRenderObj<T extends TsEmbed>(): T;
+        protected triggerAfterLoad(eventType: HostEvent, data: TriggerPayload<any, HostEvent>, onEventTriggered?: () => void): void;
         /**
             * Constructs the base URL string to load the ThoughtSpot app.
             * @param query
             */
         protected getEmbedBasePath(query: string): string;
+        protected getUpdateEmbedParamsObject(): Record<any, any>;
         /**
             * Common query params set for all the embed modes.
             * @param queryParams
@@ -8056,6 +8037,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;