@thoughtspot/visual-embed-sdk 1.44.3 → 1.44.4-HE-beta.1

package/src/embed/app.ts

@@ -19,6 +19,7 @@ import {
     AllEmbedViewConfig,
 } from '../types';
 import { V1Embed } from './ts-embed';
+import { PageContextOptions } from './hostEventClient/contracts';
 
 /**
  * Pages within the ThoughtSpot app that can be embedded.
@@ -172,14 +173,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     showPrimaryNavbar?: boolean;
     /**
-     * Control the visibility of the left navigation bar on the Homepage.
-     * If showPrimaryNavbar is true, that is, if the Global and Homepage
-     * nav-bars are visible, this flag will only hide the homepage left nav-bar.
-     * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
+     * Control the visibility of the left navigation panel on the home page
+     * in the V2 and V3 navigation and home page experience.
+     * If `showPrimaryNavbar` is true, that is, if the Global and Homepage
+     * navigation bars are visible, this flag will only hide the left navigation bar
+     * on the home page.
+     * The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
      *
-     * **Note**: This option does not apply to the classic homepage.
-     * To access the updated modular homepage, set
-     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     * **Note**: This attribute is not supported in the classic (V1) experience.
      *
      * Supported embed types: `AppEmbed`
      * @default false
@@ -194,8 +195,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     hideHomepageLeftNav?: boolean;
     /**
-     * Control the visibility of the help (?) and profile buttons on the
-     * Global nav-bar. By default, these buttons are visible on the nav-bar.
+     * Control the visibility of the help (?) and profile
+     * buttons on the top navigation bar.
+     * These buttons are visible if the
+     * navigation bar is not hidden via `showPrimaryNavbar`.
      *
      * Supported embed types: `AppEmbed`
      * @default false
@@ -212,7 +215,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
     /**
      * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
      * @default true
-     * Whether the help menu in the top nav bar should be served
+     * Whether the help menu in the top navigation bar should be served
      * from Pendo or ThoughtSpot's internal help items.
      *
      * Supported embed types: `AppEmbed`
@@ -226,8 +229,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     enablePendoHelp?: boolean
     /**
-     * Control the visibility of the hamburger icon on the top nav bar
-     * available when new navigation V3 is enabled.
+     * Control the visibility of the hamburger icon on
+     * the top navigation bar in the V3 navigation experience.
      *
      * Supported embed types: `AppEmbed`
      * @default false
@@ -242,8 +245,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     hideHamburger?: boolean;
     /**
-     * Control the visibility of the Eureka search on the top nav bar
-     * this will control for both new V2 and new navigation V3.
+     * Control the visibility of the object search
+     * on the top navigation bar in the
+     * V2 and V3 navigation experience.
+     *
+     * **Note**: This attribute is not supported
+     * in the classic (V1) experience.
      *
      * Supported embed types: `AppEmbed`
      * @default true
@@ -258,8 +265,11 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     hideObjectSearch?: boolean;
     /**
-     * Control the visibility of the notification on the top nav bar V3,
-     * available when new navigation V3 is enabled.
+     * Control the visibility of the notification icon
+     * on the top navigation bar in V3 navigation experience.
+     *
+     * **Note**: This attribute is not supported
+     * in the classic (V1) and V2 experience modes.
      *
      * Supported embed types: `AppEmbed`
      * @default true
@@ -274,12 +284,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     hideNotification?: boolean;
     /**
-     * Control the visibility of the application switcher button on the nav-bar.
-     * By default, the application switcher is shown.
+     * Control the visibility of the application selection menu
+     * in the top navigation bar in the V2 experience.
+     * In the V3 experience, it shows or hides application selection
+     * icons on the left navigation panel.
+     * By default, the application selection menu and icons are
+     * shown in the UI
      *
-     * **Note**: This option does not apply to the classic homepage.
-     * To access the updated modular homepage, set
-     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     * **Note**: This attribute is not supported in the classic (V1) experience.
      *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -297,9 +309,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      * Control the visibility of the Org switcher button on the nav-bar.
      * By default, the Org switcher button is shown.
      *
-     * **Note**: This option does not apply to the classic homepage.
-     * To access the updated modular homepage, set
-     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     * **Note**: This attribute is not supported in the classic (V1) experience.
      *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -452,8 +462,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     fullHeight?: boolean;
     /**
-     * Flag to control new Modular Home experience.
-     *
+     * Enables the V2 navigation and modular home page experience.
+     * For more information,
+     * see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
      * Supported embed types: `AppEmbed`
      * @default false
      * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -467,18 +478,20 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     modularHomeExperience?: boolean;
     /**
-     * To configure the top-left navigation and home page experience
-     *
+     * Configures the V3 navigation and home page experience.
+     * For more information, see
+     * link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
      * Supported embed types: `AppEmbed`
      * @default false
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
-     *    ... // other embed view config
+     *    // Enable V3 navigation and home page experience
      *    discoveryExperience : {
-     *      primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
-     *      homePage: HomePage.Modular,
+     *      primaryNavbarVersion: PrimaryNavbarVersion.Sliding, // Enable V3 navigation
+     *      homePage: HomePage.ModularWithStylingChanges, // Enable V3 modular home page
+     *      ... // other embed view config
      *    },
      * })
      * ```
@@ -631,7 +644,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      * Setting this height helps resolve issues with empty Apps and
      * other screens navigable from an App.
      *
-     * @version SDK: 1.44.2 | ThoughtSpot: 26.0.2.cl
+     * @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
      * @default 500
      * @example
      * ```js

package/src/embed/conversation.ts

@@ -3,6 +3,7 @@ import { ERROR_MESSAGE } from '../errors';
 import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter, ErrorDetailsTypes, EmbedErrorCodes } from '../types';
 import { TsEmbed } from './ts-embed';
 import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils';
+import { PageContextOptions } from './hostEventClient/contracts';
 
 /**
  * Configuration for search options
@@ -328,6 +329,16 @@ export class SpotterEmbed extends TsEmbed {
         await this.renderIFrame(src);
         return this;
     }
+
+    /**
+     * Get the current context of the embedded SpotterEmbed.
+     * @returns The current context object containing the page type and object ids.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    public async getCurrentContext(): Promise<PageContextOptions> {
+        const context = await super.getCurrentContext();
+        return context;
+    }
 }
 
 /**

package/src/embed/hostEventClient/contracts.ts

@@ -1,4 +1,4 @@
-import { HostEvent } from '../../types';
+import { ContextType, HostEvent } from '../../types';
 
 export enum UIPassthroughEvent {
   PinAnswerToLiveboard = 'addVizToPinboard',
@@ -103,7 +103,7 @@ export type HostEventRequest<HostEventT extends HostEvent> =
     ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]>
     : any;
 
-export type HostEventResponse<HostEventT extends HostEvent> =
+export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> =
   HostEventT extends keyof EmbedApiHostEventMapping
     ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]>
     : any;
@@ -111,5 +111,24 @@ export type HostEventResponse<HostEventT extends HostEvent> =
 // 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;
+export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> =
+  PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
+
+export enum PageType {
+  PAGE = 'page',
+  DIALOG = 'dialog',
+}
+
+interface Objects {
+  answerId?: string;
+  liveboardId?: string;
+  vizIds?: string[];
+  dataModelIds?: string[];
+  modalTitle?: string;
+}
+
+export interface PageContextOptions {
+  page: ContextType;
+  pageType: PageType;
+  objects: Objects;
+}

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

@@ -54,6 +54,7 @@ describe('HostEventClient', () => {
                     type: apiName,
                     parameters,
                 },
+                undefined,
             );
             expect(result).toEqual(await triggerResponse);
         });
@@ -148,6 +149,7 @@ describe('HostEventClient', () => {
                 HostEvent.UIPassthrough,
                 'http://localhost',
                 { parameters: payload, type: UIPassthroughEvent.PinAnswerToLiveboard },
+                undefined,
             );
             expect(result).toEqual(mockResponse.value);
         });
@@ -185,6 +187,7 @@ describe('HostEventClient', () => {
                     parameters: payload,
                     type: 'saveAnswer',
                 },
+                undefined,
             );
             expect(result).toEqual({ answerId: 'newAnswer', ...mockResponse[0].value });
         });
@@ -198,7 +201,7 @@ describe('HostEventClient', () => {
 
             const result = await client.triggerHostEvent(hostEvent, payload);
 
-            expect(client.hostEventFallback).toHaveBeenCalledWith(hostEvent, payload);
+            expect(client.hostEventFallback).toHaveBeenCalledWith(hostEvent, payload, undefined);
             expect(result).toEqual(mockResponse);
         });
 
@@ -223,6 +226,7 @@ describe('HostEventClient', () => {
                 HostEvent.Pin,
                 mockThoughtSpotHost,
                 {},
+                undefined,
             );
             expect(result).toEqual([mockResponse]);
         });
@@ -248,6 +252,7 @@ describe('HostEventClient', () => {
                 HostEvent.Save,
                 mockThoughtSpotHost,
                 {},
+                undefined,
             );
             expect(result).toEqual([mockResponse]);
         });
@@ -303,6 +308,7 @@ describe('HostEventClient', () => {
                     parameters: { ...payload, pinboardId: 'test', newPinboardName: 'testLiveboard' },
                     type: 'addVizToPinboard',
                 },
+                undefined,
             );
             expect(result).toEqual({
                 pinboardId: 'testLiveboard',

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

@@ -1,4 +1,4 @@
-import { HostEvent } from '../../types';
+import { ContextType, HostEvent } from '../../types';
 import { processTrigger as processTriggerService } from '../../utils/processTrigger';
 import { getEmbedConfig } from '../embedConfig';
 import {
@@ -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?: ContextType): Promise<any> {
       if (!this.iFrame) {
           throw new Error('Iframe element is not set');
       }
@@ -34,14 +34,16 @@ export class HostEventClient {
           message,
           thoughtspotHost,
           data,
+          context,
       );
   }
 
   public async handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(
       apiName: UIPassthroughEventT,
       parameters: UIPassthroughRequest<UIPassthroughEventT>,
+      context?: ContextType,
   ): Promise<UIPassthroughResponse<UIPassthroughEventT>> {
-      const response = (await this.triggerUIPassthroughApi(apiName, parameters))
+      const response = (await this.triggerUIPassthroughApi(apiName, parameters, context as ContextType))
           ?.filter?.((r) => r.error || r.value)[0];
 
       if (!response) {
@@ -65,8 +67,9 @@ export class HostEventClient {
   public async hostEventFallback(
       hostEvent: HostEvent,
       data: any,
+      context?: ContextType,
   ): Promise<any> {
-      return this.processTrigger(hostEvent, data);
+      return this.processTrigger(hostEvent, data, context);
   }
 
   /**
@@ -80,20 +83,22 @@ export class HostEventClient {
   public async triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(
       apiName: UIPassthroughEventT,
       parameters: UIPassthroughRequest<UIPassthroughEventT>,
+      context?: ContextType,
   ): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>> {
       const res = await this.processTrigger(HostEvent.UIPassthrough, {
           type: apiName,
           parameters,
-      });
+      }, context);
 
       return res;
   }
 
   protected async handlePinEvent(
       payload: HostEventRequest<HostEvent.Pin>,
-  ): Promise<HostEventResponse<HostEvent.Pin>> {
+      context?: ContextType,
+  ): Promise<HostEventResponse<HostEvent.Pin, ContextType>> {
       if (!payload || !('newVizName' in payload)) {
-          return this.hostEventFallback(HostEvent.Pin, payload);
+          return this.hostEventFallback(HostEvent.Pin, payload, context);
       }
 
       const formattedPayload = {
@@ -104,6 +109,7 @@ export class HostEventClient {
 
       const data = await this.handleHostEventWithParam(
           UIPassthroughEvent.PinAnswerToLiveboard, formattedPayload,
+          context as ContextType,
       );
 
       return {
@@ -114,14 +120,16 @@ export class HostEventClient {
 
   protected async handleSaveAnswerEvent(
       payload: HostEventRequest<HostEvent.SaveAnswer>,
+      context?: ContextType,
   ): Promise<any> {
       if (!payload || !('name' in payload) || !('description' in payload)) {
           // Save is the fallback for SaveAnswer
-          return this.hostEventFallback(HostEvent.Save, payload);
+          return this.hostEventFallback(HostEvent.Save, payload, context);
       }
 
       const data = await this.handleHostEventWithParam(
           UIPassthroughEvent.SaveAnswer, payload,
+          context as ContextType,
       );
       return {
           ...data,
@@ -132,19 +140,22 @@ export class HostEventClient {
   public async triggerHostEvent<
     HostEventT extends HostEvent,
     PayloadT,
+    ContextT extends ContextType,
   >(
       hostEvent: HostEventT,
       payload?: TriggerPayload<PayloadT, HostEventT>,
-  ): Promise<TriggerResponse<PayloadT, HostEventT>> {
+      context?: ContextT,
+  ): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>> {
       switch (hostEvent) {
           case HostEvent.Pin:
-              return this.handlePinEvent(payload as HostEventRequest<HostEvent.Pin>) as any;
+              return this.handlePinEvent(payload as HostEventRequest<HostEvent.Pin>, context as ContextType) as any;
           case HostEvent.SaveAnswer:
               return this.handleSaveAnswerEvent(
                   payload as HostEventRequest<HostEvent.SaveAnswer>,
+                  context as ContextType,
               ) as any;
           default:
-              return this.hostEventFallback(hostEvent, payload);
+              return this.hostEventFallback(hostEvent, payload, context);
       }
   }
 }

package/src/embed/liveboard.spec.ts

@@ -1495,7 +1495,7 @@ describe('Liveboard/viz embed tests', () => {
                 await liveboardEmbed.trigger(HostEvent.Save);
                 expect(mockProcessTrigger).toHaveBeenCalledWith(HostEvent.Save, {
                     vizId: 'testViz',
-                });
+                }, undefined);
             });
         });
     });

package/src/embed/liveboard.ts

@@ -22,12 +22,13 @@ import {
     LiveboardAppEmbedViewConfig,
     ErrorDetailsTypes,
     EmbedErrorCodes,
+    ContextType,
 } from '../types';
 import { calculateVisibleElementData, getQueryParamString, isUndefined, isValidCssMargin } from '../utils';
 import { getAuthPromise } from './base';
 import { TsEmbed, V1Embed } from './ts-embed';
 import { addPreviewStylesIfNotPresent } from '../utils/global-styles';
-import { TriggerPayload, TriggerResponse } from './hostEventClient/contracts';
+import { TriggerPayload, TriggerResponse, PageContextOptions } from './hostEventClient/contracts';
 import { logger } from '../utils/logger';
 
 
@@ -83,7 +84,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
      * Setting this height helps resolve issues with empty Liveboards and
      * other screens navigable from a Liveboard.
      *
-     * @version SDK: 1.44.2 | ThoughtSpot: 26.0.2.cl
+     * @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
      * @default 500
      * @example
      * ```js
@@ -642,6 +643,7 @@ export class LiveboardEmbed extends V1Embed {
     }
 
     private sendFullHeightLazyLoadData = () => {
+        console.log('sendFullHeightLazyLoadData', this.iFrame);
         const data = calculateVisibleElementData(this.iFrame);
         this.trigger(HostEvent.VisibleEmbedCoordinates, data);
     }
@@ -800,10 +802,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 });
@@ -812,7 +815,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.
@@ -889,6 +892,16 @@ export class LiveboardEmbed extends V1Embed {
 
         return url;
     }
+
+    /**
+     * Get the current context of the embedded liveboard.
+     * @returns The current context object containing the page type and object ids.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    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 './hostEventClient/contracts';
 import { DOMSelector, Param, BaseViewConfig, SearchLiveboardCommonViewConfig } from '../types';
 import { getQueryParamString } from '../utils';
 import { V1Embed } from './ts-embed';
@@ -229,4 +230,14 @@ export class SageEmbed extends V1Embed {
 
         return this;
     }
+
+    /**
+     * Get the current context of the embedded SageEmbed.
+     * @returns The current context object containing the page type and object ids.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    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 './hostEventClient/contracts';
 
 /**
  * @group Embed components
@@ -198,4 +199,14 @@ export class SearchBarEmbed extends TsEmbed {
         const defaultAppInitData = await super.getAppInitData();
         return { ...defaultAppInitData, ...this.getSearchInitData() };
     }
+
+    /**
+     * Get the current context of the embedded search bar.
+     * @returns The current context object containing the page type and object ids.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    public async getCurrentContext(): Promise<PageContextOptions> {
+        const context = await super.getCurrentContext();
+        return context;
+    }
 }

package/src/embed/search.ts

@@ -27,6 +27,7 @@ import { getAuthPromise } from './base';
 import { getReleaseVersion } from '../auth';
 import { getEmbedConfig } from './embedConfig';
 import { getInterceptInitData } from '../api-intercept';
+import { PageContextOptions } from './hostEventClient/contracts';
 
 /**
  * Configuration for search options.
@@ -523,4 +524,14 @@ export class SearchEmbed extends TsEmbed {
         });
         return this;
     }
+
+    /**
+     * Get the current context of the embedded search.
+     * @returns The current context object containing the page type and object ids.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    public async getCurrentContext(): Promise<PageContextOptions> {
+        const context = await super.getCurrentContext();
+        return context;
+    }
 }