@thoughtspot/visual-embed-sdk 1.24.0-alpha.0 → 1.24.0-alpha.1

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

@@ -68,7 +68,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
             /**
                 * SpotIQ listing page
                 */
-            SpotIQ = "spotiq"
+            SpotIQ = "insights"
     }
     /**
         * The view configuration for full app embedding.
@@ -138,6 +138,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * @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;
     }
     /**
         * Embeds full ThoughtSpot experience in a host application.
@@ -271,7 +279,17 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
         * @param fn The function being registered
         */
     export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
+    /**
+        * Imports TML representation of the metadata objects into ThoughtSpot.
+        * @param data
+        * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+        */
     export const executeTML: (data: executeTMLInput) => Promise<any>;
+    /**
+        * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format.
+        * @param data
+        * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+        */
     export const exportTML: (data: exportTMLInput) => Promise<any>;
     /**
         *
@@ -514,6 +532,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * @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: Action[];
     /**
@@ -542,7 +568,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
     /**
         * @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.
@@ -1023,6 +1049,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
     export interface CustomisationsInterface {
             style?: CustomStyles;
             content?: {
+                    /**
+                        * @version SDK: 1.26.0 | 9.7.0.cl
+                        */
                     strings?: Record<string, any>;
                     [key: string]: any;
             };
@@ -1430,21 +1459,21 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Boolean to hide liveboard header
                 *
-                * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 * @default false
                 */
             hideLiveboardHeader?: boolean;
             /**
                 * Boolean to show liveboard title
                 *
-                * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 * @default false
                 */
             showLiveboardTitle?: boolean;
             /**
                 * Boolean to show liveboard description
                 *
-                * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 * @default false
                 */
             showLiveboardDescription?: boolean;
@@ -1462,7 +1491,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *  'f547ec54-2a37-4516-a222-2b06719af726']
                 * });
                 * ```
-                * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 */
             hiddenTabs?: string[];
             /**
@@ -1481,7 +1510,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *  'f547ec54-2a37-4516-a222-2b06719af726']
                 * });
                 * ```
-                * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 */
             visibleTabs?: string[];
     }
@@ -2719,6 +2748,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
                 */
             UpdateFilters = "updateFilters",
+            /**
+                * Get Tab for the current Liveboard.
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
+                *   console.log(
+                *      tabDetails // TabDetails of current LB
+                *   );
+                * })
+                * ```
+                * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
+                */
             GetTabs = "getTabs",
             /**
                 * Set the visible Tabs on a Liveboard.
@@ -2731,7 +2773,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *  '430496d6-6903-4601-937e-2c691821af3c',
                 *  'f547ec54-2a37-4516-a222-2b06719af726'])
                 * ```
-                * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 */
             SetVisibleTabs = "SetPinboardVisibleTabs",
             /**
@@ -2745,9 +2787,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *  '630496d6-6903-4601-937e-2c691821af3c',
                 *  'i547ec54-2a37-4516-a222-2b06719af726'])
                 * ```
-                * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 */
-            SetHiddenTabs = "SetPinboardHiddenTabs"
+            SetHiddenTabs = "SetPinboardHiddenTabs",
+            /**
+                * Updates the search query for sage embed.
+                *
+                * @param - searchOptions: an object queryString and option to execute the query.
+                * @example
+                * ```js
+                * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
+                *  queryString: 'revenue per year',
+                *  executeSearch: true,
+                * })
+                * ```
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                */
+            UpdateSageQuery = "updateSageQuery"
     }
     /**
         * The different visual modes that the data sources panel within
@@ -2802,6 +2858,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             DisableLoginRedirect = "disableLoginRedirect",
             visibleVizs = "pinboardVisibleVizs",
             LiveboardV2Enabled = "isPinboardV2Enabled",
+            DataPanelV2Enabled = "enableDataPanelV2",
             ShowAlerts = "showAlerts",
             Locale = "locale",
             CustomStyle = "customStyle",
@@ -2829,8 +2886,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             VisibleTabs = "visibleTabs",
             HideTabPanel = "hideTabPanel",
             HideSampleQuestions = "hideSampleQuestions",
-            WorksheetId = "worksheetId",
-            Query = "query,"
+            WorksheetId = "worksheet",
+            Query = "query"
     }
     /**
         * ThoughtSpot application pages include actions and menu commands
@@ -3615,7 +3672,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             MarkAsVerified = "markAsVerified",
             /**
-                * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 */
             AddTab = "addTab",
             /**
@@ -3985,6 +4042,22 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
         */
     import { Action, DOMSelector, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/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.
@@ -3994,7 +4067,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
         */
     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;
             /**
@@ -4006,7 +4081,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
                 */
             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;
@@ -4023,6 +4099,10 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
                 * The data source GUID to set on load.
                 */
             dataSource?: string;
+            /**
+                * Configuration for search options
+                */
+            searchOptions?: SearchOptions;
     }
     export const HiddenActionItemByDefaultForSageEmbed: Action[];
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.24.0-alpha.0",
+    "version": "1.24.0-alpha.1",
     "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,11 @@ export const renderInQueue = (fn: (next?: (val?: any) => void) => Promise<any>):
     return fn(() => { }); // eslint-disable-line @typescript-eslint/no-empty-function
 };
 
+/**
+ * Imports TML representation of the metadata objects into ThoughtSpot.
+ * @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 +304,11 @@ export const executeTML = async (data: executeTMLInput): Promise<any> => {
         });
 };
 
+/**
+ * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format.
+ * @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

@@ -41,4 +41,36 @@ describe('Sage  embed tests', () => {
             );
         });
     });
+    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,6 +13,23 @@ 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.
@@ -22,7 +39,9 @@ import { V1Embed } from './ts-embed';
  */
 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;
     /**
@@ -34,7 +53,8 @@ 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;
@@ -51,6 +71,11 @@ export interface SageViewConfig extends ViewConfig {
      * The data source GUID to set on load.
      */
     dataSource?: string;
+    /**
+     * Configuration for search options
+     */
+    searchOptions?: SearchOptions;
+
 }
 export const HiddenActionItemByDefaultForSageEmbed = [
     Action.Save,
@@ -102,7 +127,7 @@ export class SageEmbed extends V1Embed {
         params[Param.DisableWorksheetChange] = !!disableWorksheetChange;
         params[Param.HideWorksheetSelector] = !!hideWorksheetSelector;
         params[Param.HideEurekaSuggestions] = !showObjectSuggestions;
-        params[Param.HideSampleQuestions] = !hideSampleQuestions;
+        params[Param.HideSampleQuestions] = !!hideSampleQuestions;
         params[Param.HideActions] = [
             ...(params[Param.HideActions] ?? []),
             ...HiddenActionItemByDefaultForSageEmbed,
@@ -121,9 +146,17 @@ export class SageEmbed extends V1Embed {
         const path = 'eureka';
         const postHashObj = {};
         const tsPostHashParams = this.getThoughtSpotPostUrlParams();
+        const {
+            dataSource, searchOptions,
+        } = this.viewConfig;
 
-        if (this.viewConfig.searchQuery) postHashObj[Param.Query] = this.viewConfig.searchQuery;
-        if (this.viewConfig.dataSource) postHashObj[Param.WorksheetId] = this.viewConfig.dataSource;
+        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}`;
 

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

@@ -105,6 +105,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 = [
@@ -157,6 +165,7 @@ export class SearchEmbed extends TsEmbed {
             dataSource,
             dataSources,
             excludeRuntimeFiltersfromURL,
+            dataPanelV2 = false,
         } = this.viewConfig;
         const queryParams = this.getBaseQueryParams();
 
@@ -190,6 +199,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`,
             );
         });