@thoughtspot/visual-embed-sdk 1.40.1 → 1.40.3

package/src/embed/app.spec.ts

@@ -344,6 +344,34 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set liveboardXLSXCSVDownload to true in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardXLSXCSVDownload: true,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLiveboardXLSXCSVDownloadEnabled=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('should set liveboardXLSXCSVDownload to false in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardXLSXCSVDownload: false,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLiveboardXLSXCSVDownloadEnabled=false${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add the tag to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -694,11 +722,27 @@ describe('App embed tests', () => {
         });
     });
 
-    test('Should not add listpageVersion when listPageVersion is List (v2) to the iframe src', async () => {
+
+    test('Should add listpageVersion=v2 by default when no discoveryExperience is provided', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&navigationVersion=v2&listpageVersion=v2${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('Should add listpageVersion=v2 by default when discoveryExperience is provided but listPageVersion is not specified', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
             discoveryExperience: {
-                listPageVersion: ListPage.List,
+                primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
+                homePage: HomePage.Modular,
             },
         } as AppViewConfig);
 
@@ -706,11 +750,12 @@ describe('App embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=true&navigationVersion=v3&listpageVersion=v2${defaultParams}${defaultParamsPost}#/home`,
             );
         });
     });
 
+
     test('Should add listpageVersion=v3 combined with other discoveryExperience options to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/app.ts

@@ -643,6 +643,7 @@ export class AppEmbed extends V1Embed {
             enablePendoHelp = true,
             discoveryExperience,
             coverAndFilterOptionInPDF = false,
+            liveboardXLSXCSVDownload = false,
             isLiveboardStylingAndGroupingEnabled,
         } = this.viewConfig;
 
@@ -662,6 +663,7 @@ export class AppEmbed extends V1Embed {
         params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
         params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
         params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
+        params[Param.LiveboardXLSXCSVDownload] = !!liveboardXLSXCSVDownload;
 
         params = this.getBaseQueryParams(params);
 
@@ -754,6 +756,9 @@ export class AppEmbed extends V1Embed {
         // Set homePageVersion to v2 by default to reset the LD flag value
         // for the homepageVersion.
         params[Param.HomepageVersion] = 'v2';
+        // Set listpageVersion to v2 by default to reset the LD flag value
+        // for the listpageVersion.
+        params[Param.ListPageVersion] = ListPage.List;
         if (discoveryExperience) {
             // primaryNavbarVersion v3 will enabled the new left navigation
             if (discoveryExperience.primaryNavbarVersion === PrimaryNavbarVersion.Sliding) {

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,

package/src/embed/liveboard.ts

@@ -435,6 +435,7 @@ export class LiveboardEmbed extends V1Embed {
             isForceRedirect,
             dataSourceId,
             coverAndFilterOptionInPDF = false,
+            liveboardXLSXCSVDownload = false,
             isLiveboardStylingAndGroupingEnabled,
         } = this.viewConfig;
 
@@ -511,6 +512,7 @@ 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);
 
         return queryParams;

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);

package/src/embed/ts-embed.ts

@@ -35,6 +35,7 @@ import {
     removeStyleProperties,
     isUndefined,
 } from '../utils';
+import { getCustomActions } from '../utils/custom-actions';
 import {
     getThoughtSpotHost,
     URL_MAX_LENGTH,
@@ -380,6 +381,16 @@ export class TsEmbed {
 
     protected async getDefaultAppInitData(): Promise<DefaultAppInitData> {
         const authToken = await this.getAuthTokenForCookielessInit();
+        const customActionsResult = getCustomActions([
+            ...(this.viewConfig.customActions || []),
+            ...(this.embedConfig.customActions || [])
+        ]);
+        if (customActionsResult.errors.length > 0) {
+            this.handleError({
+                type: 'CUSTOM_ACTION_VALIDATION',
+                message: customActionsResult.errors,
+            });
+        }
         return {
             customisations: getCustomisations(this.embedConfig, this.viewConfig),
             authToken,
@@ -398,6 +409,7 @@ export class TsEmbed {
             customVariablesForThirdPartyTools:
                 this.embedConfig.customVariablesForThirdPartyTools || {},
             hiddenListColumns: this.viewConfig.hiddenListColumns || [],
+            customActions: customActionsResult.actions,
         };
     }
 

package/src/errors.ts

@@ -19,3 +19,14 @@ export const ERROR_MESSAGE = {
     RENDER_CALLED_BEFORE_INIT: 'Looks like render was called before calling init, the render won\'t start until init is called.\nFor more info check\n1. https://developers.thoughtspot.com/docs/Function_init#_init\n2.https://developers.thoughtspot.com/docs/getting-started#initSdk',
     SPOTTER_AGENT_NOT_INITIALIZED: 'SpotterAgent not initialized',
 };
+
+export const CUSTOM_ACTIONS_ERROR_MESSAGE = {
+    INVALID_ACTION_OBJECT: 'Custom Action Validation Error: Invalid action object provided',
+    MISSING_REQUIRED_FIELDS: (id: string, missingFields: string[]) => `Custom Action Validation Error for '${id}': Missing required fields: ${missingFields.join(', ')}`,
+    UNSUPPORTED_TARGET: (id: string, targetType: string) => `Custom Action Validation Error for '${id}': Target type '${targetType}' is not supported`,
+    INVALID_POSITION: (position: string, targetType: string, supportedPositions: string) => `Position '${position}' is not supported for ${targetType.toLowerCase()}-level custom actions. Supported positions: ${supportedPositions}`,
+    INVALID_METADATA_IDS: (targetType: string, invalidIds: string[], supportedIds: string) => `Invalid metadata IDs for ${targetType.toLowerCase()}-level custom actions: ${invalidIds.join(', ')}. Supported metadata IDs: ${supportedIds}`,
+    INVALID_DATA_MODEL_IDS: (targetType: string, invalidIds: string[], supportedIds: string) => `Invalid data model IDs for ${targetType.toLowerCase()}-level custom actions: ${invalidIds.join(', ')}. Supported data model IDs: ${supportedIds}`,
+    INVALID_FIELDS: (targetType: string, invalidFields: string[], supportedFields: string) => `Invalid fields for ${targetType.toLowerCase()}-level custom actions: ${invalidFields.join(', ')}. Supported fields: ${supportedFields}`,
+    DUPLICATE_IDS: (id: string, duplicateNames: string[], keptName: string) => `Duplicate custom action ID '${id}' found. Actions with names '${duplicateNames.join("', '")}' will be ignored. Keeping '${keptName}'.`,
+};

package/src/index.ts

@@ -62,6 +62,8 @@ import {
     VizPoint,
     CustomActionPayload,
     ListPageColumns,
+    CustomActionsPosition,
+    CustomActionTarget,
 } from './types';
 import { CustomCssVariables } from './css-variables';
 import { SageEmbed, SageViewConfig } from './embed/sage';
@@ -148,6 +150,8 @@ export {
     UIPassthroughEvent,
     ListPageColumns,
     DataPanelCustomColumnGroupsAccordionState,
+    CustomActionsPosition,
+    CustomActionTarget,
 };
 
 export { resetCachedAuthToken } from './authToken';

package/src/react/index.tsx

@@ -600,4 +600,5 @@ export {
     LogLevel,
     getSessionInfo,
     ListPageColumns,
+    CustomActionsPosition,
 } from '../index';