@thoughtspot/visual-embed-sdk 1.42.1-alpha.7 → 1.42.3

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

@@ -90,7 +90,6 @@ beforeAll(() => {
 const customisations = {
     style: {
         customCSS: {},
-        customCSSUrl: undefined as string | undefined,
     },
     content: {},
 };
@@ -98,7 +97,6 @@ const customisations = {
 const customisationsView = {
     style: {
         customCSS: {},
-        customCSSUrl: undefined as string | undefined,
     },
     content: {
         strings: {
@@ -1047,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(), {
@@ -1069,7 +1067,7 @@ describe('Unit test case for ts embed', () => {
                     }
                 ]
             });
-
+            
             searchEmbed.render();
             const mockPort: any = {
                 postMessage: jest.fn(),
@@ -1118,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;
@@ -1139,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');
@@ -2430,50 +2428,6 @@ describe('Unit test case for ts embed', () => {
         });
     });
 
-    describe('When destroyed', () => {
-        it('should remove the iframe', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                frameParams: {
-                    width: '100%',
-                    height: '100%',
-                },
-            });
-            await appEmbed.render();
-            expect(getIFrameEl()).toBeTruthy();
-            appEmbed.destroy();
-            expect(getIFrameEl()).toBeFalsy();
-        });
-
-        it('should remove the iframe when insertAsSibling is true', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                frameParams: {
-                    width: '100%',
-                    height: '100%',
-                },
-                insertAsSibling: true,
-            });
-            await appEmbed.render();
-            expect(getIFrameEl()).toBeTruthy();
-            appEmbed.destroy();
-            expect(getIFrameEl()).toBeFalsy();
-        });
-
-        it("Should remove the error message on destroy if it's present", async () => {
-            jest.spyOn(baseInstance, 'getAuthPromise').mockResolvedValueOnce(false);
-            const appEmbed = new AppEmbed(getRootEl(), {
-                frameParams: {
-                    width: '100%',
-                    height: '100%',
-                },
-                insertAsSibling: true,
-            });
-            await appEmbed.render();
-            expect(getRootEl().nextElementSibling.innerHTML).toContain('Not logged in');
-            appEmbed.destroy();
-            expect(getRootEl().nextElementSibling.innerHTML).toBe('');
-        });
-    });
-
     describe('validate getThoughtSpotPostUrlParams', () => {
         const { location } = window;
 
@@ -2490,7 +2444,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', () => {
@@ -3408,7 +3362,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');
@@ -3417,7 +3371,7 @@ describe('Unit test case for ts embed', () => {
                     window.dispatchEvent(onlineEvent);
                 }).not.toThrow();
             });
-
+    
             errorSpy.mockReset();
         });
 
@@ -3458,4 +3412,172 @@ describe('Unit test case for ts embed', () => {
             triggerSpy.mockReset();
         });
     });
+
+    describe('When destroyed', () => {
+        it('should remove the iframe', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+            });
+            await appEmbed.render();
+            expect(getIFrameEl()).toBeTruthy();
+            appEmbed.destroy();
+            expect(getIFrameEl()).toBeFalsy();
+        });
+
+        it('should remove the iframe when insertAsSibling is true', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+                insertAsSibling: true,
+            });
+            await appEmbed.render();
+            expect(getIFrameEl()).toBeTruthy();
+            appEmbed.destroy();
+            expect(getIFrameEl()).toBeFalsy();
+        });
+
+        it("Should remove the error message on destroy if it's present", async () => {
+            jest.spyOn(baseInstance, 'getAuthPromise').mockResolvedValueOnce(false);
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+                insertAsSibling: true,
+            });
+            await appEmbed.render();
+            expect(getRootEl().nextElementSibling.innerHTML).toContain('Not logged in');
+            appEmbed.destroy();
+            expect(getRootEl().nextElementSibling.innerHTML).toBe('');
+        });
+
+        describe('with waitForCleanupOnDestroy configuration', () => {
+            let originalEmbedConfig: any;
+
+            beforeEach(() => {
+                originalEmbedConfig = embedConfig.getEmbedConfig();
+            });
+
+            afterEach(() => {
+                embedConfig.setEmbedConfig(originalEmbedConfig);
+            });
+
+            it('should trigger DestroyEmbed event immediately when waitForCleanupOnDestroy is false', async () => {
+                embedConfig.setEmbedConfig({
+                    ...originalEmbedConfig,
+                    waitForCleanupOnDestroy: false,
+                });
+
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+
+                const triggerSpy = jest.spyOn(appEmbed, 'trigger').mockResolvedValue(null);
+                const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+                appEmbed.destroy();
+
+                expect(triggerSpy).toHaveBeenCalledWith(HostEvent.DestroyEmbed);
+                expect(removeChildSpy).toHaveBeenCalled();
+            });
+
+            it('should trigger DestroyEmbed event and wait for cleanup when waitForCleanupOnDestroy is true', async () => {
+                embedConfig.setEmbedConfig({
+                    ...originalEmbedConfig,
+                    waitForCleanupOnDestroy: true,
+                    cleanupTimeout: 1000,
+                });
+
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+
+                const triggerSpy = jest.spyOn(appEmbed, 'trigger').mockResolvedValue(null);
+                const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+                appEmbed.destroy();
+
+                // Should be called immediately when waitForCleanupOnDestroy is true
+                expect(triggerSpy).toHaveBeenCalledWith(HostEvent.DestroyEmbed);
+                
+                // Wait for the timeout to complete
+                await new Promise(resolve => setTimeout(resolve, 1100));
+
+                expect(removeChildSpy).toHaveBeenCalled();
+            });
+
+            it('should handle Promise.race with successful cleanup completion', async () => {
+                embedConfig.setEmbedConfig({
+                    ...originalEmbedConfig,
+                    waitForCleanupOnDestroy: true,
+                    cleanupTimeout: 2000,
+                });
+
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+
+                // Mock trigger to resolve quickly (before timeout)
+                const triggerSpy = jest.spyOn(appEmbed, 'trigger').mockImplementation(() => 
+                    new Promise(resolve => setTimeout(() => resolve(null), 100))
+                );
+                const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+                appEmbed.destroy();
+
+                // Wait for the trigger to complete
+                await new Promise(resolve => setTimeout(resolve, 200));
+
+                expect(triggerSpy).toHaveBeenCalledWith(HostEvent.DestroyEmbed);
+                expect(removeChildSpy).toHaveBeenCalled();
+            });
+
+            it('should handle Promise.race with timeout when cleanup takes too long', async () => {
+                embedConfig.setEmbedConfig({
+                    ...originalEmbedConfig,
+                    waitForCleanupOnDestroy: true,
+                    cleanupTimeout: 100,
+                });
+
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+
+                // Mock trigger to take longer than timeout
+                const triggerSpy = jest.spyOn(appEmbed, 'trigger').mockImplementation(() => 
+                    new Promise(resolve => setTimeout(() => resolve(null), 500))
+                );
+                const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+                appEmbed.destroy();
+
+                // Wait for the timeout to complete
+                await new Promise(resolve => setTimeout(resolve, 200));
+
+                expect(triggerSpy).toHaveBeenCalledWith(HostEvent.DestroyEmbed);
+                expect(removeChildSpy).toHaveBeenCalled();
+            });
+        });
+    });
 });

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;
@@ -1432,8 +1396,21 @@ export class TsEmbed {
     public destroy(): void {
         try {
             this.removeFullscreenChangeHandler();
-            this.insertedDomEl?.parentNode.removeChild(this.insertedDomEl);
             this.unsubscribeToEvents();
+            if (!getEmbedConfig().waitForCleanupOnDestroy) {
+                this.trigger(HostEvent.DestroyEmbed)
+                this.insertedDomEl?.parentNode?.removeChild(this.insertedDomEl);
+            } else {
+                const cleanupTimeout = getEmbedConfig().cleanupTimeout;
+                Promise.race([
+                    this.trigger(HostEvent.DestroyEmbed),
+                    new Promise((resolve) => setTimeout(resolve, cleanupTimeout)),
+                ]).then(() => {
+                    this.insertedDomEl?.parentNode?.removeChild(this.insertedDomEl);
+                }).catch((e) => {
+                    logger.log('Error destroying TS Embed', e);
+                });
+            }
         } catch (e) {
             logger.log('Error destroying TS Embed', e);
         }

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

@@ -30,10 +30,10 @@ import {
 import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from './embed/liveboard';
 import { SearchEmbed, SearchViewConfig } from './embed/search';
 import { SearchBarEmbed, SearchBarViewConfig } from './embed/search-bar';
-import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversation, BodylessConversationViewConfig } from './embed/bodyless-conversation';
+import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversation, BodylessConversationViewConfig} from './embed/bodyless-conversation';
 import { SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed, ConversationViewConfig } from './embed/conversation';
 import {
-    AuthFailureType, AuthStatus, AuthEvent,
+    AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter,
 } from './auth';
 import { getSessionInfo } from './utils/sessionInfoService';
 import {
@@ -64,7 +64,6 @@ import {
     ListPageColumns,
     CustomActionsPosition,
     CustomActionTarget,
-    InterceptedApiType,
 } from './types';
 import { CustomCssVariables } from './css-variables';
 import { SageEmbed, SageViewConfig } from './embed/sage';
@@ -106,6 +105,7 @@ export {
     AuthFailureType,
     AuthStatus,
     AuthEvent,
+    AuthEventEmitter,
     AnswerService,
     // types
     SessionInterface,
@@ -152,7 +152,6 @@ export {
     DataPanelCustomColumnGroupsAccordionState,
     CustomActionsPosition,
     CustomActionTarget,
-    InterceptedApiType,
 };
 
 export { resetCachedAuthToken } from './authToken';

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

@@ -6,14 +6,6 @@ describe('Exports', () => {
     });
 
     it('should not have undefined exports', () => {
-        const undefinedKeys = Object.entries(Exports)
-            .filter(([, exportValue]) => !Boolean(exportValue))
-            .map(([key]) => key);
-        // Helpful log if the expectation fails
-        if (undefinedKeys.length) {
-            // eslint-disable-next-line no-console
-            console.log('Undefined re-exports in all-types-export:', undefinedKeys);
-        }
-        Object.entries(Exports).forEach(([, exportValue]) => { expect(Boolean(exportValue)).toBe(true); });
+        Object.entries(Exports).forEach(([, exportValue]) => {expect(Boolean(exportValue)).toBe(true);});
     });
 });

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

@@ -29,29 +29,23 @@ export {
     AuthFailureType,
     AuthStatus,
     AuthEvent,
-    // value exports
+    AuthEventEmitter,
+    // types
     Page,
     AuthType,
+    RuntimeFilter,
     RuntimeFilterOp,
     EmbedEvent,
     HostEvent,
     DataSourceVisualMode,
     Action,
-    PrefetchFeatures,
-    resetCachedAuthToken,
-    DataPanelCustomColumnGroupsAccordionState,
-    InterceptedApiType,
-} from '../index';
-
-export type {
-    // type-only exports
-    RuntimeFilter,
     EmbedConfig,
     SearchViewConfig,
     SearchBarViewConfig,
     LiveboardViewConfig,
     SageViewConfig,
     AppViewConfig,
+    PrefetchFeatures,
     FrameParams,
     DOMSelector,
     MessageOptions,
@@ -62,5 +56,9 @@ export type {
     customCssInterface,
     CustomCssVariables,
     RuntimeParameter,
+    resetCachedAuthToken,
     UIPassthroughEvent,
+    DataPanelCustomColumnGroupsAccordionState,
+    CustomActionsPosition,
+    CustomActionTarget,
 } from '../index';