@thoughtspot/visual-embed-sdk 1.6.0-alpha.1 → 1.7.0-alpha.0

package/src/embed/liveboard.spec.ts

@@ -0,0 +1,199 @@
+import { LiveboardEmbed, LiveboardViewConfig } from './liveboard';
+import { init } from '../index';
+import { Action, AuthType, EmbedEvent, RuntimeFilterOp } from '../types';
+import {
+    executeAfterWait,
+    getDocumentBody,
+    getIFrameSrc,
+    getRootEl,
+} from '../test/test-utils';
+import { version } from '../../package.json';
+
+const defaultViewConfig = {
+    frameParams: {
+        width: 1280,
+        height: 720,
+    },
+};
+const liveboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
+const vizId = '6e73f724-660e-11eb-ae93-0242ac130002';
+const thoughtSpotHost = 'tshost';
+const defaultParams = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
+const prefixParams = '&isLiveboardEmbed=true';
+
+beforeAll(() => {
+    init({
+        thoughtSpotHost,
+        authType: AuthType.None,
+    });
+});
+
+describe('Liveboard/viz embed tests', () => {
+    beforeEach(() => {
+        document.body.innerHTML = getDocumentBody();
+    });
+
+    test('should render liveboard', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should set disabled actions', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            disabledActions: [
+                Action.DownloadAsCsv,
+                Action.DownloadAsPdf,
+                Action.DownloadAsXlsx,
+            ],
+            disabledActionReason: 'Action denied',
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should set hidden actions', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            hiddenActions: [
+                Action.DownloadAsCsv,
+                Action.DownloadAsPdf,
+                Action.DownloadAsXlsx,
+            ],
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&hideAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should set visible actions', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            visibleActions: [
+                Action.DownloadAsCsv,
+                Action.DownloadAsPdf,
+                Action.DownloadAsXlsx,
+            ],
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&visibleAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should set visible actions as empty array', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            visibleActions: [],
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&visibleAction=[]${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should enable viz transformations true', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            enableVizTransformations: true,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&enableVizTransform=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should disable viz transformations when enableVizTransformations false', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            enableVizTransformations: false,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&enableVizTransform=false${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should render viz', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            vizId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}${prefixParams}#/embed/viz/${liveboardId}/${vizId}`,
+            );
+        });
+    });
+
+    test('should apply runtime filters', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            vizId,
+            runtimeFilters: [
+                {
+                    columnName: 'sales',
+                    operator: RuntimeFilterOp.EQ,
+                    values: [1000],
+                },
+            ],
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true&col1=sales&op1=EQ&val1=1000${defaultParams}${prefixParams}#/embed/viz/${liveboardId}/${vizId}`,
+            );
+        });
+    });
+
+    test('should register event handler to adjust iframe height', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            fullHeight: true,
+            liveboardId,
+            vizId,
+        } as LiveboardViewConfig);
+
+        const onSpy = jest.spyOn(liveboardEmbed, 'on');
+        liveboardEmbed.render();
+
+        executeAfterWait(() => {
+            expect(onSpy).toHaveBeenCalledWith(
+                EmbedEvent.EmbedHeight,
+                expect.anything(),
+            );
+        });
+    });
+});

package/src/embed/{pinboard.ts → liveboard.ts}

@@ -1,11 +1,11 @@
 /**
  * Copyright (c) 2021
  *
- * Embed a ThoughtSpot pinboard or visualization
+ * Embed a ThoughtSpot Liveboard or visualization
  * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
  * https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
  *
- * @summary Pinboard & visualization embed
+ * @summary Liveboard & visualization embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 
@@ -22,21 +22,21 @@ import { getFilterQuery, getQueryParamString } from '../utils';
 import { V1Embed, ViewConfig } from './ts-embed';
 
 /**
- * The configuration for the embedded pinboard or visualization page view.
- * @Category Pinboards and Charts
+ * The configuration for the embedded Liveboard or visualization page view.
+ * @Category Liveboards and Charts
  */
-export interface PinboardViewConfig extends ViewConfig {
+export interface LiveboardViewConfig extends ViewConfig {
     /**
      * If set to true, the embedded object container dynamically resizes
-     * according to the height of the pinboard.
+     * according to the height of the Liveboard.
      */
     fullHeight?: boolean;
     /**
-     * This is the minimum height(in pixels) for a full height pinboard.
-     * Setting this height helps resolves issues with empty pinboards and
-     * other screens navigable from a pinboard.
+     * This is the minimum height(in pixels) for a full height Liveboard.
+     * Setting this height helps resolves issues with empty Liveboards and
+     * other screens navigable from a Liveboard.
+     * *_since 1.5.0_
      * @default 500
-     * * _since 1.5.0_
      */
     defaultHeight?: number;
     /**
@@ -44,47 +44,61 @@ export interface PinboardViewConfig extends ViewConfig {
      */
     enableVizTransformations?: boolean;
     /**
-     * The pinboard to display in the embedded view.
+     * The Liveboard to display in the embedded view.
+     * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
      */
-    pinboardId: string;
+    liveboardId?: string;
     /**
-     * The visualization within the pinboard to display.
+     * To support backward compatibilty
+     * @hidden
+     */
+    pinboardId?: string;
+    /**
+     * The visualization within the Liveboard to display.
      */
     vizId?: string;
     /**
      * If set to true, all filter chips from a
-     * pinboard page will be read-only (no X buttons)
+     * Liveboard page will be read-only (no X buttons)
+     */
+    preventLiveboardFilterRemoval?: boolean;
+    /**
+     * To support backward compatibilty
+     * @hidden
      */
     preventPinboardFilterRemoval?: boolean;
 }
 
 /**
- * Embed a ThoughtSpot pinboard or visualization
- * @Category Pinboards and Charts
+ * Embed a ThoughtSpot Liveboard or visualization
+ * @Category Liveboards and Charts
  */
-export class PinboardEmbed extends V1Embed {
-    protected viewConfig: PinboardViewConfig;
+export class LiveboardEmbed extends V1Embed {
+    protected viewConfig: LiveboardViewConfig;
 
     private defaultHeight = 500;
 
     // eslint-disable-next-line no-useless-constructor
-    constructor(domSelector: DOMSelector, viewConfig: PinboardViewConfig) {
+    constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig) {
         super(domSelector, viewConfig);
     }
 
     /**
      * Construct a map of params to be passed on to the
-     * embedded pinboard or visualization.
+     * embedded Liveboard or visualization.
      */
     private getEmbedParams() {
         const params = this.getBaseQueryParams();
         const {
             enableVizTransformations,
             fullHeight,
-            preventPinboardFilterRemoval,
             defaultHeight,
         } = this.viewConfig;
 
+        const preventLiveboardFilterRemoval =
+            this.viewConfig.preventLiveboardFilterRemoval ||
+            this.viewConfig.preventPinboardFilterRemoval;
+
         if (fullHeight === true) {
             params[Param.fullHeight] = true;
         }
@@ -96,8 +110,8 @@ export class PinboardEmbed extends V1Embed {
                 Param.EnableVizTransformations
             ] = enableVizTransformations.toString();
         }
-        if (preventPinboardFilterRemoval) {
-            params[Param.preventPinboardFilterRemoval] = true;
+        if (preventLiveboardFilterRemoval) {
+            params[Param.preventLiveboardFilterRemoval] = true;
         }
         params[Param.livedBoardEmbed] = true;
         const queryParams = getQueryParamString(params, true);
@@ -106,15 +120,15 @@ export class PinboardEmbed extends V1Embed {
     }
 
     /**
-     * Construct the URL of the embedded ThoughtSpot pinboard or visualization
+     * Construct the URL of the embedded ThoughtSpot Liveboard or visualization
      * to be loaded within the iframe.
-     * @param pinboardId The GUID of the pinboard.
-     * @param vizId The optional GUID of a visualization within the pinboard.
+     * @param liveboardId The GUID of the Liveboard.
+     * @param vizId The optional GUID of a visualization within the Liveboard.
      * @param runtimeFilters A list of runtime filters to be applied to
-     * the pinboard or visualization on load.
+     * the Liveboard or visualization on load.
      */
     private getIFrameSrc(
-        pinboardId: string,
+        liveboardId: string,
         vizId?: string,
         runtimeFilters?: RuntimeFilter[],
     ) {
@@ -128,7 +142,7 @@ export class PinboardEmbed extends V1Embed {
             true,
             false,
             false,
-        )}/viz/${pinboardId}`;
+        )}/viz/${liveboardId}`;
         if (vizId) {
             url = `${url}/${vizId}`;
         }
@@ -150,31 +164,30 @@ export class PinboardEmbed extends V1Embed {
         responder({ type: EmbedEvent.EmbedIframeCenter, data: obj });
     };
 
-    private handleRouteChangeFullHeightPinboard = (data: MessagePayload) => {
-        if (
-            data.data.canvasState !== 'EMBED' &&
-            data.data.canvasState !== 'pinboard'
-        ) {
+    private setIframeHeightForNonEmbedLiveboard = (data: MessagePayload) => {
+        if (!data.data.currentPath.startsWith('/embed/viz/')) {
             this.setIFrameHeight(this.defaultHeight);
         }
     };
 
     /**
-     * Render an embedded ThoughtSpot pinboard or visualization
-     * @param renderOptions An object specifying the pinboard ID,
+     * Render an embedded ThoughtSpot Liveboard or visualization
+     * @param renderOptions An object specifying the Liveboard ID,
      * visualization ID and the runtime filters.
      */
-    public render(): PinboardEmbed {
-        const { pinboardId, vizId, runtimeFilters } = this.viewConfig;
+    public render(): LiveboardEmbed {
+        const { vizId, runtimeFilters } = this.viewConfig;
+        const liveboardId =
+            this.viewConfig.liveboardId ?? this.viewConfig.pinboardId;
 
-        if (!pinboardId && !vizId) {
-            this.handleError(ERROR_MESSAGE.PINBOARD_VIZ_ID_VALIDATION);
+        if (!liveboardId) {
+            this.handleError(ERROR_MESSAGE.LIVEBOARD_VIZ_ID_VALIDATION);
         }
 
         if (this.viewConfig.fullHeight === true) {
             this.on(
                 EmbedEvent.RouteChange,
-                this.handleRouteChangeFullHeightPinboard,
+                this.setIframeHeightForNonEmbedLiveboard,
             );
             this.on(EmbedEvent.EmbedHeight, this.updateIFrameHeight);
             this.on(EmbedEvent.EmbedIframeCenter, this.embedIframeCenter);
@@ -182,9 +195,14 @@ export class PinboardEmbed extends V1Embed {
 
         super.render();
 
-        const src = this.getIFrameSrc(pinboardId, vizId, runtimeFilters);
+        const src = this.getIFrameSrc(liveboardId, vizId, runtimeFilters);
         this.renderV1Embed(src);
 
         return this;
     }
 }
+
+/**
+ * @hidden
+ */
+export class PinboardEmbed extends LiveboardEmbed {}

package/src/embed/pinboard.spec.ts

@@ -1,4 +1,4 @@
-import { PinboardEmbed, PinboardViewConfig } from './pinboard';
+import { PinboardEmbed, LiveboardViewConfig } from './liveboard';
 import { init } from '../index';
 import { Action, AuthType, EmbedEvent, RuntimeFilterOp } from '../types';
 import {
@@ -37,7 +37,7 @@ describe('Pinboard/viz embed tests', () => {
         const pinboardEmbed = new PinboardEmbed(getRootEl(), {
             ...defaultViewConfig,
             pinboardId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -56,7 +56,7 @@ describe('Pinboard/viz embed tests', () => {
             disabledActionReason: 'Action denied',
             ...defaultViewConfig,
             pinboardId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -74,7 +74,7 @@ describe('Pinboard/viz embed tests', () => {
             ],
             ...defaultViewConfig,
             pinboardId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -92,7 +92,7 @@ describe('Pinboard/viz embed tests', () => {
             ],
             ...defaultViewConfig,
             pinboardId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -106,7 +106,7 @@ describe('Pinboard/viz embed tests', () => {
             visibleActions: [],
             ...defaultViewConfig,
             pinboardId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -120,7 +120,7 @@ describe('Pinboard/viz embed tests', () => {
             enableVizTransformations: true,
             ...defaultViewConfig,
             pinboardId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -134,7 +134,7 @@ describe('Pinboard/viz embed tests', () => {
             enableVizTransformations: false,
             ...defaultViewConfig,
             pinboardId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -148,7 +148,7 @@ describe('Pinboard/viz embed tests', () => {
             ...defaultViewConfig,
             pinboardId,
             vizId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -169,7 +169,7 @@ describe('Pinboard/viz embed tests', () => {
                     values: [1000],
                 },
             ],
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
@@ -184,7 +184,7 @@ describe('Pinboard/viz embed tests', () => {
             fullHeight: true,
             pinboardId,
             vizId,
-        } as PinboardViewConfig);
+        } as LiveboardViewConfig);
 
         const onSpy = jest.spyOn(pinboardEmbed, 'on');
         pinboardEmbed.render();

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

@@ -5,8 +5,9 @@ import {
     EmbedEvent,
     SearchEmbed,
     PinboardEmbed,
-    PinboardViewConfig,
+    LiveboardViewConfig,
     AppEmbed,
+    LiveboardEmbed,
 } from '../index';
 import { Action } from '../types';
 import { getDocumentBody, getIFrameSrc, getRootEl } from '../test/test-utils';
@@ -24,6 +25,7 @@ const defaultViewConfig = {
     },
 };
 const pinboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
+const liveboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const thoughtSpotHost = 'tshost';
 const defaultParamsForPinboardEmbed = `hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
 
@@ -119,29 +121,78 @@ describe('Unit test case for ts embed', () => {
     });
 
     describe('when visible actions are set', () => {
-        test('should throw error when there are both visible and hidden actions', async () => {
+        test('should throw error when there are both visible and hidden actions - pinboard', async () => {
             spyOn(console, 'log');
             const pinboardEmbed = new PinboardEmbed(getRootEl(), {
                 hiddenActions: [Action.DownloadAsCsv],
                 visibleActions: [Action.DownloadAsCsv],
                 ...defaultViewConfig,
                 pinboardId,
-            } as PinboardViewConfig);
+            } as LiveboardViewConfig);
             await pinboardEmbed.render();
             expect(pinboardEmbed['isError']).toBe(true);
             expect(console.log).toHaveBeenCalledWith(
                 'You cannot have both hidden actions and visible actions',
             );
         });
-        test('should not throw error when there are only visible or hidden actions', async () => {
+        test('should not throw error when there are only visible or hidden actions - pinboard', async () => {
             const pinboardEmbed = new PinboardEmbed(getRootEl(), {
                 hiddenActions: [Action.DownloadAsCsv],
                 ...defaultViewConfig,
                 pinboardId,
-            } as PinboardViewConfig);
+            } as LiveboardViewConfig);
             pinboardEmbed.render();
             expect(pinboardEmbed['isError']).toBe(false);
         });
+
+        async function testActionsForLiveboards(
+            hiddenActions: Array<Action>,
+            visibleActions: Array<Action>,
+        ) {
+            spyOn(console, 'log');
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                hiddenActions,
+                visibleActions,
+                ...defaultViewConfig,
+                liveboardId,
+            } as LiveboardViewConfig);
+            await liveboardEmbed.render();
+            expect(liveboardEmbed['isError']).toBe(true);
+            expect(console.log).toHaveBeenCalledWith(
+                'You cannot have both hidden actions and visible actions',
+            );
+        }
+        test('should throw error when there are both visible and hidden action arrays', async () => {
+            await testActionsForLiveboards(
+                [Action.DownloadAsCsv],
+                [Action.DownloadAsCsv],
+            );
+        });
+        test('should throw error when there are both visible and hidden actions arrays as empty', async () => {
+            await testActionsForLiveboards([], []);
+        });
+        test('should throw error when there are both visible and hidden actions - one of them is an empty array', async () => {
+            await testActionsForLiveboards([], [Action.DownloadAsCsv]);
+        });
+
+        test('should not throw error when there are only visible or hidden actions', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                hiddenActions: [Action.DownloadAsCsv],
+                ...defaultViewConfig,
+                liveboardId,
+            } as LiveboardViewConfig);
+            liveboardEmbed.render();
+            expect(liveboardEmbed['isError']).toBe(false);
+        });
+        test('should not throw error when there are only visible or hidden actions', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                visibleActions: [Action.DownloadAsCsv],
+                ...defaultViewConfig,
+                liveboardId,
+            } as LiveboardViewConfig);
+            liveboardEmbed.render();
+            expect(liveboardEmbed['isError']).toBe(false);
+        });
     });
 
     describe('when thoughtSpotHost is empty', () => {
@@ -180,7 +231,7 @@ describe('Unit test case for ts embed', () => {
     });
 
     describe('Naviage to Page API', () => {
-        const path = 'pinboard/e0836cad-4fdf-42d4-bd97-567a6b2a6058';
+        const path = 'viz/e0836cad-4fdf-42d4-bd97-567a6b2a6058';
         beforeEach(() => {
             jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
                 () => 'http://tshost',
@@ -189,10 +240,10 @@ describe('Unit test case for ts embed', () => {
 
         test('when app is PinboardEmbed after navigateToPage function call, new path should be set to iframe', async () => {
             const pinboardEmbed = new PinboardEmbed(getRootEl(), {
-                pinboardId: '123',
+                pinboardId: 'e0836cad-4fdf-42d4-bd97-567a6b2a6058',
             });
             await pinboardEmbed.render();
-            pinboardEmbed.navigateToPage(path);
+            // pinboardEmbed.navigateToPage(path);
             expect(getIFrameSrc()).toBe(
                 `http://${thoughtSpotHost}/?embedApp=true&${defaultParamsForPinboardEmbed}&isLiveboardEmbed=true#/embed/${path}`,
             );
@@ -227,4 +278,26 @@ describe('Unit test case for ts embed', () => {
             );
         });
     });
+    describe('Naviage to Page API - Pinboard', () => {
+        const path = 'pinboard/e0836cad-4fdf-42d4-bd97-567a6b2a6058';
+        beforeEach(() => {
+            jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
+                () => 'http://tshost',
+            );
+        });
+
+        test('when app is AppEmbed after navigateToPage function call, new path should be set to iframe', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+            });
+            await appEmbed.render();
+            appEmbed.navigateToPage(path);
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}#/${path}`,
+            );
+        });
+    });
 });