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

package/lib/src/visual-embed-sdk.d.ts

@@ -1672,8 +1672,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
             genNo: number;
             acSessionId: string;
             acGenNo: number;
-            convId: string;
-            messageId: string;
     }
     export class ConversationMessage extends TsEmbed {
             protected viewConfig: SpotterAgentMessageViewConfig;
@@ -1721,8 +1719,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
                     data?: undefined;
             } | {
                     data: {
-                            convId: any;
-                            messageId: any;
                             sessionId: any;
                             genNo: any;
                             acSessionId: any;
@@ -4486,7 +4482,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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);
                 * })
                 *```
@@ -4859,84 +4855,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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
@@ -4954,7 +4873,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
         * // create the liveboard embed.
         *
         * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
-        *   { columnName: 'state', operator: RuntimeFilterOp.EQ, values: ["california"]}
+        *   { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
         * ]);
         * ```
         * @example
@@ -5024,7 +4943,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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) => {
@@ -5163,12 +5081,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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
@@ -5226,7 +5144,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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.
@@ -5274,12 +5191,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5344,21 +5255,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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",
@@ -5382,12 +5284,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5460,8 +5356,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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)
@@ -5470,18 +5364,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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",
@@ -5529,16 +5411,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *   );
                 * })
                 * ```
-                * @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
                 */
@@ -5602,7 +5474,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * 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:
@@ -5611,11 +5482,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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
@@ -5632,19 +5498,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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:
@@ -5656,18 +5516,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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:
@@ -5679,11 +5533,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5703,7 +5552,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * 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)
@@ -5711,11 +5559,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```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",
@@ -5999,7 +5842,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
             /**
                 * Triggers an action to update Parameter values on embedded
-                * Answers, Liveboard and Spotter answer in Edit mode.
+                * Answers and Liveboard.
                 *
                 * @example
                 * ```js
@@ -6013,19 +5856,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             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",
@@ -6057,7 +5892,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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, {
@@ -6065,14 +5900,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *      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",
@@ -6101,70 +5928,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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.
@@ -6187,18 +5950,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * @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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.40.0",
+    "version": "1.40.1-alpha.1",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -57,7 +57,6 @@
         "test": "npm run test-sdk",
         "posttest": "cat ./coverage/sdk/lcov.info | coveralls",
         "is-publish-allowed": "node scripts/is-publish-allowed.js",
-        "prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
         "check-size": "npm run build && size-limit",
         "publish-dev": "npm publish --tag dev",
         "publish-prod": "npm publish --tag latest",

package/src/embed/liveboard.ts

@@ -645,16 +645,20 @@ export class LiveboardEmbed extends V1Embed {
     }
 
     protected beforePrerenderVisible(): void {
-        const embedObj = (this.insertedDomEl as any)?.[this.embedNodeKey] as LiveboardEmbed;
+        const embedObj = this.getPreRenderObj<LiveboardEmbed>();
 
         if (isUndefined(embedObj)) return;
 
-        const showDifferentLib = this.viewConfig.liveboardId
-            && embedObj.viewConfig.liveboardId !== this.viewConfig.liveboardId;
+        const showDifferentLib = this.currentLiveboardId
+            && embedObj.currentLiveboardId !== this.currentLiveboardId;
 
         if (showDifferentLib) {
-            const libId = this.viewConfig.liveboardId;
-            this.navigateToLiveboard(libId);
+            console.log('showDifferentLib', this.currentLiveboardId);
+            const libId = this.currentLiveboardId;
+            this.navigateToLiveboard(libId, null, null, () => {
+                console.log('onNavigateCalled', libId);
+                embedObj.currentLiveboardId = libId;
+            });
         }
     }
 
@@ -729,13 +733,16 @@ export class LiveboardEmbed extends V1Embed {
         return this;
     }
 
-    public navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string) {
+    public currentLiveboardId: string = this.viewConfig.liveboardId;
+
+    public navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, onNavigateCalled?: () => void) {
         const path = this.getIframeSuffixSrc(liveboardId, vizId, activeTabId);
         this.viewConfig.liveboardId = liveboardId;
         this.viewConfig.activeTabId = activeTabId;
         this.viewConfig.vizId = vizId;
         if (this.isRendered) {
-            this.trigger(HostEvent.Navigate, path.substring(1));
+            console.log('navigating to liveboard', path.substring(1));
+            this.triggerAfterLoad(HostEvent.Navigate, path.substring(1), onNavigateCalled);
         } else if (this.viewConfig.preRenderId) {
             this.preRender(true);
         } else {