@thoughtspot/visual-embed-sdk 1.33.9 → 1.33.11

package/src/embed/liveboard.spec.ts

@@ -172,6 +172,23 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should enable viz oAuthPollingInterval true', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            oAuthPollingInterval: 1000,
+            isForceRedirect: true,
+            dataSourceId: '12356',
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&oAuthPollingInterval=1000&isForceRedirect=true&dataSourceId=12356${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should disable viz transformations when enableVizTransformations false', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             enableVizTransformations: false,

package/src/embed/liveboard.ts

@@ -338,6 +338,45 @@ export interface LiveboardViewConfig
      * ```
      */
     hideIrrelevantChipsInLiveboardTabs?: boolean;
+
+    /**
+     * The Liveboard to run on regular intervals to fetch the cdw token.
+     * @hidden
+     * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    oAuthPollingInterval: value in milliseconds,
+     * })
+     */
+    oAuthPollingInterval?: number;
+
+    /**
+     * The Liveboard is set to force a token fetch during the initial load.
+     * @hidden
+     * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    isForceRedirect: false,
+     * })
+     */
+    isForceRedirect?: boolean;
+
+    /**
+     * The source connection ID for authentication.
+     * @hidden
+     * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    dataSourceId: '',
+     * })
+     */
+    dataSourceId?: string;
 }
 
 /**
@@ -399,6 +438,9 @@ export class LiveboardEmbed extends V1Embed {
             enable2ColumnLayout,
             dataPanelV2 = false,
             enableCustomColumnGroups = false,
+            oAuthPollingInterval,
+            isForceRedirect,
+            dataSourceId,
         } = this.viewConfig;
 
         const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
@@ -445,6 +487,18 @@ export class LiveboardEmbed extends V1Embed {
             params[Param.enableAskSage] = enableAskSage;
         }
 
+        if (oAuthPollingInterval !== undefined) {
+            params[Param.OauthPollingInterval] = oAuthPollingInterval;
+        }
+
+        if (isForceRedirect) {
+            params[Param.IsForceRedirect] = isForceRedirect;
+        }
+
+        if (dataSourceId !== undefined) {
+            params[Param.DataSourceId] = dataSourceId;
+        }
+
         params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
         params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
         params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;

package/src/embed/ts-embed.spec.ts

@@ -9,6 +9,12 @@ import {
     LiveboardViewConfig,
     AppEmbed,
     LiveboardEmbed,
+    AppViewConfig,
+    SageEmbed,
+    SageViewConfig,
+    ConversationViewConfig,
+    ConversationEmbed,
+    SearchViewConfig,
 } from '../index';
 import {
     Action, HomeLeftNavItem, RuntimeFilter, RuntimeFilterOp, HomepageModule, HostEvent,
@@ -28,6 +34,8 @@ import {
     expectUrlToHaveParamsWithValues,
     mockMessageChannel,
     createRootEleForEmbed,
+    expectUrlMatch,
+    fixedEncodeURI,
 } from '../test/test-utils';
 import * as config from '../config';
 import * as embedConfig from './embedConfig';
@@ -38,6 +46,8 @@ import * as baseInstance from './base';
 import { MIXPANEL_EVENT } from '../mixpanel-service';
 import * as authService from '../utils/authService/authService';
 import { logger } from '../utils/logger';
+import { version } from '../../package.json';
+import { HiddenActionItemByDefaultForSearchEmbed } from './search';
 
 const defaultViewConfig = {
     frameParams: {
@@ -51,6 +61,12 @@ const tabId1 = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const tabId2 = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const thoughtSpotHost = 'tshost';
 const defaultParamsPost = '';
+export const defaultParamsWithoutHiddenActions = `hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&authType=${AuthType.None}&blockNonEmbedFullAppAccess=true`;
+export const defaultParams = `&${defaultParamsWithoutHiddenActions}&hideAction=[%22${Action.ReportError}%22]`;
+const hideBydefault = `&hideAction=${fixedEncodeURI(
+    JSON.stringify([Action.ReportError, ...HiddenActionItemByDefaultForSearchEmbed]),
+)}`;
+const defaultParamsWithHiddenActions = defaultParamsWithoutHiddenActions + hideBydefault;
 
 beforeAll(() => {
     spyOn(window, 'alert');
@@ -89,6 +105,29 @@ describe('Unit test case for ts embed', () => {
         jest.spyOn(authInstance, 'postLoginService').mockResolvedValue(true);
     });
 
+    describe('Vaidate iframe properties', () => {
+        beforeAll(() => {
+            init({
+                thoughtSpotHost: 'tshost',
+                authType: AuthType.None,
+            });
+        });
+
+        test('should set proper allow policies', async () => {
+            // we dont have origin specific policies so just checking if
+            // policies are ending with ;
+            const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+            searchEmbed.render();
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                const policiesAdded = iframe.allow.split(' ');
+                policiesAdded.forEach((policy) => {
+                    expect(policy.endsWith(';')).toBe(true);
+                });
+            });
+        });
+    });
+
     describe('AuthExpire embedEvent in cookieless authentication authType', () => {
         beforeAll(() => {
             jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);
@@ -1454,6 +1493,186 @@ describe('Unit test case for ts embed', () => {
                 orgId: overrideOrgId,
             });
         });
+
+        it('AppEmbed: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                enableFlipTooltipToContextMenu: true,
+            } as AppViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&flipTooltipToContextMenuEnabled=true${defaultParams}${defaultParamsPost}#/home`,
+                );
+            });
+        });
+
+        it('AppEmbed: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when if false', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                enableFlipTooltipToContextMenu: false,
+            } as AppViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`,
+                );
+            });
+        });
+
+        it('LiveboardEmbed: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
+            const appEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                enableFlipTooltipToContextMenu: true,
+            } as LiveboardViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/?embedApp=true&flipTooltipToContextMenuEnabled=true${defaultParams}#/embed/viz/${liveboardId}`,
+                );
+            });
+        });
+
+        it('LiveboardEmbed: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when if false', async () => {
+            const appEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                enableFlipTooltipToContextMenu: false,
+            } as LiveboardViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/?embedApp=true${defaultParams}#/embed/viz/${liveboardId}`,
+                );
+            });
+        });
+
+        it('SageViewConfig: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
+            const defaultConfig: SageViewConfig = {
+                disableWorksheetChange: false,
+                hideWorksheetSelector: false,
+                hideSageAnswerHeader: false,
+                hideAutocompleteSuggestions: false,
+                hideSampleQuestions: false,
+                isProductTour: false,
+                dataPanelV2: false,
+            };
+            const appEmbed = new SageEmbed(getRootEl(), {
+                ...defaultConfig,
+                enableFlipTooltipToContextMenu: true,
+            } as SageViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatch(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D&flipTooltipToContextMenuEnabled=true#/embed/eureka`,
+                );
+            });
+        });
+
+        it('SageViewConfig: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when if false', async () => {
+            const defaultConfig: SageViewConfig = {
+                disableWorksheetChange: false,
+                hideWorksheetSelector: false,
+                hideSageAnswerHeader: false,
+                hideAutocompleteSuggestions: false,
+                hideSampleQuestions: false,
+                isProductTour: false,
+                dataPanelV2: false,
+            };
+            const appEmbed = new SageEmbed(getRootEl(), {
+                ...defaultConfig,
+                enableFlipTooltipToContextMenu: false,
+            } as SageViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatch(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
+                );
+            });
+        });
+
+        it('ConversationEmbed: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
+            const appEmbed = new ConversationEmbed(getRootEl(), {
+                worksheetId: 'worksheetId',
+                searchOptions: {
+                    searchQuery: 'searchQuery',
+                },
+                enableFlipTooltipToContextMenu: true,
+            } as ConversationViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&flipTooltipToContextMenuEnabled=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+                );
+            });
+        });
+
+        it('ConversationEmbed: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when flag is false', async () => {
+            const appEmbed = new ConversationEmbed(getRootEl(), {
+                worksheetId: 'worksheetId',
+                searchOptions: {
+                    searchQuery: 'searchQuery',
+                },
+                enableFlipTooltipToContextMenu: false,
+            } as ConversationViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+                );
+            });
+        });
+
+        it('SearchEmbed: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
+            const dataSources = ['data-source-1'];
+            const appEmbed = new SearchEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                dataSources,
+                enableFlipTooltipToContextMenu: true,
+            } as SearchViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&useLastSelectedSources=false&flipTooltipToContextMenuEnabled=true#/embed/answer`,
+                );
+            });
+        });
+
+        it('SearchEmbed: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when if false', async () => {
+            const dataSources = ['data-source-1'];
+            const appEmbed = new SearchEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                dataSources,
+                enableFlipTooltipToContextMenu: false,
+            } as SearchViewConfig);
+
+            appEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&useLastSelectedSources=false#/embed/answer`,
+                );
+            });
+        });
     });
 
     describe('When destroyed', () => {

package/src/embed/ts-embed.ts

@@ -446,6 +446,7 @@ export class TsEmbed {
             insertInToSlide,
             disableRedirectionLinksInNewTab,
             overrideOrgId,
+            enableFlipTooltipToContextMenu = false,
         } = this.viewConfig;
 
         const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
@@ -455,6 +456,10 @@ 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;
@@ -576,7 +581,7 @@ export class TsEmbed {
         iFrame.mozallowfullscreen = true;
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
-        iFrame.allow = 'clipboard-read; clipboard-write fullscreen';
+        iFrame.allow = 'clipboard-read; clipboard-write; fullscreen;';
 
         const {
             height: frameHeight,

package/src/index.ts

@@ -6,7 +6,9 @@
  * @summary ThoughtSpot Visual Embed SDK
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { AppEmbed, Page, AppViewConfig } from './embed/app';
+import {
+    AppEmbed, Page, AppViewConfig, HomePageSearchBarMode,
+} from './embed/app';
 import {
     init,
     prefetch,
@@ -122,6 +124,7 @@ export {
     LogLevel,
     uploadMixpanelEvent,
     MIXPANEL_EVENT,
+    HomePageSearchBarMode,
     VizPoint,
     CustomActionPayload,
 };

package/src/types.ts

@@ -1100,6 +1100,12 @@ 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;
 }
 
 /**
@@ -2412,7 +2418,6 @@ export enum HostEvent {
      * Get iframe URL for the current embed view on the playground.
      * Developers can use this URL to embed a ThoughtSpot object
      * in apps like Salesforce or Sharepoint.
-     *
      * @example
      * ```js
      * const url = embed.trigger(HostEvent.GetIframeUrl);
@@ -2535,7 +2540,6 @@ export enum HostEvent {
      * sorting, toggling of legends, and data drill down.
      * For more information, see
      * link:https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#transient-lb-content[Liveboard data with unsaved changes].
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
@@ -3187,6 +3191,14 @@ export enum HostEvent {
      * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
      */
     GetParameters = 'GetParameters',
+    /**
+     * Triggers update of persoanlised view for a liveboard
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
+     * ```
+     * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     */
+    UpdatePersonalisedView = 'UpdatePersonalisedView',
 }
 
 /**
@@ -3308,6 +3320,10 @@ export enum Param {
     SpotterEnabled = 'isSpotterExperienceEnabled',
     IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
     OverrideOrgId = 'orgId',
+    EnableFlipTooltipToContextMenu = 'flipTooltipToContextMenuEnabled',
+    OauthPollingInterval = 'oAuthPollingInterval',
+    IsForceRedirect = 'isForceRedirect',
+    DataSourceId = 'dataSourceId',
 }
 
 /**
@@ -4391,7 +4407,7 @@ export enum Action {
      * Action ID for hide/disable reset button in spotter
      *  @example
      * ```js
-     * hiddenAction: [Action.ChangeFilterVisibilityInTab]
+     * hiddenAction: [Action.ResetSpotterChat]
      * ```
      *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
      */
@@ -4401,11 +4417,41 @@ export enum Action {
      * Action ID for hide/disable feedback in spotter
      *  @example
      * ```js
-     * hiddenAction: [Action.ChangeFilterVisibilityInTab]
+     * hiddenAction: [Action.SpotterFeedback]
      * ```
      *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
      */
     SpotterFeedback = 'spotterFeedback',
+
+    /**
+     * Action ID for hide/disable editing previous prompt in spotter
+     *  @example
+     * ```js
+     * hiddenAction: [Action.EditPreviousPrompt]
+     * ```
+     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     */
+    EditPreviousPrompt = 'editPreviousPrompt',
+
+    /**
+     * Action ID for hide/disable deleting previous prompt in spotter
+     *  @example
+     * ```js
+     * hiddenAction: [Action.DeletePreviousPrompt]
+     * ```
+     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     */
+    DeletePreviousPrompt = 'deletePreviousPrompt',
+
+    /**
+     * Action ID for hide/disable edit of tokens on spotter results.
+     *  @example
+     * ```js
+     * hiddenAction: [Action.EditTokens]
+     * ```
+     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     */
+    EditTokens = 'editTokens',
 }
 
 export interface AnswerServiceType {