@thoughtspot/visual-embed-sdk 1.35.10 → 1.35.12

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 (133) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +11 -2
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js.map +1 -1
  5. package/cjs/src/embed/hostEventClient/contracts.d.ts +1 -1
  6. package/cjs/src/embed/hostEventClient/contracts.js +1 -1
  7. package/cjs/src/embed/liveboard.d.ts +7 -4
  8. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  9. package/cjs/src/embed/liveboard.js +4 -3
  10. package/cjs/src/embed/liveboard.js.map +1 -1
  11. package/cjs/src/embed/liveboard.spec.js +17 -1
  12. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  13. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  14. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  15. package/cjs/src/embed/searchEmbed-basic-auth.spec.js +104 -0
  16. package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
  17. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  18. package/cjs/src/embed/ts-embed.js +5 -2
  19. package/cjs/src/embed/ts-embed.js.map +1 -1
  20. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  21. package/cjs/src/embed/ts-embed.spec.js +110 -0
  22. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  23. package/cjs/src/hostEventsTypeMapping.d.ts +2 -0
  24. package/cjs/src/hostEventsTypeMapping.d.ts.map +1 -0
  25. package/cjs/src/hostEventsTypeMapping.js +4 -0
  26. package/cjs/src/hostEventsTypeMapping.js.map +1 -0
  27. package/cjs/src/types.d.ts +298 -161
  28. package/cjs/src/types.d.ts.map +1 -1
  29. package/cjs/src/types.js +274 -133
  30. package/cjs/src/types.js.map +1 -1
  31. package/cjs/src/utils/embedApi/contracts.d.ts +101 -0
  32. package/cjs/src/utils/embedApi/contracts.d.ts.map +1 -0
  33. package/cjs/src/utils/embedApi/contracts.js +17 -0
  34. package/cjs/src/utils/embedApi/contracts.js.map +1 -0
  35. package/cjs/src/utils/embedApi/embedApiClient.d.ts +12 -0
  36. package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  37. package/cjs/src/utils/embedApi/embedApiClient.js +46 -0
  38. package/cjs/src/utils/embedApi/embedApiClient.js.map +1 -0
  39. package/cjs/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  40. package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  41. package/cjs/src/utils/embedApi/processEmbedApi.js +18 -0
  42. package/cjs/src/utils/embedApi/processEmbedApi.js.map +1 -0
  43. package/dist/{index-DWOIXXJ1.js → index-BBBimG1x.js} +1 -1
  44. package/dist/index-BGnxP5NY.js +7370 -0
  45. package/dist/index-CENLvayL.js +7370 -0
  46. package/dist/index-CbltIawo.js +7370 -0
  47. package/dist/index-CoQfqaHj.js +7370 -0
  48. package/dist/index-CzwzS0P4.js +7370 -0
  49. package/dist/index-D-9WUCUl.js +7370 -0
  50. package/dist/index-DFwi_pV_.js +7370 -0
  51. package/dist/index-DOIjN0N_.js +7370 -0
  52. package/dist/index-DYBx8SuE.js +7370 -0
  53. package/dist/index-DaLHJaLd.js +7370 -0
  54. package/dist/index-DnJX-gN2.js +7370 -0
  55. package/dist/index-IDmSUe93.js +7370 -0
  56. package/dist/index-nWevLycs.js +7370 -0
  57. package/dist/src/embed/app.d.ts +11 -2
  58. package/dist/src/embed/app.d.ts.map +1 -1
  59. package/dist/src/embed/hostEventClient/contracts.d.ts +1 -1
  60. package/dist/src/embed/liveboard.d.ts +7 -4
  61. package/dist/src/embed/liveboard.d.ts.map +1 -1
  62. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  63. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  64. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  65. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  66. package/dist/src/hostEventsTypeMapping.d.ts +2 -0
  67. package/dist/src/hostEventsTypeMapping.d.ts.map +1 -0
  68. package/dist/src/types.d.ts +298 -161
  69. package/dist/src/types.d.ts.map +1 -1
  70. package/dist/src/utils/embedApi/contracts.d.ts +101 -0
  71. package/dist/src/utils/embedApi/contracts.d.ts.map +1 -0
  72. package/dist/src/utils/embedApi/embedApiClient.d.ts +12 -0
  73. package/dist/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  74. package/dist/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  75. package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  76. package/dist/tsembed-react.es.js +287 -142
  77. package/dist/tsembed-react.js +286 -141
  78. package/dist/tsembed.es.js +287 -142
  79. package/dist/tsembed.js +286 -141
  80. package/dist/visual-embed-sdk-react-full.d.ts +316 -167
  81. package/dist/visual-embed-sdk-react.d.ts +316 -167
  82. package/dist/visual-embed-sdk.d.ts +316 -167
  83. package/lib/package.json +1 -1
  84. package/lib/src/embed/app.d.ts +11 -2
  85. package/lib/src/embed/app.d.ts.map +1 -1
  86. package/lib/src/embed/app.js.map +1 -1
  87. package/lib/src/embed/hostEventClient/contracts.d.ts +1 -1
  88. package/lib/src/embed/hostEventClient/contracts.js +1 -1
  89. package/lib/src/embed/liveboard.d.ts +7 -4
  90. package/lib/src/embed/liveboard.d.ts.map +1 -1
  91. package/lib/src/embed/liveboard.js +4 -3
  92. package/lib/src/embed/liveboard.js.map +1 -1
  93. package/lib/src/embed/liveboard.spec.js +17 -1
  94. package/lib/src/embed/liveboard.spec.js.map +1 -1
  95. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  96. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  97. package/lib/src/embed/searchEmbed-basic-auth.spec.js +101 -0
  98. package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
  99. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  100. package/lib/src/embed/ts-embed.js +5 -2
  101. package/lib/src/embed/ts-embed.js.map +1 -1
  102. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  103. package/lib/src/embed/ts-embed.spec.js +111 -1
  104. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  105. package/lib/src/hostEventsTypeMapping.d.ts +2 -0
  106. package/lib/src/hostEventsTypeMapping.d.ts.map +1 -0
  107. package/lib/src/hostEventsTypeMapping.js +2 -0
  108. package/lib/src/hostEventsTypeMapping.js.map +1 -0
  109. package/lib/src/types.d.ts +298 -161
  110. package/lib/src/types.d.ts.map +1 -1
  111. package/lib/src/types.js +274 -133
  112. package/lib/src/types.js.map +1 -1
  113. package/lib/src/utils/embedApi/contracts.d.ts +101 -0
  114. package/lib/src/utils/embedApi/contracts.d.ts.map +1 -0
  115. package/lib/src/utils/embedApi/contracts.js +14 -0
  116. package/lib/src/utils/embedApi/contracts.js.map +1 -0
  117. package/lib/src/utils/embedApi/embedApiClient.d.ts +12 -0
  118. package/lib/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  119. package/lib/src/utils/embedApi/embedApiClient.js +42 -0
  120. package/lib/src/utils/embedApi/embedApiClient.js.map +1 -0
  121. package/lib/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  122. package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  123. package/lib/src/utils/embedApi/processEmbedApi.js +14 -0
  124. package/lib/src/utils/embedApi/processEmbedApi.js.map +1 -0
  125. package/lib/src/visual-embed-sdk.d.ts +317 -168
  126. package/package.json +1 -1
  127. package/src/embed/app.ts +11 -2
  128. package/src/embed/hostEventClient/contracts.ts +1 -1
  129. package/src/embed/liveboard.spec.ts +23 -2
  130. package/src/embed/liveboard.ts +11 -8
  131. package/src/embed/ts-embed.spec.ts +160 -1
  132. package/src/embed/ts-embed.ts +4 -4
  133. package/src/types.ts +300 -164
package/lib/src/types.js CHANGED
@@ -14,7 +14,7 @@
14
14
  export var AuthType;
15
15
  (function (AuthType) {
16
16
  /**
17
- * No authentication on the SDK. Passthrough to the embedded App. Alias for
17
+ * No authentication on the SDK. Pass-through to the embedded App. Alias for
18
18
  * `Passthrough`.
19
19
  * @example
20
20
  * ```js
@@ -275,7 +275,7 @@ export var RuntimeFilterOp;
275
275
  * **Note**: This option does not apply to the classic homepage.
276
276
  * To access the updated modular homepage, set
277
277
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
278
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
278
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
279
279
  */
280
280
  // eslint-disable-next-line no-shadow
281
281
  export var HomepageModule;
@@ -1088,7 +1088,7 @@ export var EmbedEvent;
1088
1088
  */
1089
1089
  EmbedEvent["Explore"] = "explore";
1090
1090
  /**
1091
- * Emitted when a user clicks **Copy link** action on a visualization
1091
+ * Emitted when a user clicks **Copy link** action on a visualization.
1092
1092
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1093
1093
  * @example
1094
1094
  *```js
@@ -1138,23 +1138,26 @@ export var EmbedEvent;
1138
1138
  */
1139
1139
  EmbedEvent["FilterChanged"] = "filterChanged";
1140
1140
  /**
1141
- * Emitted when a user clicks the **Go** button on the sage embed
1142
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1141
+ * Emitted when a user clicks the **Go** button to initiate
1142
+ * a Natural Language Search query
1143
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1143
1144
  */
1144
1145
  EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
1145
1146
  /**
1146
- * Emitted when a user selects a data source on the sage embed
1147
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1147
+ * Emitted when a user selects a data source on the embedded
1148
+ * Natural Language Search interface.
1149
+ *
1150
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1148
1151
  */
1149
1152
  EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
1150
1153
  /**
1151
1154
  * Emitted when a user updates a connection on the **Data** page
1152
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
1155
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1153
1156
  */
1154
1157
  EmbedEvent["UpdateConnection"] = "updateConnection";
1155
1158
  /**
1156
1159
  * Emitted when a user updates a connection on the **Data** page
1157
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
1160
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1158
1161
  */
1159
1162
  EmbedEvent["CreateConnection"] = "createConnection";
1160
1163
  /**
@@ -1164,7 +1167,7 @@ export var EmbedEvent;
1164
1167
  * @returns viewId: string
1165
1168
  * @returns liveboardId: string
1166
1169
  * @returns isPublic: boolean
1167
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1170
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1168
1171
  */
1169
1172
  EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
1170
1173
  /**
@@ -1173,7 +1176,7 @@ export var EmbedEvent;
1173
1176
  * @returns viewId: string
1174
1177
  * @returns liveboardId: string
1175
1178
  * @returns isPublic: boolean
1176
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1179
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1177
1180
  */
1178
1181
  EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
1179
1182
  /**
@@ -1182,28 +1185,28 @@ export var EmbedEvent;
1182
1185
  * @returns viewId: string
1183
1186
  * @returns liveboardId: string
1184
1187
  * @returns isPublic: boolean
1185
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1188
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1186
1189
  */
1187
1190
  EmbedEvent["ResetLiveboard"] = "resetLiveboard";
1188
1191
  /**
1189
1192
  * Emitted when a PersonalisedView is deleted.
1190
1193
  * @returns views: string[]
1191
1194
  * @returns liveboardId: string
1192
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1195
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1193
1196
  */
1194
1197
  EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
1195
1198
  /**
1196
1199
  * Emitted when a user creates a new worksheet
1197
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
1200
+ * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
1198
1201
  */
1199
1202
  EmbedEvent["CreateWorksheet"] = "createWorksheet";
1200
1203
  /**
1201
- * Emitted when Ask Sage is initialized.
1204
+ * Emitted when the *Ask Sage* is initialized.
1202
1205
  * @returns viewName: string
1203
1206
  * @returns viewId: string
1204
1207
  * @returns liveboardId: string
1205
1208
  * @returns isPublic: boolean
1206
- * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
1209
+ * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
1207
1210
  */
1208
1211
  EmbedEvent["AskSageInit"] = "AskSageInit";
1209
1212
  /**
@@ -1231,7 +1234,7 @@ export var EmbedEvent;
1231
1234
  *
1232
1235
  * error: Developers can customize the error message text when `execute`
1233
1236
  * returns `false` using the error parameter in responder.
1234
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
1237
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
1235
1238
  * @example
1236
1239
  *```js
1237
1240
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -1279,9 +1282,26 @@ export var EmbedEvent;
1279
1282
  * console.log('payload', payload);
1280
1283
  * })
1281
1284
  *```
1282
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
1285
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
1283
1286
  */
1284
1287
  EmbedEvent["ParameterChanged"] = "parameterChanged";
1288
+ /**
1289
+ * Emitted when the table viz renders.
1290
+ * You can use this event as a hook to trigger
1291
+ * other events on the rendered table viz data.
1292
+ * @example
1293
+ * ```js
1294
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
1295
+ * console.log(payload);
1296
+ * const columnDataLite = payload.data.data.columnDataLite;
1297
+ * columnDataLite[0].dataValue[0]="new fob";
1298
+ * console.log('>>> new Data', columnDataLite);
1299
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
1300
+ * })
1301
+ * ```
1302
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
1303
+ */
1304
+ EmbedEvent["TableVizRendered"] = "TableVizRendered";
1285
1305
  })(EmbedEvent || (EmbedEvent = {}));
1286
1306
  /**
1287
1307
  * Event types that can be triggered by the host application
@@ -1428,7 +1448,7 @@ export var HostEvent;
1428
1448
  * const url = embed.trigger(HostEvent.GetIframeUrl);
1429
1449
  * console.log("iFrameURL",url);
1430
1450
  * ```
1431
- * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
1451
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1432
1452
  */
1433
1453
  HostEvent["GetIframeUrl"] = "GetIframeUrl";
1434
1454
  /**
@@ -1461,6 +1481,11 @@ export var HostEvent;
1461
1481
  * attributes passed with this event are appended to the existing runtime
1462
1482
  * filters applied on a Liveboard.
1463
1483
  *
1484
+ * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
1485
+ * and `AppEmbed` only. In full application embedding, this event updates
1486
+ * the runtime filters applied on the Liveboard and saved Answer objects.
1487
+ *
1488
+ *
1464
1489
  * Pass an array of runtime filters with the following attributes:
1465
1490
  *
1466
1491
  * `columnName` - _String_. The name of the column to filter on.
@@ -1471,9 +1496,12 @@ export var HostEvent;
1471
1496
  * `values` - List of operands. Some operators such as EQ and LE allow a
1472
1497
  * single value, whereas BW and IN accept multiple values.
1473
1498
  *
1474
- * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
1475
- * and `AppEmbed` only. In full application embedding, this event updates
1476
- * the runtime filters applied on the Liveboard and saved Answer objects.
1499
+ * **Note**: Updating runtime filters resets the ThoughtSpot
1500
+ * object to its original state and applies new filter conditions.
1501
+ * Any user changes (like drilling into a visualization)
1502
+ * will be cleared, restoring the original visualization
1503
+ * with the updated filters.
1504
+ *
1477
1505
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1478
1506
  * @example
1479
1507
  * ```js
@@ -1488,7 +1516,7 @@ export var HostEvent;
1488
1516
  HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
1489
1517
  /**
1490
1518
  * Navigate to a specific page in the embedded ThoughtSpot application.
1491
- * This is the same as calling `appEmbed.navigateToPage(path, true)`
1519
+ * This is the same as calling `appEmbed.navigateToPage(path, true)`.
1492
1520
  * @param - `path` - the path to navigate to to go forward or back. The path value can
1493
1521
  * be a number; for example, `1`, `-1`.
1494
1522
  * @example
@@ -1684,7 +1712,7 @@ export var HostEvent;
1684
1712
  * @param - an object with `vizId` as a key
1685
1713
  * @example
1686
1714
  * ```js
1687
- * liveboardEmbed.trigger(HostEvent.CreateMonitor {
1715
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
1688
1716
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1689
1717
  * })
1690
1718
  * ```
@@ -1783,7 +1811,9 @@ export var HostEvent;
1783
1811
  */
1784
1812
  HostEvent["GetTML"] = "getTML";
1785
1813
  /**
1786
- * Trigger the **Show underlying data** action on visualization or search
1814
+ * Trigger the **Show underlying data** action on a
1815
+ * chart or table.
1816
+ *
1787
1817
  * @param - an object with vizId as a key
1788
1818
  * @example
1789
1819
  * ```js
@@ -1817,8 +1847,8 @@ export var HostEvent;
1817
1847
  */
1818
1848
  HostEvent["Delete"] = "onDeleteAnswer";
1819
1849
  /**
1820
- * Trigger the **SpotIQ analyze** action on visualization
1821
- * or search.
1850
+ * Trigger the **SpotIQ analyze** action on a
1851
+ * chart or table.
1822
1852
  * @param - Liveboard embed takes `vizId` as a
1823
1853
  * key. Can be left undefined when embedding Search or
1824
1854
  * visualization.
@@ -2091,7 +2121,7 @@ export var HostEvent;
2091
2121
  * '430496d6-6903-4601-937e-2c691821af3c',
2092
2122
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
2093
2123
  * ```
2094
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2124
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2095
2125
  */
2096
2126
  HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
2097
2127
  /**
@@ -2104,7 +2134,7 @@ export var HostEvent;
2104
2134
  * '630496d6-6903-4601-937e-2c691821af3c',
2105
2135
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
2106
2136
  * ```
2107
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2137
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2108
2138
  */
2109
2139
  HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
2110
2140
  /**
@@ -2118,7 +2148,7 @@ export var HostEvent;
2118
2148
  * executeSearch: true,
2119
2149
  * })
2120
2150
  * ```
2121
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
2151
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2122
2152
  */
2123
2153
  HostEvent["UpdateSageQuery"] = "updateSageQuery";
2124
2154
  /**
@@ -2135,21 +2165,22 @@ export var HostEvent;
2135
2165
  * ```js
2136
2166
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
2137
2167
  * ```
2138
- * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
2168
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
2139
2169
  */
2140
2170
  HostEvent["GetAnswerSession"] = "getAnswerSession";
2141
2171
  /**
2142
- * Trigger Ask Sage for viz
2172
+ * Trigger the *Ask Sage* action for visualizations
2143
2173
  * @example
2144
2174
  * ```js
2145
2175
  * liveboardEmbed.trigger(HostEvent.AskSage,
2146
2176
  * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
2147
2177
  * ```
2148
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
2178
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
2149
2179
  */
2150
2180
  HostEvent["AskSage"] = "AskSage";
2151
2181
  /**
2152
- * Trigger cross filter update action on a Liveboard
2182
+ * Trigger cross filter update action on a Liveboard.
2183
+ *
2153
2184
  * @example
2154
2185
  * ```js
2155
2186
  * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -2160,7 +2191,7 @@ export var HostEvent;
2160
2191
  * ],
2161
2192
  * });
2162
2193
  * ```
2163
- * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
2194
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
2164
2195
  */
2165
2196
  HostEvent["UpdateCrossFilter"] = "UpdateCrossFilter";
2166
2197
  /**
@@ -2169,11 +2200,13 @@ export var HostEvent;
2169
2200
  * ```js
2170
2201
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
2171
2202
  * ```
2172
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
2203
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
2173
2204
  */
2174
2205
  HostEvent["ResetLiveboardPersonalisedView"] = "ResetLiveboardPersonalisedView";
2175
2206
  /**
2176
- * Triggers an event to Update Parameter values for Answers and Liveboard
2207
+ * Triggers an action to update Parameter values on embedded
2208
+ * Answers and Liveboard.
2209
+ *
2177
2210
  * @example
2178
2211
  * ```js
2179
2212
  * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -2181,30 +2214,30 @@ export var HostEvent;
2181
2214
  * value: "almond"
2182
2215
  * }])
2183
2216
  *
2184
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
2217
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
2185
2218
  */
2186
2219
  HostEvent["UpdateParameters"] = "UpdateParameters";
2187
2220
  /**
2188
- * Triggers GetParameters to fetch the runtime parameters
2221
+ * Triggers GetParameters to fetch the runtime Parameters.
2189
2222
  * ```js
2190
2223
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
2191
2224
  * console.log('parameters', parameter);
2192
2225
  * });
2193
2226
  *```
2194
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
2227
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
2195
2228
  */
2196
2229
  HostEvent["GetParameters"] = "GetParameters";
2197
2230
  /**
2198
- * Triggers an event to update a persoanlised view of a Liveboard
2231
+ * Triggers an event to update a personalized view of a Liveboard.
2199
2232
  * ```js
2200
2233
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
2201
2234
  * ```
2202
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
2235
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2203
2236
  */
2204
2237
  HostEvent["UpdatePersonalisedView"] = "UpdatePersonalisedView";
2205
2238
  /**
2206
- * Triggers the action to get the current view of the liveboard
2207
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
2239
+ * Triggers the action to get the current view of the Liveboard.
2240
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2208
2241
  */
2209
2242
  HostEvent["SaveAnswer"] = "saveAnswer";
2210
2243
  /**
@@ -2212,6 +2245,25 @@ export var HostEvent;
2212
2245
  * @hidden
2213
2246
  */
2214
2247
  HostEvent["UIPassthrough"] = "UiPassthrough";
2248
+ /**
2249
+ * Triggers the table viz rerender with the updated data.
2250
+ * Includes the following properties:
2251
+ * @param - columnDataLite - an array of object containing data
2252
+ * transformed from data picked from TableVizRendered event.
2253
+ * For example, { columnDataLite: []}
2254
+ * @example
2255
+ * ```js
2256
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
2257
+ * console.log(payload);
2258
+ * const columnDataLite = payload.data.data.columnDataLite;
2259
+ * columnDataLite[0].dataValue[0]="new fob";
2260
+ * console.log('>>> new Data', columnDataLite);
2261
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
2262
+ * })
2263
+ * ```
2264
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
2265
+ */
2266
+ HostEvent["TransformTableVizData"] = "TransformTableVizData";
2215
2267
  })(HostEvent || (HostEvent = {}));
2216
2268
  /**
2217
2269
  * The different visual modes that the data sources panel within
@@ -2278,7 +2330,12 @@ export var Param;
2278
2330
  Param["AuthType"] = "authType";
2279
2331
  Param["IconSpriteUrl"] = "iconSprite";
2280
2332
  Param["cookieless"] = "cookieless";
2281
- Param["ContextMenuTrigger"] = "isContextMenuEnabledOnLeftClick";
2333
+ // Deprecated: `isContextMenuEnabledOnLeftClick`
2334
+ // Introduced: `contextMenuEnabledOnWhichClick` with values: 'left',
2335
+ // 'right', or 'both'. This update only affects ThoughtSpot URL parameters
2336
+ // and does not impact existing workflows or use cases. Added support for
2337
+ // 'both' clicks in `contextMenuTrigger` configuration.
2338
+ Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
2282
2339
  Param["LinkOverride"] = "linkOverride";
2283
2340
  Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
2284
2341
  Param["ShowInsertToSlide"] = "insertInToSlide";
@@ -2431,7 +2488,8 @@ export var Action;
2431
2488
  Action["ResetLayout"] = "resetLayout";
2432
2489
  /**
2433
2490
  * The **Schedule** menu action on a Liveboard.
2434
- * Allows scheduling a Liveboard notification.
2491
+ * Allows scheduling a Liveboard job, for example,
2492
+ * sending periodic notifications.
2435
2493
  * @example
2436
2494
  * ```js
2437
2495
  * disabledActions: [Action.Schedule]
@@ -2473,7 +2531,7 @@ export var Action;
2473
2531
  * ```js
2474
2532
  * disabledActions: [Action.AddDataPanelObjects]
2475
2533
  * ```
2476
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
2534
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
2477
2535
  */
2478
2536
  Action["AddDataPanelObjects"] = "addDataPanelObjects";
2479
2537
  /**
@@ -2486,7 +2544,28 @@ export var Action;
2486
2544
  * ```
2487
2545
  */
2488
2546
  Action["ConfigureFilter"] = "configureFilter";
2547
+ /**
2548
+ * The **Collapse data sources** icon on the Search page.
2549
+ * Collapses the panel showing data sources.
2550
+ *
2551
+ * @example
2552
+ * ```js
2553
+ * disabledActions: [Action.CollapseDataPanel]
2554
+ * ```
2555
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
2556
+ */
2489
2557
  Action["CollapseDataSources"] = "collapseDataSources";
2558
+ /**
2559
+ * The **Collapse data panel** icon on the Search page.
2560
+ * Collapses the data panel view.
2561
+ *
2562
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
2563
+ *
2564
+ * @example
2565
+ * ```js
2566
+ * disabledActions: [Action.CollapseDataPanel]
2567
+ * ```
2568
+ */
2490
2569
  Action["CollapseDataPanel"] = "collapseDataPanel";
2491
2570
  /**
2492
2571
  * The **Choose sources** button on Search page.
@@ -2522,7 +2601,7 @@ export var Action;
2522
2601
  * ```js
2523
2602
  * disabledActions: [Action.AddColumnSet]
2524
2603
  * ```
2525
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
2604
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
2526
2605
  */
2527
2606
  Action["AddColumnSet"] = "addSimpleCohort";
2528
2607
  /**
@@ -2532,7 +2611,7 @@ export var Action;
2532
2611
  * ```js
2533
2612
  * disabledActions: [Action.AddQuerySet]
2534
2613
  * ```
2535
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
2614
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
2536
2615
  */
2537
2616
  Action["AddQuerySet"] = "addAdvancedCohort";
2538
2617
  /**
@@ -2564,6 +2643,8 @@ export var Action;
2564
2643
  /**
2565
2644
  * The **Show underlying data** menu action on a visualization or
2566
2645
  * Answer page.
2646
+ * Displays detailed information and raw data
2647
+ * for a given visualization.
2567
2648
  * @example
2568
2649
  * ```js
2569
2650
  * disabledActions: [Action.ShowUnderlyingData]
@@ -2765,6 +2846,7 @@ export var Action;
2765
2846
  Action["AnalysisInfo"] = "analysisInfo";
2766
2847
  /**
2767
2848
  * The **Schedule** menu action on a Liveboard.
2849
+ * Allows scheduling a Liveboard job.
2768
2850
  * @example
2769
2851
  * ```js
2770
2852
  * disabledActions: [Action.Subscription]
@@ -2834,8 +2916,13 @@ export var Action;
2834
2916
  */
2835
2917
  Action["RequestAccess"] = "requestAccess";
2836
2918
  /**
2837
- * The **Query visualizer** and **Query SQL** buttons in Query details panel
2838
- * of the Answer page
2919
+ * The **Query visualizer** and **Query SQL** buttons in
2920
+ * Query details panel of the Answer page.
2921
+ *
2922
+ * **Query visualizer** - Displays the tables
2923
+ * and filters used in a search query.
2924
+ * **Query SQL** - Displays the SQL statements used
2925
+ * in a search query to fetch data.
2839
2926
  * @example
2840
2927
  * ```js
2841
2928
  * disabledActions: [Action.QueryDetailsButtons]
@@ -2853,7 +2940,10 @@ export var Action;
2853
2940
  */
2854
2941
  Action["AnswerDelete"] = "onDeleteAnswer";
2855
2942
  /**
2856
- * The Chart switcher icon on Answer and visualization pages.
2943
+ * The chart switcher icon on Answer page and
2944
+ * visualizations in edit mode.
2945
+ * Allows switching to the table or chart mode
2946
+ * when editing a visualization.
2857
2947
  * @example
2858
2948
  * ```js
2859
2949
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -2862,7 +2952,10 @@ export var Action;
2862
2952
  */
2863
2953
  Action["AnswerChartSwitcher"] = "answerChartSwitcher";
2864
2954
  /**
2865
- * Favorites icon (*) on Answers, Liveboard, and Data pages
2955
+ * The Favorites icon (*) for Answers,
2956
+ * Liveboard, and data objects like Worksheet, Model,
2957
+ * Tables and Views.
2958
+ * Allows adding an object to the user’s favorites list.
2866
2959
  * @example
2867
2960
  * ```js
2868
2961
  * disabledActions: [Action.AddToFavorites]
@@ -2880,7 +2973,9 @@ export var Action;
2880
2973
  */
2881
2974
  Action["EditDetails"] = "editDetails";
2882
2975
  /**
2883
- * The Create alert action on KPI charts.
2976
+ * The *Create alert* action for KPI charts.
2977
+ * Allows users to schedule threshold-based alerts
2978
+ * for KPI charts.
2884
2979
  * @example
2885
2980
  * ```js
2886
2981
  * disabledActions: [Action.CreateMonitor]
@@ -2936,7 +3031,7 @@ export var Action;
2936
3031
  * ```js
2937
3032
  * disabledActions: [Action.CrossFilter]
2938
3033
  * ```
2939
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3034
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
2940
3035
  */
2941
3036
  Action["CrossFilter"] = "context-menu-item-cross-filter";
2942
3037
  /**
@@ -2946,7 +3041,7 @@ export var Action;
2946
3041
  * ```js
2947
3042
  * disabledActions: [Action.SyncToSlack]
2948
3043
  * ```
2949
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
3044
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
2950
3045
  */
2951
3046
  Action["SyncToSlack"] = "syncToSlack";
2952
3047
  /**
@@ -2956,7 +3051,7 @@ export var Action;
2956
3051
  * ```js
2957
3052
  * disabledActions: [Action.SyncToTeams]
2958
3053
  * ```
2959
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
3054
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
2960
3055
  */
2961
3056
  Action["SyncToTeams"] = "syncToTeams";
2962
3057
  /**
@@ -2967,7 +3062,7 @@ export var Action;
2967
3062
  * ```js
2968
3063
  * disabledActions: [Action.RemoveCrossFilter]
2969
3064
  * ```
2970
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3065
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
2971
3066
  */
2972
3067
  Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
2973
3068
  /**
@@ -2978,7 +3073,7 @@ export var Action;
2978
3073
  * ```js
2979
3074
  * disabledActions: [Action.AxisMenuAggregate]
2980
3075
  * ```
2981
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3076
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
2982
3077
  */
2983
3078
  Action["AxisMenuAggregate"] = "axisMenuAggregate";
2984
3079
  /**
@@ -2989,17 +3084,19 @@ export var Action;
2989
3084
  * ```js
2990
3085
  * disabledActions: [Action.AxisMenuTimeBucket]
2991
3086
  * ```
2992
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3087
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
2993
3088
  */
2994
3089
  Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
2995
3090
  /**
2996
3091
  * The **Filter** action in the chart axis or table column
2997
3092
  * customization menu.
3093
+ * Allows adding, editing, or removing filters.
3094
+ *
2998
3095
  * @example
2999
3096
  * ```js
3000
3097
  * disabledActions: [Action.AxisMenuFilter]
3001
3098
  * ```
3002
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3099
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3003
3100
  */
3004
3101
  Action["AxisMenuFilter"] = "axisMenuFilter";
3005
3102
  /**
@@ -3010,7 +3107,7 @@ export var Action;
3010
3107
  * ```js
3011
3108
  * disabledActions: [Action.AxisMenuConditionalFormat]
3012
3109
  * ```
3013
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3110
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3014
3111
  */
3015
3112
  Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
3016
3113
  /**
@@ -3021,7 +3118,7 @@ export var Action;
3021
3118
  * ```js
3022
3119
  * disabledActions: [Action.AxisMenuConditionalFormat]
3023
3120
  * ```
3024
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3121
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3025
3122
  */
3026
3123
  Action["AxisMenuSort"] = "axisMenuSort";
3027
3124
  /**
@@ -3033,7 +3130,7 @@ export var Action;
3033
3130
  * ```js
3034
3131
  * disabledActions: [Action.AxisMenuGroup]
3035
3132
  * ```
3036
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3133
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3037
3134
  */
3038
3135
  Action["AxisMenuGroup"] = "axisMenuGroup";
3039
3136
  /**
@@ -3044,7 +3141,7 @@ export var Action;
3044
3141
  * ```js
3045
3142
  * disabledActions: [Action.AxisMenuPosition]
3046
3143
  * ```
3047
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3144
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3048
3145
  */
3049
3146
  Action["AxisMenuPosition"] = "axisMenuPosition";
3050
3147
  /**
@@ -3054,7 +3151,7 @@ export var Action;
3054
3151
  * ```js
3055
3152
  * disabledActions: [Action.AxisMenuRename]
3056
3153
  * ```
3057
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3154
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3058
3155
  */
3059
3156
  Action["AxisMenuRename"] = "axisMenuRename";
3060
3157
  /**
@@ -3065,7 +3162,7 @@ export var Action;
3065
3162
  * ```js
3066
3163
  * disabledActions: [Action.AxisMenuEdit]
3067
3164
  * ```
3068
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3165
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3069
3166
  */
3070
3167
  Action["AxisMenuEdit"] = "axisMenuEdit";
3071
3168
  /**
@@ -3075,7 +3172,7 @@ export var Action;
3075
3172
  * ```js
3076
3173
  * disabledActions: [Action.AxisMenuNumberFormat]
3077
3174
  * ```
3078
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3175
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3079
3176
  */
3080
3177
  Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
3081
3178
  /**
@@ -3085,7 +3182,7 @@ export var Action;
3085
3182
  * ```js
3086
3183
  * disabledActions: [Action.AxisMenuTextWrapping]
3087
3184
  * ```
3088
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3185
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3089
3186
  */
3090
3187
  Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
3091
3188
  /**
@@ -3097,7 +3194,7 @@ export var Action;
3097
3194
  * ```js
3098
3195
  * disabledActions: [Action.AxisMenuRemove]
3099
3196
  * ```
3100
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3197
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3101
3198
  */
3102
3199
  Action["AxisMenuRemove"] = "axisMenuRemove";
3103
3200
  /**
@@ -3111,26 +3208,27 @@ export var Action;
3111
3208
  * ```js
3112
3209
  * disabledActions: [Action.RenameModalTitleDescription]
3113
3210
  * ```
3114
- * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3211
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
3115
3212
  */
3116
3213
  Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
3117
3214
  /**
3118
- *
3215
+ * The *Request verification* action on a Liveboard.
3216
+ * Initiates a request for Liveboard verification.
3119
3217
  * @example
3120
3218
  * ```js
3121
3219
  * disabledActions: [Action.RequestVerification]
3122
3220
  * ```
3123
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3221
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
3124
3222
  */
3125
3223
  Action["RequestVerification"] = "requestVerification";
3126
3224
  /**
3127
3225
  *
3128
- *Allows users to mark a Liveboard as verified.
3226
+ * Allows users to mark a Liveboard as verified.
3129
3227
  * @example
3130
3228
  * ```js
3131
3229
  * disabledActions: [Action.MarkAsVerified]
3132
3230
  * ```
3133
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3231
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
3134
3232
  */
3135
3233
  Action["MarkAsVerified"] = "markAsVerified";
3136
3234
  /**
@@ -3140,7 +3238,7 @@ export var Action;
3140
3238
  * ```js
3141
3239
  * disabledActions: [Action.AddTab]
3142
3240
  * ```
3143
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3241
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3144
3242
  */
3145
3243
  Action["AddTab"] = "addTab";
3146
3244
  /**
@@ -3150,35 +3248,42 @@ export var Action;
3150
3248
  * ```js
3151
3249
  * disabledActions: [Action.EnableContextualChangeAnalysis]
3152
3250
  * ```
3153
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3251
+ * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
3154
3252
  */
3155
3253
  Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
3156
3254
  /**
3255
+ * Action ID to hide or disable Natural Language Search query.
3157
3256
  *
3158
3257
  * @example
3159
3258
  * ```js
3160
3259
  * disabledActions: [Action.ShowSageQuery]
3161
3260
  * ```
3162
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3261
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
3163
3262
  */
3164
3263
  Action["ShowSageQuery"] = "showSageQuery";
3165
3264
  /**
3265
+ *
3266
+ * Action ID to hide or disable the edit option for the
3267
+ * results generated from the
3268
+ * Natural Language Search query.
3166
3269
  *
3167
3270
  * @example
3168
3271
  * ```js
3169
3272
  * disabledActions: [Action.EditSageAnswer]
3170
3273
  * ```
3171
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3274
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
3172
3275
  */
3173
3276
  Action["EditSageAnswer"] = "editSageAnswer";
3174
3277
  /**
3278
+ * The feedback widget for AI-generated Answers.
3279
+ * Allows users to send feedback on the Answers generated
3280
+ * from a Natural Language Search query.
3175
3281
  *
3176
- *This action allows users to send feedback on AI-generated Answers.
3177
3282
  * @example
3178
3283
  * ```js
3179
3284
  * disabledActions: [Action.SageAnswerFeedback]
3180
3285
  * ```
3181
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3286
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
3182
3287
  */
3183
3288
  Action["SageAnswerFeedback"] = "sageAnswerFeedback";
3184
3289
  /**
@@ -3187,7 +3292,7 @@ export var Action;
3187
3292
  * ```js
3188
3293
  * disabledActions: [Action.ModifySageAnswer]
3189
3294
  * ```
3190
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3295
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
3191
3296
  */
3192
3297
  Action["ModifySageAnswer"] = "modifySageAnswer";
3193
3298
  /**
@@ -3200,7 +3305,10 @@ export var Action;
3200
3305
  */
3201
3306
  Action["MoveToTab"] = "onContainerMove";
3202
3307
  /**
3203
- * The **Manage Alertsb** menu action on KPI visualizations.
3308
+ * The **Manage Alerts** menu action on KPI visualizations.
3309
+ * Allows creating, viewing, and editing monitor
3310
+ * alerts for a KPI chart.
3311
+ *
3204
3312
  * @example
3205
3313
  * ```js
3206
3314
  * disabledActions: [Action.ManageMonitor]
@@ -3208,21 +3316,23 @@ export var Action;
3208
3316
  */
3209
3317
  Action["ManageMonitor"] = "manageMonitor";
3210
3318
  /**
3211
- * Action ID for Liveboard Personalised Views dropdown
3319
+ * The Liveboard Personalised Views dropdown.
3320
+ * Allows navigating to a personalized Liveboard View.
3212
3321
  * @example
3213
3322
  * ```js
3214
3323
  * disabledActions: [Action.PersonalisedViewsDropdown]
3215
3324
  * ```
3216
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
3325
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3217
3326
  */
3218
3327
  Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
3219
3328
  /**
3220
- * Action ID for Liveboard Users ( Recently Visited / social proof )
3329
+ * Action ID for show or hide the user details on a
3330
+ * Liveboard (Recently visited / social proof)
3221
3331
  * @example
3222
3332
  * ```js
3223
3333
  * disabledActions: [Action.LiveboardUsers]
3224
3334
  * ```
3225
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
3335
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3226
3336
  */
3227
3337
  Action["LiveboardUsers"] = "liveboardUsers";
3228
3338
  /**
@@ -3240,108 +3350,124 @@ export var Action;
3240
3350
  * hiddenAction: [Action.TML] // hide all TML actions
3241
3351
  * disabledActions: [Action.TML] // to disable all TML actions
3242
3352
  * ```
3243
- * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
3353
+ * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
3244
3354
  */
3245
3355
  Action["TML"] = "tml";
3246
3356
  /**
3247
- * Action ID for the create Liveboard option on the Liveboard list page
3248
- * and Pin modal
3357
+ * The **Create Liveboard* action on
3358
+ * the Liveboards page and the Pin modal.
3359
+ * Allows users to create a Liveboard.
3360
+ *
3249
3361
  * @example
3250
3362
  * ```js
3251
3363
  * hiddenAction: [Action.CreateLiveboard]
3252
3364
  * disabledActions: [Action.CreateLiveboard]
3253
3365
  * ```
3254
- * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
3366
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
3255
3367
  */
3256
3368
  Action["CreateLiveboard"] = "createLiveboard";
3257
3369
  /**
3258
- * Action ID for to hide Verified Liveboard Banner
3370
+ * Action ID for to hide or disable the
3371
+ * Verified Liveboard banner.
3259
3372
  * @example
3260
3373
  * ```js
3261
3374
  * hiddenAction: [Action.VerifiedLiveboard]
3262
3375
  * ```
3263
- * @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
3376
+ * @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
3264
3377
  */
3265
3378
  Action["VerifiedLiveboard"] = "verifiedLiveboard";
3266
3379
  /**
3267
- * Action ID for ask sage button
3380
+ * The *Ask Sage* action for Answers and visualizations.
3381
+ * Allows initiating a Natural Language Search query.
3382
+ *
3268
3383
  * @example
3269
3384
  * ```js
3270
3385
  * hiddenAction: [Action.AskAi]
3271
3386
  * ```
3272
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
3387
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3273
3388
  */
3274
3389
  Action["AskAi"] = "AskAi";
3275
3390
  /**
3276
3391
  * The **Add KPI to Watchlist** action on Home page watchlist.
3392
+ * Adds a KPI chart to the watchlist on the Home page.
3277
3393
  * @example
3278
3394
  * ```js
3279
3395
  * disabledActions: [Action.AddToWatchlist]
3280
3396
  * ```
3281
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
3397
+ * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
3282
3398
  */
3283
3399
  Action["AddToWatchlist"] = "addToWatchlist";
3284
3400
  /**
3285
3401
  * The **Remove from watchlist** menu action on KPI watchlist.
3402
+ * Removes a KPI chart from the watchlist on the Home page.
3286
3403
  * @example
3287
3404
  * ```js
3288
3405
  * disabledActions: [Action.RemoveFromWatchlist]
3289
3406
  * ```
3290
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
3407
+ * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
3291
3408
  */
3292
3409
  Action["RemoveFromWatchlist"] = "removeFromWatchlist";
3293
3410
  /**
3294
- * The **Organise Favourites** action on Homepage Favourite Module.
3411
+ * The **Organize Favourites** action on Homepage
3412
+ * *Favorites* module.
3413
+ *
3295
3414
  * @example
3296
3415
  * ```js
3297
3416
  * disabledActions: [Action.OrganiseFavourites]
3298
3417
  * ```
3299
- * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
3418
+ * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
3300
3419
  */
3301
3420
  Action["OrganiseFavourites"] = "organiseFavourites";
3302
3421
  /**
3303
- * Action ID for AI Highlights button
3422
+ * The **AI Highlights** action on a Liveboard.
3423
+ *
3304
3424
  * @example
3305
3425
  * ```js
3306
3426
  * hiddenAction: [Action.AIHighlights]
3307
3427
  * ```
3308
- * @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
3428
+ * @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
3309
3429
  */
3310
3430
  Action["AIHighlights"] = "AIHighlights";
3311
3431
  /**
3312
- * Action ID for edit the schedule action on schedule on homepage
3432
+ * The *Edit* action on the *Liveboard Schedules* page
3433
+ * (new Homepage experience).
3434
+ * Allows editing Liveboard schedules.
3435
+ *
3313
3436
  * @example
3314
3437
  * ```js
3315
3438
  * disabledActions: [Action.EditScheduleHomepage]
3316
3439
  * ```
3317
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3440
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3318
3441
  */
3319
3442
  Action["EditScheduleHomepage"] = "editScheduleHomepage";
3320
3443
  /**
3321
- * Action ID for pause schedule action on schedule on homepage
3444
+ * The *Pause* action on the *Liveboard Schedules* page
3445
+ * Pauses a scheduled Liveboard job.
3322
3446
  * @example
3323
3447
  * ```js
3324
3448
  * disabledActions: [Action.PauseScheduleHomepage]
3325
3449
  * ```
3326
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3450
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3327
3451
  */
3328
3452
  Action["PauseScheduleHomepage"] = "pauseScheduleHomepage";
3329
3453
  /**
3330
- * Action ID for view schedule run action on schedule on homepage
3454
+ * The **View run history** action **Liveboard Schedules** page.
3455
+ * Allows viewing schedule run history.
3331
3456
  * @example
3332
3457
  * ```js
3333
3458
  * disabledActions: [Action.ViewScheduleRunHomepage]
3334
3459
  * ```
3335
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3460
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3336
3461
  */
3337
3462
  Action["ViewScheduleRunHomepage"] = "viewScheduleRunHomepage";
3338
3463
  /**
3339
- * Action ID for unsubscribe schedule action on schedule on homepage
3464
+ * Action ID to hide or disable the
3465
+ * unsubscribe option for Liveboard schedules.
3340
3466
  * @example
3341
3467
  * ```js
3342
3468
  * disabledActions: [Action.UnsubscribeScheduleHomepage]
3343
3469
  * ```
3344
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3470
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3345
3471
  */
3346
3472
  Action["UnsubscribeScheduleHomepage"] = "unsubscribeScheduleHomepage";
3347
3473
  /**
@@ -3350,16 +3476,17 @@ export var Action;
3350
3476
  * ```js
3351
3477
  * disabledActions: [Action.ManageTags]
3352
3478
  * ```
3353
- * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
3479
+ * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3354
3480
  */
3355
3481
  Action["ManageTags"] = "manageTags";
3356
3482
  /**
3357
- * Action ID for delete schedule action on schedule on homepage
3483
+ * The **Delete** action on the **Liveboard Schedules* page.
3484
+ * Deletes a Liveboard schedule.
3358
3485
  * @example
3359
3486
  * ```js
3360
3487
  * disabledActions: [Action.DeleteScheduleHomepage]
3361
3488
  * ```
3362
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3489
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3363
3490
  */
3364
3491
  Action["DeleteScheduleHomepage"] = "deleteScheduleHomepage";
3365
3492
  /**
@@ -3368,7 +3495,7 @@ export var Action;
3368
3495
  * ```js
3369
3496
  * disabledActions: [Action.KPIAnalysisCTA]
3370
3497
  * ```
3371
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3498
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3372
3499
  */
3373
3500
  Action["KPIAnalysisCTA"] = "kpiAnalysisCTA";
3374
3501
  /**
@@ -3377,61 +3504,73 @@ export var Action;
3377
3504
  * ```js
3378
3505
  * const disabledActions = [Action.DisableChipReorder]
3379
3506
  * ```
3380
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3507
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
3381
3508
  */
3382
3509
  Action["DisableChipReorder"] = "disableChipReorder";
3383
3510
  /**
3384
- * Action ID for Hide Irrelevant filters button
3511
+ * Action ID to show, hide, or disable filters
3512
+ * in a Liveboard tab.
3513
+ *
3385
3514
  * @example
3386
3515
  * ```js
3387
3516
  * hiddenAction: [Action.ChangeFilterVisibilityInTab]
3388
3517
  * ```
3389
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3518
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
3390
3519
  */
3391
3520
  Action["ChangeFilterVisibilityInTab"] = "changeFilterVisibilityInTab";
3392
3521
  /**
3393
- * Action ID for hide/disable Preview data button in spotter
3522
+ * The **Preview data** button on the Spotter interface.
3523
+ * Allows previewing the data used for Spotter queries.
3524
+ *
3394
3525
  * @example
3395
3526
  * ```js
3396
3527
  * hiddenAction: [Action.PreviewDataSpotter]
3397
3528
  * ```
3398
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3529
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
3399
3530
  */
3400
3531
  Action["PreviewDataSpotter"] = "previewDataSpotter";
3401
3532
  /**
3402
- * Action ID for hide/disable reset button in spotter
3533
+ * The **Reset** link on the Spotter interface.
3534
+ * Resets the conversation with Spotter.
3535
+ *
3403
3536
  * @example
3404
3537
  * ```js
3405
3538
  * hiddenAction: [Action.ResetSpotterChat]
3406
3539
  * ```
3407
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3540
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
3408
3541
  */
3409
3542
  Action["ResetSpotterChat"] = "resetSpotterChat";
3410
3543
  /**
3411
- * Action ID for hide/disable feedback in spotter
3544
+ * Action ID for hide or disable the
3545
+ * Spotter feedback widget.
3546
+ *
3412
3547
  * @example
3413
3548
  * ```js
3414
3549
  * hiddenAction: [Action.SpotterFeedback]
3415
3550
  * ```
3416
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3551
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
3417
3552
  */
3418
3553
  Action["SpotterFeedback"] = "spotterFeedback";
3419
3554
  /**
3420
- * Action ID for hide/disable editing previous prompt in spotter
3555
+ * Action ID for hide or disable
3556
+ * the previous prompt edit option in Spotter.
3557
+ *
3421
3558
  * @example
3422
3559
  * ```js
3423
3560
  * hiddenAction: [Action.EditPreviousPrompt]
3424
3561
  * ```
3425
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3562
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
3426
3563
  */
3427
3564
  Action["EditPreviousPrompt"] = "editPreviousPrompt";
3428
3565
  /**
3429
- * Action ID for hide/disable deleting previous prompt in spotter
3566
+ * Action ID for hide or disable
3567
+ * the previous prompt deletion option in Spotter.
3568
+ *
3430
3569
  * @example
3431
3570
  * ```js
3432
3571
  * hiddenAction: [Action.DeletePreviousPrompt]
3433
3572
  * ```
3434
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3573
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
3435
3574
  */
3436
3575
  Action["DeletePreviousPrompt"] = "deletePreviousPrompt";
3437
3576
  /**
@@ -3440,7 +3579,7 @@ export var Action;
3440
3579
  * ```js
3441
3580
  * hiddenAction: [Action.EditTokens]
3442
3581
  * ```
3443
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3582
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
3444
3583
  */
3445
3584
  Action["EditTokens"] = "editTokens";
3446
3585
  })(Action || (Action = {}));
@@ -3453,11 +3592,13 @@ export var PrefetchFeatures;
3453
3592
  })(PrefetchFeatures || (PrefetchFeatures = {}));
3454
3593
  /**
3455
3594
  * Enum for options to change context trigger
3595
+ * BOTH_CLICKS option is introduced in 10.7
3456
3596
  */
3457
3597
  export var ContextMenuTriggerOptions;
3458
3598
  (function (ContextMenuTriggerOptions) {
3459
3599
  ContextMenuTriggerOptions["LEFT_CLICK"] = "left-click";
3460
3600
  ContextMenuTriggerOptions["RIGHT_CLICK"] = "right-click";
3601
+ ContextMenuTriggerOptions["BOTH_CLICKS"] = "both-clicks";
3461
3602
  })(ContextMenuTriggerOptions || (ContextMenuTriggerOptions = {}));
3462
3603
  export var LogLevel;
3463
3604
  (function (LogLevel) {
@@ -3470,7 +3611,7 @@ export var LogLevel;
3470
3611
  * logLevel: LogLevel.SILENT,
3471
3612
  * })
3472
3613
  * ```
3473
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
3614
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
3474
3615
  */
3475
3616
  LogLevel["SILENT"] = "SILENT";
3476
3617
  /**
@@ -3482,7 +3623,7 @@ export var LogLevel;
3482
3623
  * logLevel: LogLevel.ERROR,
3483
3624
  * })
3484
3625
  * ```
3485
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
3626
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
3486
3627
  */
3487
3628
  LogLevel["ERROR"] = "ERROR";
3488
3629
  /**
@@ -3494,7 +3635,7 @@ export var LogLevel;
3494
3635
  * logLevel: LogLevel.WARN,
3495
3636
  * })
3496
3637
  * ```
3497
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
3638
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
3498
3639
  */
3499
3640
  LogLevel["WARN"] = "WARN";
3500
3641
  /**
@@ -3506,7 +3647,7 @@ export var LogLevel;
3506
3647
  * logLevel: LogLevel.INFO,
3507
3648
  * })
3508
3649
  * ```
3509
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
3650
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
3510
3651
  */
3511
3652
  LogLevel["INFO"] = "INFO";
3512
3653
  /**
@@ -3518,7 +3659,7 @@ export var LogLevel;
3518
3659
  * logLevel: LogLevel.DEBUG,
3519
3660
  * })
3520
3661
  * ```
3521
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
3662
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
3522
3663
  */
3523
3664
  LogLevel["DEBUG"] = "DEBUG";
3524
3665
  /**
@@ -3530,7 +3671,7 @@ export var LogLevel;
3530
3671
  * logLevel: LogLevel.TRACE,
3531
3672
  * })
3532
3673
  * ```
3533
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
3674
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
3534
3675
  */
3535
3676
  LogLevel["TRACE"] = "TRACE";
3536
3677
  })(LogLevel || (LogLevel = {}));