@thoughtspot/visual-embed-sdk 1.36.1 → 1.36.3

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

@@ -927,6 +927,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```
             */
         disableProfileAndHelp?: boolean;
+        /**
+            * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
+            * @default true
+            * Whether the help menu in the top nav bar should be served
+            * from Pendo or ThoughtSpot's internal help items.
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *   ... // other options
+            *  enablePendoHelp: false,
+            * });
+            * ```
+            */
+        enablePendoHelp?: boolean;
         /**
             * Control the visibility of the application switcher button on the nav-bar.
             * By default, the application switcher is shown.
@@ -1568,7 +1582,10 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showPreviewLoader?: boolean;
         /**
-            * This flag is used to enable the compact header on a Liveboard
+            * Enables or disables the compact header feature on a Liveboard.
+            * Compact Liveboard header is turned off by default on Liveboards in
+            * ThoughtSpot Embedded apps.
+            *
             * @type {boolean}
             * @default false
             * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -2061,9 +2078,9 @@ export type DOMSelector = string | HTMLElement;
 export interface customCssInterface {
         /**
             * The custom css variables, which can be set.
-            * The allowed list is in the CustomCssVariables
+            * The variables are available in the {@link CustomCssVariables}
             * interface. For more information, see
-            * link:https://developers.thoughtspot.com/docs/css-variables-reference
+            * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
             */
         variables?: CustomCssVariables;
         /**
@@ -2590,7 +2607,7 @@ export interface ViewConfig {
             */
         showAlerts?: boolean;
         /**
-            * The list of runtime filters to apply to a search answer,
+            * 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
@@ -2609,7 +2626,7 @@ export interface ViewConfig {
             */
         runtimeFilters?: RuntimeFilter[];
         /**
-            * The list of parameter override to apply to a search answer,
+            * The list of parameter override to apply to a search Answer,
             * visualization, or Liveboard.
             * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
             * @example
@@ -2627,7 +2644,7 @@ export interface ViewConfig {
             */
         runtimeParameters?: RuntimeParameter[];
         /**
-            * The locale/language to use for the embedded view.
+            * The locale settings to apply to the embedded view.
             * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
             * @example
             * ```js
@@ -2694,7 +2711,7 @@ export interface ViewConfig {
             */
         contextMenuTrigger?: ContextMenuTriggerOptions;
         /**
-            * Flag to override openNew tab context menu link
+            * Flag to override the *Open Link in New Tab* context menu option.
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
             * @example
             * ```js
@@ -2833,7 +2850,7 @@ export interface ViewConfig {
             */
         preRenderId?: string;
         /**
-            * Determines whether the PreRender component should not dynamically track the size
+            * Determines if the PreRender component should dynamically track the size
             * of its embedding element and adjust its own size accordingly.
             * Enabling this option allows the PreRender component to automatically adapt
             * its dimensions based on changes to the size of the embedding element.
@@ -3205,8 +3222,8 @@ export declare enum EmbedEvent {
             */
         Load = "load",
         /**
-            * Data pertaining to answer or Liveboard is received
-            * @return data - The answer or Liveboard data
+            * Data pertaining to an Answer or Liveboard is received
+            * @return data - The Answer or Liveboard data
             * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             *```js
@@ -3380,7 +3397,7 @@ export declare enum EmbedEvent {
             */
         Alert = "alert",
         /**
-            * The ThoughtSpot auth session has expired.
+            * The ThoughtSpot authentication session has expired.
             * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
             * @example
             *```js
@@ -3450,7 +3467,7 @@ export declare enum EmbedEvent {
         /**
             * Emitted when the embed does not have cookie access. This happens
             * when Safari and other Web browsers block third-party cookies
-            * are blocked by default. `NoCookieAccess` can trigger
+            * are blocked by default. `NoCookieAccess` can trigger.
             * @example
             *```js
             * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -3538,7 +3555,7 @@ export declare enum EmbedEvent {
             */
         Save = "save",
         /**
-            * Emitted when the download action is triggered on an answer
+            * Emitted when the download action is triggered on an Answer.
             *
             * **Note**: This event is deprecated in v1.21.0.
             * To fire an event when a download action is initiated on a chart or table,
@@ -3554,7 +3571,7 @@ export declare enum EmbedEvent {
             */
         Download = "download",
         /**
-            * Emitted when the download action is triggered on an answer
+            * Emitted when the download action is triggered on an Answer.
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
             * @example
             *```js
@@ -3568,7 +3585,7 @@ export declare enum EmbedEvent {
             */
         DownloadAsPng = "downloadAsPng",
         /**
-            * Emitted when the Download as PDF action is triggered on an answer
+            * Emitted when the Download as PDF action is triggered on an Answer
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3582,7 +3599,7 @@ export declare enum EmbedEvent {
             */
         DownloadAsPdf = "downloadAsPdf",
         /**
-            * Emitted when the Download as CSV action is triggered on an answer
+            * Emitted when the Download as CSV action is triggered on an Answer.
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3596,7 +3613,7 @@ export declare enum EmbedEvent {
             */
         DownloadAsCsv = "downloadAsCsv",
         /**
-            * Emitted when the Download as XLSX action is triggered on an answer
+            * Emitted when the Download as XLSX action is triggered on an Answer.
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3624,7 +3641,8 @@ export declare enum EmbedEvent {
             */
         AnswerDelete = "answerDelete",
         /**
-            * Emitted when an answer is pinned to a Liveboard
+            * Emitted when a user initiates the Pin action to
+            *  add an Answer to a Liveboard.
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3762,7 +3780,7 @@ export declare enum EmbedEvent {
             */
         SaveAsView = "saveAsView",
         /**
-            * Emitted when the user creates a copy of an Answer
+            * Emitted when the user creates a copy of an Answer.
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3776,7 +3794,7 @@ export declare enum EmbedEvent {
             */
         CopyAEdit = "copyAEdit",
         /**
-            * Emitted when a user clicks Show underlying data on an Answer
+            * Emitted when a user clicks *Show underlying data* on an Answer.
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3787,7 +3805,7 @@ export declare enum EmbedEvent {
             */
         ShowUnderlyingData = "showUnderlyingData",
         /**
-            * Emitted when an answer is switched to a chart or table view.
+            * Emitted when an Answer is switched to a chart or table view.
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3921,11 +3939,12 @@ export declare enum EmbedEvent {
             */
         CopyLink = "embedDocument",
         /**
-            * Emitted when a user interacts with cross filters on a visualization or Liveboard
+            * Emitted when a user interacts with cross filters on a
+            * visualization or Liveboard.
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
+            * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
             *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
             */
@@ -4019,8 +4038,8 @@ export declare enum EmbedEvent {
             */
         DeletePersonalisedView = "deletePersonalisedView",
         /**
-            * Emitted when a user creates a new worksheet
-            * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
+            * Emitted when a user creates a Worksheet.
+            * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
             */
         CreateWorksheet = "createWorksheet",
         /**
@@ -4033,8 +4052,8 @@ export declare enum EmbedEvent {
             */
         AskSageInit = "AskSageInit",
         /**
-            * Emitted when a LB/viz is renamed
-            * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
+            * Emitted when a Liveboard or visualization is renamed.
+            * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
             */
         Rename = "rename",
         /**
@@ -4098,8 +4117,7 @@ export declare enum EmbedEvent {
         OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
         /**
             * Emitted when parameter changes in an Answer
-            * or Liveboard
-            *
+            * or Liveboard.
             * ```js
             * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
             *     console.log('payload', payload);
@@ -4126,7 +4144,7 @@ export declare enum EmbedEvent {
             */
         TableVizRendered = "TableVizRendered",
         /**
-         * Emitted when the liveboard is created from pin modal or liveboard list page.
+         * Emitted when the liveboard is created from pin modal or Liveboard list page.
          * You can use this event as a hook to trigger
          * other events on liveboard creation.
          *
@@ -4269,7 +4287,7 @@ export declare enum HostEvent {
             */
         Filter = "filter",
         /**
-            * Reload the answer or visualization
+            * Reload the Answer or visualization
             * @hidden
             */
         Reload = "reload",
@@ -4319,12 +4337,10 @@ export declare enum HostEvent {
             * and `AppEmbed` only. In full application embedding, this event updates
             * the runtime filters applied on the Liveboard and saved Answer objects.
             *
-            *
-            * Pass an array of runtime filters with the following attributes:
-            *
+            * @param - Pass an array of {@link RuntimeFilter} with the following attributes:
             * `columnName` - _String_. The name of the column to filter on.
             *
-            * `operator` - Runtime filter operator to apply. For more information,
+            * `operator` - {@link RuntimeFilterOp} to apply. For more information,
             * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
             *
             * `values` - List of operands. Some operators such as EQ and LE allow a
@@ -4336,7 +4352,7 @@ export declare enum HostEvent {
             * will be cleared, restoring the original visualization
             * with the updated filters.
             *
-            * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
@@ -4575,6 +4591,11 @@ export declare enum HostEvent {
             * appEmbed.trigger(HostEvent.Remove)
             * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            * * @example
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.Remove)
+            * ```
+            * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
             */
         Remove = "delete",
         /**
@@ -4985,7 +5006,7 @@ export declare enum HostEvent {
             * ```js
             * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
             *   console.log(
-            *      tabDetails // TabDetails of current LB
+            *      tabDetails // TabDetails of current Liveboard
             *   );
             * })
             * ```
@@ -5033,7 +5054,7 @@ export declare enum HostEvent {
             */
         UpdateSageQuery = "updateSageQuery",
         /**
-            * Get the answer session for a Search or
+            * Get the Answer session for a Search or
             * Liveboard visualization.
             * @example
             * ```js
@@ -5208,6 +5229,7 @@ export declare enum Param {
         HostAppUrl = "hostAppUrl",
         EnableVizTransformations = "enableVizTransform",
         EnableSearchAssist = "enableSearchAssist",
+        EnablePendoHelp = "enablePendoHelp",
         HideResult = "hideResult",
         UseLastSelectedDataSource = "useLastSelectedSources",
         Tag = "tag",
@@ -5432,9 +5454,10 @@ export declare enum Action {
             */
         AddDataPanelObjects = "addDataPanelObjects",
         /**
-            * Filter configuration options on a Liveboard page.
-            * Allows configuring filters on a
-            * Liveboard.
+            * The filter configuration options for a Liveboard.
+            * The configuration options are available when adding
+            * filters on a Liveboard.
+            *
             * @example
             * ```js
             * disabledActions: [Action.ConfigureFilter]
@@ -5532,14 +5555,17 @@ export declare enum Action {
             * @hidden
             */
         SpotIQFollow = "spotIQFollow",
+        /**
+            * The Share action for a Liveboard visualization.
+            */
         ShareViz = "shareViz",
         /**
             * @hidden
             */
         ReplaySearch = "replaySearch",
         /**
-            * The **Show underlying data** menu action on a visualization or
-            * Answer page.
+            * The **Show underlying data** menu action on a
+            * visualization or Answer page.
             * Displays detailed information and raw data
             * for a given visualization.
             * @example
@@ -5549,8 +5575,8 @@ export declare enum Action {
             */
         ShowUnderlyingData = "showUnderlyingData",
         /**
-            * The **Download** menu action on Liveboard visualizations
-            * and Answers.
+            * The **Download** menu action on Liveboard
+            * visualizations and Answers.
             * Allows downloading a visualization or Answer.
             * @example
             * ```js
@@ -5571,11 +5597,10 @@ export declare enum Action {
         /**
             *
             *The **Download PDF** action that downloads a Liveboard,
-            *visualization, or Answer as a PDF file.
-            *
+            * visualization, or Answer as a PDF file.
             *
-            ***NOTE**: The **Download** > **PDF** action is available on
-            *visualizations and Answers if the data is in tabular format.
+            * **NOTE**: The **Download** > **PDF** option is available for
+            * tables in visualizations and Answers.
             * @example
             * ```js
             * disabledActions: [Action.DownloadAsPdf]
@@ -5607,9 +5632,11 @@ export declare enum Action {
             */
         DownloadTrace = "downloadTrace",
         /**
-            * The **Export TML** menu action on Liveboard, Answers
-            * Worksheets and Data Connections page.
-            * Exports an object as a TML file.
+            * The **Export TML** menu action on a Liveboard, Answer, and
+            * the Data Workspace pages for data objects and connections.
+            *
+            * Allows exporting an object as a TML file.
+            *
             * @example
             * ```js
             * disabledActions: [Action.ExportTML]
@@ -5617,7 +5644,8 @@ export declare enum Action {
             */
         ExportTML = "exportTSL",
         /**
-            * The **Import TML** menu action for Liveboards and Answers.
+            * The **Import TML** menu action on the
+            * *Data Workspace* > *Utilities* page.
             * Imports TML representation of ThoughtSpot objects.
             * @example
             * ```js
@@ -5627,7 +5655,7 @@ export declare enum Action {
         ImportTML = "importTSL",
         /**
             * The **Update TML** menu action for Liveboards and Answers.
-            * Update TML representation of ThoughtSpot objects.
+            * Updates TML representation of ThoughtSpot objects.
             * @example
             * ```js
             * disabledActions: [Action.UpdateTML]
@@ -5654,8 +5682,11 @@ export declare enum Action {
             */
         Present = "present",
         /**
-            * The tile resize options in the visualization menu.
-            * Allows switching between different preset layouts.
+            * The visualization tile resize option.
+            * Also available via More `...` options menu on a visualization.
+            * Allows resizing visualization tiles and switching
+            * between different preset layout option.
+            *
             * @example
             * ```js
             * disabledActions: [Action.ToggleSize]
@@ -5681,8 +5712,9 @@ export declare enum Action {
             */
         EditTitle = "editTitle",
         /**
-            * The **Delete** menu action on Liveboards and visualizations.
-            * Deletes a Liveboard or a visualization from a Liveboard.
+            * The **Delete** action on a Liveboard, *Liveboards* and
+            * *Answers* list pages in full application embedding.
+            *
             * @example
             * ```js
             * disabledActions: [Action.Remove]
@@ -5759,8 +5791,9 @@ export declare enum Action {
             */
         Explore = "explore",
         /**
-            * The action to include data points on a drilled-down Answer
-            * or visualization
+            * The contextual menu action to include a specific data point
+            * when drilling down a table or chart on an Answer.
+            *
             * @example
             * ```js
             * disabledActions: [Action.DrillInclude]
@@ -5768,8 +5801,8 @@ export declare enum Action {
             */
         DrillInclude = "context-menu-item-include",
         /**
-            * The action to exclude data points on a drilled-down Answer
-            * or visualization
+            * The contextual menu action to exclude a specific data point
+            * when drilling down a table or chart on an Answer.
             * @example
             * ```js
             * disabledActions: [Action.DrillInclude]
@@ -5916,7 +5949,7 @@ export declare enum Action {
             * Allows users to manage data sync pipelines to third-party apps.
             * @example
             * ```js
-            * disabledActions: [Action.SyncToOtherApps]
+            * disabledActions: [Action.ManagePipelines]
             * ```
             * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
             */
@@ -6235,7 +6268,7 @@ export declare enum Action {
         /**
             * Action ID for the Parent TML action
             * The parent action **TML** must be included to access TML-related options
-            * within the cascading menu (specific to the answer page)
+            * within the cascading menu (specific to the Answer page)
             * @example
             * ```js
             * // to include specific TML actions
@@ -6274,8 +6307,10 @@ export declare enum Action {
             */
         VerifiedLiveboard = "verifiedLiveboard",
         /**
-            * The *Ask Sage* action for Answers and visualizations.
-            * Allows initiating a Natural Language Search query.
+            * Action ID for the *Ask Sage* In Natural Language Search embed,
+            * *Spotter* in Liveboard, full app, and Spotter embed.
+            *
+            * Allows initiating a conversation with ThoughtSpot AI analyst.
             *
             *  @example
             * ```js
@@ -6471,7 +6506,8 @@ export declare enum Action {
             */
         DeletePreviousPrompt = "deletePreviousPrompt",
         /**
-            * Action ID for hide/disable edit of tokens on spotter results.
+            * Action ID for hide or disable editing tokens generated from
+            * Spotter results.
             *  @example
             * ```js
             * hiddenAction: [Action.EditTokens]
@@ -7414,9 +7450,10 @@ export declare const formatPreauthInfo: (preauthInfoResp: any) => Promise<Preaut
     */
 export declare function getPreauthInfo(allowCache?: boolean): Promise<PreauthInfo>;
 /**
-    * Returns the session info object and caches it for future use.
+    * Returns the cached session info object and caches it for future use.
     * Once fetched the session info object is cached and returned from the cache on
     * subsequent calls.
+    * This cache is cleared when inti is called OR resetCachedSessionInfo is called.
     * @example ```js
     * const sessionInfo = await getSessionInfo();
     * console.log(sessionInfo);
@@ -7459,10 +7496,21 @@ export declare const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
     * const sessionInfo = await getSessionInfo();
     * console.log(sessionInfo);
     * ```
-    * @version SDK: 1.28.3 | ThoughtSpot ts7.april.cl, 7.2.1
+    * @version SDK: 1.28.3 | ThoughtSpot: *
     * @returns {void}
     */
 export declare function resetCachedSessionInfo(): void;
+/**
+    * Resets the cached preauth info object and forces a new fetch on the next call.
+    * @example ```js
+    * resetCachedPreauthInfo();
+    * const preauthInfo = await getPreauthInfo();
+    * console.log(preauthInfo);
+    * ```
+    * @version SDK: 1.28.3 | ThoughtSpot: *
+    * @returns {void}
+    */
+export declare function resetCachedPreauthInfo(): void;
 
 /**
     * The list of customization css variables. These
@@ -8044,7 +8092,7 @@ export declare const getEmbedConfig: () => EmbedConfig;
     * @version SDK: 1.27.0 | ThoughtSpot: *
     * @group Global methods
     */
-export declare const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
+export declare const setEmbedConfig: (newConfig: EmbedConfig) => any;
 
 export declare const EndPoints: {
         CONFIG: string;