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

package/cjs/src/types.js

@@ -457,6 +457,7 @@ var EmbedEvent;
      * })
      * ```
      * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
+     * Payload: {@link AuthInitPayload}.
      */
     EmbedEvent["AuthInit"] = "authInit";
     /**
@@ -476,6 +477,7 @@ var 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
@@ -489,6 +491,7 @@ var EmbedEvent;
     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
@@ -531,6 +534,7 @@ var EmbedEvent;
      *     })
      * })
      * ```
+     * Payload: {@link DrilldownPayload}.
      */
     EmbedEvent["Drilldown"] = "drillDown";
     /**
@@ -543,6 +547,7 @@ var EmbedEvent;
      *    console.log('DataSourceSelected', payload);
      * })
      * ```
+     * Payload: {@link DataSourceSelectedPayload} or string[].
      */
     EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
     /**
@@ -555,6 +560,7 @@ var EmbedEvent;
      *   console.log('AddRemoveColumns', payload);
      * })
      * ```
+     * Payload: string[].
      */
     EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
     /**
@@ -572,6 +578,7 @@ var EmbedEvent;
      *     }
      * })
      * ```
+     * Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
      */
     EmbedEvent["CustomAction"] = "customAction";
     /**
@@ -584,6 +591,7 @@ var EmbedEvent;
      *      console.log('VizPointDoubleClick', payload);
      * })
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
     /**
@@ -603,6 +611,7 @@ var EmbedEvent;
      *   )
      * });
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     EmbedEvent["VizPointClick"] = "vizPointClick";
     /**
@@ -655,6 +664,7 @@ var EmbedEvent;
      *   // { errorType: "API", message: '...', code: '...' }
      * });
      * ```
+     * Payload: {@link EmbedErrorPayload} or a string.
      */
     EmbedEvent["Error"] = "Error";
     /**
@@ -705,6 +715,7 @@ var EmbedEvent;
      * The center of visible iframe viewport is calculated.
      * @returns data - The center of the visible Iframe viewport.
      * @hidden
+     * Payload: none.
      */
     EmbedEvent["EmbedIframeCenter"] = "EmbedIframeCenter";
     /**
@@ -761,6 +772,7 @@ var EmbedEvent;
      *    console.log('dialog open', payload);
      *  })
      * ```
+     * Payload: none.
      */
     EmbedEvent["DialogOpen"] = "dialog-open";
     /**
@@ -772,6 +784,7 @@ var EmbedEvent;
      *     console.log('dialog close', payload);
      * })
      * ```
+     * Payload: none.
      */
     EmbedEvent["DialogClose"] = "dialog-close";
     /**
@@ -794,6 +807,7 @@ var EmbedEvent;
      * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
      * };
      * ```
+     * Payload: none.
      */
     EmbedEvent["LiveboardRendered"] = "PinboardRendered";
     /**
@@ -824,6 +838,7 @@ var EmbedEvent;
      *    console.log('Save', payload)
      * })
      * ```
+     * Payload: {@link SaveEventPayload}.
      */
     EmbedEvent["Save"] = "save";
     /**
@@ -840,6 +855,7 @@ var EmbedEvent;
      * vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
+     * Payload: {@link VizScope}.
      */
     EmbedEvent["Download"] = "download";
     /**
@@ -859,6 +875,7 @@ var EmbedEvent;
      * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
      *   console.log('download PNG', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     EmbedEvent["DownloadAsPng"] = "downloadAsPng";
     /**
@@ -878,6 +895,7 @@ var EmbedEvent;
      * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
      *   console.log('download PDF', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
@@ -897,6 +915,7 @@ var EmbedEvent;
      * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
      *    console.log('download CSV', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
     /**
@@ -916,6 +935,7 @@ var EmbedEvent;
      * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
      *   console.log('download Xlsx', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
     /**
@@ -927,6 +947,7 @@ var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
      *   console.log('download liveboard as continuous PDF', payload)})
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["DownloadLiveboardAsContinuousPDF"] = "downloadLiveboardAsContinuousPDF";
     /**
@@ -943,6 +964,7 @@ var EmbedEvent;
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)})
      * ```
+     * Payload: {@link AnswerScope}.
      */
     EmbedEvent["AnswerDelete"] = "answerDelete";
     /**
@@ -954,6 +976,7 @@ var EmbedEvent;
      *   console.log('AI Highlights', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["AIHighlights"] = "AIHighlights";
     /**
@@ -975,6 +998,7 @@ var EmbedEvent;
      *    console.log('pin', payload)
      * })
      * ```
+     * Payload: {@link PinEventPayload}.
      */
     EmbedEvent["Pin"] = "pin";
     /**
@@ -993,6 +1017,7 @@ var EmbedEvent;
      *   console.log('SpotIQ analyze', payload)
      * })
      * ```
+     * Payload: {@link AnswerScope}.
      */
     EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
     /**
@@ -1046,6 +1071,7 @@ var EmbedEvent;
      *    console.log('copy to clipboard', payload);
      * })
      * ```
+     * Payload: {@link CopyToClipboardPayload}.
      */
     EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
     /**
@@ -1057,6 +1083,7 @@ var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.UpdateTML)
      * })
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     EmbedEvent["UpdateTML"] = "updateTSL";
     /**
@@ -1069,6 +1096,7 @@ var EmbedEvent;
      *    console.log('Edit TML', payload);
      * })
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     EmbedEvent["EditTML"] = "editTSL";
     /**
@@ -1086,6 +1114,7 @@ var EmbedEvent;
      * searchEmbed.on(EmbedEvent.ExportTML, payload => {
      *     console.log('Export TML', payload)})
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     EmbedEvent["ExportTML"] = "exportTSL";
     /**
@@ -1124,6 +1153,7 @@ var EmbedEvent;
      *    console.log('show data', payload);
      * })
      * ```
+     * Payload: {@link AnswerScope}.
      */
     EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
     /**
@@ -1135,6 +1165,7 @@ var EmbedEvent;
      *    console.log('switch view', payload);
      * })
      * ```
+     * Payload: {@link AnswerChartSwitcherPayload}.
      */
     EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
@@ -1156,6 +1187,7 @@ var EmbedEvent;
      *    console.log('Liveboard details', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["LiveboardInfo"] = "pinboardInfo";
     /**
@@ -1167,6 +1199,7 @@ var EmbedEvent;
      *    console.log('favorites', payload);
      * })
      * ```
+     * Payload: {@link FavoritePayload}.
      */
     EmbedEvent["AddToFavorites"] = "addToFavorites";
     /**
@@ -1178,6 +1211,7 @@ var EmbedEvent;
      *    console.log('Liveboard schedule', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["Schedule"] = "subscription";
     /**
@@ -1192,6 +1226,7 @@ var EmbedEvent;
      *    console.log('Liveboard edit', payload);
      * })
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     EmbedEvent["Edit"] = "edit";
     /**
@@ -1233,6 +1268,7 @@ var EmbedEvent;
      *    console.log('Copy', payload);
      * })
      * ```
+     * Payload: {@link MakeACopyPayload}.
      */
     EmbedEvent["MakeACopy"] = "makeACopy";
     /**
@@ -1248,6 +1284,7 @@ var EmbedEvent;
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * })
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     EmbedEvent["Present"] = "present";
     /**
@@ -1258,6 +1295,7 @@ var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.Delete,
      *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["Delete"] = "delete";
     /**
@@ -1267,6 +1305,7 @@ var EmbedEvent;
      * ```js
      * liveboardEmbed.on(EmbedEvent.SchedulesList)
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["SchedulesList"] = "schedule-list";
     /**
@@ -1276,6 +1315,7 @@ var EmbedEvent;
      * ```js
      * liveboardEmbed.on(EmbedEvent.Cancel)
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["Cancel"] = "cancel";
     /**
@@ -1286,6 +1326,7 @@ var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.Explore,  {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     EmbedEvent["Explore"] = "explore";
     /**
@@ -1296,6 +1337,7 @@ var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.CopyLink, {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link CopyLinkPayload}.
      */
     EmbedEvent["CopyLink"] = "embedDocument";
     /**
@@ -1307,6 +1349,7 @@ var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
      *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link CrossFilterChangedPayload}.
      */
     EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
     /**
@@ -1318,6 +1361,7 @@ var EmbedEvent;
      *    console.log('VizPointClick', payload)
      * })
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
     /**
@@ -1345,6 +1389,7 @@ var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
+     * Payload: {@link FilterChangedPayload}.
      */
     EmbedEvent["FilterChanged"] = "filterChanged";
     /**
@@ -1367,6 +1412,7 @@ var 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}.
      */
     EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
     /**
@@ -1388,6 +1434,7 @@ var 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}.
      */
     EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
     /**
@@ -1462,6 +1509,7 @@ var 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}.
      */
     EmbedEvent["Rename"] = "rename";
     /**
@@ -1547,6 +1595,7 @@ var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
+     * Payload: {@link ParameterChangedPayload}.
      */
     EmbedEvent["ParameterChanged"] = "parameterChanged";
     /**
@@ -1590,6 +1639,7 @@ var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
+     * Payload: {@link TableVizRenderedPayload}.
      */
     EmbedEvent["TableVizRendered"] = "TableVizRendered";
     /**
@@ -1614,12 +1664,14 @@ var EmbedEvent;
      * @hidden
      * Emitted when a user exits present mode.
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     * Payload: {@link ExitPresentModePayload}.
      */
     EmbedEvent["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.
      */
     EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
     /**
@@ -1653,6 +1705,7 @@ var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * Payload: {@link VizScope}.
      */
     EmbedEvent["AddToCoaching"] = "addToCoaching";
     /**
@@ -1742,6 +1795,7 @@ var EmbedEvent;
      *     console.log('EmbedListenerReady');
      * })
      * ```
+     * Payload: none.
      */
     EmbedEvent["EmbedListenerReady"] = "EmbedListenerReady";
     /**
@@ -2116,6 +2170,7 @@ var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     * Payload: {@link TestScheduleEmailPayload}.
      */
     EmbedEvent["SendTestScheduleEmail"] = "sendTestScheduleEmail";
     /**
@@ -2627,6 +2682,19 @@ var HostEvent;
      * ```
      */
     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);
+     * ```
+     */
+    HostEvent["OpenAddTabModal"] = "openAddTabModal";
     /**
      * Open the parameter panel for a particular parameter on a Liveboard.
      * Mirrors {@link HostEvent.OpenFilter} for parameters.
@@ -4846,6 +4914,7 @@ var Param;
      * @version SDK: 1.52.2 | ThoughtSpot Cloud: 26.9.0.cl
      */
     Param["TsmcpAnswerIndex"] = "tsmcpAnswerIndex";
+    Param["IsMcpAnswerEmbed"] = "isMcpAnswerEmbed";
     Param["EmbedApp"] = "embedApp";
     Param["DataSources"] = "dataSources";
     Param["DataSourceMode"] = "dataSourceMode";
@@ -5048,6 +5117,21 @@ var Param;
 var Action;
 (function (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
+     */
+    Action["LiveboardAddPanel"] = "liveboardAddPanel";
+    /**
+     *
      * The **Save** action on an Answer or Liveboard.
      * Allows users to save the changes.
      * @example
@@ -7301,6 +7385,102 @@ var Action;
      * ```
      */
     Action["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],
+     * }
+     * ```
+     */
+    Action["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],
+     * }
+     * ```
+     */
+    Action["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],
+     * }
+     * ```
+     */
+    Action["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],
+     * }
+     * ```
+     */
+    Action["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],
+     * }
+     * ```
+     */
+    Action["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],
+     * }
+     * ```
+     */
+    Action["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],
+     * }
+     * ```
+     */
+    Action["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],
+     * }
+     * ```
+     */
+    Action["SpotterViewExplanation"] = "spotterViewExplanation";
 })(Action = exports.Action || (exports.Action = {}));
 var PrefetchFeatures;
 (function (PrefetchFeatures) {