@thoughtspot/visual-embed-sdk 1.28.2 → 1.28.4

package/lib/src/visual-embed-sdk.d.ts

@@ -365,6 +365,44 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * @default false
                 */
             enableAskSage?: boolean;
+            /**
+                * To set the initial state of the search bar in case of saved-answers.
+                *
+                * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+                * @default false
+                */
+            collapseSearchBarInitially?: boolean;
+            /**
+                * To enable custom column groups in data panel v2
+                *
+                * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+                * @default false
+                *
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#embed', {
+                *   ... // other app view config
+                *   enableCustomColumnGroups: true,
+                * });
+                * ```
+                */
+            enableCustomColumnGroups?: boolean;
+            /**
+                * This flag is used to enable the 2 column layout in liveboard
+                *
+                * @type {boolean}
+                * @default false
+                * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
+                *
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    enable2ColumnLayout: true,
+                * })
+                * ```
+                */
+            enable2ColumnLayout?: boolean;
     }
     /**
         * Embeds full ThoughtSpot experience in a host application.
@@ -806,6 +844,22 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * ```
                 */
             enableAskSage?: boolean;
+            /**
+                * This flag is used to enable the 2 column layout in liveboard
+                *
+                * @type {boolean}
+                * @default false
+                * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
+                *
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    enable2ColumnLayout: true,
+                * })
+                * ```
+                */
+            enable2ColumnLayout?: boolean;
     }
     /**
         * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1064,6 +1118,28 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * @version: SDK: 1.24.0
                 */
             useLastSelectedSources?: boolean;
+            /**
+                * To set the initial state of the search bar in case of saved-answers.
+                *
+                * @default false
+                * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+                */
+            collapseSearchBarInitially?: boolean;
+            /**
+                * To enable custom column groups in data panel v2
+                *
+                * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+                * @default false
+                *
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *   ... // other options
+                *   enableCustomColumnGroups: true,
+                * });
+                * ```
+                */
+            enableCustomColumnGroups?: boolean;
     }
     export const HiddenActionItemByDefaultForSearchEmbed: Action[];
     /**
@@ -1953,6 +2029,24 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.27.9
                 */
             disableSDKTracking?: boolean;
+            /**
+                * Overrides default/user preffered locale for date formatting
+                *
+                * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+                */
+            dateFormatLocale?: string;
+            /**
+                * Overrides default/user preffered locale for number formatting
+                *
+                * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+                */
+            numberFormatLocale?: string;
+            /**
+                * Format to be used for currency when currency format is set to infer from browser
+                *
+                * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+                */
+            currencyFormat?: string;
     }
     export interface LayoutConfig {
     }
@@ -2270,11 +2364,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * **Note**: This option does not apply to the classic homepage.
                 * To access the updated modular homepage, set
-    <<<<<<< HEAD
-                * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.0.cl).
-    =======
                 * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
-    >>>>>>> 64e22666... typo fixes
                 *
                 * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
                 * @example
@@ -4417,7 +4507,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             HideSearchBar = "hideSearchBar",
             ClientLogLevel = "clientLogLevel",
             OverrideNativeConsole = "overrideConsoleLogs",
-            enableAskSage = "enableAskSage"
+            enableAskSage = "enableAskSage",
+            CollapseSearchBarInitially = "collapseSearchBarInitially",
+            EnableCustomColumnGroups = "enableCustomColumnGroups",
+            DateFormatLocale = "dateFormatLocale",
+            NumberFormatLocale = "numberFormatLocale",
+            CurrencyFormat = "currencyFormat",
+            Enable2ColumnLayout = "enable2ColumnLayout",
+            IsFullAppEmbed = "isFullAppEmbed"
     }
     /**
         * ThoughtSpot application pages include actions and menu commands
@@ -4553,6 +4650,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 */
             AddFilter = "addFilter",
+            /**
+                * The **Add Data Panel Objects** action on the data panel v2.
+                * Allows to show action menu to add different objects (like
+                * formulas, parameters) in data panel v2.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.AddDataPanelObjects]
+                * ```
+                * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+                */
+            AddDataPanelObjects = "addDataPanelObjects",
             /**
                 * Filter configuration options on a Liveboard and Search page.
                 * Allows configuring filter options when adding filters to a
@@ -4595,6 +4704,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 */
             AddParameter = "addParameter",
+            /**
+                * The **Add Column Set** action on a Answer.
+                * Allows adding column sets to a Answer.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.AddColumnSet]
+                * ```
+                * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+                */
+            AddColumnSet = "addSimpleCohort",
+            /**
+                * The **Add Query Set** action on a Answer.
+                * Allows adding query sets to a Answer.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.AddQuerySet]
+                * ```
+                * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+                */
+            AddQuerySet = "addAdvancedCohort",
             /**
                 * @hidden
                 */
@@ -5026,6 +5157,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             CrossFilter = "context-menu-item-cross-filter",
+            /**
+                * The **Sync to Slack** action on Liveboard visualizations.
+                * Allows sending data to third-party apps Slack
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.SyncToSlack]
+                * ```
+                * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
+                */
+            SyncToSlack = "syncToSlack",
+            /**
+                * The **Sync to Teams** action on Liveboard visualizations.
+                * Allows sending data to third-party apps Team
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.SyncToTeams]
+                * ```
+                * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
+                */
+            SyncToTeams = "syncToTeams",
             /**
                 * The **Remove** action that appears when cross filters are applied
                 * on a Liveboard.
@@ -5267,6 +5420,26 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
                 */
             LiveboardUsers = "liveboardUsers",
+            /**
+                * Action ID for the Parent TML action
+                * The parent action **TML** must be included to access TML-related options
+                * within the cascading menu (specific to the answer page)
+                *
+                * @example
+                * ```js
+                * // to include specific TML actions
+                * visibleActions: [Action.TML, Action.ExportTML, Action.EditTML]
+                *
+                * ```
+                * @example
+                * ```js
+                * hiddenAction: [Action.TML] // hide all TML actions
+                * disabledActions: [Action.TML] // to disable all TML actions
+                * ```
+                *
+                * @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
+                */
+            TML = "tml",
             /**
                 * Action ID for to hide Verified Liveboard Banner
                 *
@@ -5308,15 +5481,15 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             RemoveFromWatchlist = "removeFromWatchlist",
             /**
-                * The **Copy KPI Link** menu action on KPI watchlist.
+                * The **Organise Favourites** action on Homepage Favourite Module.
                 *
                 * @example
                 * ```js
-                * disabledActions: [Action.CopyKpiLink]
+                * disabledActions: [Action.OrganiseFavourites]
                 * ```
-                * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+                * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
                 */
-            CopyKpiLink = "copyKpiLink",
+            OrganiseFavourites = "organiseFavourites",
             /**
                 * Action ID for AI Highlights button
                 *
@@ -5819,7 +5992,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
         * @summary TS Sage embed
         * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
         */
-    import { Action, DOMSelector, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
+    import { DOMSelector, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
         * Configuration for search options
@@ -5857,7 +6030,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
             showObjectResults?: boolean;
             /**
                 * flag used by the TS product tour page to show the blue search bar
-                * even after the search is completed. This is different from TSE Sage Embed
+                * even after the search is completed. This is different from Thoughtspot Embedded Sage Embed
                 * experience where it mimics closer to the non-embed case.
                 * The Sample questions container is collapsed when this value is set after
                 * does a search.
@@ -5868,8 +6041,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
             isProductTour?: boolean;
             /**
                 * Show or hide the search bar title.
+                * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
                 *
-                * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+                * @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
                 */
             hideSearchBarTitle?: boolean;
             /**
@@ -5939,7 +6113,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
                 */
             searchOptions?: SearchOptions;
     }
-    export const HiddenActionItemByDefaultForSageEmbed: Action[];
     /**
         * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
         *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.28.2",
+    "version": "1.28.4",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -175,6 +175,7 @@
     "keywords": [
         "thoughtspot",
         "everywhere",
+        "embedded",
         "embed",
         "sdk",
         "analytics"

package/src/embed/app.spec.ts

@@ -289,6 +289,21 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set enable2ColumnLayout to true in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            enable2ColumnLayout: true,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enable2ColumnLayout=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add the tag to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/app.ts

@@ -341,6 +341,44 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * @default false
      */
     enableAskSage?: boolean;
+    /**
+     * To set the initial state of the search bar in case of saved-answers.
+     *
+     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @default false
+     */
+    collapseSearchBarInitially?: boolean;
+    /**
+     * To enable custom column groups in data panel v2
+     *
+     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @default false
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed', {
+     *   ... // other app view config
+     *   enableCustomColumnGroups: true,
+     * });
+     * ```
+     */
+    enableCustomColumnGroups?: boolean;
+    /**
+     * This flag is used to enable the 2 column layout in liveboard
+     *
+     * @type {boolean}
+     * @default false
+     * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
+     *
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    enable2ColumnLayout: true,
+     * })
+     * ```
+     */
+    enable2ColumnLayout?: boolean;
 }
 
 /**
@@ -387,6 +425,9 @@ export class AppEmbed extends V1Embed {
             modularHomeExperience = false,
             isLiveboardHeaderSticky = true,
             enableAskSage,
+            collapseSearchBarInitially = false,
+            enable2ColumnLayout,
+            enableCustomColumnGroups = false,
         } = this.viewConfig;
 
         let params = {};
@@ -399,6 +440,7 @@ export class AppEmbed extends V1Embed {
         params[Param.ShowLiveboardTitle] = showLiveboardTitle;
         params[Param.ShowLiveboardDescription] = !!showLiveboardDescription;
         params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
+        params[Param.IsFullAppEmbed] = true;
 
         params = this.getBaseQueryParams(params);
 
@@ -420,6 +462,10 @@ export class AppEmbed extends V1Embed {
             params[Param.EnableSearchAssist] = enableSearchAssist;
         }
 
+        if (enable2ColumnLayout !== undefined) {
+            params[Param.Enable2ColumnLayout] = enable2ColumnLayout;
+        }
+
         if (enableAskSage) {
             params[Param.enableAskSage] = enableAskSage;
         }
@@ -427,6 +473,8 @@ export class AppEmbed extends V1Embed {
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
         params[Param.ModularHomeExperienceEnabled] = modularHomeExperience;
+        params[Param.CollapseSearchBarInitially] = collapseSearchBarInitially;
+        params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
         const queryParams = getQueryParamString(params, true);
 
         return queryParams;

package/src/embed/liveboard.spec.ts

@@ -110,6 +110,21 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set enable2ColumnLayout to true in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            enable2ColumnLayout: true,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&enable2ColumnLayout=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should set visible actions as empty array', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             visibleActions: [],
@@ -269,6 +284,63 @@ describe('Liveboard/viz embed tests', () => {
             expect(onSpy).toHaveBeenCalledWith(EmbedEvent.EmbedHeight, expect.anything());
         });
     });
+
+    test('should not call setIFrameHeight if currentPath starts with "/embed/viz/"', () => {
+        const myObject = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            fullHeight: true,
+            liveboardId,
+        } as LiveboardViewConfig) as any;
+        const spySetIFrameHeight = jest.spyOn(myObject, 'setIFrameHeight');
+
+        myObject.render();
+        myObject.setIframeHeightForNonEmbedLiveboard({
+            data: { currentPath: '/embed/viz/' },
+            type: 'Route',
+        });
+
+        // Assert that setIFrameHeight is not called
+        expect(spySetIFrameHeight).not.toHaveBeenCalled();
+    });
+
+    test('should not call setIFrameHeight if currentPath starts with "/embed/insights/viz/"', () => {
+        const myObject = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            fullHeight: true,
+            liveboardId,
+        } as LiveboardViewConfig) as any;
+        const spySetIFrameHeight = jest.spyOn(myObject, 'setIFrameHeight');
+
+        myObject.render();
+        myObject.setIframeHeightForNonEmbedLiveboard({
+            data: { currentPath: '/embed/insights/viz/' },
+            type: 'Route',
+        });
+
+        // Assert that setIFrameHeight is not called
+        expect(spySetIFrameHeight).not.toHaveBeenCalled();
+    });
+
+    test('should  call setIFrameHeight if currentPath starts with "/some/other/path/"', () => {
+        const myObject = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            fullHeight: true,
+            liveboardId,
+        } as LiveboardViewConfig) as any;
+        const spySetIFrameHeight = jest
+            .spyOn(myObject, 'setIFrameHeight')
+            .mockImplementation(jest.fn());
+
+        myObject.render();
+        myObject.setIframeHeightForNonEmbedLiveboard({
+            data: { currentPath: '/some/other/path/' },
+            type: 'Route',
+        });
+
+        // Assert that setIFrameHeight is not called
+        expect(spySetIFrameHeight).toHaveBeenCalled();
+    });
+
     test('Should set the visible vizs', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -467,22 +539,23 @@ describe('Liveboard/viz embed tests', () => {
 
             let resizeObserverCb: any;
             (window as any).ResizeObserver = window.ResizeObserver
-            || jest.fn().mockImplementation((resizeObserverCbParam) => {
-                resizeObserverCb = resizeObserverCbParam;
-                return ({
-                    disconnect: jest.fn(),
-                    observe: jest.fn(),
-                    unobserve: jest.fn(),
+                || jest.fn().mockImplementation((resizeObserverCbParam) => {
+                    resizeObserverCb = resizeObserverCbParam;
+                    return {
+                        disconnect: jest.fn(),
+                        observe: jest.fn(),
+                        unobserve: jest.fn(),
+                    };
                 });
-            });
 
             libEmbed.preRender();
 
             await waitFor(() => !!getIFrameEl());
 
             const ts = '__tsEmbed';
-            expect(document.getElementById(libEmbed.getPreRenderIds().wrapper)[ts])
-                .toEqual(libEmbed);
+            expect(document.getElementById(libEmbed.getPreRenderIds().wrapper)[ts]).toEqual(
+                libEmbed,
+            );
 
             const testLiveboardId = 'testLiveboardId';
             const newLibEmbed = new LiveboardEmbed(getRootEl(), {

package/src/embed/liveboard.ts

@@ -256,6 +256,22 @@ export interface LiveboardViewConfig
      * ```
      */
     enableAskSage?: boolean;
+    /**
+     * This flag is used to enable the 2 column layout in liveboard
+     *
+     * @type {boolean}
+     * @default false
+     * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
+     *
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    enable2ColumnLayout: true,
+     * })
+     * ```
+     */
+    enable2ColumnLayout?: boolean;
 }
 
 /**
@@ -312,6 +328,7 @@ export class LiveboardEmbed extends V1Embed {
             showLiveboardTitle,
             isLiveboardHeaderSticky = true,
             enableAskSage,
+            enable2ColumnLayout,
         } = this.viewConfig;
 
         const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
@@ -339,6 +356,9 @@ export class LiveboardEmbed extends V1Embed {
         if (liveboardV2 !== undefined) {
             params[Param.LiveboardV2Enabled] = liveboardV2;
         }
+        if (enable2ColumnLayout !== undefined) {
+            params[Param.Enable2ColumnLayout] = enable2ColumnLayout;
+        }
         if (hideTabPanel) {
             params[Param.HideTabPanel] = hideTabPanel;
         }
@@ -409,9 +429,13 @@ export class LiveboardEmbed extends V1Embed {
     };
 
     private setIframeHeightForNonEmbedLiveboard = (data: MessagePayload) => {
-        if (!data.data.currentPath.startsWith('/embed/viz/')) {
-            this.setIFrameHeight(this.defaultHeight);
+        if (
+            data.data.currentPath.startsWith('/embed/viz/')
+            || data.data.currentPath.startsWith('/embed/insights/viz/')
+        ) {
+            return;
         }
+        this.setIFrameHeight(this.defaultHeight);
     };
 
     private setActiveTab(data: { tabId: string }) {