@thoughtspot/visual-embed-sdk 1.33.5 → 1.33.7

package/src/embed/app.spec.ts

@@ -420,6 +420,21 @@ describe('App embed tests', () => {
         });
     });
 
+    test('Should add hideIrrelevantFiltersAtTabLevel flag to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            hideIrrelevantChipsInLiveboardTabs: false,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&hideIrrelevantFiltersAtTabLevel=false${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add showLiveboardVerifiedBadge flag to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/app.ts

@@ -417,6 +417,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * ```
      */
     showLiveboardVerifiedBadge?: boolean;
+    /**
+     * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+     * @type {boolean}
+     * @default false
+     * @version SDK: 1.35.0 | ThoughtSpot:10.5.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed-container', {
+     *    ... // other options
+     *    hideIrrelevantChipsInLiveboardTabs: true,
+     * })
+     * ```
+     */
+    hideIrrelevantChipsInLiveboardTabs?: boolean;
     /**
      * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
      * @type {boolean}
@@ -500,6 +514,7 @@ export class AppEmbed extends V1Embed {
             isLiveboardCompactHeaderEnabled = false,
             showLiveboardVerifiedBadge = true,
             showLiveboardReverifyBanner = true,
+            hideIrrelevantChipsInLiveboardTabs = false,
             homePageSearchBarMode,
             isUnifiedSearchExperienceEnabled = true,
         } = this.viewConfig;
@@ -517,6 +532,7 @@ export class AppEmbed extends V1Embed {
         params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
         params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;
         params[Param.ShowLiveboardReverifyBanner] = showLiveboardReverifyBanner;
+        params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
         params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
 
         params = this.getBaseQueryParams(params);

package/src/embed/bodyless-conversation.ts

@@ -24,6 +24,7 @@ interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
 
 class ConversationMessage extends TsEmbed {
     constructor(container: HTMLElement, protected viewConfig: ConversationMessageViewConfig) {
+        viewConfig.embedComponentType = 'bodyless-conversation';
         super(container, viewConfig);
     }
 

package/src/embed/conversation.ts

@@ -41,6 +41,7 @@ export interface ConversationViewConfig extends ViewConfig {
  */
 export class ConversationEmbed extends TsEmbed {
     constructor(container: HTMLElement, protected viewConfig: ConversationViewConfig) {
+        viewConfig.embedComponentType = 'conversation';
         super(container, viewConfig);
     }
 

package/src/embed/liveboard.spec.ts

@@ -289,6 +289,22 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('Should add hideIrrelevantFiltersAtTabLevel flag to the iframe src', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            hideIrrelevantChipsInLiveboardTabs: true,
+        } as LiveboardViewConfig);
+
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&hideIrrelevantFiltersAtTabLevel=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should not append runtime filters in URL if excludeRuntimeFiltersfromURL is true', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/liveboard.ts

@@ -324,6 +324,20 @@ export interface LiveboardViewConfig
      * ```
      */
     showLiveboardReverifyBanner?: boolean;
+    /**
+     * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+     * @type {boolean}
+     * @default false
+     * @version SDK: 1.35.0 | ThoughtSpot:10.5.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    hideIrrelevantChipsInLiveboardTabs: true,
+     * })
+     * ```
+     */
+    hideIrrelevantChipsInLiveboardTabs?: boolean;
 }
 
 /**
@@ -380,6 +394,7 @@ export class LiveboardEmbed extends V1Embed {
             isLiveboardCompactHeaderEnabled = false,
             showLiveboardVerifiedBadge = true,
             showLiveboardReverifyBanner = true,
+            hideIrrelevantChipsInLiveboardTabs = false,
             enableAskSage,
             enable2ColumnLayout,
             dataPanelV2 = false,
@@ -434,6 +449,7 @@ export class LiveboardEmbed extends V1Embed {
         params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
         params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;
         params[Param.ShowLiveboardReverifyBanner] = showLiveboardReverifyBanner;
+        params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
 
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;

package/src/embed/sage.spec.ts

@@ -18,6 +18,7 @@ const defaultConfig: SageViewConfig = {
     hideAutocompleteSuggestions: false,
     hideSampleQuestions: false,
     isProductTour: false,
+    dataPanelV2: false,
 };
 
 const thoughtSpotHost = 'tshost';
@@ -42,7 +43,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -53,7 +54,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=true&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=true&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -67,7 +68,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=true&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=true&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -81,7 +82,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -95,7 +96,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=true&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=true&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -109,7 +110,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=true&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=true&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -122,7 +123,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });
@@ -136,7 +137,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `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`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka?worksheet=worksheet-id`,
             );
         });
     });
@@ -153,7 +154,7 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `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`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&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`,
             );
         });
     });
@@ -170,7 +171,21 @@ describe('Sage  embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatch(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&hideAction=%5B%22reportError%22%5D#/embed/eureka?executeSearch=true&query=test-query`,
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&hideAction=%5B%22reportError%22%5D#/embed/eureka?executeSearch=true&query=test-query`,
+            );
+        });
+    });
+
+    test('should set enableDataPanelV2 to true if data panel v2 flag is true', async () => {
+        const sageEmbed = new SageEmbed(getRootEl(), {
+            ...defaultConfig,
+            dataPanelV2: true,
+        });
+        await sageEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatch(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=true&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
             );
         });
     });

package/src/embed/sage.ts

@@ -151,6 +151,7 @@ export class SageEmbed extends V1Embed {
             disableWorksheetChange,
             hideWorksheetSelector,
             showObjectSuggestions,
+            dataPanelV2,
             hideSampleQuestions,
             isProductTour,
             hideSageAnswerHeader,
@@ -158,6 +159,7 @@ export class SageEmbed extends V1Embed {
         } = this.viewConfig;
 
         const params = this.getBaseQueryParams();
+        params[Param.DataPanelV2Enabled] = !!dataPanelV2;
         params[Param.IsSageEmbed] = true;
         params[Param.DisableWorksheetChange] = !!disableWorksheetChange;
         params[Param.HideWorksheetSelector] = !!hideWorksheetSelector;

package/src/types.ts

@@ -2409,10 +2409,14 @@ export enum HostEvent {
      */
     Reload = 'reload',
     /**
-     * Get current iframe src
+     * Get iframe URL for the current embed view on the playground.
+     * Developers can use this URL to embed a ThoughtSpot object
+     * in apps like Salesforce or Sharepoint.
+     *
      * @example
      * ```js
-     * const frameUrl = AppEmbed.trigger(HostEvent.GetIframeUrl)
+     * const url = embed.trigger(HostEvent.GetIframeUrl);
+     * console.log("iFrameURL",url);
      * ```
      * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
      */
@@ -2529,6 +2533,9 @@ export enum HostEvent {
      * Liveboard filters, runtime filters applied on visualizations on a
      * Liveboard, and Liveboard layout, changes to visualizations such as
      * sorting, toggling of legends, and data drill down.
+     * For more information, see
+     * link:https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#transient-lb-content[Liveboard data with unsaved changes].
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
@@ -3295,6 +3302,7 @@ export enum Param {
     ShowLiveboardVerifiedBadge = 'showLiveboardVerifiedBadge',
     ShowLiveboardReverifyBanner = 'showLiveboardReverifyBanner',
     LiveboardHeaderV2 = 'isLiveboardHeaderV2Enabled',
+    HideIrrelevantFiltersInTab = 'hideIrrelevantFiltersAtTabLevel',
     SpotterEnabled = 'isSpotterExperienceEnabled',
     IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
     OverrideOrgId = 'orgId',
@@ -3418,8 +3426,8 @@ export enum Action {
      */
     Share = 'share',
     /**
-     * The **Add filter** action on a Liveboard and Search page.
-     * Allows adding filters to Answers and visualizations on a Liveboard.
+     * The **Add filter** action on a Liveboard page.
+     * Allows adding filters to visualizations on a Liveboard.
      * @example
      * ```js
      * disabledActions: [Action.AddFilter]
@@ -3428,8 +3436,8 @@ export enum Action {
     AddFilter = 'addFilter',
     /**
      * The **Add Data Panel Objects** action on the data panel v2.
-     * Allows to show action menu to add different objects (like
-     * formulas, parameters) in data panel v2.
+     * Allows to show action menu to add different objects (such as
+     * formulas, Parameters) in data panel new experience.
      * @example
      * ```js
      * disabledActions: [Action.AddDataPanelObjects]
@@ -3438,9 +3446,9 @@ export enum Action {
      */
     AddDataPanelObjects = 'addDataPanelObjects',
     /**
-     * Filter configuration options on a Liveboard and Search page.
-     * Allows configuring filter options when adding filters to a
-     * Liveboard or Answer.
+     * Filter configuration options on a Liveboard page.
+     * Allows configuring filters on a
+     * Liveboard.
      * @example
      * ```js
      * disabledActions: [Action.ConfigureFilter]
@@ -4356,6 +4364,16 @@ export enum Action {
      * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
      */
     DisableChipReorder = 'disableChipReorder',
+
+    /**
+     * Action ID for Hide Irrelevant filters button
+     *  @example
+     * ```js
+     * hiddenAction: [Action.ChangeFilterVisibilityInTab]
+     * ```
+     *  @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
+     */
+    ChangeFilterVisibilityInTab = 'changeFilterVisibilityInTab',
 }
 
 export interface AnswerServiceType {