@thoughtspot/visual-embed-sdk 1.28.4 → 1.28.5-alpha-1

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,
-    getIFrameSrc,
     getRootEl,
+    getIFrameSrc,
 } from '../test/test-utils';
 import * as tokenizedFetchInstance from '../tokenizedFetch';
 import { logger } from '../utils/logger';

package/src/embed/base.ts

@@ -10,28 +10,28 @@
  */
 import EventEmitter from 'eventemitter3';
 import uniq from 'lodash/uniq';
+import { resetCachedAuthToken } from '../authToken';
+import { logger, setGlobalLogLevelOverride } from '../utils/logger';
+import { tokenizedFetch } from '../tokenizedFetch';
+import { EndPoints } from '../utils/authService/authService';
+import { getThoughtSpotHost } from '../config';
 import {
-    AuthEvent,
-    AuthEventEmitter,
+    AuthType, EmbedConfig, LogLevel, PrefetchFeatures,
+} from '../types';
+import {
+    authenticate,
+    logout as _logout,
     AuthFailureType,
     AuthStatus,
-    logout as _logout,
-    authenticate,
+    AuthEvent,
     notifyAuthFailure,
     notifyAuthSDKSuccess,
     notifyAuthSuccess,
     notifyLogout,
     setAuthEE,
+    AuthEventEmitter,
 } from '../auth';
-import { resetCachedAuthToken } from '../authToken';
-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 { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 import { getEmbedConfig, setEmbedConfig } from './embedConfig';
 
 const CONFIG_DEFAULTS: Partial<EmbedConfig> = {
@@ -251,7 +251,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/liveboard.ts

@@ -11,9 +11,16 @@
 
 import { ERROR_MESSAGE } from '../errors';
 import {
-    DOMSelector, EmbedEvent, HostEvent, MessagePayload, Param, ViewConfig,
+    EmbedEvent,
+    MessagePayload,
+    Param,
+    RuntimeFilter,
+    DOMSelector,
+    HostEvent,
+    ViewConfig,
 } from '../types';
 import { getQueryParamString, isUndefined } from '../utils';
+import { getAuthPromise } from './base';
 import { V1Embed } from './ts-embed';
 
 /**
@@ -37,6 +44,7 @@ export interface LiveboardViewConfig
      * incrementally as users scroll the page to view the charts and tables.
      *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -65,6 +73,7 @@ export interface LiveboardViewConfig
     defaultHeight?: number;
     /**
      * @Deprecated If set to true, the context menu in visualizations will be enabled.
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -72,6 +81,7 @@ export interface LiveboardViewConfig
      *    enableVizTransformations:true,
      * })
      * ```
+     *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
      */
     enableVizTransformations?: boolean;
@@ -98,6 +108,7 @@ export interface LiveboardViewConfig
      * The visualization within the Liveboard to display.
      *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -127,6 +138,7 @@ export interface LiveboardViewConfig
      * event.
      *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -176,6 +188,7 @@ export interface LiveboardViewConfig
      * Show or hide the tab panel of the embedded Liveboard.
      *
      * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -201,9 +214,9 @@ export interface LiveboardViewConfig
     hideLiveboardHeader?: boolean;
     /**
      * Show or hide the Liveboard title.
-     *
      * @default false
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -215,9 +228,9 @@ export interface LiveboardViewConfig
     showLiveboardTitle?: boolean;
     /**
      * Show or hide the Liveboard description.
-     *
      * @default false
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {

package/src/embed/search.ts

@@ -7,20 +7,24 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 
-import { getReleaseVersion } from '../auth';
-import { ERROR_MESSAGE } from '../errors';
 import {
-    Action, DOMSelector, DataSourceVisualMode, Param, ViewConfig,
+    DataSourceVisualMode,
+    DOMSelector,
+    Param,
+    Action,
+    ViewConfig,
 } from '../types';
 import {
+    getQueryParamString,
     checkReleaseVersionInBeta,
     getFilterQuery,
-    getQueryParamString,
     getRuntimeParameters,
 } from '../utils';
+import { TsEmbed } from './ts-embed';
+import { ERROR_MESSAGE } from '../errors';
 import { getAuthPromise } from './base';
+import { getReleaseVersion } from '../auth';
 import { getEmbedConfig } from './embedConfig';
-import { TsEmbed } from './ts-embed';
 
 /**
  * Configuration for search options.
@@ -59,6 +63,7 @@ export interface SearchViewConfig
      * but can be expanded manually.
      *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -72,6 +77,7 @@ export interface SearchViewConfig
      * Show or hide the data sources panel.
      *
      * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -87,6 +93,7 @@ export interface SearchViewConfig
      * using raw answer data.
      *
      * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -96,14 +103,11 @@ export interface SearchViewConfig
      * ```
      */
     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, 8.8.1-sw
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -118,6 +122,7 @@ export interface SearchViewConfig
      * format for presenting search data.
      *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -131,6 +136,7 @@ export interface SearchViewConfig
      * Only a single data source is supported currently.
      *
      * @deprecated Use `dataSource` instead.
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -144,6 +150,7 @@ export interface SearchViewConfig
      * The array of data source GUIDs to set on load.
      *
      * @version: SDK: 1.19.0
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -185,6 +192,7 @@ export interface SearchViewConfig
      * The GUID of a saved answer to load initially.
      *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -199,6 +207,7 @@ export interface SearchViewConfig
      * The chart/table should still be visible.
      *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -213,6 +222,7 @@ export interface SearchViewConfig
      *
      * @default false
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -295,7 +305,6 @@ export class SearchEmbed extends TsEmbed {
     protected getEmbedParams(): string {
         const {
             hideResults,
-            expandAllDataSource,
             enableSearchAssist,
             forceTable,
             searchOptions,

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

@@ -1,39 +1,39 @@
 /* eslint-disable dot-notation */
-import * as authInstance from '../auth';
 import { resetCachedAuthToken } from '../authToken';
-import * as config from '../config';
 import {
-    AppEmbed,
     AuthType,
+    init,
     EmbedEvent,
-    LiveboardEmbed,
-    LiveboardViewConfig,
-    PinboardEmbed,
     SearchEmbed,
-    init,
+    PinboardEmbed,
+    LiveboardViewConfig,
+    AppEmbed,
+    LiveboardEmbed,
 } from '../index';
-import * as mixpanelInstance from '../mixpanel-service';
-import { MIXPANEL_EVENT } from '../mixpanel-service';
 import {
-    createRootEleForEmbed,
-    defaultParamsForPinboardEmbed,
+    Action, HomeLeftNavItem, RuntimeFilter, RuntimeFilterOp, HomepageModule, HostEvent,
+} from '../types';
+import {
     executeAfterWait,
-    expectUrlMatchesWithParams,
     getDocumentBody,
     getIFrameEl,
     getIFrameSrc,
     getRootEl,
-    mockMessageChannel,
     postMessageToParent,
+    defaultParamsForPinboardEmbed,
     waitFor,
+    expectUrlMatchesWithParams,
+    mockMessageChannel,
+    createRootEleForEmbed,
 } from '../test/test-utils';
-import {
-    Action, HomeLeftNavItem, HomepageModule, RuntimeFilter, RuntimeFilterOp,
-} from '../types';
+import * as config from '../config';
+import * as tsEmbedInstance from './ts-embed';
+import * as mixpanelInstance from '../mixpanel-service';
+import * as authInstance from '../auth';
+import * as baseInstance from './base';
+import { MIXPANEL_EVENT } from '../mixpanel-service';
 import * as authService from '../utils/authService/authService';
 import { logger } from '../utils/logger';
-import * as baseInstance from './base';
-import * as tsEmbedInstance from './ts-embed';
 
 const defaultViewConfig = {
     frameParams: {
@@ -417,10 +417,8 @@ describe('Unit test case for ts embed', () => {
                     authToken: '',
                     hostConfig: undefined,
                     runtimeFilterParams: null,
-                    hiddenHomeLeftNavItems: [
-                        HomeLeftNavItem.Home,
-                        HomeLeftNavItem.MonitorSubscription,
-                    ],
+                    hiddenHomeLeftNavItems:
+                        [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
                     hiddenHomepageModules: [],
                     reorderedHomepageModules: [],
                 },
@@ -649,10 +647,7 @@ describe('Unit test case for ts embed', () => {
                 type: EmbedEvent.APP_INIT,
                 data: {},
             };
-            const searchEmbed = new SearchEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                preRenderId: 'test',
-            });
+            const searchEmbed = new SearchEmbed(getRootEl(), { ...defaultViewConfig, preRenderId: 'test' });
             searchEmbed.preRender();
             const mockPort: any = {
                 postMessage: jest.fn(),
@@ -709,10 +704,7 @@ describe('Unit test case for ts embed', () => {
                 type: EmbedEvent.AuthExpire,
                 data: {},
             };
-            const searchEmbed = new SearchEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                preRenderId: 'test',
-            });
+            const searchEmbed = new SearchEmbed(getRootEl(), { ...defaultViewConfig, preRenderId: 'test' });
             jest.spyOn(baseInstance, 'notifyAuthFailure');
             searchEmbed.preRender();
             const mockPort: any = {
@@ -1216,7 +1208,7 @@ describe('Unit test case for ts embed', () => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
-                    + `&foo=bar&baz=1&bool=true${defaultParamsPost}#/home`,
+                + `&foo=bar&baz=1&bool=true${defaultParamsPost}#/home`,
             );
         });
 
@@ -1232,7 +1224,7 @@ describe('Unit test case for ts embed', () => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
-                    + `&showAlerts=true${defaultParamsPost}#/home`,
+                + `&showAlerts=true${defaultParamsPost}#/home`,
             );
         });
         it('Sets the locale param', async () => {
@@ -1247,7 +1239,7 @@ describe('Unit test case for ts embed', () => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
-                    + `&locale=ja-JP${defaultParamsPost}#/home`,
+                + `&locale=ja-JP${defaultParamsPost}#/home`,
             );
         });
         it('Sets the iconSprite url', async () => {
@@ -1264,7 +1256,7 @@ describe('Unit test case for ts embed', () => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
-                    + `&iconSprite=iconSprite.com${defaultParamsPost}#/home`,
+                + `&iconSprite=iconSprite.com${defaultParamsPost}#/home`,
             );
         });
 

package/src/embed/ts-embed.ts

@@ -8,54 +8,57 @@
  */
 
 import isEqual from 'lodash/isEqual';
-import pkgInfo from '../../package.json';
-import { AuthFailureType } from '../auth';
+import { logger } from '../utils/logger';
 import { getAuthenticationToken } from '../authToken';
+import { AnswerService } from '../utils/graphql/answerService/answerService';
+import {
+    getEncodedQueryParamsString,
+    getCssDimension,
+    getOffsetTop,
+    embedEventStatus,
+    setAttributes,
+    getCustomisations,
+    getRuntimeFilters,
+    getDOMNode,
+    getFilterQuery,
+    getQueryParamString,
+    getRuntimeParameters,
+    setStyleProperties,
+    removeStyleProperties,
+    isUndefined,
+} from '../utils';
 import {
-    DEFAULT_EMBED_HEIGHT,
-    DEFAULT_EMBED_WIDTH,
-    URL_MAX_LENGTH,
     getThoughtSpotHost,
+    URL_MAX_LENGTH,
+    DEFAULT_EMBED_WIDTH,
+    DEFAULT_EMBED_HEIGHT,
     getV2BasePath,
 } from '../config';
-import { MIXPANEL_EVENT, uploadMixpanelEvent } from '../mixpanel-service';
 import {
-    Action,
     AuthType,
-    ContextMenuTriggerOptions,
     DOMSelector,
-    EmbedConfig,
-    EmbedEvent,
     HostEvent,
+    EmbedEvent,
     MessageCallback,
-    MessageCallbackObj,
-    MessageOptions,
+    Action,
     Param,
+    EmbedConfig,
+    MessageOptions,
+    MessagePayload,
+    MessageCallbackObj,
     ViewConfig,
+    FrameParams,
+    ContextMenuTriggerOptions,
+    RuntimeFilter,
 } from '../types';
-import {
-    embedEventStatus,
-    getCssDimension,
-    getCustomisations,
-    getDOMNode,
-    getEncodedQueryParamsString,
-    getFilterQuery,
-    getOffsetTop,
-    getQueryParamString,
-    getRuntimeFilters,
-    getRuntimeParameters,
-    isUndefined,
-    removeStyleProperties,
-    setAttributes,
-    setStyleProperties,
-} from '../utils';
-import { AnswerService } from '../utils/graphql/answerService/answerService';
-import { logger } from '../utils/logger';
-import { processAuthFailure, processEventData } from '../utils/processData';
+import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
+import { processEventData, processAuthFailure } from '../utils/processData';
 import { processTrigger } from '../utils/processTrigger';
+import pkgInfo from '../../package.json';
 import {
-    getAuthPromise, handleAuth, notifyAuthFailure, renderInQueue,
+    getAuthPromise, renderInQueue, handleAuth, notifyAuthFailure,
 } from './base';
+import { AuthFailureType } from '../auth';
 import { getEmbedConfig } from './embedConfig';
 
 const { version } = pkgInfo;
@@ -562,7 +565,8 @@ export class TsEmbed {
 
         const {
             height: frameHeight,
-            width: frameWidth, ...restParams
+            width: frameWidth,
+            ...restParams
         } = this.viewConfig.frameParams || {};
         const width = getCssDimension(frameWidth || DEFAULT_EMBED_WIDTH);
         const height = getCssDimension(frameHeight || DEFAULT_EMBED_HEIGHT);
@@ -684,7 +688,7 @@ export class TsEmbed {
     protected connectPreRendered(): boolean {
         const preRenderIds = this.getPreRenderIds();
         this.preRenderWrapper = this.preRenderWrapper
-        || document.getElementById(preRenderIds.wrapper);
+            || document.getElementById(preRenderIds.wrapper);
 
         this.preRenderChild = this.preRenderChild || document.getElementById(preRenderIds.child);
 
@@ -1102,11 +1106,11 @@ export class TsEmbed {
                 ) {
                     logger.warn(
                         `${viewConfig.embedComponentType || 'Component'} was pre-rendered with `
-                            + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
-                            + `but a different value "${JSON.stringify(viewConfig[key])}" `
-                            + 'was passed to the Embed component. '
-                            + 'The new value provided is ignored, the value provided during '
-                            + 'preRender is used.',
+                        + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
+                        + `but a different value "${JSON.stringify(viewConfig[key])}" `
+                        + 'was passed to the Embed component. '
+                        + 'The new value provided is ignored, the value provided during '
+                        + 'preRender is used.',
                     );
                 }
             });

package/src/react/index.spec.tsx

@@ -200,35 +200,6 @@ describe('React Components', () => {
             ).toBe(true);
             expect(containerSibling.querySelector('div')).toBe(null);
         });
-
-        it('Should have the correct container element', async () => {
-            const { container } = render(
-                <LiveboardEmbed liveboardId="abcd" className="def" />,
-            );
-
-            await waitFor(() => getIFrameEl(container));
-            expect(container.querySelector('div')).not.toBe(null);
-            expect(
-                container.querySelector('div').classList.contains('def'),
-            ).toBe(true);
-
-            const { container: containerSibling } = render(
-                <LiveboardEmbed
-                    liveboardId="abcd"
-                    className="def"
-                    insertAsSibling={true}
-                />,
-            );
-            await waitFor(() => getIFrameEl(containerSibling));
-            expect(containerSibling.querySelector('span')).not.toBe(null);
-            expect(containerSibling.querySelector('span').style.position).toBe(
-                'absolute',
-            );
-            expect(
-                getIFrameEl(containerSibling).classList.contains('def'),
-            ).toBe(true);
-            expect(containerSibling.querySelector('div')).toBe(null);
-        });
     });
 
     describe('SearchBarEmbed', () => {