@thoughtspot/visual-embed-sdk 1.40.1-alpha.2 → 1.41.0-pre-render-1

package/src/embed/conversation.ts

@@ -1,10 +1,10 @@
 import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
-import { Param, BaseViewConfig } from '../types';
+import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter } from '../types';
 import { TsEmbed } from './ts-embed';
-import { getQueryParamString } from '../utils';
+import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils';
 
-/** 
+/**
  * Configuration for search options
  */
 export interface SearchOptions {
@@ -20,7 +20,8 @@ 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;
     /**
@@ -30,7 +31,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
@@ -44,7 +45,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     disableSourceSelection?: boolean;
     /**
      * hideSourceSelection : Hide data source selection
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -58,7 +59,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
@@ -76,7 +77,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
@@ -91,7 +92,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
@@ -103,6 +104,66 @@ 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: 'color',
+     *             operator: RuntimeFilterOp.EQ,
+     *             values: ['red'],
+     *           },
+     *       ],
+     * })
+     * ```
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     */
+    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
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     */
+    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: 'Integer Param',
+     *             value: 10,
+     *           },
+     *       ],
+     * })
+     * ```
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     */
+    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
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
+     */
+    excludeRuntimeParametersfromURL?: boolean;
 }
 
 /**
@@ -144,6 +205,10 @@ export class SpotterEmbed extends TsEmbed {
             dataPanelV2,
             showSpotterLimitations,
             hideSampleQuestions,
+            runtimeFilters,
+            excludeRuntimeFiltersfromURL,
+            runtimeParameters,
+            excludeRuntimeParametersfromURL,
         } = this.viewConfig;
 
         if (!worksheetId) {
@@ -177,6 +242,10 @@ export class SpotterEmbed extends TsEmbed {
         const {
             worksheetId,
             searchOptions,
+            runtimeFilters,
+            excludeRuntimeFiltersfromURL,
+            runtimeParameters,
+            excludeRuntimeParametersfromURL,
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         const queryParams = this.getEmbedParamsObject();
@@ -186,11 +255,21 @@ 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

@@ -642,7 +642,7 @@ describe('Liveboard/viz embed tests', () => {
             privileges: [],
             mixpanelToken: '1234567890',
         });
-        
+
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
             preRenderId: 'test',
@@ -721,6 +721,12 @@ 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(), {
@@ -787,7 +793,7 @@ describe('Liveboard/viz embed tests', () => {
             });
         });
 
-        test('it should navigateToLiveboard with liveboard id is not passed', async (done) => {
+        test('it should navigateToLiveboard with liveboard id is not passed with EmbedListenerReady event', async (done) => {
             mockMessageChannel();
             const consoleSpy = jest.spyOn(console, 'error');
             const testPreRenderId = 'testPreRender';
@@ -816,12 +822,19 @@ describe('Liveboard/viz embed tests', () => {
                 libEmbed,
             );
 
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, {
+                    type: EmbedEvent.EmbedListenerReady,
+                });
+            });
+
             const testLiveboardId = 'testLiveboardId';
             const newLibEmbed = new LiveboardEmbed(getRootEl(), {
                 preRenderId: testPreRenderId,
                 liveboardId: testLiveboardId,
-                activeTabId: 'tab1',
-                vizId: 'viz1',
+                vizId: 'testVizId',
+                activeTabId: 'testActiveTabId',
             });
             const navigateToLiveboardSpy = jest.spyOn(newLibEmbed, 'navigateToLiveboard');
             await newLibEmbed.showPreRender();
@@ -832,7 +845,7 @@ describe('Liveboard/viz embed tests', () => {
                 ) as HTMLIFrameElement;
 
                 // should render the generic link
-                expect(navigateToLiveboardSpy).toHaveBeenCalledWith(testLiveboardId, 'viz1', 'tab1', expect.any(Function));
+                expect(navigateToLiveboardSpy).toHaveBeenCalledWith(testLiveboardId, 'testVizId', 'testActiveTabId');
                 expect(iFrame.src).toMatch(/http:\/\/tshost\/.*&isLiveboardEmbed=true.*#$/);
 
                 expect(consoleSpy).toHaveBeenCalledTimes(0);
@@ -840,6 +853,71 @@ 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');
+            const testPreRenderId = 'testPreRender';
+            const libEmbed = new LiveboardEmbed(getRootEl(), {
+                preRenderId: testPreRenderId,
+            });
+
+            jest.spyOn(SessionInfoService, 'getSessionInfo').mockResolvedValue({
+                releaseVersion: '1.0.0',
+                userGUID: '1234567890',
+                currentOrgId: 1,
+                privileges: [],
+                mixpanelToken: '1234567890',
+            });
+            let resizeObserverCb: any;
+            (window as any).ResizeObserver =
+                window.ResizeObserver ||
+                jest.fn().mockImplementation((resizeObserverCbParam: any) => {
+                    resizeObserverCb = resizeObserverCbParam;
+                    return {
+                        disconnect: jest.fn(),
+                        observe: jest.fn(),
+                        unobserve: jest.fn(),
+                    };
+                });
+            await libEmbed.preRender();
+            await waitFor(() => !!getIFrameEl());
+            const ts = '__tsEmbed';
+            expect((document.getElementById(libEmbed.getPreRenderIds().wrapper) as any)[ts]).toEqual(
+                libEmbed,
+            );
+            const testLiveboardId = 'testLiveboardId';
+            const newLibEmbed = new LiveboardEmbed(getRootEl(), {
+                preRenderId: testPreRenderId,
+                liveboardId: testLiveboardId,
+                vizId: 'testVizId',
+                activeTabId: 'testActiveTabId',
+            });
+            const navigateToLiveboardSpy = jest.spyOn(newLibEmbed, 'navigateToLiveboard');
+
+            await newLibEmbed.showPreRender();
+
+            await executeAfterWait(() => {
+                const iFrame = document.getElementById(
+                    newLibEmbed.getPreRenderIds().child,
+                ) as HTMLIFrameElement;
+                postMessageToParent(iFrame.contentWindow, {
+                    type: EmbedEvent.AuthInit,
+                });
+            });
+
+
+            await executeAfterWait(() => {
+                const iFrame = document.getElementById(
+                    libEmbed.getPreRenderIds().child,
+                ) as HTMLIFrameElement;
+                // should render the generic link
+                expect(navigateToLiveboardSpy).toHaveBeenCalledWith(testLiveboardId, 'testVizId', 'testActiveTabId');
+                expect(iFrame.src).toMatch(/http:\/\/tshost\/.*&isLiveboardEmbed=true.*#$/);
+                expect(consoleSpy).toHaveBeenCalledTimes(0);
+                done();
+            }, 1005);
+        });
     });
 
     describe('LazyLoadingForFullHeight functionality', () => {
@@ -1113,4 +1191,157 @@ describe('Liveboard/viz embed tests', () => {
             });
         });
     });
+
+    describe('Liveboard Embed Container Loading and PreRender', () => {
+        beforeEach(() => {
+            document.body.innerHTML = getDocumentBody();
+        });
+
+        test('should call navigateToLiveboard after embed container is loaded in beforePrerenderVisible', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                liveboardId,
+                vizId,
+                activeTabId,
+                ...defaultViewConfig,
+            });
+
+            const navigateToLiveboardSpy = jest.spyOn(liveboardEmbed, 'navigateToLiveboard').mockResolvedValue(undefined);
+
+            // Mock embed container as not loaded initially
+            liveboardEmbed.isEmbedContainerLoaded = false;
+
+            // Call beforePrerenderVisible
+            liveboardEmbed['beforePrerenderVisible']();
+
+            // navigateToLiveboard should not be called immediately
+            expect(navigateToLiveboardSpy).not.toHaveBeenCalled();
+
+            // Simulate embed container becoming ready
+            liveboardEmbed.isEmbedContainerLoaded = true;
+            liveboardEmbed['executeEmbedContainerReadyCallbacks']();
+
+            // Now navigateToLiveboard should be called
+            expect(navigateToLiveboardSpy).toHaveBeenCalledWith(liveboardId, vizId, activeTabId);
+        });
+
+        test('should update currentLiveboardState for prerender object when embed container loads', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                liveboardId,
+                vizId,
+                activeTabId,
+                ...defaultViewConfig,
+            });
+
+            const mockPreRenderObj = {
+                currentLiveboardState: {},
+            };
+
+            jest.spyOn(liveboardEmbed as any, 'getPreRenderObj').mockReturnValue(mockPreRenderObj as any);
+            jest.spyOn(liveboardEmbed, 'navigateToLiveboard').mockResolvedValue(undefined);
+
+            // Mock embed container as not loaded initially
+            liveboardEmbed.isEmbedContainerLoaded = false;
+
+            // Call beforePrerenderVisible
+            liveboardEmbed['beforePrerenderVisible']();
+
+            // Simulate embed container becoming ready
+            liveboardEmbed.isEmbedContainerLoaded = true;
+            liveboardEmbed['executeEmbedContainerReadyCallbacks']();
+
+            // Check that currentLiveboardState was updated
+            expect(mockPreRenderObj.currentLiveboardState).toEqual({
+                liveboardId,
+                vizId,
+                activeTabId,
+            });
+        });
+
+        test('should handle beforePrerenderVisible when embed container is already loaded', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                liveboardId,
+                vizId,
+                activeTabId,
+                ...defaultViewConfig,
+            });
+
+            const navigateToLiveboardSpy = jest.spyOn(liveboardEmbed, 'navigateToLiveboard').mockResolvedValue(undefined);
+
+            // Mock embed container as already loaded
+            liveboardEmbed.isEmbedContainerLoaded = true;
+
+            // Call beforePrerenderVisible
+            liveboardEmbed['beforePrerenderVisible']();
+
+            // navigateToLiveboard should be called immediately
+            expect(navigateToLiveboardSpy).toHaveBeenCalledWith(liveboardId, vizId, activeTabId);
+        });
+
+        test('should handle beforePrerenderVisible without prerender object', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                liveboardId,
+                vizId,
+                activeTabId,
+                ...defaultViewConfig,
+            });
+
+            jest.spyOn(liveboardEmbed as any, 'getPreRenderObj').mockReturnValue(null);
+            const navigateToLiveboardSpy = jest.spyOn(liveboardEmbed, 'navigateToLiveboard').mockResolvedValue(undefined);
+
+            // Mock embed container as not loaded initially
+            liveboardEmbed.isEmbedContainerLoaded = false;
+
+            // Call beforePrerenderVisible
+            liveboardEmbed['beforePrerenderVisible']();
+
+            // Simulate embed container becoming ready
+            liveboardEmbed.isEmbedContainerLoaded = true;
+            liveboardEmbed['executeEmbedContainerReadyCallbacks']();
+
+            // navigateToLiveboard should still be called
+            expect(navigateToLiveboardSpy).toHaveBeenCalledWith(liveboardId, vizId, activeTabId);
+        });
+
+        test('should work with all liveboard parameters', async () => {
+            const customLiveboardId = 'custom-liveboard-id';
+            const customVizId = 'custom-viz-id';
+            const customActiveTabId = 'custom-active-tab-id';
+
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                liveboardId: customLiveboardId,
+                vizId: customVizId,
+                activeTabId: customActiveTabId,
+                ...defaultViewConfig,
+            });
+
+            const navigateToLiveboardSpy = jest.spyOn(liveboardEmbed, 'navigateToLiveboard').mockResolvedValue(undefined);
+
+            // Mock embed container as already loaded
+            liveboardEmbed.isEmbedContainerLoaded = true;
+
+            // Call beforePrerenderVisible
+            liveboardEmbed['beforePrerenderVisible']();
+
+            // Check that all parameters are passed correctly
+            expect(navigateToLiveboardSpy).toHaveBeenCalledWith(customLiveboardId, customVizId, customActiveTabId);
+        });
+
+        test('should work with minimal liveboard parameters', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                liveboardId,
+                ...defaultViewConfig,
+            });
+
+            const navigateToLiveboardSpy = jest.spyOn(liveboardEmbed, 'navigateToLiveboard').mockResolvedValue(undefined);
+
+            // Mock embed container as already loaded
+            liveboardEmbed.isEmbedContainerLoaded = true;
+
+            // Call beforePrerenderVisible
+            liveboardEmbed['beforePrerenderVisible']();
+
+            // Check that undefined parameters are passed correctly
+            expect(navigateToLiveboardSpy).toHaveBeenCalledWith(liveboardId, undefined, undefined);
+        });
+    });
 });

package/src/embed/liveboard.ts

@@ -674,12 +674,29 @@ export class LiveboardEmbed extends V1Embed {
         }
     }
 
+    /**
+     * @hidden
+     * Internal state to track the current liveboard id.
+     * This is used to navigate to the correct liveboard when the prerender is visible.
+     */
+    public currentLiveboardState = {
+        liveboardId: this.viewConfig.liveboardId,
+        vizId: this.viewConfig.vizId,
+        activeTabId: this.viewConfig.activeTabId,
+    };
+
     protected beforePrerenderVisible(): void {
         const embedObj = this.getPreRenderObj<LiveboardEmbed>();
 
-        const libId = this.currentLiveboardId;
-        this.navigateToLiveboard(libId, this.viewConfig.vizId, this.viewConfig.activeTabId, () => {
-            if (embedObj) embedObj.currentLiveboardId = libId;
+        this.executeAfterEmbedContainerLoaded(() => {
+            this.navigateToLiveboard(this.viewConfig.liveboardId, this.viewConfig.vizId, this.viewConfig.activeTabId);
+            if (embedObj) {
+                embedObj.currentLiveboardState = {
+                    liveboardId: this.viewConfig.liveboardId,
+                    vizId: this.viewConfig.vizId,
+                    activeTabId: this.viewConfig.activeTabId,
+                };
+            }
         });
     }
 
@@ -754,15 +771,13 @@ export class LiveboardEmbed extends V1Embed {
         return this;
     }
 
-    public currentLiveboardId: string = this.viewConfig.liveboardId;
-
-    public navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, onNavigateCalled?: () => void) {
+    public navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string) {
         const path = this.getIframeSuffixSrc(liveboardId, vizId, activeTabId);
         this.viewConfig.liveboardId = liveboardId;
         this.viewConfig.activeTabId = activeTabId;
         this.viewConfig.vizId = vizId;
         if (this.isRendered) {
-            this.triggerAfterLoad(HostEvent.Navigate, path.substring(1), onNavigateCalled);
+            this.trigger(HostEvent.Navigate, path.substring(1));
         } else if (this.viewConfig.preRenderId) {
             this.preRender(true);
         } else {

package/src/embed/sage.ts

@@ -199,7 +199,7 @@ export class SageEmbed extends V1Embed {
      */
     public getIFrameSrc(): string {
         const path = 'eureka';
-        const postHashObj = {};
+        const postHashObj: Record<string, any> = {};
         const tsPostHashParams = this.getThoughtSpotPostUrlParams();
         const {
             dataSource, searchOptions,