@thoughtspot/visual-embed-sdk 1.35.11 → 1.35.13

package/src/embed/ts-embed.ts

@@ -10,8 +10,6 @@ import isEqual from 'lodash/isEqual';
 import isEmpty from 'lodash/isEmpty';
 import isObject from 'lodash/isObject';
 import {
-    HostEventRequest,
-    HostEventResponse,
     TriggerPayload,
     TriggerResponse,
     UIPassthroughArrayResponse,
@@ -141,8 +139,8 @@ export class TsEmbed {
     protected thoughtSpotHost: string;
 
     /*
-    * This is the base to access ThoughtSpot V2.
-    */
+     * This is the base to access ThoughtSpot V2.
+     */
     protected thoughtSpotV2Base: string;
 
     /**
@@ -352,7 +350,7 @@ export class TsEmbed {
                 ? this.viewConfig?.hiddenHomeLeftNavItems
                 : [],
             customVariablesForThirdPartyTools:
-            this.embedConfig.customVariablesForThirdPartyTools || {},
+                this.embedConfig.customVariablesForThirdPartyTools || {},
         };
     }
 
@@ -403,12 +401,37 @@ export class TsEmbed {
         notifyAuthFailure(AuthFailureType.EXPIRY);
     };
 
+    /**
+     * Auto Login and send updated authToken to the iFrame to avoid user session logout
+     * @param _
+     * @param responder
+     */
+    private idleSessionTimeout = (_: any, responder: any) => {
+        handleAuth().then(async () => {
+            let authToken = '';
+            try {
+                authToken = await getAuthenticationToken(this.embedConfig);
+                responder({
+                    type: EmbedEvent.IdleSessionTimeout,
+                    data: { authToken },
+                });
+            } catch (e) {
+                logger.error(`${ERROR_MESSAGE.INVALID_TOKEN_ERROR} Error : ${e?.message}`);
+                processAuthFailure(e, this.isPreRendered ? this.preRenderWrapper : this.el);
+            }
+        }).catch((e) => {
+            logger.error(`Auto Login failed, Error : ${e?.message}`);
+        });
+        notifyAuthFailure(AuthFailureType.IDLE_SESSION_TIMEOUT);
+    };
+
     /**
      * Register APP_INIT event and sendback init payload
      */
     private registerAppInit = () => {
         this.on(EmbedEvent.APP_INIT, this.appInitCb, { start: false }, true);
         this.on(EmbedEvent.AuthExpire, this.updateAuthToken, { start: false }, true);
+        this.on(EmbedEvent.IdleSessionTimeout, this.idleSessionTimeout, { start: false }, true);
     };
 
     /**
@@ -416,7 +439,7 @@ export class TsEmbed {
      * @param query
      */
     protected getEmbedBasePath(query: string): string {
-        let queryString = (query.startsWith('?')) ? query : `?${query}`;
+        let queryString = query.startsWith('?') ? query : `?${query}`;
         if (this.shouldEncodeUrlQueryParams) {
             queryString = `?base64UrlEncodedFlags=${getEncodedQueryParamsString(
                 queryString.substr(1),
@@ -434,9 +457,7 @@ export class TsEmbed {
      * @param queryParams
      * @returns queryParams
      */
-    protected getBaseQueryParams(
-        queryParams: Record<any, any> = {},
-    ) {
+    protected getBaseQueryParams(queryParams: Record<any, any> = {}) {
         let hostAppUrl = window?.location?.host || '';
 
         // The below check is needed because TS Cloud firewall, blocks
@@ -444,14 +465,15 @@ export class TsEmbed {
         if (hostAppUrl.includes('localhost') || hostAppUrl.includes('127.0.0.1')) {
             hostAppUrl = 'local-host';
         }
+        const blockNonEmbedFullAppAccess = this.embedConfig.blockNonEmbedFullAppAccess ?? true;
         queryParams[Param.EmbedApp] = true;
         queryParams[Param.HostAppUrl] = encodeURIComponent(hostAppUrl);
         queryParams[Param.ViewPortHeight] = window.innerHeight;
         queryParams[Param.ViewPortWidth] = window.innerWidth;
         queryParams[Param.Version] = version;
         queryParams[Param.AuthType] = this.embedConfig.authType;
-        queryParams[Param.blockNonEmbedFullAppAccess] = this.embedConfig.blockNonEmbedFullAppAccess
-            ?? true;
+        queryParams[Param.blockNonEmbedFullAppAccess] = blockNonEmbedFullAppAccess;
+        queryParams[Param.AutoLogin] = this.embedConfig.autoLogin;
         if (this.embedConfig.disableLoginRedirect === true || this.embedConfig.autoLogin === true) {
             queryParams[Param.DisableLoginRedirect] = true;
         }
@@ -490,7 +512,6 @@ export class TsEmbed {
             insertInToSlide,
             disableRedirectionLinksInNewTab,
             overrideOrgId,
-            enableFlipTooltipToContextMenu = false,
         } = this.viewConfig;
 
         const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
@@ -500,10 +521,6 @@ export class TsEmbed {
             ...additionalFlagsFromView,
         };
 
-        if (enableFlipTooltipToContextMenu) {
-            queryParams[Param.EnableFlipTooltipToContextMenu] = enableFlipTooltipToContextMenu;
-        }
-
         if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
             this.handleError('You cannot have both hidden actions and visible actions');
             return queryParams;
@@ -536,13 +553,15 @@ export class TsEmbed {
          *  menu click
          */
         if (contextMenuTrigger === ContextMenuTriggerOptions.LEFT_CLICK) {
-            queryParams[Param.ContextMenuTrigger] = true;
+            queryParams[Param.ContextMenuTrigger] = 'left';
         } else if (contextMenuTrigger === ContextMenuTriggerOptions.RIGHT_CLICK) {
-            queryParams[Param.ContextMenuTrigger] = false;
+            queryParams[Param.ContextMenuTrigger] = 'right';
+        } else if (contextMenuTrigger === ContextMenuTriggerOptions.BOTH_CLICKS) {
+            queryParams[Param.ContextMenuTrigger] = 'both';
         }
 
-        const spriteUrl = customizations?.iconSpriteUrl
-            || this.embedConfig.customizations?.iconSpriteUrl;
+        const embedCustomizations = this.embedConfig.customizations;
+        const spriteUrl = customizations?.iconSpriteUrl || embedCustomizations?.iconSpriteUrl;
         if (spriteUrl) {
             queryParams[Param.IconSpriteUrl] = spriteUrl.replace('https://', '');
         }
@@ -627,11 +646,8 @@ export class TsEmbed {
         // @ts-ignore
         iFrame.allow = 'clipboard-read; clipboard-write; fullscreen;';
 
-        const {
-            height: frameHeight,
-            width: frameWidth,
-            ...restParams
-        } = this.viewConfig.frameParams || {};
+        const frameParams = this.viewConfig.frameParams;
+        const { height: frameHeight, width: frameWidth, ...restParams } = frameParams || {};
         const width = getCssDimension(frameWidth || DEFAULT_EMBED_WIDTH);
         const height = getCssDimension(frameHeight || DEFAULT_EMBED_HEIGHT);
         setAttributes(iFrame, restParams);
@@ -753,8 +769,8 @@ export class TsEmbed {
 
     protected connectPreRendered(): boolean {
         const preRenderIds = this.getPreRenderIds();
-        this.preRenderWrapper = this.preRenderWrapper
-            || document.getElementById(preRenderIds.wrapper);
+        const preRenderWrapperElement = document.getElementById(preRenderIds.wrapper);
+        this.preRenderWrapper = this.preRenderWrapper || preRenderWrapperElement;
 
         this.preRenderChild = this.preRenderChild || document.getElementById(preRenderIds.child);
 
@@ -1033,7 +1049,7 @@ export class TsEmbed {
      */
     public async trigger<HostEventT extends HostEvent, PayloadT>(
         messageType: HostEventT,
-        data: TriggerPayload<PayloadT, HostEventT> = ({} as any),
+        data: TriggerPayload<PayloadT, HostEventT> = {} as any,
     ): Promise<TriggerResponse<PayloadT, HostEventT>> {
         uploadMixpanelEvent(`${MIXPANEL_EVENT.VISUAL_SDK_TRIGGER}-${messageType}`);
 
@@ -1182,11 +1198,11 @@ export class TsEmbed {
                 ) {
                     logger.warn(
                         `${viewConfig.embedComponentType || 'Component'} was pre-rendered with `
-                        + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
-                        + `but a different value "${JSON.stringify(viewConfig[key])}" `
-                        + 'was passed to the Embed component. '
-                        + 'The new value provided is ignored, the value provided during '
-                        + 'preRender is used.',
+                            + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
+                            + `but a different value "${JSON.stringify(viewConfig[key])}" `
+                            + 'was passed to the Embed component. '
+                            + 'The new value provided is ignored, the value provided during '
+                            + 'preRender is used.',
                     );
                 }
             });
@@ -1351,7 +1367,7 @@ export class V1Embed extends TsEmbed {
             const filterQuery = getFilterQuery(runtimeFilters || []);
             queryString = [filterQuery, queryString].filter(Boolean).join('&');
         }
-        return (this.viewConfig.enableV2Shell_experimental)
+        return this.viewConfig.enableV2Shell_experimental
             ? this.getEmbedBasePath(queryString)
             : this.getV1EmbedBasePath(queryString);
     }

package/src/types.ts

@@ -535,7 +535,12 @@ export interface EmbedConfig {
     suppressErrorAlerts?: boolean;
 
     /**
-     * Log level for the SDK.
+     * Suppress or show specific types of logs in the console output.
+     * For example, `LogLevel.ERROR` shows only Visual Embed SDK and
+     * ThoughtSpot application errors and suppresses
+     * other logs such as warnings, information alerts,
+     * and debug messages in the console output.
+     *
      * @default LogLevel.ERROR
      * @example
      * ```js
@@ -1119,12 +1124,6 @@ export interface ViewConfig {
      * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
      */
     overrideOrgId?: number;
-    /**
-     * Flag to control new flip tooltip context menu experience
-     * @default false
-     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
-     */
-    enableFlipTooltipToContextMenu?: boolean;
 }
 
 /**
@@ -1593,6 +1592,13 @@ export enum EmbedEvent {
      * @hidden
      */
     AuthFailure = 'ThoughtspotAuthFailure',
+
+    /**
+     * ThoughtSpot failed to re validate the auth session.
+     * @hidden
+     */
+    IdleSessionTimeout = 'IdleSessionTimeout',
+
     /**
      * ThoughtSpot failed to validate the auth session.
      * @hidden
@@ -2299,6 +2305,36 @@ export enum EmbedEvent {
      * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
      */
     ParameterChanged = 'parameterChanged',
+    /**
+     * Emitted when the table viz renders.
+     * You can use this event as a hook to trigger
+     * other events on the rendered table viz data.
+     * @example
+     * ```js
+     * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
+     *       console.log(payload);
+     *       const columnDataLite = payload.data.data.columnDataLite;
+     *       columnDataLite[0].dataValue[0]="new fob";
+     *       console.log('>>> new Data', columnDataLite);
+     *       searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
+     * })
+     * ```
+     * @version SDK: 1.35.12 | ThoughtSpot: 10.7.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.36.0 | ThoughtSpot : 10.8.0.cl
+     */
+    CreateLiveboard = 'createLiveboard',
 }
 
 /**
@@ -2709,7 +2745,7 @@ export enum HostEvent {
      * @param - an object with `vizId` as a key
      * @example
      * ```js
-     * liveboardEmbed.trigger(HostEvent.CreateMonitor {
+     * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
@@ -3242,6 +3278,25 @@ export enum HostEvent {
      * @hidden
      */
     UIPassthrough = 'UiPassthrough',
+    /**
+     * Triggers the table viz rerender with the updated data.
+     * Includes the following properties:
+     * @param - columnDataLite - an array of object containing data
+     * transformed from data picked from TableVizRendered event.
+     * For example, { columnDataLite: []}
+     * @example
+     * ```js
+     * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
+     *       console.log(payload);
+     *       const columnDataLite = payload.data.data.columnDataLite;
+     *       columnDataLite[0].dataValue[0]="new fob";
+     *       console.log('>>> new Data', columnDataLite);
+     *       searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
+     * })
+     * ```
+     * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+     */
+    TransformTableVizData = 'TransformTableVizData',
 }
 
 /**
@@ -3286,6 +3341,7 @@ export enum Param {
     HideResult = 'hideResult',
     UseLastSelectedDataSource = 'useLastSelectedSources',
     Tag = 'tag',
+    AutoLogin = 'autoLogin',
     searchTokenString = 'searchTokenString',
     executeSearch = 'executeSearch',
     fullHeight = 'isFullHeightPinboard',
@@ -3308,7 +3364,12 @@ export enum Param {
     AuthType = 'authType',
     IconSpriteUrl = 'iconSprite',
     cookieless = 'cookieless',
-    ContextMenuTrigger = 'isContextMenuEnabledOnLeftClick',
+    // Deprecated: `isContextMenuEnabledOnLeftClick`
+    // Introduced: `contextMenuEnabledOnWhichClick` with values: 'left',
+    // 'right', or 'both'. This update only affects ThoughtSpot URL parameters
+    // and does not impact existing workflows or use cases. Added support for
+    // 'both' clicks in `contextMenuTrigger` configuration.
+    ContextMenuTrigger = 'contextMenuEnabledOnWhichClick',
     LinkOverride = 'linkOverride',
     blockNonEmbedFullAppAccess = 'blockNonEmbedFullAppAccess',
     ShowInsertToSlide = 'insertInToSlide',
@@ -3363,10 +3424,10 @@ export enum Param {
     SpotterEnabled = 'isSpotterExperienceEnabled',
     IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
     OverrideOrgId = 'orgId',
-    EnableFlipTooltipToContextMenu = 'flipTooltipToContextMenuEnabled',
     OauthPollingInterval = 'oAuthPollingInterval',
     IsForceRedirect = 'isForceRedirect',
     DataSourceId = 'dataSourceId',
+    ShowSpotterLimitations = 'showSpotterLimitations',
 }
 
 /**
@@ -4587,10 +4648,12 @@ export enum PrefetchFeatures {
 
 /**
  * Enum for options to change context trigger
+ * BOTH_CLICKS option is introduced in 10.7
  */
 export enum ContextMenuTriggerOptions {
     LEFT_CLICK = 'left-click',
     RIGHT_CLICK = 'right-click',
+    BOTH_CLICKS = 'both-clicks',
 }
 
 export interface ColumnValue {
@@ -4641,9 +4704,17 @@ export interface CustomActionPayload {
     vizId?: string;
 }
 
+/**
+ * Enum options to show or suppress Visual Embed SDK and
+ * ThoughtSpot application logs in the console output.
+ * This attribute doesn't support suppressing
+ * browser warnings or errors.
+ */
+
 export enum LogLevel {
     /**
-     * No logs will be logged in the console.
+     * No application or SDK-related logs will be logged
+     * in the console output.
      * @example
      * ```js
      * init({
@@ -4655,7 +4726,7 @@ export enum LogLevel {
      */
     SILENT = 'SILENT',
     /**
-     * Only ERROR logs will be logged in the console.
+     * Log only errors in the console output.
      * @example
      * ```js
      * init({
@@ -4667,7 +4738,7 @@ export enum LogLevel {
      */
     ERROR = 'ERROR',
     /**
-     * Only WARN and ERROR logs will be logged in the console.
+     * Log only warnings and errors in the console output.
      * @example
      * ```js
      * init({
@@ -4679,7 +4750,8 @@ export enum LogLevel {
      */
     WARN = 'WARN',
     /**
-     * Only INFO, WARN, and ERROR logs will be logged in the console.
+     * Log only the information alerts, warnings, and errors
+     * in the console output.
      * @example
      * ```js
      * init({
@@ -4692,7 +4764,8 @@ export enum LogLevel {
     INFO = 'INFO',
 
     /**
-     * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
+     * Log debug messages, warnings, information alerts,
+     * and errors in the console output.
      * @example
      * ```js
      * init({
@@ -4704,7 +4777,7 @@ export enum LogLevel {
      */
     DEBUG = 'DEBUG',
     /**
-     * All logs will be logged in the console.
+     * All logs will be logged in the browser console.
      * @example
      * ```js
      * init({

package/src/utils/processData.spec.ts

@@ -48,6 +48,37 @@ describe('Unit test for process data', () => {
         );
     });
 
+    test('ProcessData, when Action is CustomAction with contextMenuPoints', async () => {
+        const processedData = {
+            type: EmbedEvent.CustomAction,
+            data: {
+                contextMenuPoints: {
+                    selectedPoints: [{ x: 1, y: 2 }],
+                },
+            },
+        };
+        jest.spyOn(processDataInstance, 'processCustomAction').mockImplementation(async () => ({}));
+        expect(
+            processDataInstance.processEventData(
+                EmbedEvent.CustomAction,
+                processedData,
+                thoughtSpotHost,
+                null,
+            ),
+        ).toEqual(
+            expect.objectContaining({
+                ...processedData,
+                answerService: {
+                    answer: {},
+                    selectedPoints: [{ x: 1, y: 2 }],
+                    session: undefined,
+                    thoughtSpotHost: 'http://localhost',
+                    tmlOverride: {},
+                },
+            }),
+        );
+    });
+
     test('ProcessData, when Action is non CustomAction', () => {
         const processedData = { type: EmbedEvent.Data };
         jest.spyOn(processDataInstance, 'processCustomAction').mockImplementation(async () => ({}));
@@ -188,4 +219,36 @@ describe('Unit test for process data', () => {
         expect(base.notifyAuthFailure).not.toBeCalled();
         expect(el.innerHTML).not.toBe('Hello');
     });
+
+    test('process authFailure AuthType=TrustedAuthToken and autoLogin true', () => {
+        const e = { type: EmbedEvent.AuthFailure };
+        jest.spyOn(base, 'notifyAuthFailure');
+        jest.spyOn(embedConfigInstance, 'getEmbedConfig').mockReturnValue({
+            loginFailedMessage: 'Hello',
+            authType: AuthType.TrustedAuthToken,
+            autoLogin: true,
+        });
+        const el: any = {};
+        expect(processDataInstance.processEventData(e.type, e, '', el)).toEqual({
+            type: e.type,
+        });
+        expect(base.notifyAuthFailure).toBeCalledWith(auth.AuthFailureType.IDLE_SESSION_TIMEOUT);
+        expect(el.innerHTML).toBe('Hello');
+    });
+
+    test('process authFailure with TrustedAuthTokenCookieless and autoLogin', () => {
+        const e = { type: EmbedEvent.AuthFailure };
+        jest.spyOn(base, 'notifyAuthFailure');
+        jest.spyOn(embedConfigInstance, 'getEmbedConfig').mockReturnValue({
+            loginFailedMessage: 'Hello',
+            authType: AuthType.TrustedAuthTokenCookieless,
+            autoLogin: true,
+        });
+        const el: any = {};
+        expect(processDataInstance.processEventData(e.type, e, '', el)).toEqual({
+            type: e.type,
+        });
+        expect(base.notifyAuthFailure).toBeCalledWith(auth.AuthFailureType.IDLE_SESSION_TIMEOUT);
+        expect(el.innerHTML).toBe('Hello');
+    });
 });

package/src/utils/processData.ts

@@ -77,8 +77,18 @@ function processNoCookieAccess(e: any, containerEl: Element) {
  * @param containerEl
  */
 export function processAuthFailure(e: any, containerEl: Element) {
-    const { loginFailedMessage, authType, disableLoginFailurePage } = getEmbedConfig();
-    if (authType !== AuthType.None && !disableLoginFailurePage) {
+    const {
+        loginFailedMessage, authType, disableLoginFailurePage, autoLogin,
+    } = getEmbedConfig();
+    if (
+        autoLogin
+        && (authType === AuthType.TrustedAuthToken
+            || authType === AuthType.TrustedAuthTokenCookieless)
+    ) {
+        // eslint-disable-next-line no-param-reassign
+        containerEl.innerHTML = loginFailedMessage;
+        notifyAuthFailure(AuthFailureType.IDLE_SESSION_TIMEOUT);
+    } else if (authType !== AuthType.None && !disableLoginFailurePage) {
         // eslint-disable-next-line no-param-reassign
         containerEl.innerHTML = loginFailedMessage;
         notifyAuthFailure(AuthFailureType.OTHER);