@thoughtspot/visual-embed-sdk 1.53.1 → 1.53.2-beta

package/dist/src/types.d.ts

@@ -2601,6 +2601,7 @@ export declare enum EmbedEvent {
      * })
      * ```
      * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
+     * Payload: {@link AuthInitPayload}.
      */
     AuthInit = "authInit",
     /**
@@ -2620,6 +2621,7 @@ export declare enum EmbedEvent {
     /**
      * Data pertaining to an Answer, Liveboard or Spotter visualization is received.
      * The event payload includes the raw data of the object.
+     * Payload: {@link DataEventPayload}.
      * @return data -  Answer of Liveboard data
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
@@ -2633,6 +2635,7 @@ export declare enum EmbedEvent {
     Data = "data",
     /**
      * Search query has been updated by the user.
+     * Payload: {@link QueryChangedPayload} or a string.
      * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
      * @example
      * ```js
@@ -2675,6 +2678,7 @@ export declare enum EmbedEvent {
      *     })
      * })
      * ```
+     * Payload: {@link DrilldownPayload}.
      */
     Drilldown = "drillDown",
     /**
@@ -2687,6 +2691,7 @@ export declare enum EmbedEvent {
      *    console.log('DataSourceSelected', payload);
      * })
      * ```
+     * Payload: {@link DataSourceSelectedPayload} or string[].
      */
     DataSourceSelected = "dataSourceSelected",
     /**
@@ -2699,6 +2704,7 @@ export declare enum EmbedEvent {
      *   console.log('AddRemoveColumns', payload);
      * })
      * ```
+     * Payload: string[].
      */
     AddRemoveColumns = "addRemoveColumns",
     /**
@@ -2716,6 +2722,7 @@ export declare enum EmbedEvent {
      *     }
      * })
      * ```
+     * Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
      */
     CustomAction = "customAction",
     /**
@@ -2728,6 +2735,7 @@ export declare enum EmbedEvent {
      *      console.log('VizPointDoubleClick', payload);
      * })
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     VizPointDoubleClick = "vizPointDoubleClick",
     /**
@@ -2747,6 +2755,7 @@ export declare enum EmbedEvent {
      *   )
      * });
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     VizPointClick = "vizPointClick",
     /**
@@ -2799,6 +2808,7 @@ export declare enum EmbedEvent {
      *   // { errorType: "API", message: '...', code: '...' }
      * });
      * ```
+     * Payload: {@link EmbedErrorPayload} or a string.
      */
     Error = "Error",
     /**
@@ -2849,6 +2859,7 @@ export declare enum EmbedEvent {
      * The center of visible iframe viewport is calculated.
      * @returns data - The center of the visible Iframe viewport.
      * @hidden
+     * Payload: none.
      */
     EmbedIframeCenter = "EmbedIframeCenter",
     /**
@@ -2905,6 +2916,7 @@ export declare enum EmbedEvent {
      *    console.log('dialog open', payload);
      *  })
      * ```
+     * Payload: none.
      */
     DialogOpen = "dialog-open",
     /**
@@ -2916,6 +2928,7 @@ export declare enum EmbedEvent {
      *     console.log('dialog close', payload);
      * })
      * ```
+     * Payload: none.
      */
     DialogClose = "dialog-close",
     /**
@@ -2938,6 +2951,7 @@ export declare enum EmbedEvent {
      * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
      * };
      * ```
+     * Payload: none.
      */
     LiveboardRendered = "PinboardRendered",
     /**
@@ -2968,6 +2982,7 @@ export declare enum EmbedEvent {
      *    console.log('Save', payload)
      * })
      * ```
+     * Payload: {@link SaveEventPayload}.
      */
     Save = "save",
     /**
@@ -2984,6 +2999,7 @@ export declare enum EmbedEvent {
      * vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
+     * Payload: {@link VizScope}.
      */
     Download = "download",
     /**
@@ -3003,6 +3019,7 @@ export declare enum EmbedEvent {
      * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
      *   console.log('download PNG', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     DownloadAsPng = "downloadAsPng",
     /**
@@ -3022,6 +3039,7 @@ export declare enum EmbedEvent {
      * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
      *   console.log('download PDF', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     DownloadAsPdf = "downloadAsPdf",
     /**
@@ -3041,6 +3059,7 @@ export declare enum EmbedEvent {
      * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
      *    console.log('download CSV', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     DownloadAsCsv = "downloadAsCsv",
     /**
@@ -3060,6 +3079,7 @@ export declare enum EmbedEvent {
      * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
      *   console.log('download Xlsx', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     DownloadAsXlsx = "downloadAsXlsx",
     /**
@@ -3071,6 +3091,7 @@ export declare enum EmbedEvent {
      * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
      *   console.log('download liveboard as continuous PDF', payload)})
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
     /**
@@ -3087,6 +3108,7 @@ export declare enum EmbedEvent {
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)})
      * ```
+     * Payload: {@link AnswerScope}.
      */
     AnswerDelete = "answerDelete",
     /**
@@ -3098,6 +3120,7 @@ export declare enum EmbedEvent {
      *   console.log('AI Highlights', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     AIHighlights = "AIHighlights",
     /**
@@ -3119,6 +3142,7 @@ export declare enum EmbedEvent {
      *    console.log('pin', payload)
      * })
      * ```
+     * Payload: {@link PinEventPayload}.
      */
     Pin = "pin",
     /**
@@ -3137,6 +3161,7 @@ export declare enum EmbedEvent {
      *   console.log('SpotIQ analyze', payload)
      * })
      * ```
+     * Payload: {@link AnswerScope}.
      */
     SpotIQAnalyze = "spotIQAnalyze",
     /**
@@ -3190,6 +3215,7 @@ export declare enum EmbedEvent {
      *    console.log('copy to clipboard', payload);
      * })
      * ```
+     * Payload: {@link CopyToClipboardPayload}.
      */
     CopyToClipboard = "context-menu-item-copy-to-clipboard",
     /**
@@ -3201,6 +3227,7 @@ export declare enum EmbedEvent {
      * liveboardEmbed.on(EmbedEvent.UpdateTML)
      * })
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     UpdateTML = "updateTSL",
     /**
@@ -3213,6 +3240,7 @@ export declare enum EmbedEvent {
      *    console.log('Edit TML', payload);
      * })
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     EditTML = "editTSL",
     /**
@@ -3230,6 +3258,7 @@ export declare enum EmbedEvent {
      * searchEmbed.on(EmbedEvent.ExportTML, payload => {
      *     console.log('Export TML', payload)})
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     ExportTML = "exportTSL",
     /**
@@ -3268,6 +3297,7 @@ export declare enum EmbedEvent {
      *    console.log('show data', payload);
      * })
      * ```
+     * Payload: {@link AnswerScope}.
      */
     ShowUnderlyingData = "showUnderlyingData",
     /**
@@ -3279,6 +3309,7 @@ export declare enum EmbedEvent {
      *    console.log('switch view', payload);
      * })
      * ```
+     * Payload: {@link AnswerChartSwitcherPayload}.
      */
     AnswerChartSwitcher = "answerChartSwitcher",
     /**
@@ -3300,6 +3331,7 @@ export declare enum EmbedEvent {
      *    console.log('Liveboard details', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     LiveboardInfo = "pinboardInfo",
     /**
@@ -3311,6 +3343,7 @@ export declare enum EmbedEvent {
      *    console.log('favorites', payload);
      * })
      * ```
+     * Payload: {@link FavoritePayload}.
      */
     AddToFavorites = "addToFavorites",
     /**
@@ -3322,6 +3355,7 @@ export declare enum EmbedEvent {
      *    console.log('Liveboard schedule', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     Schedule = "subscription",
     /**
@@ -3336,6 +3370,7 @@ export declare enum EmbedEvent {
      *    console.log('Liveboard edit', payload);
      * })
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     Edit = "edit",
     /**
@@ -3377,6 +3412,7 @@ export declare enum EmbedEvent {
      *    console.log('Copy', payload);
      * })
      * ```
+     * Payload: {@link MakeACopyPayload}.
      */
     MakeACopy = "makeACopy",
     /**
@@ -3392,6 +3428,7 @@ export declare enum EmbedEvent {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * })
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     Present = "present",
     /**
@@ -3402,6 +3439,7 @@ export declare enum EmbedEvent {
      * liveboardEmbed.on(EmbedEvent.Delete,
      *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     Delete = "delete",
     /**
@@ -3411,6 +3449,7 @@ export declare enum EmbedEvent {
      * ```js
      * liveboardEmbed.on(EmbedEvent.SchedulesList)
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     SchedulesList = "schedule-list",
     /**
@@ -3420,6 +3459,7 @@ export declare enum EmbedEvent {
      * ```js
      * liveboardEmbed.on(EmbedEvent.Cancel)
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     Cancel = "cancel",
     /**
@@ -3430,6 +3470,7 @@ export declare enum EmbedEvent {
      * liveboardEmbed.on(EmbedEvent.Explore,  {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     Explore = "explore",
     /**
@@ -3440,6 +3481,7 @@ export declare enum EmbedEvent {
      * liveboardEmbed.on(EmbedEvent.CopyLink, {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link CopyLinkPayload}.
      */
     CopyLink = "embedDocument",
     /**
@@ -3451,6 +3493,7 @@ export declare enum EmbedEvent {
      * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
      *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link CrossFilterChangedPayload}.
      */
     CrossFilterChanged = "cross-filter-changed",
     /**
@@ -3462,6 +3505,7 @@ export declare enum EmbedEvent {
      *    console.log('VizPointClick', payload)
      * })
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     VizPointRightClick = "vizPointRightClick",
     /**
@@ -3489,6 +3533,7 @@ export declare enum EmbedEvent {
      * })
      * ```
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
+     * Payload: {@link FilterChangedPayload}.
      */
     FilterChanged = "filterChanged",
     /**
@@ -3511,6 +3556,7 @@ export declare enum EmbedEvent {
      * @returns isPublic: boolean
      * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+     * Payload: {@link PersonalisedViewPayload}.
      */
     UpdatePersonalisedView = "updatePersonalisedView",
     /**
@@ -3532,6 +3578,7 @@ export declare enum EmbedEvent {
      * @returns isPublic: boolean
      * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+     * Payload: {@link PersonalisedViewPayload}.
      */
     SavePersonalisedView = "savePersonalisedView",
     /**
@@ -3606,6 +3653,7 @@ export declare enum EmbedEvent {
     /**
      * Emitted when a Liveboard or visualization is renamed.
      * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
+     * Payload: {@link RenamePayload}.
      */
     Rename = "rename",
     /**
@@ -3691,6 +3739,7 @@ export declare enum EmbedEvent {
      * })
      * ```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
+     * Payload: {@link ParameterChangedPayload}.
      */
     ParameterChanged = "parameterChanged",
     /**
@@ -3734,6 +3783,7 @@ export declare enum EmbedEvent {
      * })
      * ```
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
+     * Payload: {@link TableVizRenderedPayload}.
      */
     TableVizRendered = "TableVizRendered",
     /**
@@ -3758,12 +3808,14 @@ export declare enum EmbedEvent {
      * @hidden
      * Emitted when a user exits present mode.
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     * Payload: {@link ExitPresentModePayload}.
      */
     ExitPresentMode = "exitPresentMode",
     /**
      * Emitted when a user requests the full height lazy load data.
      * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      * @hidden
+     * Payload: none.
      */
     RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
     /**
@@ -3797,6 +3849,7 @@ export declare enum EmbedEvent {
      * })
      * ```
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * Payload: {@link VizScope}.
      */
     AddToCoaching = "addToCoaching",
     /**
@@ -3886,6 +3939,7 @@ export declare enum EmbedEvent {
      *     console.log('EmbedListenerReady');
      * })
      * ```
+     * Payload: none.
      */
     EmbedListenerReady = "EmbedListenerReady",
     /**
@@ -4260,6 +4314,7 @@ export declare enum EmbedEvent {
      * })
      * ```
      * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     * Payload: {@link TestScheduleEmailPayload}.
      */
     SendTestScheduleEmail = "sendTestScheduleEmail",
     /**
@@ -4770,6 +4825,19 @@ export declare enum HostEvent {
      * ```
      */
     OpenAddParameterModal = "openAddParameterModal",
+    /**
+     * Add a tab to the Liveboard, the same action as the *Tab* option in the
+     * *Add* dropdown in the Liveboard edit header.
+     *
+     * The Liveboard must be in edit mode; the event is ignored otherwise.
+     *
+     * @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.OpenAddTabModal);
+     * ```
+     */
+    OpenAddTabModal = "openAddTabModal",
     /**
      * Open the parameter panel for a particular parameter on a Liveboard.
      * Mirrors {@link HostEvent.OpenFilter} for parameters.
@@ -6986,6 +7054,7 @@ export declare enum Param {
      * @version SDK: 1.52.2 | ThoughtSpot Cloud: 26.9.0.cl
      */
     TsmcpAnswerIndex = "tsmcpAnswerIndex",
+    IsMcpAnswerEmbed = "isMcpAnswerEmbed",
     EmbedApp = "embedApp",
     DataSources = "dataSources",
     DataSourceMode = "dataSourceMode",
@@ -7188,6 +7257,21 @@ export type SpotterFileUploadFileTypes = {
  */
 export declare enum Action {
     /**
+     * The **Add** button on a Liveboard in edit mode.
+     * Controls the visibility and disabled state of the Add panel button
+     * in the Liveboard edit toolbar, which allows users to add
+     * visualizations, filters, parameters, and tabs.
+     * @example
+     * ```js
+     * hiddenActions: [Action.LiveboardAddPanel]
+     * // or
+     * disabledActions: [Action.LiveboardAddPanel]
+     * ```
+     * @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
+     */
+    LiveboardAddPanel = "liveboardAddPanel",
+    /**
+     *
      * The **Save** action on an Answer or Liveboard.
      * Allows users to save the changes.
      * @example
@@ -9438,7 +9522,103 @@ export declare enum Action {
      * });
      * ```
      */
-    Cancel = "cancel"
+    Cancel = "cancel",
+    /**
+     * Controls the visibility and disabled state of the "Version history" menu item for a Liveboard or Answer.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.ShowVersionHistory],
+     *     disabledActions: [Action.ShowVersionHistory],
+     * }
+     * ```
+     */
+    ShowVersionHistory = "showVersionHistory",
+    /**
+     * Controls the visibility and disabled state of the "Enable version control" menu item for a Liveboard or Answer.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.EnableVersionControl],
+     *     disabledActions: [Action.EnableVersionControl],
+     * }
+     * ```
+     */
+    EnableVersionControl = "enableVersionControl",
+    /**
+     * Controls the visibility and disabled state of the "Disable version control" menu item for a Liveboard or Answer.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.DisableVersionControl],
+     *     disabledActions: [Action.DisableVersionControl],
+     * }
+     * ```
+     */
+    DisableVersionControl = "disableVersionControl",
+    /**
+     * Controls the visibility and disabled state of the "Withdraw verification" menu item for a verified Liveboard.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.WithdrawVerification],
+     *     disabledActions: [Action.WithdrawVerification],
+     * }
+     * ```
+     */
+    WithdrawVerification = "withdrawVerification",
+    /**
+     * Controls the visibility and disabled state of the "Switch to new chart experience" menu item on an Answer.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.SwitchToNewChartExperience],
+     *     disabledActions: [Action.SwitchToNewChartExperience],
+     * }
+     * ```
+     */
+    SwitchToNewChartExperience = "switchToNewChartExperience",
+    /**
+     * Controls the visibility and disabled state of the "Switch to classic chart experience" menu item on an Answer.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.SwitchToClassicChartExperience],
+     *     disabledActions: [Action.SwitchToClassicChartExperience],
+     * }
+     * ```
+     */
+    SwitchToClassicChartExperience = "switchToClassicChartExperience",
+    /**
+     * Controls the visibility and disabled state of the "Monitor" menu item on an Answer, which includes the alert options.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.5.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.Monitor],
+     *     disabledActions: [Action.Monitor],
+     * }
+     * ```
+     */
+    Monitor = "monitor",
+    /**
+     * Controls the visibility and disabled state of the "View explanation" button in the footer of a Spotter answer, which opens the explanation and verification details.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.SpotterViewExplanation],
+     *     disabledActions: [Action.SpotterViewExplanation],
+     * }
+     * ```
+     */
+    SpotterViewExplanation = "spotterViewExplanation"
 }
 export interface AnswerServiceType {
     getAnswer?: (offset: number, batchSize: number) => any;