@thoughtspot/visual-embed-sdk 1.28.4 → 1.28.5

package/dist/visual-embed-sdk-react.d.ts

@@ -2081,6 +2081,23 @@ export interface EmbedConfig {
             * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
             */
         currencyFormat?: string;
+        /**
+            * This flag is used to disable the token verification in the SDK.
+            * Enabling this flag will also disable the caching of the token.
+            *
+            * @hidden
+            *
+            * @example
+            * ```js
+            * init({
+            *   ...embedConfig,
+            *   disableTokenVerification : true
+            * })
+            * ```
+            *
+            * @version SDK: 1.28.5 | Thoughtspot: *
+            */
+        disableTokenVerification?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -2731,6 +2748,8 @@ export declare enum EmbedEvent {
         /**
             * Authentication has either succeeded or failed.
             *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+            *
             * @example
             *```js
             * appEmbed.on(EmbedEvent.AuthInit, payload => {
@@ -2744,6 +2763,8 @@ export declare enum EmbedEvent {
             * The embed object container has loaded.
             *
             * @returns timestamp - The timestamp when the event was generated.
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             *```js
             * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
@@ -2758,6 +2779,8 @@ export declare enum EmbedEvent {
             * Data pertaining to answer or Liveboard is received
             *
             * @return data - The answer or Liveboard data
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             *```js
             * liveboardEmbed.on(EmbedEvent.Data, payload => {
@@ -2776,6 +2799,7 @@ export declare enum EmbedEvent {
         /**
             * Search query has been updated by the user.
             *
+            * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
             * @example
             *```js
             * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
@@ -2785,12 +2809,14 @@ export declare enum EmbedEvent {
         /**
             * A drill-down operation has been performed.
             *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+            *
             * @returns additionalFilters - Any additional filters applied
             * @returns drillDownColumns - The columns on which drill down was performed
             * @returns nonFilteredColumns - The columns that were not filtered
             * @example
             *```js
-            * searchEmbed.trigger(EmbedEvent.DrillDown, {
+            * searchEmbed.on(EmbedEvent.DrillDown, {
             *    points: {
             *        clickedPoint,
             *        selectedPoints: selectedPoint
@@ -2823,6 +2849,8 @@ export declare enum EmbedEvent {
             * One or more data sources have been selected.
             *
             * @returns dataSourceIds - the list of data sources
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
@@ -2850,6 +2878,8 @@ export declare enum EmbedEvent {
             * @returns actionId - ID of the custom action
             * @returns payload {@link CustomActionPayload} - Response payload with the
             * Answer or Liveboard data
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             * ```js
             * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -2897,22 +2927,23 @@ export declare enum EmbedEvent {
         /**
             * An error has occurred. This event is fired for the following error types:
             *
-            *  API - API call failure error.
+            * `API`: API call failure error.
             *
-            *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen
-            *  mode.
+            * `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen mode.
             *
-            *  SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
+            * `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
             *
-            *  NON_EXIST_FILTER - Error due to a non-existent filter.
+            * `NON_EXIST_FILTER`: Error due to a non-existent filter.
             *
-            *  INVALID_DATE_VALUE - Invalid date value error.
+            * `INVALID_DATE_VALUE`: Invalid date value error.
             *
-            *  INVALID_OPERATOR - Use of invalid operator during filter application.
+            * `INVALID_OPERATOR`: Use of invalid operator during filter application.
             *
-            *  For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
+            *  For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
             *
             * @returns error - An error object or message
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             * ```js
             * // API error
@@ -2938,6 +2969,9 @@ export declare enum EmbedEvent {
             * The embedded object has sent an alert.
             *
             * @returns alert - An alert object
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+            *
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.Alert)
@@ -2947,6 +2981,8 @@ export declare enum EmbedEvent {
         /**
             * The ThoughtSpot auth session has expired.
             *
+            * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
+            *
             * @example
             *```js
             * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
@@ -3000,6 +3036,7 @@ export declare enum EmbedEvent {
         /**
             * Detects the route change.
             *
+            * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
             * @example
             *```js
             * searchEmbed.on(EmbedEvent.RouteChange, payload =>
@@ -3016,7 +3053,7 @@ export declare enum EmbedEvent {
         /**
             * Emitted when the embed does not have cookie access. This happens
             * when Safari and other Web browsers block third-party cookies
-            * are blocked by default. `NoCookieAccess` can trigger
+            * are blocked by default.
             *
             * @example
             *```js
@@ -3059,7 +3096,7 @@ export declare enum EmbedEvent {
         /**
             * Emitted when the Liveboard shell loads.
             * You can use this event as a hook to trigger
-            * other events on the rendered Liveboard.
+            * actions on the rendered Liveboard.
             *
             * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
             * @example
@@ -3080,8 +3117,7 @@ export declare enum EmbedEvent {
             */
         LiveboardRendered = "PinboardRendered",
         /**
-            * This can be used to register an event listener which
-            * is triggered on all events.
+            * Emits all events.
             *
             * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
             * @example
@@ -3098,13 +3134,13 @@ export declare enum EmbedEvent {
             * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //Emit when action starts
             *  searchEmbed.on(EmbedEvent.Save, payload => {
             *    console.log('Save', payload)
             *  }, {
             *    start: true
             * })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.Save, payload => {
             *    console.log('Save', payload)
             * })
@@ -3114,7 +3150,7 @@ export declare enum EmbedEvent {
         /**
             * Emitted when the download action is triggered on an answer
             *
-            * **Note**: This event is deprecated in v1.21.0.
+            *  **Note**:  This event is deprecated in v1.21.0.
             * To fire an event when a download action is initiated on a chart or table,
             * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
             * or `EmbedEvent.DownloadAsXLSX`
@@ -3122,7 +3158,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(HostEvent.Download, {
+            * liveboardEmbed.on(EmbedEvent.Download, {
             * vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             *```
@@ -3134,10 +3170,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
             *   console.log('download PNG', payload)}, {start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
             *   console.log('download PNG', payload)})
             *```
@@ -3149,10 +3185,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
             *   console.log('download PDF', payload)}, {start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
             *   console.log('download PDF', payload)})
             *```
@@ -3164,10 +3200,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
             *   console.log('download CSV', payload)}, {start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
             *    console.log('download CSV', payload)})
             *```
@@ -3179,10 +3215,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
             *   console.log('download Xlsx', payload)}, { start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
             *   console.log('download Xlsx', payload)})
             *```
@@ -3194,10 +3230,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
             *    console.log('delete answer', payload)}, {start: true })
-            * //trigger when action is completed
+            * //emit when action is completed
             * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
             *    console.log('delete answer', payload)})
             *```
@@ -3209,13 +3245,13 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.Pin, payload => {
             *    console.log('pin', payload)
             * }, {
             * start: true
             * })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.Pin, payload => {
             *    console.log('pin', payload)
             * })
@@ -3228,13 +3264,13 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
             *   console.log('SpotIQAnalyze', payload)
             * }, {
             * start: true
             * })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
             *   console.log('SpotIQ analyze', payload)
             * })
@@ -3247,13 +3283,13 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.Share, payload => {
             *    console.log('Share', payload)
             * }, {
             * start: true
             * })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.Share, payload => {
             *   console.log('Share', payload)
             * })
@@ -3328,10 +3364,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.ExportTML, payload => {
             *     console.log('Export TML', payload)}, { start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.ExportTML, payload => {
             *     console.log('Export TML', payload)})
             *```
@@ -3355,10 +3391,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
             *    console.log('Copy and edit', payload)}, {start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
             *    console.log('Copy and edit', payload)})
             *```
@@ -3460,7 +3496,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(HostEvent.Present)
+            * liveboardEmbed.on(EmbedEvent.Present)
             *```
             * @example
             *```js
@@ -3476,7 +3512,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.Delete,
+            * liveboardEmbed.on(EmbedEvent.Delete,
             *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
             */
@@ -3487,7 +3523,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.SchedulesList)
+            * liveboardEmbed.on(EmbedEvent.SchedulesList)
             *```
             */
         SchedulesList = "schedule-list",
@@ -3497,7 +3533,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.Cancel)
+            * liveboardEmbed.on(EmbedEvent.Cancel)
             *```
             */
         Cancel = "cancel",
@@ -3507,7 +3543,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.Explore,  {
+            * liveboardEmbed.on(EmbedEvent.Explore,  {
             *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
             */
@@ -3518,7 +3554,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.CopyLink, {
+            * liveboardEmbed.on(EmbedEvent.CopyLink, {
             *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
             */
@@ -3529,7 +3565,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
+            * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
             *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
             */
@@ -3553,9 +3589,18 @@ export declare enum EmbedEvent {
             */
         InsertIntoSlide = "insertInToSlide",
         /**
-            * @hidden
             * Emitted when a user changes any filter on a Liveboard.
+            * Returns filter type and name, column name and ID, and runtime
+            * filter details.
+            *
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
+            * @example
+            *
+            *```js
+            * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
+            *    console.log('payload', payload);
+            * })
+            *```
             */
         FilterChanged = "filterChanged",
         /**
@@ -4090,7 +4135,7 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
             *   console.log(
-            *      tml.search_query // TML representation of the search query
+            *      tml.answer.search_query // TML representation of the search query
             *   );
             * })
             * ```
@@ -4333,7 +4378,7 @@ export declare enum HostEvent {
             *
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
-            *  filter: { column: 'column name', oper: 'IN', values: [1,2,3], is_mandatory: false }
+            *  filter: { column: 'column name', oper: 'IN', values: [1,2,3]}
             * })
             * ```
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -5471,7 +5516,7 @@ export declare enum Action {
             * disabledActions: [Action.TML] // to disable all TML actions
             * ```
             *
-            * @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
+            * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
             */
         TML = "tml",
         /**