@thoughtspot/visual-embed-sdk 1.42.3 → 1.43.1

package/src/api-intercept.ts

@@ -0,0 +1,204 @@
+import { getThoughtSpotHost } from "./config";
+import { getEmbedConfig } from "./embed/embedConfig";
+import { InterceptedApiType, BaseViewConfig, ApiInterceptFlags, EmbedEvent } from "./types";
+import { embedEventStatus } from "./utils";
+import { logger } from "./utils/logger";
+
+const DefaultInterceptUrlsMap: Record<Exclude<InterceptedApiType, InterceptedApiType.ALL>, string[]> = {
+    [InterceptedApiType.AnswerData]: [
+        '/prism/?op=GetChartWithData',
+        '/prism/?op=GetTableWithHeadlineData',
+        '/prism/?op=GetTableWithData',
+    ] as string[],
+    [InterceptedApiType.LiveboardData]: [
+        '/prism/?op=LoadContextBook'
+    ] as string[],
+};
+
+const formatInterceptUrl = (url: string) => {
+    const host = getThoughtSpotHost(getEmbedConfig());
+    if (url.startsWith('/')) return `${host}${url}`;
+    return url;
+}
+
+interface LegacyInterceptFlags {
+    isOnBeforeGetVizDataInterceptEnabled: boolean;
+}
+/**
+ * Converts user passed url values to proper urls
+ * [ANSER_DATA] => ['https://host/pris/op?=op']
+ * @param interceptUrls 
+ * @returns 
+ */
+const processInterceptUrls = (interceptUrls: (string | InterceptedApiType)[]) => {
+    let processedUrls = [...interceptUrls];
+    Object.entries(DefaultInterceptUrlsMap).forEach(([apiType, apiTypeUrls]) => {
+        if (!processedUrls.includes(apiType)) return;
+        processedUrls = processedUrls.filter(url => url !== apiType);
+        processedUrls = [...processedUrls, ...apiTypeUrls];
+    })
+    return processedUrls.map(url => formatInterceptUrl(url));
+}
+
+/**
+ * Returns the data to be sent to embed to setup intercepts
+ * the urls to intercept, timeout etc
+ * @param viewConfig 
+ * @returns 
+ */
+export const getInterceptInitData = (viewConfig: BaseViewConfig): Required<Omit<ApiInterceptFlags, 'isOnBeforeGetVizDataInterceptEnabled'>> => {
+    const combinedUrls = [...(viewConfig.interceptUrls || [])];
+
+    if ((viewConfig as LegacyInterceptFlags).isOnBeforeGetVizDataInterceptEnabled) {
+        combinedUrls.push(InterceptedApiType.AnswerData);
+    }
+
+    const shouldInterceptAll = combinedUrls.includes(InterceptedApiType.ALL);
+    const interceptUrls = shouldInterceptAll ? [InterceptedApiType.ALL] : processInterceptUrls(combinedUrls);
+
+    const interceptTimeout = viewConfig.interceptTimeout;
+
+    return {
+        interceptUrls,
+        interceptTimeout,
+    };
+}
+
+const parseJson = (jsonString: string): [any, Error | null] => {
+    try {
+        const json = JSON.parse(jsonString);
+        return [json, null];
+    } catch (error) {
+        return [null, error];
+    }
+}
+
+/**
+ * Parse the api intercept data and return the parsed data and error if any
+ * Embed returns the input and init from the fetch call
+ */
+const parseInterceptData = (eventDataString: any) => {
+
+    try {
+        const [parsedData, error] = parseJson(eventDataString);
+        if (error) {
+            return [null, error];
+        }
+
+        const { input, init } = parsedData;
+
+        const [parsedBody, bodyParseError] = parseJson(init.body);
+        if (!bodyParseError) {
+            init.body = parsedBody;
+        }
+
+        const parsedInit = { input, init };
+        return [parsedInit, null];
+    } catch (error) {
+        return [null, error];
+    }
+}
+
+const getUrlType = (url: string) => {
+    for (const [apiType, apiTypeUrls] of Object.entries(DefaultInterceptUrlsMap)) {
+        if (apiTypeUrls.includes(url)) return apiType as InterceptedApiType;
+    }
+    // TODO: have a unknown type maybe ??
+    return InterceptedApiType.ALL;
+}
+
+/**
+ * Handle Api intercept event and simulate legacy onBeforeGetVizDataIntercept event
+ * 
+ * embed sends -> ApiIntercept -> we send 
+ *  ApiIntercept 
+ *  OnBeforeGetVizDataIntercept (if url is part of DefaultUrlMap.AnswerData)
+ * 
+ * @param params 
+ * @returns 
+ */
+export const handleInterceptEvent = async (params: {
+    eventData: any,
+    executeEvent: (eventType: EmbedEvent, data: any) => void,
+    viewConfig: BaseViewConfig,
+    getUnsavedAnswerTml: (props: { sessionId?: string, vizId?: string }) => Promise<{ tml: string }>
+}) => {
+
+    const { eventData, executeEvent, viewConfig, getUnsavedAnswerTml } = params;
+
+    const [interceptData, bodyParseError] = parseInterceptData(eventData.data);
+
+    if (bodyParseError) {
+        executeEvent(EmbedEvent.Error, {
+            error: 'Error parsing api intercept body',
+        });
+        logger.error('Error parsing request body', bodyParseError);
+        return;
+    }
+
+
+    const { input: requestUrl, init } = interceptData;
+    
+    const sessionId = init?.body?.variables?.session?.sessionId;
+    const vizId = init?.body?.variables?.contextBookId;
+
+    const answerDataUrls = DefaultInterceptUrlsMap[InterceptedApiType.AnswerData];
+    const legacyInterceptEnabled = viewConfig.isOnBeforeGetVizDataInterceptEnabled;
+    const isAnswerDataUrl = answerDataUrls.includes(requestUrl);
+    const sendLegacyIntercept = isAnswerDataUrl && legacyInterceptEnabled;
+    if (sendLegacyIntercept) {
+        const answerTml = await getUnsavedAnswerTml({ sessionId, vizId });
+        // Build the legacy payload for backwards compatibility
+        const legacyPayload = {
+            data: {
+                data:  answerTml,
+                status: embedEventStatus.END,
+                type: EmbedEvent.OnBeforeGetVizDataIntercept
+            }
+        }
+        executeEvent(EmbedEvent.OnBeforeGetVizDataIntercept, legacyPayload);
+    }
+
+    const urlType = getUrlType(requestUrl);
+    executeEvent(EmbedEvent.ApiIntercept, { ...interceptData, urlType });
+}
+
+/**
+ * Support both the legacy and new format of the api intercept response
+ * @param payload 
+ * @returns 
+ */
+export const processApiInterceptResponse = (payload: any) => {
+   const isLegacyFormat = payload?.data?.error;
+
+   if (isLegacyFormat) {
+    return processLegacyInterceptResponse(payload);
+   }
+
+   return payload;
+}
+
+export const processLegacyInterceptResponse = (payload: any) => {
+
+    const errorText = payload?.data?.error?.errorText;
+    const errorDescription = payload?.data?.error?.errorDescription;
+
+    const payloadToSend = {
+        execute: payload?.data?.execute,
+        response: {
+            body: {
+                errors: [
+                    {
+                        title: errorText,
+                        description: errorDescription,
+                        isUserError: true,
+                    },
+                ],
+                data: {},
+            },
+        },
+    };
+
+
+    return { data: payloadToSend };
+}

package/src/css-variables.ts

@@ -847,4 +847,9 @@ export interface CustomCssVariables {
      * Background color of the summary header in the CCA modal.
      */
     '--ts-var-cca-modal-summary-header-background'?: string;
+    
+    /**
+     * Width of the Spotter chat window.
+     */
+    '--ts-var-spotter-chat-width'?: string;
   }

package/src/embed/app.spec.ts

@@ -414,6 +414,17 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should not set liveboardXLSXCSVDownload in url when undefined', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+            expect(iframeSrc).not.toContain('isLiveboardXLSXCSVDownloadEnabled');
+        });
+    });
+
     test('should set isCentralizedLiveboardFilterUXEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/app.ts

@@ -512,11 +512,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      * ```
      */
     dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
-    /**
-     * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
-     * @version SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl
-     */
-    isOnBeforeGetVizDataInterceptEnabled?: boolean;
     /**
      * Flag to use home page search bar mode
      * 
@@ -668,8 +663,6 @@ export class AppEmbed extends V1Embed {
             collapseSearchBarInitially = false,
             enable2ColumnLayout,
             enableCustomColumnGroups = false,
-            isOnBeforeGetVizDataInterceptEnabled = false,
-
             dataPanelCustomGroupsAccordionInitialState = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
             collapseSearchBar = true,
             isLiveboardCompactHeaderEnabled = false,
@@ -682,7 +675,7 @@ export class AppEmbed extends V1Embed {
             enablePendoHelp = true,
             discoveryExperience,
             coverAndFilterOptionInPDF = false,
-            liveboardXLSXCSVDownload = false,
+            liveboardXLSXCSVDownload,
             isLiveboardStylingAndGroupingEnabled,
             isPNGInScheduledEmailsEnabled = false,
             isCentralizedLiveboardFilterUXEnabled = false,
@@ -706,7 +699,6 @@ export class AppEmbed extends V1Embed {
         params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
         params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
         params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
-        params[Param.LiveboardXLSXCSVDownload] = !!liveboardXLSXCSVDownload;
 
         params = this.getBaseQueryParams(params);
 
@@ -752,13 +744,6 @@ export class AppEmbed extends V1Embed {
             params[Param.enableAskSage] = enableAskSage;
         }
 
-        if (isOnBeforeGetVizDataInterceptEnabled) {
-
-            params[
-                Param.IsOnBeforeGetVizDataInterceptEnabled
-            ] = isOnBeforeGetVizDataInterceptEnabled;
-        }
-
         if (homePageSearchBarMode) {
             params[Param.HomePageSearchBarMode] = homePageSearchBarMode;
         }
@@ -771,6 +756,10 @@ export class AppEmbed extends V1Embed {
             params[Param.IsLiveboardStylingAndGroupingEnabled] = isLiveboardStylingAndGroupingEnabled;
         }
 
+        if (liveboardXLSXCSVDownload !== undefined) {
+            params[Param.LiveboardXLSXCSVDownload] = !!liveboardXLSXCSVDownload;
+        }
+
         if (isPNGInScheduledEmailsEnabled !== undefined) {
             params[Param.isPNGInScheduledEmailsEnabled] = isPNGInScheduledEmailsEnabled;
         }

package/src/embed/conversation.spec.ts

@@ -316,6 +316,28 @@ describe('ConversationEmbed', () => {
         );
     });
 
+    it('should render the conversation embed with all boolean flags set', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            disableSourceSelection: true,
+            hideSourceSelection: true,
+            dataPanelV2: true,
+            showSpotterLimitations: true,
+            hideSampleQuestions: true,
+            enablePastConversationsSidebar: true,
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&disableSourceSelection=true&hideSourceSelection=true&enableDataPanelV2=true&showSpotterLimitations=true&hideSampleQuestions=true&enablePastConversationsSidebar=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
     it('should ensure deprecated ConversationEmbed class maintains same functionality as SpotterEmbed', async () => {
         const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',

package/src/embed/conversation.ts

@@ -62,7 +62,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default true
-     * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
+     * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -177,7 +177,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      *    enablePastConversationsSidebar : true,
      * })
      * ```
-     * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     enablePastConversationsSidebar?: boolean;
 }
@@ -263,7 +263,7 @@ export class SpotterEmbed extends TsEmbed {
             excludeRuntimeFiltersfromURL,
             runtimeParameters,
             excludeRuntimeParametersfromURL,
-            enablePastConversationsSidebar
+            enablePastConversationsSidebar,
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         const queryParams = this.getEmbedParamsObject();

package/src/embed/hostEventClient/contracts.ts

@@ -7,6 +7,7 @@ export enum UIPassthroughEvent {
   GetAvailableUIPassthroughs = 'getAvailableUiPassthroughs',
   GetAnswerConfig = 'getAnswerPageConfig',
   GetLiveboardConfig = 'getPinboardPageConfig',
+  GetUnsavedAnswerTML = 'getUnsavedAnswerTML',
 }
 
 // UI Passthrough Contract
@@ -63,6 +64,15 @@ export type UIPassthroughContractBase = {
     request: any;
     response: any;
   };
+  [UIPassthroughEvent.GetUnsavedAnswerTML]: {
+    request: {
+      sessionId?: string;
+      vizId?: string;
+    };
+    response: {
+      tml: string;
+    };
+  };
 };
 
 // UI Passthrough Request and Response

package/src/embed/liveboard.spec.ts

@@ -483,6 +483,18 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should not add liveboardXLSXCSVDownload flag when undefined', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+            expect(iframeSrc).not.toContain('isLiveboardXLSXCSVDownloadEnabled');
+        });
+    });
+
     test('should add isCentralizedLiveboardFilterUXEnabled flag and set value to true to the iframe src', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/liveboard.ts

@@ -474,7 +474,7 @@ export class LiveboardEmbed extends V1Embed {
             isForceRedirect,
             dataSourceId,
             coverAndFilterOptionInPDF = false,
-            liveboardXLSXCSVDownload = false,
+            liveboardXLSXCSVDownload,
             isLiveboardStylingAndGroupingEnabled,
             isPNGInScheduledEmailsEnabled = false,
             showSpotterLimitations,
@@ -574,7 +574,11 @@ export class LiveboardEmbed extends V1Embed {
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
         params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
-        params[Param.LiveboardXLSXCSVDownload] = !!liveboardXLSXCSVDownload;
+
+        if (liveboardXLSXCSVDownload !== undefined) {
+            params[Param.LiveboardXLSXCSVDownload] = !!liveboardXLSXCSVDownload;
+        }
+
         const queryParams = getQueryParamString(params, true);
 
         return params;

package/src/embed/search.ts

@@ -26,6 +26,7 @@ import { ERROR_MESSAGE } from '../errors';
 import { getAuthPromise } from './base';
 import { getReleaseVersion } from '../auth';
 import { getEmbedConfig } from './embedConfig';
+import { getInterceptInitData } from '../api-intercept';
 
 /**
  * Configuration for search options.
@@ -276,13 +277,6 @@ export interface SearchViewConfig
      * @deprecated Use {@link collapseSearchBar} instead
      */
     collapseSearchBarInitially?: boolean;
-    /**
-     * Flag to enable onBeforeSearchExecute Embed Event
-     * 
-     * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
-     */
-    isOnBeforeGetVizDataInterceptEnabled?: boolean;
     /**
      * This controls the initial behaviour of custom column groups accordion.
      * It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
@@ -397,8 +391,6 @@ export class SearchEmbed extends TsEmbed {
             runtimeParameters,
             collapseSearchBarInitially = false,
             enableCustomColumnGroups = false,
-            isOnBeforeGetVizDataInterceptEnabled = false,
-
             dataPanelCustomGroupsAccordionInitialState = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
             focusSearchBarOnRender = true,
             excludeRuntimeParametersfromURL,
@@ -442,11 +434,6 @@ export class SearchEmbed extends TsEmbed {
             queryParams[Param.HideSearchBar] = true;
         }
 
-        if (isOnBeforeGetVizDataInterceptEnabled) {
-
-            queryParams[Param.IsOnBeforeGetVizDataInterceptEnabled] = isOnBeforeGetVizDataInterceptEnabled;
-        }
-
         if (!focusSearchBarOnRender) {
             queryParams[Param.FocusSearchBarOnRender] = focusSearchBarOnRender;
         }