@thoughtspot/visual-embed-sdk 1.39.2-alpha.1 → 1.39.2-alpha.2

package/src/embed/conversation.spec.ts

@@ -1,8 +1,10 @@
-import { SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed } from './conversation';
-import { TsEmbed } from './ts-embed';
+import {
+    SpotterEmbed,
+    SpotterEmbedViewConfig,
+} from './conversation';
 import * as authInstance from '../auth';
 import { Action, init } from '../index';
-import { AuthType, Param, RuntimeFilterOp } from '../types';
+import { AuthType, Param } from '../types';
 import {
     getDocumentBody,
     getIFrameSrc,
@@ -178,132 +180,4 @@ describe('ConversationEmbed', () => {
             `http://${thoughtSpotHost}/v2/?${defaultParams}&${Param.DisableActions}=[%22${Action.InConversationTraining}%22]&${Param.DisableActionReason}=${disabledReason}&isSpotterExperienceEnabled=true&enableDataPanelV2=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
         );
     });
-
-    it('should render the conversation embed with runtime filters', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeFilters: [
-                {
-                    columnName: 'revenue',
-                    operator: RuntimeFilterOp.EQ,
-                    values: [1000],
-                },
-            ],
-        };
-
-        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&col1=revenue&op1=EQ&val1=1000#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
-
-    it('should render the conversation embed with runtime parameters', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeParameters: [
-                {
-                    name: 'Date Range',
-                    value: '30',
-                },
-            ],
-        };
-
-        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&param1=Date%20Range&paramVal1=30#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
-
-    it('should render the conversation embed with runtime parameters excluded from URL', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeParameters: [
-                {
-                    name: 'Date Range',
-                    value: '30',
-                },
-                {
-                    name: 'Region',
-                    value: 'North America',
-                },
-            ],
-            excludeRuntimeParametersfromURL: true,
-        };
-
-        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
-
-    it('should render the conversation embed with both runtime filters and parameters', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeParameters: [
-                {
-                    name: 'Date Range',
-                    value: '30',
-                },
-            ],
-            runtimeFilters: [
-                {
-                    columnName: 'revenue',
-                    operator: RuntimeFilterOp.EQ,
-                    values: [1000],
-                },
-            ],
-            excludeRuntimeParametersfromURL: false,
-            excludeRuntimeFiltersfromURL: false,
-        };
-
-        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&col1=revenue&op1=EQ&val1=1000&param1=Date%20Range&paramVal1=30#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
-
-    it('should ensure deprecated ConversationEmbed class maintains same functionality as SpotterEmbed', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeParameters: [
-                {
-                    name: 'Date Range',
-                    value: '30',
-                },
-            ],
-        };
-
-        // Test with deprecated class
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-
-        // Verify it generates the same URL structure as SpotterEmbed
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&param1=Date%20Range&paramVal1=30#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
 });

package/src/embed/conversation.ts

@@ -1,10 +1,10 @@
 import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
-import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter } from '../types';
+import { Param, BaseViewConfig } from '../types';
 import { TsEmbed } from './ts-embed';
-import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils';
+import { getQueryParamString } from '../utils';
 
-/**
+/** 
  * Configuration for search options
  */
 export interface SearchOptions {
@@ -20,8 +20,7 @@ export interface SearchOptions {
  */
 export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
     /**
-     * The ID of the data source object. For example, Model, View, or Table. Spotter uses
-     * this object to query data and generate Answers.
+     * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
      */
     worksheetId: string;
     /**
@@ -31,7 +30,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     /**
      * disableSourceSelection : Disables data source selection
      * but still display the selected data source.
-     *
+     * 
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -45,7 +44,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     disableSourceSelection?: boolean;
     /**
      * hideSourceSelection : Hide data source selection
-     *
+     * 
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -59,7 +58,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     hideSourceSelection?: boolean;
     /**
      * 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
@@ -77,7 +76,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * showSpotterLimitations : show limitation text
      * of the spotter underneath the chat input.
      * default is false.
-     *
+     * 
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -92,7 +91,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     /**
      * hideSampleQuestions : Hide sample questions on
      * the initial screen of the conversation.
-     *
+     * 
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -104,63 +103,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     hideSampleQuestions?: boolean;
-    /**
-     * The list of runtime filters to apply to a search Answer,
-     * visualization, or Liveboard.
-     *
-     * Supported embed types: `SpotterEmbed`
-     * @example
-     * ```js
-     * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... // other embed view config
-     *    runtimeFilters: [
-     *           {
-     *             columnName: 'value',
-     *             operator: RuntimeFilterOp.EQ,
-     *             values: ['string' | 123 | true],
-     *           },
-     *       ],
-     * })
-     * ```
-     */
-    runtimeFilters?: RuntimeFilter[];
-    /**
-     * Flag to control whether runtime filters should be included in the URL.
-     * If true, filters will be passed via app initialization payload instead.
-     * If false/undefined, filters will be added to URL (default behavior).
-     *
-     * Supported embed types: `SpotterEmbed`
-     * @default false
-     */
-    excludeRuntimeFiltersfromURL?: boolean;
-    /**
-     * The list of runtime parameters to apply to the conversation.
-     *
-     * Supported embed types: `SpotterEmbed`
-     * @example
-     * ```js
-     * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... // other embed view config
-     *    runtimeParameters: [
-     *           {
-     *             name: 'Parameter Name',
-     *             value: 'Parameter Value',
-     *           },
-     *       ],
-     * })
-     * ```
-     */
-    runtimeParameters?: RuntimeParameter[];
-    /**
-     * Flag to control whether runtime parameters should be included in the URL.
-     * If true, parameters will be passed via app initialization payload instead.
-     * If false/undefined, parameters will be added to URL (default behavior).
-     *
-     * Supported embed types: `SpotterEmbed`
-     * @default false
-     *
-     */
-    excludeRuntimeParametersfromURL?: boolean;
 }
 
 /**
@@ -202,10 +144,6 @@ export class SpotterEmbed extends TsEmbed {
             dataPanelV2,
             showSpotterLimitations,
             hideSampleQuestions,
-            runtimeFilters,
-            excludeRuntimeFiltersfromURL,
-            runtimeParameters,
-            excludeRuntimeParametersfromURL,
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         if (!worksheetId) {
@@ -237,21 +175,11 @@ export class SpotterEmbed extends TsEmbed {
         if (queryParamsString) {
             query = `?${queryParamsString}`;
         }
-
-        const filterQuery = getFilterQuery(runtimeFilters || []);
-        if (filterQuery && !excludeRuntimeFiltersfromURL) {
-            query += `&${filterQuery}`;
-        }
-
-        const parameterQuery = getRuntimeParameters(runtimeParameters || []);
-        if (parameterQuery && !excludeRuntimeParametersfromURL) {
-            query += `&${parameterQuery}`;
-        }
-
         const tsPostHashParams = this.getThoughtSpotPostUrlParams({
             worksheet: worksheetId,
             query: searchOptions?.searchQuery || '',
         });
+
         return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
     }
 

package/src/embed/liveboard.spec.ts

@@ -786,7 +786,7 @@ describe('Liveboard/viz embed tests', () => {
             await waitFor(() => !!getIFrameEl());
 
             const ts = '__tsEmbed';
-            expect(document.getElementById(libEmbed.getPreRenderIds().wrapper)[ts]).toEqual(
+            expect((document.getElementById(libEmbed.getPreRenderIds().wrapper) as any)[ts]).toEqual(
                 libEmbed,
             );
 
@@ -814,6 +814,256 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    describe('LazyLoadingForFullHeight functionality', () => {
+        let mockIFrame: HTMLIFrameElement;
+
+        beforeEach(() => {
+            mockIFrame = document.createElement('iframe');
+            mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
+                top: 100,
+                left: 150,
+                bottom: 600,
+                right: 800,
+                width: 650,
+                height: 500,
+            });
+            jest.spyOn(document, 'createElement').mockImplementation((tagName) => {
+                if (tagName === 'iframe') {
+                    return mockIFrame;
+                }
+                return document.createElement(tagName);
+            });
+        });
+
+        afterEach(() => {
+            jest.restoreAllMocks();
+        });
+
+        test('should set lazyLoadingMargin parameter when provided', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: true,
+                lazyLoadingMargin: '100px 0px',
+            } as LiveboardViewConfig);
+
+            await liveboardEmbed.render();
+
+            await executeAfterWait(() => {
+                const iframeSrc = getIFrameSrc();
+                expect(iframeSrc).toContain('isLazyLoadingForEmbedEnabled=true');
+                expect(iframeSrc).toContain('isFullHeightPinboard=true');
+                expect(iframeSrc).toContain('rootMarginForLazyLoad=100px%200px');
+            }, 100);
+        });
+
+        test('should set isLazyLoadingForEmbedEnabled=true when both fullHeight and lazyLoadingForFullHeight are enabled', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: true,
+            } as LiveboardViewConfig);
+
+            await liveboardEmbed.render();
+
+            await executeAfterWait(() => {
+                const iframeSrc = getIFrameSrc();
+                expect(iframeSrc).toContain('isLazyLoadingForEmbedEnabled=true');
+                expect(iframeSrc).toContain('isFullHeightPinboard=true');
+            }, 100);
+        });
+
+        test('should not set lazyLoadingForEmbed when lazyLoadingForFullHeight is enabled but fullHeight is false', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: false,
+                lazyLoadingForFullHeight: true,
+            } as LiveboardViewConfig);
+
+            await liveboardEmbed.render();
+
+            await executeAfterWait(() => {
+                const iframeSrc = getIFrameSrc();
+                expect(iframeSrc).not.toContain('isLazyLoadingForEmbedEnabled=true');
+                expect(iframeSrc).not.toContain('isFullHeightPinboard=true');
+            }, 100);
+        });
+
+        test('should not set isLazyLoadingForEmbedEnabled when fullHeight is true but lazyLoadingForFullHeight is false', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: false,
+            } as LiveboardViewConfig);
+
+            await liveboardEmbed.render();
+
+            await executeAfterWait(() => {
+                const iframeSrc = getIFrameSrc();
+                expect(iframeSrc).not.toContain('isLazyLoadingForEmbedEnabled=true');
+                expect(iframeSrc).toContain('isFullHeightPinboard=true');
+            }, 100);
+        });
+
+        test('should register event handlers to adjust iframe height', async () => {
+            const onSpy = jest.spyOn(LiveboardEmbed.prototype, 'on');
+
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: true,
+            } as LiveboardViewConfig);
+
+            await liveboardEmbed.render();
+
+            await executeAfterWait(() => {
+                expect(onSpy).toHaveBeenCalledWith(EmbedEvent.EmbedHeight, expect.anything());
+                expect(onSpy).toHaveBeenCalledWith(EmbedEvent.RouteChange, expect.anything());
+                expect(onSpy).toHaveBeenCalledWith(EmbedEvent.EmbedIframeCenter, expect.anything());
+                expect(onSpy).toHaveBeenCalledWith(EmbedEvent.RequestVisibleEmbedCoordinates, expect.anything());
+            }, 100);
+        });
+
+        test('should send correct visible data when RequestVisibleEmbedCoordinates is triggered', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: true,
+            } as LiveboardViewConfig);
+
+            const mockTrigger = jest.spyOn(liveboardEmbed, 'trigger');
+
+            await liveboardEmbed.render();
+
+            // Trigger the lazy load data calculation
+            (liveboardEmbed as any).sendFullHeightLazyLoadData();
+
+            expect(mockTrigger).toHaveBeenCalledWith(HostEvent.VisibleEmbedCoordinates, {
+                top: 0,
+                height: 500,
+                left: 0,
+                width: 650,
+            });
+        });
+
+        test('should calculate correct visible data for partially visible full height element', async () => {
+            mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
+                top: -50,
+                left: -30,
+                bottom: 700,
+                right: 1024,
+                width: 1054,
+                height: 750,
+            });
+
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: true,
+            } as LiveboardViewConfig);
+
+            const mockTrigger = jest.spyOn(liveboardEmbed, 'trigger');
+
+            await liveboardEmbed.render();
+
+            // Trigger the lazy load data calculation
+            (liveboardEmbed as any).sendFullHeightLazyLoadData();
+
+            expect(mockTrigger).toHaveBeenCalledWith(HostEvent.VisibleEmbedCoordinates, {
+                top: 50,
+                height: 700,
+                left: 30,
+                width: 1024,
+            });
+        });
+
+        test('should add window event listeners for resize and scroll when fullHeight and lazyLoadingForFullHeight are enabled', async () => {
+            const addEventListenerSpy = jest.spyOn(window, 'addEventListener');
+
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: true,
+            } as LiveboardViewConfig);
+
+            await liveboardEmbed.render();
+
+            expect(addEventListenerSpy).toHaveBeenCalledWith('resize', expect.anything());
+            expect(addEventListenerSpy).toHaveBeenCalledWith('scroll', expect.anything());
+
+            addEventListenerSpy.mockRestore();
+        });
+
+        test('should remove window event listeners on destroy when fullHeight and lazyLoadingForFullHeight are enabled', async () => {
+            const removeEventListenerSpy = jest.spyOn(window, 'removeEventListener');
+
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: true,
+            } as LiveboardViewConfig);
+
+            await liveboardEmbed.render();
+            liveboardEmbed.destroy();
+
+            expect(removeEventListenerSpy).toHaveBeenCalledWith('resize', expect.anything());
+            expect(removeEventListenerSpy).toHaveBeenCalledWith('scroll', expect.anything());
+
+            removeEventListenerSpy.mockRestore();
+        });
+
+        test('should handle RequestVisibleEmbedCoordinates event and respond with correct data', async () => {
+            // Mock the iframe element
+            mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
+                top: 100,
+                left: 150,
+                bottom: 600,
+                right: 800,
+                width: 650,
+                height: 500,
+            });
+            Object.defineProperty(mockIFrame, 'scrollHeight', { value: 500 });
+
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                fullHeight: true,
+                lazyLoadingForFullHeight: true,
+            } as LiveboardViewConfig);
+
+            // Set the iframe before render
+            (liveboardEmbed as any).iFrame = mockIFrame;
+
+            await liveboardEmbed.render();
+
+            // Create a mock responder function
+            const mockResponder = jest.fn();
+
+            // Trigger the handler directly
+            (liveboardEmbed as any).requestVisibleEmbedCoordinatesHandler({}, mockResponder);
+
+            // Verify the responder was called with the correct data
+            expect(mockResponder).toHaveBeenCalledWith({
+                type: EmbedEvent.RequestVisibleEmbedCoordinates,
+                data: {
+                    top: 0,
+                    height: 500,
+                    left: 0,
+                    width: 650,
+                },
+            });
+        });
+    });
+
     describe('Host events for liveborad', () => {
         test('Host event with empty param', async () => {
             const mockProcessTrigger = jest.spyOn(tsEmbed.TsEmbed.prototype, 'trigger');