@thoughtspot/visual-embed-sdk 1.42.0 → 1.42.1-alpha.2

package/src/types.ts

@@ -329,7 +329,7 @@ export interface CustomisationsInterface {
  * if a trusted authentication server is used.
  * @group Authentication / Init
  */
-export interface EmbedConfig {
+export interface EmbedConfig extends InterceptV2Flags {
     /**
      * The ThoughtSpot cluster hostname or IP address.
      */
@@ -726,7 +726,7 @@ export interface FrameParams {
 /**
  * The common configuration object for an embedded view.
  */
-export interface BaseViewConfig {
+export interface BaseViewConfig extends InterceptV2Flags {
     /**
      * @hidden
      */
@@ -1512,7 +1512,22 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     liveboardXLSXCSVDownload?: boolean;
-
+    /**
+     * This flag is used to enable or disable the link parameters in liveboard.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isLinkParametersEnabled: true,
+     * })
+     * ```
+     */
+    isLinkParametersEnabled?: boolean;
+    
 }
 
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig { }
@@ -2905,6 +2920,21 @@ export enum EmbedEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     OrgSwitched = 'orgSwitched',
+    /**
+     * Emitted when the user intercepts a URL.
+     *
+     * Supported on all embed types.
+     * 
+     * @example
+     * ```js
+     * embed.on(EmbedEvent.ApiIntercept, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     * ```
+     * 
+     * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
+     */
+    ApiIntercept = 'ApiIntercept',
 }
 
 /**
@@ -4350,6 +4380,7 @@ export enum Param {
     RootMarginForLazyLoad = 'rootMarginForLazyLoad',
     LiveboardXLSXCSVDownload = 'isLiveboardXLSXCSVDownloadEnabled',
     isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
+    isLinkParametersEnabled = 'isLinkParametersEnabled',
 }
 
 /**
@@ -5880,3 +5911,71 @@ export interface DefaultAppInitData {
     hiddenListColumns: ListPageColumns[];
     customActions: CustomAction[];
 }
+
+/**
+ * Enum for the type of API intercepted
+ */
+export enum InterceptedApiType {
+    /**
+     * The apis that are use to get the metadata for the embed
+     */
+    METADATA = 'METADATA',
+    /**
+     * The apis that are use to get the data for the embed
+     */
+    ANSWER_DATA = 'ANSWER_DATA',
+    /**
+     * This will intercept all the apis
+     */
+    ALL = 'ALL',
+    /**
+     * The apis that are use to get the data for the liveboard
+     */
+    LIVEBOARD_DATA = 'LIVEBOARD_DATA',
+}
+
+
+export type InterceptV2Flags = {
+    /**
+     * Enable intercepting the apis
+     * 
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ...viewConfig,
+     *   enableApiIntercept: true,
+     *   interceptUrls: [InterceptedApiType.DATA],
+     * })
+     * ```
+     * 
+     */
+    enableApiIntercept?: boolean;
+    /**
+     * The apis to intercept
+     * 
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ...viewConfig,
+     *   enableApiIntercept: true,
+     *   interceptUrls: [InterceptedApiType.DATA],
+     * })
+     * ```
+     */
+    interceptUrls?: (string | InterceptedApiType)[];
+    /**
+     * The timeout for the intercept, default is 30000ms
+     * the api will error out if the timeout is reached
+     * 
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ...viewConfig,
+     *   enableApiIntercept: true,
+     *   interceptUrls: [InterceptedApiType.ALL],
+     *   interceptTimeout: 1000,
+     * })
+     * ```
+     */
+    interceptTimeout?: number;
+}

package/src/utils/processData.ts

@@ -10,9 +10,9 @@ import { AuthType, CustomActionPayload, EmbedEvent } from '../types';
 import { AnswerService } from './graphql/answerService/answerService';
 import { resetCachedAuthToken } from '../authToken';
 import { ERROR_MESSAGE } from '../errors';
-import { logger } from '../utils/logger';
 import { handleExitPresentMode } from '../utils';
 import { resetCachedPreauthInfo, resetCachedSessionInfo } from './sessionInfoService';
+import { processApiIntercept } from '../api-intercept';
 
 /**
  * Process the ExitPresentMode event and handle default fullscreen exit
@@ -21,7 +21,7 @@ import { resetCachedPreauthInfo, resetCachedSessionInfo } from './sessionInfoSer
 function processExitPresentMode(e: any) {
     const embedConfig = getEmbedConfig();
     const disableFullscreenPresentation = embedConfig?.disableFullscreenPresentation ?? true;
-    
+
     if (!disableFullscreenPresentation) {
         handleExitPresentMode();
     }
@@ -103,7 +103,7 @@ export function processAuthFailure(e: any, containerEl: Element) {
     const {
         loginFailedMessage, authType, disableLoginFailurePage, autoLogin,
     } = getEmbedConfig();
-    
+
     const isEmbeddedSSO = authType === AuthType.EmbeddedSSO;
     const isTrustedAuth = authType === AuthType.TrustedAuthToken || authType === AuthType.TrustedAuthTokenCookieless;
     const isEmbeddedSSOInfoFailure = isEmbeddedSSO && e?.data?.type === AuthFailureType.UNAUTHENTICATED_FAILURE;
@@ -144,26 +144,26 @@ function processAuthLogout(e: any, containerEl: Element) {
  */
 export function processEventData(
     type: EmbedEvent,
-    e: any,
+    eventData: any,
     thoughtSpotHost: string,
     containerEl: Element,
 ): any {
     switch (type) {
         case EmbedEvent.CustomAction:
-            return processCustomAction(e, thoughtSpotHost);
+            return processCustomAction(eventData, thoughtSpotHost);
         case EmbedEvent.AuthInit:
-            return processAuthInit(e);
+            return processAuthInit(eventData);
         case EmbedEvent.NoCookieAccess:
-            return processNoCookieAccess(e, containerEl);
+            return processNoCookieAccess(eventData, containerEl);
         case EmbedEvent.AuthFailure:
-            return processAuthFailure(e, containerEl);
+            return processAuthFailure(eventData, containerEl);
         case EmbedEvent.AuthLogout:
-            return processAuthLogout(e, containerEl);
+            return processAuthLogout(eventData, containerEl);
         case EmbedEvent.ExitPresentMode:
-            return processExitPresentMode(e);
+            return processExitPresentMode(eventData);
         case EmbedEvent.CLEAR_INFO_CACHE:
             return processClearInfoCache();
         default:
     }
-    return e;
+    return eventData;
 }