@thoughtspot/visual-embed-sdk 1.20.2 → 1.20.3

package/cjs/src/types.js

@@ -0,0 +1,1543 @@
+"use strict";
+/**
+ * Copyright (c) 2023
+ *
+ * TypeScript type definitions for ThoughtSpot Visual Embed SDK
+ *
+ * @summary Type definitions for Embed SDK
+ * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextMenuTriggerOptions = exports.PrefetchFeatures = exports.OperationType = exports.Action = exports.Param = exports.DataSourceVisualMode = exports.HostEvent = exports.EmbedEvent = exports.RuntimeFilterOp = exports.AuthType = void 0;
+/**
+ * The authentication mechanism for allowing access to the
+ * the embedded app
+ *
+ * @group Authentication / Init
+ */
+// eslint-disable-next-line no-shadow
+var AuthType;
+(function (AuthType) {
+    /**
+     * 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.
+     *
+     * @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
+     */
+    AuthType["SAML"] = "SSO_SAML";
+    /**
+     * SSO using SAML
+     * Will make the host application redirect to the SAML Idp. Use this
+     * when the idp does not allow itself to be embedded.
+     *
+     * 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({
+     *   // ...
+     *   authType: AuthType.SAMLRedirect,
+     *  });
+     * ```
+     *
+     * This opens the SAML Idp in a popup window. The popup is triggered
+     * when the user clicks the trigger button. The popup window will be
+     * closed automatically after authentication.
+     * @example
+     * ```js
+     * init({
+     *   // ...
+     *   authType: AuthType.SAMLRedirect,
+     *   authTriggerText: 'Login with SAML',
+     *   authTriggerContainer: '#embed-container',
+     *   inPopup: true,
+     * });
+     * ```
+     *
+     * Can also use event to trigger the popup flow. Works the same
+     * as above example.
+     * @example
+     * ```js
+     * const authEE = init({
+     *  // ...
+     *  authType: AuthType.SAMLRedirect,
+     *  inPopup: true,
+     * });
+     *
+     * someButtonOnYourPage.addEventListener('click', () => {
+     *  authEE.emit(AuthEvent.TRIGGER_SSO_POPUP);
+     * });
+     * ```
+     */
+    AuthType["SAMLRedirect"] = "SSO_SAML";
+    /**
+     * SSO using OIDC
+     *
+     * @hidden
+     * @deprecated Use {@link OIDCRedirect} instead
+     */
+    AuthType["OIDC"] = "SSO_OIDC";
+    /**
+     * SSO using OIDC
+     * Will make the host application redirect to the OIDC Idp.
+     * See code samples in {@link SAMLRedirect}.
+     */
+    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.
+     *
+     * @example
+     * ```js
+     * init({
+     *  // ...
+     *  authType: AuthType.TrustedAuthToken,
+     *  getAuthToken: () => {
+     *    return fetch('https://my-backend.app/ts-token')
+     *      .then((response) => response.json())
+     *      .then((data) => data.token);
+     *  }
+     * ```
+     */
+    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
+     *
+     * @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";
+    /**
+     * Use the ThoughtSpot login API to authenticate to the cluster directly.
+     *
+     * Warning: This feature is primarily intended for developer testing. It is
+     * strongly advised not to use this authentication method in production.
+     */
+    AuthType["Basic"] = "Basic";
+})(AuthType = exports.AuthType || (exports.AuthType = {}));
+/**
+ * A map of the supported runtime filter operations
+ */
+// eslint-disable-next-line no-shadow
+var RuntimeFilterOp;
+(function (RuntimeFilterOp) {
+    /**
+     * Equals
+     */
+    RuntimeFilterOp["EQ"] = "EQ";
+    /**
+     * Does not equal
+     */
+    RuntimeFilterOp["NE"] = "NE";
+    /**
+     * Less than
+     */
+    RuntimeFilterOp["LT"] = "LT";
+    /**
+     * Less than or equal to
+     */
+    RuntimeFilterOp["LE"] = "LE";
+    /**
+     * Greater than
+     */
+    RuntimeFilterOp["GT"] = "GT";
+    /**
+     * Greater than or equal to
+     */
+    RuntimeFilterOp["GE"] = "GE";
+    /**
+     * Contains
+     */
+    RuntimeFilterOp["CONTAINS"] = "CONTAINS";
+    /**
+     * Begins with
+     */
+    RuntimeFilterOp["BEGINS_WITH"] = "BEGINS_WITH";
+    /**
+     * Ends with
+     */
+    RuntimeFilterOp["ENDS_WITH"] = "ENDS_WITH";
+    /**
+     * Between, inclusive of higher value
+     */
+    RuntimeFilterOp["BW_INC_MAX"] = "BW_INC_MAX";
+    /**
+     * Between, inclusive of lower value
+     */
+    RuntimeFilterOp["BW_INC_MIN"] = "BW_INC_MIN";
+    /**
+     * Between, inclusive of both higher and lower value
+     */
+    RuntimeFilterOp["BW_INC"] = "BW_INC";
+    /**
+     * Between, non-inclusive
+     */
+    RuntimeFilterOp["BW"] = "BW";
+    /**
+     * Is included in this list of values
+     */
+    RuntimeFilterOp["IN"] = "IN";
+})(RuntimeFilterOp = exports.RuntimeFilterOp || (exports.RuntimeFilterOp = {}));
+/**
+ * Event types emitted by the embedded ThoughtSpot application.
+ *
+ * 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
+var EmbedEvent;
+(function (EmbedEvent) {
+    /**
+     * Rendering has initialized.
+     *
+     * @returns timestamp - The timestamp when the event was generated.
+     */
+    EmbedEvent["Init"] = "init";
+    /**
+     * Authentication has either succeeded or failed.
+     *
+     * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
+     */
+    EmbedEvent["AuthInit"] = "authInit";
+    /**
+     * The embed object container has loaded.
+     *
+     * @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 by the user.
+     *
+     * @hidden
+     */
+    EmbedEvent["FiltersChanged"] = "filtersChanged";
+    /**
+     * Search query has been updated by the user.
+     */
+    EmbedEvent["QueryChanged"] = "queryChanged";
+    /**
+     * A drill down operation has been performed.
+     *
+     * @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.
+     *
+     * @returns dataSourceIds - the list of data sources
+     */
+    EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
+    /**
+     * One or more data columns have been selected.
+     *
+     * @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
+     *
+     * @returns actionId - The id of the custom action
+     * @returns data - The answer or Liveboard data
+     */
+    EmbedEvent["CustomAction"] = "customAction";
+    /**
+     * 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";
+    /**
+     * 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.
+     *
+     * @returns error - An error object or message
+     */
+    EmbedEvent["Error"] = "Error";
+    /**
+     * The embedded object has sent an alert
+     *
+     * @returns alert - An alert object
+     */
+    EmbedEvent["Alert"] = "alert";
+    /**
+     * The ThoughtSpot auth session has expired.
+     */
+    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.
+     *
+     * @returns data - The height of the embedded Liveboard or visualization
+     * @hidden
+     */
+    EmbedEvent["EmbedHeight"] = "EMBED_HEIGHT";
+    /**
+     * The center of visible iframe viewport is calculated.
+     *
+     * @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";
+    /**
+     * Detects the route change.
+     */
+    EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
+    /**
+     * The v1 event type for Data
+     *
+     * @hidden
+     */
+    EmbedEvent["V1Data"] = "exportVizDataToParent";
+    /**
+     * Emitted when the embed does not have cookie access. This
+     * happens on Safari where third-party cookies are blocked by default.
+     *
+     * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+     */
+    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";
+    /**
+     * 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";
+    /**
+     * Emitted when the download action is triggered on an answer
+     *
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
+     */
+    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
+     *
+     * @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
+     *
+     * @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 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 = exports.EmbedEvent || (exports.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.
+ *
+ * @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
+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.
+     * @param - searchQuery - The search query
+     * @param - execute - execute the existing / updated query
+     * @example
+     * ```js
+     * searchEmbed.trigger(HostEvent.Search, {
+     *   searchQuery: "[sales] by [item type],
+     *   dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
+     *   execute: true
+     * })
+     * ```
+     */
+    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.
+     * @example
+     * ```js
+     * 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
+     * ```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"]}
+     * ])
+     * ```
+     * @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
+     * appEmbed.navigateToPage(-1)
+     * ```
+     * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
+     */
+    HostEvent["Navigate"] = "Navigate";
+    /**
+     * Opens the filter panel for a particular column.
+     * Works with Search embed.
+     *
+     * @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' })
+     * ```
+     * @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
+     * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
+     * ```
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    HostEvent["AddColumns"] = "addColumns";
+    /**
+     * Removes a column from the current Search.
+     *
+     * @param - { columnId: string }
+     * @example
+     * ```js
+     * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
+     * ```
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    HostEvent["RemoveColumn"] = "removeColumn";
+    /**
+     * Gets the current pinboard content.
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
+     * ```
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+     */
+    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
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.Pin)
+     * searchEmbed.trigger(HostEvent.Pin)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["Pin"] = "pin";
+    /**
+     * Triggers the Show Liveboard details action on a Liveboard
+     *
+     * @example
+     * ```js
+     *  liveboardEmbed.trigger(HostEvent.LiveboardInfo)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["LiveboardInfo"] = "pinboardInfo";
+    /**
+     * Triggers the Schedule action on a Liveboard
+     *
+     * @example
+     * ```js
+     *  liveboardEmbed.trigger(HostEvent.Schedule)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["Schedule"] = "subscription";
+    /**
+     * Triggers the Manage schedule action on a Liveboard
+     *
+     * @example
+     * ```js
+     *  liveboardEmbed.trigger(HostEvent.ScheduleList)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["SchedulesList"] = "schedule-list";
+    /**
+     * Triggers the Export TML action on a Liveboard
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.ExportTML)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["ExportTML"] = "exportTSL";
+    /**
+     * Triggers the Edit TML action on a Liveboard
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.EditTML)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["EditTML"] = "editTSL";
+    /**
+     * Triggers the Update TML action on a Liveboard
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.UpdateTML)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["UpdateTML"] = "updateTSL";
+    /**
+     * Triggers the Download PDF action on a Liveboard
+     *
+     * @example
+     * ```js
+     * 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'})
+     * vizEmbed.trigger(HostEvent.MakeACopy)
+     * searchEmbed.trigger(HostEvent.MakeACopy)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["MakeACopy"] = "makeACopy";
+    /**
+     * Triggers the Delete action on a Liveboard
+     *
+     * @example
+     * ```js
+     * appEmbed.trigger(HostEvent.Remove)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["Remove"] = "delete";
+    /**
+     * Triggers the Explore action on a visualization
+     *
+     * @param - an object with vizId as a key
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    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'
+     * })
+     * ```
+     * @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'
+     * })
+     * ```
+     * @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
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.Edit)
+     *
+     * 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 s
+     *  pecfic visualization in Liveboard embed, pass in vizId as a key
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.CopyLink)
+     * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger((HostEvent.CopyLink)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    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
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.Present)
+     * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger((HostEvent.Present)
+     * ```
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    HostEvent["Present"] = "present";
+    /**
+     * Get TML for the current search.
+     *
+     * @example
+     * ```js
+     * 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
+     * ```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
+     * ```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"] = "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
+     * ```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
+     * ```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"] = "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
+     *
+     * @example
+     * ```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
+     *
+     * @example
+     * ```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
+     * ```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
+     * ```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
+     * ```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
+     * ```js
+     * searchEmbed.trigger(HostEvent.ResetSearch)
+     * ```
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
+     */
+    HostEvent["ResetSearch"] = "resetSearch";
+})(HostEvent = exports.HostEvent || (exports.HostEvent = {}));
+/**
+ * The different visual modes that the data sources panel within
+ * search could appear in, i.e., hidden, collapsed, or expanded.
+ */
+// eslint-disable-next-line no-shadow
+var DataSourceVisualMode;
+(function (DataSourceVisualMode) {
+    /**
+     * Data source panel is hidden.
+     */
+    DataSourceVisualMode["Hidden"] = "hide";
+    /**
+     * Data source panel is collapsed, but the user can manually expand it.
+     */
+    DataSourceVisualMode["Collapsed"] = "collapse";
+    /**
+     * Data source panel is expanded, but the user can manually collapse it.
+     */
+    DataSourceVisualMode["Expanded"] = "expand";
+})(DataSourceVisualMode = exports.DataSourceVisualMode || (exports.DataSourceVisualMode = {}));
+/**
+ * The query params passed down to the embedded ThoughtSpot app
+ * containing configuration and/or visual information.
+ */
+// eslint-disable-next-line no-shadow
+var Param;
+(function (Param) {
+    Param["EmbedApp"] = "embedApp";
+    Param["DataSources"] = "dataSources";
+    Param["DataSourceMode"] = "dataSourceMode";
+    Param["DisableActions"] = "disableAction";
+    Param["DisableActionReason"] = "disableHint";
+    Param["ForceTable"] = "forceTable";
+    Param["preventLiveboardFilterRemoval"] = "preventPinboardFilterRemoval";
+    Param["SearchQuery"] = "searchQuery";
+    Param["HideActions"] = "hideAction";
+    Param["HideObjects"] = "hideObjects";
+    Param["HostAppUrl"] = "hostAppUrl";
+    Param["EnableVizTransformations"] = "enableVizTransform";
+    Param["EnableSearchAssist"] = "enableSearchAssist";
+    Param["HideResult"] = "hideResult";
+    Param["UseLastSelectedDataSource"] = "useLastSelectedSources";
+    Param["Tag"] = "tag";
+    Param["searchTokenString"] = "searchTokenString";
+    Param["executeSearch"] = "executeSearch";
+    Param["fullHeight"] = "isFullHeightPinboard";
+    Param["livedBoardEmbed"] = "isLiveboardEmbed";
+    Param["searchEmbed"] = "isSearchEmbed";
+    Param["vizEmbed"] = "isVizEmbed";
+    Param["Version"] = "sdkVersion";
+    Param["ViewPortHeight"] = "viewPortHeight";
+    Param["ViewPortWidth"] = "viewPortWidth";
+    Param["VisibleActions"] = "visibleAction";
+    Param["CustomCSSUrl"] = "customCssUrl";
+    Param["DisableLoginRedirect"] = "disableLoginRedirect";
+    Param["visibleVizs"] = "pinboardVisibleVizs";
+    Param["LiveboardV2Enabled"] = "isPinboardV2Enabled";
+    Param["ShowAlerts"] = "showAlerts";
+    Param["Locale"] = "locale";
+    Param["CustomStyle"] = "customStyle";
+    Param["ForceSAMLAutoRedirect"] = "forceSAMLAutoRedirect";
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    Param["AuthType"] = "authType";
+    Param["IconSpriteUrl"] = "iconSprite";
+    Param["cookieless"] = "cookieless";
+    Param["ContextMenuTrigger"] = "isContextMenuEnabledOnLeftClick";
+    Param["LinkOverride"] = "linkOverride";
+    Param["ShowInsertToSlide"] = "insertInToSlide";
+    Param["PrimaryNavHidden"] = "primaryNavHidden";
+    Param["HideProfleAndHelp"] = "profileAndHelpInNavBarHidden";
+})(Param = exports.Param || (exports.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
+var Action;
+(function (Action) {
+    Action["Save"] = "save";
+    /**
+     * @hidden
+     */
+    Action["Update"] = "update";
+    /**
+     * @hidden
+     */
+    Action["SaveUntitled"] = "saveUntitled";
+    Action["SaveAsView"] = "saveAsView";
+    Action["MakeACopy"] = "makeACopy";
+    Action["EditACopy"] = "editACopy";
+    Action["CopyLink"] = "embedDocument";
+    /**
+     * @hidden
+     */
+    Action["ResetLayout"] = "resetLayout";
+    Action["Schedule"] = "subscription";
+    Action["SchedulesList"] = "schedule-list";
+    Action["Share"] = "share";
+    Action["AddFilter"] = "addFilter";
+    Action["ConfigureFilter"] = "configureFilter";
+    Action["CollapseDataSources"] = "collapseDataSources";
+    Action["ChooseDataSources"] = "chooseDataSources";
+    Action["AddFormula"] = "addFormula";
+    Action["AddParameter"] = "addParameter";
+    /**
+     * @hidden
+     */
+    Action["SearchOnTop"] = "searchOnTop";
+    Action["SpotIQAnalyze"] = "spotIQAnalyze";
+    /**
+     * @hidden
+     */
+    Action["ExplainInsight"] = "explainInsight";
+    /**
+     * @hidden
+     */
+    Action["SpotIQFollow"] = "spotIQFollow";
+    Action["ShareViz"] = "shareViz";
+    /**
+     * @hidden
+     */
+    Action["ReplaySearch"] = "replaySearch";
+    Action["ShowUnderlyingData"] = "showUnderlyingData";
+    Action["Download"] = "download";
+    Action["DownloadAsPng"] = "downloadAsPng";
+    Action["DownloadAsPdf"] = "downloadAsPdf";
+    Action["DownloadAsCsv"] = "downloadAsCSV";
+    Action["DownloadAsXlsx"] = "downloadAsXLSX";
+    /**
+     * @hidden
+     */
+    Action["DownloadTrace"] = "downloadTrace";
+    Action["ExportTML"] = "exportTSL";
+    Action["ImportTML"] = "importTSL";
+    Action["UpdateTML"] = "updateTSL";
+    Action["EditTML"] = "editTSL";
+    Action["Present"] = "present";
+    Action["ToggleSize"] = "toggleSize";
+    Action["Edit"] = "edit";
+    Action["EditTitle"] = "editTitle";
+    Action["Remove"] = "delete";
+    /**
+     * @hidden
+     */
+    Action["Ungroup"] = "ungroup";
+    /**
+     * @hidden
+     */
+    Action["Describe"] = "describe";
+    /**
+     * @hidden
+     */
+    Action["Relate"] = "relate";
+    /**
+     * @hidden
+     */
+    Action["CustomizeHeadlines"] = "customizeHeadlines";
+    /**
+     * @hidden
+     */
+    Action["PinboardInfo"] = "pinboardInfo";
+    Action["LiveboardInfo"] = "pinboardInfo";
+    /**
+     * @hidden
+     */
+    Action["SendAnswerFeedback"] = "sendFeedback";
+    /**
+     * @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";
+    Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
+    Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
+    /**
+     * @hidden
+     */
+    Action["DrillEdit"] = "context-menu-item-edit";
+    Action["EditMeasure"] = "context-menu-item-edit-measure";
+    Action["Separator"] = "context-menu-item-separator";
+    Action["DrillDown"] = "DRILL";
+    Action["RequestAccess"] = "requestAccess";
+    Action["QueryDetailsButtons"] = "queryDetailsButtons";
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     */
+    Action["AnswerDelete"] = "onDeleteAnswer";
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     */
+    Action["AnswerChartSwitcher"] = "answerChartSwitcher";
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     */
+    Action["AddToFavorites"] = "addToFavorites";
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     */
+    Action["EditDetails"] = "editDetails";
+    /**
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     */
+    Action["CreateMonitor"] = "createMonitor";
+    /**
+     * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     */
+    Action["ReportError"] = "reportError";
+    Action["SyncToSheets"] = "sync-to-sheets";
+    Action["SyncToOtherApps"] = "sync-to-other-apps";
+    Action["ManagePipelines"] = "manage-pipeline";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["CrossFilter"] = "context-menu-item-cross-filter";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuAggregate"] = "axisMenuAggregate";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuFilter"] = "axisMenuFilter";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuSort"] = "axisMenuSort";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuGroup"] = "axisMenuGroup";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuPosition"] = "axisMenuPosition";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuRename"] = "axisMenuRename";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuEdit"] = "axisMenuEdit";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
+    /**
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     */
+    Action["AxisMenuRemove"] = "axisMenuRemove";
+    /**
+     * @hidden
+     */
+    Action["InsertInToSlide"] = "insertInToSlide";
+    /**
+     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+     */
+    Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
+})(Action = exports.Action || (exports.Action = {}));
+// eslint-disable-next-line no-shadow
+var OperationType;
+(function (OperationType) {
+    OperationType["GetChartWithData"] = "GetChartWithData";
+    OperationType["GetTableWithHeadlineData"] = "GetTableWithHeadlineData";
+})(OperationType = exports.OperationType || (exports.OperationType = {}));
+var PrefetchFeatures;
+(function (PrefetchFeatures) {
+    PrefetchFeatures["FullApp"] = "FullApp";
+    PrefetchFeatures["SearchEmbed"] = "SearchEmbed";
+    PrefetchFeatures["LiveboardEmbed"] = "LiveboardEmbed";
+    PrefetchFeatures["VizEmbed"] = "VizEmbed";
+})(PrefetchFeatures = exports.PrefetchFeatures || (exports.PrefetchFeatures = {}));
+/**
+ * Enum for options to change context trigger
+ */
+var ContextMenuTriggerOptions;
+(function (ContextMenuTriggerOptions) {
+    ContextMenuTriggerOptions["LEFT_CLICK"] = "left-click";
+    ContextMenuTriggerOptions["RIGHT_CLICK"] = "right-click";
+})(ContextMenuTriggerOptions = exports.ContextMenuTriggerOptions || (exports.ContextMenuTriggerOptions = {}));
+//# sourceMappingURL=types.js.map