@thoughtspot/visual-embed-sdk 1.39.2-spotter-agent → 1.39.3

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;
@@ -1245,6 +1247,21 @@ export declare enum HomePage {
             */
         Modular = "v2"
 }
+/**
+    * Define the version of the list page
+    * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
+    */
+export declare enum ListPage {
+        /**
+            * List (v2) is the traditional List Experience.
+            * It serves as the foundational version of the list page.
+            */
+        List = "v2",
+        /**
+            * ListWithUXChanges (v3) introduces the new updated list page with UX changes.
+            */
+        ListWithUXChanges = "v3"
+}
 /**
     * Define the discovery experience
     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
@@ -1258,6 +1275,10 @@ export interface DiscoveryExperience {
             * homePage determines the version of the home page.
             */
         homePage?: HomePage;
+        /**
+            * listPageVersion determines the version of the list page.
+            */
+        listPageVersion?: ListPage;
 }
 /**
     * The view configuration for full app embedding.
@@ -1629,21 +1650,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * ```
             */
         isUnifiedSearchExperienceEnabled?: boolean;
-        /**
-         * Show alert messages and toast messages in the embedded
-         * view in full app embed.
-         *
-         * Supported embed types: `AppEmbed`
-         * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-         * @example
-         * ```js
-         * const embed = new AppEmbed('#tsEmbed', {
-         *    ... // other embed view config
-         *    showAlerts:true,
-         * })
-         * ```
-         */
-        showAlerts?: boolean;
         /**
             * This flag is used to enable/disable the styling and grouping in a Liveboard
             *
@@ -2082,6 +2088,8 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
         genNo: number;
         acSessionId: string;
         acGenNo: number;
+        convId: string;
+        messageId: string;
 }
 export declare class ConversationMessage extends TsEmbed {
         protected viewConfig: SpotterAgentMessageViewConfig;
@@ -2129,6 +2137,8 @@ export declare class SpotterAgentEmbed {
                 data?: undefined;
         } | {
                 data: {
+                        convId: any;
+                        messageId: any;
                         sessionId: any;
                         genNo: any;
                         acSessionId: any;
@@ -2373,7 +2383,13 @@ export declare enum HomeLeftNavItem {
             * available when new navigation V3 is enabled.
             * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        Spotter = "spotter"
+        Spotter = "spotter",
+        /**
+            * Favorites option in the insights left navigation,
+            * available when new navigation V3 is enabled.
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        Favorites = "favorites"
 }
 export type DOMSelector = string | HTMLElement;
 /**
@@ -3139,6 +3155,20 @@ export interface BaseViewConfig {
             * @private
             */
         insertInToSlide?: boolean;
+        /**
+            * Show alert messages and toast messages in the embed.
+            * Supported embed in all embed types.
+            *
+            * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other embed view config
+            *    showAlerts:true,
+            * })
+            * ```
+            */
+        showAlerts?: boolean;
 }
 /**
     * The configuration object for Home page embeds configs.
@@ -4791,7 +4821,84 @@ export declare enum EmbedEvent {
             * Emitted when a user exits present mode.
             * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        ExitPresentMode = "exitPresentMode"
+        ExitPresentMode = "exitPresentMode",
+        /**
+            * Emitted when spotter response is text data
+            * @example
+            * ```js
+            * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            *```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.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.41.0 | ThoughtSpot: 10.12.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.41.0 | ThoughtSpot: 10.12.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.41.0 | ThoughtSpot: 10.12.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.41.0 | ThoughtSpot: 10.12.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.41.0 | ThoughtSpot: 10.12.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"
 }
 /**
     * Event types that can be triggered by the host application
@@ -5080,6 +5187,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.
@@ -5127,6 +5235,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",
@@ -5220,6 +5334,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",
@@ -5292,6 +5412,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.
+            * **Required** in Spotter embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5300,6 +5421,12 @@ 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'
+            *  });
+            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         Edit = "edit",
@@ -5347,6 +5474,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
             */
@@ -5434,7 +5571,12 @@ 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",
@@ -5452,6 +5594,11 @@ 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",
@@ -5469,6 +5616,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",
@@ -5488,6 +5640,7 @@ export declare enum HostEvent {
         /**
             * Trigger the **Save**  action on a Liveboard or Answer.
             * Saves the changes.
+            * @param - `vizId` is required in Spotter Embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Save)
@@ -5495,6 +5648,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",
@@ -5778,7 +5936,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
@@ -5797,6 +5955,13 @@ export declare enum HostEvent {
             *  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",
@@ -5864,6 +6029,64 @@ 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 - `queryString`: 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,
+            * })
+            * ```
+            */
+        SpotterSearch = "SpotterSearch",
+        /**
+            * Edits the last prompt in spotter embed.
+            * @param - `query`: Text string
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
+            * ```
+            */
+        EditLastPrompt = "EditLastPrompt",
+        /**
+            * Opens the Worksheet preview modal in Spotter Embed.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
+            * ```
+            */
+        PreviewSpotterData = "PreviewSpotterData",
+        /**
+            * Resets the Spotter Embed Conversation.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
+            * ```
+            */
+        ResetSpotterConversation = "ResetSpotterConversation",
+        /**
+            * Deletes the last prompt in spotter embed.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
+            * ```
+            */
+        DeleteLastPrompt = "DeleteLastPrompt",
+        /**
+            * Toggle the visualization to chart or table view.
+            * @param - `vizId ` In Spotter Embed, vizId is required.
+            * @example
+            * ```js
+            * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
+            *          vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
+            * });
+            *```
+            */
+        AnswerChartSwitcher = "answerChartSwitcher",
         /**
             * @hidden
             * Trigger exit from presentation mode when user exits fullscreen.
@@ -5873,7 +6096,17 @@ export declare enum HostEvent {
             *```
             * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
             */
-        ExitPresentMode = "exitPresentMode"
+        ExitPresentMode = "exitPresentMode",
+        /**
+            * Trigger the *Ask Sage* action for visualizations
+            * @example
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.AskSpotter,
+            * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
+            * ```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        AskSpotter = "askSpotter"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -5969,6 +6202,7 @@ export declare enum Param {
         Query = "query",
         HideHomepageLeftNav = "hideHomepageLeftNav",
         ModularHomeExperienceEnabled = "modularHomeExperience",
+        ListPageVersion = "listpageVersion",
         PendoTrackingKey = "additionalPendoKey",
         LiveboardHeaderSticky = "isLiveboardHeaderSticky",
         IsProductTour = "isProductTour",
@@ -7579,7 +7813,7 @@ export declare class ConversationEmbed extends SpotterEmbed {
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
 
 /**
     * Copyright (c) 2022