@thoughtspot/visual-embed-sdk 1.41.0-pre-render-1 → 1.41.0

package/src/embed/liveboard.spec.ts

@@ -368,6 +368,36 @@ 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 append runtime filters in URL if excludeRuntimeFiltersfromURL is true', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -601,14 +631,6 @@ describe('Liveboard/viz embed tests', () => {
 
     test('navigateToLiveboard should trigger the navigate event with the correct path', async (done) => {
         mockMessageChannel();
-        // mock getSessionInfo
-        jest.spyOn(SessionInfoService, 'getSessionInfo').mockResolvedValue({
-            releaseVersion: '1.0.0',
-            userGUID: '1234567890',
-            currentOrgId: 1,
-            privileges: [],
-            mixpanelToken: '1234567890',
-        });
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
         } as LiveboardViewConfig);
@@ -619,30 +641,16 @@ describe('Liveboard/viz embed tests', () => {
             postMessageToParent(iframe.contentWindow, {
                 type: EmbedEvent.APP_INIT,
             });
-            postMessageToParent(iframe.contentWindow, {
-                type: EmbedEvent.AuthInit,
-            });
-            liveboardEmbed.navigateToLiveboard('lb1', 'viz1');
         });
-
         executeAfterWait(() => {
+            liveboardEmbed.navigateToLiveboard('lb1', 'viz1');
             expect(onSpy).toHaveBeenCalledWith(HostEvent.Navigate, 'embed/viz/lb1/viz1');
             done();
-        }, 1002);
+        });
     });
 
     test('navigateToLiveboard with preRender', async (done) => {
         mockMessageChannel();
-
-        // mock getSessionInfo
-        jest.spyOn(SessionInfoService, 'getSessionInfo').mockResolvedValue({
-            releaseVersion: '1.0.0',
-            userGUID: '1234567890',
-            currentOrgId: 1,
-            privileges: [],
-            mixpanelToken: '1234567890',
-        });
-
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
             preRenderId: 'test',
@@ -654,15 +662,12 @@ describe('Liveboard/viz embed tests', () => {
             postMessageToParent(iframe.contentWindow, {
                 type: EmbedEvent.APP_INIT,
             });
-            postMessageToParent(iframe.contentWindow, {
-                type: EmbedEvent.AuthInit,
-            });
         });
         executeAfterWait(() => {
             liveboardEmbed.navigateToLiveboard('lb1', 'viz1');
             expect(onSpy).toHaveBeenCalledWith(HostEvent.Navigate, 'embed/viz/lb1/viz1');
             done();
-        }, 1002);
+        });
     });
     test('should set runtime parametere values in url params', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
@@ -721,12 +726,6 @@ describe('Liveboard/viz embed tests', () => {
     });
 
     describe('PreRender flow for liveboard embed', () => {
-        beforeAll(() => {
-            init({
-                thoughtSpotHost: "http://tshost",
-                authType: AuthType.None,
-            });
-        });
         test('it should preRender generic with liveboard id is not passed', async (done) => {
             const consoleSpy = jest.spyOn(console, 'error');
             const libEmbed = new LiveboardEmbed(getRootEl(), {
@@ -853,7 +852,7 @@ describe('Liveboard/viz embed tests', () => {
                 done();
             });
         });
-
+       
         test('it should navigateToLiveboard with liveboard id is not passed with AuthInit event', async (done) => {
             mockMessageChannel();
             const consoleSpy = jest.spyOn(console, 'error');
@@ -918,6 +917,7 @@ describe('Liveboard/viz embed tests', () => {
                 done();
             }, 1005);
         });
+
     });
 
     describe('LazyLoadingForFullHeight functionality', () => {

package/src/embed/liveboard.ts

@@ -408,12 +408,6 @@ export class LiveboardEmbed extends V1Embed {
      * embedded Liveboard or visualization.
      */
     protected getEmbedParams() {
-        const params = this.getEmbedParamsObject();
-        const queryParams = getQueryParamString(params, true);
-        return queryParams;
-    }
-
-    protected getEmbedParamsObject() {
         let params: any = {};
         params = this.getBaseQueryParams(params);
         const {
@@ -441,6 +435,7 @@ export class LiveboardEmbed extends V1Embed {
             isForceRedirect,
             dataSourceId,
             coverAndFilterOptionInPDF = false,
+            liveboardXLSXCSVDownload = false,
             isLiveboardStylingAndGroupingEnabled,
         } = this.viewConfig;
 
@@ -517,33 +512,10 @@ export class LiveboardEmbed extends V1Embed {
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
         params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
+        params[Param.LiveboardXLSXCSVDownload] = !!liveboardXLSXCSVDownload;
+        const queryParams = getQueryParamString(params, true);
 
-        if (oAuthPollingInterval !== undefined) {
-            params[Param.OauthPollingInterval] = oAuthPollingInterval;
-        }
-
-        if (isForceRedirect) {
-            params[Param.IsForceRedirect] = isForceRedirect;
-        }
-
-        if (dataSourceId !== undefined) {
-            params[Param.DataSourceId] = dataSourceId;
-        }
-
-
-        if (isLiveboardStylingAndGroupingEnabled !== undefined) {
-            params[Param.IsLiveboardStylingAndGroupingEnabled] = isLiveboardStylingAndGroupingEnabled;
-        }
-
-        params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
-        params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
-        params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;
-        params[Param.ShowLiveboardReverifyBanner] = showLiveboardReverifyBanner;
-        params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
-        params[Param.DataPanelV2Enabled] = dataPanelV2;
-        params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
-        params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
-        return params;
+        return queryParams;
     }
 
     private getIframeSuffixSrc(liveboardId: string, vizId: string, activeTabId: string) {

package/src/embed/sage.ts

@@ -153,7 +153,12 @@ export class SageEmbed extends V1Embed {
         super(domSelector, viewConfig);
     }
 
-    protected getEmbedParamsObject() {
+    /**
+     * Constructs a map of parameters to be passed on to the
+     * embedded Eureka or Sage search page.
+     * @returns {string} query string
+     */
+    protected getEmbedParams(): string {
         const {
             disableWorksheetChange,
             hideWorksheetSelector,
@@ -179,16 +184,6 @@ export class SageEmbed extends V1Embed {
         params[Param.IsProductTour] = !!isProductTour;
         params[Param.HideSageAnswerHeader] = !!hideSageAnswerHeader;
 
-        return params;
-    }
-
-    /**
-     * Constructs a map of parameters to be passed on to the
-     * embedded Eureka or Sage search page.
-     * @returns {string} query string
-     */
-    protected getEmbedParams(): string {
-        const params = this.getEmbedParamsObject();
         return getQueryParamString(params, true);
     }
 
@@ -199,7 +194,7 @@ export class SageEmbed extends V1Embed {
      */
     public getIFrameSrc(): string {
         const path = 'eureka';
-        const postHashObj: Record<string, any> = {};
+        const postHashObj = {};
         const tsPostHashParams = this.getThoughtSpotPostUrlParams();
         const {
             dataSource, searchOptions,

package/src/embed/search-bar.tsx

@@ -118,7 +118,12 @@ export class SearchBarEmbed extends TsEmbed {
         this.viewConfig = viewConfig;
     }
 
-    protected getEmbedParamsObject() {
+    /**
+     * Construct the URL of the embedded ThoughtSpot search to be
+     * loaded in the iframe
+     * @param dataSources A list of data source GUIDs
+     */
+    private getIFrameSrc() {
         const {
             searchOptions,
             dataSource,
@@ -126,6 +131,7 @@ export class SearchBarEmbed extends TsEmbed {
             useLastSelectedSources = false,
             excludeSearchTokenStringFromURL,
         } = this.viewConfig;
+        const path = 'search-bar-embed';
         const queryParams = this.getBaseQueryParams();
 
         queryParams[Param.HideActions] = [...(queryParams[Param.HideActions] ?? [])];
@@ -153,19 +159,6 @@ export class SearchBarEmbed extends TsEmbed {
             queryParams[Param.UseLastSelectedDataSource] = false;
         }
         queryParams[Param.searchEmbed] = true;
-
-        return queryParams;
-    }
-
-    /**
-     * Construct the URL of the embedded ThoughtSpot search to be
-     * loaded in the iframe
-     * @param dataSources A list of data source GUIDs
-     */
-    private getIFrameSrc() {
-        const queryParams = this.getEmbedParamsObject();
-        const path = 'search-bar-embed';
-       
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {

package/src/embed/search.ts

@@ -331,7 +331,7 @@ export const HiddenActionItemByDefaultForSearchEmbed = [
 ];
 
 export interface SearchAppInitData extends DefaultAppInitData {
-    searchOptions?: SearchOptions;
+  searchOptions?: SearchOptions;
 }
 
 /**
@@ -381,7 +381,7 @@ export class SearchEmbed extends TsEmbed {
         return { ...defaultAppInitData, ...this.getSearchInitData() };
     }
 
-    protected getEmbedParamsObject() {
+    protected getEmbedParams(): string {
         const {
             hideResults,
             enableSearchAssist,
@@ -398,7 +398,7 @@ export class SearchEmbed extends TsEmbed {
             collapseSearchBarInitially = false,
             enableCustomColumnGroups = false,
             isOnBeforeGetVizDataInterceptEnabled = false,
-
+            /* eslint-disable-next-line max-len */
             dataPanelCustomGroupsAccordionInitialState = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
             focusSearchBarOnRender = true,
             excludeRuntimeParametersfromURL,
@@ -443,7 +443,7 @@ export class SearchEmbed extends TsEmbed {
         }
 
         if (isOnBeforeGetVizDataInterceptEnabled) {
-
+            /* eslint-disable-next-line max-len */
             queryParams[Param.IsOnBeforeGetVizDataInterceptEnabled] = isOnBeforeGetVizDataInterceptEnabled;
         }
 
@@ -460,7 +460,7 @@ export class SearchEmbed extends TsEmbed {
         }
 
         queryParams[Param.searchEmbed] = true;
-
+        /* eslint-disable-next-line max-len */
         queryParams[Param.CollapseSearchBarInitially] = collapseSearchBarInitially || collapseSearchBar;
         queryParams[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
         if (dataPanelCustomGroupsAccordionInitialState
@@ -468,23 +468,12 @@ export class SearchEmbed extends TsEmbed {
             || dataPanelCustomGroupsAccordionInitialState
             === DataPanelCustomColumnGroupsAccordionState.EXPAND_FIRST
         ) {
-
+            /* eslint-disable-next-line max-len */
             queryParams[Param.DataPanelCustomGroupsAccordionInitialState] = dataPanelCustomGroupsAccordionInitialState;
         } else {
-
+            /* eslint-disable-next-line max-len */
             queryParams[Param.DataPanelCustomGroupsAccordionInitialState] = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL;
         }
-        return queryParams;
-    }
-
-    protected getEmbedParams() {
-        const {
-            runtimeParameters,
-            runtimeFilters,
-            excludeRuntimeParametersfromURL,
-            excludeRuntimeFiltersfromURL,
-        } = this.viewConfig;
-        const queryParams = this.getEmbedParamsObject();
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {

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

@@ -1,4 +1,3 @@
-
 import { resetValueFromWindow } from '../utils';
 import { ERROR_MESSAGE } from '../errors';
 import { resetCachedAuthToken } from '../authToken';
@@ -27,6 +26,8 @@ import {
     RuntimeParameter,
     Param,
     ContextMenuTriggerOptions,
+    CustomActionTarget,
+    CustomActionsPosition,
 } from '../types';
 import {
     executeAfterWait,
@@ -346,6 +347,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -382,6 +384,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -424,6 +427,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [HomepageModule.MyLibrary, HomepageModule.Learning],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -462,6 +466,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -503,6 +508,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules:
                             [HomepageModule.MyLibrary, HomepageModule.Watchlist],
                         customVariablesForThirdPartyTools,
@@ -547,6 +553,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -592,6 +599,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -636,6 +644,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -681,6 +690,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -725,6 +735,7 @@ describe('Unit test case for ts embed', () => {
                             [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -893,6 +904,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools: {},
@@ -977,6 +989,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools: {},
@@ -1011,6 +1024,127 @@ describe('Unit test case for ts embed', () => {
         });
     });
 
+    describe('getDefaultAppInitData with CustomActionsValidationResult', () => {
+        beforeEach(() => {
+            jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);
+            jest.spyOn(authService, 'verifyTokenService').mockResolvedValue(true);
+            init({
+                thoughtSpotHost: 'tshost',
+                authType: AuthType.TrustedAuthTokenCookieless,
+                getAuthToken: () => Promise.resolve('test_auth_token1'),
+            });
+        });
+
+        afterEach(() => {
+            baseInstance.reset();
+            jest.clearAllMocks();
+        });
+
+        test('should handle valid custom actions and sort them by name in getDefaultAppInitData', async () => {
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.APP_INIT,
+                data: {},
+            };
+            
+            // Create a SearchEmbed with valid custom actions to test
+            // CustomActionsValidationResult
+            const searchEmbed = new SearchEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                customActions: [
+                    {
+                        id: 'action1',
+                        name: 'Valid Action',
+                        target: CustomActionTarget.LIVEBOARD,
+                        position: CustomActionsPosition.PRIMARY,
+                        metadataIds: { liveboardIds: ['lb123'] }
+                    },
+                    {
+                        id: 'action2',
+                        name: 'Another Valid Action',
+                        target: CustomActionTarget.VIZ,
+                        position: CustomActionsPosition.MENU,
+                        metadataIds: { vizIds: ['viz456'] }
+                    }
+                ]
+            });
+            
+            searchEmbed.render();
+            const mockPort: any = {
+                postMessage: jest.fn(),
+            };
+
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations: {
+                            content: {},
+                            style: {
+                                customCSS: {},
+                                customCSSUrl: undefined,
+                            },
+                        },
+                        authToken: 'test_auth_token1',
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hiddenListColumns: [],
+                        customActions: [
+                            {
+                                id: 'action2',
+                                name: 'Another Valid Action',
+                                target: CustomActionTarget.VIZ,
+                                position: CustomActionsPosition.MENU,
+                                metadataIds: { vizIds: ['viz456'] }
+                            },
+                            {
+                                id: 'action1',
+                                name: 'Valid Action',
+                                target: CustomActionTarget.LIVEBOARD,
+                                position: CustomActionsPosition.PRIMARY,
+                                metadataIds: { liveboardIds: ['lb123'] }
+                            }
+                        ], // Actions should be sorted by name
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools: {},
+                    },
+                });
+                
+                // Verify that CustomActionsValidationResult structure is
+                // correct
+                const appInitData = mockPort.postMessage.mock.calls[0][0].data;
+                expect(appInitData.customActions).toHaveLength(2);
+                expect(appInitData.customActions).toEqual(
+                    expect.arrayContaining([
+                        expect.objectContaining({
+                            id: 'action1',
+                            name: 'Valid Action',
+                            target: CustomActionTarget.LIVEBOARD,
+                            position: CustomActionsPosition.PRIMARY
+                        }),
+                        expect.objectContaining({
+                            id: 'action2',
+                            name: 'Another Valid Action',
+                            target: CustomActionTarget.VIZ,
+                            position: CustomActionsPosition.MENU
+                        })
+                    ])
+                );
+                
+                // Verify actions are sorted by name (alphabetically)
+                expect(appInitData.customActions[0].name).toBe('Another Valid Action');
+                expect(appInitData.customActions[1].name).toBe('Valid Action');
+            });
+        });
+    });
+
     describe('Token fetch fails in cookieless authentication authType', () => {
         beforeEach(() => {
             jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);
@@ -2354,7 +2488,7 @@ describe('Unit test case for ts embed', () => {
         });
 
         afterAll((): void => {
-            window.location = location as any;
+            window.location = location;
         });
 
         it('get url params for TS', () => {