@thoughtspot/visual-embed-sdk 1.44.4 → 1.44.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +32 -0
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +7 -4
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/app.spec.js +18 -7
  7. package/cjs/src/embed/app.spec.js.map +1 -1
  8. package/cjs/src/embed/conversation.d.ts +10 -6
  9. package/cjs/src/embed/conversation.d.ts.map +1 -1
  10. package/cjs/src/embed/conversation.js +12 -2
  11. package/cjs/src/embed/conversation.js.map +1 -1
  12. package/cjs/src/embed/conversation.spec.js +3 -0
  13. package/cjs/src/embed/conversation.spec.js.map +1 -1
  14. package/cjs/src/embed/embed.spec.js +1 -0
  15. package/cjs/src/embed/embed.spec.js.map +1 -1
  16. package/cjs/src/embed/liveboard.d.ts +32 -0
  17. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  18. package/cjs/src/embed/liveboard.js +7 -4
  19. package/cjs/src/embed/liveboard.js.map +1 -1
  20. package/cjs/src/embed/liveboard.spec.js +46 -33
  21. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  22. package/cjs/src/embed/pinboard.spec.js +1 -0
  23. package/cjs/src/embed/pinboard.spec.js.map +1 -1
  24. package/cjs/src/embed/search.d.ts.map +1 -1
  25. package/cjs/src/embed/search.js +6 -1
  26. package/cjs/src/embed/search.js.map +1 -1
  27. package/cjs/src/embed/search.spec.js +2 -0
  28. package/cjs/src/embed/search.spec.js.map +1 -1
  29. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  30. package/cjs/src/embed/ts-embed.js +7 -3
  31. package/cjs/src/embed/ts-embed.js.map +1 -1
  32. package/cjs/src/embed/ts-embed.spec.js +1 -0
  33. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  34. package/cjs/src/types.d.ts +140 -141
  35. package/cjs/src/types.d.ts.map +1 -1
  36. package/cjs/src/types.js +127 -117
  37. package/cjs/src/types.js.map +1 -1
  38. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
  39. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  40. package/cjs/src/utils/graphql/answerService/answer-queries.js +0 -1
  41. package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  42. package/cjs/src/utils/graphql/answerService/answerService.spec.js +0 -1
  43. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  44. package/dist/{index-C5FAW929.js → index-_2rRJf4J.js} +1 -1
  45. package/dist/src/embed/app.d.ts +32 -0
  46. package/dist/src/embed/app.d.ts.map +1 -1
  47. package/dist/src/embed/conversation.d.ts +10 -6
  48. package/dist/src/embed/conversation.d.ts.map +1 -1
  49. package/dist/src/embed/liveboard.d.ts +32 -0
  50. package/dist/src/embed/liveboard.d.ts.map +1 -1
  51. package/dist/src/embed/search.d.ts.map +1 -1
  52. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  53. package/dist/src/types.d.ts +140 -141
  54. package/dist/src/types.d.ts.map +1 -1
  55. package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
  56. package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  57. package/dist/tsembed-react.es.js +169 -135
  58. package/dist/tsembed-react.js +168 -134
  59. package/dist/tsembed.es.js +169 -135
  60. package/dist/tsembed.js +168 -134
  61. package/dist/visual-embed-sdk-react-full.d.ts +207 -129
  62. package/dist/visual-embed-sdk-react.d.ts +207 -129
  63. package/dist/visual-embed-sdk.d.ts +212 -146
  64. package/lib/package.json +1 -1
  65. package/lib/src/embed/app.d.ts +32 -0
  66. package/lib/src/embed/app.d.ts.map +1 -1
  67. package/lib/src/embed/app.js +7 -4
  68. package/lib/src/embed/app.js.map +1 -1
  69. package/lib/src/embed/app.spec.js +18 -7
  70. package/lib/src/embed/app.spec.js.map +1 -1
  71. package/lib/src/embed/conversation.d.ts +10 -6
  72. package/lib/src/embed/conversation.d.ts.map +1 -1
  73. package/lib/src/embed/conversation.js +12 -2
  74. package/lib/src/embed/conversation.js.map +1 -1
  75. package/lib/src/embed/conversation.spec.js +3 -0
  76. package/lib/src/embed/conversation.spec.js.map +1 -1
  77. package/lib/src/embed/embed.spec.js +1 -0
  78. package/lib/src/embed/embed.spec.js.map +1 -1
  79. package/lib/src/embed/liveboard.d.ts +32 -0
  80. package/lib/src/embed/liveboard.d.ts.map +1 -1
  81. package/lib/src/embed/liveboard.js +7 -4
  82. package/lib/src/embed/liveboard.js.map +1 -1
  83. package/lib/src/embed/liveboard.spec.js +46 -33
  84. package/lib/src/embed/liveboard.spec.js.map +1 -1
  85. package/lib/src/embed/pinboard.spec.js +1 -0
  86. package/lib/src/embed/pinboard.spec.js.map +1 -1
  87. package/lib/src/embed/search.d.ts.map +1 -1
  88. package/lib/src/embed/search.js +6 -1
  89. package/lib/src/embed/search.js.map +1 -1
  90. package/lib/src/embed/search.spec.js +2 -0
  91. package/lib/src/embed/search.spec.js.map +1 -1
  92. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  93. package/lib/src/embed/ts-embed.js +7 -3
  94. package/lib/src/embed/ts-embed.js.map +1 -1
  95. package/lib/src/embed/ts-embed.spec.js +1 -0
  96. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  97. package/lib/src/types.d.ts +140 -141
  98. package/lib/src/types.d.ts.map +1 -1
  99. package/lib/src/types.js +127 -117
  100. package/lib/src/types.js.map +1 -1
  101. package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
  102. package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  103. package/lib/src/utils/graphql/answerService/answer-queries.js +0 -1
  104. package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  105. package/lib/src/utils/graphql/answerService/answerService.spec.js +0 -1
  106. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  107. package/package.json +1 -1
  108. package/src/embed/app.spec.ts +25 -7
  109. package/src/embed/app.ts +44 -5
  110. package/src/embed/conversation.spec.ts +3 -0
  111. package/src/embed/conversation.ts +22 -8
  112. package/src/embed/embed.spec.ts +1 -0
  113. package/src/embed/liveboard.spec.ts +62 -42
  114. package/src/embed/liveboard.ts +42 -5
  115. package/src/embed/pinboard.spec.ts +1 -0
  116. package/src/embed/search.spec.ts +2 -0
  117. package/src/embed/search.ts +6 -1
  118. package/src/embed/ts-embed.spec.ts +1 -0
  119. package/src/embed/ts-embed.ts +7 -3
  120. package/src/types.ts +144 -144
  121. package/src/utils/graphql/answerService/answer-queries.ts +0 -1
  122. package/src/utils/graphql/answerService/answerService.spec.ts +0 -1
@@ -1186,7 +1186,7 @@ export interface EmbedConfig {
1186
1186
  /**
1187
1187
  * [AuthServer] The trusted authentication endpoint to use to get the
1188
1188
  * authentication token. A `GET` request is made to the
1189
- * authentication API endpoint, which returns the token
1189
+ * authentication API endpoint, which returns the token
1190
1190
  * as a plaintext response. For trusted authentication,
1191
1191
  * the `authEndpoint` or `getAuthToken` attribute is required.
1192
1192
  */
@@ -1296,12 +1296,12 @@ export interface EmbedConfig {
1296
1296
  * When there are multiple objects embedded, queue the rendering of embedded objects
1297
1297
  * to start after the previous embed's render is complete. This helps improve
1298
1298
  * performance by decreasing the load on the browser.
1299
- * @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
1299
+ * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
1300
1300
  * @default false
1301
1301
  */
1302
1302
  queueMultiRenders?: boolean;
1303
1303
  /**
1304
- * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
1304
+ * [AuthServer|Basic] Detect if third-party cookies are enabled by doing an
1305
1305
  * additional call. This is slower and should be avoided. Listen to the
1306
1306
  * `NO_COOKIE_ACCESS` event to handle the situation.
1307
1307
  *
@@ -2080,21 +2080,26 @@ export interface SearchLiveboardCommonViewConfig {
2080
2080
  /**
2081
2081
  * Boolean to exclude runtimeFilters in the URL
2082
2082
  * By default it is true, this flag removes runtime filters from the URL
2083
- * when set to false, runtime filters will be included in the URL.
2083
+ * (default behavior from SDK 1.45.0).
2084
+ * when set to false, runtime filters will be included in the URL
2085
+ * (default behavior before SDK 1.45.0).
2084
2086
  *
2085
2087
  * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
2086
2088
  * embedded view.
2087
- * @default false
2089
+ * @default true
2088
2090
  * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
2089
2091
  */
2090
2092
  excludeRuntimeFiltersfromURL?: boolean;
2091
2093
  /**
2092
2094
  * Boolean to exclude runtimeParameters from the URL
2093
- * when set to true, this flag removes runtime parameters from the URL.
2095
+ * when set to true, this flag removes runtime parameters from the URL
2096
+ * (default behavior from SDK 1.45.0).
2097
+ * when set to false, runtime parameters will be included in the URL
2098
+ * (default behavior before SDK 1.45.0).
2094
2099
  *
2095
2100
  * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
2096
2101
  * embedded view.
2097
- * @default false
2102
+ * @default true
2098
2103
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
2099
2104
  */
2100
2105
  excludeRuntimeParametersfromURL?: boolean;
@@ -2332,22 +2337,6 @@ export interface LiveboardAppEmbedViewConfig {
2332
2337
  * ```
2333
2338
  */
2334
2339
  coverAndFilterOptionInPDF?: boolean;
2335
- /**
2336
- * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
2337
- * To enable this feature on your instance, contact ThoughtSpot Support.
2338
- *
2339
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2340
- * @version SDK: 1.41.0 | ThoughtSpot: 26.3.0.cl
2341
- * @example
2342
- * ```js
2343
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
2344
- * const embed = new <EmbedComponent>('#tsEmbed', {
2345
- * ... // other embed view config
2346
- * liveboardXLSXCSVDownload: true,
2347
- * })
2348
- * ```
2349
- */
2350
- liveboardXLSXCSVDownload?: boolean;
2351
2340
  /**
2352
2341
  * This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
2353
2342
  * When enabled, a unified modal is used to manage and update multiple filters at once,
@@ -2555,7 +2544,11 @@ declare enum HomepageModule {
2555
2544
  }
2556
2545
  declare enum ListPageColumns {
2557
2546
  /**
2558
- * Favourite
2547
+ * Favorites
2548
+ */
2549
+ Favorites = "FAVOURITE",
2550
+ /**
2551
+ * @deprecated Use {@link ListPageColumns.Favorites} instead.
2559
2552
  */
2560
2553
  Favourite = "FAVOURITE",
2561
2554
  /**
@@ -2573,7 +2566,11 @@ declare enum ListPageColumns {
2573
2566
  /**
2574
2567
  * Share
2575
2568
  */
2576
- Share = "SHARE"
2569
+ Share = "SHARE",
2570
+ /**
2571
+ * Verified badge/column
2572
+ */
2573
+ Verified = "VERIFIED"
2577
2574
  }
2578
2575
  /**
2579
2576
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
@@ -2823,7 +2820,7 @@ export declare enum EmbedEvent {
2823
2820
  /**
2824
2821
  * An error has occurred. This event is fired for the following error types:
2825
2822
  *
2826
- * `API` - API call failure error.
2823
+ * `API` - API call failure.
2827
2824
  * `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
2828
2825
  * mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
2829
2826
  * filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
@@ -3554,20 +3551,20 @@ export declare enum EmbedEvent {
3554
3551
  /**
3555
3552
  *
3556
3553
  * This event can be emitted to intercept search execution initiated by
3557
- * the users and implement the logic to allow or restrict search execution.
3558
- * You can can also show custom error text if the search query must be
3554
+ * users and implement logic to allow or restrict search execution.
3555
+ * You can also show custom error text if the search query must be
3559
3556
  * restricted due to your application or business requirements.
3560
3557
 
3561
3558
  * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
3562
3559
  * for this embed event to get emitted.
3563
- * @param:payload The payload received from the embed related to the Data API call.
3564
- * @param:responder
3565
- * Contains elements that lets developers define whether ThoughtSpot
3566
- * should run the search, and if not, what error message
3567
- * should be shown to the user.
3560
+ * @param - Includes the following event listener parameters:
3561
+ * - `payload`: The payload received from the embed related to the Data API call.
3562
+ * - `responder`: Contains elements that let developers define whether ThoughtSpot
3563
+ * should run the search, and if not, what error message
3564
+ * should be shown to the user.
3568
3565
  *
3569
- * `execute` - When execute returns `true`, the search will be run.
3570
- * When execute returns `false`, the search will not be executed.
3566
+ * `execute` - When `execute` returns `true`, the search will be run.
3567
+ * When `execute` returns `false`, the search will not be executed.
3571
3568
  *
3572
3569
  * `error` - Developers can customize the error message text when `execute`
3573
3570
  * is `false` using the `errorText` and `errorDescription` parameters in responder.
@@ -3739,7 +3736,7 @@ export declare enum EmbedEvent {
3739
3736
  * console.log('payload', payload);
3740
3737
  * })
3741
3738
  * ```
3742
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3739
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
3743
3740
  */
3744
3741
  DataModelInstructions = "DataModelInstructions",
3745
3742
  /**
@@ -3957,14 +3954,14 @@ export declare enum HostEvent {
3957
3954
  * the search query string.
3958
3955
  * Supported in `AppEmbed` and `SearchEmbed` deployments.
3959
3956
  * Includes the following properties:
3960
- * @param - `searchQuery` - query string with search tokens
3961
- * @param - `dataSources` - Data source GUID to Search on
3962
- * - Although an array, only a single source
3963
- * is supported.
3964
- * @param - `execute` - executes search and updates the existing query
3957
+ * @param - Includes the following keys:
3958
+ * - `searchQuery`: Query string with search tokens.
3959
+ * - `dataSources`: Data source GUID to search on.
3960
+ * Although an array, only a single source is supported.
3961
+ * - `execute`: Executes search and updates the existing query.
3965
3962
  * @example
3966
3963
  * ```js
3967
- * searchembed.trigger(HostEvent.Search, {
3964
+ * searchEmbed.trigger(HostEvent.Search, {
3968
3965
  searchQuery: "[sales] by [item type]",
3969
3966
  dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
3970
3967
  execute: true
@@ -3975,16 +3972,15 @@ export declare enum HostEvent {
3975
3972
  /**
3976
3973
  * Triggers a drill on certain points of the specified column
3977
3974
  * Includes the following properties:
3978
- * @param - points - an object containing selectedPoints/clickedPoints
3979
- * to drill to. For example, { selectedPoints: []}
3980
- * @param - columnGuid - Optional. GUID of the column to drill
3981
- * by. If not provided it will auto drill by the configured
3982
- * column.
3983
- * @param - autoDrillDown - Optional. If true, the drill down will be
3984
- * done automatically on the most popular column.
3985
- * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
3986
- * in case of a Liveboard.
3987
- * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3975
+ * @param - Includes the following keys:
3976
+ * - `points`: An object containing `selectedPoints` and/or `clickedPoint`
3977
+ * to drill to. For example, `{ selectedPoints: [] }`.
3978
+ * - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
3979
+ * it will auto drill by the configured column.
3980
+ * - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
3981
+ * on the most popular column.
3982
+ * - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
3983
+ * of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
3988
3984
  * @example
3989
3985
  * ```js
3990
3986
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -4077,14 +4073,12 @@ export declare enum HostEvent {
4077
4073
  * and `AppEmbed` only. In full application embedding, this event updates
4078
4074
  * the runtime filters applied on the Liveboard and saved Answer objects.
4079
4075
  *
4080
- * @param - Pass an array of {@link RuntimeFilter} with the following attributes:
4081
- * `columnName` - _String_. The name of the column to filter on.
4082
- *
4083
- * `operator` - {@link RuntimeFilterOp} to apply. For more information,
4084
- * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
4085
- *
4086
- * `values` - List of operands. Some operators such as EQ and LE allow a
4087
- * single value, whereas BW and IN accept multiple values.
4076
+ * @param - Array of {@link RuntimeFilter} objects. Each item includes:
4077
+ * - `columnName`: Name of the column to filter on.
4078
+ * - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
4079
+ * link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
4080
+ * - `values`: List of operands. Some operators such as EQ and LE allow a single
4081
+ * value, whereas BW and IN accept multiple values.
4088
4082
  *
4089
4083
  * **Note**: Updating runtime filters resets the ThoughtSpot
4090
4084
  * object to its original state and applies new filter conditions.
@@ -4107,7 +4101,7 @@ export declare enum HostEvent {
4107
4101
  /**
4108
4102
  * Navigate to a specific page in the embedded ThoughtSpot application.
4109
4103
  * This is the same as calling `appEmbed.navigateToPage(path, true)`.
4110
- * @param - `path` - the path to navigate to to go forward or back. The path value can
4104
+ * @param - `path` - the path to navigate to go forward or back. The path value can
4111
4105
  * be a number; for example, `1`, `-1`.
4112
4106
  * @example
4113
4107
  * ```js
@@ -4178,30 +4172,25 @@ export declare enum HostEvent {
4178
4172
  * for the Answer that the user is currently on
4179
4173
  * and a modal opens for Liveboard selection.
4180
4174
  * To add an Answer or visualization to a Liveboard programmatically without
4181
- * showing requiring additional user input via *Pin to Liveboard* modal, define
4175
+ * requiring additional user input via the *Pin to Liveboard* modal, define
4182
4176
  * the following parameters:
4183
4177
  *
4184
- * @param
4185
- * `vizId`- GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
4186
- * Optional when pinning a new chart or table generated from a Search query.
4187
- * **Required** in Spotter Embed.
4188
- * @param
4189
- * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,
4190
- * specify the `newLiveboardName` parameter to create a new Liveboard.
4191
- * @param
4192
- * `tabId` - GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
4193
- * specified in the code.
4194
- * @param
4195
- * `newVizName` - Name string for the Answer or visualization. If defined,
4196
- * this parameter adds a new visualization object or creates a copy of the
4197
- * Answer or visualization specified in `vizId`.
4198
- * Required attribute.
4199
- * @param
4200
- * `newLiveboardName` - Name string for the Liveboard.
4201
- * Creates a new Liveboard object with the specified name.
4202
- * @param
4203
- * `newTabName` - Name of the tab. Adds a new tab Liveboard specified
4204
- * in the code.
4178
+ * @param - Includes the following keys:
4179
+ * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
4180
+ * Optional when pinning a new chart or table generated from a Search query.
4181
+ * **Required** in Spotter Embed.
4182
+ * - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
4183
+ * specify the `newLiveboardName` parameter to create a new Liveboard.
4184
+ * - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
4185
+ * specified in the code.
4186
+ * - `newVizName`: Name string for the Answer or visualization. If defined,
4187
+ * this parameter adds a new visualization object or creates a copy of the
4188
+ * Answer or visualization specified in `vizId`.
4189
+ * Required.
4190
+ * - `newLiveboardName`: Name string for the Liveboard.
4191
+ * Creates a new Liveboard object with the specified name.
4192
+ * - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
4193
+ * in the code.
4205
4194
  *
4206
4195
  * @example
4207
4196
  * ```js
@@ -4441,9 +4430,9 @@ export declare enum HostEvent {
4441
4430
  * on a Liveboard.
4442
4431
  *
4443
4432
  * This event is not supported in visualization embed and search embed.
4444
- * @param - object - To trigger the action for a specific visualization
4445
- * in Liveboard embed, pass in `vizId` as a key.
4446
- * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
4433
+ * @param - Object parameter. Includes the following keys:
4434
+ * - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
4435
+ * pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
4447
4436
  *
4448
4437
  * @example
4449
4438
  * ```js
@@ -4810,10 +4799,9 @@ export declare enum HostEvent {
4810
4799
  GetFilters = "getFilters",
4811
4800
  /**
4812
4801
  * Update one or several filters applied on a Liveboard.
4813
- * @param - `filter`: a single filter object containing column name,
4814
- * filter operator, and values.
4815
- * @param - `filters`: multiple filter objects with column name, filter operator,
4816
- * and values for each.
4802
+ * @param - Includes the following keys:
4803
+ * - `filter`: A single filter object containing column name, filter operator, and values.
4804
+ * - `filters`: Multiple filter objects with column name, filter operator, and values for each.
4817
4805
  *
4818
4806
  * Each filter object must include the following attributes:
4819
4807
  *
@@ -4939,8 +4927,9 @@ export declare enum HostEvent {
4939
4927
  SetHiddenTabs = "SetPinboardHiddenTabs",
4940
4928
  /**
4941
4929
  * Updates the search query string for Natural Language Search operations.
4942
- * @param - `queryString`: Text string in Natural Language format
4943
- * @param - `executeSearch`: Boolean to execute search and update search query
4930
+ * @param - Includes the following keys:
4931
+ * - `queryString`: Text string in Natural Language format.
4932
+ * - `executeSearch`: Boolean to execute search and update search query.
4944
4933
  * @example
4945
4934
  * ```js
4946
4935
  * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -5019,11 +5008,10 @@ export declare enum HostEvent {
5019
5008
  /**
5020
5009
  * Triggers an action to update Parameter values on embedded
5021
5010
  * Answers, Liveboard, and Spotter answer in Edit mode.
5022
- * @param - `name` - Name of the Parameter
5023
- * @param - `value` - The value to set for the Parameter.
5024
- *
5025
- * Optionally, to control the visibility of the Parameter chip,
5026
- * use the `isVisibleToUser` attribute when applying an override.
5011
+ * @param - Includes the following keys for each item:
5012
+ * - `name`: Name of the parameter.
5013
+ * - `value`: The value to set for the parameter.
5014
+ * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
5027
5015
  *
5028
5016
  * @example
5029
5017
  * ```js
@@ -5081,11 +5069,10 @@ export declare enum HostEvent {
5081
5069
  * If no parameters are specified, the save action is
5082
5070
  * triggered with a modal to prompt users to
5083
5071
  * add a name and description for the Answer.
5084
- * @param - `vizId` refers to the Answer ID in Spotter embed
5085
- * and is required in Spotter embed.
5086
- * Optional attributes to set Answer properties include:
5087
- * @param - `name` - Name string for the Answer.
5088
- * @param - `description` - Description text for the Answer.
5072
+ * @param - Includes the following keys:
5073
+ * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
5074
+ * - `name`: Optional. Name string for the Answer.
5075
+ * - `description`: Optional. Description text for the Answer.
5089
5076
  * @example
5090
5077
  * ```js
5091
5078
  * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -5134,8 +5121,9 @@ export declare enum HostEvent {
5134
5121
  /**
5135
5122
  * Triggers a search operation with the search tokens specified in
5136
5123
  * the search query string in spotter embed.
5137
- * @param - `query`: Text string in Natural Language format
5138
- * @param - `executeSearch`: Boolean to execute search and update search query
5124
+ * @param - Includes the following keys:
5125
+ * - `query`: Text string in Natural Language format.
5126
+ * - `executeSearch`: Boolean to execute search and update search query.
5139
5127
  * @example
5140
5128
  * ```js
5141
5129
  * spotterEmbed.trigger(HostEvent.SpotterSearch, {
@@ -5182,7 +5170,7 @@ export declare enum HostEvent {
5182
5170
  * ```js
5183
5171
  * spotterEmbed.trigger(HostEvent.DataModelInstructions);
5184
5172
  * ```
5185
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5173
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
5186
5174
  */
5187
5175
  DataModelInstructions = "DataModelInstructions",
5188
5176
  /**
@@ -5267,7 +5255,7 @@ export declare enum HostEvent {
5267
5255
  */
5268
5256
  UpdateEmbedParams = "updateEmbedParams",
5269
5257
  /**
5270
- * Triggered when the embed is needed to be destroyed. This is used to clean up any embed related resources internally.
5258
+ * Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
5271
5259
  * @example
5272
5260
  * ```js
5273
5261
  * liveboardEmbed.trigger(HostEvent.DestroyEmbed);
@@ -5275,11 +5263,12 @@ export declare enum HostEvent {
5275
5263
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5276
5264
  */
5277
5265
  DestroyEmbed = "EmbedDestroyed",
5278
- /** Triggers a create new conversation operation in spotter embed.
5279
- * @example
5280
- * ```js
5266
+ /**
5267
+ * Triggers a new conversation in Spotter embed.
5268
+ *
5281
5269
  * This feature is available only when chat history is enabled on your ThoughtSpot instance.
5282
5270
  * Contact your admin or ThoughtSpot Support to enable chat history on your instance.
5271
+ *
5283
5272
  * @example
5284
5273
  * ```js
5285
5274
  * spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
@@ -5331,7 +5320,7 @@ export declare enum DataSourceVisualMode {
5331
5320
  * hiddenActions: [Action.Edit, ActionAction.Explore],
5332
5321
  * })
5333
5322
  * ```
5334
- * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
5323
+ * See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
5335
5324
  */
5336
5325
  export declare enum Action {
5337
5326
  /**
@@ -5618,6 +5607,16 @@ export declare enum Action {
5618
5607
  * ```
5619
5608
  */
5620
5609
  DownloadAsXlsx = "downloadAsXLSX",
5610
+ /**
5611
+ * The **Download Liveboard** menu action on a Liveboard.
5612
+ * Allows downloading the entire Liveboard.
5613
+ * @example
5614
+ * ```js
5615
+ * disabledActions: [Action.DownloadLiveboard]
5616
+ * ```
5617
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
5618
+ */
5619
+ DownloadLiveboard = "downloadLiveboard",
5621
5620
  /**
5622
5621
  * @hidden
5623
5622
  */
@@ -5957,28 +5956,28 @@ export declare enum Action {
5957
5956
  CrossFilter = "context-menu-item-cross-filter",
5958
5957
  /**
5959
5958
  * The **Sync to Slack** action on Liveboard visualizations.
5960
- * Allows sending data to third-party apps Slack
5959
+ * Allows sending data to third-party apps like Slack.
5961
5960
  * @example
5962
5961
  * ```js
5963
5962
  * disabledActions: [Action.SyncToSlack]
5964
5963
  * ```
5965
- * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5964
+ * @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5966
5965
  */
5967
5966
  SyncToSlack = "syncToSlack",
5968
5967
  /**
5969
5968
  * The **Sync to Teams** action on Liveboard visualizations.
5970
- * Allows sending data to third-party apps Team
5969
+ * Allows sending data to third-party apps like Microsoft Teams.
5971
5970
  * @example
5972
5971
  * ```js
5973
5972
  * disabledActions: [Action.SyncToTeams]
5974
5973
  * ```
5975
- * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5974
+ * @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5976
5975
  */
5977
5976
  SyncToTeams = "syncToTeams",
5978
5977
  /**
5979
5978
  * The **Remove** action that appears when cross filters are applied
5980
5979
  * on a Liveboard.
5981
- * Removes filters applied o a visualization.
5980
+ * Removes filters applied to a visualization.
5982
5981
  * @example
5983
5982
  * ```js
5984
5983
  * disabledActions: [Action.RemoveCrossFilter]
@@ -6164,7 +6163,7 @@ export declare enum Action {
6164
6163
  AddTab = "addTab",
6165
6164
  /**
6166
6165
  *
6167
- *Initiates contextual change analysis on KPI charts.
6166
+ * Initiates contextual change analysis on KPI charts.
6168
6167
  * @example
6169
6168
  * ```js
6170
6169
  * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -6174,7 +6173,7 @@ export declare enum Action {
6174
6173
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
6175
6174
  /**
6176
6175
  * Action ID to hide or disable Iterative Change Analysis option
6177
- * on contextual change analysis Inisght charts context menu
6176
+ * in the contextual change analysis Insight charts context menu.
6178
6177
  *
6179
6178
  * @example
6180
6179
  * ```js
@@ -6452,6 +6451,17 @@ export declare enum Action {
6452
6451
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6453
6452
  */
6454
6453
  ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
6454
+ /**
6455
+ * The **Data model instructions** button on the Spotter interface.
6456
+ * Allows opening the data model instructions modal.
6457
+ *
6458
+ * @example
6459
+ * ```js
6460
+ * hiddenAction: [Action.DataModelInstructions]
6461
+ * ```
6462
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6463
+ */
6464
+ DataModelInstructions = "DataModelInstructions",
6455
6465
  /**
6456
6466
  * The **Preview data** button on the Spotter interface.
6457
6467
  * Allows previewing the data used for Spotter queries.
@@ -6537,12 +6547,12 @@ export declare enum Action {
6537
6547
  */
6538
6548
  CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
6539
6549
  /**
6540
- * Action ID for hide or disable the
6541
- * Spotter in conversation training widget.
6542
- * The Add to Coaching feature is currently in beta
6543
- * and is disabled by default on embed deployments.
6544
- * To enable this feature on your instance,
6545
- * contact ThoughtSpot Support.
6550
+ * Action ID to hide or disable the Spotter in the conversation training widget.
6551
+ * When disabled, users cannot access **Add to Coaching**, which allows adding reference
6552
+ * questions and business terms to improve Spotter’s responses.
6553
+ * The **Add to Coaching** feature is generally available from version 26.2.0.cl and
6554
+ * enabled by default on embed deployments.
6555
+
6546
6556
  * @example
6547
6557
  * ```js
6548
6558
  * hiddenAction: [Action.InConversationTraining]
@@ -8755,6 +8765,38 @@ export interface AppViewConfig extends AllEmbedViewConfig {
8755
8765
  * ```
8756
8766
  */
8757
8767
  isPNGInScheduledEmailsEnabled?: boolean;
8768
+ /**
8769
+ * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
8770
+ *
8771
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
8772
+ * @type {boolean}
8773
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8774
+ * @example
8775
+ * ```js
8776
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
8777
+ * const embed = new <EmbedComponent>('#tsEmbed', {
8778
+ * ... // other embed view config
8779
+ * isLiveboardXLSXCSVDownloadEnabled: true,
8780
+ * })
8781
+ * ```
8782
+ */
8783
+ isLiveboardXLSXCSVDownloadEnabled?: boolean;
8784
+ /**
8785
+ * This flag is used to enable/disable the granular XLSX/CSV schedules feature
8786
+ *
8787
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
8788
+ * @type {boolean}
8789
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8790
+ * @example
8791
+ * ```js
8792
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
8793
+ * const embed = new <EmbedComponent>('#tsEmbed', {
8794
+ * ... // other embed view config
8795
+ * isGranularXLSXCSVSchedulesEnabled: true,
8796
+ * })
8797
+ * ```
8798
+ */
8799
+ isGranularXLSXCSVSchedulesEnabled?: boolean;
8758
8800
  /**
8759
8801
  * This flag is used to enable the full height lazy load data.
8760
8802
  *
@@ -9224,6 +9266,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9224
9266
  * ```
9225
9267
  */
9226
9268
  isPNGInScheduledEmailsEnabled?: boolean;
9269
+ /**
9270
+ * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
9271
+ *
9272
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
9273
+ * @type {boolean}
9274
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9275
+ * @example
9276
+ * ```js
9277
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
9278
+ * const embed = new <EmbedComponent>('#tsEmbed', {
9279
+ * ... // other embed view config
9280
+ * isLiveboardXLSXCSVDownloadEnabled: true,
9281
+ * })
9282
+ * ```
9283
+ */
9284
+ isLiveboardXLSXCSVDownloadEnabled?: boolean;
9285
+ /**
9286
+ * This flag is used to enable/disable the granular XLSX/CSV schedules feature
9287
+ *
9288
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
9289
+ * @type {boolean}
9290
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9291
+ * @example
9292
+ * ```js
9293
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
9294
+ * const embed = new <EmbedComponent>('#tsEmbed', {
9295
+ * ... // other embed view config
9296
+ * isGranularXLSXCSVSchedulesEnabled: true,
9297
+ * })
9298
+ * ```
9299
+ */
9300
+ isGranularXLSXCSVSchedulesEnabled?: boolean;
9227
9301
  /**
9228
9302
  * This flag is used to enable the full height lazy load data.
9229
9303
  *
@@ -9529,11 +9603,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9529
9603
  runtimeFilters?: RuntimeFilter[];
9530
9604
  /**
9531
9605
  * Flag to control whether runtime filters should be included in the URL.
9532
- * If true, filters will be passed via app initialization payload instead.
9533
- * If false/undefined, filters will be added to URL (default behavior).
9606
+ * If true, filters will be passed via app initialization payload
9607
+ * (default behavior from SDK 1.45.0).
9608
+ * If false/undefined, filters are appended to the iframe URL instead.
9609
+ * (default behavior before SDK 1.45.0).
9534
9610
  *
9535
9611
  * Supported embed types: `SpotterEmbed`
9536
- * @default false
9612
+ * @default true
9537
9613
  * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9538
9614
  */
9539
9615
  excludeRuntimeFiltersfromURL?: boolean;
@@ -9558,11 +9634,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9558
9634
  runtimeParameters?: RuntimeParameter[];
9559
9635
  /**
9560
9636
  * Flag to control whether runtime parameters should be included in the URL.
9561
- * If true, parameters will be passed via app initialization payload instead.
9562
- * If false/undefined, parameters will be added to URL (default behavior).
9637
+ * If true, parameters will be passed via app
9638
+ * initialization payload (default behavior from SDK 1.45.0).
9639
+ * If false/undefined, parameters are appended to
9640
+ * the iframe URL instead (default behavior before SDK 1.45.0).
9563
9641
  *
9564
9642
  * Supported embed types: `SpotterEmbed`
9565
- * @default false
9643
+ * @default true
9566
9644
  * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9567
9645
  */
9568
9646
  excludeRuntimeParametersfromURL?: boolean;