@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.23.0",
+    "version": "1.23.2",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

package/src/auth.ts

@@ -1,5 +1,4 @@
 import EventEmitter from 'eventemitter3';
-import _ from 'lodash';
 import { initMixpanel } from './mixpanel-service';
 import {
     AuthType, DOMSelector, EmbedConfig, EmbedEvent, Param,
@@ -207,7 +206,7 @@ export function notifyLogout(): void {
 }
 
 export const initSession = (sessionDetails: sessionInfoInterface) => {
-    if (_.isNull(sessionInfo)) {
+    if (sessionInfo == null) {
         sessionInfo = sessionDetails;
         initMixpanel(sessionInfo);
         sessionInfoResolver(sessionInfo);

package/src/embed/app.spec.ts

@@ -254,6 +254,21 @@ describe('App embed tests', () => {
         });
     });
 
+    test('Should add enableDataPanelV2 flag to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            dataPanelV2: true,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&enableDataPanelV2=true${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should register event handlers to adjust iframe height', async () => {
         const onSpy = jest.spyOn(AppEmbed.prototype, 'on')
             .mockImplementation((event, callback) => {

package/src/embed/app.ts

@@ -47,7 +47,7 @@ export enum Page {
     /**
      * SpotIQ listing page
      */
-    SpotIQ = 'spotiq',
+    SpotIQ = 'insights',
 }
 
 /**
@@ -118,6 +118,14 @@ export interface AppViewConfig extends ViewConfig {
       * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
       */
     fullHeight?:boolean;
+    /**
+     * Flag to control Data panel experience
+     *
+     * @default false
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @hidden
+     */
+    dataPanelV2?: boolean;
 }
 
 /**
@@ -155,6 +163,7 @@ export class AppEmbed extends V1Embed {
             hideOrgSwitcher,
             enableSearchAssist,
             fullHeight,
+            dataPanelV2 = false,
         } = this.viewConfig;
 
         let params = {};
@@ -184,6 +193,7 @@ export class AppEmbed extends V1Embed {
             params[Param.EnableSearchAssist] = enableSearchAssist;
         }
 
+        params[Param.DataPanelV2Enabled] = dataPanelV2;
         const queryParams = getQueryParamString(params, true);
 
         return queryParams;

package/src/embed/base.ts

@@ -256,6 +256,10 @@ export const renderInQueue = (fn: (next?: (val?: any) => void) => Promise<any>):
     return fn(() => { }); // eslint-disable-line @typescript-eslint/no-empty-function
 };
 
+/**
+ * @param data
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+ */
 export const executeTML = async (data: executeTMLInput): Promise<any> => {
     const { thoughtSpotHost, authType } = config;
     try {
@@ -299,6 +303,10 @@ export const executeTML = async (data: executeTMLInput): Promise<any> => {
         });
 };
 
+/**
+ * @param data
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+ */
 export const exportTML = async (data: exportTMLInput): Promise<any> => {
     const { thoughtSpotHost, authType } = config;
     try {

package/src/embed/sage.spec.ts

@@ -37,7 +37,39 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&hideEurekaResults=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=true&hideAction=%5B"save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&hideEurekaResults=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=true&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
+            );
+        });
+    });
+    test('embed url include pre-seed dataSource and query', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            ...defaultConfig,
+            dataSource: 'worksheet-id',
+            searchOptions: {
+                searchQuery: 'test-query',
+            },
+        });
+        sageEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatch(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&hideEurekaResults=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=true&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka?worksheet=worksheet-id&query=test-query`,
+            );
+        });
+    });
+    test('embed url include pre-seed execute flag with query', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            ...defaultConfig,
+            searchOptions: {
+                searchQuery: 'test-query',
+                executeSearch: true,
+            },
+        });
+        sageEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatch(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&hideEurekaResults=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=true&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka?query=test-query&executeSearch=true`,
             );
         });
     });

package/src/embed/sage.ts

@@ -13,15 +13,35 @@ import {
 import { getQueryParamString } from '../utils';
 import { V1Embed } from './ts-embed';
 
+/**
+ * Configuration for search options
+ */
+export interface SearchOptions {
+    /**
+     * The tml string to load the answer
+     */
+    searchQuery: string;
+    /**
+     * Boolean to determine if the search should be executed or not.
+     * if it is executed, put the focus on the results.
+     * if it’s not executed, put the focus in the search bar - at the end of
+     * the tokens
+     */
+    executeSearch?: boolean;
+}
+
 /**
  * The configuration attributes for the embedded Natural language search view. Based on
  * GPT and LLM.
  *
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
  * @group Embed components
  */
 export interface SageViewConfig extends ViewConfig {
     /**
-     * If set to true, object results are shown.
+     * If set to true, a list of liveboard and answers related
+     * to the natural language search will be shown below the
+     * AI generated answer.
      */
     showObjectResults?: boolean;
     /**
@@ -33,10 +53,29 @@ export interface SageViewConfig extends ViewConfig {
      */
     hideWorksheetSelector?: boolean,
     /**
-     * If set to true, the object search suggestions are not shown
+     * If set to true, the search suggestions will contain existing
+     * liveboards and answers in addition with the autocomplete
      *
      */
     showObjectSuggestions?: boolean;
+    /**
+     * The query string to pre-fill in natual language search bar
+     */
+    searchQuery?: string;
+    /**
+     * If set to true, sample questions would be hidden to user.
+     * These sample questions are autogenerated based on selected datasource.
+     */
+    hideSampleQuestions?: boolean;
+    /**
+     * The data source GUID to set on load.
+     */
+    dataSource?: string;
+    /**
+     * Configuration for search options
+     */
+    searchOptions?: SearchOptions;
+
 }
 export const HiddenActionItemByDefaultForSageEmbed = [
     Action.Save,
@@ -78,15 +117,17 @@ export class SageEmbed extends V1Embed {
             disableWorksheetChange,
             hideWorksheetSelector,
             showObjectSuggestions,
+            hideSampleQuestions,
         } = this.viewConfig;
 
-        const params = {};
+        const params = this.getBaseQueryParams();
         params[Param.EmbedApp] = true;
         params[Param.HideEurekaResults] = !showObjectResults;
         params[Param.IsSageEmbed] = true;
         params[Param.DisableWorksheetChange] = !!disableWorksheetChange;
         params[Param.HideWorksheetSelector] = !!hideWorksheetSelector;
         params[Param.HideEurekaSuggestions] = !showObjectSuggestions;
+        params[Param.HideSampleQuestions] = !!hideSampleQuestions;
         params[Param.HideActions] = [
             ...(params[Param.HideActions] ?? []),
             ...HiddenActionItemByDefaultForSageEmbed,
@@ -103,9 +144,23 @@ export class SageEmbed extends V1Embed {
      */
     private getIFrameSrc() {
         const path = 'eureka';
+        const postHashObj = {};
         const tsPostHashParams = this.getThoughtSpotPostUrlParams();
+        const {
+            dataSource, searchOptions,
+        } = this.viewConfig;
+
+        if (dataSource) postHashObj[Param.WorksheetId] = dataSource;
+        if (searchOptions?.searchQuery) {
+            postHashObj[Param.Query] = searchOptions?.searchQuery;
+            if (searchOptions.executeSearch) {
+                postHashObj[Param.executeSearch] = true;
+            }
+        }
+        let sagePostHashParams = new URLSearchParams(postHashObj).toString();
+        if (sagePostHashParams) sagePostHashParams = `${tsPostHashParams ? '&' : '?'}${sagePostHashParams}`;
 
-        return `${this.getRootIframeSrc()}/embed/${path}${tsPostHashParams}`;
+        return `${this.getRootIframeSrc()}/embed/${path}${tsPostHashParams}${sagePostHashParams}`;
     }
 
     /**

package/src/embed/search-bar.tsx

@@ -8,7 +8,7 @@ import { SearchOptions } from './search';
 /**
  * @group Embed components
  */
-export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
+export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
     /**
      * The array of data source GUIDs to set on load.
      * Only a single dataSource supported currently.

package/src/embed/search.spec.ts

@@ -47,7 +47,7 @@ describe('Search embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&enableDataPanelV2=false&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
     });
@@ -336,4 +336,18 @@ describe('Search embed tests', () => {
             );
         });
     });
+
+    test('should set enableDataPanelV2 to true if data panel v2 flag is true', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            dataPanelV2: true,
+        });
+        searchEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=true&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
+            );
+        });
+    });
 });

package/src/embed/search.ts

@@ -109,6 +109,14 @@ export interface SearchViewConfig extends ViewConfig {
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     hideSearchBar?: boolean;
+    /**
+     * Flag to control Data panel experience
+     *
+     * @default false
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @hidden
+     */
+    dataPanelV2?: boolean;
 }
 
 export const HiddenActionItemByDefaultForSearchEmbed = [
@@ -162,6 +170,7 @@ export class SearchEmbed extends TsEmbed {
             dataSource,
             dataSources,
             excludeRuntimeFiltersfromURL,
+            dataPanelV2 = false,
         } = this.viewConfig;
         const queryParams = this.getBaseQueryParams();
 
@@ -195,6 +204,7 @@ export class SearchEmbed extends TsEmbed {
             queryParams[Param.ForceTable] = true;
         }
 
+        queryParams[Param.DataPanelV2Enabled] = dataPanelV2;
         queryParams[Param.DataSourceMode] = this.getDataSourceMode();
         queryParams[Param.UseLastSelectedDataSource] = false;
         queryParams[Param.searchEmbed] = true;

package/src/react/index.spec.tsx

@@ -47,7 +47,7 @@ describe('React Components', () => {
                 ),
             ).toBe(true);
             expect(getIFrameSrc(container)).toBe(
-                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&authType=None&blockNonEmbedFullAppAccess=true&hideAction=[%22${Action.ReportError}%22,%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`,
+                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&authType=None&blockNonEmbedFullAppAccess=true&hideAction=[%22${Action.ReportError}%22,%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&enableDataPanelV2=false&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`,
             );
         });