SCAL-265809 SDK flag to control LB filter UX v2 in TSE (#326)

Author: fathima-nooha

src/embed/app.spec.ts

@@ -414,6 +414,34 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set isCentralizedLiveboardFilterUXEnabled to true in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            isCentralizedLiveboardFilterUXEnabled: true,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isCentralizedLiveboardFilterUXEnabled=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('should set isCentralizedLiveboardFilterUXEnabled to false in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            isCentralizedLiveboardFilterUXEnabled: false,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isCentralizedLiveboardFilterUXEnabled=false${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add the tag to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

src/embed/app.ts

@@ -684,6 +684,7 @@ export class AppEmbed extends V1Embed {
             liveboardXLSXCSVDownload = false,
             isLiveboardStylingAndGroupingEnabled,
             isPNGInScheduledEmailsEnabled = false,
+            isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
         } = this.viewConfig;
 
@@ -780,6 +781,12 @@ export class AppEmbed extends V1Embed {
             params[Param.isLinkParametersEnabled] = isLinkParametersEnabled;
         }
 
+        if (isCentralizedLiveboardFilterUXEnabled != undefined) {
+            params[
+                Param.isCentralizedLiveboardFilterUXEnabled
+            ] = isCentralizedLiveboardFilterUXEnabled;
+        }
+
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
         params[Param.ModularHomeExperienceEnabled] = modularHomeExperience;

src/embed/liveboard.spec.ts

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

src/embed/liveboard.ts

@@ -477,6 +477,7 @@ export class LiveboardEmbed extends V1Embed {
             isLiveboardStylingAndGroupingEnabled,
             isPNGInScheduledEmailsEnabled = false,
             showSpotterLimitations,
+            isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
         } = this.viewConfig;
 
@@ -557,6 +558,12 @@ export class LiveboardEmbed extends V1Embed {
             params[Param.isLinkParametersEnabled] = isLinkParametersEnabled;
         }
 
+        if (isCentralizedLiveboardFilterUXEnabled !== undefined) {
+            params[
+                Param.isCentralizedLiveboardFilterUXEnabled
+            ] = isCentralizedLiveboardFilterUXEnabled;
+        }
+
         params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
         params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
         params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;

src/types.ts

@@ -1512,6 +1512,24 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     liveboardXLSXCSVDownload?: boolean;
+    /**
+     * This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
+     * When enabled, a unified modal is used to manage and update multiple filters at once,
+     * replacing the older individual filter interactions.
+     * To enable this feature on your instance, contact ThoughtSpot Support.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isCentralizedLiveboardFilterUXEnabled: true,
+     * })
+     * ```
+     */
+    isCentralizedLiveboardFilterUXEnabled?: boolean;
     /**
      * This flag is used to enable or disable the link parameters in liveboard.
      *
@@ -4366,6 +4384,7 @@ export enum Param {
     RootMarginForLazyLoad = 'rootMarginForLazyLoad',
     LiveboardXLSXCSVDownload = 'isLiveboardXLSXCSVDownloadEnabled',
     isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
+    isCentralizedLiveboardFilterUXEnabled = 'isCentralizedLiveboardFilterUXEnabled',
     isLinkParametersEnabled = 'isLinkParametersEnabled',
     EnablePastConversationsSidebar = 'enablePastConversationsSidebar',
 }