@thoughtspot/visual-embed-sdk 1.28.0-preRender → 1.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.28.0-preRender",
+    "version": "1.28.0",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -38,7 +38,7 @@
     "size-limit": [
         {
             "path": "dist/tsembed.js",
-            "limit": "44 kB"
+            "limit": "45 kB"
         }
     ],
     "scripts": {
@@ -67,8 +67,7 @@
         "prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
         "check-size": "npm run build && size-limit",
         "publish-dev": "npm publish --tag dev",
-        "publish-prod": "npm publish --tag latest",
-        "nirmay": "npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build"
+        "publish-prod": "npm publish --tag latest"
     },
     "peerDependencies": {
         "react": "> 16.8.0",

package/src/auth.spec.ts

@@ -3,6 +3,7 @@ import * as authService from './utils/authService/authService';
 import * as tokenAuthService from './utils/authService/tokenizedAuthService';
 import * as checkReleaseVersionInBetaInstance from './utils';
 import * as mixPanelService from './mixpanel-service';
+import * as EmbedConfig from './embed/embedConfig';
 import { AuthType, EmbedEvent } from './types';
 import { executeAfterWait } from './test/test-utils';
 import { resetCachedAuthToken } from './authToken';
@@ -130,6 +131,15 @@ describe('Unit test for auth', () => {
         expect(sessionInfo).toStrictEqual(mockSessionInfo);
     });
 
+    test('Disable mixpanel when disableSDKTracking flag is set', () => {
+        jest.clearAllMocks();
+        jest.resetAllMocks();
+        jest.spyOn(mixPanelService, 'initMixpanel');
+        jest.spyOn(EmbedConfig, 'getEmbedConfig').mockReturnValue({ disableSDKTracking: true });
+        authInstance.initSession(mockSessionInfo);
+        expect(mixPanelService.initMixpanel).not.toBeCalled();
+    });
+
     test('doCookielessTokenAuth: when authEndpoint and getAuthToken are not there, it throw error', async () => {
         try {
             await authInstance.doCookielessTokenAuth(

package/src/auth.ts

@@ -1,19 +1,20 @@
 import EventEmitter from 'eventemitter3';
+import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
 import { initMixpanel } from './mixpanel-service';
 import {
-    AuthType, DOMSelector, EmbedConfig, EmbedEvent, Param,
+    AuthType, DOMSelector, EmbedConfig, EmbedEvent,
 } from './types';
 import { getDOMNode, getRedirectUrl } from './utils';
 import {
-    fetchSessionInfoService,
+    EndPoints,
+    fetchAuthPostService,
     fetchAuthService,
     fetchBasicAuthService,
     fetchLogoutService,
-    fetchAuthPostService,
-    EndPoints,
+    fetchSessionInfoService,
 } from './utils/authService';
-import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
 import { logger } from './utils/logger';
+import { getEmbedConfig } from './embed/embedConfig';
 
 // eslint-disable-next-line import/no-mutable-exports
 export let loggedInStatus = false;
@@ -117,7 +118,22 @@ export interface AuthEventEmitter {
      *
      * @param {@link AuthEvent}
      */
-    emit(event: AuthEvent): void;
+    emit(event: AuthEvent, ...args: any[]): boolean;
+    /**
+     * Remove listener from the emitter returned from init.
+     *
+     * @param event
+     * @param listener
+     * @param context
+     * @param once
+     */
+    off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
+    /**
+     * Remove all the event listeners
+     *
+     * @param event
+     */
+    removeAllListeners(event: AuthStatus): this;
 }
 
 /**
@@ -196,9 +212,12 @@ export function notifyLogout(): void {
 }
 
 export const initSession = (sessionDetails: sessionInfoInterface) => {
+    const embedConfig = getEmbedConfig();
     if (sessionInfo == null) {
         sessionInfo = sessionDetails;
-        initMixpanel(sessionInfo);
+        if (!embedConfig.disableSDKTracking) {
+            initMixpanel(sessionInfo);
+        }
         sessionInfoResolver(sessionInfo);
     }
 };
@@ -473,7 +492,7 @@ export const logout = async (embedConfig: EmbedConfig): Promise<boolean> => {
     const { thoughtSpotHost } = embedConfig;
     await fetchLogoutService(thoughtSpotHost);
     resetCachedAuthToken();
-    const thoughtspotIframes = document.querySelectorAll('[data-ts-iframe=\'true\']');
+    const thoughtspotIframes = document.querySelectorAll("[data-ts-iframe='true']");
     if (thoughtspotIframes?.length) {
         thoughtspotIframes.forEach((el) => {
             el.parentElement.innerHTML = embedConfig.loginFailedMessage;

package/src/embed/app.spec.ts

@@ -213,6 +213,7 @@ describe('App embed tests', () => {
                     values: [1000],
                 },
             ],
+            excludeRuntimeFiltersfromURL: false,
         } as AppViewConfig);
 
         appEmbed.render();
@@ -224,7 +225,7 @@ describe('App embed tests', () => {
         });
     });
 
-    test('should not apply runtime filters if excludeRuntimeFiltersfromURL is true', async () => {
+    test('should not append runtime filters in URL if excludeRuntimeFiltersfromURL is true', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
             showPrimaryNavbar: true,
@@ -247,6 +248,28 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should not append runtime filters in URL if excludeRuntimeFiltersfromURL is undefined', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            showPrimaryNavbar: true,
+            runtimeFilters: [
+                {
+                    columnName: 'sales',
+                    operator: RuntimeFilterOp.EQ,
+                    values: [1000],
+                },
+            ],
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should disable and hide actions', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/app.ts

@@ -9,11 +9,11 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 
-import { logger } from '../utils/logger';
-import { getQueryParamString } from '../utils';
 import {
-    Param, DOMSelector, HostEvent, ViewConfig, EmbedEvent, MessagePayload,
+    DOMSelector, EmbedEvent, HostEvent, MessagePayload, Param, ViewConfig,
 } from '../types';
+import { getQueryParamString } from '../utils';
+import { logger } from '../utils/logger';
 import { V1Embed } from './ts-embed';
 
 /**
@@ -61,6 +61,16 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * If true, the top navigation bar within the ThoughtSpot app
      * is displayed. By default, the navigation bar is hidden.
      * This flag also controls the homepage left navigation bar.
+     *
+     * @default true
+     * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showPrimaryNavbar:true,
+     * })
+     * ```
      */
     showPrimaryNavbar?: boolean;
     /**
@@ -69,23 +79,78 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * nav-bars are visible, this flag will only hide the homepage left nav-bar.
      * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
      *
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
      * @default false
-     * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideHomepageLeftNav : true,
+     * })
+     * ```
      */
     hideHomepageLeftNav?: boolean;
     /**
      * Control the visibility of the help (?) and profile buttons on the
      * Global nav-bar. By default, these buttons are visible on the nav-bar.
+     *
+     * @default false
+     * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    disableProfileAndHelp: true,
+     * })
+     * ```
      */
     disableProfileAndHelp?: boolean;
     /**
      * Control the visibility of the application switcher button on the nav-bar.
      * By default, the application switcher is shown.
+     *
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @default false
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideApplicationSwitcher : true,
+     * })
+     * ```
      */
     hideApplicationSwitcher?: boolean;
     /**
      * Control the visibility of the Org switcher button on the nav-bar.
      * By default, the Org switcher button is shown.
+     *
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @default true
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideOrgSwitcher : true,
+     * })
+     * ```
      */
     hideOrgSwitcher?: boolean;
     /**
@@ -97,9 +162,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * For eg, if you want the component to open to a specific Liveboard
      * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
      *
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
      * @example
-     * ```
-     * <AppEmbed path="pinboard/1234/tab/7464" />
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    path:"pinboard/1234/tab/7464"
+     * })
      * ```
      */
     path?: string;
@@ -109,16 +178,46 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * Use this to open to particular page in the app. To open to a specific
      * path within the app, use the `path` attribute which is more flexible.
+     *
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    pageId : Page.Answers | Page.Data
+     * })
+     * ```
      */
     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.
+     *
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    tag:'value',
+     * })
+     * ```
      */
     tag?: string;
     /**
      * The array of GUIDs to be hidden
+     *
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideObjects: [
+     *       '430496d6-6903-4601-937e-2c691821af3c',
+     *       'f547ec54-2a37-4516-a222-2b06719af726'
+     *     ]
+     * })
+     * ```
      */
     hideObjects?: string[];
     /**
@@ -132,7 +231,15 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
     /**
      * If set to true, the Search Assist feature is enabled.
      *
+     * @default true
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    enableSearchAssist: true,
+     * })
+     * ```
      */
     enableSearchAssist?: boolean;
     /**
@@ -140,6 +247,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * 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
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    fullHeight: true,
+     * })
+     * ```
      */
     fullHeight?: boolean;
     /**
@@ -155,6 +269,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideLiveboardHeader : true,
+     * })
+     * ```
      */
     hideLiveboardHeader?: boolean;
     /**
@@ -162,6 +283,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showLiveboardTitle:true,
+     * })
+     * ```
      */
     showLiveboardTitle?: boolean;
     /**
@@ -169,13 +297,28 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showLiveboardDescription:true,
+     * })
+     * ```
      */
     showLiveboardDescription?: boolean;
     /**
-     * Flag to control new Modular Home experience
+     * Flag to control new Modular Home experience.
      *
      * @default false
-     * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    modularHomeExperience : true,
+     * })
+     * ```
      */
     modularHomeExperience?: boolean;
     /**
@@ -295,9 +438,7 @@ export class AppEmbed extends V1Embed {
      * @param pageId The ID of the page to be embedded.
      */
     public getIFrameSrc(): string {
-        const {
-            pageId, path, modularHomeExperience,
-        } = this.viewConfig;
+        const { pageId, path, modularHomeExperience } = this.viewConfig;
         const pageRoute = this.formatPath(path) || this.getPageRoute(pageId, modularHomeExperience);
         let url = `${this.getRootIframeSrc()}/${pageRoute}`;
 
@@ -414,10 +555,10 @@ export class AppEmbed extends V1Embed {
      * @param renderOptions An object containing the page ID
      * to be embedded.
      */
-    public render(): AppEmbed {
+    public async render(): Promise<AppEmbed> {
         super.render();
         const src = this.getIFrameSrc();
-        this.renderV1Embed(src);
+        await this.renderV1Embed(src);
 
         return this;
     }

package/src/embed/base.spec.ts

@@ -1,11 +1,11 @@
 /* eslint-disable no-console */
 /* eslint-disable @typescript-eslint/no-shadow */
 import EventEmitter from 'eventemitter3';
-import { EmbedConfig } from '../index';
 import * as auth from '../auth';
-import * as authService from '../utils/authService/authService';
 import * as authTokenService from '../authToken';
 import * as index from '../index';
+import { EmbedConfig } from '../index';
+import * as authService from '../utils/authService/authService';
 import * as base from './base';
 import * as embedConfigInstance from './embedConfig';
 
@@ -13,8 +13,8 @@ import {
     executeAfterWait,
     getAllIframeEl,
     getDocumentBody,
-    getRootEl,
     getIFrameSrc,
+    getRootEl,
 } from '../test/test-utils';
 import * as tokenizedFetchInstance from '../tokenizedFetch';
 import { logger } from '../utils/logger';

package/src/embed/base.ts

@@ -10,27 +10,27 @@
  */
 import EventEmitter from 'eventemitter3';
 import uniq from 'lodash/uniq';
-import { logger, setGlobalLogLevelOverride } from '../utils/logger';
-import { tokenizedFetch } from '../tokenizedFetch';
-import { EndPoints } from '../utils/authService/authService';
-import { getThoughtSpotHost } from '../config';
-import {
-    AuthType, EmbedConfig, LogLevel, PrefetchFeatures,
-} from '../types';
 import {
-    authenticate,
-    logout as _logout,
+    AuthEvent,
+    AuthEventEmitter,
     AuthFailureType,
     AuthStatus,
-    AuthEvent,
+    logout as _logout,
+    authenticate,
     notifyAuthFailure,
     notifyAuthSDKSuccess,
     notifyAuthSuccess,
     notifyLogout,
     setAuthEE,
-    AuthEventEmitter,
 } from '../auth';
-import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
+import { getThoughtSpotHost } from '../config';
+import { MIXPANEL_EVENT, uploadMixpanelEvent } from '../mixpanel-service';
+import { tokenizedFetch } from '../tokenizedFetch';
+import {
+    AuthType, EmbedConfig, LogLevel, PrefetchFeatures,
+} from '../types';
+import { EndPoints } from '../utils/authService/authService';
+import { logger, setGlobalLogLevelOverride } from '../utils/logger';
 import { getEmbedConfig, setEmbedConfig } from './embedConfig';
 
 const CONFIG_DEFAULTS: Partial<EmbedConfig> = {
@@ -133,10 +133,6 @@ function sanity(embedConfig: EmbedConfig) {
         throw new Error('ThoughtSpot host not provided');
     }
     if (embedConfig.authType === AuthType.TrustedAuthToken) {
-        if (!embedConfig.username) {
-            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');
         }
@@ -253,7 +249,7 @@ export const renderInQueue = (fn: (next?: (val?: any) => void) => Promise<any>):
         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
 };
 
 /**

package/src/embed/embed.spec.ts

@@ -50,24 +50,6 @@ describe('test view config', () => {
             expect(iframe.style.height).toBe(`${height}px`);
         });
     });
-
-    test('trying to register event handler after render should throw error', async () => {
-        spyOn(logger, 'error');
-        const onErrorSpy = jest.fn();
-        const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
-        searchEmbed
-            .on(EmbedEvent.Error, onErrorSpy)
-            .render()
-            .on(EmbedEvent.Load, () => null);
-        await executeAfterWait(() => {
-            expect(onErrorSpy).toHaveBeenCalledWith(
-                {
-                    error: 'Please register event handlers before calling render',
-                },
-                expect.any(Function),
-            );
-        }, EVENT_WAIT_TIME);
-    });
 });
 
 describe('Custom CSS Url', () => {

package/src/embed/liveboard.spec.ts

@@ -182,6 +182,7 @@ describe('Liveboard/viz embed tests', () => {
                     values: [1000],
                 },
             ],
+            excludeRuntimeFiltersfromURL: false,
         } as LiveboardViewConfig);
         liveboardEmbed.render();
         await executeAfterWait(() => {
@@ -208,7 +209,29 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
-    test('should not apply runtime filters if excludeRuntimeFiltersfromURL is true', async () => {
+    test('should not append runtime filters in URL if excludeRuntimeFiltersfromURL is true', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            vizId,
+            runtimeFilters: [
+                {
+                    columnName: 'sales',
+                    operator: RuntimeFilterOp.EQ,
+                    values: [1000],
+                },
+            ],
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}${prefixParamsVizEmbed}#/embed/viz/${liveboardId}/${vizId}`,
+            );
+        });
+    });
+
+    test('should not append runtime filters in URL if excludeRuntimeFiltersfromURL is undefined', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
             liveboardId,