@thoughtspot/visual-embed-sdk 1.44.4 → 1.45.0

package/src/embed/liveboard.spec.ts

@@ -184,6 +184,21 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set isThisPeriodInDateFiltersEnabled to true in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            isThisPeriodInDateFiltersEnabled: true,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isThisPeriodInDateFiltersEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should set isLiveboardPermissionV2Enabled to true in url', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             isEnhancedFilterInteractivityEnabled: true,
@@ -214,6 +229,66 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set isLiveboardXLSXCSVDownloadEnabled to true in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isLiveboardXLSXCSVDownloadEnabled: true,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardXLSXCSVDownloadEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should set isLiveboardXLSXCSVDownloadEnabled to false in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isLiveboardXLSXCSVDownloadEnabled: false,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardXLSXCSVDownloadEnabled=false${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should set isGranularXLSXCSVSchedulesEnabled to true in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isGranularXLSXCSVSchedulesEnabled: true,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isGranularXLSXCSVSchedulesEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should set isGranularXLSXCSVSchedulesEnabled to false in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isGranularXLSXCSVSchedulesEnabled: false,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isGranularXLSXCSVSchedulesEnabled=false${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should set isLinkParametersEnabled to true in url', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             isLinkParametersEnabled: true,
@@ -518,48 +593,6 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
-    test('should add liveboardXLSXCSVDownload flag and set value to true to the iframe src', async () => {
-        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
-            ...defaultViewConfig,
-            liveboardId,
-            liveboardXLSXCSVDownload: true,
-        } as LiveboardViewConfig);
-        liveboardEmbed.render();
-        await executeAfterWait(() => {
-            expectUrlMatchesWithParams(
-                getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardXLSXCSVDownloadEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
-            );
-        });
-    });
-
-    test('should add liveboardXLSXCSVDownload flag and set value to false to the iframe src', async () => {
-        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
-            ...defaultViewConfig,
-            liveboardId,
-            liveboardXLSXCSVDownload: false,
-        } as LiveboardViewConfig);
-        liveboardEmbed.render();
-        await executeAfterWait(() => {
-            expectUrlMatchesWithParams(
-                getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardXLSXCSVDownloadEnabled=false&${prefixParams}#/embed/viz/${liveboardId}`,
-            );
-        });
-    });
-
-    test('should not add liveboardXLSXCSVDownload flag when undefined', async () => {
-        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
-            ...defaultViewConfig,
-            liveboardId,
-        } as LiveboardViewConfig);
-        liveboardEmbed.render();
-        await executeAfterWait(() => {
-            const iframeSrc = getIFrameSrc();
-            expect(iframeSrc).not.toContain('isLiveboardXLSXCSVDownloadEnabled');
-        });
-    });
-
     test('should add isCentralizedLiveboardFilterUXEnabled flag and set value to true to the iframe src', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -646,6 +679,7 @@ describe('Liveboard/viz embed tests', () => {
                     values: [1000],
                 },
             ],
+            excludeRuntimeFiltersfromURL: undefined,
         } as LiveboardViewConfig);
         liveboardEmbed.render();
         const runtimeFilter = 'col1=sales&op1=EQ&val1=1000';
@@ -890,6 +924,7 @@ describe('Liveboard/viz embed tests', () => {
                     value: 1,
                 },
             ],
+            excludeRuntimeParametersfromURL: undefined,
         } as LiveboardViewConfig);
         await liveboardEmbed.render();
         await executeAfterWait(() => {

package/src/embed/liveboard.ts

@@ -360,6 +360,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
      * ```
      */
     isPNGInScheduledEmailsEnabled?: boolean;
+    /**
+     * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @type {boolean}
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isLiveboardXLSXCSVDownloadEnabled: true,
+     * })
+     * ```
+     */
+    isLiveboardXLSXCSVDownloadEnabled?: boolean;
+    /**
+     * This flag is used to enable/disable the granular XLSX/CSV schedules feature
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @type {boolean}
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isGranularXLSXCSVSchedulesEnabled: true,
+     * })
+     * ```
+     */
+    isGranularXLSXCSVSchedulesEnabled?: boolean;
     /**
      * This flag is used to enable the full height lazy load data.
      *
@@ -512,13 +544,15 @@ export class LiveboardEmbed extends V1Embed {
             isForceRedirect,
             dataSourceId,
             coverAndFilterOptionInPDF = false,
-            liveboardXLSXCSVDownload,
             isLiveboardStylingAndGroupingEnabled,
             isPNGInScheduledEmailsEnabled = false,
+            isLiveboardXLSXCSVDownloadEnabled = false,
+            isGranularXLSXCSVSchedulesEnabled = false,
             showSpotterLimitations,
             isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
             updatedSpotterChatPrompt,
+            isThisPeriodInDateFiltersEnabled,
         } = this.viewConfig;
 
         const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
@@ -593,6 +627,14 @@ export class LiveboardEmbed extends V1Embed {
             params[Param.isPNGInScheduledEmailsEnabled] = isPNGInScheduledEmailsEnabled;
         }
 
+        if (isLiveboardXLSXCSVDownloadEnabled !== undefined) {
+            params[Param.isLiveboardXLSXCSVDownloadEnabled] = isLiveboardXLSXCSVDownloadEnabled;
+        }
+
+        if (isGranularXLSXCSVSchedulesEnabled !== undefined) {
+            params[Param.isGranularXLSXCSVSchedulesEnabled] = isGranularXLSXCSVSchedulesEnabled;
+        }
+
         if (showSpotterLimitations !== undefined) {
             params[Param.ShowSpotterLimitations] = showSpotterLimitations;
         }
@@ -607,6 +649,10 @@ export class LiveboardEmbed extends V1Embed {
             ] = isCentralizedLiveboardFilterUXEnabled;
         }
 
+        if (isThisPeriodInDateFiltersEnabled !== undefined) {
+            params[Param.IsThisPeriodInDateFiltersEnabled] = isThisPeriodInDateFiltersEnabled;
+        }
+
         params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
         params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
         params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;
@@ -619,10 +665,6 @@ export class LiveboardEmbed extends V1Embed {
         params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
         params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
 
-        if (liveboardXLSXCSVDownload !== undefined) {
-            params[Param.LiveboardXLSXCSVDownload] = !!liveboardXLSXCSVDownload;
-        }
-
         const queryParams = getQueryParamString(params, true);
 
         return params;

package/src/embed/pinboard.spec.ts

@@ -217,6 +217,7 @@ describe('Pinboard/viz embed tests', () => {
                     values: [1000],
                 },
             ],
+            excludeRuntimeFiltersfromURL: undefined,
         } as LiveboardViewConfig);
         liveboardEmbed.render();
         const runtimeFilter = 'col1=sales&op1=EQ&val1=1000';

package/src/embed/search.spec.ts

@@ -287,6 +287,7 @@ describe('Search embed tests', () => {
                     values: ['berkeley'],
                 },
             ],
+            excludeRuntimeFiltersfromURL: undefined,
         });
         searchEmbed.render();
         const runtimeFilter = 'col1=city&op1=EQ&val1=berkeley';
@@ -485,6 +486,7 @@ describe('Search embed tests', () => {
                     value: 1,
                 },
             ],
+            excludeRuntimeParametersfromURL: false,
         });
         searchEmbed.render();
         await executeAfterWait(() => {
@@ -508,6 +510,20 @@ describe('Search embed tests', () => {
         });
     });
 
+    test('should set isThisPeriodInDateFiltersEnabled to true in url', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            isThisPeriodInDateFiltersEnabled: true,
+        });
+        searchEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=true&useLastSelectedSources=false&isThisPeriodInDateFiltersEnabled=true${prefixParams}#/embed/saved-answer/${answerId}`,
+            );
+        });
+    });
+
     test('should set dataPanelCustomGroupsAccordionInitialState to EXPAND_FIRST when passed', async () => {
         const searchEmbed = new SearchBarEmbed(getRootEl() as any, {
             ...defaultViewConfig,

package/src/embed/search.ts

@@ -157,6 +157,7 @@ export interface SearchViewConfig
      *    ... // other embed view config
      *    forceTable:true,
      * })
+     * ```
      */
     forceTable?: boolean;
     /**
@@ -339,7 +340,12 @@ export class SearchEmbed extends TsEmbed {
     protected viewConfig: SearchViewConfig;
 
     constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig) {
-        viewConfig.embedComponentType = 'SearchEmbed';
+        viewConfig = {
+            embedComponentType: 'SearchEmbed',
+            excludeRuntimeFiltersfromURL: true,
+            excludeRuntimeParametersfromURL: true,
+            ...viewConfig,
+        }
         super(domSelector, viewConfig);
     }
 
@@ -396,6 +402,7 @@ export class SearchEmbed extends TsEmbed {
             excludeRuntimeParametersfromURL,
             excludeSearchTokenStringFromURL,
             collapseSearchBar = true,
+            isThisPeriodInDateFiltersEnabled,
         } = this.viewConfig;
         const queryParams = this.getBaseQueryParams();
 
@@ -438,6 +445,10 @@ export class SearchEmbed extends TsEmbed {
             queryParams[Param.FocusSearchBarOnRender] = focusSearchBarOnRender;
         }
 
+        if (isThisPeriodInDateFiltersEnabled !== undefined) {
+            queryParams[Param.IsThisPeriodInDateFiltersEnabled] = isThisPeriodInDateFiltersEnabled;
+        }
+
         queryParams[Param.DataPanelV2Enabled] = dataPanelV2;
         queryParams[Param.DataSourceMode] = this.getDataSourceMode();
 

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

@@ -559,6 +559,7 @@ describe('Unit test case for ts embed', () => {
             const searchEmbed = new SearchEmbed(getRootEl(), {
                 ...defaultViewConfig,
                 runtimeFilters: mockRuntimeFilters,
+                excludeRuntimeFiltersfromURL: undefined,
             });
             searchEmbed.render();
             const mockPort: any = {

package/src/embed/ts-embed.ts

@@ -195,8 +195,8 @@ export class TsEmbed {
         this.eventHandlerMap = new Map();
         this.isError = false;
         this.viewConfig = {
-            excludeRuntimeFiltersfromURL: false,
-            excludeRuntimeParametersfromURL: false,
+            excludeRuntimeFiltersfromURL: true,
+            excludeRuntimeParametersfromURL: true,
             ...viewConfig,
         };
         this.registerAppInit();
@@ -1756,7 +1756,11 @@ export class V1Embed extends TsEmbed {
 
     constructor(domSelector: DOMSelector, viewConfig: ViewConfig) {
         super(domSelector, viewConfig);
-        this.viewConfig = { excludeRuntimeFiltersfromURL: false, ...viewConfig };
+        this.viewConfig = {
+            excludeRuntimeFiltersfromURL: true,
+            excludeRuntimeParametersfromURL: true,
+            ...viewConfig,
+        };
     }
 
     /**