@thoughtspot/visual-embed-sdk 1.25.0-alpha.2 → 1.25.0-alpha.3

package/src/embed/sage.spec.ts

@@ -10,10 +10,13 @@ import {
 } from '../test/test-utils';
 
 const defaultConfig: SageViewConfig = {
-    showObjectResults: true,
     disableWorksheetChange: false,
-    hideWorksheetSelector: true,
-    showObjectSuggestions: false,
+    hideWorksheetSelector: false,
+    hideSearchBarTitle: false,
+    hideSageAnswerHeader: false,
+    hideAutocompleteSuggestions: false,
+    hideSampleQuestions: false,
+    isProductTour: false,
 };
 
 const thoughtSpotHost = 'tshost';
@@ -37,10 +40,119 @@ describe('Sage  embed tests', () => {
         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`,
+                `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`,
             );
         });
     });
+
+    test('should render sage with product tour flag set', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), { ...defaultConfig, isProductTour: true });
+        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`,
+            );
+        });
+    });
+
+    test('should render sage with disable worksheet change flag', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            ...defaultConfig,
+            disableWorksheetChange: true,
+        });
+        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`,
+            );
+        });
+    });
+
+    test('should render sage with hide worksheet selector flag', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            ...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 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`,
+            );
+        });
+    });
+
+    test('should render sage with hide Sage Answer Header flag', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            ...defaultConfig,
+            hideSageAnswerHeader: true,
+        });
+        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`,
+            );
+        });
+    });
+
+    test('should render sage with hide Autocomplete suggestions flag', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            ...defaultConfig,
+            hideAutocompleteSuggestions: true,
+        });
+        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`,
+            );
+        });
+    });
+
+    test('should render sage with deprecated showObjectSuggestions flag', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            showObjectSuggestions: true,
+        });
+        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`,
+            );
+        });
+    });
+
+    test('embed url include pre-seed dataSource without populating searchOptions', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            ...defaultConfig,
+            dataSource: 'worksheet-id',
+        });
+        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`,
+            );
+        });
+    });
+
     test('embed url include pre-seed dataSource and query', async () => {
         const sageEmbed = new SageEmbed(getRootEl(), {
             ...defaultConfig,
@@ -53,10 +165,11 @@ describe('Sage  embed tests', () => {
         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`,
+                `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-query`,
             );
         });
     });
+
     test('embed url include pre-seed execute flag with query', async () => {
         const sageEmbed = new SageEmbed(getRootEl(), {
             ...defaultConfig,
@@ -69,7 +182,7 @@ describe('Sage  embed tests', () => {
         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`,
+                `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?query=test-query&executeSearch=true`,
             );
         });
     });

package/src/embed/sage.ts

@@ -18,7 +18,7 @@ import { V1Embed } from './ts-embed';
  */
 export interface SearchOptions {
     /**
-     * The tml string to load the answer
+     * The query string to pre-fill in natual language search bar
      */
     searchQuery: string;
     /**
@@ -37,34 +37,74 @@ export interface SearchOptions {
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
  * @group Embed components
  */
-export interface SageViewConfig extends ViewConfig {
+export interface SageViewConfig
+    extends Omit<
+        ViewConfig,
+        'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'
+    > {
     /**
      * 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
      */
     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.
+     * 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;
+    /**
+     * flag to hide search bar title. default false.
+     *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
+     */
+    hideSearchBarTitle?: boolean;
+    /**
+     * flag to disable Sage Answer header(`AI Answer` title section on top of the Sage
+     * answer). default false.
+     *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
+     */
+    hideSageAnswerHeader?: boolean;
     /**
      * flag to disable changing worksheet. default false.
+     *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
      */
-    disableWorksheetChange?: boolean,
+    disableWorksheetChange?: boolean;
     /**
      * flag to hide worksheet selector. default false.
      */
-    hideWorksheetSelector?: boolean,
+    hideWorksheetSelector?: boolean;
     /**
-     * If set to true, the search suggestions will contain existing
-     * liveboards and answers in addition with the autocomplete
+     * If set to true, the search bar auto complete search suggestions will not be shown.
+     * default false
      *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
      */
-    showObjectSuggestions?: boolean;
+    hideAutocompleteSuggestions?: boolean;
     /**
-     * The query string to pre-fill in natual language search bar
+     * If set to false, the auto complete search suggestions not be shown
+     *
+     * @deprecated currently, object suggestions will not be shown for sage embed
+     * earlier this flag was used to show Auto complete suggestions
      */
-    searchQuery?: string;
+    showObjectSuggestions?: boolean;
     /**
      * If set to true, sample questions would be hidden to user.
      * These sample questions are autogenerated based on selected datasource.
+     *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
      */
     hideSampleQuestions?: boolean;
     /**
@@ -73,9 +113,10 @@ export interface SageViewConfig extends ViewConfig {
     dataSource?: string;
     /**
      * Configuration for search options
+     *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
      */
     searchOptions?: SearchOptions;
-
 }
 export const HiddenActionItemByDefaultForSageEmbed = [
     Action.Save,
@@ -115,21 +156,30 @@ export class SageEmbed extends V1Embed {
      */
     protected getEmbedParams(): string {
         const {
-            showObjectResults,
             disableWorksheetChange,
             hideWorksheetSelector,
             showObjectSuggestions,
             hideSampleQuestions,
+            isProductTour,
+            hideSearchBarTitle,
+            hideSageAnswerHeader,
+            hideAutocompleteSuggestions,
         } = this.viewConfig;
 
         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.HideEurekaSuggestions] = !!hideAutocompleteSuggestions;
+        if (showObjectSuggestions) {
+            params[Param.HideEurekaSuggestions] = !showObjectSuggestions;
+            // support backwards compatibility
+        }
         params[Param.HideSampleQuestions] = !!hideSampleQuestions;
+        params[Param.IsProductTour] = !!isProductTour;
+        params[Param.HideSearchBarTitle] = !!hideSearchBarTitle;
+        params[Param.HideSageAnswerHeader] = !!hideSageAnswerHeader;
         params[Param.HideActions] = [
             ...(params[Param.HideActions] ?? []),
             ...HiddenActionItemByDefaultForSageEmbed,

package/src/embed/search-bar.tsx

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

package/src/embed/search.ts

@@ -50,7 +50,11 @@ export interface SearchOptions {
  *
  * @group Embed components
  */
-export interface SearchViewConfig extends ViewConfig {
+export interface SearchViewConfig
+    extends Omit<
+        ViewConfig,
+        'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'
+    > {
     /**
      * If set to true, the data sources panel is collapsed on load,
      * but can be expanded manually.

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

@@ -163,7 +163,7 @@ describe('Unit test case for ts embed', () => {
                 HomepageModule.Learning,
             ];
 
-            const searchEmbed = new SearchEmbed(getRootEl(), {
+            const searchEmbed = new AppEmbed(getRootEl(), {
                 ...defaultViewConfig,
                 hiddenHomepageModules: mockedHiddenHomepageModules,
             });
@@ -200,7 +200,7 @@ describe('Unit test case for ts embed', () => {
                 HomepageModule.Watchlist,
             ];
 
-            const searchEmbed = new SearchEmbed(getRootEl(), {
+            const searchEmbed = new AppEmbed(getRootEl(), {
                 ...defaultViewConfig,
                 reorderedHomepageModules: mockedReorderedHomepageModules,
             });
@@ -317,7 +317,7 @@ describe('Unit test case for ts embed', () => {
                 HomeLeftNavItem.Documentation,
             ];
 
-            const searchEmbed = new SearchEmbed(getRootEl(), {
+            const searchEmbed = new AppEmbed(getRootEl(), {
                 ...defaultViewConfig,
                 hiddenHomeLeftNavItems: mockedHiddenHomeLeftNavItems,
             });

package/src/embed/ts-embed.ts

@@ -384,9 +384,6 @@ export class TsEmbed {
             contextMenuTrigger,
             linkOverride,
             insertInToSlide,
-            hideLiveboardHeader,
-            showLiveboardDescription,
-            showLiveboardTitle,
         } = this.viewConfig;
 
         if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
@@ -454,15 +451,6 @@ export class TsEmbed {
         if (insertInToSlide) {
             queryParams[Param.ShowInsertToSlide] = insertInToSlide;
         }
-        if (hideLiveboardHeader) {
-            queryParams[Param.HideLiveboardHeader] = hideLiveboardHeader;
-        }
-        if (showLiveboardDescription) {
-            queryParams[Param.ShowLiveboardDescription] = showLiveboardDescription;
-        }
-        if (showLiveboardTitle) {
-            queryParams[Param.ShowLiveboardTitle] = showLiveboardTitle;
-        }
 
         return queryParams;
     }

package/src/types.ts

@@ -712,27 +712,6 @@ export interface ViewConfig {
      * @hidden
      */
     excludeRuntimeFiltersfromURL?: boolean;
-    /**
-     * Boolean to hide liveboard header
-     *
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-     * @default false
-     */
-    hideLiveboardHeader?: boolean;
-    /**
-     * Boolean to show liveboard title
-     *
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-     * @default false
-     */
-    showLiveboardTitle?: boolean;
-    /**
-     * Boolean to show liveboard description
-     *
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-     * @default false
-     */
-    showLiveboardDescription?: boolean;
     /**
      * The list of tab IDs to hide from the embedded.
      * This Tabs will be hidden from their respective LBs.
@@ -760,6 +739,7 @@ export interface ViewConfig {
     /**
      * reordering the home page modules
      * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
+     *
      * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
      */
     reorderedHomepageModules?: HomepageModule[];
@@ -2275,6 +2255,7 @@ export enum Param {
     DisableWorksheetChange = 'disableWorksheetChange',
     HideEurekaResults = 'hideEurekaResults',
     HideEurekaSuggestions = 'hideEurekaSuggestions',
+    HideAutocompleteSuggestions = 'hideAutocompleteSuggestions',
     HideLiveboardHeader = 'hideLiveboardHeader',
     ShowLiveboardDescription = 'showLiveboardDescription',
     ShowLiveboardTitle = 'showLiveboardTitle',
@@ -2287,6 +2268,10 @@ export enum Param {
     HideHomepageLeftNav = 'hideHomepageLeftNav',
     ModularHomeExperienceEnabled = 'modularHomeExperience',
     PendoTrackingKey = 'additionalPendoKey',
+    LiveboardHeaderSticky = 'isLiveboardHeaderSticky',
+    IsProductTour = 'isProductTour',
+    HideSearchBarTitle = 'hideSearchBarTitle',
+    HideSageAnswerHeader = 'hideSageAnswerHeader',
 }
 
 /**
@@ -3126,6 +3111,16 @@ export enum Action {
      *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     PersonalisedViewsDropdown = 'personalisedViewsDropdown',
+    /**
+     * Action ID for Liveboard Users ( Recently Visited / social proof )
+     *
+     *  @example
+     * ```js
+     * disabledActions: [Action.LiveboardUsers]
+     * ```
+     *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+     */
+    LiveboardUsers = 'liveboardUsers',
 }
 
 export interface AnswerServiceType {

package/src/utils.spec.ts

@@ -32,6 +32,19 @@ describe('unit test for utils', () => {
         ).toBe('bar=baz');
     });
 
+    test('getFilterQuery should encode URL params', () => {
+        expect(getFilterQuery([])).toBe(null);
+
+        expect(
+            getFilterQuery([
+                {
+                    columnName: 'foo+foo',
+                    operator: RuntimeFilterOp.NE,
+                    values: ['bar+'],
+                },
+            ]),
+        ).toBe('col1=foo%2Bfoo&op1=NE&val1=bar%2B');
+    });
     test('getFilterQuery', () => {
         expect(getFilterQuery([])).toBe(null);
 

package/src/utils.ts

@@ -31,9 +31,9 @@ export const getFilterQuery = (runtimeFilters: RuntimeFilter[]): string => {
         const filters = runtimeFilters.map((filter, valueIndex) => {
             const index = valueIndex + 1;
             const filterExpr = [];
-            filterExpr.push(`col${index}=${filter.columnName}`);
+            filterExpr.push(`col${index}=${encodeURIComponent(filter.columnName)}`);
             filterExpr.push(`op${index}=${filter.operator}`);
-            filterExpr.push(filter.values.map((value) => `val${index}=${value}`).join('&'));
+            filterExpr.push(filter.values.map((value) => `val${index}=${encodeURIComponent(value)}`).join('&'));
 
             return filterExpr.join('&');
         });