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

package/dist/visual-embed-sdk-react-full.d.ts

@@ -234,7 +234,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-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, };
+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, };
 
 /**
     * @group Embed components
@@ -296,7 +296,7 @@ export declare class SearchBarEmbed extends TsEmbed {
         /**
             * Render the embedded ThoughtSpot search
             */
-        render(): SearchBarEmbed;
+        render(): Promise<SearchBarEmbed>;
 }
 
 /**
@@ -458,7 +458,7 @@ export declare class SageEmbed extends V1Embed {
             *
             * @returns {SageEmbed} Eureka/Sage embed
             */
-        render(): SageEmbed;
+        render(): Promise<SageEmbed>;
 }
 
 /**
@@ -608,7 +608,7 @@ export declare class SearchEmbed extends TsEmbed {
         /**
             * Render the embedded ThoughtSpot search
             */
-        render(): SearchEmbed;
+        render(): Promise<SearchEmbed>;
 }
 
 /**
@@ -672,8 +672,12 @@ 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).
+            *
             * @default false
-            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
             */
         hideHomepageLeftNav?: boolean;
         /**
@@ -684,11 +688,21 @@ 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).
+            *
             */
         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;
         /**
@@ -775,10 +789,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         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;
         /**
@@ -847,7 +861,7 @@ export declare class AppEmbed extends V1Embed {
             * @param renderOptions An object containing the page ID
             * to be embedded.
             */
-        render(): AppEmbed;
+        render(): Promise<AppEmbed>;
 }
 
 /**
@@ -869,6 +883,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         /**
             * 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
             */
@@ -1027,7 +1047,7 @@ export declare class LiveboardEmbed extends V1Embed {
             * @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;
 }
 /**
@@ -1274,7 +1294,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;
 }
 /**
     * Events which can be triggered on the emitter returned from {@link init}.
@@ -1506,6 +1541,7 @@ export declare enum AuthType {
             *      .then((response) => response.json())
             *      .then((data) => data.token);
             *  }
+            * });
             * ```
             */
         TrustedAuthToken = "AuthServer",
@@ -1539,15 +1575,30 @@ export declare enum AuthType {
         Basic = "Basic"
 }
 export declare 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;
 /**
@@ -1603,6 +1654,8 @@ export interface CustomStyles {
 /**
     * 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
@@ -1617,7 +1670,12 @@ export interface CustomStyles {
     *     },
     *     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'
@@ -1649,12 +1707,6 @@ export interface EmbedConfig {
             * 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.
             */
@@ -1899,6 +1951,12 @@ export interface EmbedConfig {
             * @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 {
 }
@@ -2076,9 +2134,14 @@ export interface ViewConfig {
         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;
         /**
@@ -2100,16 +2163,24 @@ export interface ViewConfig {
         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[];
         /**
@@ -2136,7 +2207,11 @@ export interface ViewConfig {
             * 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[];
         /**
@@ -2312,6 +2387,10 @@ export declare enum HomepageModule {
         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",
         /**
@@ -2450,7 +2529,7 @@ export declare enum EmbedEvent {
             * @returns nonFilteredColumns - The columns that were not filtered
             * @example
             *```js
-            * searchEmbed.trigger(HostEvent.DrillDown, {
+            * searchEmbed.trigger(EmbedEvent.DrillDown, {
             *    points: {
             *        clickedPoint,
             *        selectedPoints: selectedPoint
@@ -2542,7 +2621,7 @@ export declare enum EmbedEvent {
             * @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,
@@ -2555,15 +2634,41 @@ export declare enum EmbedEvent {
             */
         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",
@@ -3109,7 +3214,7 @@ export declare enum EmbedEvent {
             * @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'})
             *```
             */
@@ -3120,7 +3225,7 @@ export declare enum EmbedEvent {
             * @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",
@@ -3130,7 +3235,7 @@ export declare enum EmbedEvent {
             * @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",
@@ -3140,7 +3245,7 @@ export declare enum EmbedEvent {
             * @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'})
             *```
             */
@@ -3151,7 +3256,7 @@ export declare enum EmbedEvent {
             * @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'})
             *```
             */
@@ -3273,7 +3378,7 @@ export declare enum EmbedEvent {
         /**
             * 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"
 }
@@ -3420,10 +3525,13 @@ export declare enum HostEvent {
             * _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
@@ -3946,22 +4054,24 @@ export declare enum HostEvent {
             */
         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
@@ -4047,7 +4157,33 @@ export declare enum HostEvent {
             * ```
             * @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
@@ -5012,7 +5148,47 @@ export declare enum Action {
             * ```
             *  @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;
@@ -5669,6 +5845,17 @@ export declare function initMixpanel(sessionInfo: any): void;
     */
 export declare function testResetMixpanel(): void;
 
+/**
+  * 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 declare const tokenizedFetch: typeof fetch;
+
 /**
     * Copyright (c) 2022
     *
@@ -5861,7 +6048,7 @@ export declare class TsEmbed {
             *
             * @param args
             */
-        render(): TsEmbed;
+        render(): Promise<TsEmbed>;
         getIframeSrc(): string;
         protected handleRenderForPrerender(): void;
         /**