@thoughtspot/visual-embed-sdk 1.41.1 → 1.42.1-alpha.1

package/src/embed/ts-embed.ts

@@ -71,6 +71,7 @@ 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;
 
@@ -199,11 +200,11 @@ export class TsEmbed {
         uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_EMBED_CREATE, {
             ...viewConfig,
         });
-        this.hostEventClient = new HostEventClient(this.iFrame);
+        const embedConfig = getEmbedConfig();
+        this.embedConfig = embedConfig;
 
+        this.hostEventClient = new HostEventClient(this.iFrame);
         this.isReadyForRenderPromise = getInitPromise().then(async () => {
-            const embedConfig = getEmbedConfig();
-            this.embedConfig = embedConfig;
             if (!embedConfig.authTriggerContainer && !embedConfig.useEventForSAMLPopup) {
                 this.embedConfig.authTriggerContainer = domSelector;
             }
@@ -312,31 +313,11 @@ export class TsEmbed {
     private subscribedListeners: Record<string, any> = {};
 
     /**
-     * Adds a global event listener to window for "message" events.
-     * ThoughtSpot detects if a particular event is targeted to this
-     * embed instance through an identifier contained in the payload,
-     * and executes the registered callbacks accordingly.
+     * Subscribe to network events (online/offline) that should
+     * work regardless of auth status
      */
-    private subscribeToEvents() {
-        this.unsubscribeToEvents();
-        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);
+    private subscribeToNetworkEvents() {
+        this.unsubscribeToNetworkEvents();
 
         const onlineEventListener = (e: Event) => {
             this.trigger(HostEvent.Reload);
@@ -344,7 +325,7 @@ export class TsEmbed {
         window.addEventListener('online', onlineEventListener);
 
         const offlineEventListener = (e: Event) => {
-            const offlineWarning = 'Network not Detected. Embed is offline. Please reconnect and refresh';
+            const offlineWarning = ERROR_MESSAGE.OFFLINE_WARNING;
             this.executeCallbacks(EmbedEvent.Error, {
                 offlineWarning,
             });
@@ -352,11 +333,84 @@ export class TsEmbed {
         };
         window.addEventListener('offline', offlineEventListener);
 
-        this.subscribedListeners = {
-            message: messageEventListener,
-            online: onlineEventListener,
-            offline: offlineEventListener,
-        };
+        this.subscribedListeners.online = onlineEventListener;
+        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);
+
+        this.subscribedListeners.message = this.messageEventListener;
+    }
+   
+
+    /**
+     * Adds event listeners for both network and message events.
+     * This maintains backward compatibility with the existing method.
+     * Adds a global event listener to window for "message" events.
+     * ThoughtSpot detects if a particular event is targeted to this
+     * embed instance through an identifier contained in the payload,
+     * and executes the registered callbacks accordingly.
+     */
+    private subscribeToEvents() {
+        this.subscribeToNetworkEvents();
+        this.subscribeToMessageEvents();
+    }
+
+
+    private unsubscribeToNetworkEvents() {
+        if (this.subscribedListeners.online) {
+            window.removeEventListener('online', this.subscribedListeners.online);
+            delete this.subscribedListeners.online;
+        }
+        if (this.subscribedListeners.offline) {
+            window.removeEventListener('offline', this.subscribedListeners.offline);
+            delete this.subscribedListeners.offline;
+        }
+    }
+
+    private unsubscribeToMessageEvents() {
+        if (this.subscribedListeners.message) {
+            window.removeEventListener('message', this.subscribedListeners.message);
+            delete this.subscribedListeners.message;
+        }
     }
 
     private unsubscribeToEvents() {
@@ -391,7 +445,7 @@ export class TsEmbed {
                 message: customActionsResult.errors,
             });
         }
-        return {
+        const baseInitData = {
             customisations: getCustomisations(this.embedConfig, this.viewConfig),
             authToken,
             runtimeFilterParams: this.viewConfig.excludeRuntimeFiltersfromURL
@@ -410,7 +464,10 @@ export class TsEmbed {
                 this.embedConfig.customVariablesForThirdPartyTools || {},
             hiddenListColumns: this.viewConfig.hiddenListColumns || [],
             customActions: customActionsResult.actions,
+            ...getInterceptInitData(this.embedConfig, this.viewConfig),
         };
+
+        return baseInitData;
     }
 
     protected async getAppInitData() {
@@ -494,10 +551,10 @@ export class TsEmbed {
         this.on(EmbedEvent.APP_INIT, this.appInitCb, { start: false }, true);
         this.on(EmbedEvent.AuthExpire, this.updateAuthToken, { start: false }, true);
         this.on(EmbedEvent.IdleSessionTimeout, this.idleSessionTimeout, { start: false }, true);
-        
-        const embedListenerReadyHandler = this.createEmbedContainerHandler(EmbedEvent.EmbedListenerReady);  
+
+        const embedListenerReadyHandler = this.createEmbedContainerHandler(EmbedEvent.EmbedListenerReady);
         this.on(EmbedEvent.EmbedListenerReady, embedListenerReadyHandler, { start: false }, true);
-        
+
         const authInitHandler = this.createEmbedContainerHandler(EmbedEvent.AuthInit);
         this.on(EmbedEvent.AuthInit, authInitHandler, { start: false }, true);
     };
@@ -520,6 +577,12 @@ export class TsEmbed {
         return `${basePath}#`;
     }
 
+    protected getUpdateEmbedParamsObject() {
+        let queryParams = this.getEmbedParamsObject();
+        queryParams = { ...this.viewConfig, ...queryParams };
+        return queryParams;
+    }
+
     /**
      * Common query params set for all the embed modes.
      * @param queryParams
@@ -702,10 +765,15 @@ export class TsEmbed {
     }
 
     protected getEmbedParams() {
-        const queryParams = this.getBaseQueryParams();
+        const queryParams = this.getEmbedParamsObject();
         return getQueryParamString(queryParams);
     }
 
+    protected getEmbedParamsObject() {
+        const params = this.getBaseQueryParams();
+        return params;
+    }
+
     protected getRootIframeSrc() {
         const query = this.getEmbedParams();
         return this.getEmbedBasePath(query);
@@ -787,6 +855,9 @@ export class TsEmbed {
 
             uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_RENDER_START);
 
+            // Always subscribe to network events, regardless of auth status
+            this.subscribeToNetworkEvents();
+
             return getAuthPromise()
                 ?.then((isLoggedIn: boolean) => {
                     if (!isLoggedIn) {
@@ -832,7 +903,9 @@ export class TsEmbed {
                             el.remove();
                         });
                     }
-                    this.subscribeToEvents();
+                    // Subscribe to message events only after successful
+                    // auth and iframe setup
+                    this.subscribeToMessageEvents();
                 })
                 .catch((error) => {
                     nextInQueue();
@@ -972,6 +1045,21 @@ 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
@@ -996,9 +1084,8 @@ export class TsEmbed {
                 // payload
                 || (!callbackObj.options.start && dataStatus === embedEventStatus.END)
             ) {
-                callbackObj.callback(data, (payload) => {
-                    this.triggerEventOnPort(eventPort, payload);
-                });
+                const responder = this.createEmbedEventResponder(eventPort, eventType);
+                callbackObj.callback(data, responder);
             }
         });
     }
@@ -1141,10 +1228,10 @@ 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.
-     */
+    * @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;
 
     /**
@@ -1191,7 +1278,7 @@ export class TsEmbed {
         } else {
             logger.debug('pushing callback to embedContainerReadyCallbacks', callback);
             this.embedContainerReadyCallbacks.push(callback);
-          }
+        }
     }
 
     protected createEmbedContainerHandler = (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => {
@@ -1232,6 +1319,16 @@ export class TsEmbed {
             this.handleError('Host event type is undefined');
             return null;
         }
+
+        // Check if iframe exists before triggering - 
+        // this prevents the error when auth fails
+        if (!this.iFrame) {
+            logger.debug(
+                `Cannot trigger ${messageType} - iframe not available (likely due to auth failure)`,
+            );
+            return null;
+        }
+
         // send an empty object, this is needed for liveboard default handlers
         return this.hostEventClient.triggerHostEvent(messageType, data);
     }
@@ -1279,6 +1376,7 @@ export class TsEmbed {
      * Creates the preRender shell
      * @param showPreRenderByDefault - Show the preRender after render, hidden by default
      */
+
     public async preRender(showPreRenderByDefault = false, replaceExistingPreRender = false): Promise<TsEmbed> {
         if (!this.viewConfig.preRenderId) {
             logger.error(ERROR_MESSAGE.PRERENDER_ID_MISSING);
@@ -1286,7 +1384,7 @@ export class TsEmbed {
         }
         this.isPreRendered = true;
         this.showPreRenderByDefault = showPreRenderByDefault;
-        
+
         const isAlreadyRendered = this.connectPreRendered();
         if (isAlreadyRendered && !replaceExistingPreRender) {
             return this;
@@ -1413,8 +1511,14 @@ export class TsEmbed {
                 return this.preRender(true);
             }
             this.validatePreRenderViewConfig(this.viewConfig);
+            logger.debug('triggering UpdateEmbedParams', this.viewConfig);
+            this.executeAfterEmbedContainerLoaded(() => {
+                this.trigger(HostEvent.UpdateEmbedParams, this.getUpdateEmbedParamsObject());
+            });
         }
 
+        this.beforePrerenderVisible();
+
         if (this.el) {
             this.syncPreRenderStyle();
             if (!this.viewConfig.doNotTrackPreRenderSize) {
@@ -1432,8 +1536,6 @@ export class TsEmbed {
             }
         }
 
-        this.beforePrerenderVisible();
-
         removeStyleProperties(this.preRenderWrapper, ['z-index', 'opacity', 'pointer-events']);
 
         this.subscribeToEvents();

package/src/errors.ts

@@ -19,6 +19,7 @@ export const ERROR_MESSAGE = {
     MISSING_REPORTING_OBSERVER: 'ReportingObserver not supported',
     RENDER_CALLED_BEFORE_INIT: 'Looks like render was called before calling init, the render won\'t start until init is called.\nFor more info check\n1. https://developers.thoughtspot.com/docs/Function_init#_init\n2.https://developers.thoughtspot.com/docs/getting-started#initSdk',
     SPOTTER_AGENT_NOT_INITIALIZED: 'SpotterAgent not initialized',
+    OFFLINE_WARNING : 'Network not Detected. Embed is offline. Please reconnect and refresh',
 };
 
 export const CUSTOM_ACTIONS_ERROR_MESSAGE = {

package/src/index.ts

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

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

@@ -6,6 +6,6 @@ describe('Exports', () => {
     });
 
     it('should not have undefined exports', () => {
-        Object.keys(Exports).forEach((exportKey) => expect(Boolean(Exports[exportKey])).toBe(true));
+        Object.entries(Exports).forEach(([, exportValue]) => {expect(Boolean(exportValue)).toBe(true);});
     });
 });

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

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

package/src/react/util.spec.tsx

@@ -0,0 +1,88 @@
+import { getViewPropsAndListeners } from './util';
+import { EmbedEvent, MessageCallback } from '../types';
+
+describe('React util functions', () => {
+    describe('getViewPropsAndListeners', () => {
+        test('should return empty viewConfig and listeners for empty props', () => {
+            const props = {};
+            const result = getViewPropsAndListeners(props);
+
+            expect(result.viewConfig).toEqual({});
+            expect(result.listeners).toEqual({});
+        });
+
+        test('should separate view config properties from props', () => {
+            const props = {
+                frameParams: { width: 100, height: 200 },
+                showLiveboardTitle: true,
+                liveboardId: 'test-liveboard-id',
+                vizId: 'test-viz-id',
+                className: 'test-class',
+                style: { color: 'red' },
+            };
+
+            const result = getViewPropsAndListeners(props);
+
+            expect(result.viewConfig).toEqual({
+                frameParams: { width: 100, height: 200 },
+                showLiveboardTitle: true,
+                liveboardId: 'test-liveboard-id',
+                vizId: 'test-viz-id',
+                className: 'test-class',
+                style: { color: 'red' },
+            });
+            expect(result.listeners).toEqual({});
+        });
+
+        test('should separate event handlers from props', () => {
+            const onInit: MessageCallback = jest.fn();
+            const onLoad: MessageCallback = jest.fn();
+            const onData: MessageCallback = jest.fn();
+
+            const props = {
+                onInit,
+                onLoad,
+                onData,
+            };
+
+            const result = getViewPropsAndListeners(props);
+
+            expect(result.viewConfig).toEqual({});
+            expect(result.listeners).toEqual({
+                [EmbedEvent.Init]: onInit,
+                [EmbedEvent.Load]: onLoad,
+                [EmbedEvent.Data]: onData,
+            });
+        });
+
+        test('should handle both view config and event handlers', () => {
+            const onInit: MessageCallback = jest.fn();
+            const onAuthInit: MessageCallback = jest.fn();
+            const onQueryChanged: MessageCallback = jest.fn();
+
+            const props = {
+                liveboardId: 'test-liveboard-id',
+                showLiveboardTitle: false,
+                frameParams: { height: 500 },
+                onInit,
+                onAuthInit,
+                onQueryChanged,
+                className: 'embed-container',
+            };
+
+            const result = getViewPropsAndListeners(props);
+
+            expect(result.viewConfig).toEqual({
+                liveboardId: 'test-liveboard-id',
+                showLiveboardTitle: false,
+                frameParams: { height: 500 },
+                className: 'embed-container',
+            });
+            expect(result.listeners).toEqual({
+                [EmbedEvent.Init]: onInit,
+                [EmbedEvent.AuthInit]: onAuthInit,
+                [EmbedEvent.QueryChanged]: onQueryChanged,
+            });
+        });
+    });
+});

package/src/react/util.ts

@@ -24,10 +24,10 @@ export function getViewPropsAndListeners<
     return Object.keys(props).reduce(
         (accu, key) => {
             if (key.startsWith('on')) {
-                const eventName = key.substr(2);
-                accu.listeners[EmbedEvent[eventName]] = props[key];
+                const eventName = key.substr(2) as any;
+                (accu.listeners as any)[EmbedEvent[eventName as keyof typeof EmbedEvent] as any] = props[key as keyof T];
             } else {
-                accu.viewConfig[key] = props[key];
+                (accu.viewConfig as any)[key] = props[key as keyof T];
             }
             return accu;
         },