@thoughtspot/visual-embed-sdk 1.29.0-alpha.2 → 1.29.0-alpha.4

package/src/embed/sage.spec.ts

@@ -12,7 +12,6 @@ import {
 const defaultConfig: SageViewConfig = {
     disableWorksheetChange: false,
     hideWorksheetSelector: false,
-    hideSearchBarTitle: false,
     hideSageAnswerHeader: false,
     hideAutocompleteSuggestions: false,
     hideSampleQuestions: false,
@@ -36,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`,
             );
         });
     });
@@ -61,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`,
             );
         });
     });
@@ -75,25 +74,11 @@ describe('Sage  embed tests', () => {
             ...defaultConfig,
             hideWorksheetSelector: true,
         });
-        sageEmbed.render();
+        await 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 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`,
             );
         });
     });
@@ -103,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`,
             );
         });
     });
@@ -117,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`,
             );
         });
     });
@@ -130,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`,
             );
         });
     });
@@ -144,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`,
             );
         });
     });
@@ -161,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`,
             );
         });
     });
@@ -178,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

@@ -7,9 +7,7 @@
  * @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';
 
@@ -54,7 +52,7 @@ 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
+     * 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.
@@ -65,8 +63,9 @@ export interface SageViewConfig
     isProductTour?: boolean;
     /**
      * Show or hide the search bar title.
+     * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      *
-     * @version SDK: 1.26.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;
     /**
@@ -136,16 +135,6 @@ 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.
  *
@@ -178,7 +167,6 @@ export class SageEmbed extends V1Embed {
             showObjectSuggestions,
             hideSampleQuestions,
             isProductTour,
-            hideSearchBarTitle,
             hideSageAnswerHeader,
             hideAutocompleteSuggestions,
         } = this.viewConfig;
@@ -195,12 +183,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);
     }

package/src/embed/ts-embed.spec.ts

@@ -1323,6 +1323,28 @@ describe('Unit test case for ts embed', () => {
                 done();
             });
         });
+
+        it('Should set the override locale for number/date and currency format', async () => {
+            jest.spyOn(baseInstance, 'getAuthPromise').mockResolvedValue(true);
+            init({
+                thoughtSpotHost: 'tshost',
+                authType: AuthType.None,
+                numberFormatLocale: 'en-US',
+                dateFormatLocale: 'en-IN',
+                currencyFormat: 'USD',
+            });
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+            });
+            await appEmbed.render();
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&numberFormatLocale=en-US&dateFormatLocale=en-IN&currencyFormat=USD${defaultParamsPost}#/home`,
+            );
+        });
     });
 
     describe('When destroyed', () => {

package/src/embed/ts-embed.ts

@@ -417,6 +417,15 @@ export class TsEmbed {
         if (this.embedConfig.pendoTrackingKey) {
             queryParams[Param.PendoTrackingKey] = this.embedConfig.pendoTrackingKey;
         }
+        if (this.embedConfig.numberFormatLocale) {
+            queryParams[Param.NumberFormatLocale] = this.embedConfig.numberFormatLocale;
+        }
+        if (this.embedConfig.dateFormatLocale) {
+            queryParams[Param.DateFormatLocale] = this.embedConfig.dateFormatLocale;
+        }
+        if (this.embedConfig.currencyFormat) {
+            queryParams[Param.CurrencyFormat] = this.embedConfig.currencyFormat;
+        }
 
         const {
             disabledActions,

package/src/errors.ts

@@ -1,6 +1,6 @@
 export const ERROR_MESSAGE = {
     INVALID_THOUGHTSPOT_HOST: 'Error parsing ThoughtSpot host. Please provide a valid URL.',
-    LIVEBOARD_VIZ_ID_VALIDATION: 'Please provide either liveboardId or pinboardId',
+    LIVEBOARD_VIZ_ID_VALIDATION: 'Please select a liveboard to embed.',
     TRIGGER_TIMED_OUT: 'Trigger timedout in getting response',
     SEARCHEMBED_BETA_WRANING_MESSAGE: 'Search Embed is in Beta in this release.',
     SAGE_EMBED_BETA_WARNING_MESSAGE: 'Sage Embed is in Beta in this release.',

package/src/types.ts

@@ -592,6 +592,24 @@ export interface EmbedConfig {
      * @version SDK: 1.27.9
      */
     disableSDKTracking?: boolean;
+    /**
+     * Overrides default/user preffered locale for date formatting
+     *
+     * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+     */
+    dateFormatLocale?: string;
+    /**
+     * Overrides default/user preffered locale for number formatting
+     *
+     * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+     */
+    numberFormatLocale?: string;
+    /**
+     * Format to be used for currency when currency format is set to infer from browser
+     *
+     * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+     */
+    currencyFormat?: string;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -3083,6 +3101,10 @@ export enum Param {
     OverrideNativeConsole = 'overrideConsoleLogs',
     enableAskSage = 'enableAskSage',
     CollapseSearchBarInitially= 'collapseSearchBarInitially',
+    DateFormatLocale = 'dateFormatLocale',
+    NumberFormatLocale = 'numberFormatLocale',
+    CurrencyFormat = 'currencyFormat',
+    IsFullAppEmbed = 'isFullAppEmbed',
 }
 
 /**