@thoughtspot/visual-embed-sdk 1.20.2 → 1.20.3

package/lib/src/types.js

@@ -9,29 +9,43 @@
 /**
  * The authentication mechanism for allowing access to the
  * the embedded app
+ *
  * @group Authentication / Init
  */
 // eslint-disable-next-line no-shadow
 export var AuthType;
 (function (AuthType) {
     /**
-     * No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
+     * No authentication on the SDK. Passthrough to the embedded App. Alias for
+     * `Passthrough`.
+     *
+     * @example
+     * ```js
+     * init({
+     *   // ...
+     *   authType: AuthType.None,
+     *  });
+     * ```
      */
     AuthType["None"] = "None";
     /**
-     * Passthrough SSO to the embedded App within the iframe. Requires least configuration, but may not
-     * be supported by all IDPs. This will behave like `None` if SSO is not configured on ThoughtSpot.
+     * Passthrough SSO to the embedded App within the iframe. Requires least
+     * configuration, but may not be supported by all IDPs. This will behave like `None`
+     * if SSO is not configured on ThoughtSpot.
+     *
      * @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
      */
     AuthType["EmbeddedSSO"] = "EmbeddedSSO";
     /**
      * SSO using SAML
+     *
      * @deprecated Use {@link SAMLRedirect} instead
      * @hidden
      */
     AuthType["SSO"] = "SSO_SAML";
     /**
      * SSO using SAML
+     *
      * @deprecated Use {@link SAMLRedirect} instead
      * @hidden
      */
@@ -43,6 +57,7 @@ export var AuthType;
      *
      * This redirects the host application to the SAML Idp. The host application
      * will be redirected back to the ThoughtSpot app after authentication.
+     *
      * @example
      * ```js
      * init({
@@ -83,6 +98,7 @@ export var AuthType;
     AuthType["SAMLRedirect"] = "SSO_SAML";
     /**
      * SSO using OIDC
+     *
      * @hidden
      * @deprecated Use {@link OIDCRedirect} instead
      */
@@ -95,14 +111,15 @@ export var AuthType;
     AuthType["OIDCRedirect"] = "SSO_OIDC";
     /**
      * Trusted authentication server
+     *
      * @hidden
      * @deprecated Use {@link TrustedAuth} instead
      */
     AuthType["AuthServer"] = "AuthServer";
     /**
      * Trusted authentication server, Use your own authentication server
-     * which returns a bearer token, generated using the secret_key obtained from
-     * ThoughtSpot.
+     * which returns a bearer token, generated using the secret_key obtained
+     * from ThoughtSpot.
      *
      * @example
      * ```js
@@ -118,10 +135,24 @@ export var AuthType;
      */
     AuthType["TrustedAuthToken"] = "AuthServer";
     /**
-     * Trusted authentication server Cookieless, Use you own authentication server
-     * which returns a bearer token, generated using the secret_key obtained from
-     * ThoughtSpot. This uses a cookieless authentication approach, recommended
-     * to by pass third-party cookie-blocking restriction implemented by some browsers
+     * Trusted authentication server Cookieless, Use you own authentication
+     * server which returns a bearer token, generated using the secret_key
+     * obtained from ThoughtSpot. This uses a cookieless authentication
+     * approach, recommended to by pass third-party cookie-blocking restriction
+     * implemented by some browsers
+     *
+     * @example
+     * ```js
+     * init({
+     *  // ...
+     *  authType: AuthType.TrustedAuthTokenCookieless,
+     *  getAuthToken: () => {
+     *    return fetch('https://my-backend.app/ts-token')
+     *      .then((response) => response.json())
+     *      .then((data) => data.token);
+     *  }
+     * ```
+     * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
      */
     AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
     /**
@@ -200,6 +231,19 @@ export var RuntimeFilterOp;
  *
  * To add an event listener use the corresponding
  * {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
+ *
+ *  @example
+ * ```js
+ * import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
+ * // Or
+ * // const { EmbedEvent } = window.tsembed;
+ *
+ * // create the liveboard embed.
+ *
+ * liveboardEmbed.on(EmbedEvent.Drilldown, (drilldown) => {
+ *   console.log('Drilldown event', drilldown);
+ * }));
+ * ```
  * @group Events
  */
 // eslint-disable-next-line no-shadow
@@ -207,77 +251,104 @@ export var EmbedEvent;
 (function (EmbedEvent) {
     /**
      * Rendering has initialized.
-     * @return timestamp - The timestamp when the event was generated.
+     *
+     * @returns timestamp - The timestamp when the event was generated.
      */
     EmbedEvent["Init"] = "init";
     /**
      * Authentication has either succeeded or failed.
-     * @return isLoggedIn - A Boolean specifying whether authentication was successful.
+     *
+     * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
      */
     EmbedEvent["AuthInit"] = "authInit";
     /**
      * The embed object container has loaded.
-     * @return timestamp - The timestamp when the event was generated.
+     *
+     * @returns timestamp - The timestamp when the event was generated.
      */
     EmbedEvent["Load"] = "load";
     /**
      * Data pertaining to answer or Liveboard is received
+     *
      * @return data - The answer or Liveboard data
+     * @important
      */
     EmbedEvent["Data"] = "data";
     /**
-     * Search/answer/Liveboard filters have been applied/updated
+     * Search/answer/Liveboard filters have been applied/updated by the user.
+     *
      * @hidden
      */
     EmbedEvent["FiltersChanged"] = "filtersChanged";
     /**
-     * Search query has been updated
+     * Search query has been updated by the user.
      */
     EmbedEvent["QueryChanged"] = "queryChanged";
     /**
      * A drill down operation has been performed.
-     * @return additionalFilters - Any additional filters applied
-     * @return drillDownColumns - The columns on which drill down was performed
-     * @return nonFilteredColumns - The columns that were not filtered
+     *
+     * @returns additionalFilters - Any additional filters applied
+     * @returns drillDownColumns - The columns on which drill down was performed
+     * @returns nonFilteredColumns - The columns that were not filtered
      */
     EmbedEvent["Drilldown"] = "drillDown";
     /**
      * One or more data sources have been selected.
-     * @return dataSourceIds - the list of data sources
+     *
+     * @returns dataSourceIds - the list of data sources
      */
     EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
     /**
      * One or more data columns have been selected.
-     * @return columnIds - the list of columns
+     *
+     * @returns columnIds - the list of columns
      * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
      */
     EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
     /**
      * A custom action has been triggered
-     * @return actionId - The id of the custom action
-     * @return data - The answer or Liveboard data
+     *
+     * @returns actionId - The id of the custom action
+     * @returns data - The answer or Liveboard data
      */
     EmbedEvent["CustomAction"] = "customAction";
     /**
-     * A double click has been triggered on table/chart
+     * Listen to double clicks on a visualization
+     *
      * @return ContextMenuInputPoints - data point that is double clicked
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      */
     EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
     /**
-     * A click has been triggered on table/chart
-     * @return ContextMenuInputPoints - data point that is clicked
+     * Listen to clicks on a visualization in a liveboard or Search result.
+     *
+     * @example
+     * ```js
+     * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
+     *   console.log(
+     *    data.vizId, // viz id
+     *    data.clickedPoint.selectedAttributes[0].value,
+     *    data.clickedPoint.selectedAttributes[0].column.name,
+     *    data.clickedPoint.selectedMeasures[0].value,
+     *    data.clickedPoint.selectedMeasures[0].column.name,
+     *   )
+     * });
+     * ```
+     * @return viz, clickedPoint - metadata about point that is clicked
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     * @important
      */
     EmbedEvent["VizPointClick"] = "vizPointClick";
     /**
      * An error has occurred.
-     * @return error - An error object or message
+     *
+     * @returns error - An error object or message
      */
     EmbedEvent["Error"] = "Error";
     /**
      * The embedded object has sent an alert
-     * @return alert - An alert object
+     *
+     * @returns alert - An alert object
      */
     EmbedEvent["Alert"] = "alert";
     /**
@@ -286,29 +357,34 @@ export var EmbedEvent;
     EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
     /**
      * ThoughtSpot failed to validate the auth session.
+     *
      * @hidden
      */
     EmbedEvent["AuthFailure"] = "ThoughtspotAuthFailure";
     /**
      * ThoughtSpot failed to validate the auth session.
+     *
      * @hidden
      */
     EmbedEvent["AuthLogout"] = "ThoughtspotAuthLogout";
     /**
      * The height of the embedded Liveboard or visualization has been computed.
-     * @return data - The height of the embedded Liveboard or visualization
+     *
+     * @returns data - The height of the embedded Liveboard or visualization
      * @hidden
      */
     EmbedEvent["EmbedHeight"] = "EMBED_HEIGHT";
     /**
      * The center of visible iframe viewport is calculated.
-     * @return data - The center of the visible Iframe viewport.
+     *
+     * @returns data - The center of the visible Iframe viewport.
      * @hidden
      */
     EmbedEvent["EmbedIframeCenter"] = "EmbedIframeCenter";
     /**
      * Emitted when  the "Get Data" button in Search Bar embed
      * is clicked.
+     *
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
      */
     EmbedEvent["GetDataClick"] = "getDataClick";
@@ -318,6 +394,7 @@ export var EmbedEvent;
     EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
     /**
      * The v1 event type for Data
+     *
      * @hidden
      */
     EmbedEvent["V1Data"] = "exportVizDataToParent";
@@ -330,17 +407,20 @@ export var EmbedEvent;
     EmbedEvent["NoCookieAccess"] = "noCookieAccess";
     /**
      * Emitted when SAML is complete
+     *
      * @private
      * @hidden
      */
     EmbedEvent["SAMLComplete"] = "samlComplete";
     /**
      * Emitted when any modal is opened in the app
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     EmbedEvent["DialogOpen"] = "dialog-open";
     /**
      * Emitted when any modal is closed in the app
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     EmbedEvent["DialogClose"] = "dialog-close";
@@ -348,22 +428,26 @@ export var EmbedEvent;
      * Emitted when the Liveboard shell loads.
      * You can use this event as a hook to trigger
      * other events on the rendered Liveboard.
+     *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     EmbedEvent["LiveboardRendered"] = "PinboardRendered";
     /**
      * This can be used to register an event listener which
      * is triggered on all events.
+     *
      * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
      */
     EmbedEvent["ALL"] = "*";
     /**
      * Emitted when answer is saved in the app
+     *
      * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["Save"] = "save";
     /**
      * Emitted when the download action is triggered on an answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["Download"] = "download";
@@ -375,166 +459,219 @@ export var EmbedEvent;
     EmbedEvent["DownloadAsPng"] = "downloadAsPng";
     /**
      * 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
      */
     EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
      * 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
      */
     EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
     /**
      * 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
      */
     EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
     /**
      * Emitted when an answer is deleted in the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["AnswerDelete"] = "answerDelete";
     /**
      * Emitted when an answer is pinned to a Liveboard
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["Pin"] = "pin";
     /**
      * Emitted when SpotIQ analysis is triggered
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
     /**
      * Emitted when a user shares an object with another user or group
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["Share"] = "share";
     /**
-     * Emitted when a user clicks the Include action to include a specific value or data on a chart or table
+     * Emitted when a user clicks the Include action to include a specific value or data
+     * on a chart or table
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["DrillInclude"] = "context-menu-item-include";
     /**
-     * Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table
+     * Emitted when a user clicks the Exclude action to exclude a specific value or data
+     * on a chart or table
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
     /**
      * Emitted when copied column value on the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
     /**
      * Emitted when a user clicks the Update TML action
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["UpdateTML"] = "updateTSL";
     /**
      * Emitted when a user clicks the Edit TML action
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["EditTML"] = "editTSL";
     /**
      * Emitted when ExportTML trigger in answer on the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["ExportTML"] = "exportTSL";
     /**
      * Emitted when an answer is saved as a view
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["SaveAsView"] = "saveAsView";
     /**
      * Emitted when copy of existing answer on the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["CopyAEdit"] = "copyAEdit";
     /**
      * Emitted when a user clicks Show underlying data on an answe
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
     /**
      * 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
      */
     EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
      * Internal event to communicate the initial settings back to the TS APP
+     *
      * @hidden
      */
     EmbedEvent["APP_INIT"] = "appInit";
     /**
      * Emitted when a user clicks Show Liveboard details on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["LiveboardInfo"] = "pinboardInfo";
     /**
      * Emitted when a user clicks on the Favorite icon on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["AddToFavorites"] = "addToFavorites";
     /**
      * Emitted when a user clicks Schedule on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["Schedule"] = "subscription";
     /**
      * Emitted when a user clicks Edit on a Liveboard or visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["Edit"] = "edit";
     /**
      * Emitted when a user clicks Make a copy on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["MakeACopy"] = "makeACopy";
     /**
      * Emitted when a user clicks Present on a Liveboard or visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["Present"] = "present";
     /**
      * Emitted when a user clicks Delete on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["Delete"] = "delete";
     /**
      * Emitted when a user clicks Manage schedules on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["SchedulesList"] = "schedule-list";
     /**
      * Emitted when a user clicks Cancel in edit mode on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["Cancel"] = "cancel";
     /**
      * Emitted when a user clicks Explore on a visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["Explore"] = "explore";
     /**
      * Emitted when a user clicks Copy link action on a visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EmbedEvent["CopyLink"] = "embedDocument";
     /**
      * Emitted when a user interacts with cross filters on a visualization or liveboard
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
     /**
-     * Emitted when a user right clicks on chart or table
+     * Emitted when a user right clicks on a visualization (chart or table)
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
+    /**
+     * Emitted when a user clicks on Insert to slide on a visualization
+     *
+     * @hidden
+     */
+    EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
 })(EmbedEvent || (EmbedEvent = {}));
 /**
  * Event types that can be triggered by the host application
  * to the embedded ThoughtSpot app
  *
  * To trigger an event use the corresponding
- * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link SearchEmbed.trigger} method.
+ * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
+ * SearchEmbed.trigger} method.
+ *
+ * @example
+ * ```js
+ * import { HostEvent } from '@thoughtspot/visual-embed-sdk';
+ * // Or
+ * // const { HostEvent } = window.tsembed;
+ *
+ * // create the liveboard embed.
+ *
+ * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
+ *   { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
+ * ]);
+ * ```
  * @group Events
  */
 // eslint-disable-next-line no-shadow
@@ -542,6 +679,7 @@ export var HostEvent;
 (function (HostEvent) {
     /**
      * Trigger a search
+     *
      * @param - dataSourceIds - The data source GUID to Search on
      *                        - Although an array, only a single source
      *                          is supported at this time.
@@ -551,7 +689,7 @@ export var HostEvent;
      * ```js
      * searchEmbed.trigger(HostEvent.Search, {
      *   searchQuery: "[sales] by [item type],
-     *   dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
+     *   dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
      *   execute: true
      * })
      * ```
@@ -559,55 +697,77 @@ export var HostEvent;
     HostEvent["Search"] = "search";
     /**
      * Trigger a drill on certain points by certain column
+     *
      * @param - points - an object containing selectedPoints/clickedPoints
      *              eg. { selectedPoints: []}
      * @param - columnGuid - a string guid of the column to drill by. This is optional,
-     *                     if not provided it will auto drill by the configured column.
+     *                     if not provided it will auto drill by the configured
+     *                     column.
      * @example
      * ```js
-     * searchEmbed.trigger(HostEvent.DrillDown, {
-     *   points: clickedPointData,
-     *   autoDrillDown: true,
+     * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
+     *       console.log(payload);
+     *       const clickedPoint = payload.data.clickedPoint;
+     *       const selectedPoint = payload.data.selectedPoints;
+     *       console.log('>>> called', clickedPoint);
+     *       searchEmbed.trigger(HostEvent.DrillDown, {
+     *             points: {
+     *                  clickedPoint,
+     *                  selectedPoints: selectedPoint
+     *             },
+     *             autoDrillDown: true,
+     *       });
      * })
      * ```
-     *
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      */
     HostEvent["DrillDown"] = "triggerDrillDown";
     /**
      * Apply filters
+     *
      * @hidden
      */
     HostEvent["Filter"] = "filter";
     /**
      * Reload the answer or visualization
+     *
      * @hidden
      */
     HostEvent["Reload"] = "reload";
     /**
      * Set the visible visualizations on a Liveboard.
+     *
      * @param - an array of ids of visualizations to show, the ids not passed
      *          will be hidden.
      * @example
-     * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['730496d6-6903-4601-937e-2c691821af3c', 'd547ec54-2a37-4516-a222-2b06719af726'])
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
+     *  '730496d6-6903-4601-937e-2c691821af3c',
+     *  'd547ec54-2a37-4516-a222-2b06719af726'])
+     * ```
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
     /**
      * Update the runtime filters. The runtime filters passed here are extended
      * on to the existing runtime filters if they exist.
+     *
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
-     * {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]},
-     * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
+     *   {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]},
+     *   {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
      * ])
+     * ```
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * @important
      */
     HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
     /**
      * Navigate to a specific page in App embed without any reload.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`
+     *
      * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
      * @example
      * ```js
@@ -619,16 +779,22 @@ export var HostEvent;
     /**
      * Opens the filter panel for a particular column.
      * Works with Search embed.
-     * @param - { columnId: string, name: string, type: INT64/CHAR/DATE, dataType: ATTRIBUTE/MEASURE }
+     *
+     * @param - { columnId: string,
+     *  name: string,
+     *  type: INT64/CHAR/DATE,
+     *  dataType: ATTRIBUTE/MEASURE }
      * @example
      * ```js
-     * searchEmbed.trigger(HostEvent.OpenFilter, { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
+     * searchEmbed.trigger(HostEvent.OpenFilter,
+     *  { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
      * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     HostEvent["OpenFilter"] = "openFilter";
     /**
      * Adds the columns to the current Search.
+     *
      * @param - { columnIds: string[] }
      * @example
      * ```js
@@ -639,6 +805,7 @@ export var HostEvent;
     HostEvent["AddColumns"] = "addColumns";
     /**
      * Removes a column from the current Search.
+     *
      * @param - { columnId: string }
      * @example
      * ```js
@@ -649,6 +816,7 @@ export var HostEvent;
     HostEvent["RemoveColumn"] = "removeColumn";
     /**
      * Gets the current pinboard content.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
@@ -658,6 +826,7 @@ export var HostEvent;
     HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
     /**
      * Triggers the Pin action on an embedded object
+     *
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
      * @example
@@ -671,6 +840,7 @@ export var HostEvent;
     HostEvent["Pin"] = "pin";
     /**
      * Triggers the Show Liveboard details action on a Liveboard
+     *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.LiveboardInfo)
@@ -680,6 +850,7 @@ export var HostEvent;
     HostEvent["LiveboardInfo"] = "pinboardInfo";
     /**
      * Triggers the Schedule action on a Liveboard
+     *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.Schedule)
@@ -689,6 +860,7 @@ export var HostEvent;
     HostEvent["Schedule"] = "subscription";
     /**
      * Triggers the Manage schedule action on a Liveboard
+     *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.ScheduleList)
@@ -698,6 +870,7 @@ export var HostEvent;
     HostEvent["SchedulesList"] = "schedule-list";
     /**
      * Triggers the Export TML action on a Liveboard
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ExportTML)
@@ -707,6 +880,7 @@ export var HostEvent;
     HostEvent["ExportTML"] = "exportTSL";
     /**
      * Triggers the Edit TML action on a Liveboard
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -716,6 +890,7 @@ export var HostEvent;
     HostEvent["EditTML"] = "editTSL";
     /**
      * Triggers the Update TML action on a Liveboard
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateTML)
@@ -725,15 +900,17 @@ export var HostEvent;
     HostEvent["UpdateTML"] = "updateTSL";
     /**
      * Triggers the Download PDF action on a Liveboard
+     *
      * @example
      * ```js
-     * liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
+     * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
      * Triggers the Make a copy action on a Liveboard, search or visualization
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
@@ -745,6 +922,7 @@ export var HostEvent;
     HostEvent["MakeACopy"] = "makeACopy";
     /**
      * Triggers the Delete action on a Liveboard
+     *
      * @example
      * ```js
      * appEmbed.trigger(HostEvent.Remove)
@@ -754,6 +932,7 @@ export var HostEvent;
     HostEvent["Remove"] = "delete";
     /**
      * Triggers the Explore action on a visualization
+     *
      * @param - an object with vizId as a key
      * @example
      * ```js
@@ -764,37 +943,52 @@ export var HostEvent;
     HostEvent["Explore"] = "explore";
     /**
      * Triggers the Create alert action on a visualization
+     *
      * @param - an object with vizId as a key
      * @example
      * ```js
-     * liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * liveboardEmbed.trigger(HostEvent.CreateMonitor {
+     *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
+     * })
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["CreateMonitor"] = "createMonitor";
     /**
      * Triggers the Manage alert action on a visualization
+     *
      * @param - an object with vizId as a key
      * @example
      * ```js
-     * liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
+     *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
+     * })
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["ManageMonitor"] = "manageMonitor";
     /**
      * Triggers the Edit action on a Liveboard or visualization
-     * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+     *
+     * @param - object - to trigger the action for a specfic visualization
+     *   in Liveboard embed, pass in vizId as a key
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Edit)
-     * liveboardEmbed.trigger(HostEvent.Edit, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     *
+     * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger((HostEvent.Edit)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["Edit"] = "edit";
     /**
      * Triggers the Copy link action on a Liveboard or visualization
-     * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+     *
+     * @param - object - to trigger the action for a s
+     *  pecfic visualization in Liveboard embed, pass in vizId as a key
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.CopyLink)
@@ -806,7 +1000,9 @@ export var HostEvent;
     HostEvent["CopyLink"] = "embedDocument";
     /**
      * Triggers the Present action on a Liveboard or visualization
-     * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+     *
+     * @param - object - to trigger the action for a specfic visualization
+     *  in Liveboard embed, pass in vizId as a key
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Present)
@@ -818,119 +1014,203 @@ export var HostEvent;
     HostEvent["Present"] = "present";
     /**
      * Get TML for the current search.
+     *
      * @example
      * ```js
-     * searchEmbed.trigger(HostEvent.GetTML)
+     * searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
+     *   console.log(
+     *      tml.search_query // TML representation of the search query
+     *   );
+     * })
      * ```
      * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+     * @important
      */
     HostEvent["GetTML"] = "getTML";
     /**
      * Triggers the ShowUnderlyingData action on visualization or search
+     *
      * @param - an object with vizId as a key
      * @example
-     * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
+     *
      * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
     /**
      * Triggers the Delete action on visualization or search
+     *
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
      * @example
-     * liveboardEmbed.trigger(HostEvent.Delete, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.Delete)
+     *
      * searchEmbed.trigger(HostEvent.Delete)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
-    HostEvent["Delete"] = "delete";
+    HostEvent["Delete"] = "onDeleteAnswer";
     /**
      * Triggers the SpotIQAnalyze action on visualization or search
+     *
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
      * @example
-     * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
+     *
      * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
     /**
      * Triggers the Download action on visualization or search when Displaymode is Chart
+     *
      * @example
-     * liveboardEmbed.trigger(HostEvent.Download, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.Download, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.Download)
+     *
      * searchEmbed.trigger(HostEvent.Download)
+     * ```
+     * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
-    HostEvent["Download"] = "download";
+    HostEvent["Download"] = "downloadAsPng";
+    /**
+     * Triggers the Download action on visualization or search when Displaymode is Chart
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
+     * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+     *
+     * vizEmbed.trigger(HostEvent.DownloadAsPng)
+     *
+     * searchEmbed.trigger(HostEvent.DownloadAsPng)
+     * ```
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
+     */
+    HostEvent["DownloadAsPng"] = "downloadAsPng";
     /**
-     * Triggers the downloadAsCSV action on visualization or search when Displaymode is Table
+     * Triggers the downloadAsCSV action on visualization or search
+     *
      * @example
-     * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.DownloadAsCsv)
+     *
      * searchEmbed.trigger(HostEvent.DownloadAsCsv)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["DownloadAsCsv"] = "downloadAsCSV";
     /**
-     * Triggers the downloadAsXLSX action on visualization or search when Displaymode is Table
+     * Triggers the downloadAsXLSX action on visualization or search
+     *
      * @example
-     * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
+     *
      * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
     /**
      * Triggers the Share action on a liveboard or answer
+     *
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Share)
+     *
      * searchEmbed.trigger(HostEvent.Share)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["Share"] = "share";
     /**
      * Trigger the Save action on a liveboard or answer
+     *
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Save)
+     *
      * searchEmbed.trigger(HostEvent.Save)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["Save"] = "save";
     /**
      * Triggers the SyncToSheets action on visualization
+     *
      * @param - an object with vizId as a key
      * @example
-     * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.SyncToSheets)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["SyncToSheets"] = "sync-to-sheets";
     /**
      * Triggers the SyncToOtherApps action on visualization
+     *
      * @param - an object with vizId as a key
      * @example
-     * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.SyncToOtherApps)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
     /**
      * Triggers the ManagePipelines action on visualization
+     *
      * @param - an object with vizId as a key
      * @example
-     * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
+     * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.ManagePipelines)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     HostEvent["ManagePipelines"] = "manage-pipeline";
     /**
      * Triggers the Reset search in answer
+     *
      * @example
-     * searchEmbed.trigger(HostEvent.SearchReset
+     * ```js
+     * searchEmbed.trigger(HostEvent.ResetSearch)
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
      */
     HostEvent["ResetSearch"] = "resetSearch";
@@ -962,6 +1242,7 @@ export var DataSourceVisualMode;
 // eslint-disable-next-line no-shadow
 export var Param;
 (function (Param) {
+    Param["EmbedApp"] = "embedApp";
     Param["DataSources"] = "dataSources";
     Param["DataSourceMode"] = "dataSourceMode";
     Param["DisableActions"] = "disableAction";
@@ -1002,10 +1283,25 @@ export var Param;
     Param["ContextMenuTrigger"] = "isContextMenuEnabledOnLeftClick";
     Param["LinkOverride"] = "linkOverride";
     Param["ShowInsertToSlide"] = "insertInToSlide";
+    Param["PrimaryNavHidden"] = "primaryNavHidden";
+    Param["HideProfleAndHelp"] = "profileAndHelpInNavBarHidden";
 })(Param || (Param = {}));
 /**
  * The list of actions that can be performed on visual ThoughtSpot
  * entities, such as answers and Liveboards.
+ *
+ * This enum is used to specify the actions that could be disabled,
+ * hidden or made visible.
+ *
+ * @example
+ * ```js
+ * const embed = new LiveboardEmbed('#embed-container', {
+ *    ... // other options
+ *    visibleActions: [Action.Save, Action.Explore],
+ *    disableActions: [Action.Save],
+ *    hiddenActions: [Action.Download], // Set either this or visibleActions
+ * })
+ * ```
  */
 // eslint-disable-next-line no-shadow
 export var Action;
@@ -1102,12 +1398,18 @@ export var Action;
      * @hidden
      */
     Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
+    /**
+     * Pin action.
+     */
     Action["Pin"] = "pin";
     /**
      * @hidden
      */
     Action["AnalysisInfo"] = "analysisInfo";
     Action["Subscription"] = "subscription";
+    /**
+     * Explore action.
+     */
     Action["Explore"] = "explore";
     Action["DrillInclude"] = "context-menu-item-include";
     Action["DrillExclude"] = "context-menu-item-exclude";
@@ -1119,9 +1421,6 @@ export var Action;
     Action["DrillEdit"] = "context-menu-item-edit";
     Action["EditMeasure"] = "context-menu-item-edit-measure";
     Action["Separator"] = "context-menu-item-separator";
-    /**
-     * @hidden
-     */
     Action["DrillDown"] = "DRILL";
     Action["RequestAccess"] = "requestAccess";
     Action["QueryDetailsButtons"] = "queryDetailsButtons";
@@ -1212,6 +1511,10 @@ export var Action;
      * @hidden
      */
     Action["InsertInToSlide"] = "insertInToSlide";
+    /**
+     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+     */
+    Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
 })(Action || (Action = {}));
 // eslint-disable-next-line no-shadow
 export var OperationType;
@@ -1226,6 +1529,9 @@ export var PrefetchFeatures;
     PrefetchFeatures["LiveboardEmbed"] = "LiveboardEmbed";
     PrefetchFeatures["VizEmbed"] = "VizEmbed";
 })(PrefetchFeatures || (PrefetchFeatures = {}));
+/**
+ * Enum for options to change context trigger
+ */
 export var ContextMenuTriggerOptions;
 (function (ContextMenuTriggerOptions) {
     ContextMenuTriggerOptions["LEFT_CLICK"] = "left-click";