@thoughtspot/visual-embed-sdk 1.13.0-alpha.4 → 1.14.0

package/src/auth.spec.ts

@@ -240,6 +240,45 @@ describe('Unit test for auth', () => {
         expect(isLoggedIn).toBe(false);
     });
 
+    test('doTokenAuth: when user is not loggedIn & fetchAuthPostService failed than fetchAuthService should call', async () => {
+        jest.spyOn(window, 'alert').mockImplementation(() => undefined);
+        jest.spyOn(authService, 'fetchSessionInfoService').mockImplementation(
+            () => false,
+        );
+        jest.spyOn(
+            authService,
+            'fetchAuthTokenService',
+        ).mockImplementation(() => ({ text: () => Promise.resolve('abc') }));
+        jest.spyOn(authService, 'fetchAuthPostService').mockImplementation(() =>
+            // eslint-disable-next-line prefer-promise-reject-errors
+            Promise.reject({
+                status: 500,
+            }),
+        );
+        jest.spyOn(authService, 'fetchAuthService').mockImplementation(() =>
+            Promise.resolve({
+                status: 200,
+                type: 'opaqueredirect',
+            }),
+        );
+        expect(
+            await authInstance.doTokenAuth(
+                embedConfig.doTokenAuthSuccess('authToken2'),
+            ),
+        ).toBe(true);
+        expect(authService.fetchSessionInfoService).toBeCalled();
+        expect(authService.fetchAuthPostService).toBeCalledWith(
+            thoughtSpotHost,
+            username,
+            'authToken2',
+        );
+        expect(authService.fetchAuthService).toBeCalledWith(
+            thoughtSpotHost,
+            username,
+            'authToken2',
+        );
+    });
+
     describe('doBasicAuth', () => {
         beforeEach(() => {
             global.fetch = window.fetch;

package/src/auth.ts

@@ -8,6 +8,7 @@ import {
     fetchAuthService,
     fetchBasicAuthService,
     fetchLogoutService,
+    fetchAuthPostService,
 } from './utils/authService';
 
 // eslint-disable-next-line import/no-mutable-exports
@@ -157,11 +158,16 @@ export const doTokenAuth = async (
             const response = await fetchAuthTokenService(authEndpoint);
             authToken = await response.text();
         }
-        const resp = await fetchAuthService(
-            thoughtSpotHost,
-            username,
-            authToken,
-        );
+        let resp;
+        try {
+            resp = await fetchAuthPostService(
+                thoughtSpotHost,
+                username,
+                authToken,
+            );
+        } catch (e) {
+            resp = await fetchAuthService(thoughtSpotHost, username, authToken);
+        }
         // token login issues a 302 when successful
         loggedInStatus = resp.ok || resp.type === 'opaqueredirect';
         if (loggedInStatus && embedConfig.detectCookieAccessSlow) {

package/src/embed/app.ts

@@ -87,13 +87,13 @@ export interface AppViewConfig extends ViewConfig {
      * Render liveboards using the new v2 rendering mode
      * This is a transient flag which is primarily meant for internal use
      * @default false
-     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      * @hidden
      */
     liveboardV2?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
-     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
      */
     enableSearchAssist?: boolean;
 }
@@ -203,7 +203,8 @@ export class AppEmbed extends V1Embed {
      * @param path string | number The string, set to iframe src and navigate to new page
      * eg: appEmbed.navigateToPage('pinboards')
      * When used with `noReload` this can also be a number like 1/-1 to go forward/back.
-     * @param noReload boolean Trigger the navigation without reloading the page (version: 1.12.0 | 8.4.0.cl)
+     * @param noReload boolean Trigger the navigation without reloading the page
+     * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
      */
     public navigateToPage(path: string | number, noReload = false): void {
         if (!this.iFrame) {

package/src/embed/base.ts

@@ -146,7 +146,7 @@ export function disableAutoLogin(): void {
  *
  * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
  * @returns Promise which resolves when logout completes.
- * @version SDK: 1.10.1 | ThoughtSpot: *
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
  */
 export const logout = (doNotDisableAutoLogin = false): Promise<boolean> => {
     if (!doNotDisableAutoLogin) {

package/src/embed/liveboard.spec.ts

@@ -23,6 +23,7 @@ const defaultViewConfig = {
     },
 };
 const liveboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
+const activeTabId = '502693ba-9818-4e71-8ecd-d1a194e46861';
 const vizId = '6e73f724-660e-11eb-ae93-0242ac130002';
 const thoughtSpotHost = 'tshost';
 const defaultParamsSansHideAction = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
@@ -234,4 +235,18 @@ describe('Liveboard/viz embed tests', () => {
         const result = await liveboardEmbed.trigger(HostEvent.Pin);
         expect(mockProcessTrigger).toBeCalled();
     });
+
+    test('should render active tab when activeTab present', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            liveboardId,
+            activeTabId,
+            liveboardV2: true,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardEmbed=true&isPinboardV2Enabled=true#/embed/viz/${liveboardId}/tab/${activeTabId}`,
+            );
+        });
+    });
 });

package/src/embed/liveboard.ts

@@ -35,7 +35,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      * 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.
-     * @version 1.5.0 or later
+     * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @default 500
      */
     defaultHeight?: number;
@@ -49,7 +49,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     liveboardId?: string;
     /**
-     * To support backward compatibilty
+     * To support backward compatibility
      * @hidden
      */
     pinboardId?: string;
@@ -66,7 +66,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      * Array of viz ids which should be visible when the liveboard
      * first renders. This can be changed by triggering the "SetVisibleVizs"
      * event.
-     * @version 1.9.1 or later
+     * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     visibleVizs?: string[];
     /**
@@ -75,13 +75,16 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     preventPinboardFilterRemoval?: boolean;
     /**
-     * Render embedded liveboards and visualizations using the new v2 rendering mode
-     * This is a transient flag which is primarily meant for internal use
+     * Render embedded Liveboards and visualizations in the new Liveboard experience mode
      * @default false
-     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
-     * @hidden
+     * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
      */
     liveboardV2?: boolean;
+    /**
+     * Tab Id of the Liveboard that is supposed to be active
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    activeTabId?: string;
 }
 
 /**
@@ -111,6 +114,7 @@ export class LiveboardEmbed extends V1Embed {
             visibleVizs,
             liveboardV2 = false,
             vizId,
+            activeTabId,
         } = this.viewConfig;
 
         const preventLiveboardFilterRemoval =
@@ -156,6 +160,7 @@ export class LiveboardEmbed extends V1Embed {
         liveboardId: string,
         vizId?: string,
         runtimeFilters?: RuntimeFilter[],
+        activeTabId?: string,
     ) {
         const filterQuery = getFilterQuery(runtimeFilters || []);
         const queryParams = this.getEmbedParams();
@@ -168,6 +173,9 @@ export class LiveboardEmbed extends V1Embed {
             false,
             false,
         )}/viz/${liveboardId}`;
+        if (activeTabId) {
+            url = `${url}/tab/${activeTabId}`;
+        }
         if (vizId) {
             url = `${url}/${vizId}`;
         }
@@ -217,7 +225,7 @@ export class LiveboardEmbed extends V1Embed {
      * visualization ID and the runtime filters.
      */
     public render(): LiveboardEmbed {
-        const { vizId, runtimeFilters } = this.viewConfig;
+        const { vizId, activeTabId, runtimeFilters } = this.viewConfig;
         const liveboardId =
             this.viewConfig.liveboardId ?? this.viewConfig.pinboardId;
 
@@ -236,7 +244,12 @@ export class LiveboardEmbed extends V1Embed {
 
         super.render();
 
-        const src = this.getIFrameSrc(liveboardId, vizId, runtimeFilters);
+        const src = this.getIFrameSrc(
+            liveboardId,
+            vizId,
+            runtimeFilters,
+            activeTabId,
+        );
         this.renderV1Embed(src);
 
         return this;

package/src/embed/search.ts

@@ -52,9 +52,13 @@ 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.
-     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
      */
     enableSearchAssist?: boolean;
     /**
@@ -130,6 +134,7 @@ export class SearchEmbed extends TsEmbed {
     private getIFrameSrc(answerId: string, dataSources?: string[]) {
         const {
             hideResults,
+            expandAllDataSource,
             enableSearchAssist,
             forceTable,
             searchOptions,

package/src/embed/ts-embed.ts

@@ -118,12 +118,12 @@ export interface ViewConfig {
     /**
      * The list of actions to display from the primary menu, more menu
      * (...), and the contextual menu.
-     * @version 1.6.0 or later
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     visibleActions?: Action[];
     /**
      * Show alert messages and toast messages in the embedded view.
-     * @version 1.11.0 | ThoughtSpot: 8.3.0.cl
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     showAlerts?: boolean;
     /**
@@ -133,7 +133,7 @@ export interface ViewConfig {
     runtimeFilters?: RuntimeFilter[];
     /**
      * The locale/language to use for the embedded view.
-     * @version 1.9.4 or later
+     * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
      */
     locale?: string;
     /**
@@ -143,7 +143,7 @@ export interface ViewConfig {
      * Warning: This option is for advanced use only and is used internally
      * to control embed behavior in non-regular ways. We do not publish the
      * list of supported keys and values associated with each.
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     additionalFlags?: { [key: string]: string | number | boolean };
 }