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

package/dist/visual-embed-sdk-react.d.ts

@@ -1744,7 +1744,7 @@ export declare class ConversationEmbed extends TsEmbed {
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-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 { 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, };
 
 /**
     * Copyright (c) 2023
@@ -4905,7 +4905,7 @@ export declare enum HostEvent {
             * EmbedApi
             * @hidden
             */
-        UiPassthrough = "UiPassthrough"
+        UIPassthrough = "UiPassthrough"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -6300,6 +6300,11 @@ export declare class TsEmbed {
             * 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;
         /**
@@ -6431,19 +6436,19 @@ export declare class TsEmbed {
         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
@@ -6562,16 +6567,16 @@ export declare class V1Embed extends TsEmbed {
         test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
 }
 
-export declare enum UiPassthroughEvent {
-    addVizToPinboard = "addVizToPinboard",
-    saveAnswer = "saveAnswer",
-    getDiscoverabilityStatus = "getDiscoverabilityStatus",
-    getAvailableUiPassthroughs = "getAvailableUiPassthroughs",
-    getAnswerPageConfig = "getAnswerPageConfig",
-    getPinboardPageConfig = "getPinboardPageConfig"
+export declare 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;
@@ -6587,7 +6592,7 @@ export type UiPassthroughContractBase = {
             vizId: string;
         };
     };
-    [UiPassthroughEvent.saveAnswer]: {
+    [UIPassthroughEvent.SaveAnswer]: {
         request: {
             name: string;
             description: string;
@@ -6596,53 +6601,49 @@ 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;
-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;
 
 export interface executeTMLInput {
         metadata_tmls: string[];
@@ -7725,11 +7726,25 @@ export declare function getAuthenticationToken(embedConfig: EmbedConfig): Promis
 export declare const resetCachedAuthToken: () => void;
 
 export declare 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/dist/visual-embed-sdk.d.ts

@@ -12,7 +12,7 @@ import EventEmitter from 'eventemitter3';
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-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 { 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, };
 
 /**
     * Copyright (c) 2022
@@ -4902,7 +4902,7 @@ export enum HostEvent {
             * EmbedApi
             * @hidden
             */
-        UiPassthrough = "UiPassthrough"
+        UIPassthrough = "UiPassthrough"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -7061,16 +7061,16 @@ export const getAnswerFromQuery: (query: string, worksheetId: string) => Promise
   */
 export const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
 
-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;
@@ -7086,7 +7086,7 @@ export type UiPassthroughContractBase = {
             vizId: string;
         };
     };
-    [UiPassthroughEvent.saveAnswer]: {
+    [UIPassthroughEvent.SaveAnswer]: {
         request: {
             name: string;
             description: string;
@@ -7095,53 +7095,49 @@ 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;
-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;
 
 /**
     *
@@ -7197,6 +7193,11 @@ export class TsEmbed {
             * 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;
         /**
@@ -7328,19 +7329,19 @@ export class TsEmbed {
         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
@@ -7460,11 +7461,25 @@ export class V1Embed extends TsEmbed {
 }
 
 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/lib/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/lib/src/embed/hostEventClient/contracts.d.ts

@@ -1,14 +1,14 @@
 import { HostEvent } from '../../types';
-export declare enum UiPassthroughEvent {
-    addVizToPinboard = "addVizToPinboard",
-    saveAnswer = "saveAnswer",
-    getDiscoverabilityStatus = "getDiscoverabilityStatus",
-    getAvailableUiPassthroughs = "getAvailableUiPassthroughs",
-    getAnswerPageConfig = "getAnswerPageConfig",
-    getPinboardPageConfig = "getPinboardPageConfig"
+export declare 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;
@@ -24,7 +24,7 @@ export type UiPassthroughContractBase = {
             vizId: string;
         };
     };
-    [UiPassthroughEvent.saveAnswer]: {
+    [UIPassthroughEvent.SaveAnswer]: {
         request: {
             name: string;
             description: string;
@@ -33,51 +33,47 @@ 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;
-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;
 //# sourceMappingURL=contracts.d.ts.map

package/lib/src/embed/hostEventClient/contracts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,oBAAY,kBAAkB;IAC5B,gBAAgB,qBAAqB;IACrC,UAAU,eAAe;IACzB,wBAAwB,6BAA6B;IACrD,0BAA0B,+BAA+B;IACzD,mBAAmB,wBAAwB;IAC3C,qBAAqB,0BAA0B;CAChD;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE;QACrC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,MAAM,CAAC;YACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,eAAe,CAAC,EAAE,MAAM,CAAC;YACzB,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,QAAQ,EAAE;YACR,UAAU,EAAE,MAAM,CAAC;YACnB,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC/B,OAAO,EAAE;YACP,IAAI,EAAE,MAAM,CAAC;YACb,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,cAAc,CAAC,EAAE,OAAO,CAAC;SAC1B,CAAC;QACF,QAAQ,EAAE;YACR,QAAQ,EAAE,MAAM,CAAC;YACjB,YAAY,EAAE,GAAG,CAAC;YAClB,aAAa,CAAC,EAAE,GAAG,CAAC;YACpB,MAAM,CAAC,EAAE,GAAG,CAAC;SACd,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,EAAE;QAC7C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,yBAAyB,EAAE,OAAO,CAAC;YACnC,yCAAyC,EAAE,OAAO,CAAC;SACpD,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,EAAE;QAC/C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,IAAI,EAAE,MAAM,EAAE,CAAC;SAChB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,EAAE;QACxC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;IACF,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,EAAE;QAC1C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,KAAK,CAAC;AAElF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,yBAAyB,IAAI,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AACnI,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,MAAM,yBAAyB,IAAI,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;AAErI,MAAM,MAAM,0BAA0B,CAAC,OAAO,SAAS,MAAM,yBAAyB,IACpF,OAAO,CAAC,KAAK,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACvC,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC,CAAC,CAAA;AAEL,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC;IACrD,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;CACvD,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,SAAS,IACvD,UAAU,SAAS,MAAM,wBAAwB,GACjD,WAAW,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;AAEhF,MAAM,MAAM,iBAAiB,CAAC,UAAU,SAAS,SAAS,IACxD,UAAU,SAAS,MAAM,wBAAwB,GACjD;IACE,KAAK,CAAC,EAAE,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAA;CACpE,GACC,GAAG,CAAC"}
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,oBAAY,kBAAkB;IAC5B,oBAAoB,qBAAqB;IACzC,UAAU,eAAe;IACzB,wBAAwB,6BAA6B;IACrD,0BAA0B,+BAA+B;IACzD,eAAe,wBAAwB;IACvC,kBAAkB,0BAA0B;CAC7C;AAGD,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,EAAE;QACzC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,MAAM,CAAC;YACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,eAAe,CAAC,EAAE,MAAM,CAAC;YACzB,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,QAAQ,EAAE;YACR,UAAU,EAAE,MAAM,CAAC;YACnB,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC/B,OAAO,EAAE;YACP,IAAI,EAAE,MAAM,CAAC;YACb,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,cAAc,CAAC,EAAE,OAAO,CAAC;SAC1B,CAAC;QACF,QAAQ,EAAE;YACR,QAAQ,EAAE,MAAM,CAAC;YACjB,YAAY,CAAC,EAAE,GAAG,CAAC;YACnB,aAAa,CAAC,EAAE,GAAG,CAAC;SACrB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,EAAE;QAC7C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,yBAAyB,EAAE,OAAO,CAAC;YACnC,yCAAyC,EAAE,OAAO,CAAC;SACpD,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,EAAE;QAC/C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,IAAI,EAAE,MAAM,EAAE,CAAC;SAChB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAE;QACpC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;IACF,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE;QACvC,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;CACH,CAAC;AAGF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SACxB,MAAM,yBAAyB,IACrC,yBAAyB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAE5C,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,MAAM,yBAAyB,IACvC,yBAAyB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;AAE7C,MAAM,MAAM,0BAA0B,CAAC,OAAO,SAAS,MAAM,yBAAyB,IACpF,KAAK,CAAC;IACJ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACvC,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC,CAAA;AAGJ,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC;IACzD,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;CACvD,CAAA;AAGD,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,SAAS,IACvD,UAAU,SAAS,MAAM,wBAAwB,GAC7C,oBAAoB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,GAC1D,GAAG,CAAC;AAEV,MAAM,MAAM,iBAAiB,CAAC,UAAU,SAAS,SAAS,IACxD,UAAU,SAAS,MAAM,wBAAwB,GAC7C,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,GAC3D,GAAG,CAAC;AAGV,MAAM,MAAM,cAAc,CAAC,QAAQ,EAAE,UAAU,SAAS,SAAS,IAC/D,QAAQ,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAC1C,MAAM,MAAM,eAAe,CAAC,QAAQ,EAAE,UAAU,SAAS,SAAS,IAChE,QAAQ,SAAS,gBAAgB,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC"}

package/lib/src/embed/hostEventClient/contracts.js

@@ -1,11 +1,11 @@
 import { HostEvent } from '../../types';
-export var UiPassthroughEvent;
-(function (UiPassthroughEvent) {
-    UiPassthroughEvent["addVizToPinboard"] = "addVizToPinboard";
-    UiPassthroughEvent["saveAnswer"] = "saveAnswer";
-    UiPassthroughEvent["getDiscoverabilityStatus"] = "getDiscoverabilityStatus";
-    UiPassthroughEvent["getAvailableUiPassthroughs"] = "getAvailableUiPassthroughs";
-    UiPassthroughEvent["getAnswerPageConfig"] = "getAnswerPageConfig";
-    UiPassthroughEvent["getPinboardPageConfig"] = "getPinboardPageConfig";
-})(UiPassthroughEvent || (UiPassthroughEvent = {}));
+export var UIPassthroughEvent;
+(function (UIPassthroughEvent) {
+    UIPassthroughEvent["PinAnswerToLiveboard"] = "addVizToPinboard";
+    UIPassthroughEvent["SaveAnswer"] = "saveAnswer";
+    UIPassthroughEvent["GetDiscoverabilityStatus"] = "getDiscoverabilityStatus";
+    UIPassthroughEvent["GetAvailableUIPassthroughs"] = "getAvailableUIPassthroughs";
+    UIPassthroughEvent["GetAnswerConfig"] = "getAnswerPageConfig";
+    UIPassthroughEvent["GetLiveboardConfig"] = "getPinboardPageConfig";
+})(UIPassthroughEvent || (UIPassthroughEvent = {}));
 //# sourceMappingURL=contracts.js.map

package/lib/src/embed/hostEventClient/contracts.js.map

@@ -1 +1 @@
-{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,CAAN,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,2DAAqC,CAAA;IACrC,+CAAyB,CAAA;IACzB,2EAAqD,CAAA;IACrD,+EAAyD,CAAA;IACzD,iEAA2C,CAAA;IAC3C,qEAA+C,CAAA;AACjD,CAAC,EAPW,kBAAkB,KAAlB,kBAAkB,QAO7B"}
+{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,CAAN,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,+DAAyC,CAAA;IACzC,+CAAyB,CAAA;IACzB,2EAAqD,CAAA;IACrD,+EAAyD,CAAA;IACzD,6DAAuC,CAAA;IACvC,kEAA4C,CAAA;AAC9C,CAAC,EAPW,kBAAkB,KAAlB,kBAAkB,QAO7B"}

package/lib/src/embed/hostEventClient/host-event-client.d.ts

@@ -1,11 +1,25 @@
 import { HostEvent } from '../../types';
-import { UiPassthroughArrayResponse, UiPassthroughEvent, HostEventRequest, HostEventResponse, UiPassthroughRequest, UiPassthroughResponse } from './contracts';
+import { UIPassthroughArrayResponse, UIPassthroughEvent, HostEventRequest, HostEventResponse, UIPassthroughRequest, UIPassthroughResponse, TriggerPayload, TriggerResponse } from './contracts';
 export declare 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>>;
 }
 //# sourceMappingURL=host-event-client.d.ts.map

package/lib/src/embed/hostEventClient/host-event-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"host-event-client.d.ts","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/host-event-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EACH,0BAA0B,EAC1B,kBAAkB,EAAE,gBAAgB,EAAE,iBAAiB,EACvD,oBAAoB,EACpB,qBAAqB,EACxB,MAAM,aAAa,CAAC;AAErB,qBAAa,eAAe;IAC1B,eAAe,EAAE,MAAM,CAAC;gBAEZ,eAAe,EAAE,MAAM;IAItB,uBAAuB,CAAC,mBAAmB,SAAS,kBAAkB,EAC/E,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,0BAA0B,CAAC,mBAAmB,CAAC;IASrC,+BAA+B,CAAC,mBAAmB,SAAS,kBAAkB,EACvF,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;IAmBzC,iBAAiB,CAC1B,MAAM,EAAE,iBAAiB,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAC3D,OAAO,CAAC,GAAG,CAAC;IAIF,gBAAgB,CAAC,CAAC,SAAS,SAAS,EAC7C,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC9B,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;CAmBzC"}
+{"version":3,"file":"host-event-client.d.ts","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/host-event-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,OAAO,EACH,0BAA0B,EAC1B,kBAAkB,EAAE,gBAAgB,EAAE,iBAAiB,EACvD,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACd,eAAe,EAClB,MAAM,aAAa,CAAC;AAOrB,qBAAa,eAAe;IAC1B,MAAM,EAAE,iBAAiB,CAAC;gBAEd,MAAM,CAAC,EAAE,iBAAiB;IAItC;;;;;OAKG;cACa,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAc9D,wBAAwB,CAAC,mBAAmB,SAAS,kBAAkB,EAChF,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;IAsBzC,iBAAiB,CAC1B,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,GAAG,GACV,OAAO,CAAC,GAAG,CAAC;IAIf;;;OAGG;IACI,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAI3C,uBAAuB,CAAC,mBAAmB,SAAS,kBAAkB,EAC/E,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAC;cAS3C,cAAc,CAC1B,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG,CAAC,GACzC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;cAU5B,qBAAqB,CACjC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,GAChD,OAAO,CAAC,GAAG,CAAC;IAeF,gBAAgB,CAC3B,UAAU,SAAS,SAAS,EAC5B,QAAQ,EAEN,SAAS,EAAE,UAAU,EACrB,OAAO,CAAC,EAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,GAC/C,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;CAYlD"}