@thoughtspot/visual-embed-sdk 1.35.12 → 1.35.13

package/src/embed/conversation.spec.ts

@@ -4,13 +4,11 @@ import {
 } from './conversation';
 import * as authInstance from '../auth';
 import { init } from '../index';
-import { Action, AuthType, RuntimeFilterOp } from '../types';
+import { AuthType } from '../types';
 import {
-    executeAfterWait,
     getDocumentBody,
     getIFrameSrc,
     getRootEl,
-    fixedEncodeURI,
     defaultParamsWithoutHiddenActions as defaultParams,
     expectUrlMatchesWithParams,
 } from '../test/test-utils';
@@ -62,6 +60,40 @@ describe('ConversationEmbed', () => {
         );
     });
 
+    it('should render the conversation embed with spotter limitations text if flag is set', async () => {
+        const viewConfig: ConversationViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            showSpotterLimitations: true,
+        };
+
+        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&showSpotterLimitations=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed with sample questions hidden', async () => {
+        const viewConfig: ConversationViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            hideSampleQuestions: true,
+        };
+
+        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&hideSampleQuestions=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
     it('should render the conversation embed with worksheets hidden', async () => {
         const viewConfig: ConversationViewConfig = {
             worksheetId: 'worksheetId',
@@ -93,4 +125,21 @@ describe('ConversationEmbed', () => {
             ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND,
         );
     });
+
+    it('should render the conversation embed if data panel v2 flag is true', async () => {
+        const viewConfig: ConversationViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            dataPanelV2: true,
+        };
+
+        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&enableDataPanelV2=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
 });

package/src/embed/conversation.ts

@@ -14,6 +14,10 @@ export interface SearchOptions {
     searchQuery: string;
 }
 
+/**
+ * The configuration for the embedded conversationEmbed options.
+ * @group Embed components
+ */
 export interface ConversationViewConfig extends ViewConfig {
     /**
      * The ID of the worksheet to use for the conversation.
@@ -48,6 +52,46 @@ export interface ConversationViewConfig extends ViewConfig {
      * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
      */
     hideSourceSelection?: boolean;
+    /**
+     * Flag to control Data panel experience
+     * @default false
+     * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    dataPanelV2: true,
+     * })
+     * ```
+     */
+    dataPanelV2?: boolean;
+    /**
+     * showSpotterLimitations : show limitation text
+     * of the spotter underneath the chat input.
+     * default is false.
+     * @example
+     * ```js
+     * const embed = new ConversationEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showSpotterLimitations : true,
+     * })
+     * ```
+     * @version SDK: 1.36.0 | Thoughtspot: 10.5.0.cl
+     */
+    showSpotterLimitations?: boolean;
+    /**
+     * hideSampleQuestions : Hide sample questions on
+     * the initial screen of the conversation.
+     * @example
+     * ```js
+     * const embed = new ConversationEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideSampleQuestions : true,
+     * })
+     * ```
+     * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     */
+    hideSampleQuestions?: boolean;
 }
 
 /**
@@ -71,12 +115,15 @@ export class ConversationEmbed extends TsEmbed {
         super(container, viewConfig);
     }
 
-    public getIframeSrc() {
+    public getIframeSrc(): string {
         const {
             worksheetId,
             searchOptions,
             disableSourceSelection,
             hideSourceSelection,
+            dataPanelV2,
+            showSpotterLimitations,
+            hideSampleQuestions,
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         if (!worksheetId) {
@@ -91,6 +138,18 @@ export class ConversationEmbed extends TsEmbed {
             queryParams[Param.HideSourceSelection] = !!hideSourceSelection;
         }
 
+        if (!isUndefined(dataPanelV2)) {
+            queryParams[Param.DataPanelV2Enabled] = !!dataPanelV2;
+        }
+
+        if (!isUndefined(showSpotterLimitations)) {
+            queryParams[Param.ShowSpotterLimitations] = !!showSpotterLimitations;
+        }
+
+        if (!isUndefined(hideSampleQuestions)) {
+            queryParams[Param.HideSampleQuestions] = !!hideSampleQuestions;
+        }
+
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {

package/src/embed/hostEventClient/contracts.ts

@@ -16,13 +16,13 @@ export type UIPassthroughContractBase = {
       vizId?: string;
       newVizName: string;
       newVizDescription?: string;
-      pinboardId?: string;
+      liveboardId?: string;
       tabId?: string;
-      newPinboardName?: string;
+      newLiveboardName?: string;
       newTabName?: string;
     };
     response: {
-      pinboardId: string;
+      liveboardId: string;
       tabId: string;
       vizId: string;
     };

package/src/embed/hostEventClient/host-event-client.ts

@@ -96,8 +96,14 @@ export class HostEventClient {
           return this.hostEventFallback(HostEvent.Pin, payload);
       }
 
+      const formattedPayload = {
+          ...payload,
+          pinboardId: payload.liveboardId,
+          newPinboardName: payload.newLiveboardName,
+      };
+
       return this.handleHostEventWithParam(
-          UIPassthroughEvent.PinAnswerToLiveboard, payload,
+          UIPassthroughEvent.PinAnswerToLiveboard, formattedPayload,
       );
   }
 

package/src/embed/liveboard.ts

@@ -25,6 +25,13 @@ import { V1Embed } from './ts-embed';
 import { addPreviewStylesIfNotPresent } from '../utils/global-styles';
 import { TriggerPayload, TriggerResponse } from './hostEventClient/contracts';
 
+const liveboardHeightWhitelistedRoutes = [
+    '/embed/viz/',
+    '/embed/insights/viz/',
+    '/tsl-editor/PINBOARD_ANSWER_BOOK/',
+    '/import-tsl/PINBOARD_ANSWER_BOOK/',
+];
+
 /**
  * The configuration for the embedded Liveboard or visualization page view.
  * @group Embed components
@@ -562,10 +569,8 @@ export class LiveboardEmbed extends V1Embed {
     };
 
     private setIframeHeightForNonEmbedLiveboard = (data: MessagePayload) => {
-        if (
-            data.data.currentPath.startsWith('/embed/viz/')
-            || data.data.currentPath.startsWith('/embed/insights/viz/')
-        ) {
+        const routePath = data.data.currentPath;
+        if (liveboardHeightWhitelistedRoutes.some((path) => routePath.startsWith(path))) {
             return;
         }
         this.setIFrameHeight(this.defaultHeight);

package/src/embed/search-bar.tsx

@@ -143,10 +143,12 @@ export class SearchBarEmbed extends TsEmbed {
         if (dataSource) {
             queryParams[Param.DataSources] = `["${dataSource}"]`;
         }
-        if (searchOptions?.searchTokenString && !excludeSearchTokenStringFromURL) {
-            queryParams[Param.searchTokenString] = encodeURIComponent(
-                searchOptions.searchTokenString,
-            );
+        if (searchOptions?.searchTokenString) {
+            if (!excludeSearchTokenStringFromURL) {
+                queryParams[Param.searchTokenString] = encodeURIComponent(
+                    searchOptions.searchTokenString,
+                );
+            }
 
             if (searchOptions.executeSearch) {
                 queryParams[Param.executeSearch] = true;

package/src/embed/search.spec.ts

@@ -539,10 +539,10 @@ describe('Search embed tests', () => {
         });
     });
 
-    test('with excludeSearchTokenStringFromURL', async () => {
+    test('with excludeSearchTokenStringFromURL, execute as false', async () => {
         const searchOptions: SearchOptions = {
             searchTokenString: '[commit date][revenue]',
-            executeSearch: true,
+            executeSearch: false,
         };
         const searchEmbed = new SearchEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -570,6 +570,9 @@ describe('Search embed tests', () => {
             );
         });
 
+        expect(getIFrameSrc().includes('searchTokenString')).toBeFalsy();
+        expect(getIFrameSrc().includes('executeSearch')).toBeFalsy();
+
         expect(mockPort.postMessage).toHaveBeenCalledWith({
             type: EmbedEvent.APP_INIT,
             data: expect.objectContaining({
@@ -580,22 +583,87 @@ describe('Search embed tests', () => {
         });
     });
 
-    test('without excludeSearchTokenStringFromURL', async () => {
+    test('with excludeSearchTokenStringFromURL with execute true', async () => {
         const searchOptions: SearchOptions = {
             searchTokenString: '[commit date][revenue]',
             executeSearch: true,
         };
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            searchOptions,
+            excludeSearchTokenStringFromURL: true,
+        });
+        const mockEmbedEventPayload = {
+            type: EmbedEvent.APP_INIT,
+            data: {},
+        };
+        searchEmbed.render();
+
+        const mockPort: any = {
+            postMessage: jest.fn(),
+        };
+        await executeAfterWait(() => {
+            const iframe = getIFrameEl();
+            postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+        });
+
+        expect(getIFrameSrc().includes('searchTokenString')).toBeFalsy();
+
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&executeSearch=true&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
+            );
+        });
+
+        expect(mockPort.postMessage).toHaveBeenCalledWith({
+            type: EmbedEvent.APP_INIT,
+            data: expect.objectContaining({
+                searchOptions: {
+                    searchTokenString: '[commit date][revenue]',
+                },
+            }),
+        });
+    });
+
+    test('without excludeSearchTokenStringFromURL with execute search as false', async () => {
+        const searchOptions: SearchOptions = {
+            searchTokenString: '[commit date][revenue]',
+            executeSearch: false,
+        };
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            searchOptions,
+            excludeSearchTokenStringFromURL: false,
+        });
+        searchEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false&searchTokenString=[commit date][revenue]${prefixParams}#/embed/saved-answer/${answerId}`,
+            );
+        });
+    });
+
+    test('without excludeSearchTokenStringFromURL with executeSearch as false', async () => {
+        const searchOptions: SearchOptions = {
+            searchTokenString: '[commit date][revenue]',
+            executeSearch: false,
+        };
         const searchEmbed = new SearchEmbed(getRootEl(), {
             ...defaultViewConfig,
             searchOptions,
             excludeSearchTokenStringFromURL: false,
         });
         searchEmbed.render();
+
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false&searchTokenString=[commit date][revenue]${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });
+
+        expect(getIFrameSrc().includes('executeSearch')).toBeFalsy();
     });
 });

package/src/embed/search.ts

@@ -392,11 +392,12 @@ export class SearchEmbed extends TsEmbed {
         if (dataSource) {
             queryParams[Param.DataSources] = `["${dataSource}"]`;
         }
-        if (searchOptions?.searchTokenString && !excludeSearchTokenStringFromURL) {
-            queryParams[Param.searchTokenString] = encodeURIComponent(
-                searchOptions.searchTokenString,
-            );
-
+        if (searchOptions?.searchTokenString) {
+            if (!excludeSearchTokenStringFromURL) {
+                queryParams[Param.searchTokenString] = encodeURIComponent(
+                    searchOptions.searchTokenString,
+                );
+            }
             if (searchOptions.executeSearch) {
                 queryParams[Param.executeSearch] = true;
             }