@thoughtspot/visual-embed-sdk 1.29.1-alpha.1 → 1.29.2

package/src/embed/sage.spec.ts

@@ -9,12 +9,9 @@ import {
     getRootEl,
 } from '../test/test-utils';
 
-import * as authInstance from '../auth';
-
 const defaultConfig: SageViewConfig = {
     disableWorksheetChange: false,
     hideWorksheetSelector: false,
-    hideSearchBarTitle: false,
     hideSageAnswerHeader: false,
     hideAutocompleteSuggestions: false,
     hideSampleQuestions: false,
@@ -29,7 +26,6 @@ beforeAll(() => {
         authType: AuthType.None,
     });
     spyOn(window, 'alert');
-    jest.spyOn(authInstance, 'postLoginService').mockResolvedValue(true);
 });
 
 describe('Sage  embed tests', () => {
@@ -39,22 +35,22 @@ describe('Sage  embed tests', () => {
 
     test('should render sage', async () => {
         const sageEmbed = new SageEmbed(getRootEl(), defaultConfig);
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSearchBarTitle=false&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
 
     test('should render sage with product tour flag set', async () => {
         const sageEmbed = new SageEmbed(getRootEl(), { ...defaultConfig, isProductTour: true });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=true&hideSearchBarTitle=false&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=true&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -64,11 +60,11 @@ describe('Sage  embed tests', () => {
             ...defaultConfig,
             disableWorksheetChange: true,
         });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=true&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSearchBarTitle=false&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=true&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -78,25 +74,11 @@ describe('Sage  embed tests', () => {
             ...defaultConfig,
             hideWorksheetSelector: true,
         });
-        sageEmbed.render();
-        await executeAfterWait(() => {
-            expectUrlMatch(
-                getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=false&isProductTour=false&hideSearchBarTitle=false&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
-            );
-        });
-    });
-
-    test('should render sage with hideSearchBarTitle flag', async () => {
-        const sageEmbed = new SageEmbed(getRootEl(), {
-            ...defaultConfig,
-            hideSearchBarTitle: true,
-        });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSearchBarTitle=true&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -106,11 +88,11 @@ describe('Sage  embed tests', () => {
             ...defaultConfig,
             hideSageAnswerHeader: true,
         });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSearchBarTitle=false&hideSageAnswerHeader=true&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=true&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -120,11 +102,11 @@ describe('Sage  embed tests', () => {
             ...defaultConfig,
             hideAutocompleteSuggestions: true,
         });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=true&isProductTour=false&hideSearchBarTitle=false&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=true&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -133,11 +115,11 @@ describe('Sage  embed tests', () => {
         const sageEmbed = new SageEmbed(getRootEl(), {
             showObjectSuggestions: true,
         });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSearchBarTitle=false&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -147,11 +129,11 @@ describe('Sage  embed tests', () => {
             ...defaultConfig,
             dataSource: 'worksheet-id',
         });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSearchBarTitle=false&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka?worksheet=worksheet-id`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka?worksheet=worksheet-id`,
             );
         });
     });
@@ -164,11 +146,11 @@ describe('Sage  embed tests', () => {
                 searchQuery: 'test query', // also tests for query with spaces
             },
         });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSearchBarTitle=false&hideSageAnswerHeader=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka?worksheet=worksheet-id&query=test%20query`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka?worksheet=worksheet-id&query=test%20query`,
             );
         });
     });
@@ -181,11 +163,11 @@ describe('Sage  embed tests', () => {
                 executeSearch: true,
             },
         });
-        sageEmbed.render();
+        await sageEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka?executeSearch=true&query=test-query`,
+                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&hideAction=%5B%22reportError%22%5D#/embed/eureka?executeSearch=true&query=test-query`,
             );
         });
     });

package/src/embed/sage.ts

@@ -2,14 +2,11 @@
  * Copyright (c) 2023
  *
  * Embed ThoughtSpot Sage
- *
  * @summary TS Sage embed
  * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
  */
 
-import {
-    Action, DOMSelector, Param, ViewConfig,
-} from '../types';
+import { DOMSelector, Param, ViewConfig } from '../types';
 import { getQueryParamString } from '../utils';
 import { V1Embed } from './ts-embed';
 
@@ -33,7 +30,6 @@ export interface SearchOptions {
 /**
  * The configuration attributes for the embedded Natural language search view. Based on
  * GPT and LLM.
- *
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
  * @group Embed components
  */
@@ -46,7 +42,6 @@ export interface SageViewConfig
      * If set to true, a list of Liveboard and Answers related
      * to the natural language search will be shown below the
      * AI generated answer.
-     *
      * @deprecated Currently Liveboard and Answers related
      * to the natural language search will not be shown for sage
      * embed
@@ -54,49 +49,43 @@ export interface SageViewConfig
     showObjectResults?: boolean;
     /**
      * flag used by the TS product tour page to show the blue search bar
-     * even after the search is completed. This is different from TSE Sage Embed
-     * experience where it mimics closer to the non-embed case.
+     * even after the search is completed. This is different from Thoughtspot Embedded
+     * Sage Embed experience where it mimics closer to the non-embed case.
      * The Sample questions container is collapsed when this value is set after
      * does a search.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
      * @hidden
      */
     isProductTour?: boolean;
     /**
      * Show or hide the search bar title.
-     *
-     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
      */
     hideSearchBarTitle?: boolean;
     /**
      * Show or hide the Answer header, that is, the `AI Answer` title
      * at the top of the Answer page.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
      */
     hideSageAnswerHeader?: boolean;
     /**
      * Disable the worksheet selection option.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     disableWorksheetChange?: boolean;
     /**
      * Hide the worksheet selection panel.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     hideWorksheetSelector?: boolean;
     /**
      * Show or hide autocomplete suggestions for the search query string.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     hideAutocompleteSuggestions?: boolean;
     /**
      * Show or hide autocomplete suggestions for the search query string.
-     *
      * @deprecated
      * Currently, the object suggestions will not be shown for Natural Language Search.
      * You can use {@link hideAutocompleteSuggestions} instead.
@@ -106,7 +95,6 @@ export interface SageViewConfig
      * Show or hide sample questions.
      * The sample questions are autogenerated based on the worksheet
      * selected for the search operation.
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     hideSampleQuestions?: boolean;
@@ -124,7 +112,6 @@ export interface SageViewConfig
      * If it is executed, the focus is placed on the results.
      * If it’s not executed, the focus is placed at the end of
      * the token string in the search bar.
-     *
      * @example
      * ```js
      * searchOptions: {
@@ -136,19 +123,8 @@ export interface SageViewConfig
      */
     searchOptions?: SearchOptions;
 }
-export const HiddenActionItemByDefaultForSageEmbed = [
-    Action.Save,
-    Action.Pin,
-    Action.EditACopy,
-    Action.SaveAsView,
-    Action.UpdateTML,
-    Action.EditTML,
-    Action.AnswerDelete,
-    Action.Share,
-];
 /**
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
- *
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
  * @group Embed components
  */
@@ -168,7 +144,6 @@ export class SageEmbed extends V1Embed {
     /**
      * Constructs a map of parameters to be passed on to the
      * embedded Eureka or Sage search page.
-     *
      * @returns {string} query string
      */
     protected getEmbedParams(): string {
@@ -178,7 +153,6 @@ export class SageEmbed extends V1Embed {
             showObjectSuggestions,
             hideSampleQuestions,
             isProductTour,
-            hideSearchBarTitle,
             hideSageAnswerHeader,
             hideAutocompleteSuggestions,
         } = this.viewConfig;
@@ -195,12 +169,7 @@ export class SageEmbed extends V1Embed {
         }
         params[Param.HideSampleQuestions] = !!hideSampleQuestions;
         params[Param.IsProductTour] = !!isProductTour;
-        params[Param.HideSearchBarTitle] = !!hideSearchBarTitle;
         params[Param.HideSageAnswerHeader] = !!hideSageAnswerHeader;
-        params[Param.HideActions] = [
-            ...(params[Param.HideActions] ?? []),
-            ...HiddenActionItemByDefaultForSageEmbed,
-        ];
 
         return getQueryParamString(params, true);
     }
@@ -208,7 +177,6 @@ export class SageEmbed extends V1Embed {
     /**
      * Construct the URL of the embedded ThoughtSpot sage to be
      * loaded in the iframe
-     *
      * @returns {string} iframe url
      */
     public getIFrameSrc(): string {
@@ -234,7 +202,6 @@ export class SageEmbed extends V1Embed {
 
     /**
      * Render the embedded ThoughtSpot Sage
-     *
      * @returns {SageEmbed} Eureka/Sage embed
      */
     public async render(): Promise<SageEmbed> {

package/src/embed/search-bar.tsx

@@ -21,11 +21,8 @@ export interface SearchBarViewConfig
     /**
      * The array of data source GUIDs to set on load.
      * Only a single data source is supported currently.
-     *
      * @deprecated Use `dataSource` instead
-     *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
-     *
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -37,9 +34,7 @@ export interface SearchBarViewConfig
     dataSources?: string[];
     /**
      * Pass the ID of the source to be selected.
-     *
      * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
-     *
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -51,9 +46,7 @@ export interface SearchBarViewConfig
     dataSource?: string;
     /**
      * Boolean to define if the last selected data source should be used
-     *
      * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -73,9 +66,7 @@ export interface SearchBarViewConfig
      * If it is executed, the focus is placed on the results.
      * If it’s not executed, the focus is placed at the end of
      * the token string in the search bar.
-     *
      * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -92,7 +83,6 @@ export interface SearchBarViewConfig
 
 /**
  * Embed ThoughtSpot search bar
- *
  * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
  * @group Embed components
  */
@@ -112,7 +102,6 @@ export class SearchBarEmbed extends TsEmbed {
     /**
      * Construct the URL of the embedded ThoughtSpot search to be
      * loaded in the iframe
-     *
      * @param dataSources A list of data source GUIDs
      */
     private getIFrameSrc() {

package/src/embed/search.spec.ts

@@ -1,4 +1,8 @@
-import { SearchEmbed, HiddenActionItemByDefaultForSearchEmbed } from './search';
+import {
+    SearchEmbed,
+    HiddenActionItemByDefaultForSearchEmbed,
+    DataPanelCustomColumnGroupsAccordionState,
+} from './search';
 import * as authInstance from '../auth';
 import { init } from '../index';
 import { Action, AuthType, RuntimeFilterOp } from '../types';
@@ -32,7 +36,6 @@ beforeAll(() => {
         thoughtSpotHost,
         authType: AuthType.None,
     });
-    jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve({}));
     spyOn(window, 'alert');
 });
 
@@ -218,6 +221,33 @@ describe('Search embed tests', () => {
         });
     });
 
+    test('should not append runtime parameters in URL if excludeRuntimeFiltersfromURL is true', async () => {
+        const dataSources = ['data-source-1'];
+        const searchOptions = {
+            searchTokenString: '[commit date][revenue]',
+        };
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            hideDataSources: true,
+            dataSources,
+            searchOptions,
+            runtimeParameters: [
+                {
+                    name: 'city',
+                    value: 'berkeley',
+                },
+            ],
+            excludeRuntimeParametersfromURL: true,
+        });
+        searchEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=hide&useLastSelectedSources=false${prefixParams}#/embed/answer`,
+            );
+        });
+    });
+
     test('should append runtime filters in URL if excludeRuntimeFiltersfromURL is undefined', async () => {
         const dataSources = ['data-source-1'];
         const searchOptions = {
@@ -455,4 +485,20 @@ describe('Search embed tests', () => {
             );
         });
     });
+
+    test('should set dataPanelCustomGroupsAccordionInitialState to EXPAND_FIRST when passed', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            // eslint-disable-next-line max-len
+            dataPanelCustomGroupsAccordionInitialState:
+                DataPanelCustomColumnGroupsAccordionState.EXPAND_FIRST,
+        });
+        searchEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_FIRST${prefixParams}#/embed/saved-answer/${answerId}`,
+            );
+        });
+    });
 });