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

package/src/embed/app.spec.ts

@@ -344,6 +344,48 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set isPNGInScheduledEmailsEnabled to true in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            isPNGInScheduledEmailsEnabled: true,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isPNGInScheduledEmailsEnabled=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    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,
@@ -611,6 +653,43 @@ describe('App embed tests', () => {
         });
     });
 
+    test('Should add homepageVersion=v3 & navigationVersion=v3 & modularHomeExperience=true when Sliding and ModularWithStylingChanges configured in the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            discoveryExperience: {
+                primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
+                homePage: HomePage.ModularWithStylingChanges,
+            },
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=true&navigationVersion=v3&homepageVersion=v3${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('Should add homepageVersion=v3 & navigationVersion=v3 & modularHomeExperience=true when homePage is ModularWithStylingChanges to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            // primaryNavbarVersion is not included under discoveryExperience,
+            // then it set navigationVersion=v2 and modularHomeExperience=false.
+            discoveryExperience: {
+                homePage: HomePage.ModularWithStylingChanges,
+            },
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&navigationVersion=v2&homepageVersion=v3${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add navigationVersion=v2 when primaryNavbarVersion is not added to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -657,11 +736,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);
 
@@ -669,11 +764,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

@@ -107,6 +107,11 @@ export enum HomePage {
      * It serves as the foundational version of the home page.
      */
     Modular = 'v2',
+    /**
+     * ModularWithStylingChanges (v3) introduces Modular Home Experience
+     * with styling changes.
+     */
+    ModularWithStylingChanges = 'v3',
 }
 
 /**
@@ -532,6 +537,23 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     isLiveboardStylingAndGroupingEnabled?: boolean;
 
+    /**
+     * This flag is used to enable/disable the png embedding of liveboard in scheduled mails
+     * 
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @type {boolean}
+     * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isPNGInScheduledEmailsEnabled: true,
+     * })
+     * ```
+     */
+    isPNGInScheduledEmailsEnabled?: boolean;
+
     /**
      * This flag is used to enable the full height lazy load data.
      * 
@@ -614,7 +636,7 @@ export class AppEmbed extends V1Embed {
             hideOrgSwitcher,
             enableSearchAssist,
             fullHeight,
-            dataPanelV2 = false,
+            dataPanelV2 = true,
             hideLiveboardHeader = false,
             showLiveboardTitle = true,
             showLiveboardDescription = true,
@@ -638,7 +660,9 @@ export class AppEmbed extends V1Embed {
             enablePendoHelp = true,
             discoveryExperience,
             coverAndFilterOptionInPDF = false,
+            liveboardXLSXCSVDownload = false,
             isLiveboardStylingAndGroupingEnabled,
+            isPNGInScheduledEmailsEnabled = false,
         } = this.viewConfig;
 
         let params: any = {};
@@ -657,6 +681,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);
 
@@ -721,6 +746,10 @@ export class AppEmbed extends V1Embed {
             params[Param.IsLiveboardStylingAndGroupingEnabled] = isLiveboardStylingAndGroupingEnabled;
         }
 
+        if (isPNGInScheduledEmailsEnabled !== undefined) {
+            params[Param.isPNGInScheduledEmailsEnabled] = isPNGInScheduledEmailsEnabled;
+        }
+
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
         params[Param.ModularHomeExperienceEnabled] = modularHomeExperience;
@@ -746,6 +775,12 @@ export class AppEmbed extends V1Embed {
         // To use v3 navigation, we must manually set the discoveryExperience
         // settings.
         params[Param.NavigationVersion] = 'v2';
+        // 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) {
@@ -759,6 +794,14 @@ export class AppEmbed extends V1Embed {
             if (discoveryExperience.homePage === HomePage.Modular) {
                 params[Param.ModularHomeExperienceEnabled] = true;
             }
+
+            // ModularWithStylingChanges (v3) introduces the styling changes
+            // to the Modular Homepage.
+            // v3 will be the base version of homePageVersion.
+            if (discoveryExperience.homePage === HomePage.ModularWithStylingChanges) {
+                params[Param.HomepageVersion] = HomePage.ModularWithStylingChanges;
+            }
+
             // listPageVersion v3 will enable the new list page
             if (discoveryExperience.listPageVersion === ListPage.ListWithUXChanges) {
                 params[Param.ListPageVersion] = discoveryExperience.listPageVersion;

package/src/embed/bodyless-conversation.ts

@@ -39,13 +39,6 @@ export class ConversationMessage extends TsEmbed {
         super(container, viewConfig);
     }
 
-    protected getEmbedParamsObject() {
-        const queryParams = this.getBaseQueryParams();
-        queryParams[Param.HideActions] = [...(queryParams[Param.HideActions] ?? [])];
-        queryParams[Param.isSpotterAgentEmbed] = true;
-        return queryParams;
-    }
-
     public getIframeSrc() {
         const {
             sessionId,
@@ -56,8 +49,10 @@ export class ConversationMessage extends TsEmbed {
             messageId,
         } = this.viewConfig;
         const path = 'conv-assist-answer';
-        const queryParams = this.getEmbedParamsObject();
+        const queryParams = this.getBaseQueryParams();
 
+        queryParams[Param.HideActions] = [...(queryParams[Param.HideActions] ?? [])];
+        queryParams[Param.isSpotterAgentEmbed] = true;
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {

package/src/embed/conversation.ts

@@ -61,8 +61,8 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * Flag to control Data panel experience
      *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
-     * @default false
-     * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
+     * @default true
+     * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -196,7 +196,7 @@ export class SpotterEmbed extends TsEmbed {
         super(container, viewConfig);
     }
 
-    protected getEmbedParamsObject() {
+    public getIframeSrc(): string {
         const {
             worksheetId,
             searchOptions,
@@ -210,7 +210,7 @@ export class SpotterEmbed extends TsEmbed {
             runtimeParameters,
             excludeRuntimeParametersfromURL,
         } = this.viewConfig;
-
+        const path = 'insights/conv-assist';
         if (!worksheetId) {
             this.handleError(ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND);
         }
@@ -235,21 +235,6 @@ export class SpotterEmbed extends TsEmbed {
             queryParams[Param.HideSampleQuestions] = !!hideSampleQuestions;
         }
 
-        return queryParams;
-    }
-
-    public getIframeSrc(): string {
-        const {
-            worksheetId,
-            searchOptions,
-            runtimeFilters,
-            excludeRuntimeFiltersfromURL,
-            runtimeParameters,
-            excludeRuntimeParametersfromURL,
-        } = this.viewConfig;
-        const path = 'insights/conv-assist';
-        const queryParams = this.getEmbedParamsObject();
-
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {

package/src/embed/liveboard.spec.ts

@@ -41,6 +41,16 @@ const thoughtSpotHost = 'tshost';
 const prefixParams = '&isLiveboardEmbed=true';
 const prefixParamsVizEmbed = '&isLiveboardEmbed=true&isVizEmbed=true';
 
+const mockGetSessionInfo = (mockSessionInfo?: any) => {
+    jest.spyOn(SessionInfoService, 'getSessionInfo').mockResolvedValue(mockSessionInfo || {
+        releaseVersion: '1.0.0',
+        userGUID: '1234567890',
+        currentOrgId: 1,
+        privileges: [],
+        mixpanelToken: '1234567890',
+    })
+};
+
 beforeAll(() => {
     init({
         thoughtSpotHost,
@@ -77,7 +87,7 @@ describe('Liveboard/viz embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}${prefixParams}&enableDataPanelV2=false#/embed/viz/${liveboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}${prefixParams}&enableDataPanelV2=true#/embed/viz/${liveboardId}`,
             );
         });
     });
@@ -158,6 +168,21 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set isPNGInScheduledEmailsEnabled to true in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isPNGInScheduledEmailsEnabled: true,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isPNGInScheduledEmailsEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should set visible actions as empty array', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             visibleActions: [],
@@ -368,6 +393,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,
@@ -602,13 +657,7 @@ 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',
-        });
+        mockGetSessionInfo();
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
         } as LiveboardViewConfig);
@@ -635,13 +684,7 @@ describe('Liveboard/viz embed tests', () => {
         mockMessageChannel();
 
         // mock getSessionInfo
-        jest.spyOn(SessionInfoService, 'getSessionInfo').mockResolvedValue({
-            releaseVersion: '1.0.0',
-            userGUID: '1234567890',
-            currentOrgId: 1,
-            privileges: [],
-            mixpanelToken: '1234567890',
-        });
+        mockGetSessionInfo();
 
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -684,6 +727,21 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set showSpotterLimitations parameter in url params', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            showSpotterLimitations: true,
+        } as LiveboardViewConfig);
+        await liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}${prefixParams}&showSpotterLimitations=true#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('SetActiveTab Hostevent should not trigger the navigate event with the correct path, for vizEmbed', async () => {
         const mockProcessTrigger = jest.spyOn(tsEmbed.TsEmbed.prototype, 'trigger');
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
@@ -721,12 +779,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(), {
@@ -821,7 +873,6 @@ describe('Liveboard/viz embed tests', () => {
             expect((document.getElementById(libEmbed.getPreRenderIds().wrapper) as any)[ts]).toEqual(
                 libEmbed,
             );
-
             await executeAfterWait(() => {
                 const iframe = getIFrameEl();
                 postMessageToParent(iframe.contentWindow, {
@@ -862,13 +913,7 @@ describe('Liveboard/viz embed tests', () => {
                 preRenderId: testPreRenderId,
             });
 
-            jest.spyOn(SessionInfoService, 'getSessionInfo').mockResolvedValue({
-                releaseVersion: '1.0.0',
-                userGUID: '1234567890',
-                currentOrgId: 1,
-                privileges: [],
-                mixpanelToken: '1234567890',
-            });
+            mockGetSessionInfo();
             let resizeObserverCb: any;
             (window as any).ResizeObserver =
                 window.ResizeObserver ||
@@ -906,7 +951,6 @@ describe('Liveboard/viz embed tests', () => {
                 });
             });
 
-
             await executeAfterWait(() => {
                 const iFrame = document.getElementById(
                     libEmbed.getPreRenderIds().child,
@@ -918,6 +962,60 @@ describe('Liveboard/viz embed tests', () => {
                 done();
             }, 1005);
         });
+
+
+        test('should replace existing preRender when replaceExistingPreRender is true', async () => {
+            const testPreRenderId = 'testReplacePreRender';
+
+            // Stub ResizeObserver for JSDOM
+            (window as any).ResizeObserver = (window as any).ResizeObserver
+                || jest.fn().mockImplementation(() => ({
+                    disconnect: jest.fn(),
+                    observe: jest.fn(),
+                    unobserve: jest.fn(),
+                }));
+
+            // Create initial embed and show preRender (this will create the
+            // preRender wrapper/child)
+            const embedA = new LiveboardEmbed(getRootEl(), {
+                preRenderId: testPreRenderId,
+            });
+
+            await embedA.showPreRender();
+
+            await waitFor(() => !!getIFrameEl());
+
+            const ids = embedA.getPreRenderIds();
+            const oldWrapper = document.getElementById(ids.wrapper);
+            const oldChild = document.getElementById(ids.child);
+
+            const tsKey = '__tsEmbed';
+            expect((oldWrapper as any)[tsKey]).toBe(embedA);
+
+            // Create a new embed instance and preRender with
+            // replaceExistingPreRender = true
+            const embedB = new LiveboardEmbed(getRootEl(), {
+                preRenderId: testPreRenderId,
+            });
+            const prerenderGenericSpy = jest.spyOn(embedB, 'prerenderGeneric');
+
+            await embedB.preRender(false, true);
+
+            await waitFor(() => (document.getElementById(ids.wrapper) as any)?.[tsKey] === embedB);
+
+            const newWrapper = document.getElementById(ids.wrapper);
+            const newChild = document.getElementById(ids.child);
+
+            // Should have called prerenderGeneric for the new embed instance
+            expect(prerenderGenericSpy).toHaveBeenCalledTimes(1);
+
+            // Wrapper should be replaced (new wrapper element), child iframe
+            // may be reused
+            expect(newWrapper).not.toBe(oldWrapper);
+
+            // __tsEmbed on wrapper should now point to the new embed instance
+            expect((newWrapper as any)[tsKey]).toBe(embedB);
+        });
     });
 
     describe('LazyLoadingForFullHeight functionality', () => {