@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
@@ -280,8 +280,17 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
280
280
  */
281
281
  enableSearchAssist?: boolean;
282
282
  /**
283
- * If set to true, the embedded object container dynamically resizes
284
- * according to the height of the pages which support fullHeight mode.
283
+ * If set to true, the Liveboard container dynamically resizes
284
+ * according to the height of the Liveboard.
285
+ *
286
+ * **Note**: Using fullHeight loads all visualizations
287
+ * on the Liveboard simultaneously, which results in
288
+ * multiple warehouse queries and potentially a
289
+ * longer wait for the topmost visualizations to
290
+ * display on the screen. Setting fullHeight to
291
+ * `false` fetches visualizations incrementally as
292
+ * users scroll the page to view the charts and tables.
293
+ *
285
294
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
286
295
  * @example
287
296
  * ```js
@@ -680,7 +689,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
680
689
  */
681
690
  import { DOMSelector, HostEvent, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
682
691
  import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
683
- import { HostEventRequest, HostEventResponse } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
692
+ import { TriggerPayload, TriggerResponse } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
684
693
  /**
685
694
  * The configuration for the embedded Liveboard or visualization page view.
686
695
  * @group Embed components
@@ -689,12 +698,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
689
698
  /**
690
699
  * If set to true, the embedded object container dynamically resizes
691
700
  * according to the height of the Liveboard.
701
+ *
692
702
  * **Note**: Using fullHeight loads all visualizations on the
693
703
  * Liveboard simultaneously, which results in multiple warehouse
694
704
  * queries and potentially a longer wait for the topmost
695
705
  * visualizations to display on the screen.
696
706
  * Setting `fullHeight` to `false` fetches visualizations
697
707
  * incrementally as users scroll the page to view the charts and tables.
708
+ *
698
709
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
699
710
  * @example
700
711
  * ```js
@@ -1056,10 +1067,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
1056
1067
  protected handleRenderForPrerender(): void;
1057
1068
  /**
1058
1069
  * Triggers an event to the embedded app
1059
- * @param messageType The event type
1060
- * @param data The payload to send with the message
1070
+ * @param {HostEvent} messageType The event type
1071
+ * @param {any} data The payload to send with the message
1072
+ * @returns A promise that resolves with the response from the embedded app
1061
1073
  */
1062
- trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
1074
+ trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
1063
1075
  /**
1064
1076
  * Render an embedded ThoughtSpot Liveboard or visualization
1065
1077
  * @param renderOptions An object specifying the Liveboard ID,
@@ -1864,7 +1876,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1864
1876
  */
1865
1877
  export enum AuthType {
1866
1878
  /**
1867
- * No authentication on the SDK. Passthrough to the embedded App. Alias for
1879
+ * No authentication on the SDK. Pass-through to the embedded App. Alias for
1868
1880
  * `Passthrough`.
1869
1881
  * @example
1870
1882
  * ```js
@@ -2061,8 +2073,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2061
2073
  /**
2062
2074
  * The custom css variables, which can be set.
2063
2075
  * The allowed list is in the CustomCssVariables
2064
- * interface.
2065
- * Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
2076
+ * interface. For more information, see
2077
+ * link:https://developers.thoughtspot.com/docs/css-variables-reference
2066
2078
  */
2067
2079
  variables?: CustomCssVariables;
2068
2080
  /**
@@ -2104,7 +2116,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2104
2116
  }
2105
2117
  /**
2106
2118
  * Configuration to define the customization on the Embedded
2107
- * Thoughtspot components.
2119
+ * ThoughtSpot components.
2108
2120
  * You can customize styles, text strings, and icons.
2109
2121
  * For more information, see https://developers.thoughtspot.com/docs/custom-css.
2110
2122
  * @example
@@ -2224,7 +2236,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2224
2236
  /**
2225
2237
  * Boolean to define if the query parameters in the ThoughtSpot URL
2226
2238
  * should be encoded in base64. This provides additional security to
2227
- * Thoughtspot clusters against cross-site scripting attacks.
2239
+ * ThoughtSpot clusters against cross-site scripting attacks.
2228
2240
  * @default false
2229
2241
  */
2230
2242
  shouldEncodeUrlQueryParams?: boolean;
@@ -2377,18 +2389,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2377
2389
  */
2378
2390
  disableSDKTracking?: boolean;
2379
2391
  /**
2380
- * Overrides default/user preffered locale for date formatting
2381
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2392
+ * Overrides default/user preferred locale for date formatting
2393
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2382
2394
  */
2383
2395
  dateFormatLocale?: string;
2384
2396
  /**
2385
- * Overrides default/user preffered locale for number formatting
2386
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2397
+ * Overrides default/user preferred locale for number formatting
2398
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2387
2399
  */
2388
2400
  numberFormatLocale?: string;
2389
2401
  /**
2390
2402
  * Format to be used for currency when currency format is set to infer from browser
2391
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2403
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2392
2404
  */
2393
2405
  currencyFormat?: string;
2394
2406
  /**
@@ -2402,12 +2414,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2402
2414
  * disableTokenVerification : true
2403
2415
  * })
2404
2416
  * ```
2405
- * @version SDK: 1.28.5 | Thoughtspot: *
2417
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
2406
2418
  */
2407
2419
  disableTokenVerification?: boolean;
2408
2420
  /**
2409
2421
  * This flag is used to disable showing the login failure page in the embedded app.
2410
- * @version SDK 1.32.3 | Thoughtspot: *
2422
+ * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
2411
2423
  */
2412
2424
  disableLoginFailurePage?: boolean;
2413
2425
  /**
@@ -2445,7 +2457,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2445
2457
  * }
2446
2458
  * });
2447
2459
  * ```
2448
- * @version SDK 1.37.0 | Thoughtspot: 10.7.0.cl
2460
+ * @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
2449
2461
  */
2450
2462
  customVariablesForThirdPartyTools?: Record<string, any>;
2451
2463
  }
@@ -2604,7 +2616,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2604
2616
  /**
2605
2617
  * The list of parameter override to apply to a search answer,
2606
2618
  * visualization, or Liveboard.
2607
- * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
2619
+ * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2608
2620
  * @example
2609
2621
  * ```js
2610
2622
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2664,7 +2676,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2664
2676
  /**
2665
2677
  * Insert as a sibling of the target container, instead of appending to a
2666
2678
  * child inside it.
2667
- * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
2679
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
2668
2680
  * @example
2669
2681
  * ```js
2670
2682
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2737,7 +2749,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2737
2749
  * 'f547ec54-2a37-4516-a222-2b06719af726']
2738
2750
  * });
2739
2751
  * ```
2740
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2752
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
2741
2753
  */
2742
2754
  hiddenTabs?: string[];
2743
2755
  /**
@@ -2747,7 +2759,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2747
2759
  * **Note**: This option does not apply to the classic homepage.
2748
2760
  * To access the updated modular homepage, set
2749
2761
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2750
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2762
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2751
2763
  * @example
2752
2764
  * ```js
2753
2765
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2764,7 +2776,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2764
2776
  * **Note**: This option does not apply to the classic homepage.
2765
2777
  * To access the updated modular homepage, set
2766
2778
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2767
- * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
2779
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2768
2780
  * @example
2769
2781
  * ```js
2770
2782
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2779,7 +2791,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2779
2791
  * Only the tabs specified in the array will be shown in the Liveboard.
2780
2792
  *
2781
2793
  * Use either `visibleTabs` or `hiddenTabs`.
2782
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2794
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
2783
2795
  * @example
2784
2796
  * ```js
2785
2797
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2807,7 +2819,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2807
2819
  * **Note**: This option does not apply to the classic homepage.
2808
2820
  * To access the updated modular homepage, set
2809
2821
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2810
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2822
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2811
2823
  */
2812
2824
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
2813
2825
  /**
@@ -2822,7 +2834,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2822
2834
  * });
2823
2835
  * embed.showPreRender();
2824
2836
  * ```
2825
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
2837
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
2826
2838
  */
2827
2839
  preRenderId?: string;
2828
2840
  /**
@@ -2876,7 +2888,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2876
2888
  /**
2877
2889
  * To set the initial state of the search bar in case of saved Answers.
2878
2890
  * @default true
2879
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2891
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
2880
2892
  * @example
2881
2893
  * ```js
2882
2894
  * const embed = new LiveboardEmbed('#embed', {
@@ -2900,7 +2912,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2900
2912
  /**
2901
2913
  * Flag to control Data panel experience
2902
2914
  * @default false
2903
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2915
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
2904
2916
  * @example
2905
2917
  * ```js
2906
2918
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2912,7 +2924,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2912
2924
  dataPanelV2?: boolean;
2913
2925
  /**
2914
2926
  * To enable custom column groups in data panel v2
2915
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
2927
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
2916
2928
  * @default false
2917
2929
  * @example
2918
2930
  * ```js
@@ -2940,9 +2952,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2940
2952
  */
2941
2953
  overrideOrgId?: number;
2942
2954
  /**
2943
- * Flag to control new flip tooltip context menu experience
2955
+ * Flag to enhance the visual effects of charts
2956
+ * This feature is a beta release for 10.6
2944
2957
  * @default false
2945
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
2958
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2946
2959
  */
2947
2960
  enableFlipTooltipToContextMenu?: boolean;
2948
2961
  }
@@ -3062,7 +3075,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3062
3075
  * **Note**: This option does not apply to the classic homepage.
3063
3076
  * To access the updated modular homepage, set
3064
3077
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3065
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
3078
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3066
3079
  */
3067
3080
  export enum HomepageModule {
3068
3081
  /**
@@ -3905,7 +3918,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3905
3918
  */
3906
3919
  Explore = "explore",
3907
3920
  /**
3908
- * Emitted when a user clicks **Copy link** action on a visualization
3921
+ * Emitted when a user clicks **Copy link** action on a visualization.
3909
3922
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3910
3923
  * @example
3911
3924
  *```js
@@ -3955,23 +3968,26 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3955
3968
  */
3956
3969
  FilterChanged = "filterChanged",
3957
3970
  /**
3958
- * Emitted when a user clicks the **Go** button on the sage embed
3959
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3971
+ * Emitted when a user clicks the **Go** button to initiate
3972
+ * a Natural Language Search query
3973
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3960
3974
  */
3961
3975
  SageEmbedQuery = "sageEmbedQuery",
3962
3976
  /**
3963
- * Emitted when a user selects a data source on the sage embed
3964
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3977
+ * Emitted when a user selects a data source on the embedded
3978
+ * Natural Language Search interface.
3979
+ *
3980
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3965
3981
  */
3966
3982
  SageWorksheetUpdated = "sageWorksheetUpdated",
3967
3983
  /**
3968
3984
  * Emitted when a user updates a connection on the **Data** page
3969
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
3985
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3970
3986
  */
3971
3987
  UpdateConnection = "updateConnection",
3972
3988
  /**
3973
3989
  * Emitted when a user updates a connection on the **Data** page
3974
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
3990
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3975
3991
  */
3976
3992
  CreateConnection = "createConnection",
3977
3993
  /**
@@ -3981,7 +3997,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3981
3997
  * @returns viewId: string
3982
3998
  * @returns liveboardId: string
3983
3999
  * @returns isPublic: boolean
3984
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4000
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3985
4001
  */
3986
4002
  UpdatePersonalisedView = "updatePersonalisedView",
3987
4003
  /**
@@ -3990,7 +4006,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3990
4006
  * @returns viewId: string
3991
4007
  * @returns liveboardId: string
3992
4008
  * @returns isPublic: boolean
3993
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4009
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3994
4010
  */
3995
4011
  SavePersonalisedView = "savePersonalisedView",
3996
4012
  /**
@@ -3999,28 +4015,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3999
4015
  * @returns viewId: string
4000
4016
  * @returns liveboardId: string
4001
4017
  * @returns isPublic: boolean
4002
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4018
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4003
4019
  */
4004
4020
  ResetLiveboard = "resetLiveboard",
4005
4021
  /**
4006
4022
  * Emitted when a PersonalisedView is deleted.
4007
4023
  * @returns views: string[]
4008
4024
  * @returns liveboardId: string
4009
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4025
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4010
4026
  */
4011
4027
  DeletePersonalisedView = "deletePersonalisedView",
4012
4028
  /**
4013
4029
  * Emitted when a user creates a new worksheet
4014
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
4030
+ * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
4015
4031
  */
4016
4032
  CreateWorksheet = "createWorksheet",
4017
4033
  /**
4018
- * Emitted when Ask Sage is initialized.
4034
+ * Emitted when the *Ask Sage* is initialized.
4019
4035
  * @returns viewName: string
4020
4036
  * @returns viewId: string
4021
4037
  * @returns liveboardId: string
4022
4038
  * @returns isPublic: boolean
4023
- * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
4039
+ * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
4024
4040
  */
4025
4041
  AskSageInit = "AskSageInit",
4026
4042
  /**
@@ -4048,7 +4064,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4048
4064
  *
4049
4065
  * error: Developers can customize the error message text when `execute`
4050
4066
  * returns `false` using the error parameter in responder.
4051
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4067
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
4052
4068
  * @example
4053
4069
  *```js
4054
4070
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -4096,9 +4112,26 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4096
4112
  * console.log('payload', payload);
4097
4113
  * })
4098
4114
  *```
4099
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4115
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
4100
4116
  */
4101
- ParameterChanged = "parameterChanged"
4117
+ ParameterChanged = "parameterChanged",
4118
+ /**
4119
+ * Emitted when the table viz renders.
4120
+ * You can use this event as a hook to trigger
4121
+ * other events on the rendered table viz data.
4122
+ * @example
4123
+ * ```js
4124
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
4125
+ * console.log(payload);
4126
+ * const columnDataLite = payload.data.data.columnDataLite;
4127
+ * columnDataLite[0].dataValue[0]="new fob";
4128
+ * console.log('>>> new Data', columnDataLite);
4129
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
4130
+ * })
4131
+ * ```
4132
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
4133
+ */
4134
+ TableVizRendered = "TableVizRendered"
4102
4135
  }
4103
4136
  /**
4104
4137
  * Event types that can be triggered by the host application
@@ -4243,7 +4276,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4243
4276
  * const url = embed.trigger(HostEvent.GetIframeUrl);
4244
4277
  * console.log("iFrameURL",url);
4245
4278
  * ```
4246
- * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
4279
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4247
4280
  */
4248
4281
  GetIframeUrl = "GetIframeUrl",
4249
4282
  /**
@@ -4276,6 +4309,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4276
4309
  * attributes passed with this event are appended to the existing runtime
4277
4310
  * filters applied on a Liveboard.
4278
4311
  *
4312
+ * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
4313
+ * and `AppEmbed` only. In full application embedding, this event updates
4314
+ * the runtime filters applied on the Liveboard and saved Answer objects.
4315
+ *
4316
+ *
4279
4317
  * Pass an array of runtime filters with the following attributes:
4280
4318
  *
4281
4319
  * `columnName` - _String_. The name of the column to filter on.
@@ -4286,9 +4324,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4286
4324
  * `values` - List of operands. Some operators such as EQ and LE allow a
4287
4325
  * single value, whereas BW and IN accept multiple values.
4288
4326
  *
4289
- * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
4290
- * and `AppEmbed` only. In full application embedding, this event updates
4291
- * the runtime filters applied on the Liveboard and saved Answer objects.
4327
+ * **Note**: Updating runtime filters resets the ThoughtSpot
4328
+ * object to its original state and applies new filter conditions.
4329
+ * Any user changes (like drilling into a visualization)
4330
+ * will be cleared, restoring the original visualization
4331
+ * with the updated filters.
4332
+ *
4292
4333
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
4293
4334
  * @example
4294
4335
  * ```js
@@ -4303,7 +4344,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4303
4344
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
4304
4345
  /**
4305
4346
  * Navigate to a specific page in the embedded ThoughtSpot application.
4306
- * This is the same as calling `appEmbed.navigateToPage(path, true)`
4347
+ * This is the same as calling `appEmbed.navigateToPage(path, true)`.
4307
4348
  * @param - `path` - the path to navigate to to go forward or back. The path value can
4308
4349
  * be a number; for example, `1`, `-1`.
4309
4350
  * @example
@@ -4499,7 +4540,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4499
4540
  * @param - an object with `vizId` as a key
4500
4541
  * @example
4501
4542
  * ```js
4502
- * liveboardEmbed.trigger(HostEvent.CreateMonitor {
4543
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
4503
4544
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4504
4545
  * })
4505
4546
  * ```
@@ -4598,7 +4639,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4598
4639
  */
4599
4640
  GetTML = "getTML",
4600
4641
  /**
4601
- * Trigger the **Show underlying data** action on visualization or search
4642
+ * Trigger the **Show underlying data** action on a
4643
+ * chart or table.
4644
+ *
4602
4645
  * @param - an object with vizId as a key
4603
4646
  * @example
4604
4647
  * ```js
@@ -4632,8 +4675,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4632
4675
  */
4633
4676
  Delete = "onDeleteAnswer",
4634
4677
  /**
4635
- * Trigger the **SpotIQ analyze** action on visualization
4636
- * or search.
4678
+ * Trigger the **SpotIQ analyze** action on a
4679
+ * chart or table.
4637
4680
  * @param - Liveboard embed takes `vizId` as a
4638
4681
  * key. Can be left undefined when embedding Search or
4639
4682
  * visualization.
@@ -4906,7 +4949,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4906
4949
  * '430496d6-6903-4601-937e-2c691821af3c',
4907
4950
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
4908
4951
  * ```
4909
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4952
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4910
4953
  */
4911
4954
  SetVisibleTabs = "SetPinboardVisibleTabs",
4912
4955
  /**
@@ -4919,7 +4962,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4919
4962
  * '630496d6-6903-4601-937e-2c691821af3c',
4920
4963
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
4921
4964
  * ```
4922
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4965
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4923
4966
  */
4924
4967
  SetHiddenTabs = "SetPinboardHiddenTabs",
4925
4968
  /**
@@ -4933,7 +4976,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4933
4976
  * executeSearch: true,
4934
4977
  * })
4935
4978
  * ```
4936
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
4979
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
4937
4980
  */
4938
4981
  UpdateSageQuery = "updateSageQuery",
4939
4982
  /**
@@ -4950,21 +4993,22 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4950
4993
  * ```js
4951
4994
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
4952
4995
  * ```
4953
- * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
4996
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
4954
4997
  */
4955
4998
  GetAnswerSession = "getAnswerSession",
4956
4999
  /**
4957
- * Trigger Ask Sage for viz
5000
+ * Trigger the *Ask Sage* action for visualizations
4958
5001
  * @example
4959
5002
  * ```js
4960
5003
  * liveboardEmbed.trigger(HostEvent.AskSage,
4961
5004
  * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
4962
5005
  * ```
4963
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
5006
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
4964
5007
  */
4965
5008
  AskSage = "AskSage",
4966
5009
  /**
4967
- * Trigger cross filter update action on a Liveboard
5010
+ * Trigger cross filter update action on a Liveboard.
5011
+ *
4968
5012
  * @example
4969
5013
  * ```js
4970
5014
  * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -4975,7 +5019,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4975
5019
  * ],
4976
5020
  * });
4977
5021
  * ```
4978
- * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
5022
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
4979
5023
  */
4980
5024
  UpdateCrossFilter = "UpdateCrossFilter",
4981
5025
  /**
@@ -4984,11 +5028,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4984
5028
  * ```js
4985
5029
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
4986
5030
  * ```
4987
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
5031
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
4988
5032
  */
4989
5033
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
4990
5034
  /**
4991
- * Triggers an event to Update Parameter values for Answers and Liveboard
5035
+ * Triggers an action to update Parameter values on embedded
5036
+ * Answers and Liveboard.
5037
+ *
4992
5038
  * @example
4993
5039
  * ```js
4994
5040
  * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -4996,37 +5042,56 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4996
5042
  * value: "almond"
4997
5043
  * }])
4998
5044
  *
4999
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
5045
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5000
5046
  */
5001
5047
  UpdateParameters = "UpdateParameters",
5002
5048
  /**
5003
- * Triggers GetParameters to fetch the runtime parameters
5049
+ * Triggers GetParameters to fetch the runtime Parameters.
5004
5050
  * ```js
5005
5051
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
5006
5052
  * console.log('parameters', parameter);
5007
5053
  * });
5008
5054
  *```
5009
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
5055
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5010
5056
  */
5011
5057
  GetParameters = "GetParameters",
5012
5058
  /**
5013
- * Triggers an event to update a persoanlised view of a Liveboard
5059
+ * Triggers an event to update a personalized view of a Liveboard.
5014
5060
  * ```js
5015
5061
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5016
5062
  * ```
5017
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5063
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5018
5064
  */
5019
5065
  UpdatePersonalisedView = "UpdatePersonalisedView",
5020
5066
  /**
5021
- * Triggers the action to get the current view of the liveboard
5022
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5067
+ * Triggers the action to get the current view of the Liveboard.
5068
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5023
5069
  */
5024
5070
  SaveAnswer = "saveAnswer",
5025
5071
  /**
5026
5072
  * EmbedApi
5027
5073
  * @hidden
5028
5074
  */
5029
- UIPassthrough = "UiPassthrough"
5075
+ UIPassthrough = "UiPassthrough",
5076
+ /**
5077
+ * Triggers the table viz rerender with the updated data.
5078
+ * Includes the following properties:
5079
+ * @param - columnDataLite - an array of object containing data
5080
+ * transformed from data picked from TableVizRendered event.
5081
+ * For example, { columnDataLite: []}
5082
+ * @example
5083
+ * ```js
5084
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
5085
+ * console.log(payload);
5086
+ * const columnDataLite = payload.data.data.columnDataLite;
5087
+ * columnDataLite[0].dataValue[0]="new fob";
5088
+ * console.log('>>> new Data', columnDataLite);
5089
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
5090
+ * })
5091
+ * ```
5092
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
5093
+ */
5094
+ TransformTableVizData = "TransformTableVizData"
5030
5095
  }
5031
5096
  /**
5032
5097
  * The different visual modes that the data sources panel within
@@ -5088,7 +5153,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5088
5153
  AuthType = "authType",
5089
5154
  IconSpriteUrl = "iconSprite",
5090
5155
  cookieless = "cookieless",
5091
- ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
5156
+ ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
5092
5157
  LinkOverride = "linkOverride",
5093
5158
  blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
5094
5159
  ShowInsertToSlide = "insertInToSlide",
@@ -5239,7 +5304,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5239
5304
  ResetLayout = "resetLayout",
5240
5305
  /**
5241
5306
  * The **Schedule** menu action on a Liveboard.
5242
- * Allows scheduling a Liveboard notification.
5307
+ * Allows scheduling a Liveboard job, for example,
5308
+ * sending periodic notifications.
5243
5309
  * @example
5244
5310
  * ```js
5245
5311
  * disabledActions: [Action.Schedule]
@@ -5281,7 +5347,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5281
5347
  * ```js
5282
5348
  * disabledActions: [Action.AddDataPanelObjects]
5283
5349
  * ```
5284
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5350
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5285
5351
  */
5286
5352
  AddDataPanelObjects = "addDataPanelObjects",
5287
5353
  /**
@@ -5294,7 +5360,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5294
5360
  * ```
5295
5361
  */
5296
5362
  ConfigureFilter = "configureFilter",
5363
+ /**
5364
+ * The **Collapse data sources** icon on the Search page.
5365
+ * Collapses the panel showing data sources.
5366
+ *
5367
+ * @example
5368
+ * ```js
5369
+ * disabledActions: [Action.CollapseDataPanel]
5370
+ * ```
5371
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5372
+ */
5297
5373
  CollapseDataSources = "collapseDataSources",
5374
+ /**
5375
+ * The **Collapse data panel** icon on the Search page.
5376
+ * Collapses the data panel view.
5377
+ *
5378
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
5379
+ *
5380
+ * @example
5381
+ * ```js
5382
+ * disabledActions: [Action.CollapseDataPanel]
5383
+ * ```
5384
+ */
5298
5385
  CollapseDataPanel = "collapseDataPanel",
5299
5386
  /**
5300
5387
  * The **Choose sources** button on Search page.
@@ -5330,7 +5417,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5330
5417
  * ```js
5331
5418
  * disabledActions: [Action.AddColumnSet]
5332
5419
  * ```
5333
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5420
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5334
5421
  */
5335
5422
  AddColumnSet = "addSimpleCohort",
5336
5423
  /**
@@ -5340,7 +5427,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5340
5427
  * ```js
5341
5428
  * disabledActions: [Action.AddQuerySet]
5342
5429
  * ```
5343
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5430
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5344
5431
  */
5345
5432
  AddQuerySet = "addAdvancedCohort",
5346
5433
  /**
@@ -5372,6 +5459,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5372
5459
  /**
5373
5460
  * The **Show underlying data** menu action on a visualization or
5374
5461
  * Answer page.
5462
+ * Displays detailed information and raw data
5463
+ * for a given visualization.
5375
5464
  * @example
5376
5465
  * ```js
5377
5466
  * disabledActions: [Action.ShowUnderlyingData]
@@ -5573,6 +5662,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5573
5662
  AnalysisInfo = "analysisInfo",
5574
5663
  /**
5575
5664
  * The **Schedule** menu action on a Liveboard.
5665
+ * Allows scheduling a Liveboard job.
5576
5666
  * @example
5577
5667
  * ```js
5578
5668
  * disabledActions: [Action.Subscription]
@@ -5642,8 +5732,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5642
5732
  */
5643
5733
  RequestAccess = "requestAccess",
5644
5734
  /**
5645
- * The **Query visualizer** and **Query SQL** buttons in Query details panel
5646
- * of the Answer page
5735
+ * The **Query visualizer** and **Query SQL** buttons in
5736
+ * Query details panel of the Answer page.
5737
+ *
5738
+ * **Query visualizer** - Displays the tables
5739
+ * and filters used in a search query.
5740
+ * **Query SQL** - Displays the SQL statements used
5741
+ * in a search query to fetch data.
5647
5742
  * @example
5648
5743
  * ```js
5649
5744
  * disabledActions: [Action.QueryDetailsButtons]
@@ -5661,7 +5756,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5661
5756
  */
5662
5757
  AnswerDelete = "onDeleteAnswer",
5663
5758
  /**
5664
- * The Chart switcher icon on Answer and visualization pages.
5759
+ * The chart switcher icon on Answer page and
5760
+ * visualizations in edit mode.
5761
+ * Allows switching to the table or chart mode
5762
+ * when editing a visualization.
5665
5763
  * @example
5666
5764
  * ```js
5667
5765
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -5670,7 +5768,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5670
5768
  */
5671
5769
  AnswerChartSwitcher = "answerChartSwitcher",
5672
5770
  /**
5673
- * Favorites icon (*) on Answers, Liveboard, and Data pages
5771
+ * The Favorites icon (*) for Answers,
5772
+ * Liveboard, and data objects like Worksheet, Model,
5773
+ * Tables and Views.
5774
+ * Allows adding an object to the user’s favorites list.
5674
5775
  * @example
5675
5776
  * ```js
5676
5777
  * disabledActions: [Action.AddToFavorites]
@@ -5688,7 +5789,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5688
5789
  */
5689
5790
  EditDetails = "editDetails",
5690
5791
  /**
5691
- * The Create alert action on KPI charts.
5792
+ * The *Create alert* action for KPI charts.
5793
+ * Allows users to schedule threshold-based alerts
5794
+ * for KPI charts.
5692
5795
  * @example
5693
5796
  * ```js
5694
5797
  * disabledActions: [Action.CreateMonitor]
@@ -5744,7 +5847,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5744
5847
  * ```js
5745
5848
  * disabledActions: [Action.CrossFilter]
5746
5849
  * ```
5747
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5850
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
5748
5851
  */
5749
5852
  CrossFilter = "context-menu-item-cross-filter",
5750
5853
  /**
@@ -5754,7 +5857,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5754
5857
  * ```js
5755
5858
  * disabledActions: [Action.SyncToSlack]
5756
5859
  * ```
5757
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5860
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5758
5861
  */
5759
5862
  SyncToSlack = "syncToSlack",
5760
5863
  /**
@@ -5764,7 +5867,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5764
5867
  * ```js
5765
5868
  * disabledActions: [Action.SyncToTeams]
5766
5869
  * ```
5767
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5870
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5768
5871
  */
5769
5872
  SyncToTeams = "syncToTeams",
5770
5873
  /**
@@ -5775,7 +5878,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5775
5878
  * ```js
5776
5879
  * disabledActions: [Action.RemoveCrossFilter]
5777
5880
  * ```
5778
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5881
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5779
5882
  */
5780
5883
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
5781
5884
  /**
@@ -5786,7 +5889,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5786
5889
  * ```js
5787
5890
  * disabledActions: [Action.AxisMenuAggregate]
5788
5891
  * ```
5789
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5892
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5790
5893
  */
5791
5894
  AxisMenuAggregate = "axisMenuAggregate",
5792
5895
  /**
@@ -5797,17 +5900,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5797
5900
  * ```js
5798
5901
  * disabledActions: [Action.AxisMenuTimeBucket]
5799
5902
  * ```
5800
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5903
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5801
5904
  */
5802
5905
  AxisMenuTimeBucket = "axisMenuTimeBucket",
5803
5906
  /**
5804
5907
  * The **Filter** action in the chart axis or table column
5805
5908
  * customization menu.
5909
+ * Allows adding, editing, or removing filters.
5910
+ *
5806
5911
  * @example
5807
5912
  * ```js
5808
5913
  * disabledActions: [Action.AxisMenuFilter]
5809
5914
  * ```
5810
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5915
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5811
5916
  */
5812
5917
  AxisMenuFilter = "axisMenuFilter",
5813
5918
  /**
@@ -5818,7 +5923,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5818
5923
  * ```js
5819
5924
  * disabledActions: [Action.AxisMenuConditionalFormat]
5820
5925
  * ```
5821
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5926
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5822
5927
  */
5823
5928
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
5824
5929
  /**
@@ -5829,7 +5934,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5829
5934
  * ```js
5830
5935
  * disabledActions: [Action.AxisMenuConditionalFormat]
5831
5936
  * ```
5832
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5937
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5833
5938
  */
5834
5939
  AxisMenuSort = "axisMenuSort",
5835
5940
  /**
@@ -5841,7 +5946,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5841
5946
  * ```js
5842
5947
  * disabledActions: [Action.AxisMenuGroup]
5843
5948
  * ```
5844
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5949
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5845
5950
  */
5846
5951
  AxisMenuGroup = "axisMenuGroup",
5847
5952
  /**
@@ -5852,7 +5957,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5852
5957
  * ```js
5853
5958
  * disabledActions: [Action.AxisMenuPosition]
5854
5959
  * ```
5855
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5960
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5856
5961
  */
5857
5962
  AxisMenuPosition = "axisMenuPosition",
5858
5963
  /**
@@ -5862,7 +5967,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5862
5967
  * ```js
5863
5968
  * disabledActions: [Action.AxisMenuRename]
5864
5969
  * ```
5865
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5970
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5866
5971
  */
5867
5972
  AxisMenuRename = "axisMenuRename",
5868
5973
  /**
@@ -5873,7 +5978,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5873
5978
  * ```js
5874
5979
  * disabledActions: [Action.AxisMenuEdit]
5875
5980
  * ```
5876
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5981
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5877
5982
  */
5878
5983
  AxisMenuEdit = "axisMenuEdit",
5879
5984
  /**
@@ -5883,7 +5988,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5883
5988
  * ```js
5884
5989
  * disabledActions: [Action.AxisMenuNumberFormat]
5885
5990
  * ```
5886
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5991
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5887
5992
  */
5888
5993
  AxisMenuNumberFormat = "axisMenuNumberFormat",
5889
5994
  /**
@@ -5893,7 +5998,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5893
5998
  * ```js
5894
5999
  * disabledActions: [Action.AxisMenuTextWrapping]
5895
6000
  * ```
5896
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6001
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5897
6002
  */
5898
6003
  AxisMenuTextWrapping = "axisMenuTextWrapping",
5899
6004
  /**
@@ -5905,7 +6010,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5905
6010
  * ```js
5906
6011
  * disabledActions: [Action.AxisMenuRemove]
5907
6012
  * ```
5908
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6013
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5909
6014
  */
5910
6015
  AxisMenuRemove = "axisMenuRemove",
5911
6016
  /**
@@ -5919,26 +6024,27 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5919
6024
  * ```js
5920
6025
  * disabledActions: [Action.RenameModalTitleDescription]
5921
6026
  * ```
5922
- * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
6027
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
5923
6028
  */
5924
6029
  RenameModalTitleDescription = "renameModalTitleDescription",
5925
6030
  /**
5926
- *
6031
+ * The *Request verification* action on a Liveboard.
6032
+ * Initiates a request for Liveboard verification.
5927
6033
  * @example
5928
6034
  * ```js
5929
6035
  * disabledActions: [Action.RequestVerification]
5930
6036
  * ```
5931
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
6037
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
5932
6038
  */
5933
6039
  RequestVerification = "requestVerification",
5934
6040
  /**
5935
6041
  *
5936
- *Allows users to mark a Liveboard as verified.
6042
+ * Allows users to mark a Liveboard as verified.
5937
6043
  * @example
5938
6044
  * ```js
5939
6045
  * disabledActions: [Action.MarkAsVerified]
5940
6046
  * ```
5941
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
6047
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
5942
6048
  */
5943
6049
  MarkAsVerified = "markAsVerified",
5944
6050
  /**
@@ -5948,7 +6054,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5948
6054
  * ```js
5949
6055
  * disabledActions: [Action.AddTab]
5950
6056
  * ```
5951
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6057
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5952
6058
  */
5953
6059
  AddTab = "addTab",
5954
6060
  /**
@@ -5958,35 +6064,42 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5958
6064
  * ```js
5959
6065
  * disabledActions: [Action.EnableContextualChangeAnalysis]
5960
6066
  * ```
5961
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
6067
+ * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
5962
6068
  */
5963
6069
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
5964
6070
  /**
6071
+ * Action ID to hide or disable Natural Language Search query.
5965
6072
  *
5966
6073
  * @example
5967
6074
  * ```js
5968
6075
  * disabledActions: [Action.ShowSageQuery]
5969
6076
  * ```
5970
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6077
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
5971
6078
  */
5972
6079
  ShowSageQuery = "showSageQuery",
5973
6080
  /**
6081
+ *
6082
+ * Action ID to hide or disable the edit option for the
6083
+ * results generated from the
6084
+ * Natural Language Search query.
5974
6085
  *
5975
6086
  * @example
5976
6087
  * ```js
5977
6088
  * disabledActions: [Action.EditSageAnswer]
5978
6089
  * ```
5979
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6090
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
5980
6091
  */
5981
6092
  EditSageAnswer = "editSageAnswer",
5982
6093
  /**
6094
+ * The feedback widget for AI-generated Answers.
6095
+ * Allows users to send feedback on the Answers generated
6096
+ * from a Natural Language Search query.
5983
6097
  *
5984
- *This action allows users to send feedback on AI-generated Answers.
5985
6098
  * @example
5986
6099
  * ```js
5987
6100
  * disabledActions: [Action.SageAnswerFeedback]
5988
6101
  * ```
5989
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6102
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5990
6103
  */
5991
6104
  SageAnswerFeedback = "sageAnswerFeedback",
5992
6105
  /**
@@ -5995,7 +6108,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5995
6108
  * ```js
5996
6109
  * disabledActions: [Action.ModifySageAnswer]
5997
6110
  * ```
5998
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6111
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5999
6112
  */
6000
6113
  ModifySageAnswer = "modifySageAnswer",
6001
6114
  /**
@@ -6008,7 +6121,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6008
6121
  */
6009
6122
  MoveToTab = "onContainerMove",
6010
6123
  /**
6011
- * The **Manage Alertsb** menu action on KPI visualizations.
6124
+ * The **Manage Alerts** menu action on KPI visualizations.
6125
+ * Allows creating, viewing, and editing monitor
6126
+ * alerts for a KPI chart.
6127
+ *
6012
6128
  * @example
6013
6129
  * ```js
6014
6130
  * disabledActions: [Action.ManageMonitor]
@@ -6016,21 +6132,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6016
6132
  */
6017
6133
  ManageMonitor = "manageMonitor",
6018
6134
  /**
6019
- * Action ID for Liveboard Personalised Views dropdown
6135
+ * The Liveboard Personalised Views dropdown.
6136
+ * Allows navigating to a personalized Liveboard View.
6020
6137
  * @example
6021
6138
  * ```js
6022
6139
  * disabledActions: [Action.PersonalisedViewsDropdown]
6023
6140
  * ```
6024
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
6141
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6025
6142
  */
6026
6143
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
6027
6144
  /**
6028
- * Action ID for Liveboard Users ( Recently Visited / social proof )
6145
+ * Action ID for show or hide the user details on a
6146
+ * Liveboard (Recently visited / social proof)
6029
6147
  * @example
6030
6148
  * ```js
6031
6149
  * disabledActions: [Action.LiveboardUsers]
6032
6150
  * ```
6033
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
6151
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6034
6152
  */
6035
6153
  LiveboardUsers = "liveboardUsers",
6036
6154
  /**
@@ -6048,108 +6166,124 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6048
6166
  * hiddenAction: [Action.TML] // hide all TML actions
6049
6167
  * disabledActions: [Action.TML] // to disable all TML actions
6050
6168
  * ```
6051
- * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
6169
+ * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6052
6170
  */
6053
6171
  TML = "tml",
6054
6172
  /**
6055
- * Action ID for the create Liveboard option on the Liveboard list page
6056
- * and Pin modal
6173
+ * The **Create Liveboard* action on
6174
+ * the Liveboards page and the Pin modal.
6175
+ * Allows users to create a Liveboard.
6176
+ *
6057
6177
  * @example
6058
6178
  * ```js
6059
6179
  * hiddenAction: [Action.CreateLiveboard]
6060
6180
  * disabledActions: [Action.CreateLiveboard]
6061
6181
  * ```
6062
- * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
6182
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
6063
6183
  */
6064
6184
  CreateLiveboard = "createLiveboard",
6065
6185
  /**
6066
- * Action ID for to hide Verified Liveboard Banner
6186
+ * Action ID for to hide or disable the
6187
+ * Verified Liveboard banner.
6067
6188
  * @example
6068
6189
  * ```js
6069
6190
  * hiddenAction: [Action.VerifiedLiveboard]
6070
6191
  * ```
6071
- * @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
6192
+ * @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
6072
6193
  */
6073
6194
  VerifiedLiveboard = "verifiedLiveboard",
6074
6195
  /**
6075
- * Action ID for ask sage button
6196
+ * The *Ask Sage* action for Answers and visualizations.
6197
+ * Allows initiating a Natural Language Search query.
6198
+ *
6076
6199
  * @example
6077
6200
  * ```js
6078
6201
  * hiddenAction: [Action.AskAi]
6079
6202
  * ```
6080
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
6203
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
6081
6204
  */
6082
6205
  AskAi = "AskAi",
6083
6206
  /**
6084
6207
  * The **Add KPI to Watchlist** action on Home page watchlist.
6208
+ * Adds a KPI chart to the watchlist on the Home page.
6085
6209
  * @example
6086
6210
  * ```js
6087
6211
  * disabledActions: [Action.AddToWatchlist]
6088
6212
  * ```
6089
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
6213
+ * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6090
6214
  */
6091
6215
  AddToWatchlist = "addToWatchlist",
6092
6216
  /**
6093
6217
  * The **Remove from watchlist** menu action on KPI watchlist.
6218
+ * Removes a KPI chart from the watchlist on the Home page.
6094
6219
  * @example
6095
6220
  * ```js
6096
6221
  * disabledActions: [Action.RemoveFromWatchlist]
6097
6222
  * ```
6098
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
6223
+ * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6099
6224
  */
6100
6225
  RemoveFromWatchlist = "removeFromWatchlist",
6101
6226
  /**
6102
- * The **Organise Favourites** action on Homepage Favourite Module.
6227
+ * The **Organize Favourites** action on Homepage
6228
+ * *Favorites* module.
6229
+ *
6103
6230
  * @example
6104
6231
  * ```js
6105
6232
  * disabledActions: [Action.OrganiseFavourites]
6106
6233
  * ```
6107
- * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
6234
+ * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6108
6235
  */
6109
6236
  OrganiseFavourites = "organiseFavourites",
6110
6237
  /**
6111
- * Action ID for AI Highlights button
6238
+ * The **AI Highlights** action on a Liveboard.
6239
+ *
6112
6240
  * @example
6113
6241
  * ```js
6114
6242
  * hiddenAction: [Action.AIHighlights]
6115
6243
  * ```
6116
- * @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
6244
+ * @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
6117
6245
  */
6118
6246
  AIHighlights = "AIHighlights",
6119
6247
  /**
6120
- * Action ID for edit the schedule action on schedule on homepage
6248
+ * The *Edit* action on the *Liveboard Schedules* page
6249
+ * (new Homepage experience).
6250
+ * Allows editing Liveboard schedules.
6251
+ *
6121
6252
  * @example
6122
6253
  * ```js
6123
6254
  * disabledActions: [Action.EditScheduleHomepage]
6124
6255
  * ```
6125
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6256
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6126
6257
  */
6127
6258
  EditScheduleHomepage = "editScheduleHomepage",
6128
6259
  /**
6129
- * Action ID for pause schedule action on schedule on homepage
6260
+ * The *Pause* action on the *Liveboard Schedules* page
6261
+ * Pauses a scheduled Liveboard job.
6130
6262
  * @example
6131
6263
  * ```js
6132
6264
  * disabledActions: [Action.PauseScheduleHomepage]
6133
6265
  * ```
6134
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6266
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6135
6267
  */
6136
6268
  PauseScheduleHomepage = "pauseScheduleHomepage",
6137
6269
  /**
6138
- * Action ID for view schedule run action on schedule on homepage
6270
+ * The **View run history** action **Liveboard Schedules** page.
6271
+ * Allows viewing schedule run history.
6139
6272
  * @example
6140
6273
  * ```js
6141
6274
  * disabledActions: [Action.ViewScheduleRunHomepage]
6142
6275
  * ```
6143
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6276
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6144
6277
  */
6145
6278
  ViewScheduleRunHomepage = "viewScheduleRunHomepage",
6146
6279
  /**
6147
- * Action ID for unsubscribe schedule action on schedule on homepage
6280
+ * Action ID to hide or disable the
6281
+ * unsubscribe option for Liveboard schedules.
6148
6282
  * @example
6149
6283
  * ```js
6150
6284
  * disabledActions: [Action.UnsubscribeScheduleHomepage]
6151
6285
  * ```
6152
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6286
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6153
6287
  */
6154
6288
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
6155
6289
  /**
@@ -6158,16 +6292,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6158
6292
  * ```js
6159
6293
  * disabledActions: [Action.ManageTags]
6160
6294
  * ```
6161
- * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
6295
+ * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6162
6296
  */
6163
6297
  ManageTags = "manageTags",
6164
6298
  /**
6165
- * Action ID for delete schedule action on schedule on homepage
6299
+ * The **Delete** action on the **Liveboard Schedules* page.
6300
+ * Deletes a Liveboard schedule.
6166
6301
  * @example
6167
6302
  * ```js
6168
6303
  * disabledActions: [Action.DeleteScheduleHomepage]
6169
6304
  * ```
6170
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6305
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6171
6306
  */
6172
6307
  DeleteScheduleHomepage = "deleteScheduleHomepage",
6173
6308
  /**
@@ -6176,7 +6311,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6176
6311
  * ```js
6177
6312
  * disabledActions: [Action.KPIAnalysisCTA]
6178
6313
  * ```
6179
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6314
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6180
6315
  */
6181
6316
  KPIAnalysisCTA = "kpiAnalysisCTA",
6182
6317
  /**
@@ -6185,61 +6320,73 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6185
6320
  * ```js
6186
6321
  * const disabledActions = [Action.DisableChipReorder]
6187
6322
  * ```
6188
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6323
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6189
6324
  */
6190
6325
  DisableChipReorder = "disableChipReorder",
6191
6326
  /**
6192
- * Action ID for Hide Irrelevant filters button
6327
+ * Action ID to show, hide, or disable filters
6328
+ * in a Liveboard tab.
6329
+ *
6193
6330
  * @example
6194
6331
  * ```js
6195
6332
  * hiddenAction: [Action.ChangeFilterVisibilityInTab]
6196
6333
  * ```
6197
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6334
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6198
6335
  */
6199
6336
  ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
6200
6337
  /**
6201
- * Action ID for hide/disable Preview data button in spotter
6338
+ * The **Preview data** button on the Spotter interface.
6339
+ * Allows previewing the data used for Spotter queries.
6340
+ *
6202
6341
  * @example
6203
6342
  * ```js
6204
6343
  * hiddenAction: [Action.PreviewDataSpotter]
6205
6344
  * ```
6206
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6345
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6207
6346
  */
6208
6347
  PreviewDataSpotter = "previewDataSpotter",
6209
6348
  /**
6210
- * Action ID for hide/disable reset button in spotter
6349
+ * The **Reset** link on the Spotter interface.
6350
+ * Resets the conversation with Spotter.
6351
+ *
6211
6352
  * @example
6212
6353
  * ```js
6213
6354
  * hiddenAction: [Action.ResetSpotterChat]
6214
6355
  * ```
6215
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6356
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6216
6357
  */
6217
6358
  ResetSpotterChat = "resetSpotterChat",
6218
6359
  /**
6219
- * Action ID for hide/disable feedback in spotter
6360
+ * Action ID for hide or disable the
6361
+ * Spotter feedback widget.
6362
+ *
6220
6363
  * @example
6221
6364
  * ```js
6222
6365
  * hiddenAction: [Action.SpotterFeedback]
6223
6366
  * ```
6224
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6367
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6225
6368
  */
6226
6369
  SpotterFeedback = "spotterFeedback",
6227
6370
  /**
6228
- * Action ID for hide/disable editing previous prompt in spotter
6371
+ * Action ID for hide or disable
6372
+ * the previous prompt edit option in Spotter.
6373
+ *
6229
6374
  * @example
6230
6375
  * ```js
6231
6376
  * hiddenAction: [Action.EditPreviousPrompt]
6232
6377
  * ```
6233
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6378
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6234
6379
  */
6235
6380
  EditPreviousPrompt = "editPreviousPrompt",
6236
6381
  /**
6237
- * Action ID for hide/disable deleting previous prompt in spotter
6382
+ * Action ID for hide or disable
6383
+ * the previous prompt deletion option in Spotter.
6384
+ *
6238
6385
  * @example
6239
6386
  * ```js
6240
6387
  * hiddenAction: [Action.DeletePreviousPrompt]
6241
6388
  * ```
6242
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6389
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6243
6390
  */
6244
6391
  DeletePreviousPrompt = "deletePreviousPrompt",
6245
6392
  /**
@@ -6248,7 +6395,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6248
6395
  * ```js
6249
6396
  * hiddenAction: [Action.EditTokens]
6250
6397
  * ```
6251
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6398
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6252
6399
  */
6253
6400
  EditTokens = "editTokens"
6254
6401
  }
@@ -6263,10 +6410,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6263
6410
  }
6264
6411
  /**
6265
6412
  * Enum for options to change context trigger
6413
+ * BOTH_CLICKS option is introduced in 10.7
6266
6414
  */
6267
6415
  export enum ContextMenuTriggerOptions {
6268
6416
  LEFT_CLICK = "left-click",
6269
- RIGHT_CLICK = "right-click"
6417
+ RIGHT_CLICK = "right-click",
6418
+ BOTH_CLICKS = "both-clicks"
6270
6419
  }
6271
6420
  export interface ColumnValue {
6272
6421
  column: {
@@ -6319,7 +6468,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6319
6468
  * logLevel: LogLevel.SILENT,
6320
6469
  * })
6321
6470
  * ```
6322
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6471
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6323
6472
  */
6324
6473
  SILENT = "SILENT",
6325
6474
  /**
@@ -6331,7 +6480,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6331
6480
  * logLevel: LogLevel.ERROR,
6332
6481
  * })
6333
6482
  * ```
6334
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6483
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6335
6484
  */
6336
6485
  ERROR = "ERROR",
6337
6486
  /**
@@ -6343,7 +6492,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6343
6492
  * logLevel: LogLevel.WARN,
6344
6493
  * })
6345
6494
  * ```
6346
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6495
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6347
6496
  */
6348
6497
  WARN = "WARN",
6349
6498
  /**
@@ -6355,7 +6504,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6355
6504
  * logLevel: LogLevel.INFO,
6356
6505
  * })
6357
6506
  * ```
6358
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6507
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6359
6508
  */
6360
6509
  INFO = "INFO",
6361
6510
  /**
@@ -6367,7 +6516,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6367
6516
  * logLevel: LogLevel.DEBUG,
6368
6517
  * })
6369
6518
  * ```
6370
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6519
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6371
6520
  */
6372
6521
  DEBUG = "DEBUG",
6373
6522
  /**
@@ -6379,7 +6528,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6379
6528
  * logLevel: LogLevel.TRACE,
6380
6529
  * })
6381
6530
  * ```
6382
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6531
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6383
6532
  */
6384
6533
  TRACE = "TRACE"
6385
6534
  }
@@ -7227,7 +7376,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts' {
7227
7376
  PinAnswerToLiveboard = "addVizToPinboard",
7228
7377
  SaveAnswer = "saveAnswer",
7229
7378
  GetDiscoverabilityStatus = "getDiscoverabilityStatus",
7230
- GetAvailableUIPassthroughs = "getAvailableUIPassthroughs",
7379
+ GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
7231
7380
  GetAnswerConfig = "getAnswerPageConfig",
7232
7381
  GetLiveboardConfig = "getPinboardPageConfig"
7233
7382
  }