@thoughtspot/visual-embed-sdk 1.28.0-alpha.5 → 1.28.0

package/src/embed/app.ts

@@ -9,16 +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';
 
 /**
@@ -69,7 +64,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * @default true
      * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
-     *
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
@@ -85,12 +79,13 @@ 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 in Early Access from 9.12 forward).
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
      *
      * @default false
-     * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
      *
      * @example
      * ```js
@@ -104,9 +99,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
     /**
      * 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', {
@@ -120,12 +115,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * 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 in Early Access from 9.12 forward).
+     * `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
-     * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
      *
      * @example
      * ```js
@@ -140,13 +136,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * 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 in Early Access from 9.12 forward).
-     *
+     * `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
-     * @version SDK: 1.2.0 | Thoughtspot: 9.4.0.cl
      *
      * @example
      * ```js
@@ -167,7 +163,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
      *
      * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
-     *
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
@@ -185,7 +180,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * 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', {
@@ -214,7 +208,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * 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', {
@@ -237,10 +230,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
     liveboardV2?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
-     * @default true
      *
+     * @default true
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
-     *
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
@@ -255,7 +247,6 @@ 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', {
@@ -278,7 +269,6 @@ 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', {
@@ -293,7 +283,6 @@ 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', {
@@ -308,7 +297,6 @@ 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', {
@@ -322,7 +310,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * Flag to control new Modular Home experience.
      *
      * @default false
-     * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
      *
      * @example
      * ```js

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,28 +10,27 @@
  */
 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 {
-    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> = {
@@ -175,7 +174,6 @@ function backwardCompat(embedConfig: EmbedConfig): EmbedConfig {
  */
 export const init = (embedConfig: EmbedConfig): AuthEventEmitter => {
     sanity(embedConfig);
-    resetCachedAuthToken();
     embedConfig = setEmbedConfig(
         backwardCompat({
             ...CONFIG_DEFAULTS,

package/src/embed/liveboard.ts

@@ -11,16 +11,9 @@
 
 import { ERROR_MESSAGE } from '../errors';
 import {
-    EmbedEvent,
-    MessagePayload,
-    Param,
-    RuntimeFilter,
-    DOMSelector,
-    HostEvent,
-    ViewConfig,
+    DOMSelector, EmbedEvent, HostEvent, MessagePayload, Param, ViewConfig,
 } from '../types';
 import { getQueryParamString, isUndefined } from '../utils';
-import { getAuthPromise } from './base';
 import { V1Embed } from './ts-embed';
 
 /**
@@ -44,7 +37,6 @@ 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', {
@@ -73,7 +65,6 @@ 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', {
@@ -81,7 +72,6 @@ export interface LiveboardViewConfig
      *    enableVizTransformations:true,
      * })
      * ```
-     *
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
      */
     enableVizTransformations?: boolean;
@@ -108,7 +98,6 @@ 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', {
@@ -138,7 +127,6 @@ 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', {
@@ -188,7 +176,6 @@ 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', {
@@ -214,9 +201,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', {
@@ -228,9 +215,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,24 +7,20 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 
+import { getReleaseVersion } from '../auth';
+import { ERROR_MESSAGE } from '../errors';
 import {
-    DataSourceVisualMode,
-    DOMSelector,
-    Param,
-    Action,
-    ViewConfig,
+    Action, DOMSelector, DataSourceVisualMode, Param, 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.
@@ -63,7 +59,6 @@ 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', {
@@ -77,7 +72,6 @@ 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', {
@@ -93,7 +87,6 @@ export interface SearchViewConfig
      * using raw answer data.
      *
      * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -103,11 +96,14 @@ 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', {
@@ -122,7 +118,6 @@ 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', {
@@ -136,7 +131,6 @@ export interface SearchViewConfig
      * Only a single data source is supported currently.
      *
      * @deprecated Use `dataSource` instead.
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -150,7 +144,6 @@ 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', {
@@ -192,7 +185,6 @@ 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', {
@@ -207,7 +199,6 @@ 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', {
@@ -222,7 +213,6 @@ export interface SearchViewConfig
      *
      * @default false
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-     *
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -283,6 +273,7 @@ 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,
-    SearchEmbed,
-    PinboardEmbed,
-    LiveboardViewConfig,
-    AppEmbed,
     LiveboardEmbed,
+    LiveboardViewConfig,
+    PinboardEmbed,
+    SearchEmbed,
+    init,
 } from '../index';
+import * as mixpanelInstance from '../mixpanel-service';
+import { MIXPANEL_EVENT } from '../mixpanel-service';
 import {
-    Action, HomeLeftNavItem, RuntimeFilter, RuntimeFilterOp, HomepageModule, HostEvent,
-} from '../types';
-import {
+    createRootEleForEmbed,
+    defaultParamsForPinboardEmbed,
     executeAfterWait,
+    expectUrlMatchesWithParams,
     getDocumentBody,
     getIFrameEl,
     getIFrameSrc,
     getRootEl,
+    mockMessageChannel,
     postMessageToParent,
-    defaultParamsForPinboardEmbed,
     waitFor,
-    expectUrlMatchesWithParams,
-    mockMessageChannel,
-    createRootEleForEmbed,
 } from '../test/test-utils';
-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 {
+    Action, HomeLeftNavItem, HomepageModule, RuntimeFilter, RuntimeFilterOp,
+} from '../types';
 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: {
@@ -418,8 +418,10 @@ describe('Unit test case for ts embed', () => {
                     authToken: '',
                     hostConfig: undefined,
                     runtimeFilterParams: null,
-                    hiddenHomeLeftNavItems:
-                        [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
+                    hiddenHomeLeftNavItems: [
+                        HomeLeftNavItem.Home,
+                        HomeLeftNavItem.MonitorSubscription,
+                    ],
                     hiddenHomepageModules: [],
                     reorderedHomepageModules: [],
                 },
@@ -648,7 +650,10 @@ 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(),
@@ -705,7 +710,10 @@ 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 = {
@@ -1209,7 +1217,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`,
             );
         });
 
@@ -1225,7 +1233,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 () => {
@@ -1240,7 +1248,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 () => {
@@ -1257,7 +1265,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`,
             );
         });