@thoughtspot/visual-embed-sdk 1.44.1 → 1.44.2

package/src/embed/app.ts

@@ -9,7 +9,7 @@
  */
 
 import { logger } from '../utils/logger';
-import { calculateVisibleElementData, getQueryParamString, isUndefined } from '../utils';
+import { calculateVisibleElementData, getQueryParamString, isUndefined, isValidCssMargin } from '../utils';
 import {
     Param,
     DOMSelector,
@@ -626,6 +626,23 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     updatedSpotterChatPrompt?: boolean;
+    /**
+     * This is the minimum height (in pixels) for a full-height App.
+     * Setting this height helps resolve issues with empty Apps and
+     * other screens navigable from an App.
+     *
+     * @version SDK: 1.44.2 | ThoughtSpot: 26.0.2.cl
+     * @default 500
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed', {
+     *   ... // other app view config
+     *   fullHeight: true,
+     *   minimumHeight: 600,
+     * });
+     * ```
+     */
+    minimumHeight?: number;
 }
 
 /**
@@ -635,7 +652,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 export class AppEmbed extends V1Embed {
     protected viewConfig: AppViewConfig;
 
-    private defaultHeight = '100%';
+    private defaultHeight = 500;
 
 
     constructor(domSelector: DOMSelector, viewConfig: AppViewConfig) {
@@ -672,6 +689,8 @@ export class AppEmbed extends V1Embed {
             hideLiveboardHeader = false,
             showLiveboardTitle = true,
             showLiveboardDescription = true,
+            showMaskedFilterChip = false,
+            isLiveboardMasterpiecesEnabled = false,
             hideHomepageLeftNav = false,
             modularHomeExperience = false,
             isLiveboardHeaderSticky = true,
@@ -697,6 +716,7 @@ export class AppEmbed extends V1Embed {
             isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
             updatedSpotterChatPrompt,
+            minimumHeight,
         } = this.viewConfig;
 
         let params: any = {};
@@ -707,6 +727,8 @@ export class AppEmbed extends V1Embed {
         params[Param.HideLiveboardHeader] = hideLiveboardHeader;
         params[Param.ShowLiveboardTitle] = showLiveboardTitle;
         params[Param.ShowLiveboardDescription] = !!showLiveboardDescription;
+        params[Param.ShowMaskedFilterChip] = showMaskedFilterChip;
+        params[Param.IsLiveboardMasterpiecesEnabled] = isLiveboardMasterpiecesEnabled;
         params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
         params[Param.IsFullAppEmbed] = true;
         params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
@@ -739,7 +761,9 @@ export class AppEmbed extends V1Embed {
             params[Param.fullHeight] = true;
             if (this.viewConfig.lazyLoadingForFullHeight) {
                 params[Param.IsLazyLoadingForEmbedEnabled] = true;
-                params[Param.RootMarginForLazyLoad] = this.viewConfig.lazyLoadingMargin;
+                if (isValidCssMargin(this.viewConfig.lazyLoadingMargin)) {
+                    params[Param.RootMarginForLazyLoad] = this.viewConfig.lazyLoadingMargin;
+                }
             }
         }
 
@@ -799,6 +823,8 @@ export class AppEmbed extends V1Embed {
             ] = isCentralizedLiveboardFilterUXEnabled;
         }
 
+        this.defaultHeight = minimumHeight || this.defaultHeight;
+
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
         params[Param.ModularHomeExperienceEnabled] = modularHomeExperience;
@@ -900,7 +926,7 @@ export class AppEmbed extends V1Embed {
      * @param data The event payload
      */
     protected updateIFrameHeight = (data: MessagePayload) => {
-        this.setIFrameHeight(Math.max(data.data, this.iFrame?.scrollHeight));
+        this.setIFrameHeight(Math.max(data.data, this.defaultHeight));
         this.sendFullHeightLazyLoadData();
     };
 

package/src/embed/base.spec.ts

@@ -32,14 +32,14 @@ describe('Base TS Embed', () => {
             thoughtSpotHost,
             authType: index.AuthType.None,
         }) as EventEmitter;
-        jest.spyOn(auth, 'postLoginService').mockImplementation(() => Promise.resolve({}));
+        jest.spyOn(auth, 'postLoginService').mockImplementation(() => Promise.resolve(undefined));
     });
 
     beforeEach(() => {
         document.body.innerHTML = getDocumentBody();
     });
 
-    test('Should show an alert when third party cookie access is blocked', (done) => {
+    test('Should show an alert when third party cookie access is blocked', () => {
         const tsEmbed = new index.SearchEmbed(getRootEl(), {});
         const iFrame: any = document.createElement('div');
         iFrame.contentWindow = null;
@@ -59,18 +59,17 @@ describe('Base TS Embed', () => {
         jest.spyOn(window, 'alert').mockImplementation(() => undefined);
         authEE.on(auth.AuthStatus.FAILURE, (reason) => {
             expect(reason).toEqual(auth.AuthFailureType.NO_COOKIE_ACCESS);
-            expect(window.alert).toBeCalledWith(
+            expect(window.alert).toHaveBeenCalledWith(
                 'Third-party cookie access is blocked on this browser. Please allow third-party cookies for this to work properly. \nYou can use `suppressNoCookieAccessAlert` to suppress this message.',
             );
-            done();
         });
     });
 
-    test('Should ignore cookie blocked alert if ignoreNoCookieAccess is true', async (done) => {
+    test('Should ignore cookie blocked alert if ignoreNoCookieAccess is true', async () => {
         jest.spyOn(window, 'fetch').mockResolvedValue({
             ok: true,
             json: jest.fn().mockResolvedValue({}),
-        });
+        } as any);
         const authEE = index.init({
             thoughtSpotHost,
             authType: index.AuthType.None,
@@ -96,7 +95,6 @@ describe('Base TS Embed', () => {
         authEE.on(auth.AuthStatus.FAILURE, (reason) => {
             expect(reason).toEqual(auth.AuthFailureType.NO_COOKIE_ACCESS);
             expect(window.alert).not.toHaveBeenCalled();
-            done();
         });
     });
 
@@ -104,7 +102,7 @@ describe('Base TS Embed', () => {
         jest.spyOn(window, 'fetch').mockResolvedValue({
             ok: true,
             json: jest.fn().mockResolvedValue({}),
-        });
+        } as any);
         index.init({
             thoughtSpotHost,
             authType: index.AuthType.None,
@@ -161,7 +159,7 @@ describe('Base TS Embed', () => {
         jest.spyOn(tokenizedFetchInstance, 'tokenizedFetch').mockResolvedValueOnce({
             ok: true,
             json: jest.fn().mockResolvedValue({}),
-        });
+        } as any);
         index.init({
             thoughtSpotHost,
             authType: index.AuthType.TrustedAuthTokenCookieless,
@@ -229,7 +227,7 @@ describe('Base TS Embed', () => {
         jest.spyOn(tokenizedFetchInstance, 'tokenizedFetch').mockResolvedValueOnce({
             ok: true,
             json: jest.fn().mockResolvedValue({}),
-        });
+        } as any);
         index.init({
             thoughtSpotHost,
             authType: index.AuthType.None,
@@ -388,7 +386,7 @@ describe('Base TS Embed', () => {
         });
     });
 
-    test('handleAuth notifies for SDK auth failure', (done) => {
+    test('handleAuth notifies for SDK auth failure', () => {
         jest.spyOn(auth, 'authenticate').mockResolvedValue(false);
         const authEmitter = index.init({
             thoughtSpotHost,
@@ -398,11 +396,10 @@ describe('Base TS Embed', () => {
         });
         authEmitter.on(auth.AuthStatus.FAILURE, (reason) => {
             expect(reason).toBe(auth.AuthFailureType.SDK);
-            done();
         });
     });
 
-    test('handleAuth notifies for SDK auth success', (done) => {
+    test('handleAuth notifies for SDK auth success', () => {
         jest.spyOn(auth, 'authenticate').mockResolvedValue(true);
         const failureCallback = jest.fn();
         const authEmitter = index.init({
@@ -414,16 +411,15 @@ describe('Base TS Embed', () => {
 
         authEmitter.on(auth.AuthStatus.FAILURE, failureCallback);
         authEmitter.on(auth.AuthStatus.SDK_SUCCESS, (...args) => {
-            expect(failureCallback).not.toBeCalled();
+            expect(failureCallback).not.toHaveBeenCalled();
             expect(args.length).toBe(0);
-            done();
         });
     });
 
     test('Logout method should disable autoLogin', () => {
         jest.spyOn(window, 'fetch').mockResolvedValueOnce({
             type: 'opaque',
-        });
+        } as any);
         index.init({
             thoughtSpotHost,
             authType: index.AuthType.None,
@@ -461,7 +457,7 @@ describe('Base TS Embed', () => {
             index.init({
                 authType: index.AuthType.None,
             } as EmbedConfig);
-        }).toThrowError();
+        }).toThrow();
     });
 
     test('config sanity, no username in trusted auth', () => {
@@ -470,7 +466,7 @@ describe('Base TS Embed', () => {
                 authType: index.AuthType.TrustedAuthToken,
                 thoughtSpotHost,
             } as EmbedConfig);
-        }).toThrowError();
+        }).toThrow();
     });
 
     test('config sanity, no authEndpoint and getAuthToken', () => {
@@ -480,7 +476,7 @@ describe('Base TS Embed', () => {
                 thoughtSpotHost,
                 username: 'test',
             });
-        }).toThrowError();
+        }).toThrow();
     });
     test('config backward compat, should assign inPopup when noRedirect is set', () => {
         index.init({
@@ -532,6 +528,6 @@ describe('Init tests', () => {
             thoughtSpotHost,
             authType: index.AuthType.None,
         });
-        expect(resetService.resetAllCachedServices).toBeCalled();
+        expect(resetService.resetAllCachedServices).toHaveBeenCalled();
     });
 });

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

@@ -22,8 +22,8 @@ describe('SpotterAgentEmbed', () => {
             thoughtSpotHost,
             authType: AuthType.None,
         });
-        jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve({}));
-        spyOn(window, 'alert');
+        jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve(undefined));
+        jest.spyOn(window, 'alert').mockImplementation(() => undefined);
         document.body.innerHTML = getDocumentBody();
     });
 

package/src/embed/conversation.spec.ts

@@ -2,7 +2,7 @@ import { SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed } from './conve
 import { TsEmbed } from './ts-embed';
 import * as authInstance from '../auth';
 import { Action, init } from '../index';
-import { AuthType, Param, RuntimeFilterOp } from '../types';
+import { AuthType, Param, RuntimeFilterOp, ErrorDetailsTypes, EmbedErrorCodes  } from '../types';
 import {
     getDocumentBody,
     getIFrameSrc,
@@ -19,8 +19,8 @@ beforeAll(() => {
         thoughtSpotHost,
         authType: AuthType.None,
     });
-    jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve({}));
-    spyOn(window, 'alert');
+    jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve(undefined));
+    jest.spyOn(window, 'alert');
     document.body.innerHTML = getDocumentBody();
 });
 
@@ -120,7 +120,12 @@ describe('ConversationEmbed', () => {
         (conversationEmbed as any).handleError = jest.fn();
         await conversationEmbed.render();
         expect((conversationEmbed as any).handleError).toHaveBeenCalledWith(
-            ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND,
+            {
+                errorType: ErrorDetailsTypes.VALIDATION_ERROR,
+                message: ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND,
+                code: EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND,
+                error: ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND,
+            },
         );
     });
 

package/src/embed/conversation.ts

@@ -1,6 +1,6 @@
 import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
-import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter } from '../types';
+import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter, ErrorDetailsTypes, EmbedErrorCodes } from '../types';
 import { TsEmbed } from './ts-embed';
 import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils';
 
@@ -246,7 +246,12 @@ export class SpotterEmbed extends TsEmbed {
         } = this.viewConfig;
 
         if (!worksheetId) {
-            this.handleError(ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND);
+            this.handleError({
+                errorType: ErrorDetailsTypes.VALIDATION_ERROR,
+                message: ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND,
+                code: EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND,
+                error: ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND,
+            });
         }
         const queryParams = this.getBaseQueryParams();
         queryParams[Param.SpotterEnabled] = true;

package/src/embed/embed.spec.ts

@@ -1,13 +1,18 @@
 import { logger } from '../utils/logger';
 import {
     init, AuthType, SearchEmbed, EmbedEvent,
+    RuntimeFilterOp,
+    Action,
 } from '../index';
 import {
     EVENT_WAIT_TIME,
     executeAfterWait,
+    expectUrlToHaveParamsWithValues,
     getDocumentBody,
     getIFrameEl,
+    getIFrameSrc,
     getRootEl,
+    postMessageToParent,
 } from '../test/test-utils';
 import * as authInstance from '../auth';
 
@@ -24,8 +29,8 @@ beforeAll(() => {
         thoughtSpotHost,
         authType: AuthType.None,
     });
-    spyOn(window, 'alert');
-    jest.spyOn(authInstance, 'postLoginService').mockResolvedValue(true);
+    jest.spyOn(window, 'alert');
+    jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve(undefined));
 });
 
 describe('test view config', () => {
@@ -52,4 +57,119 @@ describe('test view config', () => {
             expect(iframe.style.height).toBe(`${height}px`);
         });
     });
+    
+    test('should pass hideResults parameter when configured', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            hideResults: true,
+        });
+        searchEmbed.render();
+
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+            expectUrlToHaveParamsWithValues(iframeSrc, {
+                hideResult: true,
+            });
+        });
+    });
+
+    test('should pass forceTable parameter when configured', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            forceTable: true,
+        });
+        searchEmbed.render();
+
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+            expectUrlToHaveParamsWithValues(iframeSrc, {
+                forceTable: true,
+            });
+        });
+    });
+
+    test('should pass enableSearchAssist parameter when configured', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            enableSearchAssist: true,
+        });
+        searchEmbed.render();
+
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+            expectUrlToHaveParamsWithValues(iframeSrc, {
+                enableSearchAssist: true,
+            });
+        });
+    });
+
+    test('should pass hideSearchBar parameter when configured', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            hideSearchBar: true,
+        });
+        searchEmbed.render();
+
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+            expectUrlToHaveParamsWithValues(iframeSrc, {
+                hideSearchBar: true,
+            });
+        });
+    });
+
+    test('should register and trigger event listeners', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+        const mockCallback = jest.fn();
+
+        searchEmbed.on(EmbedEvent.Load, mockCallback);
+        await searchEmbed.render();
+
+        await executeAfterWait(() => {
+            const iframe = getIFrameEl();
+            postMessageToParent(iframe.contentWindow, {
+                type: EmbedEvent.Load,
+            });
+        });
+
+        await executeAfterWait(() => {
+            expect(mockCallback).toHaveBeenCalled();
+        }, EVENT_WAIT_TIME);
+    });
+
+    test('should pass disabledActions parameter when configured', async () => {
+        const disabledActions = [Action.Download, Action.Share];
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            disabledActions,
+        });
+        searchEmbed.render();
+
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+            expect(iframeSrc).toContain('disableAction');
+        });
+    });
+
+    test('should pass runtime filters when configured', async () => {
+        const runtimeFilters = [
+            {
+                columnName: 'revenue',
+                operator: RuntimeFilterOp.GT,
+                values: [1000],
+            },
+        ];
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            runtimeFilters,
+        });
+        searchEmbed.render();
+
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+            expect(iframeSrc).toContain('col1=revenue');
+            expect(iframeSrc).toContain('op1=GT');
+            expect(iframeSrc).toContain('val1=1000');
+        });
+    });
 });

package/src/embed/events.spec.ts

@@ -36,8 +36,8 @@ beforeAll(() => {
         thoughtSpotHost,
         authType: AuthType.None,
     });
-    spyOn(window, 'alert');
-    jest.spyOn(authInstance, 'postLoginService').mockReturnValue(true);
+    jest.spyOn(window, 'alert');
+    jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve(undefined));
 });
 
 describe('test communication between host app and ThoughtSpot', () => {

package/src/embed/hostEventClient/host-event-client.spec.ts

@@ -1,5 +1,5 @@
 import { getIFrameEl, getRootEl } from '../../test/test-utils';
-import { HostEvent } from '../../types';
+import { AuthType, HostEvent } from '../../types';
 import { processTrigger } from '../../utils/processTrigger';
 import * as EmbedConfigService from '../embedConfig';
 import {
@@ -23,7 +23,7 @@ const createHostEventClient = () => {
 describe('HostEventClient', () => {
     const mockThoughtSpotHost = 'http://localhost';
     beforeEach(() => {
-        jest.spyOn(EmbedConfigService, 'getEmbedConfig').mockReturnValue({ thoughtSpotHost: mockThoughtSpotHost });
+        jest.spyOn(EmbedConfigService, 'getEmbedConfig').mockReturnValue({ thoughtSpotHost: mockThoughtSpotHost, authType: AuthType.None } as any);
     });
 
     afterEach(() => {