@thoughtspot/visual-embed-sdk 1.42.1-alpha.6 → 1.42.2

package/src/embed/conversation.ts

@@ -164,6 +164,22 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
      */
     excludeRuntimeParametersfromURL?: boolean;
+    /**
+     * enablePastConversationsSidebar : Controls the visibility of the past conversations
+     * sidebar.
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @default false
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    ... //other embed view config
+     *    enablePastConversationsSidebar : true,
+     * })
+     * ```
+     * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+     */
+    enablePastConversationsSidebar?: boolean;
 }
 
 /**
@@ -205,6 +221,7 @@ export class SpotterEmbed extends TsEmbed {
             dataPanelV2,
             showSpotterLimitations,
             hideSampleQuestions,
+            enablePastConversationsSidebar,
             runtimeFilters,
             excludeRuntimeFiltersfromURL,
             runtimeParameters,
@@ -246,10 +263,15 @@ export class SpotterEmbed extends TsEmbed {
             excludeRuntimeFiltersfromURL,
             runtimeParameters,
             excludeRuntimeParametersfromURL,
+            enablePastConversationsSidebar
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         const queryParams = this.getEmbedParamsObject();
 
+        if (!isUndefined(enablePastConversationsSidebar)) {
+            queryParams[Param.EnablePastConversationsSidebar] = !!enablePastConversationsSidebar;
+        }
+
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {

package/src/embed/hostEventClient/contracts.ts

@@ -7,7 +7,6 @@ export enum UIPassthroughEvent {
   GetAvailableUIPassthroughs = 'getAvailableUiPassthroughs',
   GetAnswerConfig = 'getAnswerPageConfig',
   GetLiveboardConfig = 'getPinboardPageConfig',
-  GetUnsavedAnswerTML = 'getUnsavedAnswerTML',
 }
 
 // UI Passthrough Contract
@@ -64,15 +63,6 @@ export type UIPassthroughContractBase = {
     request: any;
     response: any;
   };
-  [UIPassthroughEvent.GetUnsavedAnswerTML]: {
-    request: {
-      sessionId?: string;
-      vizId?: string;
-    };
-    response: {
-      tml: string;
-    };
-  };
 };
 
 // UI Passthrough Request and Response

package/src/embed/liveboard.spec.ts

@@ -16,6 +16,7 @@ import {
     defaultParams,
     defaultParamsWithoutHiddenActions,
     expectUrlMatchesWithParams,
+    expectUrlToHaveParamsWithValues,
     postMessageToParent,
     getIFrameEl,
     mockMessageChannel,
@@ -138,6 +139,20 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set LiveboardStylePanel in visible actions', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            visibleActions: [Action.LiveboardStylePanel],
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlToHaveParamsWithValues(getIFrameSrc(), {
+                visibleAction: JSON.stringify([Action.LiveboardStylePanel]),
+            });
+        });
+    });
+
     test('should set enable2ColumnLayout to true in url', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             enable2ColumnLayout: true,
@@ -168,6 +183,21 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set isLiveboardPermissionV2Enabled to true in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isEnhancedFilterInteractivityEnabled: true,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardPermissionV2Enabled=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should set isPNGInScheduledEmailsEnabled to true in url', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             isPNGInScheduledEmailsEnabled: true,
@@ -453,6 +483,36 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should add isCentralizedLiveboardFilterUXEnabled flag and set value to true to the iframe src', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            isCentralizedLiveboardFilterUXEnabled: true,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isCentralizedLiveboardFilterUXEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should add isCentralizedLiveboardFilterUXEnabled flag and set value to false to the iframe src', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            isCentralizedLiveboardFilterUXEnabled: false,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isCentralizedLiveboardFilterUXEnabled=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

@@ -465,6 +465,7 @@ export class LiveboardEmbed extends V1Embed {
             showLiveboardVerifiedBadge = true,
             showLiveboardReverifyBanner = true,
             hideIrrelevantChipsInLiveboardTabs = false,
+            isEnhancedFilterInteractivityEnabled = false,
             enableAskSage,
             enable2ColumnLayout,
             dataPanelV2 = true,
@@ -477,6 +478,7 @@ export class LiveboardEmbed extends V1Embed {
             isLiveboardStylingAndGroupingEnabled,
             isPNGInScheduledEmailsEnabled = false,
             showSpotterLimitations,
+            isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
         } = this.viewConfig;
 
@@ -557,11 +559,18 @@ export class LiveboardEmbed extends V1Embed {
             params[Param.isLinkParametersEnabled] = isLinkParametersEnabled;
         }
 
+        if (isCentralizedLiveboardFilterUXEnabled !== undefined) {
+            params[
+                Param.isCentralizedLiveboardFilterUXEnabled
+            ] = isCentralizedLiveboardFilterUXEnabled;
+        }
+
         params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
         params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
         params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;
         params[Param.ShowLiveboardReverifyBanner] = showLiveboardReverifyBanner;
         params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
+        params[Param.IsEnhancedFilterInteractivityEnabled] = isEnhancedFilterInteractivityEnabled;
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
         params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;

package/src/embed/sage.ts

@@ -69,12 +69,12 @@ export interface SageViewConfig
      */
     hideSageAnswerHeader?: boolean;
     /**
-     * Disable the worksheet selection option.
+     * Disable the data source selection option.
      * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     disableWorksheetChange?: boolean;
     /**
-     * Hide the worksheet selection panel.
+     * Hide the data source selection panel.
      * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     hideWorksheetSelector?: boolean;
@@ -92,7 +92,7 @@ export interface SageViewConfig
     showObjectSuggestions?: boolean;
     /**
      * Show or hide sample questions.
-     * The sample questions are autogenerated based on the worksheet
+     * The sample questions are autogenerated based on the data Model.
      * selected for the search operation.
      * 
      * Supported embed types: `SageEmbed`
@@ -107,7 +107,7 @@ export interface SageViewConfig
      */
     hideSampleQuestions?: boolean;
     /**
-     * The data source GUID (Worksheet GUID) to set on load.
+     * The data source GUID (Model GUID) to set on load.
      */
     dataSource?: string;
     /**

package/src/embed/search.ts

@@ -26,7 +26,6 @@ import { ERROR_MESSAGE } from '../errors';
 import { getAuthPromise } from './base';
 import { getReleaseVersion } from '../auth';
 import { getEmbedConfig } from './embedConfig';
-import { getInterceptInitData } from '../api-intercept';
 
 /**
  * Configuration for search options.
@@ -443,8 +442,7 @@ export class SearchEmbed extends TsEmbed {
             queryParams[Param.HideSearchBar] = true;
         }
 
-        const { enableApiIntercept } = getInterceptInitData(this.embedConfig, this.viewConfig);
-        if (isOnBeforeGetVizDataInterceptEnabled && !enableApiIntercept) {
+        if (isOnBeforeGetVizDataInterceptEnabled) {
 
             queryParams[Param.IsOnBeforeGetVizDataInterceptEnabled] = isOnBeforeGetVizDataInterceptEnabled;
         }

package/src/embed/ts-embed.spec.ts

@@ -1045,7 +1045,7 @@ describe('Unit test case for ts embed', () => {
                 type: EmbedEvent.APP_INIT,
                 data: {},
             };
-
+            
             // Create a SearchEmbed with valid custom actions to test
             // CustomActionsValidationResult
             const searchEmbed = new SearchEmbed(getRootEl(), {
@@ -1067,7 +1067,7 @@ describe('Unit test case for ts embed', () => {
                     }
                 ]
             });
-
+            
             searchEmbed.render();
             const mockPort: any = {
                 postMessage: jest.fn(),
@@ -1116,7 +1116,7 @@ describe('Unit test case for ts embed', () => {
                         customVariablesForThirdPartyTools: {},
                     },
                 });
-
+                
                 // Verify that CustomActionsValidationResult structure is
                 // correct
                 const appInitData = mockPort.postMessage.mock.calls[0][0].data;
@@ -1137,7 +1137,7 @@ describe('Unit test case for ts embed', () => {
                         })
                     ])
                 );
-
+                
                 // Verify actions are sorted by name (alphabetically)
                 expect(appInitData.customActions[0].name).toBe('Another Valid Action');
                 expect(appInitData.customActions[1].name).toBe('Valid Action');
@@ -2488,7 +2488,7 @@ describe('Unit test case for ts embed', () => {
         });
 
         afterAll((): void => {
-            (window.location as any) = location;
+            window.location = location as any;
         });
 
         it('get url params for TS', () => {
@@ -3406,7 +3406,7 @@ describe('Unit test case for ts embed', () => {
                 new Error('Auth failed'),
             );
             const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
-            const errorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
+            const errorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
             await searchEmbed.render();
             await executeAfterWait(() => {
                 expect(getRootEl().innerHTML).toContain('Not logged in');
@@ -3415,7 +3415,7 @@ describe('Unit test case for ts embed', () => {
                     window.dispatchEvent(onlineEvent);
                 }).not.toThrow();
             });
-
+    
             errorSpy.mockReset();
         });
 

package/src/embed/ts-embed.ts

@@ -71,7 +71,6 @@ import { getEmbedConfig } from './embedConfig';
 import { ERROR_MESSAGE } from '../errors';
 import { getPreauthInfo } from '../utils/sessionInfoService';
 import { HostEventClient } from './hostEventClient/host-event-client';
-import { getInterceptInitData, handleInterceptEvent, processLegacyInterceptResponse } from '../api-intercept';
 
 const { version } = pkgInfo;
 
@@ -202,7 +201,7 @@ export class TsEmbed {
         });
         const embedConfig = getEmbedConfig();
         this.embedConfig = embedConfig;
-
+    
         this.hostEventClient = new HostEventClient(this.iFrame);
         this.isReadyForRenderPromise = getInitPromise().then(async () => {
             if (!embedConfig.authTriggerContainer && !embedConfig.useEventForSAMLPopup) {
@@ -337,50 +336,33 @@ export class TsEmbed {
         this.subscribedListeners.offline = offlineEventListener;
     }
 
-    private messageEventListener = async (event: MessageEvent<any>) => {
-        const eventType = this.getEventType(event);
-        const eventPort = this.getEventPort(event);
-        const eventData = this.formatEventData(event, eventType);
-        if (event.source === this.iFrame.contentWindow) {
-            const processedEventData = await processEventData(
-                eventType,
-                eventData,
-                this.thoughtSpotHost,
-                this.isPreRendered ? this.preRenderWrapper : this.el,
-            );
-
-            const executeEvent = (_eventType: EmbedEvent, data: any) => {
-                this.executeCallbacks(_eventType, data, eventPort);
-            }
-
-            if (eventType === EmbedEvent.ApiIntercept && this.viewConfig.enableApiIntercept) {
-                const getUnsavedAnswerTml = async (props: { sessionId?: string, vizId?: string }) => {
-                    const response = await this.triggerUIPassThrough(UIPassthroughEvent.GetUnsavedAnswerTML, props);
-                    return response[0]?.value;
-                }
-                handleInterceptEvent({ eventData: processedEventData, executeEvent, embedConfig: this.embedConfig, viewConfig: this.viewConfig, getUnsavedAnswerTml });
-                return;
-            }
-
-            this.executeCallbacks(
-                eventType,
-                processedEventData,
-                eventPort,
-            );
-        }
-    };
     /**
      * Subscribe to message events that depend on successful iframe setup
      */
     private subscribeToMessageEvents() {
         this.unsubscribeToMessageEvents();
 
-        window.addEventListener('message', this.messageEventListener);
+        const messageEventListener = (event: MessageEvent<any>) => {
+            const eventType = this.getEventType(event);
+            const eventPort = this.getEventPort(event);
+            const eventData = this.formatEventData(event, eventType);
+            if (event.source === this.iFrame.contentWindow) {
+                this.executeCallbacks(
+                    eventType,
+                    processEventData(
+                        eventType,
+                        eventData,
+                        this.thoughtSpotHost,
+                        this.isPreRendered ? this.preRenderWrapper : this.el,
+                    ),
+                    eventPort,
+                );
+            }
+        };
+        window.addEventListener('message', messageEventListener);
 
-        this.subscribedListeners.message = this.messageEventListener;
+        this.subscribedListeners.message = messageEventListener;
     }
-   
-
     /**
      * Adds event listeners for both network and message events.
      * This maintains backward compatibility with the existing method.
@@ -394,7 +376,6 @@ export class TsEmbed {
         this.subscribeToMessageEvents();
     }
 
-
     private unsubscribeToNetworkEvents() {
         if (this.subscribedListeners.online) {
             window.removeEventListener('online', this.subscribedListeners.online);
@@ -445,7 +426,7 @@ export class TsEmbed {
                 message: customActionsResult.errors,
             });
         }
-        const baseInitData = {
+        return {
             customisations: getCustomisations(this.embedConfig, this.viewConfig),
             authToken,
             runtimeFilterParams: this.viewConfig.excludeRuntimeFiltersfromURL
@@ -464,10 +445,7 @@ export class TsEmbed {
                 this.embedConfig.customVariablesForThirdPartyTools || {},
             hiddenListColumns: this.viewConfig.hiddenListColumns || [],
             customActions: customActionsResult.actions,
-            ...getInterceptInitData(this.embedConfig, this.viewConfig),
         };
-
-        return baseInitData;
     }
 
     protected async getAppInitData() {
@@ -1045,21 +1023,6 @@ export class TsEmbed {
         this.iFrame.style.height = getCssDimension(height);
     }
 
-    protected createEmbedEventResponder = (eventPort: MessagePort | void, eventType: EmbedEvent) => {
-
-        const { enableApiIntercept } = getInterceptInitData(this.embedConfig, this.viewConfig);
-        if (eventType === EmbedEvent.OnBeforeGetVizDataIntercept && enableApiIntercept) {
-            return (payload: any) => {
-                const payloadToSend = processLegacyInterceptResponse(payload);
-                this.triggerEventOnPort(eventPort, payloadToSend);
-            }
-        }
-
-        return (payload: any) => {
-            this.triggerEventOnPort(eventPort, payload);
-        }
-    }
-
     /**
      * Executes all registered event handlers for a particular event type
      * @param eventType The event type
@@ -1084,8 +1047,9 @@ export class TsEmbed {
                 // payload
                 || (!callbackObj.options.start && dataStatus === embedEventStatus.END)
             ) {
-                const responder = this.createEmbedEventResponder(eventPort, eventType);
-                callbackObj.callback(data, responder);
+                callbackObj.callback(data, (payload) => {
+                    this.triggerEventOnPort(eventPort, payload);
+                });
             }
         });
     }
@@ -1227,12 +1191,12 @@ export class TsEmbed {
         }
     }
 
-    /**
-    * @hidden
-    * Internal state to track if the embed container is loaded.
-    * This is used to trigger events after the embed container is loaded.
-    */
-    public isEmbedContainerLoaded = false;
+     /**
+     * @hidden
+     * Internal state to track if the embed container is loaded.
+     * This is used to trigger events after the embed container is loaded.
+     */
+     public isEmbedContainerLoaded = false;
 
     /**
      * @hidden
@@ -1384,7 +1348,7 @@ export class TsEmbed {
         }
         this.isPreRendered = true;
         this.showPreRenderByDefault = showPreRenderByDefault;
-
+        
         const isAlreadyRendered = this.connectPreRendered();
         if (isAlreadyRendered && !replaceExistingPreRender) {
             return this;

package/src/errors.ts

@@ -1,6 +1,6 @@
 export const ERROR_MESSAGE = {
     INVALID_THOUGHTSPOT_HOST: 'Error parsing ThoughtSpot host. Please provide a valid URL.',
-    SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND: 'Please select a worksheet to get started',
+    SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND: 'Please select a Model to get started',
     LIVEBOARD_VIZ_ID_VALIDATION: 'Please select a Liveboard to embed.',
     TRIGGER_TIMED_OUT: 'Trigger timed-out in getting a response',
     SEARCHEMBED_BETA_WRANING_MESSAGE: 'SearchEmbed is in Beta in this release.',

package/src/index.ts

@@ -64,7 +64,6 @@ import {
     ListPageColumns,
     CustomActionsPosition,
     CustomActionTarget,
-    InterceptedApiType,
 } from './types';
 import { CustomCssVariables } from './css-variables';
 import { SageEmbed, SageViewConfig } from './embed/sage';
@@ -153,7 +152,6 @@ export {
     DataPanelCustomColumnGroupsAccordionState,
     CustomActionsPosition,
     CustomActionTarget,
-    InterceptedApiType,
 };
 
 export { resetCachedAuthToken } from './authToken';

package/src/react/all-types-export.ts

@@ -59,5 +59,6 @@ export {
     resetCachedAuthToken,
     UIPassthroughEvent,
     DataPanelCustomColumnGroupsAccordionState,
-    InterceptedApiType,
+    CustomActionsPosition,
+    CustomActionTarget,
 } from '../index';