@thoughtspot/visual-embed-sdk 1.42.1-HE2 → 1.42.1-HE2.0.1

package/src/embed/liveboard.ts

@@ -25,8 +25,9 @@ import { calculateVisibleElementData, getQueryParamString, isUndefined } from '.
 import { getAuthPromise } from './base';
 import { TsEmbed, V1Embed } from './ts-embed';
 import { addPreviewStylesIfNotPresent } from '../utils/global-styles';
-import { TriggerPayload, TriggerResponse } from './hostEventClient/contracts';
+import { ContextType, TriggerPayload, TriggerResponse } from './hostEventClient/contracts';
 import { logger } from '../utils/logger';
+import { PageContextOptions } from 'visual-embed-sdk';
 
 
 /**
@@ -738,10 +739,11 @@ export class LiveboardEmbed extends V1Embed {
      * @param {any} data The payload to send with the message
      * @returns A promise that resolves with the response from the embedded app
      */
-    public trigger<HostEventT extends HostEvent, PayloadT>(
+    public trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(
         messageType: HostEventT,
         data: TriggerPayload<PayloadT, HostEventT> = ({} as any),
-    ): Promise<TriggerResponse<PayloadT, HostEventT>> {
+        context?: ContextT,
+    ): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>> {
         const dataWithVizId: any = data;
         if (messageType === HostEvent.SetActiveTab) {
             this.setActiveTab(data as { tabId: string });
@@ -750,7 +752,7 @@ export class LiveboardEmbed extends V1Embed {
         if (typeof dataWithVizId === 'object' && this.viewConfig.vizId) {
             dataWithVizId.vizId = this.viewConfig.vizId;
         }
-        return super.trigger(messageType, dataWithVizId);
+        return super.trigger(messageType, dataWithVizId, context);
     }
     /**
      * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
@@ -827,6 +829,11 @@ export class LiveboardEmbed extends V1Embed {
 
         return url;
     }
+
+    public async getCurrentContext(): Promise<PageContextOptions> {
+        const context = await super.getCurrentContext();
+        return context;
+    } 
 }
 
 /**

package/src/embed/sage.ts

@@ -6,6 +6,7 @@
  * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
  */
 
+import { PageContextOptions } from 'visual-embed-sdk';
 import { DOMSelector, Param, BaseViewConfig, SearchLiveboardCommonViewConfig } from '../types';
 import { getQueryParamString } from '../utils';
 import { V1Embed } from './ts-embed';
@@ -229,4 +230,9 @@ export class SageEmbed extends V1Embed {
 
         return this;
     }
+
+    public async getCurrentContext(): Promise<PageContextOptions> {
+        const context = await super.getCurrentContext();
+        return context;
+    }
 }

package/src/embed/search-bar.tsx

@@ -2,6 +2,7 @@ import { SearchLiveboardCommonViewConfig, BaseViewConfig, DefaultAppInitData, Pa
 import { getQueryParamString } from '../utils';
 import { TsEmbed } from './ts-embed';
 import { SearchOptions } from './search';
+import { PageContextOptions } from 'visual-embed-sdk';
 
 /**
  * @group Embed components
@@ -198,4 +199,9 @@ export class SearchBarEmbed extends TsEmbed {
         const defaultAppInitData = await super.getAppInitData();
         return { ...defaultAppInitData, ...this.getSearchInitData() };
     }
+
+    public async getCurrentContext(): Promise<PageContextOptions> {
+        const context = await super.getCurrentContext();
+        return context;
+    }
 }

package/src/embed/search.ts

@@ -26,6 +26,8 @@ import { ERROR_MESSAGE } from '../errors';
 import { getAuthPromise } from './base';
 import { getReleaseVersion } from '../auth';
 import { getEmbedConfig } from './embedConfig';
+import { PageContextOptions } from 'visual-embed-sdk';
+import { ContextType, PageType } from './hostEventClient/contracts';
 
 /**
  * Configuration for search options.
@@ -536,4 +538,9 @@ export class SearchEmbed extends TsEmbed {
         });
         return this;
     }
+
+    public async getCurrentContext(): Promise<PageContextOptions> {
+        const context = await super.getCurrentContext();
+        return context;
+    }
 }

package/src/embed/ts-embed.ts

@@ -10,11 +10,13 @@ import isEqual from 'lodash/isEqual';
 import isEmpty from 'lodash/isEmpty';
 import isObject from 'lodash/isObject';
 import {
+    ContextType,
     TriggerPayload,
     TriggerResponse,
     UIPassthroughArrayResponse,
     UIPassthroughEvent,
     UIPassthroughRequest,
+    PageType,
 } from './hostEventClient/contracts';
 import { logger } from '../utils/logger';
 import { getAuthenticationToken } from '../authToken';
@@ -71,6 +73,7 @@ import { getEmbedConfig } from './embedConfig';
 import { ERROR_MESSAGE } from '../errors';
 import { getPreauthInfo } from '../utils/sessionInfoService';
 import { HostEventClient } from './hostEventClient/host-event-client';
+import { PageContextOptions } from '../../visual-embed-sdk';
 
 const { version } = pkgInfo;
 
@@ -1268,11 +1271,11 @@ export class TsEmbed {
      * @param {any} data The payload to send with the message
      * @returns A promise that resolves with the response from the embedded app
      */
-    public async trigger<HostEventT extends HostEvent, PayloadT>(
+    public async trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(
         messageType: HostEventT,
         data: TriggerPayload<PayloadT, HostEventT> = {} as any,
-        context: any = {},
-    ): Promise<TriggerResponse<PayloadT, HostEventT>> {
+        context?: ContextT,
+    ): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>> {
         uploadMixpanelEvent(`${MIXPANEL_EVENT.VISUAL_SDK_TRIGGER}-${messageType}`);
 
         if (!this.isRendered) {
@@ -1337,6 +1340,18 @@ export class TsEmbed {
         return this.render();
     }
 
+    public async getCurrentContext(): Promise<any> {
+        this.executeAfterEmbedContainerLoaded(async () => {
+            const context = await this.trigger(HostEvent.GetPageContext, {});
+            return context;
+        });
+        return {
+            page: ContextType.Default,
+            pageType: PageType.PAGE,
+            objectIds: {},
+        };
+    }
+
     /**
      * Creates the preRender shell
      * @param showPreRenderByDefault - Show the preRender after render, hidden by default

package/src/types.ts

@@ -4257,6 +4257,16 @@ export enum HostEvent {
      * ```
      */
     UpdateEmbedParams = 'updateEmbedParams',
+
+    /**
+     * @hidden
+     * Triggers the get of the page context.
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.GetPageContext);
+     * ```
+     */
+    GetPageContext = 'GetPageContext',
 }
 
 /**

package/src/utils/processTrigger.ts

@@ -3,6 +3,7 @@ import { HostEvent, MessagePayload } from '../types';
 import { logger } from '../utils/logger';
 import { handlePresentEvent } from '../utils';
 import { getEmbedConfig } from '../embed/embedConfig';
+import { ContextType } from 'src/embed/hostEventClient/contracts';
 
 /**
  * Reloads the ThoughtSpot iframe.
@@ -50,7 +51,7 @@ export function processTrigger(
     messageType: HostEvent,
     thoughtSpotHost: string,
     data: any,
-    context?: any,
+    context?: ContextType,
 ): Promise<any> {
     return new Promise<any>((res, rej) => {
         if (messageType === HostEvent.Reload) {