@thoughtspot/visual-embed-sdk 1.46.5-beta.1 → 1.46.5

package/src/embed/app.spec.ts

@@ -439,117 +439,111 @@ describe('App embed tests', () => {
         });
     });
 
-    test('should set isPNGInScheduledEmailsEnabled to true in url', async () => {
-        const appEmbed = new AppEmbed(getRootEl(), {
-            ...defaultViewConfig,
-            isPNGInScheduledEmailsEnabled: true,
-        } as AppViewConfig);
+    test('should set enableHomepageAnnouncement to false in url when not provided in AppViewConfig', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), defaultViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isPNGInScheduledEmailsEnabled=true${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enableHomepageAnnouncement=false${defaultParamsPost}#/home`,
             );
         });
     });
 
-    test('should set isLinkParametersEnabled to true in url', async () => {
+    test('should set isPNGInScheduledEmailsEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
-            isLinkParametersEnabled: true,
+            isPNGInScheduledEmailsEnabled: true,
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLinkParametersEnabled=true${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isPNGInScheduledEmailsEnabled=true${defaultParamsPost}#/home`,
             );
         });
     });
 
-    test('should set isLinkParametersEnabled to false in url', async () => {
+    test('should set isWYSIWYGLiveboardPDFEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
-            isLinkParametersEnabled: false,
+            isContinuousLiveboardPDFEnabled: true,
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLinkParametersEnabled=false${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isWYSIWYGLiveboardPDFEnabled=true${defaultParamsPost}#/home`,
             );
         });
     });
 
-    test('should set isLiveboardXLSXCSVDownloadEnabled to true in url', async () => {
+    test('should set isLinkParametersEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
-            isLiveboardXLSXCSVDownloadEnabled: true,
+            isLinkParametersEnabled: true,
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLiveboardXLSXCSVDownloadEnabled=true${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLinkParametersEnabled=true${defaultParamsPost}#/home`,
             );
         });
     });
 
-    test('should set updatedSpotterChatPrompt to true in url', async () => {
+    test('should set isLinkParametersEnabled to false in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
-            updatedSpotterChatPrompt: true,
+            isLinkParametersEnabled: false,
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&updatedSpotterChatPrompt=true${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLinkParametersEnabled=false${defaultParamsPost}#/home`,
             );
         });
     });
 
-    test('should set updatedSpotterChatPrompt to false in url', async () => {
+    test('should set isLiveboardXLSXCSVDownloadEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
-            updatedSpotterChatPrompt: false,
+            isLiveboardXLSXCSVDownloadEnabled: true,
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&updatedSpotterChatPrompt=false${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLiveboardXLSXCSVDownloadEnabled=true${defaultParamsPost}#/home`,
             );
         });
     });
 
-    test('should set deprecated standalone enablePastConversationsSidebar in url', async () => {
+    test('should set updatedSpotterChatPrompt to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
-            enablePastConversationsSidebar: true,
+            updatedSpotterChatPrompt: true,
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enablePastConversationsSidebar=true${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&updatedSpotterChatPrompt=true${defaultParamsPost}#/home`,
             );
         });
     });
 
-    test('should prefer spotterSidebarConfig.enablePastConversationsSidebar over deprecated standalone flag in url', async () => {
+    test('should set updatedSpotterChatPrompt to false in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
-            enablePastConversationsSidebar: false,
-            spotterSidebarConfig: {
-                enablePastConversationsSidebar: true,
-            },
+            updatedSpotterChatPrompt: false,
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enablePastConversationsSidebar=true${defaultParamsPost}#/home`,
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&updatedSpotterChatPrompt=false${defaultParamsPost}#/home`,
             );
         });
     });
@@ -1247,7 +1241,6 @@ describe('App embed tests', () => {
     });
 
     test('should register event handlers to adjust iframe height', async () => {
-        jest.spyOn(logger, 'error').mockImplementation(() => {});
         let embedHeightCallback: any = () => { };
         const onSpy = jest.spyOn(AppEmbed.prototype, 'on').mockImplementation((event, callback) => {
             if (event === EmbedEvent.RouteChange) {
@@ -1520,6 +1513,28 @@ describe('App embed tests', () => {
                 width: 650,
             });
         });
+        test('should not send correct visible data when RequestFullHeightLazyLoadData is triggered if lazyLoadingForFullHeight is false', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                fullHeight: true,
+                lazyLoadingForFullHeight: false,
+                lazyLoadingMargin: '10px',
+            } as AppViewConfig);
+
+            const mockTrigger = jest.spyOn(appEmbed, 'trigger');
+
+            await appEmbed.render();
+
+            // Trigger the lazy load data calculation
+            (appEmbed as any).sendFullHeightLazyLoadData();
+
+            expect(mockTrigger).not.toHaveBeenCalledWith(HostEvent.VisibleEmbedCoordinates, {
+                top: 0,
+                height: 500,
+                left: 0,
+                width: 650,
+            });
+        });
 
         test('should calculate correct visible data for partially visible full height element', async () => {
             // Mock iframe partially clipped from top and left
@@ -1639,8 +1654,8 @@ describe('App embed tests', () => {
 
     describe('IFrame height management', () => {
         let mockIFrame: HTMLIFrameElement;
+
         beforeEach(() => {
-            jest.spyOn(logger, 'error').mockImplementation(() => {});
             mockIFrame = document.createElement('iframe');
             mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
                 top: 100,
@@ -1692,16 +1707,13 @@ describe('App embed tests', () => {
                 fullHeight: true,
             } as AppViewConfig) as any;
 
-            // Set up the mock iframe with a height that differs from defaultHeight by > threshold
-            mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
-                top: 100, left: 150, bottom: 100, right: 800, width: 650, height: 0,
-            });
+            // Set up the mock iframe
             appEmbed.iFrame = mockIFrame;
             document.body.appendChild(mockIFrame);
 
             await appEmbed.render();
             const mockEvent = {
-                data: 0, // This will make it use the default height (500); change = |500 - 0| = 500 >= 30
+                data: 0, // This will make it use the default height
                 type: EmbedEvent.EmbedHeight,
             };
             appEmbed.updateIFrameHeight(mockEvent);
@@ -1709,61 +1721,6 @@ describe('App embed tests', () => {
             // Should use the default height
             expect(mockIFrame.style.height).toBe('500px');
         });
-
-        test('should skip height update when change is below threshold', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                fullHeight: true,
-            } as AppViewConfig) as any;
-
-            appEmbed.iFrame = mockIFrame;
-            document.body.appendChild(mockIFrame);
-            await appEmbed.render();
-
-            const spySetIFrameHeight = jest.spyOn(appEmbed, 'setIFrameHeight');
-
-            // currentHeight is 500; heightToSet will be max(510, 500) = 510; change = 10 < 30
-            appEmbed.updateIFrameHeight({ data: 510, type: EmbedEvent.EmbedHeight });
-
-            expect(spySetIFrameHeight).not.toHaveBeenCalled();
-        });
-
-        test('should update height when change meets threshold', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                fullHeight: true,
-            } as AppViewConfig) as any;
-
-            appEmbed.iFrame = mockIFrame;
-            document.body.appendChild(mockIFrame);
-            await appEmbed.render();
-
-            const spySetIFrameHeight = jest.spyOn(appEmbed, 'setIFrameHeight');
-
-            // currentHeight is 500; heightToSet = max(600, 500) = 600; change = 100 >= 30
-            appEmbed.updateIFrameHeight({ data: 600, type: EmbedEvent.EmbedHeight });
-
-            expect(spySetIFrameHeight).toHaveBeenCalledWith(600);
-        });
-
-        test('should use defaultHeight when data is below it and check threshold', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                fullHeight: true,
-                minimumHeight: 800,
-            } as AppViewConfig) as any;
-
-            appEmbed.iFrame = mockIFrame;
-            document.body.appendChild(mockIFrame);
-            await appEmbed.render();
-
-            const spySetIFrameHeight = jest.spyOn(appEmbed, 'setIFrameHeight');
-
-            // currentHeight is 500; heightToSet = max(100, 800) = 800; change = 300 >= 30
-            appEmbed.updateIFrameHeight({ data: 100, type: EmbedEvent.EmbedHeight });
-
-            expect(spySetIFrameHeight).toHaveBeenCalledWith(800);
-        });
     });
 });
 
@@ -1786,3 +1743,5 @@ describe('App Embed Default Height and Minimum Height Handling', () => {
         expect(appEmbed['defaultHeight']).toBe(700);
     });
 });
+
+

package/src/embed/app.ts

@@ -9,7 +9,7 @@
  */
 
 import { logger } from '../utils/logger';
-import { calculateVisibleElementData, getQueryParamString, isUndefined, isValidCssMargin, setParamIfDefined, validateHttpUrl, resolveEnablePastConversationsSidebar } from '../utils';
+import { calculateVisibleElementData, getQueryParamString, isUndefined, isValidCssMargin, setParamIfDefined } from '../utils';
 import {
     Param,
     DOMSelector,
@@ -17,12 +17,11 @@ import {
     EmbedEvent,
     MessagePayload,
     AllEmbedViewConfig,
-    ErrorDetailsTypes,
-    EmbedErrorCodes,
+    DefaultAppInitData,
 } from '../types';
 import { V1Embed } from './ts-embed';
 import { SpotterChatViewConfig, SpotterSidebarViewConfig } from './conversation';
-import { ERROR_MESSAGE } from '../errors';
+import { buildSpotterSidebarAppInitData } from './spotter-utils';
 
 /**
  * Pages within the ThoughtSpot app that can be embedded.
@@ -587,6 +586,25 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     isPNGInScheduledEmailsEnabled?: boolean;
 
+    /**
+     * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page 
+     * following the exact UI layout, instead of splitting visualizations across multiple A4 pages. 
+     * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @type {boolean}
+     * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isContinuousLiveboardPDFEnabled: true,
+     * })
+     * ```
+     */
+    isContinuousLiveboardPDFEnabled?: boolean;
+
     /**
      * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
      *
@@ -760,6 +778,16 @@ export interface AppViewConfig extends AllEmbedViewConfig {
     enableHomepageAnnouncement?: boolean;
 }
 
+/**
+ * APP_INIT data shape for AppEmbed.
+ * @internal
+ */
+export interface AppEmbedAppInitData extends DefaultAppInitData {
+    embedParams?: {
+        spotterSidebarConfig?: SpotterSidebarViewConfig;
+    };
+}
+
 /**
  * Embeds full ThoughtSpot experience in a host application.
  * @group Embed components
@@ -783,6 +811,23 @@ export class AppEmbed extends V1Embed {
         }
     }
 
+    /**
+     * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
+     * so the conv-assist app can read sidebar configuration on initialisation.
+     *
+     * Precedence for `enablePastConversationsSidebar`:
+     * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
+     * deprecated top-level `enablePastConversationsSidebar` flag; if the former
+     * is absent the latter is used as a fallback.
+     *
+     * An invalid `spotterDocumentationUrl` triggers a validation error and is
+     * excluded from the payload rather than forwarded to the app.
+     */
+    protected async getAppInitData(): Promise<AppEmbedAppInitData> {
+        const defaultAppInitData = await super.getAppInitData();
+        return buildSpotterSidebarAppInitData(defaultAppInitData, this.viewConfig, this.handleError.bind(this));
+    }
+
     /**
      * Constructs a map of parameters to be passed on to the
      * embedded Liveboard or visualization.
@@ -834,11 +879,11 @@ export class AppEmbed extends V1Embed {
             isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
             updatedSpotterChatPrompt,
-            spotterSidebarConfig,
             spotterChatConfig,
             minimumHeight,
             isThisPeriodInDateFiltersEnabled,
-            enableHomepageAnnouncement,
+            enableHomepageAnnouncement = false,
+            isContinuousLiveboardPDFEnabled,
         } = this.viewConfig;
 
         let params: any = {};
@@ -867,53 +912,6 @@ export class AppEmbed extends V1Embed {
             params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
         }
 
-        const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
-            spotterSidebarConfigValue: spotterSidebarConfig?.enablePastConversationsSidebar,
-            standaloneValue: this.viewConfig.enablePastConversationsSidebar,
-        });
-        setParamIfDefined(params, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
-
-        // Handle spotterSidebarConfig params
-        if (spotterSidebarConfig) {
-            const {
-                spotterSidebarTitle,
-                spotterSidebarDefaultExpanded,
-                spotterChatRenameLabel,
-                spotterChatDeleteLabel,
-                spotterDeleteConversationModalTitle,
-                spotterPastConversationAlertMessage,
-                spotterDocumentationUrl,
-                spotterBestPracticesLabel,
-                spotterConversationsBatchSize,
-                spotterNewChatButtonTitle,
-            } = spotterSidebarConfig;
-
-            setParamIfDefined(params, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
-            setParamIfDefined(params, Param.SpotterSidebarTitle, spotterSidebarTitle);
-            setParamIfDefined(params, Param.SpotterChatRenameLabel, spotterChatRenameLabel);
-            setParamIfDefined(params, Param.SpotterChatDeleteLabel, spotterChatDeleteLabel);
-            setParamIfDefined(params, Param.SpotterDeleteConversationModalTitle, spotterDeleteConversationModalTitle);
-            setParamIfDefined(params, Param.SpotterPastConversationAlertMessage, spotterPastConversationAlertMessage);
-            setParamIfDefined(params, Param.SpotterBestPracticesLabel, spotterBestPracticesLabel);
-            setParamIfDefined(params, Param.SpotterConversationsBatchSize, spotterConversationsBatchSize);
-            setParamIfDefined(params, Param.SpotterNewChatButtonTitle, spotterNewChatButtonTitle);
-
-            // URL param with validation
-            if (spotterDocumentationUrl !== undefined) {
-                const [isValid, validationError] = validateHttpUrl(spotterDocumentationUrl);
-                if (isValid) {
-                    params[Param.SpotterDocumentationUrl] = spotterDocumentationUrl;
-                } else {
-                    this.handleError({
-                        errorType: ErrorDetailsTypes.VALIDATION_ERROR,
-                        message: ERROR_MESSAGE.INVALID_SPOTTER_DOCUMENTATION_URL,
-                        code: EmbedErrorCodes.INVALID_URL,
-                        error: validationError?.message || ERROR_MESSAGE.INVALID_SPOTTER_DOCUMENTATION_URL,
-                    });
-                }
-            }
-        }
-
         // Handle spotterChatConfig params
         if (spotterChatConfig) {
             const {
@@ -1017,6 +1015,10 @@ export class AppEmbed extends V1Embed {
             params[Param.EnableHomepageAnnouncement] = enableHomepageAnnouncement;
         }
 
+        if (isContinuousLiveboardPDFEnabled !== undefined) {
+            params[Param.IsWYSIWYGLiveboardPDFEnabled] = isContinuousLiveboardPDFEnabled;
+        }
+
         this.defaultHeight = minimumHeight || this.defaultHeight;
 
         params[Param.DataPanelV2Enabled] = dataPanelV2;
@@ -1085,7 +1087,10 @@ export class AppEmbed extends V1Embed {
 
     private sendFullHeightLazyLoadData = () => {
         const data = calculateVisibleElementData(this.iFrame);
-        this.trigger(HostEvent.VisibleEmbedCoordinates, data);
+        // this should be fired only if the lazyLoadingForFullHeight and fullHeight are true
+        if(this.viewConfig.lazyLoadingForFullHeight && this.viewConfig.fullHeight){
+            this.trigger(HostEvent.VisibleEmbedCoordinates, data);
+        }
     }
 
     /**
@@ -1115,22 +1120,13 @@ export class AppEmbed extends V1Embed {
         return url;
     }
 
-    private HEIGHT_CHANAGE_THRESHOLD = 30;
     /**
      * Set the iframe height as per the computed height received
      * from the ThoughtSpot app.
      * @param data The event payload
      */
     protected updateIFrameHeight = (data: MessagePayload) => {
-        logger.error('Updating iframe height', data);
-        const currentHeight = this.iFrame.getBoundingClientRect().height;
-        const heightToSet = Math.max(data.data, this.defaultHeight);
-        const heightChange = Math.abs(heightToSet - currentHeight);
-        if (heightChange < this.HEIGHT_CHANAGE_THRESHOLD) {
-            logger.info('Height change is less than the threshold, skipping height update', { heightChange, heightToSet, currentHeight });
-            return;
-        }
-        this.setIFrameHeight(heightToSet);
+        this.setIFrameHeight(Math.max(data.data, this.defaultHeight));
         this.sendFullHeightLazyLoadData();
     };