@thoughtspot/visual-embed-sdk 1.28.0-alpha.1 → 1.28.0-alpha.3

package/lib/src/visual-embed-sdk.d.ts

@@ -24,7 +24,8 @@ declare module '@thoughtspot/visual-embed-sdk' {
     import { AnswerService, SessionInterface, UnderlyingDataPoint } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
     import { getEmbedConfig } from '@thoughtspot/visual-embed-sdk/embed/embedConfig';
     import { uploadMixpanelEvent, MIXPANEL_EVENT } from '@thoughtspot/visual-embed-sdk/mixpanel-service';
-    export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, VizPoint, CustomActionPayload, };
+    import { tokenizedFetch } from '@thoughtspot/visual-embed-sdk/tokenizedFetch';
+    export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, VizPoint, CustomActionPayload, };
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/app' {
@@ -91,8 +92,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * 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).
+                *
                 * @default false
-                * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+                * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
                 */
             hideHomepageLeftNav?: boolean;
             /**
@@ -103,11 +108,21 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
             /**
                 * 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).
+                *
                 */
             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 in Early Access from 9.12 forward).
+                *
                 */
             hideOrgSwitcher?: boolean;
             /**
@@ -194,10 +209,10 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 */
             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.27.9 | Thoughtspot: 9.12.0.cl
                 */
             modularHomeExperience?: boolean;
             /**
@@ -266,7 +281,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * @param renderOptions An object containing the page ID
                 * to be embedded.
                 */
-            render(): AppEmbed;
+            render(): Promise<AppEmbed>;
     }
 }
 
@@ -434,6 +449,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             /**
                 * If set to true, the embedded object container dynamically resizes
                 * according to the height of the Liveboard.
+                * **Note**:  Using fullHeight loads all visualizations on the
+                * Liveboard simultaneously, which results in multiple warehouse
+                * queries and potentially a longer wait for the topmost
+                * visualizations to display on the screen.
+                * Setting `fullHeight` to `false` fetches visualizations
+                * incrementally as users scroll the page to view the charts and tables.
                 *
                 * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
                 */
@@ -592,7 +613,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * @param renderOptions An object specifying the Liveboard ID,
                 * visualization ID and the runtime filters.
                 */
-            render(): LiveboardEmbed;
+            render(): Promise<LiveboardEmbed>;
             navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
     }
     /**
@@ -752,7 +773,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             /**
                 * Render the embedded ThoughtSpot search
                 */
-            render(): SearchEmbed;
+            render(): Promise<SearchEmbed>;
     }
 }
 
@@ -820,7 +841,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
             /**
                 * Render the embedded ThoughtSpot search
                 */
-            render(): SearchBarEmbed;
+            render(): Promise<SearchBarEmbed>;
     }
 }
 
@@ -909,7 +930,22 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
                 *
                 * @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;
     }
     /**
         * Events which can be triggered on the emitter returned from {@link init}.
@@ -1145,6 +1181,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *      .then((response) => response.json())
                 *      .then((data) => data.token);
                 *  }
+                * });
                 * ```
                 */
             TrustedAuthToken = "AuthServer",
@@ -1178,15 +1215,30 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Basic = "Basic"
     }
     export enum HomeLeftNavItem {
-            QueryBuilder = "query-builder",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
+            SearchData = "search-data",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
             Home = "insights-home",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
             Liveboards = "liveboards",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
             Answers = "answers",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
             MonitorSubscription = "monitor-alerts",
-            SpotIQAnalysis = "spotiq-analysis",
-            Tutorials = "tutorials",
-            Documentation = "documentation",
-            Community = "community"
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
+            SpotIQAnalysis = "spotiq-analysis"
     }
     export type DOMSelector = string | HTMLElement;
     /**
@@ -1242,6 +1294,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
     /**
         * Configuration to define the customization on the Embedded
         * Thoughtspot components.
+        * You can customize styles, text strings, and icons.
+        * For more information, see https://developers.thoughtspot.com/docs/custom-css.
         *
         * @example
         * ```js
@@ -1256,7 +1310,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
         *     },
         *     content: {
         *      strings: {
-        *        'LIVEBOARDS': 'Dashboards'
+        *        'LIVEBOARDS': 'Dashboards',
+        *        'ANSWERS': 'Visualizations',
+        *        'Edit': 'Modify',
+        *        'Show underlying data': 'Show source data',
+        *        'SpotIQ': 'Insights',
+        *        'Monitor': 'Alerts',
         *      }
         *     },
         *     iconSpriteUrl: 'https://my-custom-icon-sprite.svg'
@@ -1288,12 +1347,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * The ThoughtSpot cluster hostname or IP address.
                 */
             thoughtSpotHost: string;
-            /**
-                * If true, all the iframe links will have /v2 added automatically.
-                * If false, all the iframe links will have /v1 added automatically.
-                * If undefined, nothing will be added
-                */
-            enableReactShell?: boolean | undefined;
             /**
                 * The authentication mechanism to use.
                 */
@@ -1538,6 +1591,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
                 */
             logLevel?: LogLevel;
+            /**
+                * Disables the Mixpanel tracking from the SDK.
+                *
+                * @version SDK: 1.27.9
+                */
+            disableSDKTracking?: boolean;
     }
     export interface LayoutConfig {
     }
@@ -1715,9 +1774,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             usePrerenderedIfAvailable?: boolean;
             /**
                 * Boolean to exclude runtimeFilters in the URL
+                * By default it is true, this flag removes runtime filters from the URL
+                * when set to false, runtime filters will be included in the URL.
                 *
-                * @default false
-                * @hidden
+                * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
+                * embedded view.
+                *
+                * @default true
+                * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
                 */
             excludeRuntimeFiltersfromURL?: boolean;
             /**
@@ -1739,16 +1803,24 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             hiddenTabs?: string[];
             /**
                 * Hide the home page modules
-                * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+                * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
+                *
+                * **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).
                 *
-                * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+                * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
                 */
             hiddenHomepageModules?: HomepageModule[];
             /**
                 * reordering the home page modules
                 * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
                 *
-                * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
+                * **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.0.cl onwards).
+                *
+                * @version SDK: 1.27.9| Thoughtspot: 9.12.0.cl
                 */
             reorderedHomepageModules?: HomepageModule[];
             /**
@@ -1775,7 +1847,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
                 * ```
                 *
-                * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
+                * **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).
+                *
+                * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
                 */
             hiddenHomeLeftNavItems?: HomeLeftNavItem[];
             /**
@@ -1951,6 +2027,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             MyLibrary = "MY_LIBRARY",
             /**
                 * Trending list
+                *
+                * **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.0.cl onwards).
                 */
             Trending = "TRENDING",
             /**
@@ -2089,7 +2169,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @returns nonFilteredColumns - The columns that were not filtered
                 * @example
                 *```js
-                * searchEmbed.trigger(HostEvent.DrillDown, {
+                * searchEmbed.trigger(EmbedEvent.DrillDown, {
                 *    points: {
                 *        clickedPoint,
                 *        selectedPoints: selectedPoint
@@ -2181,7 +2261,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @important
                 * @example
                 * ```js
-                * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
+                * embed.on(EmbedEvent.VizPointClick, ({data}) => {
                 *   console.log(
                 *    data.vizId, // viz id
                 *    data.clickedPoint.selectedAttributes[0].value,
@@ -2194,15 +2274,41 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             VizPointClick = "vizPointClick",
             /**
-                * An error has occurred.
+                * An error has occurred. This event is fired for the following error types:
+                *
+                *  API - API call failure error.
+                *
+                *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
+                *
+                *  SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
+                *
+                *  NON_EXIST_FILTER - Error due to a non-existent filter.
+                *
+                *  INVALID_DATE_VALUE - Invalid date value error.
+                *
+                *  INVALID_OPERATOR - Use of invalid operator during filter application.
+                *
+                *  For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
                 *
                 * @returns error - An error object or message
                 * @example
                 * ```js
-                * SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
-                * //show error messaage
-                *  function showErrorMsg() {
-                *    document.getElementById("error");
+                * // API error
+                * SearchEmbed.on(EmbedEvent.Error, (error) => {
+                *   console.log(error);
+                *  // { type: "Error", data: { errorType: "API", error: { message: '...', error: '...' } } }
+                * });
+                * ```
+                * @example
+                * ```js
+                * // Fullscreen error (Errors during presenting of a liveboard)
+                * LiveboardEmbed.on(EmbedEvent.Error, (error) => {
+                *   console.log(error);
+                *   // { type: "Error", data: { errorType: "FULLSCREEN", error: {
+                *   //   message: "Fullscreen API is not enabled",
+                *   //   stack: "..."
+                *   // } }}
+                * })
                 * ```
                 */
             Error = "Error",
@@ -2748,7 +2854,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.Delete,
+                * liveboardEmbed.trigger(EmbedEvent.Delete,
                 *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -2759,7 +2865,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.SchedulesList)
+                * liveboardEmbed.trigger(EmbedEvent.SchedulesList)
                 *```
                 */
             SchedulesList = "schedule-list",
@@ -2769,7 +2875,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.Cancel)
+                * liveboardEmbed.trigger(EmbedEvent.Cancel)
                 *```
                 */
             Cancel = "cancel",
@@ -2779,7 +2885,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.Explore,  {
+                * liveboardEmbed.trigger(EmbedEvent.Explore,  {
                 *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -2790,7 +2896,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.CopyLink, {
+                * liveboardEmbed.trigger(EmbedEvent.CopyLink, {
                 *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -2912,7 +3018,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Emitted when a LB/viz is renamed
                 *
-                * @version SDK : 1.28.0 | ThoughtSpot: 9.11.0.cl
+                * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
                 */
             Rename = "rename"
     }
@@ -3059,10 +3165,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * _String_. The name of the column to filter on.
                 * `operator`
                 *  Runtime filter operator to apply. For information,
-                *  see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+                *  see https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator.
                 * `values`
                 *  List of operands. Some operators such as EQ, LE allow a single value, whereas
                 *  operators such as BW and IN accept multiple operands.
+                *  **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
+                *  Search embedding (SearchEmbed) and Natural Language Search
+                *  embedding (SageEmbed).
                 *
                 * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
                 * @example
@@ -3585,22 +3694,24 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             ResetSearch = "resetSearch",
             /**
-                * @hidden
+                *
                 * Get the currents visible and runtime filters applied on a Liveboard
+                *
                 * @example
                 * liveboardEmbed.trigger(HostEvent.GetFilters)
                 * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
                 */
             GetFilters = "getFilters",
             /**
-                * @hidden
+                *
                 * Update the visible filters on the Liveboard.
+                *
                 * @param - filter: filter object containing column name and filter operation and values
                 * @example
                 *
                 * ```js
                 * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
-                *  filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
+                *  filter: { column: 'column name', oper: 'IN', values: [1,2,3], is_mandatory: false }
                 * })
                 * ```
                 * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -3686,7 +3797,33 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
                 */
-            AskSage = "AskSage"
+            AskSage = "AskSage",
+            /**
+                * Trigger UpdateCrossFilter for Liveboard
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
+                *      vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e',
+                *      conditions: [
+                *      { columnName: 'Category', values: ['mfgr#12','mfgr#14'] },
+                *      { columnName: 'color', values: ['mint','hot'] },
+                *    ],
+                * });
+                * ```
+                * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
+                */
+            UpdateCrossFilter = "UpdateCrossFilter",
+            /**
+                * Trigger ResetLiveboardPersonalisedView for Liveboard
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
+                * ```
+                * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+                */
+            ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
     }
     /**
         * The different visual modes that the data sources panel within
@@ -4651,7 +4788,47 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 *  @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
                 */
-            AskAi = "AskAi"
+            AskAi = "AskAi",
+            /**
+                * The **Add KPI to Watchlist** action on Home page watchlist.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.AddToWatchlist]
+                * ```
+                * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+                */
+            AddToWatchlist = "addToWatchlist",
+            /**
+                * The **Remove from watchlist** menu action on KPI watchlist.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.RemoveFromWatchlist]
+                * ```
+                * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+                */
+            RemoveFromWatchlist = "removeFromWatchlist",
+            /**
+                * The **Copy KPI Link** menu action on KPI watchlist.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.CopyKpiLink]
+                * ```
+                * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+                */
+            CopyKpiLink = "copyKpiLink",
+            /**
+                * Action ID for AI Highlights button
+                *
+                *  @example
+                * ```js
+                * hiddenAction: [Action.AIHighlights]
+                * ```
+                *  @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
+                */
+            AIHighlights = "AIHighlights"
     }
     export interface AnswerServiceType {
             getAnswer?: (offset: number, batchSize: number) => any;
@@ -5297,7 +5474,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
                 *
                 * @returns {SageEmbed} Eureka/Sage embed
                 */
-            render(): SageEmbed;
+            render(): Promise<SageEmbed>;
     }
 }
 
@@ -5485,6 +5662,19 @@ declare module '@thoughtspot/visual-embed-sdk/mixpanel-service' {
     export function testResetMixpanel(): void;
 }
 
+declare module '@thoughtspot/visual-embed-sdk/tokenizedFetch' {
+    /**
+      * Fetch wrapper that adds the authentication token to the request.
+      * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
+      *
+      * @param input
+      * @param init
+      * @version SDK: 1.28.0
+      * @group Global methods
+      */
+    export const tokenizedFetch: typeof fetch;
+}
+
 declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
     /**
         * Copyright (c) 2022
@@ -5680,7 +5870,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 *
                 * @param args
                 */
-            render(): TsEmbed;
+            render(): Promise<TsEmbed>;
             getIframeSrc(): string;
             protected handleRenderForPrerender(): void;
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.28.0-alpha.1",
+    "version": "1.28.0-alpha.3",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

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

@@ -14,6 +14,7 @@ import {
 } 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);
     }
 };