@thoughtspot/visual-embed-sdk 1.41.1 → 1.42.1-alpha.1

package/src/types.ts

@@ -231,12 +231,12 @@ export type DOMSelector = string | HTMLElement;
  * Use {@link CustomCssVariables} or css rules.
  */
 export interface customCssInterface {
-  /**
-   * The custom css variables, which can be set.
-   * The variables are available in the {@link CustomCssVariables}
-   * interface. For more information, see
-   * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
-   */
+    /**
+     * The custom css variables, which can be set.
+     * The variables are available in the {@link CustomCssVariables}
+     * interface. For more information, see
+     * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
+     */
     variables?: CustomCssVariables;
     /**
      * Can be used to define a custom font face
@@ -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.
      */
@@ -648,7 +648,7 @@ export interface EmbedConfig {
      * ```
      *  @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-    customVariablesForThirdPartyTools?: Record< string, any >;
+    customVariablesForThirdPartyTools?: Record<string, any>;
 
     disablePreauthCache?: boolean;
 
@@ -695,7 +695,7 @@ export interface EmbedConfig {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface LayoutConfig {}
+export interface LayoutConfig { }
 
 /**
  * Embedded iframe configuration
@@ -726,7 +726,7 @@ export interface FrameParams {
 /**
  * The common configuration object for an embedded view.
  */
-export interface BaseViewConfig {
+export interface BaseViewConfig extends InterceptV2Flags {
     /**
      * @hidden
      */
@@ -1481,41 +1481,56 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     enableAskSage?: boolean;
-     /**
-     * This flag is used to show or hide checkboxes for including or excluding
-     * the cover and filters pages in the Liveboard PDF.
+    /**
+    * This flag is used to show or hide checkboxes for including or excluding
+    * the cover and filters pages in the Liveboard PDF.
+    *
+    * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+    * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
+    * @example
+    * ```js
+    * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+    * const embed = new <EmbedComponent>('#tsEmbed', {
+    *    ... // other embed view config
+    *    coverAndFilterOptionInPDF: false,
+    * })
+    * ```
+    */
+    coverAndFilterOptionInPDF?: boolean;
+    /**
+     * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
      *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-     * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
+     * @version SDK: 1.41.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
-     *    coverAndFilterOptionInPDF: false,
+     *    liveboardXLSXCSVDownload: true,
      * })
      * ```
      */
-    coverAndFilterOptionInPDF?: boolean;
+    liveboardXLSXCSVDownload?: boolean;
     /**
-     * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
+     * This flag is used to enable or disable the link parameters in liveboard.
      *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.14.0.cl
+     * @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
-     *    liveboardXLSXCSVDownload: true,
+     *    isLinkParametersEnabled: true,
      * })
      * ```
      */
-    liveboardXLSXCSVDownload?: boolean;
-
+    isLinkParametersEnabled?: boolean;
+    
 }
 
-export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {}
+export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig { }
 
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2774,25 +2789,25 @@ export enum EmbedEvent {
      * ```
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-     TableVizRendered = 'TableVizRendered',
-     /**
-     * Emitted when the liveboard is created from pin modal or Liveboard list page.
-     * You can use this event as a hook to trigger
-     * other events on liveboard creation.
-     *
-     * ```js
-     * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
-     *     console.log('payload', payload);
-     * })
-     *```
-     * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
-     */
+    TableVizRendered = 'TableVizRendered',
+    /**
+    * Emitted when the liveboard is created from pin modal or Liveboard list page.
+    * You can use this event as a hook to trigger
+    * other events on liveboard creation.
+    *
+    * ```js
+    * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
+    *     console.log('payload', payload);
+    * })
+    *```
+    * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
+    */
     CreateLiveboard = 'createLiveboard',
     /**
      * Emitted when a user creates a Model.
      * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-     CreateModel = 'createModel',
+    CreateModel = 'createModel',
     /**
      * @hidden
      * Emitted when a user exits present mode.
@@ -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',
 }
 
 /**
@@ -3670,24 +3700,45 @@ export enum HostEvent {
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     Share = 'share',
-    /**
-     * Trigger the **Save**  action on a Liveboard or Answer.
-     * Saves the changes.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
-     * @example
-     * ```js
-     * liveboardEmbed.trigger(HostEvent.Save)
-     * ```
-     * ```js
-     * searchEmbed.trigger(HostEvent.Save)
-     * ```
-     * ```js
-     * spotterEmbed.trigger(HostEvent.Save, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
-     * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
-     */
+  /**
+   * Trigger the **Save** action on a Liveboard, Answer, or Spotter.
+   * Saves the changes.
+   *
+   * @param - `vizId` refers to the Spotter Visualization Id used in Spotter embed.
+   * It is required and can be retrieved from the data embed event.
+   *
+   * @example
+   * ```js
+   * // Save changes in a Liveboard
+   * liveboardEmbed.trigger(HostEvent.Save)
+   * ```
+   *
+   * ```js
+   * // Save the current Answer in Search embed
+   * searchEmbed.trigger(HostEvent.Save)
+   * ```
+   *
+   * ```js
+   * // Save an Answer in Spotter (requires vizId)
+   * spotterEmbed.trigger(HostEvent.Save, {
+   *   vizId: "730496d6-6903-4601-937e-2c691821af3c"
+   * })
+   * ```
+   *
+   * ```js
+   * // How to get the vizId in Spotter?
+   *
+   * // You can use the Data event dispatched on each answer creation to get the vizId.
+   * let latestSpotterVizId = '';
+   * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+   *   latestSpotterVizId = payload.data.id;
+   * });
+   *
+   * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
+   * ```
+   *
+   * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
+   */
     Save = 'save',
     /**
      * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
@@ -4015,7 +4066,7 @@ export enum HostEvent {
      *```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
-     InfoSuccess = 'InfoSuccess',
+    InfoSuccess = 'InfoSuccess',
     /**
      * Trigger the save action for an Answer.
      * To programmatically save an answer without opening the
@@ -4169,6 +4220,17 @@ export enum HostEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     AskSpotter = 'AskSpotter',
+
+    /**
+     * @hidden
+     * Triggers the update of the embed params.
+     * 
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
+     * ```
+     */
+    UpdateEmbedParams = 'updateEmbedParams',
 }
 
 /**
@@ -4318,6 +4380,7 @@ export enum Param {
     RootMarginForLazyLoad = 'rootMarginForLazyLoad',
     LiveboardXLSXCSVDownload = 'isLiveboardXLSXCSVDownloadEnabled',
     isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
+    isLinkParametersEnabled = 'isLinkParametersEnabled',
 }
 
 /**
@@ -5671,15 +5734,15 @@ export interface ColumnValue {
         [key: string]: any;
     };
     value:
-        | string
-        | number
-        | boolean
-        | {
-              v: {
-                  s: number;
-                  e: number;
-              };
-          };
+    | string
+    | number
+    | boolean
+    | {
+        v: {
+            s: number;
+            e: number;
+        };
+    };
 }
 
 export interface VizPoint {
@@ -5848,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;
 }