@thoughtspot/visual-embed-sdk 1.45.0 → 1.45.2

package/src/types.ts

@@ -1120,6 +1120,47 @@ export interface BaseViewConfig extends ApiInterceptFlags {
      * ```
      */
     customActions?: CustomAction[];
+
+
+    /**
+     * Refresh the auth token when the token is near expiry.
+     * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    refreshAuthTokenOnNearExpiry: true,
+     * })
+     * ```
+     */
+    refreshAuthTokenOnNearExpiry?: boolean;
+    /**
+     * This flag skips payload validation so events can be processed even if the payload is old, incomplete, or from a trusted system.
+     * @default false
+     * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    shouldBypassPayloadValidation:true,
+     * })
+     * ```
+     */
+    shouldBypassPayloadValidation?: boolean;
+
+    /**
+     * Flag to use host events v2. This is used to enable the new host events v2 API.
+     * @default false
+     * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    useHostEventsV2:true,
+     * })
+     * ```
+     */
+    useHostEventsV2?: boolean;
 }
 
 /**
@@ -3162,6 +3203,19 @@ export enum EmbedEvent {
      * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
      */
     ApiIntercept = 'ApiIntercept',
+    
+    /**
+     * @hidden
+     * Emitted when the auth token is about to get expired and needs to be refreshed.
+     * @example
+     * ```js
+     * embed.on(EmbedEvent.RefreshAuthToken, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     * ```
+     * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+     */
+    RefreshAuthToken = 'RefreshAuthToken',
 }
 
 /**
@@ -4547,6 +4601,18 @@ export enum HostEvent {
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     StartNewSpotterConversation = 'StartNewSpotterConversation',
+
+    /**
+     * @hidden
+     * Get the current context of the embedded page.
+     * 
+     * @example
+     * ```js
+     * const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
+     * ```
+     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     */
+    GetPageContext = 'GetPageContext',
 }
 
 /**
@@ -6507,6 +6573,26 @@ export interface EmbedErrorDetailsEvent {
     /** Additional context-specific for backward compatibility */
     [key: string]: any;
 }
+
+export enum ContextType {
+    /**
+     * Search answer context for search page or edit viz dialog on liveboard page.
+     */
+    Search = 'search-answer',
+    /**
+     * Liveboard context for liveboard page.
+     */
+    Liveboard = 'liveboard',
+    /**
+     * Answer context for explore modal/page on liveboard page.
+     */
+    Answer = 'answer',
+    /**
+     * Spotter context for spotter modal/page.
+     */
+    Spotter = 'spotter',
+}
+
 export interface DefaultAppInitData {
     customisations: CustomisationsInterface;
     authToken: string;
@@ -6584,3 +6670,88 @@ export type ApiInterceptFlags = {
      */
     interceptTimeout?: number;
 };
+
+/**
+ * Object IDs for the embedded component.
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+ */
+export interface ObjectIds {
+    /**
+     * Liveboard ID.
+     */
+    liveboardId?: string;
+    /**
+     * Answer ID.
+     */
+    answerId?: string;
+    /**
+     * Viz IDs.
+     */
+    vizIds?: string[];
+    /**
+     * Data model IDs.
+     */
+    dataModelIds?: string[];
+    /**
+     * Modal title.
+     */
+    modalTitle?: string;
+}
+
+/**
+ * Context object for the embedded component.
+ * @example
+ * ```js
+ * const context = await embed.getCurrentContext();
+ * console.log(context);
+ * {
+ *   stack: [
+ *     {
+ *       name: 'Liveboard',
+ *       type: ContextType.Liveboard,
+ *       objectIds: {
+ *         liveboardId: '123',
+ *       },
+ *     },
+ *   ],
+ *   currentContext: {
+ *     name: 'Liveboard',
+ *     type: ContextType.Liveboard,
+ *     objectIds: {
+ *       liveboardId: '123',
+ *     },
+ *   },
+ * }
+ * ```
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+ */
+export interface ContextObject {
+    /**
+     * Stack of context objects.
+     */
+   stack: Array<{
+    /**
+     * Name of the context object.
+     */
+    name: string;
+    /**
+     * Type of the context object.
+     */
+    type: ContextType;
+    /**
+     * Object IDs of the context object.
+     */
+    objectIds: ObjectIds;
+   }>
+   /**
+    * Current context object.
+    */
+   currentContext: {
+    /**
+     * Name of the current context object.
+     */
+    name: string;
+    type: ContextType;
+    objectIds: ObjectIds;
+   }
+}

package/src/utils/processTrigger.ts

@@ -1,5 +1,5 @@
 import { ERROR_MESSAGE } from '../errors';
-import { HostEvent, MessagePayload } from '../types';
+import { ContextType, HostEvent, MessagePayload } from '../types';
 import { logger } from '../utils/logger';
 import { handlePresentEvent } from '../utils';
 import { getEmbedConfig } from '../embed/embedConfig';
@@ -22,12 +22,13 @@ export const reload = (iFrame: HTMLIFrameElement) => {
  * @param message
  * @param message.type
  * @param message.data
+ * @param message.context
  * @param thoughtSpotHost
  * @param channel
  */
 function postIframeMessage(
     iFrame: HTMLIFrameElement,
-    message: { type: HostEvent; data: any },
+    message: { type: HostEvent; data: any, context?: any },
     thoughtSpotHost: string,
     channel?: MessageChannel,
 ) {
@@ -42,12 +43,14 @@ export const TRIGGER_TIMEOUT = 30000;
  * @param messageType
  * @param thoughtSpotHost
  * @param data
+ * @param context
  */
 export function processTrigger(
     iFrame: HTMLIFrameElement,
     messageType: HostEvent,
     thoughtSpotHost: string,
     data: any,
+    context?: ContextType,
 ): Promise<any> {
     return new Promise<any>((res, rej) => {
         if (messageType === HostEvent.Reload) {
@@ -83,6 +86,6 @@ export function processTrigger(
             res(new Error(ERROR_MESSAGE.TRIGGER_TIMED_OUT));
         }, TRIGGER_TIMEOUT);
 
-        return postIframeMessage(iFrame, { type: messageType, data }, thoughtSpotHost, channel);
+        return postIframeMessage(iFrame, { type: messageType, data, context }, thoughtSpotHost, channel);
     });
 }

package/src/utils.ts

@@ -15,6 +15,7 @@ import {
     DOMSelector,
     RuntimeParameter,
     AllEmbedViewConfig,
+    BaseViewConfig,
 } from './types';
 import { logger } from './utils/logger';
 import { ERROR_MESSAGE } from './errors';
@@ -560,6 +561,13 @@ export const formatTemplate = (template: string, values: Record<string, any>): s
     });
 };
 
+export const getHostEventsConfig = (viewConfig: BaseViewConfig) => {
+    return {
+        shouldBypassPayloadValidation: viewConfig.shouldBypassPayloadValidation,
+        useHostEventsV2: viewConfig.useHostEventsV2,
+    };
+}
+
 /**
  * Check if the window is undefined
  * If the window is undefined, it means the code is running in a SSR environment.