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

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

@@ -354,8 +354,6 @@ export function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
                 query: string;
                 message: {
                         worksheetId: string;
-                        convId: any;
-                        messageId: any;
                         sessionId: any;
                         genNo: any;
                         acSessionId: any;
@@ -2178,8 +2176,6 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
         genNo: number;
         acSessionId: string;
         acGenNo: number;
-        convId: string;
-        messageId: string;
 }
 export declare class ConversationMessage extends TsEmbed {
         protected viewConfig: SpotterAgentMessageViewConfig;
@@ -2227,8 +2223,6 @@ export declare class SpotterAgentEmbed {
                 data?: undefined;
         } | {
                 data: {
-                        convId: any;
-                        messageId: any;
                         sessionId: any;
                         genNo: any;
                         acSessionId: any;
@@ -4544,7 +4538,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);
             * })
             *```
@@ -4917,84 +4911,7 @@ export declare enum EmbedEvent {
             * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
             * @hidden
             */
-        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"
+        RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates"
 }
 /**
     * Event types that can be triggered by the host application
@@ -5012,7 +4929,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
@@ -5082,7 +4999,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) => {
@@ -5221,12 +5137,12 @@ export declare enum HostEvent {
             * Works with Search and Liveboard embed.
             * @param - { columnId: string,
             *  name: string,
-            *  type: ATTRIBUTE/MEASURE,
-            *  dataType: INT64/CHAR/DATE }
+            *  type: INT64/CHAR/DATE,
+            *  dataType: ATTRIBUTE/MEASURE }
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.OpenFilter,
-            *  {column: { columnId: '<column-GUID>', name: 'column name', type: 'ATTRIBUTE', dataType: 'INT64'}})
+            *  {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
             * ```
             * @example
             * ```js
@@ -5284,7 +5200,6 @@ 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.
@@ -5332,12 +5247,6 @@ 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",
@@ -5402,21 +5311,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",
@@ -5440,12 +5340,6 @@ 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",
@@ -5518,8 +5412,6 @@ 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)
@@ -5528,18 +5420,6 @@ 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",
@@ -5587,16 +5467,6 @@ 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
             */
@@ -5660,7 +5530,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 +5538,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
@@ -5690,19 +5554,13 @@ 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:
@@ -5714,18 +5572,12 @@ 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:
@@ -5737,11 +5589,6 @@ 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",
@@ -5761,7 +5608,6 @@ 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)
@@ -5769,11 +5615,6 @@ 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",
@@ -6057,7 +5898,7 @@ export declare enum HostEvent {
         ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
         /**
             * Triggers an action to update Parameter values on embedded
-            * Answers, Liveboard and Spotter answer in Edit mode.
+            * Answers and Liveboard.
             *
             * @example
             * ```js
@@ -6071,19 +5912,11 @@ 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",
@@ -6115,7 +5948,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 +5956,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",
@@ -6159,70 +5984,6 @@ 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.
@@ -6245,18 +6006,7 @@ export declare enum HostEvent {
             *
             * @hidden
             */
-        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"
+        VisibleEmbedCoordinates = "visibleEmbedCoordinates"
 }
 /**
     * The different visual modes that the data sources panel within