@thoughtspot/visual-embed-sdk 1.33.5 → 1.33.6

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

@@ -439,6 +439,20 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * ```
                 */
             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}
@@ -961,6 +975,20 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * ```
                 */
             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;
     }
     /**
         * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -4951,6 +4979,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
             ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
             LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled",
+            HideIrrelevantFiltersInTab = "hideIrrelevantFiltersAtTabLevel",
             SpotterEnabled = "isSpotterExperienceEnabled",
             IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled",
             OverrideOrgId = "orgId"
@@ -5993,7 +6022,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
                 */
-            DisableChipReorder = "disableChipReorder"
+            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 {
             getAnswer?: (offset: number, batchSize: number) => any;

package/package.json

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

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/types.ts

@@ -3295,6 +3295,7 @@ export enum Param {
     ShowLiveboardVerifiedBadge = 'showLiveboardVerifiedBadge',
     ShowLiveboardReverifyBanner = 'showLiveboardReverifyBanner',
     LiveboardHeaderV2 = 'isLiveboardHeaderV2Enabled',
+    HideIrrelevantFiltersInTab = 'hideIrrelevantFiltersAtTabLevel',
     SpotterEnabled = 'isSpotterExperienceEnabled',
     IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
     OverrideOrgId = 'orgId',
@@ -4356,6 +4357,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 {