@thoughtspot/visual-embed-sdk 1.22.0 → 1.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.22.0",
+    "version": "1.23.0",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

package/src/css-variables.ts

@@ -149,7 +149,7 @@ export interface CustomCssVariables {
      * Background color of the primary buttons. For example, the primary buttons such as
      * Pin* and *Save*.
      */
-    '---ts-var-button--primary-background'?: string;
+    '--ts-var-button--primary-background'?: string;
 
     /**
      * Background color of the primary buttons on hover.

package/src/embed/liveboard.spec.ts

@@ -302,6 +302,22 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('Should set hideTabPanel option', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            liveboardId,
+            activeTabId,
+            liveboardV2: true,
+            hideTabPanel: true,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&hideTabPanel=true&isLiveboardEmbed=true&isPinboardV2Enabled=true#/embed/viz/${liveboardId}/tab/${activeTabId}`,
+            );
+        });
+    });
+
     test('navigateToLiveboard should trigger the navigate event with the correct path', (done) => {
         mockMessageChannel();
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {

package/src/embed/liveboard.ts

@@ -99,6 +99,12 @@ export interface LiveboardViewConfig extends ViewConfig {
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     activeTabId?: string;
+    /**
+     * Hide tab Panel of embedded LB
+     *
+     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     */
+    hideTabPanel?: boolean;
 }
 
 /**
@@ -146,6 +152,7 @@ export class LiveboardEmbed extends V1Embed {
             visibleVizs,
             liveboardV2,
             vizId,
+            hideTabPanel,
             activeTabId,
         } = this.viewConfig;
 
@@ -174,6 +181,9 @@ export class LiveboardEmbed extends V1Embed {
         if (liveboardV2 !== undefined) {
             params[Param.LiveboardV2Enabled] = liveboardV2;
         }
+        if (hideTabPanel) {
+            params[Param.HideTabPanel] = hideTabPanel;
+        }
         const queryParams = getQueryParamString(params, true);
 
         return queryParams;

package/src/embed/sage.ts

@@ -51,6 +51,7 @@ export const HiddenActionItemByDefaultForSageEmbed = [
 /**
  * Embed ThoughtSpot LLM and GPT based natural language search component.
  *
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
  * @group Embed components
  */
 export class SageEmbed extends V1Embed {

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

@@ -36,6 +36,8 @@ const defaultViewConfig = {
 };
 const pinboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const liveboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
+const tabId1 = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
+const tabId2 = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const thoughtSpotHost = 'tshost';
 const defaultParamsPost = '';
 
@@ -582,6 +584,83 @@ describe('Unit test case for ts embed', () => {
         });
     });
 
+    describe('when visible Tabs are set', () => {
+        test('should throw error when there are both visible and hidden Tabs - pinboard', async () => {
+            spyOn(console, 'error');
+            const pinboardEmbed = new PinboardEmbed(getRootEl(), {
+                visibleTabs: [tabId1],
+                hiddenTabs: [tabId2],
+                ...defaultViewConfig,
+                pinboardId,
+            } as LiveboardViewConfig);
+            await pinboardEmbed.render();
+            expect(pinboardEmbed['isError']).toBe(true);
+            expect(console.error).toHaveBeenCalledWith(
+                'You cannot have both hidden Tabs and visible Tabs',
+            );
+        });
+        test('should not throw error when there are only visible or hidden Tabs - pinboard', async () => {
+            const pinboardEmbed = new PinboardEmbed(getRootEl(), {
+                hiddenTabs: [tabId1],
+                ...defaultViewConfig,
+                pinboardId,
+            } as LiveboardViewConfig);
+            pinboardEmbed.render();
+            expect(pinboardEmbed['isError']).toBe(false);
+        });
+
+        /**
+         *
+         * @param hiddenTabs
+         * @param visibleTabs
+         */
+        async function testTabsForLiveboards(
+            hiddenTabs: Array<string>,
+            visibleTabs: Array<string>,
+        ) {
+            spyOn(console, 'error');
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                hiddenTabs,
+                visibleTabs,
+                ...defaultViewConfig,
+                liveboardId,
+            } as LiveboardViewConfig);
+            await liveboardEmbed.render();
+            expect(liveboardEmbed['isError']).toBe(true);
+            expect(console.error).toHaveBeenCalledWith(
+                'You cannot have both hidden Tabs and visible Tabs',
+            );
+        }
+        test('should throw error when there are both visible and hidden Tab arrays', async () => {
+            await testTabsForLiveboards([tabId1], [tabId2]);
+        });
+        test('should throw error when there are both visible and hidden Tab arrays as empty', async () => {
+            await testTabsForLiveboards([], []);
+        });
+        test('should throw error when there are both visible and hidden Tabs - one of them is an empty array', async () => {
+            await testTabsForLiveboards([], [tabId2]);
+        });
+
+        test('should not throw error when there are only visible or hidden Tab', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                hiddenTabs: [tabId2],
+                ...defaultViewConfig,
+                liveboardId,
+            } as LiveboardViewConfig);
+            liveboardEmbed.render();
+            expect(liveboardEmbed['isError']).toBe(false);
+        });
+        test('should not throw error when there are only visible or hidden Tabs', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                visibleTabs: [tabId1],
+                ...defaultViewConfig,
+                liveboardId,
+            } as LiveboardViewConfig);
+            liveboardEmbed.render();
+            expect(liveboardEmbed['isError']).toBe(false);
+        });
+    });
+
     describe('when thoughtSpotHost is empty', () => {
         beforeAll(() => {
             jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(() => '');

package/src/embed/ts-embed.ts

@@ -358,6 +358,8 @@ export class TsEmbed {
             disabledActionReason,
             hiddenActions,
             visibleActions,
+            hiddenTabs,
+            visibleTabs,
             showAlerts,
             additionalFlags,
             locale,
@@ -365,6 +367,9 @@ export class TsEmbed {
             contextMenuTrigger,
             linkOverride,
             insertInToSlide,
+            hideLiveboardHeader,
+            showLiveboardDescription,
+            showLiveboardTitle,
         } = this.viewConfig;
 
         if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
@@ -372,6 +377,11 @@ export class TsEmbed {
             return queryParams;
         }
 
+        if (Array.isArray(visibleTabs) && Array.isArray(hiddenTabs)) {
+            this.handleError('You cannot have both hidden Tabs and visible Tabs');
+            return queryParams;
+        }
+
         // TODO remove embedConfig.customCssUrl
         const cssUrlParam = customizations?.style?.customCSSUrl || this.embedConfig.customCssUrl;
 
@@ -389,7 +399,12 @@ export class TsEmbed {
         if (Array.isArray(visibleActions)) {
             queryParams[Param.VisibleActions] = visibleActions;
         }
-
+        if (Array.isArray(hiddenTabs)) {
+            queryParams[Param.HiddenTabs] = hiddenTabs;
+        }
+        if (Array.isArray(visibleTabs)) {
+            queryParams[Param.VisibleTabs] = visibleTabs;
+        }
         /**
          * Default behavior for context menu will be left-click
          *  from version 9.2.0.cl the user have an option to override context
@@ -422,6 +437,16 @@ export class TsEmbed {
         if (insertInToSlide) {
             queryParams[Param.ShowInsertToSlide] = insertInToSlide;
         }
+        if (hideLiveboardHeader) {
+            queryParams[Param.HideLiveboardHeader] = hideLiveboardHeader;
+        }
+        if (showLiveboardDescription) {
+            queryParams[Param.ShowLiveboardDescription] = showLiveboardDescription;
+        }
+        if (showLiveboardTitle) {
+            queryParams[Param.ShowLiveboardTitle] = showLiveboardTitle;
+        }
+
         return queryParams;
     }