@thoughtspot/visual-embed-sdk 1.35.5-hostEvent.6 → 1.35.5-hostEvent.7

package/lib/src/visual-embed-sdk.d.ts

@@ -29,8 +29,8 @@ declare module '@thoughtspot/visual-embed-sdk' {
     import { tokenizedFetch } from '@thoughtspot/visual-embed-sdk/tokenizedFetch';
     import { getAnswerFromQuery } from '@thoughtspot/visual-embed-sdk/utils/graphql/nlsService/nls-answer-service';
     import { createLiveboardWithAnswers } from '@thoughtspot/visual-embed-sdk/utils/liveboardService/liveboardService';
-    import { UiPassthroughEvent } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
-    export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UiPassthroughEvent, };
+    import { UIPassthroughEvent } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
+    export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, };
     export { resetCachedAuthToken } from '@thoughtspot/visual-embed-sdk/authToken';
 }
 
@@ -4960,7 +4960,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * EmbedApi
                 * @hidden
                 */
-            UiPassthrough = "UiPassthrough"
+            UIPassthrough = "UiPassthrough"
     }
     /**
         * The different visual modes that the data sources panel within
@@ -7145,16 +7145,16 @@ declare module '@thoughtspot/visual-embed-sdk/utils/liveboardService/liveboardSe
 
 declare module '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts' {
     import { HostEvent } from '@thoughtspot/visual-embed-sdk/types';
-    export enum UiPassthroughEvent {
-        addVizToPinboard = "addVizToPinboard",
-        saveAnswer = "saveAnswer",
-        getDiscoverabilityStatus = "getDiscoverabilityStatus",
-        getAvailableUiPassthroughs = "getAvailableUiPassthroughs",
-        getAnswerPageConfig = "getAnswerPageConfig",
-        getPinboardPageConfig = "getPinboardPageConfig"
+    export enum UIPassthroughEvent {
+        PinAnswerToLiveboard = "addVizToPinboard",
+        SaveAnswer = "saveAnswer",
+        GetDiscoverabilityStatus = "getDiscoverabilityStatus",
+        GetAvailableUIPassthroughs = "getAvailableUIPassthroughs",
+        GetAnswerConfig = "getAnswerPageConfig",
+        GetLiveboardConfig = "getPinboardPageConfig"
     }
-    export type UiPassthroughContractBase = {
-        [UiPassthroughEvent.addVizToPinboard]: {
+    export type UIPassthroughContractBase = {
+        [UIPassthroughEvent.PinAnswerToLiveboard]: {
             request: {
                 vizId?: string;
                 newVizName: string;
@@ -7170,7 +7170,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts' {
                 vizId: string;
             };
         };
-        [UiPassthroughEvent.saveAnswer]: {
+        [UIPassthroughEvent.SaveAnswer]: {
             request: {
                 name: string;
                 description: string;
@@ -7179,53 +7179,49 @@ declare module '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts' {
             };
             response: {
                 answerId: string;
-                saveResponse: any;
+                saveResponse?: any;
                 shareResponse?: any;
-                errors?: any;
             };
         };
-        [UiPassthroughEvent.getDiscoverabilityStatus]: {
+        [UIPassthroughEvent.GetDiscoverabilityStatus]: {
             request: any;
             response: {
                 shouldShowDiscoverability: boolean;
                 isDiscoverabilityCheckboxUnselectedPerOrg: boolean;
             };
         };
-        [UiPassthroughEvent.getAvailableUiPassthroughs]: {
+        [UIPassthroughEvent.GetAvailableUIPassthroughs]: {
             request: any;
             response: {
                 keys: string[];
             };
         };
-        [UiPassthroughEvent.getAnswerPageConfig]: {
+        [UIPassthroughEvent.GetAnswerConfig]: {
             request: {
                 vizId?: string;
             };
             response: any;
         };
-        [UiPassthroughEvent.getPinboardPageConfig]: {
+        [UIPassthroughEvent.GetLiveboardConfig]: {
             request: any;
             response: any;
         };
     };
-    export type FlattenType<T> = T extends infer R ? {
-        [K in keyof R]: R[K];
-    } : never;
-    export type UiPassthroughRequest<T extends keyof UiPassthroughContractBase> = FlattenType<UiPassthroughContractBase[T]['request']>;
-    export type UiPassthroughResponse<T extends keyof UiPassthroughContractBase> = FlattenType<UiPassthroughContractBase[T]['response']>;
-    export type UiPassthroughArrayResponse<ApiName extends keyof UiPassthroughContractBase> = Promise<Array<{
+    export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]['request'];
+    export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]['response'];
+    export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> = Array<{
         redId?: string;
-        value?: UiPassthroughResponse<ApiName>;
+        value?: UIPassthroughResponse<ApiName>;
         error?: any;
-    }>>;
+    }>;
     export type EmbedApiHostEventMapping = {
-        [HostEvent.Pin]: UiPassthroughEvent.addVizToPinboard;
-        [HostEvent.SaveAnswer]: UiPassthroughEvent.saveAnswer;
+        [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
+        [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
     };
-    export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? FlattenType<UiPassthroughRequest<EmbedApiHostEventMapping[HostEventT]>> : any;
-    export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? {
-        value?: UiPassthroughResponse<EmbedApiHostEventMapping[HostEventT]>;
-    } : any;
+    export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
+    export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
+    export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
+    export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
 }
 
 declare module '@thoughtspot/visual-embed-sdk/authToken' {
@@ -7255,7 +7251,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
         * @summary Base classes
         * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
         */
-    import { HostEventRequest, HostEventResponse, UiPassthroughArrayResponse, UiPassthroughEvent, UiPassthroughRequest } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
+    import { TriggerPayload, TriggerResponse, UIPassthroughArrayResponse, UIPassthroughEvent, UIPassthroughRequest } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
     import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
     import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { HostEventClient } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/host-event-client';
@@ -7290,6 +7286,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * will be rendered.
                 */
             protected iFrame: HTMLIFrameElement;
+            /**
+                * Setter for the iframe element
+                * @param {HTMLIFrameElement} iFrame HTMLIFrameElement
+                */
+            protected setIframeElement(iFrame: HTMLIFrameElement): void;
             protected viewConfig: ViewConfig;
             protected embedConfig: EmbedConfig;
             /**
@@ -7421,19 +7422,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
             off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
             /**
                 * Triggers an event to the embedded app
-                * @param messageType The event type
-                * @param data The payload to send with the message
+                * @param {HostEvent} messageType The event type
+                * @param {any} data The payload to send with the message
                 * @returns A promise that resolves with the response from the embedded app
                 */
-            trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
+            trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
             /**
                 * Triggers an event to the embedded app, skipping the UI flow.
-                * @param {UiPassthroughEvent} apiName - The name of the API to be triggered.
-                * @param {UiPassthroughRequest} parameters - The parameters to be passed to the API.
-                * @returns {Promise<UiPassthroughRequest>} - A promise that resolves with the response
+                * @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
+                * @param {UIPassthroughRequest} parameters - The parameters to be passed to the API.
+                * @returns {Promise<UIPassthroughRequest>} - A promise that resolves with the response
                 * from the embedded app.
                 */
-            triggerUiPassThrough<UiPassthroughEventT extends UiPassthroughEvent>(apiName: UiPassthroughEventT, parameters: UiPassthroughRequest<UiPassthroughEventT>): UiPassthroughArrayResponse<UiPassthroughEventT>;
+            triggerUIPassThrough<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
             /**
                 * Marks the ThoughtSpot object to have been rendered
                 * Needs to be overridden by subclasses to do the actual
@@ -7555,14 +7556,28 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
 
 declare module '@thoughtspot/visual-embed-sdk/embed/hostEventClient/host-event-client' {
     import { HostEvent } from '@thoughtspot/visual-embed-sdk/types';
-    import { UiPassthroughArrayResponse, UiPassthroughEvent, HostEventRequest, HostEventResponse, UiPassthroughRequest, UiPassthroughResponse } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
+    import { UIPassthroughArrayResponse, UIPassthroughEvent, HostEventRequest, HostEventResponse, UIPassthroughRequest, UIPassthroughResponse, TriggerPayload, TriggerResponse } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
     export class HostEventClient {
-        thoughtSpotHost: string;
-        constructor(thoughtSpotHost: string);
-        executeUiPassthroughApi<UiPassthroughEventT extends UiPassthroughEvent>(iFrame: HTMLIFrameElement, apiName: UiPassthroughEventT, parameters: UiPassthroughRequest<UiPassthroughEventT>): UiPassthroughArrayResponse<UiPassthroughEventT>;
-        handleUiPassthroughForHostEvent<UiPassthroughEventT extends UiPassthroughEvent>(iFrame: HTMLIFrameElement, apiName: UiPassthroughEventT, parameters: UiPassthroughRequest<UiPassthroughEventT>): Promise<UiPassthroughResponse<UiPassthroughEventT>>;
-        hostEventFallback(iFrame: HTMLIFrameElement, hostEvent: HostEvent, data: any): Promise<any>;
-        executeHostEvent<T extends HostEvent>(iFrame: HTMLIFrameElement, hostEvent: HostEvent, payload?: HostEventRequest<T>): Promise<HostEventResponse<HostEvent>>;
+            iFrame: HTMLIFrameElement;
+            constructor(iFrame?: HTMLIFrameElement);
+            /**
+                * A wrapper over process trigger to
+                * @param {HostEvent} message Host event to send
+                * @param {any} data Data to send with the host event
+                * @returns {Promise<any>} - the response from the process trigger
+                */
+            protected processTrigger(message: HostEvent, data: any): Promise<any>;
+            handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
+            hostEventFallback(hostEvent: HostEvent, data: any): Promise<any>;
+            /**
+                * Setter for the iframe element used for host events
+                * @param {HTMLIFrameElement} iFrame - the iframe element to set
+                */
+            setIframeElement(iFrame: HTMLIFrameElement): void;
+            triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
+            protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
+            protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>): Promise<any>;
+            triggerHostEvent<HostEventT extends HostEvent, PayloadT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.35.5-hostEvent.6",
+    "version": "1.35.5-hostEvent.7",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

package/src/embed/hostEventClient/contracts.ts

@@ -1,16 +1,17 @@
 import { HostEvent } from '../../types';
 
-export enum UiPassthroughEvent {
-  addVizToPinboard = 'addVizToPinboard',
-  saveAnswer = 'saveAnswer',
-  getDiscoverabilityStatus = 'getDiscoverabilityStatus',
-  getAvailableUiPassthroughs = 'getAvailableUiPassthroughs',
-  getAnswerPageConfig = 'getAnswerPageConfig',
-  getPinboardPageConfig = 'getPinboardPageConfig',
+export enum UIPassthroughEvent {
+  PinAnswerToLiveboard = 'addVizToPinboard',
+  SaveAnswer = 'saveAnswer',
+  GetDiscoverabilityStatus = 'getDiscoverabilityStatus',
+  GetAvailableUIPassthroughs = 'getAvailableUIPassthroughs',
+  GetAnswerConfig = 'getAnswerPageConfig',
+  GetLiveboardConfig = 'getPinboardPageConfig',
 }
 
-export type UiPassthroughContractBase = {
-  [UiPassthroughEvent.addVizToPinboard]: {
+// UI Passthrough Contract
+export type UIPassthroughContractBase = {
+  [UIPassthroughEvent.PinAnswerToLiveboard]: {
     request: {
       vizId?: string;
       newVizName: string;
@@ -26,7 +27,7 @@ export type UiPassthroughContractBase = {
       vizId: string;
     };
   };
-  [UiPassthroughEvent.saveAnswer]: {
+  [UIPassthroughEvent.SaveAnswer]: {
     request: {
       name: string;
       description: string;
@@ -35,60 +36,70 @@ export type UiPassthroughContractBase = {
     };
     response: {
       answerId: string,
-      saveResponse: any;
+      saveResponse?: any;
       shareResponse?: any;
-      errors?: any;
     };
   };
-  [UiPassthroughEvent.getDiscoverabilityStatus]: {
+  [UIPassthroughEvent.GetDiscoverabilityStatus]: {
     request: any;
     response: {
       shouldShowDiscoverability: boolean;
       isDiscoverabilityCheckboxUnselectedPerOrg: boolean;
     };
   };
-  [UiPassthroughEvent.getAvailableUiPassthroughs]: {
+  [UIPassthroughEvent.GetAvailableUIPassthroughs]: {
     request: any;
     response: {
       keys: string[];
     };
   };
-  [UiPassthroughEvent.getAnswerPageConfig]: {
+  [UIPassthroughEvent.GetAnswerConfig]: {
     request: {
       vizId?: string;
     };
     response: any;
   };
-  [UiPassthroughEvent.getPinboardPageConfig]: {
+  [UIPassthroughEvent.GetLiveboardConfig]: {
     request: any;
     response: any;
   };
 };
 
-export type FlattenType<T> = T extends infer R ? { [K in keyof R]: R[K] } : never;
+// UI Passthrough Request and Response
+export type UIPassthroughRequest<T
+  extends keyof UIPassthroughContractBase
+> = UIPassthroughContractBase[T]['request'];
 
-export type UiPassthroughRequest<T extends keyof UiPassthroughContractBase> = FlattenType<UiPassthroughContractBase[T]['request']>;
-export type UiPassthroughResponse<T extends keyof UiPassthroughContractBase> = FlattenType<UiPassthroughContractBase[T]['response']>;
+export type UIPassthroughResponse<
+  T extends keyof UIPassthroughContractBase
+> = UIPassthroughContractBase[T]['response'];
 
-export type UiPassthroughArrayResponse<ApiName extends keyof UiPassthroughContractBase> =
-  Promise<Array<{
+export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> =
+  Array<{
     redId?: string;
-    value?: UiPassthroughResponse<ApiName>;
+    value?: UIPassthroughResponse<ApiName>;
     error?: any;
-  }>>
+  }>
 
+// Host event and UI Passthrough Event Mapping
 export type EmbedApiHostEventMapping = {
-  [HostEvent.Pin]: UiPassthroughEvent.addVizToPinboard;
-  [HostEvent.SaveAnswer]: UiPassthroughEvent.saveAnswer;
+  [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
+  [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
 }
 
+// Host Event Request and Response
 export type HostEventRequest<HostEventT extends HostEvent> =
-  HostEventT extends keyof EmbedApiHostEventMapping ?
-  FlattenType<UiPassthroughRequest<EmbedApiHostEventMapping[HostEventT]>> : any;
+  HostEventT extends keyof EmbedApiHostEventMapping
+    ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]>
+    : any;
 
 export type HostEventResponse<HostEventT extends HostEvent> =
-  HostEventT extends keyof EmbedApiHostEventMapping ?
-  {
-    value?: UiPassthroughResponse<EmbedApiHostEventMapping[HostEventT]>
-  }
-  : any;
+  HostEventT extends keyof EmbedApiHostEventMapping
+    ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]>
+    : any;
+
+// trigger response and request
+export type TriggerPayload<PayloadT, HostEventT extends HostEvent> =
+  PayloadT | HostEventRequest<HostEventT>;
+export type TriggerResponse<PayloadT, HostEventT extends HostEvent> =
+  PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;

package/src/embed/hostEventClient/host-event-client.spec.ts

@@ -1,10 +1,11 @@
-import { getIFrameEl } from '../../test/test-utils';
+import { getIFrameEl, getRootEl } from '../../test/test-utils';
 import { HostEvent } from '../../types';
 import { processTrigger } from '../../utils/processTrigger';
+import * as EmbedConfigService from '../embedConfig';
 import {
-    UiPassthroughEvent,
-    UiPassthroughRequest,
-    UiPassthroughArrayResponse,
+    UIPassthroughEvent,
+    UIPassthroughRequest,
+    UIPassthroughArrayResponse,
     HostEventRequest,
 } from './contracts';
 import { HostEventClient } from './host-event-client';
@@ -14,23 +15,27 @@ jest.mock('../../utils/processTrigger');
 const mockProcessTrigger = processTrigger as jest.Mock;
 
 const createHostEventClient = () => {
-    const mockIframe = getIFrameEl();
-    const mockThoughtSpotHost = 'http://localhost';
-    const client = new HostEventClient(mockThoughtSpotHost);
-    return { client, mockIframe, mockThoughtSpotHost };
+    const mockIframe = document.createElement('iframe');
+    const client = new HostEventClient(mockIframe);
+    return { client, mockIframe };
 };
 
 describe('HostEventClient', () => {
+    const mockThoughtSpotHost = 'http://localhost';
+    beforeEach(() => {
+        jest.spyOn(EmbedConfigService, 'getEmbedConfig').mockReturnValue({ thoughtSpotHost: mockThoughtSpotHost });
+    });
+
     afterEach(() => {
         jest.clearAllMocks();
     });
 
-    describe('executeUiPassthroughApi', () => {
+    describe('executeUIPassthroughApi', () => {
         it('should call processTrigger with correct parameters and return response', async () => {
-            const { client, mockIframe, mockThoughtSpotHost } = createHostEventClient();
+            const { client, mockIframe } = createHostEventClient();
 
-            const apiName = UiPassthroughEvent.addVizToPinboard;
-            const parameters: UiPassthroughRequest<typeof apiName> = {
+            const apiName = UIPassthroughEvent.PinAnswerToLiveboard;
+            const parameters: UIPassthroughRequest<typeof apiName> = {
                 newVizName: 'testViz',
             };
             const triggerResponse = Promise.resolve([
@@ -39,11 +44,11 @@ describe('HostEventClient', () => {
 
             mockProcessTrigger.mockResolvedValue(triggerResponse);
 
-            const result = await client.executeUiPassthroughApi(getIFrameEl(), apiName, parameters);
+            const result = await client.triggerUIPassthroughApi(apiName, parameters);
 
             expect(mockProcessTrigger).toHaveBeenCalledWith(
                 mockIframe,
-                HostEvent.UiPassthrough,
+                HostEvent.UIPassthrough,
                 mockThoughtSpotHost,
                 {
                     type: apiName,
@@ -54,11 +59,11 @@ describe('HostEventClient', () => {
         });
     });
 
-    describe('handleUiPassthroughForHostEvent', () => {
+    describe('handleUIPassthroughForHostEvent', () => {
         it('should return the value from the first valid response', async () => {
             const { client } = createHostEventClient();
-            const apiName = UiPassthroughEvent.addVizToPinboard;
-            const parameters: UiPassthroughRequest<typeof apiName> = {
+            const apiName = UIPassthroughEvent.PinAnswerToLiveboard;
+            const parameters: UIPassthroughRequest<typeof apiName> = {
                 newVizName: 'testViz',
             };
             const triggerResponse = Promise.resolve([
@@ -66,8 +71,7 @@ describe('HostEventClient', () => {
             ]);
             mockProcessTrigger.mockResolvedValue(triggerResponse);
 
-            const result = await client.handleUiPassthroughForHostEvent(getIFrameEl(),
-                apiName, parameters);
+            const result = await client.handleHostEventWithParam(apiName, parameters);
 
             expect(result).toEqual({
                 pinboardId: 'testPinboard',
@@ -78,50 +82,50 @@ describe('HostEventClient', () => {
 
         it('should throw an error if no valid response is found', async () => {
             const { client } = createHostEventClient();
-            const apiName = UiPassthroughEvent.addVizToPinboard;
-            const parameters: UiPassthroughRequest<typeof apiName> = {
+            const apiName = UIPassthroughEvent.PinAnswerToLiveboard;
+            const parameters: UIPassthroughRequest<typeof apiName> = {
                 newVizName: 'testViz',
             };
-            const triggerResponse: UiPassthroughArrayResponse<typeof apiName> = Promise.resolve([]);
+            const triggerResponse: UIPassthroughArrayResponse<typeof apiName> = [];
             mockProcessTrigger.mockResolvedValue(triggerResponse);
 
-            await expect(client.handleUiPassthroughForHostEvent(getIFrameEl(), apiName, parameters))
+            await expect(client.handleHostEventWithParam(apiName, parameters))
                 .rejects.toEqual({ error: 'No answer found.' });
         });
 
         it('should throw an error if no valid response is found for vizId', async () => {
             const { client } = createHostEventClient();
-            const apiName = UiPassthroughEvent.addVizToPinboard;
-            const parameters: UiPassthroughRequest<typeof apiName> = {
+            const apiName = UIPassthroughEvent.PinAnswerToLiveboard;
+            const parameters: UIPassthroughRequest<typeof apiName> = {
                 newVizName: 'testViz',
                 vizId: 'testVizId',
             };
-            const triggerResponse: UiPassthroughArrayResponse<typeof apiName> = Promise.resolve([]);
+            const triggerResponse: UIPassthroughArrayResponse<typeof apiName> = [];
             mockProcessTrigger.mockResolvedValue(triggerResponse);
 
-            await expect(client.handleUiPassthroughForHostEvent(getIFrameEl(), apiName, parameters))
+            await expect(client.handleHostEventWithParam(apiName, parameters))
                 .rejects.toEqual({ error: 'No answer found for vizId: testVizId.' });
         });
 
         it('should throw an error if the response contains errors', async () => {
             const { client } = createHostEventClient();
-            const apiName = UiPassthroughEvent.addVizToPinboard;
-            const parameters: UiPassthroughRequest<typeof apiName> = {
+            const apiName = UIPassthroughEvent.PinAnswerToLiveboard;
+            const parameters: UIPassthroughRequest<typeof apiName> = {
                 newVizName: 'testViz',
             };
-            const triggerResponse: UiPassthroughArrayResponse<typeof apiName> = Promise.resolve([
+            const triggerResponse: UIPassthroughArrayResponse<typeof apiName> = [
                 { error: 'Some error' },
-            ]);
+            ];
             mockProcessTrigger.mockResolvedValue(triggerResponse);
 
-            await expect(client.handleUiPassthroughForHostEvent(getIFrameEl(), apiName, parameters))
+            await expect(client.handleHostEventWithParam(apiName, parameters))
                 .rejects.toEqual({ error: 'Some error' });
         });
     });
 
     describe('executeHostEvent', () => {
-        it('should call handleUiPassthroughForHostEvent for Pin event', async () => {
-            const { client } = createHostEventClient();
+        it('should call handleUIPassthroughForHostEvent for Pin event', async () => {
+            const { client, mockIframe } = createHostEventClient();
             const hostEvent = HostEvent.Pin;
             const payload: HostEventRequest<typeof hostEvent> = {
                 newVizName: 'testViz',
@@ -136,19 +140,19 @@ describe('HostEventClient', () => {
 
             mockProcessTrigger.mockResolvedValue([mockResponse]);
 
-            const result = await client.executeHostEvent(getIFrameEl(), hostEvent, payload);
+            const result = await client.triggerHostEvent(hostEvent, payload);
 
             expect(mockProcessTrigger).toHaveBeenCalledWith(
-                getIFrameEl(),
-                HostEvent.UiPassthrough,
+                mockIframe,
+                HostEvent.UIPassthrough,
                 'http://localhost',
-                { parameters: payload, type: UiPassthroughEvent.addVizToPinboard },
+                { parameters: payload, type: UIPassthroughEvent.PinAnswerToLiveboard },
             );
             expect(result).toEqual(mockResponse.value);
         });
 
-        it('should call handleUiPassthroughForHostEvent for SaveAnswer event', async () => {
-            const { client } = createHostEventClient();
+        it('should call handleUIPassthroughForHostEvent for SaveAnswer event', async () => {
+            const { client, mockIframe } = createHostEventClient();
             const hostEvent = HostEvent.SaveAnswer;
             const payload: HostEventRequest<typeof hostEvent> = {
                 name: 'Test Answer',
@@ -170,12 +174,12 @@ describe('HostEventClient', () => {
                 refId: 'testVizId',
             }];
             mockProcessTrigger.mockResolvedValue(mockResponse);
-            const result = await client.executeHostEvent(getIFrameEl(), hostEvent, payload);
+            const result = await client.triggerHostEvent(hostEvent, payload);
 
             expect(mockProcessTrigger).toHaveBeenCalledWith(
-                null,
-                'UiPassthrough',
-                'http://localhost',
+                mockIframe,
+                HostEvent.UIPassthrough,
+                mockThoughtSpotHost,
                 {
                     parameters: payload,
                     type: 'saveAnswer',
@@ -191,14 +195,14 @@ describe('HostEventClient', () => {
             const mockResponse = { fallbackResponse: 'data' };
             jest.spyOn(client, 'hostEventFallback').mockResolvedValue(mockResponse);
 
-            const result = await client.executeHostEvent(getIFrameEl(), hostEvent, payload);
+            const result = await client.triggerHostEvent(hostEvent, payload);
 
-            expect(client.hostEventFallback).toHaveBeenCalledWith(null, hostEvent, payload);
+            expect(client.hostEventFallback).toHaveBeenCalledWith(hostEvent, payload);
             expect(result).toEqual(mockResponse);
         });
 
         it('should call fallback  for Pin event', async () => {
-            const { client } = createHostEventClient();
+            const { client, mockIframe } = createHostEventClient();
             const hostEvent = HostEvent.Pin;
             const payload: HostEventRequest<typeof hostEvent> = {} as any;
             const mockResponse = {
@@ -211,19 +215,19 @@ describe('HostEventClient', () => {
 
             mockProcessTrigger.mockResolvedValue([mockResponse]);
 
-            const result = await client.executeHostEvent(getIFrameEl(), hostEvent, payload);
+            const result = await client.triggerHostEvent(hostEvent, payload);
 
             expect(mockProcessTrigger).toHaveBeenCalledWith(
-                getIFrameEl(),
+                mockIframe,
                 HostEvent.Pin,
-                'http://localhost',
+                mockThoughtSpotHost,
                 {},
             );
             expect(result).toEqual([mockResponse]);
         });
 
         it('should call fallback for SaveAnswer event', async () => {
-            const { client } = createHostEventClient();
+            const { client, mockIframe } = createHostEventClient();
             const hostEvent = HostEvent.SaveAnswer;
             const payload: HostEventRequest<typeof hostEvent> = {} as any;
             const mockResponse = {
@@ -236,12 +240,12 @@ describe('HostEventClient', () => {
 
             mockProcessTrigger.mockResolvedValue([mockResponse]);
 
-            const result = await client.executeHostEvent(getIFrameEl(), hostEvent, payload);
+            const result = await client.triggerHostEvent(hostEvent, payload);
 
             expect(mockProcessTrigger).toHaveBeenCalledWith(
-                getIFrameEl(),
+                mockIframe,
                 HostEvent.Save,
-                'http://localhost',
+                mockThoughtSpotHost,
                 {},
             );
             expect(result).toEqual([mockResponse]);