@thoughtspot/visual-embed-sdk 1.20.1 → 1.20.3

package/src/embed/app.spec.ts

@@ -1,6 +1,8 @@
 import { AppEmbed, AppViewConfig, Page } from './app';
 import { init } from '../index';
-import { Action, AuthType, HostEvent, RuntimeFilterOp } from '../types';
+import {
+    Action, AuthType, EmbedEvent, HostEvent, RuntimeFilterOp,
+} from '../types';
 import {
     executeAfterWait,
     getDocumentBody,
@@ -11,9 +13,11 @@ import {
     defaultParams,
     defaultParamsForPinboardEmbed,
     defaultParamsWithoutHiddenActions,
+    expectUrlMatchesWithParams,
 } from '../test/test-utils';
 import { version } from '../../package.json';
 import * as config from '../config';
+import { TsEmbed, V1Embed } from './ts-embed';
 
 const defaultViewConfig = {
     frameParams: {
@@ -44,7 +48,8 @@ describe('App embed tests', () => {
         const appEmbed = new AppEmbed(getRootEl(), defaultViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`,
             );
         });
@@ -57,7 +62,8 @@ describe('App embed tests', () => {
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`,
             );
         });
@@ -70,7 +76,8 @@ describe('App embed tests', () => {
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=true${defaultParams}${defaultParamsPost}#/home`,
             );
         });
@@ -101,7 +108,8 @@ describe('App embed tests', () => {
                 appEmbed.render();
 
                 await executeAfterWait(() => {
-                    expect(getIFrameSrc()).toBe(
+                    expectUrlMatchesWithParams(
+                        getIFrameSrc(),
                         `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/${route}`,
                     );
                     cleanUp();
@@ -117,7 +125,8 @@ describe('App embed tests', () => {
         } as AppViewConfig);
         appEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/foo/bar`,
             );
         });
@@ -138,7 +147,8 @@ describe('App embed tests', () => {
 
         appEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false&col1=sales&op1=EQ&val1=1000${defaultParams}${defaultParamsPost}#/home`,
             );
         });
@@ -155,7 +165,8 @@ describe('App embed tests', () => {
 
         appEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false&${defaultParamsWithoutHiddenActions}&disableAction=[%22save%22,%22update%22]&disableHint=Access%20denied&hideAction=[%22${Action.ReportError}%22,%22download%22]${defaultParamsPost}#/home`,
             );
         });
@@ -170,7 +181,8 @@ describe('App embed tests', () => {
 
         appEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}&tag=Finance${defaultParamsPost}#/home`,
             );
         });
@@ -184,18 +196,48 @@ describe('App embed tests', () => {
 
         appEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&enableSearchAssist=true${defaultParams}${defaultParamsPost}#/home`,
             );
         });
     });
 
+    test('should register event handlers to adjust iframe height', async () => {
+        const onSpy = jest.spyOn(AppEmbed.prototype, 'on')
+            .mockImplementation((event, callback) => {
+                if (event === EmbedEvent.RouteChange) {
+                    callback({ data: { currentPath: '/answers' } }, jest.fn());
+                }
+                if (event === EmbedEvent.EmbedHeight) {
+                    callback({ data: '100%' });
+                }
+                if (event === EmbedEvent.EmbedIframeCenter) {
+                    callback({}, jest.fn());
+                }
+                return null;
+            });
+        jest.spyOn(TsEmbed.prototype as any, 'getIframeCenter').mockReturnValue({});
+        jest.spyOn(TsEmbed.prototype as any, 'setIFrameHeight').mockReturnValue({});
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            fullHeight: true,
+        } as AppViewConfig);
+
+        appEmbed.render();
+
+        await executeAfterWait(() => {
+            expect(onSpy).toHaveBeenCalledWith(EmbedEvent.EmbedHeight, expect.anything());
+            expect(onSpy).toHaveBeenCalledWith(EmbedEvent.RouteChange, expect.anything());
+            expect(onSpy).toHaveBeenCalledWith(EmbedEvent.EmbedIframeCenter, expect.anything());
+        });
+        jest.clearAllMocks();
+    });
+
     describe('Navigate to Page API', () => {
         const path = 'pinboard/e0836cad-4fdf-42d4-bd97-567a6b2a6058';
         beforeEach(() => {
-            jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
-                () => 'http://tshost',
-            );
+            jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(() => 'http://tshost');
         });
 
         test('when app is AppEmbed after navigateToPage function call, new path should be set to iframe', async () => {
@@ -207,7 +249,8 @@ describe('App embed tests', () => {
             });
             await appEmbed.render();
             appEmbed.navigateToPage(path);
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}${defaultParamsPost}#/${path}`,
             );
         });

package/src/embed/app.ts

@@ -9,13 +9,9 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 
-import { getFilterQuery, getQueryParamString } from '../utils';
+import { getQueryParamString } from '../utils';
 import {
-    Param,
-    RuntimeFilter,
-    DOMSelector,
-    HostEvent,
-    ViewConfig,
+    Param, DOMSelector, HostEvent, ViewConfig, EmbedEvent, MessagePayload,
 } from '../types';
 import { V1Embed } from './ts-embed';
 
@@ -56,6 +52,7 @@ export enum Page {
 
 /**
  * The view configuration for full app embedding.
+ *
  * @group Embed components
  */
 export interface AppViewConfig extends ViewConfig {
@@ -81,8 +78,9 @@ export interface AppViewConfig extends ViewConfig {
      */
     pageId?: Page;
     /**
-     * This puts a filter tag on the application. All metadata lists in the application, such as
-     * Liveboards and answers, would be filtered by this tag.
+     * This puts a filter tag on the application. All metadata lists in the
+     * application, such as Liveboards and answers, would be filtered by this
+     * tag.
      */
     tag?: string;
     /**
@@ -92,36 +90,71 @@ 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
+     *
      * @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, 8.8.1-sw
      */
     enableSearchAssist?: boolean;
+     /**
+      * If set to true, the embedded object container dynamically resizes
+      * according to the height of the pages which support fullHeight mode.
+      *
+      * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
+      */
+    fullHeight?:boolean;
 }
 
 /**
  * Embeds full ThoughtSpot experience in a host application.
+ *
  * @group Embed components
  */
 export class AppEmbed extends V1Embed {
     protected viewConfig: AppViewConfig;
 
+    private defaultHeight = '100%';
+
     // eslint-disable-next-line no-useless-constructor
     constructor(domSelector: DOMSelector, viewConfig: AppViewConfig) {
         super(domSelector, viewConfig);
+        if (this.viewConfig.fullHeight === true) {
+            this.on(EmbedEvent.RouteChange, this.setIframeHeightForNonEmbedLiveboard);
+            this.on(EmbedEvent.EmbedHeight, this.updateIFrameHeight);
+            this.on(EmbedEvent.EmbedIframeCenter, this.embedIframeCenter);
+        }
     }
 
     /**
      * Constructs a map of parameters to be passed on to the
      * embedded Liveboard or visualization.
      */
-    private getEmbedParams() {
-        const params = this.getBaseQueryParams();
-        const { tag, hideObjects, liveboardV2 } = this.viewConfig;
+    protected getEmbedParams() {
+        const {
+            tag,
+            hideObjects,
+            liveboardV2,
+            showPrimaryNavbar,
+            disableProfileAndHelp,
+            enableSearchAssist,
+            fullHeight,
+        } = this.viewConfig;
+
+        let params = {};
+        params[Param.EmbedApp] = true;
+        params[Param.PrimaryNavHidden] = !showPrimaryNavbar;
+        params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
+
+        params = this.getBaseQueryParams(params);
+
+        if (fullHeight === true) {
+            params[Param.fullHeight] = true;
+        }
 
         if (tag) {
             params[Param.Tag] = tag;
@@ -133,6 +166,10 @@ export class AppEmbed extends V1Embed {
             params[Param.LiveboardV2Enabled] = liveboardV2;
         }
 
+        if (enableSearchAssist !== undefined) {
+            params[Param.EnableSearchAssist] = enableSearchAssist;
+        }
+
         const queryParams = getQueryParamString(params, true);
 
         return queryParams;
@@ -140,21 +177,13 @@ export class AppEmbed extends V1Embed {
 
     /**
      * Constructs the URL of the ThoughtSpot app page to be rendered.
+     *
      * @param pageId The ID of the page to be embedded.
      */
-    private getIFrameSrc(pageId: string, runtimeFilters: RuntimeFilter[]) {
-        const filterQuery = getFilterQuery(runtimeFilters || []);
-        const queryParams = this.getEmbedParams();
-        const queryString = [filterQuery, queryParams]
-            .filter(Boolean)
-            .join('&');
-        let url = `${this.getV1EmbedBasePath(
-            queryString,
-            this.viewConfig.showPrimaryNavbar,
-            this.viewConfig.disableProfileAndHelp,
-            true,
-            this.viewConfig.enableSearchAssist,
-        )}/${pageId}`;
+    private getIFrameSrc() {
+        const { pageId, path } = this.viewConfig;
+        const pageRoute = this.formatPath(path) || this.getPageRoute(pageId);
+        let url = `${this.getRootIframeSrc()}/${pageRoute}`;
 
         const tsPostHashParams = this.getThoughtSpotPostUrlParams();
         url = `${url}${tsPostHashParams}`;
@@ -162,8 +191,33 @@ export class AppEmbed extends V1Embed {
         return url;
     }
 
+    /**
+     * Set the iframe height as per the computed height received
+     * from the ThoughtSpot app.
+     *
+     * @param data The event payload
+     */
+    protected updateIFrameHeight = (data: MessagePayload) => {
+        this.setIFrameHeight(Math.max(data.data, this.iFrame?.scrollHeight));
+    }
+
+    private embedIframeCenter = (data: MessagePayload, responder: any) => {
+        const obj = this.getIframeCenter();
+        responder({ type: EmbedEvent.EmbedIframeCenter, data: obj });
+    };
+
+    private setIframeHeightForNonEmbedLiveboard = (data: MessagePayload) => {
+        const {
+            height: frameHeight, ...restParams
+        } = this.viewConfig.frameParams || {};
+        if (!data.data.currentPath.startsWith('/pinboard/')) {
+            this.setIFrameHeight(frameHeight || this.defaultHeight);
+        }
+    };
+
     /**
      * Gets the ThoughtSpot route of the page for a particular page ID.
+     *
      * @param pageId The identifier for a page in the ThoughtSpot app.
      */
     private getPageRoute(pageId: Page) {
@@ -188,6 +242,7 @@ export class AppEmbed extends V1Embed {
 
     /**
      * Formats the path provided by the user.
+     *
      * @param path The URL path.
      * @returns The URL path that the embedded app understands.
      */
@@ -206,10 +261,13 @@ export class AppEmbed extends V1Embed {
 
     /**
      * Navigate to particular page for app embed. eg:answers/pinboards/home
-     * This is used for embedding answers, pinboards, visualizations and full application only.
+     * This is used for embedding answers, pinboards, visualizations and full application
+     * only.
+     *
      * @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.
+     * When used with `noReload` (default: true) this can also be a number
+     * like 1/-1 to go forward/back.
      * @param noReload boolean Trigger the navigation without reloading the page
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
      */
@@ -222,31 +280,28 @@ export class AppEmbed extends V1Embed {
             this.trigger(HostEvent.Navigate, path);
         } else {
             if (typeof path !== 'string') {
-                console.warn(
-                    'Path can only by a string when triggered without noReload',
-                );
+                console.warn('Path can only by a string when triggered without noReload');
                 return;
             }
             const iframeSrc = this.iFrame.src;
             const embedPath = '#/embed';
             const currentPath = iframeSrc.includes(embedPath) ? embedPath : '#';
-            this.iFrame.src = `${
-                iframeSrc.split(currentPath)[0]
-            }${currentPath}/${path.replace(/^\/?#?\//, '')}`;
+            this.iFrame.src = `${iframeSrc.split(currentPath)[0]}${currentPath}/${path.replace(
+                /^\/?#?\//,
+                '',
+            )}`;
         }
     }
 
     /**
      * Renders the embedded application pages in the ThoughtSpot app.
+     *
      * @param renderOptions An object containing the page ID
      * to be embedded.
      */
     public render(): AppEmbed {
         super.render();
-
-        const { pageId, runtimeFilters, path } = this.viewConfig;
-        const pageRoute = this.formatPath(path) || this.getPageRoute(pageId);
-        const src = this.getIFrameSrc(pageRoute, runtimeFilters);
+        const src = this.getIFrameSrc();
         this.renderV1Embed(src);
 
         return this;

package/src/embed/base.spec.ts

@@ -62,9 +62,7 @@ describe('Base TS Embed', () => {
             callPrefetch: true,
         });
         expect(getAllIframeEl().length).toBe(1);
-        const prefetchIframe = document.querySelectorAll<HTMLIFrameElement>(
-            '.prefetchIframe',
-        );
+        const prefetchIframe = document.querySelectorAll<HTMLIFrameElement>('.prefetchIframe');
         expect(prefetchIframe.length).toBe(1);
         const firstIframe = <HTMLIFrameElement>prefetchIframe[0];
         expect(firstIframe.src).toBe(url);
@@ -79,9 +77,7 @@ describe('Base TS Embed', () => {
             index.PrefetchFeatures.LiveboardEmbed,
         ]);
         expect(getAllIframeEl().length).toBe(2);
-        const prefetchIframe = document.querySelectorAll<HTMLIFrameElement>(
-            '.prefetchIframe',
-        );
+        const prefetchIframe = document.querySelectorAll<HTMLIFrameElement>('.prefetchIframe');
         expect(prefetchIframe.length).toBe(2);
         const firstIframe = <HTMLIFrameElement>prefetchIframe[0];
         expect(firstIframe.src).toBe(searchUrl);
@@ -93,9 +89,7 @@ describe('Base TS Embed', () => {
         const url = '';
         index.prefetch(url);
         expect(getAllIframeEl().length).toBe(0);
-        const prefetchIframe = document.querySelectorAll<HTMLIFrameElement>(
-            '.prefetchIframe',
-        );
+        const prefetchIframe = document.querySelectorAll<HTMLIFrameElement>('.prefetchIframe');
         expect(prefetchIframe.length).toBe(0);
     });
 

package/src/embed/base.ts

@@ -46,10 +46,7 @@ export const getEmbedConfig = (): EmbedConfig => config;
 export const getAuthPromise = (): Promise<boolean> => authPromise;
 
 export {
-    notifyAuthFailure,
-    notifyAuthSDKSuccess,
-    notifyAuthSuccess,
-    notifyLogout,
+    notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout,
 };
 
 /**
@@ -80,16 +77,16 @@ const hostUrlToFeatureUrl = {
 };
 
 /**
- * Prefetches static resources from the specified URL. Web browsers can then cache the prefetched resources and serve them from the user's local disk to provide faster access to your app.
+ * Prefetches static resources from the specified URL. Web browsers can then cache the
+ * prefetched resources and serve them from the user's local disk to provide faster access
+ * to your app.
+ *
  * @param url The URL provided for prefetch
  * @param prefetchFeatures Specify features which needs to be prefetched.
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
  * @group Global methods
  */
-export const prefetch = (
-    url?: string,
-    prefetchFeatures?: PrefetchFeatures[],
-): void => {
+export const prefetch = (url?: string, prefetchFeatures?: PrefetchFeatures[]): void => {
     if (url === '') {
         // eslint-disable-next-line no-console
         console.warn('The prefetch method does not have a valid URL');
@@ -97,21 +94,25 @@ export const prefetch = (
         const features = prefetchFeatures || [PrefetchFeatures.FullApp];
         let hostUrl = url || config.thoughtSpotHost;
         hostUrl = hostUrl[hostUrl.length - 1] === '/' ? hostUrl : `${hostUrl}/`;
-        uniq(
-            features.map((feature) => hostUrlToFeatureUrl[feature](hostUrl)),
-        ).forEach((prefetchUrl, index) => {
-            const iFrame = document.createElement('iframe');
-            iFrame.src = prefetchUrl;
-            iFrame.style.width = '0';
-            iFrame.style.height = '0';
-            iFrame.style.border = '0';
-            iFrame.classList.add('prefetchIframe');
-            iFrame.classList.add(`prefetchIframeNum-${index}`);
-            document.body.appendChild(iFrame);
-        });
+        uniq(features.map((feature) => hostUrlToFeatureUrl[feature](hostUrl))).forEach(
+            (prefetchUrl, index) => {
+                const iFrame = document.createElement('iframe');
+                iFrame.src = prefetchUrl;
+                iFrame.style.width = '0';
+                iFrame.style.height = '0';
+                iFrame.style.border = '0';
+                iFrame.classList.add('prefetchIframe');
+                iFrame.classList.add(`prefetchIframeNum-${index}`);
+                document.body.appendChild(iFrame);
+            },
+        );
     }
 };
 
+/**
+ *
+ * @param embedConfig
+ */
 function sanity(embedConfig: EmbedConfig) {
     if (embedConfig.thoughtSpotHost === undefined) {
         throw new Error('ThoughtSpot host not provided');
@@ -121,23 +122,19 @@ function sanity(embedConfig: EmbedConfig) {
             throw new Error('Username not provided with Trusted auth');
         }
 
-        if (
-            !embedConfig.authEndpoint &&
-            typeof embedConfig.getAuthToken !== 'function'
-        ) {
-            throw new Error(
-                'Trusted auth should provide either authEndpoint or getAuthToken',
-            );
+        if (!embedConfig.authEndpoint && typeof embedConfig.getAuthToken !== 'function') {
+            throw new Error('Trusted auth should provide either authEndpoint or getAuthToken');
         }
     }
 }
 
+/**
+ *
+ * @param embedConfig
+ */
 function backwardCompat(embedConfig: EmbedConfig): EmbedConfig {
     const newConfig = { ...embedConfig };
-    if (
-        embedConfig.noRedirect !== undefined &&
-        embedConfig.inPopup === undefined
-    ) {
+    if (embedConfig.noRedirect !== undefined && embedConfig.inPopup === undefined) {
         newConfig.inPopup = embedConfig.noRedirect;
     }
     return newConfig;
@@ -145,10 +142,12 @@ function backwardCompat(embedConfig: EmbedConfig): EmbedConfig {
 
 /**
  * Initializes the Visual Embed SDK globally and perform
- * authentication if applicable.
+ * authentication if applicable. This function needs to be called before any ThoughtSpot
+ * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+ * to actually embed. That is handled internally.
+ *
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.
- *
  * @example
  * ```js
  *   const authStatus = init({
@@ -157,8 +156,8 @@ function backwardCompat(embedConfig: EmbedConfig): EmbedConfig {
  *   });
  *   authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
  * ```
- *
- * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success, failure and logout. See {@link AuthStatus}
+ * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success,
+ *      failure and logout. See {@link AuthStatus}
  * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
  * @group Authentication / Init
  */
@@ -177,17 +176,12 @@ export const init = (embedConfig: EmbedConfig): AuthEventEmitter => {
     uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_CALLED_INIT, {
         authType: config.authType,
         host: config.thoughtSpotHost,
-        usedCustomizationSheet:
-            embedConfig.customizations?.style?.customCSSUrl != null,
-        usedCustomizationVariables:
-            embedConfig.customizations?.style?.customCSS?.variables != null,
+        usedCustomizationSheet: embedConfig.customizations?.style?.customCSSUrl != null,
+        usedCustomizationVariables: embedConfig.customizations?.style?.customCSS?.variables != null,
         usedCustomizationRules:
-            embedConfig.customizations?.style?.customCSS?.rules_UNSTABLE !=
-            null,
-        usedCustomizationStrings: !!embedConfig.customizations?.content
-            ?.strings,
-        usedCustomizationIconSprite: !!embedConfig.customizations
-            ?.iconSpriteUrl,
+            embedConfig.customizations?.style?.customCSS?.rules_UNSTABLE != null,
+        usedCustomizationStrings: !!embedConfig.customizations?.content?.strings,
+        usedCustomizationIconSprite: !!embedConfig.customizations?.iconSpriteUrl,
     });
 
     if (config.callPrefetch) {
@@ -196,16 +190,19 @@ export const init = (embedConfig: EmbedConfig): AuthEventEmitter => {
     return authEE as AuthEventEmitter;
 };
 
+/**
+ *
+ */
 export function disableAutoLogin(): void {
     config.autoLogin = false;
 }
 
 /**
- * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to prevent
- * the SDK from automatically logging in again.
+ * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
+ * prevent the SDK from automatically logging in again.
  *
- * You can call the `init` method again to re login, if autoLogin is set to true in this
- * second call it will be honored.
+ * You can call the `init` method again to re login, if autoLogin is set to
+ * true in this second call it will be honored.
  *
  * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
  * @returns Promise which resolves when logout completes.
@@ -225,22 +222,25 @@ export const logout = (doNotDisableAutoLogin = false): Promise<boolean> => {
 let renderQueue: Promise<any> = Promise.resolve();
 
 /**
- * Renders functions in a queue, resolves to next function only after the callback next is called
+ * Renders functions in a queue, resolves to next function only after the callback next
+ * is called
+ *
  * @param fn The function being registered
  */
-export const renderInQueue = (
-    fn: (next?: (val?: any) => void) => Promise<any>,
-): Promise<any> => {
+export const renderInQueue = (fn: (next?: (val?: any) => void) => Promise<any>): Promise<any> => {
     const { queueMultiRenders = false } = config;
     if (queueMultiRenders) {
         renderQueue = renderQueue.then(() => new Promise((res) => fn(res)));
         return renderQueue;
     }
     // Sending an empty function to keep it consistent with the above usage.
-    return fn(() => {}); // eslint-disable-line @typescript-eslint/no-empty-function
+    return fn(() => { }); // eslint-disable-line @typescript-eslint/no-empty-function
 };
 
 // For testing purposes only
+/**
+ *
+ */
 export function reset(): void {
     config = {} as any;
     setAuthEE(null);

package/src/embed/embed.spec.ts

@@ -1,4 +1,6 @@
-import { init, AuthType, SearchEmbed, EmbedEvent } from '../index';
+import {
+    init, AuthType, SearchEmbed, EmbedEvent,
+} from '../index';
 import {
     EVENT_WAIT_TIME,
     executeAfterWait,
@@ -59,8 +61,7 @@ describe('test view config', () => {
         await executeAfterWait(() => {
             expect(onErrorSpy).toHaveBeenCalledWith(
                 {
-                    error:
-                        'Please register event handlers before calling render',
+                    error: 'Please register event handlers before calling render',
                 },
                 expect.any(Function),
             );
@@ -84,9 +85,7 @@ describe('Custom CSS Url', () => {
         embed.render();
         executeAfterWait(() => {
             const iframe = getIFrameEl();
-            expect(iframe.src.includes('customCssUrl=bla.com/foo.css')).toBe(
-                true,
-            );
+            expect(iframe.src.includes('customCssUrl=bla.com/foo.css')).toBe(true);
             done();
         });
     });