@thoughtspot/visual-embed-sdk 1.6.0-alpha.2 → 1.6.2

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/liveboard.ts

@@ -1,7 +1,7 @@
 /**
  * Copyright (c) 2021
  *
- * Embed a ThoughtSpot liveboard 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
  *
@@ -22,21 +22,21 @@ import { getFilterQuery, getQueryParamString } from '../utils';
 import { V1Embed, ViewConfig } from './ts-embed';
 
 /**
- * The configuration for the embedded liveboard or visualization page view.
+ * The configuration for the embedded Liveboard or visualization page view.
  * @Category Liveboards and Charts
  */
 export interface LiveboardViewConfig extends ViewConfig {
     /**
      * If set to true, the embedded object container dynamically resizes
-     * according to the height of the liveboard.
+     * according to the height of the Liveboard.
      */
     fullHeight?: boolean;
     /**
-     * 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.
+     * 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,7 +44,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     enableVizTransformations?: boolean;
     /**
-     * The liveboard 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.
      */
     liveboardId?: string;
@@ -54,12 +54,12 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     pinboardId?: string;
     /**
-     * The visualization within the liveboard to display.
+     * The visualization within the Liveboard to display.
      */
     vizId?: string;
     /**
      * If set to true, all filter chips from a
-     * liveboard page will be read-only (no X buttons)
+     * Liveboard page will be read-only (no X buttons)
      */
     preventLiveboardFilterRemoval?: boolean;
     /**
@@ -70,7 +70,7 @@ export interface LiveboardViewConfig extends ViewConfig {
 }
 
 /**
- * Embed a ThoughtSpot liveboard or visualization
+ * Embed a ThoughtSpot Liveboard or visualization
  * @Category Liveboards and Charts
  */
 export class LiveboardEmbed extends V1Embed {
@@ -85,7 +85,7 @@ export class LiveboardEmbed extends V1Embed {
 
     /**
      * Construct a map of params to be passed on to the
-     * embedded liveboard or visualization.
+     * embedded Liveboard or visualization.
      */
     private getEmbedParams() {
         const params = this.getBaseQueryParams();
@@ -120,12 +120,12 @@ export class LiveboardEmbed extends V1Embed {
     }
 
     /**
-     * Construct the URL of the embedded ThoughtSpot liveboard or visualization
+     * Construct the URL of the embedded ThoughtSpot Liveboard or visualization
      * to be loaded within the iframe.
-     * @param liveboardId The GUID of the liveboard.
-     * @param vizId The optional GUID of a visualization within the liveboard.
+     * @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 liveboard or visualization on load.
+     * the Liveboard or visualization on load.
      */
     private getIFrameSrc(
         liveboardId: string,
@@ -164,18 +164,15 @@ export class LiveboardEmbed extends V1Embed {
         responder({ type: EmbedEvent.EmbedIframeCenter, data: obj });
     };
 
-    private handleRouteChangeFullHeightLiveboard = (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 liveboard or visualization
-     * @param renderOptions An object specifying the liveboard ID,
+     * Render an embedded ThoughtSpot Liveboard or visualization
+     * @param renderOptions An object specifying the Liveboard ID,
      * visualization ID and the runtime filters.
      */
     public render(): LiveboardEmbed {
@@ -190,7 +187,7 @@ export class LiveboardEmbed extends V1Embed {
         if (this.viewConfig.fullHeight === true) {
             this.on(
                 EmbedEvent.RouteChange,
-                this.handleRouteChangeFullHeightLiveboard,
+                this.setIframeHeightForNonEmbedLiveboard,
             );
             this.on(EmbedEvent.EmbedHeight, this.updateIFrameHeight);
             this.on(EmbedEvent.EmbedIframeCenter, this.embedIframeCenter);

package/src/embed/search.ts

@@ -49,6 +49,10 @@ export interface SearchViewConfig extends ViewConfig {
      * using raw answer data.
      */
     hideResults?: boolean;
+    /**
+     * If set to true, expands all the data sources panel.
+     */
+    expandAllDataSource?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
      */
@@ -118,6 +122,7 @@ export class SearchEmbed extends TsEmbed {
     private getIFrameSrc(answerId: string, dataSources?: string[]) {
         const {
             hideResults,
+            expandAllDataSource,
             enableSearchAssist,
             forceTable,
             searchOptions,

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

@@ -7,6 +7,7 @@ import {
     PinboardEmbed,
     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,7 +121,7 @@ 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],
@@ -133,7 +135,7 @@ describe('Unit test case for ts embed', () => {
                 '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,
@@ -142,6 +144,55 @@ describe('Unit test case for ts embed', () => {
             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}`,
+            );
+        });
+    });
 });

package/src/embed/ts-embed.ts

@@ -32,9 +32,11 @@ import {
 import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 import { getProcessData } from '../utils/processData';
 import { processTrigger } from '../utils/processTrigger';
-import { version } from '../../package.json';
+import pkgInfo from '../../package.json';
 import { getAuthPromise, getEmbedConfig, renderInQueue } from './base';
 
+const { version } = pkgInfo;
+
 /**
  * The event id map from v2 event names to v1 event id
  * v1 events are the classic embed events implemented in Blink v1
@@ -105,7 +107,7 @@ export interface ViewConfig {
     visibleActions?: Action[];
     /**
      * The list of runtime filters to apply to a search answer,
-     * visualization, or liveboard.
+     * visualization, or Liveboard.
      */
     runtimeFilters?: RuntimeFilter[];
 }
@@ -327,7 +329,7 @@ export class TsEmbed {
             visibleActions,
         } = this.viewConfig;
 
-        if (visibleActions?.length && hiddenActions?.length) {
+        if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
             this.handleError(
                 'You cannot have both hidden actions and visible actions',
             );
@@ -351,7 +353,7 @@ export class TsEmbed {
 
     /**
      * Constructs the base URL string to load v1 of the ThoughtSpot app.
-     * This is used for embedding liveboards, visualizations, and full application.
+     * This is used for embedding Liveboards, visualizations, and full application.
      * @param queryString The query string to append to the URL.
      * @param isAppEmbed A Boolean parameter to specify if you are embedding
      * the full application.
@@ -587,27 +589,6 @@ export class TsEmbed {
         return this;
     }
 
-    /**
-     * Navigates users to the specified application page.
-     * Use this method to navigate users from the embedded
-     * ThoughtSpot context to a specific page in your app.
-     * @param path The page path string.
-     * For example, to navigate users to a liveboard page,
-     * define the method as navigateToPage('liveboard/<liveboardId>').
-     */
-    public navigateToPage(path: string): void {
-        const iframeSrc = this.iFrame?.src;
-        if (iframeSrc) {
-            const embedPath = '#/embed';
-            const currentPath = iframeSrc.includes(embedPath) ? embedPath : '#';
-            this.iFrame.src = `${
-                iframeSrc.split(currentPath)[0]
-            }${currentPath}/${path.replace(/^\/?#?\//, '')}`;
-        } else {
-            console.log('Please call render before invoking this method');
-        }
-    }
-
     /**
      * Triggers an event on specific Port registered against
      * for the EmbedEvent