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

package/lib/src/types.js

@@ -454,6 +454,7 @@ export var EmbedEvent;
      * })
      * ```
      * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
+     * Payload: {@link AuthInitPayload}.
      */
     EmbedEvent["AuthInit"] = "authInit";
     /**
@@ -473,6 +474,7 @@ export 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
@@ -486,6 +488,7 @@ export 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
@@ -528,6 +531,7 @@ export var EmbedEvent;
      *     })
      * })
      * ```
+     * Payload: {@link DrilldownPayload}.
      */
     EmbedEvent["Drilldown"] = "drillDown";
     /**
@@ -540,6 +544,7 @@ export var EmbedEvent;
      *    console.log('DataSourceSelected', payload);
      * })
      * ```
+     * Payload: {@link DataSourceSelectedPayload} or string[].
      */
     EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
     /**
@@ -552,6 +557,7 @@ export var EmbedEvent;
      *   console.log('AddRemoveColumns', payload);
      * })
      * ```
+     * Payload: string[].
      */
     EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
     /**
@@ -569,6 +575,7 @@ export var EmbedEvent;
      *     }
      * })
      * ```
+     * Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
      */
     EmbedEvent["CustomAction"] = "customAction";
     /**
@@ -581,6 +588,7 @@ export var EmbedEvent;
      *      console.log('VizPointDoubleClick', payload);
      * })
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
     /**
@@ -600,6 +608,7 @@ export var EmbedEvent;
      *   )
      * });
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     EmbedEvent["VizPointClick"] = "vizPointClick";
     /**
@@ -652,6 +661,7 @@ export var EmbedEvent;
      *   // { errorType: "API", message: '...', code: '...' }
      * });
      * ```
+     * Payload: {@link EmbedErrorPayload} or a string.
      */
     EmbedEvent["Error"] = "Error";
     /**
@@ -702,6 +712,7 @@ export 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";
     /**
@@ -758,6 +769,7 @@ export var EmbedEvent;
      *    console.log('dialog open', payload);
      *  })
      * ```
+     * Payload: none.
      */
     EmbedEvent["DialogOpen"] = "dialog-open";
     /**
@@ -769,6 +781,7 @@ export var EmbedEvent;
      *     console.log('dialog close', payload);
      * })
      * ```
+     * Payload: none.
      */
     EmbedEvent["DialogClose"] = "dialog-close";
     /**
@@ -791,6 +804,7 @@ export var EmbedEvent;
      * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
      * };
      * ```
+     * Payload: none.
      */
     EmbedEvent["LiveboardRendered"] = "PinboardRendered";
     /**
@@ -821,6 +835,7 @@ export var EmbedEvent;
      *    console.log('Save', payload)
      * })
      * ```
+     * Payload: {@link SaveEventPayload}.
      */
     EmbedEvent["Save"] = "save";
     /**
@@ -837,6 +852,7 @@ export var EmbedEvent;
      * vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
+     * Payload: {@link VizScope}.
      */
     EmbedEvent["Download"] = "download";
     /**
@@ -856,6 +872,7 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
      *   console.log('download PNG', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     EmbedEvent["DownloadAsPng"] = "downloadAsPng";
     /**
@@ -875,6 +892,7 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
      *   console.log('download PDF', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
@@ -894,6 +912,7 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
      *    console.log('download CSV', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
     /**
@@ -913,6 +932,7 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
      *   console.log('download Xlsx', payload)})
      * ```
+     * Payload: {@link DownloadEventPayload}.
      */
     EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
     /**
@@ -924,6 +944,7 @@ export var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
      *   console.log('download liveboard as continuous PDF', payload)})
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["DownloadLiveboardAsContinuousPDF"] = "downloadLiveboardAsContinuousPDF";
     /**
@@ -940,6 +961,7 @@ export var EmbedEvent;
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)})
      * ```
+     * Payload: {@link AnswerScope}.
      */
     EmbedEvent["AnswerDelete"] = "answerDelete";
     /**
@@ -951,6 +973,7 @@ export var EmbedEvent;
      *   console.log('AI Highlights', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["AIHighlights"] = "AIHighlights";
     /**
@@ -972,6 +995,7 @@ export var EmbedEvent;
      *    console.log('pin', payload)
      * })
      * ```
+     * Payload: {@link PinEventPayload}.
      */
     EmbedEvent["Pin"] = "pin";
     /**
@@ -990,6 +1014,7 @@ export var EmbedEvent;
      *   console.log('SpotIQ analyze', payload)
      * })
      * ```
+     * Payload: {@link AnswerScope}.
      */
     EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
     /**
@@ -1043,6 +1068,7 @@ export var EmbedEvent;
      *    console.log('copy to clipboard', payload);
      * })
      * ```
+     * Payload: {@link CopyToClipboardPayload}.
      */
     EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
     /**
@@ -1054,6 +1080,7 @@ export var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.UpdateTML)
      * })
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     EmbedEvent["UpdateTML"] = "updateTSL";
     /**
@@ -1066,6 +1093,7 @@ export var EmbedEvent;
      *    console.log('Edit TML', payload);
      * })
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     EmbedEvent["EditTML"] = "editTSL";
     /**
@@ -1083,6 +1111,7 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.ExportTML, payload => {
      *     console.log('Export TML', payload)})
      * ```
+     * Payload: {@link TmlEventPayload}.
      */
     EmbedEvent["ExportTML"] = "exportTSL";
     /**
@@ -1121,6 +1150,7 @@ export var EmbedEvent;
      *    console.log('show data', payload);
      * })
      * ```
+     * Payload: {@link AnswerScope}.
      */
     EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
     /**
@@ -1132,6 +1162,7 @@ export var EmbedEvent;
      *    console.log('switch view', payload);
      * })
      * ```
+     * Payload: {@link AnswerChartSwitcherPayload}.
      */
     EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
@@ -1153,6 +1184,7 @@ export var EmbedEvent;
      *    console.log('Liveboard details', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["LiveboardInfo"] = "pinboardInfo";
     /**
@@ -1164,6 +1196,7 @@ export var EmbedEvent;
      *    console.log('favorites', payload);
      * })
      * ```
+     * Payload: {@link FavoritePayload}.
      */
     EmbedEvent["AddToFavorites"] = "addToFavorites";
     /**
@@ -1175,6 +1208,7 @@ export var EmbedEvent;
      *    console.log('Liveboard schedule', payload);
      * })
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["Schedule"] = "subscription";
     /**
@@ -1189,6 +1223,7 @@ export var EmbedEvent;
      *    console.log('Liveboard edit', payload);
      * })
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     EmbedEvent["Edit"] = "edit";
     /**
@@ -1230,6 +1265,7 @@ export var EmbedEvent;
      *    console.log('Copy', payload);
      * })
      * ```
+     * Payload: {@link MakeACopyPayload}.
      */
     EmbedEvent["MakeACopy"] = "makeACopy";
     /**
@@ -1245,6 +1281,7 @@ export var EmbedEvent;
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * })
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     EmbedEvent["Present"] = "present";
     /**
@@ -1255,6 +1292,7 @@ export var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.Delete,
      *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["Delete"] = "delete";
     /**
@@ -1264,6 +1302,7 @@ export var EmbedEvent;
      * ```js
      * liveboardEmbed.on(EmbedEvent.SchedulesList)
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["SchedulesList"] = "schedule-list";
     /**
@@ -1273,6 +1312,7 @@ export var EmbedEvent;
      * ```js
      * liveboardEmbed.on(EmbedEvent.Cancel)
      * ```
+     * Payload: {@link LiveboardScope}.
      */
     EmbedEvent["Cancel"] = "cancel";
     /**
@@ -1283,6 +1323,7 @@ export var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.Explore,  {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link LiveboardVizScope}.
      */
     EmbedEvent["Explore"] = "explore";
     /**
@@ -1293,6 +1334,7 @@ export var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.CopyLink, {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link CopyLinkPayload}.
      */
     EmbedEvent["CopyLink"] = "embedDocument";
     /**
@@ -1304,6 +1346,7 @@ export var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
      *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * Payload: {@link CrossFilterChangedPayload}.
      */
     EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
     /**
@@ -1315,6 +1358,7 @@ export var EmbedEvent;
      *    console.log('VizPointClick', payload)
      * })
      * ```
+     * Payload: {@link VizInteractionPayload}.
      */
     EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
     /**
@@ -1342,6 +1386,7 @@ export var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
+     * Payload: {@link FilterChangedPayload}.
      */
     EmbedEvent["FilterChanged"] = "filterChanged";
     /**
@@ -1364,6 +1409,7 @@ export 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";
     /**
@@ -1385,6 +1431,7 @@ export 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";
     /**
@@ -1459,6 +1506,7 @@ export 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";
     /**
@@ -1544,6 +1592,7 @@ export var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
+     * Payload: {@link ParameterChangedPayload}.
      */
     EmbedEvent["ParameterChanged"] = "parameterChanged";
     /**
@@ -1587,6 +1636,7 @@ export var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
+     * Payload: {@link TableVizRenderedPayload}.
      */
     EmbedEvent["TableVizRendered"] = "TableVizRendered";
     /**
@@ -1611,12 +1661,14 @@ export 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";
     /**
@@ -1650,6 +1702,7 @@ export var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * Payload: {@link VizScope}.
      */
     EmbedEvent["AddToCoaching"] = "addToCoaching";
     /**
@@ -1739,6 +1792,7 @@ export var EmbedEvent;
      *     console.log('EmbedListenerReady');
      * })
      * ```
+     * Payload: none.
      */
     EmbedEvent["EmbedListenerReady"] = "EmbedListenerReady";
     /**
@@ -2113,6 +2167,7 @@ export var EmbedEvent;
      * })
      * ```
      * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     * Payload: {@link TestScheduleEmailPayload}.
      */
     EmbedEvent["SendTestScheduleEmail"] = "sendTestScheduleEmail";
     /**
@@ -2624,6 +2679,19 @@ export 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.
@@ -4843,6 +4911,7 @@ export 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";
@@ -5045,6 +5114,21 @@ export var Param;
 export 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
@@ -7298,6 +7382,102 @@ export 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 || (Action = {}));
 export var PrefetchFeatures;
 (function (PrefetchFeatures) {