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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.42.1-alpha.6",
+    "version": "1.42.1",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -57,7 +57,7 @@
         "test": "npm run test-sdk",
         "posttest": "cat ./coverage/sdk/lcov.info | npx coveralls-next",
         "is-publish-allowed": "node scripts/is-publish-allowed.js",
-        "prepublishOnly": "npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
+        "prepublishOnly": "npm run is-publish-allowed && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
         "check-size": "npm run build && size-limit",
         "publish-dev": "npm publish --tag dev",
         "publish-prod": "npm publish --tag latest",
@@ -92,6 +92,7 @@
         "@testing-library/user-event": "^13.1.8",
         "@types/jest": "^22.2.3",
         "@types/lodash": "^4.17.0",
+        "@types/mixpanel-browser": "^2.35.6",
         "@types/react-test-renderer": "^17.0.1",
         "@typescript-eslint/eslint-plugin": "^8.28.0",
         "@typescript-eslint/parser": "^8.28.0",

package/src/embed/app.spec.ts

@@ -430,6 +430,51 @@ describe('App embed tests', () => {
         });
     });
 
+    test('Should add the hideTagFilterChips true to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            showPrimaryNavbar: false,
+            hideTagFilterChips: true,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}&hideTagFilterChips=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+    
+    test('Should add the hideTagFilterChips false to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            showPrimaryNavbar: false,
+            hideTagFilterChips: false,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}&hideTagFilterChips=false${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('Should not add hideTagFilterChips if it is undefined', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            showPrimaryNavbar: false,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add enableSearchAssist flagto the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/app.ts

@@ -19,7 +19,6 @@ import {
     AllEmbedViewConfig,
 } from '../types';
 import { V1Embed } from './ts-embed';
-import { getInterceptInitData } from '../api-intercept';
 
 /**
  * Pages within the ThoughtSpot app that can be embedded.
@@ -368,6 +367,26 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      * ```
      */
     tag?: string;
+    /**
+     * Hide tag filter chips that appear when content is filtered by tags.
+     * When enabled, this automatically:
+     * - Hides tag filter indicators/chips from the UI
+     * 
+     * This provides a clean interface without tag-related UI elements.
+     *
+     * Supported embed types: `AppEmbed`
+     * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
+     * @example
+     * ```js
+     * // Simple usage - automatically hides all tag-related UI
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    tag: 'Some Tag',
+     *    hideTagFilterChips: true, // This is all you need!
+     * });
+     * ```
+     */
+    hideTagFilterChips?: boolean;
     /**
      * The array of GUIDs to be hidden
      * 
@@ -626,6 +645,7 @@ export class AppEmbed extends V1Embed {
     protected getEmbedParams() {
         const {
             tag,
+            hideTagFilterChips,
             hideObjects,
             liveboardV2,
             showPrimaryNavbar,
@@ -729,9 +749,7 @@ export class AppEmbed extends V1Embed {
             params[Param.enableAskSage] = enableAskSage;
         }
 
-        const { enableApiIntercept } = getInterceptInitData(this.embedConfig, this.viewConfig);
-
-        if (isOnBeforeGetVizDataInterceptEnabled && !enableApiIntercept) {
+        if (isOnBeforeGetVizDataInterceptEnabled) {
 
             params[
                 Param.IsOnBeforeGetVizDataInterceptEnabled
@@ -753,6 +771,10 @@ export class AppEmbed extends V1Embed {
         if (isPNGInScheduledEmailsEnabled !== undefined) {
             params[Param.isPNGInScheduledEmailsEnabled] = isPNGInScheduledEmailsEnabled;
         }
+        
+        if (hideTagFilterChips !== undefined) {
+            params[Param.HideTagFilterChips] = hideTagFilterChips;
+        }
 
         if (isLinkParametersEnabled !== undefined) {
             params[Param.isLinkParametersEnabled] = isLinkParametersEnabled;

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/hostEventClient/host-event-client.ts

@@ -23,7 +23,7 @@ export class HostEventClient {
    * @param {any} data Data to send with the host event
    * @returns {Promise<any>} - the response from the process trigger
    */
-  protected async processTrigger(message: HostEvent, data: any): Promise<any> {
+  protected async processTrigger(message: HostEvent, data: any, context?: any): Promise<any> {
       if (!this.iFrame) {
           throw new Error('Iframe element is not set');
       }
@@ -34,6 +34,7 @@ export class HostEventClient {
           message,
           thoughtspotHost,
           data,
+          context,
       );
   }
 
@@ -65,8 +66,9 @@ export class HostEventClient {
   public async hostEventFallback(
       hostEvent: HostEvent,
       data: any,
+      context?: any,
   ): Promise<any> {
-      return this.processTrigger(hostEvent, data);
+      return this.processTrigger(hostEvent, data, context);
   }
 
   /**
@@ -132,9 +134,11 @@ export class HostEventClient {
   public async triggerHostEvent<
     HostEventT extends HostEvent,
     PayloadT,
+    ContextT,
   >(
       hostEvent: HostEventT,
       payload?: TriggerPayload<PayloadT, HostEventT>,
+      context?: ContextT,
   ): Promise<TriggerResponse<PayloadT, HostEventT>> {
       switch (hostEvent) {
           case HostEvent.Pin:
@@ -144,7 +148,7 @@ export class HostEventClient {
                   payload as HostEventRequest<HostEvent.SaveAnswer>,
               ) as any;
           default:
-              return this.hostEventFallback(hostEvent, payload);
+              return this.hostEventFallback(hostEvent, payload, context as any);
       }
   }
 }

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
@@ -1307,6 +1271,7 @@ export class TsEmbed {
     public async trigger<HostEventT extends HostEvent, PayloadT>(
         messageType: HostEventT,
         data: TriggerPayload<PayloadT, HostEventT> = {} as any,
+        context: any = {},
     ): Promise<TriggerResponse<PayloadT, HostEventT>> {
         uploadMixpanelEvent(`${MIXPANEL_EVENT.VISUAL_SDK_TRIGGER}-${messageType}`);
 
@@ -1330,7 +1295,7 @@ export class TsEmbed {
         }
 
         // send an empty object, this is needed for liveboard default handlers
-        return this.hostEventClient.triggerHostEvent(messageType, data);
+        return this.hostEventClient.triggerHostEvent(messageType, data, context);
     }
 
     /**
@@ -1384,7 +1349,7 @@ export class TsEmbed {
         }
         this.isPreRendered = true;
         this.showPreRenderByDefault = showPreRenderByDefault;
-
+        
         const isAlreadyRendered = this.connectPreRendered();
         if (isAlreadyRendered && !replaceExistingPreRender) {
             return this;

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,4 @@ export {
     resetCachedAuthToken,
     UIPassthroughEvent,
     DataPanelCustomColumnGroupsAccordionState,
-    InterceptedApiType,
 } from '../index';