@thoughtspot/visual-embed-sdk 1.35.5-hostEvent.1 → 1.35.5-hostEvent.3

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

@@ -4,20 +4,9 @@ import {
     UiPassthroughArrayResponse,
     UiPassthroughEvent, HostEventRequest, HostEventResponse,
     UiPassthroughRequest,
-    FlattenType,
+    UiPassthroughResponse,
 } from './contracts';
 
-type UiPassthroughHandlerWithIframe = <UiPassthroughEventT extends UiPassthroughEvent>(
-    iFrame: HTMLIFrameElement,
-    apiName: UiPassthroughEventT,
-    parameters: FlattenType<UiPassthroughRequest<UiPassthroughEventT>>,
-) => UiPassthroughArrayResponse<UiPassthroughEventT>;
-
-export type UiPassthroughHandler = <UiPassthroughEventT extends UiPassthroughEvent>(
-  apiName: UiPassthroughEventT,
-  parameters: FlattenType<UiPassthroughRequest<UiPassthroughEventT>>,
-) => UiPassthroughArrayResponse<UiPassthroughEventT>;
-
 export class HostEventClient {
   thoughtSpotHost: string;
 
@@ -25,7 +14,11 @@ export class HostEventClient {
       this.thoughtSpotHost = thoughtSpotHost;
   }
 
-  executeUiPassthroughApi:UiPassthroughHandlerWithIframe = async (iFrame, apiName, parameters) => {
+  public async executeUiPassthroughApi<UiPassthroughEventT extends UiPassthroughEvent>(
+      iFrame: HTMLIFrameElement,
+      apiName: UiPassthroughEventT,
+      parameters: UiPassthroughRequest<UiPassthroughEventT>,
+  ): UiPassthroughArrayResponse<UiPassthroughEventT> {
       const res = await processTrigger(iFrame, HostEvent.UiPassthrough, this.thoughtSpotHost, {
           type: apiName,
           parameters,
@@ -34,36 +27,40 @@ export class HostEventClient {
       return res;
   }
 
-  handleUiPassthroughForHostEvent:UiPassthroughHandlerWithIframe =
-     async (iFrame, apiName, parameters) => {
-         const response = (await this.executeUiPassthroughApi(iFrame, apiName, parameters))
-             ?.filter?.((r) => r.error || r.value)[0];
+  public async handleUiPassthroughForHostEvent<UiPassthroughEventT extends UiPassthroughEvent>(
+      iFrame: HTMLIFrameElement,
+      apiName: UiPassthroughEventT,
+      parameters: UiPassthroughRequest<UiPassthroughEventT>,
+  ): Promise<UiPassthroughResponse<UiPassthroughEventT>> {
+      const response = (await this.executeUiPassthroughApi(iFrame, apiName, parameters))
+          ?.filter?.((r) => r.error || r.value)[0];
 
-         if (!response) {
-             const error = `No answer found${parameters.vizId ? ` for vizId: ${parameters.vizId}` : ''}.`;
-             // eslint-disable-next-line no-throw-literal
-             throw { error };
-         }
+      if (!response) {
+          const error = `No answer found${parameters.vizId ? ` for vizId: ${parameters.vizId}` : ''}.`;
+          // eslint-disable-next-line no-throw-literal
+          throw { error };
+      }
 
-         const errors = response.error || (response.value as any)?.errors;
-         if (errors) {
-             // eslint-disable-next-line no-throw-literal
-             throw { error: response.error };
-         }
+      const errors = response.error || (response.value as any)?.errors;
+      if (errors) {
+      // eslint-disable-next-line no-throw-literal
+          throw { error: response.error };
+      }
 
-         return { ...response.value };
-     }
+      return { ...response.value };
+  }
 
-  async hostEventFallback(
+  public async hostEventFallback(
       iFrame: HTMLIFrameElement, hostEvent: HostEvent, data: any,
   ): Promise<any> {
       return processTrigger(iFrame, hostEvent, this.thoughtSpotHost, data);
   }
 
-  async executeHostEvent<T extends HostEvent>(
-      iFrame: HTMLIFrameElement, hostEvent: HostEvent, payload?: HostEventRequest<T>,
-  ):
-    Promise<HostEventResponse<HostEvent>> {
+  public async executeHostEvent<T extends HostEvent>(
+      iFrame: HTMLIFrameElement,
+      hostEvent: HostEvent,
+      payload?: HostEventRequest<T>,
+  ): Promise<HostEventResponse<HostEvent>> {
       if (hostEvent === HostEvent.Pin && payload?.newVizName) {
           return this.handleUiPassthroughForHostEvent(
               iFrame, UiPassthroughEvent.addVizToPinboard, payload,

package/src/embed/ts-embed.ts

@@ -9,7 +9,13 @@
 import isEqual from 'lodash/isEqual';
 import isEmpty from 'lodash/isEmpty';
 import isObject from 'lodash/isObject';
-import { HostEventRequest, HostEventResponse } from './hostEventClient/contracts';
+import {
+    HostEventRequest,
+    HostEventResponse,
+    UiPassthroughArrayResponse,
+    UiPassthroughEvent,
+    UiPassthroughRequest,
+} from './hostEventClient/contracts';
 import { logger } from '../utils/logger';
 import { getAuthenticationToken } from '../authToken';
 import { AnswerService } from '../utils/graphql/answerService/answerService';
@@ -63,7 +69,7 @@ import {
 import { AuthFailureType } from '../auth';
 import { getEmbedConfig } from './embedConfig';
 import { ERROR_MESSAGE } from '../errors';
-import { HostEventClient, UiPassthroughHandler } from './hostEventClient/host-event-client';
+import { HostEventClient } from './hostEventClient/host-event-client';
 
 const { version } = pkgInfo;
 
@@ -1015,11 +1021,14 @@ export class TsEmbed {
      * 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 
+     * @returns {Promise<UiPassthroughRequest>} - A promise that resolves with the response
      * from the embedded app.
      */
     // eslint-disable-next-line arrow-body-style
-    public triggerUiPassThrough: UiPassthroughHandler = (apiName, parameters) => {
+    public triggerUiPassThrough<UiPassthroughEventT extends UiPassthroughEvent>(
+        apiName: UiPassthroughEventT,
+        parameters: UiPassthroughRequest<UiPassthroughEventT>,
+    ): UiPassthroughArrayResponse<UiPassthroughEventT> {
         return this.hostEventClient.executeUiPassthroughApi(this.iFrame, apiName, parameters);
     }
 

package/src/types.ts

@@ -3201,7 +3201,7 @@ export enum HostEvent {
     UpdatePersonalisedView = 'UpdatePersonalisedView',
     /**
      * Triggers the action to get the current view of the liveboard
-     * @version SDK: 1.34.0 | Thoughtspot: 10.6.0.cl
+     * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
      */
     SaveAnswer = 'saveAnswer',
     /**