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

package/src/types.ts

@@ -146,6 +146,7 @@ export enum AuthType {
      *      .then((data) => data.token);
      *  }
      * });
+     * });
      * ```
      */
     TrustedAuthToken = 'AuthServer',
@@ -178,17 +179,40 @@ export enum AuthType {
      */
     Basic = 'Basic',
 }
+/**
+ *
+ * This option does not apply to the classic homepage experience.
+ * To access the updated modular homepage,
+ * set `modularHomeExperience` to `true`
+ * (available as Early Access feature in 9.12.5.cl).
+ *
+ */
 
 export enum HomeLeftNavItem {
-    QueryBuilder = 'query-builder',
+    /**
+     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     */
+    SearchData = 'search-data',
+    /**
+     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     */
     Home = 'insights-home',
+    /**
+     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     */
     Liveboards = 'liveboards',
+    /**
+     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     */
     Answers = 'answers',
+    /**
+     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     */
     MonitorSubscription = 'monitor-alerts',
+    /**
+     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     */
     SpotIQAnalysis = 'spotiq-analysis',
-    Tutorials = 'tutorials',
-    Documentation = 'documentation',
-    Community = 'community',
 }
 export type DOMSelector = string | HTMLElement;
 
@@ -247,6 +271,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
@@ -261,7 +287,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'
@@ -294,12 +325,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.
      */
@@ -471,6 +496,7 @@ export interface EmbedConfig {
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
      */
     suppressSearchEmbedBetaWarning?: boolean;
+
     /**
      * Hide `beta` alert warning message for SageEmbed.
      *
@@ -562,10 +588,16 @@ 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;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface LayoutConfig { }
+export interface LayoutConfig {}
 
 /**
  * Embedded iframe configuration
@@ -603,8 +635,20 @@ export interface ViewConfig {
      */
     layoutConfig?: LayoutConfig;
     /**
-     * The <b>width</b> and <b>height</b> dimensions to render an embedded
+     * The width and height dimensions to render an embedded
      * object inside your app.  Specify the values in pixels or percentage.
+     *
+     * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   frameParams: {
+     *     width: '500px' | '50%',
+     *      height: '400px' | '60%',
+     *   },
+     * });
+     * ```
      */
     frameParams?: FrameParams;
     /**
@@ -622,6 +666,7 @@ export interface ViewConfig {
      * for the user.
      * Use this to disable actions.
      *
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -633,6 +678,16 @@ export interface ViewConfig {
     disabledActions?: Action[];
     /**
      * The tooltip to display for disabled actions.
+     *
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   disabledActions: [Action.Download, Action.Save]
+     *   disabledActionReason: "Reason for disabling",
+     * });
+     * ```
      */
     disabledActionReason?: string;
     /**
@@ -640,6 +695,7 @@ export interface ViewConfig {
      * This actions will be hidden from the user.
      * Use this to hide an action.
      *
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -660,17 +716,46 @@ export interface ViewConfig {
      *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @important
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   visibleActions: [Action.Download, Action.Export]
+     * });
+     * ```
      */
     visibleActions?: Action[];
     /**
      * Show alert messages and toast messages in the embedded view.
      *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    showAlerts:true,
+     * })
+     * ```
      */
     showAlerts?: boolean;
     /**
      * The list of runtime filters to apply to a search answer,
      * visualization, or Liveboard.
+     *
+     * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    runtimeFilters: [
+     *           {
+     *             columnName: 'value',
+     *              operator: RuntimeFilterOp.EQ,
+     *             values: ['string' | 123 | true],
+     *           },
+     *       ],
+     * })
+     * ```
      */
     runtimeFilters?: RuntimeFilter[];
     /**
@@ -678,12 +763,31 @@ export interface ViewConfig {
      * visualization, or Liveboard.
      *
      * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    runtimeParameters: [
+     *     {
+     *       name: 'value',
+     *       value: 'string' | 123 | true,
+     *     },
+     *   ],
+     * })
+     * ```
      */
     runtimeParameters?: RuntimeParameter[];
     /**
      * The locale/language to use for the embedded view.
      *
      * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    locale:'en',
+     * })
+     * ```
      */
     locale?: string;
     /**
@@ -694,6 +798,16 @@ export interface ViewConfig {
      * to control embed behavior in non-regular ways. We do not publish the
      * list of supported keys and values associated with each.
      *
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   additionalFlags: {
+     *        flag1: 'value1',
+     *        flag2: 'value2'
+     *     }
+     * });
+     * ```
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      */
     additionalFlags?: { [key: string]: string | number | boolean };
@@ -708,18 +822,41 @@ export interface ViewConfig {
     /**
      * Insert as a sibling of the target container, instead of appending to a
      * child inside it.
+     *
+     * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    insertAsSibling:true,
+     * })
+     * ```
      */
     insertAsSibling?: boolean;
     /**
      * flag to set ContextMenu Trigger to either left or right click.
      *
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... // other options
+     *    contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
+     * })
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     contextMenuTrigger?: ContextMenuTriggerOptions;
     /**
-     * flag to override openNew tab context menu link
+     * Flag to override openNew tab context menu link
      *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    linkOverride:false,
+     * })
+     * ```
      */
     linkOverride?: boolean;
     /**
@@ -741,9 +878,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;
     /**
@@ -765,16 +907,42 @@ export interface ViewConfig {
     hiddenTabs?: string[];
     /**
      * Hide the home page modules
-     * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+     * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
      *
-     * @version SDK: 1.27.0 | Thoughtspot: 9.12.0.cl
+     *
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.0.cl).
+     *
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
+     * })
+     * ```
      */
     hiddenHomepageModules?: HomepageModule[];
     /**
      * reordering the home page modules
      * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
      *
-     * @version SDK: 1.28.0 | Thoughtspot: 9.12.0.cl
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
+     * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
+     * })
+     * ```
      */
     reorderedHomepageModules?: HomepageModule[];
     /**
@@ -783,13 +951,17 @@ export interface ViewConfig {
      *
      * Use either `visibleTabs` or `hiddenTabs`.
      *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @example
      * ```js
-     * visibleTabs: [
-     * '430496d6-6903-4601-937e-2c691821af3c',
-     * 'f547ec54-2a37-4516-a222-2b06719af726']
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    visibleTabs: [
+     *       '430496d6-6903-4601-937e-2c691821af3c',
+     *       'f547ec54-2a37-4516-a222-2b06719af726'
+     *     ]
+     * })
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     visibleTabs?: string[];
     /**
@@ -797,11 +969,22 @@ export interface ViewConfig {
      * There are 8 eight home navigation list items.
      * To hide these items, specify the string in the array.
      *
+     * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
+     * @example
      * ```js
-     * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
+     * })
      * ```
      *
-     * @version SDK: 1.27.0 | Thoughtspot: 9.12.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.28.0 | Thoughtspot: 9.12.5.cl
      */
     hiddenHomeLeftNavItems?: HomeLeftNavItem[];
     /**
@@ -829,7 +1012,9 @@ export interface ViewConfig {
      *
      * @type {boolean}
      * @default false
+     * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
      * @example
+     * ```js
      * // Disable tracking PreRender size in the configuration
      * const config = {
      *   doNotTrackPreRenderSize: true,
@@ -837,6 +1022,7 @@ export interface ViewConfig {
      *
      * // Instantiate an object with the configuration
      * const myComponent = new MyComponent(config);
+     * ```
      */
     doNotTrackPreRenderSize?: boolean;
     /**
@@ -970,7 +1156,12 @@ export enum RuntimeFilterOp {
 }
 
 /**
- * Home page module that can be hidden
+ * Home page module that can be hidden.
+ * **Note**: This option does not apply to the classic homepage.
+ * To access the updated modular homepage, set
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+ *
+ * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
  */
 // eslint-disable-next-line no-shadow
 export enum HomepageModule {
@@ -1133,7 +1324,7 @@ export enum EmbedEvent {
      * @returns nonFilteredColumns - The columns that were not filtered
      * @example
      *```js
-     * searchEmbed.trigger(HostEvent.DrillDown, {
+     * searchEmbed.trigger(EmbedEvent.DrillDown, {
      *    points: {
      *        clickedPoint,
      *        selectedPoints: selectedPoint
@@ -1225,7 +1416,7 @@ export 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,
@@ -1240,19 +1431,21 @@ export enum EmbedEvent {
     /**
      * An error has occurred. This event is fired for the following error types:
      *
-     *  `API` - API call failure error.
+     *  API - API call failure error.
      *
-     *  `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
+     *  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.
+     *  SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
      *
-     *  `NON_EXIST_FILTER` - Error due to a non-existent filter.
+     *  NON_EXIST_FILTER - Error due to a non-existent filter.
      *
-     *  `INVALID_DATE_VALUE` - Invalid date value error.
+     *  INVALID_DATE_VALUE - Invalid date value error.
      *
-     *  `INVALID_OPERATOR` - Use of invalid operator during filter application.
+     *  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
@@ -1817,7 +2010,7 @@ export 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'})
      *```
      */
@@ -1828,7 +2021,7 @@ export 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',
@@ -1838,7 +2031,7 @@ export 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',
@@ -1848,7 +2041,7 @@ export 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'})
      *```
      */
@@ -1859,7 +2052,7 @@ export 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'})
      *```
      */
@@ -2130,10 +2323,13 @@ export 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
@@ -2658,6 +2854,7 @@ export enum HostEvent {
     /**
      *
      * 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
@@ -2666,12 +2863,13 @@ export enum HostEvent {
     /**
      *
      * 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
@@ -2758,6 +2956,32 @@ export enum HostEvent {
      * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
      */
     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',
 }
 
 /**
@@ -3736,6 +3960,7 @@ export enum Action {
 
     /**
      * The **Add KPI to Watchlist** action on Home page watchlist.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddToWatchlist]
@@ -3746,6 +3971,7 @@ export enum Action {
 
     /**
      * The **Remove from watchlist** menu action on KPI watchlist.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RemoveFromWatchlist]
@@ -3756,6 +3982,7 @@ export enum Action {
 
     /**
      * The **Copy KPI Link** menu action on KPI watchlist.
+     *
      * @example
      * ```js
      * disabledActions: [Action.CopyKpiLink]
@@ -3763,6 +3990,17 @@ export enum Action {
      * @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 {
@@ -3792,15 +4030,15 @@ export interface ColumnValue {
         [key: string]: any;
     };
     value:
-    | string
-    | number
-    | boolean
-    | {
-        v: {
-            s: number;
-            e: number;
-        };
-    };
+        | string
+        | number
+        | boolean
+        | {
+              v: {
+                  s: number;
+                  e: number;
+              };
+          };
 }
 
 export interface VizPoint {