@thoughtspot/visual-embed-sdk 1.46.5 → 1.47.1

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 (158) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +9 -0
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +7 -2
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/app.spec.js +22 -2
  7. package/cjs/src/embed/app.spec.js.map +1 -1
  8. package/cjs/src/embed/conversation.d.ts +10 -1
  9. package/cjs/src/embed/conversation.d.ts.map +1 -1
  10. package/cjs/src/embed/conversation.js +2 -1
  11. package/cjs/src/embed/conversation.js.map +1 -1
  12. package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -1
  13. package/cjs/src/embed/hostEventClient/utils.js +7 -1
  14. package/cjs/src/embed/hostEventClient/utils.js.map +1 -1
  15. package/cjs/src/embed/hostEventClient/utils.spec.js +80 -5
  16. package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -1
  17. package/cjs/src/embed/liveboard.d.ts +9 -0
  18. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  19. package/cjs/src/embed/liveboard.js +4 -1
  20. package/cjs/src/embed/liveboard.js.map +1 -1
  21. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  22. package/cjs/src/embed/ts-embed.js +12 -4
  23. package/cjs/src/embed/ts-embed.js.map +1 -1
  24. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  25. package/cjs/src/embed/ts-embed.spec.js +28 -67
  26. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  27. package/cjs/src/errors.d.ts +0 -1
  28. package/cjs/src/errors.d.ts.map +1 -1
  29. package/cjs/src/errors.js +0 -1
  30. package/cjs/src/errors.js.map +1 -1
  31. package/cjs/src/index.d.ts +1 -2
  32. package/cjs/src/index.d.ts.map +1 -1
  33. package/cjs/src/index.js +2 -4
  34. package/cjs/src/index.js.map +1 -1
  35. package/cjs/src/react/all-types-export.d.ts +2 -2
  36. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  37. package/cjs/src/react/all-types-export.js +1 -3
  38. package/cjs/src/react/all-types-export.js.map +1 -1
  39. package/cjs/src/react/index.d.ts +1 -36
  40. package/cjs/src/react/index.d.ts.map +1 -1
  41. package/cjs/src/react/index.js +1 -34
  42. package/cjs/src/react/index.js.map +1 -1
  43. package/cjs/src/types.d.ts +42 -74
  44. package/cjs/src/types.d.ts.map +1 -1
  45. package/cjs/src/types.js +18 -46
  46. package/cjs/src/types.js.map +1 -1
  47. package/dist/{index-ChNydfIz.js → index-CUgxBnPm.js} +1 -1
  48. package/dist/src/embed/app.d.ts +9 -0
  49. package/dist/src/embed/app.d.ts.map +1 -1
  50. package/dist/src/embed/conversation.d.ts +10 -1
  51. package/dist/src/embed/conversation.d.ts.map +1 -1
  52. package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -1
  53. package/dist/src/embed/liveboard.d.ts +9 -0
  54. package/dist/src/embed/liveboard.d.ts.map +1 -1
  55. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  56. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  57. package/dist/src/errors.d.ts +0 -1
  58. package/dist/src/errors.d.ts.map +1 -1
  59. package/dist/src/index.d.ts +1 -2
  60. package/dist/src/index.d.ts.map +1 -1
  61. package/dist/src/react/all-types-export.d.ts +2 -2
  62. package/dist/src/react/all-types-export.d.ts.map +1 -1
  63. package/dist/src/react/index.d.ts +1 -36
  64. package/dist/src/react/index.d.ts.map +1 -1
  65. package/dist/src/types.d.ts +42 -74
  66. package/dist/src/types.d.ts.map +1 -1
  67. package/dist/tsembed-react.es.js +72 -200
  68. package/dist/tsembed-react.js +60 -190
  69. package/dist/tsembed.es.js +87 -181
  70. package/dist/tsembed.js +30812 -30907
  71. package/dist/visual-embed-sdk-react-full.d.ts +71 -255
  72. package/dist/visual-embed-sdk-react.d.ts +71 -255
  73. package/dist/visual-embed-sdk.d.ts +69 -225
  74. package/lib/package.json +1 -1
  75. package/lib/src/embed/app.d.ts +9 -0
  76. package/lib/src/embed/app.d.ts.map +1 -1
  77. package/lib/src/embed/app.js +7 -2
  78. package/lib/src/embed/app.js.map +1 -1
  79. package/lib/src/embed/app.spec.js +22 -2
  80. package/lib/src/embed/app.spec.js.map +1 -1
  81. package/lib/src/embed/conversation.d.ts +10 -1
  82. package/lib/src/embed/conversation.d.ts.map +1 -1
  83. package/lib/src/embed/conversation.js +2 -1
  84. package/lib/src/embed/conversation.js.map +1 -1
  85. package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -1
  86. package/lib/src/embed/hostEventClient/utils.js +7 -1
  87. package/lib/src/embed/hostEventClient/utils.js.map +1 -1
  88. package/lib/src/embed/hostEventClient/utils.spec.js +80 -5
  89. package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -1
  90. package/lib/src/embed/liveboard.d.ts +9 -0
  91. package/lib/src/embed/liveboard.d.ts.map +1 -1
  92. package/lib/src/embed/liveboard.js +4 -1
  93. package/lib/src/embed/liveboard.js.map +1 -1
  94. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  95. package/lib/src/embed/ts-embed.js +12 -4
  96. package/lib/src/embed/ts-embed.js.map +1 -1
  97. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  98. package/lib/src/embed/ts-embed.spec.js +30 -69
  99. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  100. package/lib/src/errors.d.ts +0 -1
  101. package/lib/src/errors.d.ts.map +1 -1
  102. package/lib/src/errors.js +0 -1
  103. package/lib/src/errors.js.map +1 -1
  104. package/lib/src/index.d.ts +1 -2
  105. package/lib/src/index.d.ts.map +1 -1
  106. package/lib/src/index.js +1 -2
  107. package/lib/src/index.js.map +1 -1
  108. package/lib/src/react/all-types-export.d.ts +2 -2
  109. package/lib/src/react/all-types-export.d.ts.map +1 -1
  110. package/lib/src/react/all-types-export.js +1 -1
  111. package/lib/src/react/all-types-export.js.map +1 -1
  112. package/lib/src/react/index.d.ts +1 -36
  113. package/lib/src/react/index.d.ts.map +1 -1
  114. package/lib/src/react/index.js +0 -33
  115. package/lib/src/react/index.js.map +1 -1
  116. package/lib/src/types.d.ts +42 -74
  117. package/lib/src/types.d.ts.map +1 -1
  118. package/lib/src/types.js +18 -46
  119. package/lib/src/types.js.map +1 -1
  120. package/lib/src/visual-embed-sdk.d.ts +69 -225
  121. package/package.json +1 -1
  122. package/src/embed/app.spec.ts +33 -3
  123. package/src/embed/app.ts +18 -3
  124. package/src/embed/conversation.ts +15 -4
  125. package/src/embed/hostEventClient/utils.spec.ts +94 -6
  126. package/src/embed/hostEventClient/utils.ts +15 -2
  127. package/src/embed/liveboard.ts +13 -0
  128. package/src/embed/ts-embed.spec.ts +56 -108
  129. package/src/embed/ts-embed.ts +10 -3
  130. package/src/errors.ts +0 -1
  131. package/src/index.ts +2 -5
  132. package/src/react/all-types-export.ts +0 -3
  133. package/src/react/index.tsx +15 -59
  134. package/src/types.ts +103 -137
  135. package/cjs/src/embed/sage.d.ts +0 -164
  136. package/cjs/src/embed/sage.d.ts.map +0 -1
  137. package/cjs/src/embed/sage.js +0 -88
  138. package/cjs/src/embed/sage.js.map +0 -1
  139. package/cjs/src/embed/sage.spec.d.ts +0 -2
  140. package/cjs/src/embed/sage.spec.d.ts.map +0 -1
  141. package/cjs/src/embed/sage.spec.js +0 -151
  142. package/cjs/src/embed/sage.spec.js.map +0 -1
  143. package/dist/index-DGV_zh53.js +0 -7371
  144. package/dist/index-DW2wEHqy.js +0 -7371
  145. package/dist/src/embed/sage.d.ts +0 -164
  146. package/dist/src/embed/sage.d.ts.map +0 -1
  147. package/dist/src/embed/sage.spec.d.ts +0 -2
  148. package/dist/src/embed/sage.spec.d.ts.map +0 -1
  149. package/lib/src/embed/sage.d.ts +0 -164
  150. package/lib/src/embed/sage.d.ts.map +0 -1
  151. package/lib/src/embed/sage.js +0 -84
  152. package/lib/src/embed/sage.js.map +0 -1
  153. package/lib/src/embed/sage.spec.d.ts +0 -2
  154. package/lib/src/embed/sage.spec.d.ts.map +0 -1
  155. package/lib/src/embed/sage.spec.js +0 -148
  156. package/lib/src/embed/sage.spec.js.map +0 -1
  157. package/src/embed/sage.spec.ts +0 -206
  158. package/src/embed/sage.ts +0 -231
@@ -1438,11 +1438,6 @@ export interface EmbedConfig {
1438
1438
  * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
1439
1439
  */
1440
1440
  suppressSearchEmbedBetaWarning?: boolean;
1441
- /**
1442
- * Hide `beta` alert warning message for SageEmbed.
1443
- *
1444
- */
1445
- suppressSageEmbedBetaWarning?: boolean;
1446
1441
  /**
1447
1442
  * Custom style params for embed Config.
1448
1443
  * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
@@ -1524,6 +1519,7 @@ export interface EmbedConfig {
1524
1519
  /**
1525
1520
  * Disables the Mixpanel tracking from the SDK.
1526
1521
  * @version SDK: 1.27.9
1522
+ * @hidden
1527
1523
  */
1528
1524
  disableSDKTracking?: boolean;
1529
1525
  /**
@@ -1826,7 +1822,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1826
1822
  * The width and height dimensions to render an embedded
1827
1823
  * object inside your app. Specify the values in pixels or percentage.
1828
1824
  *
1829
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1825
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1830
1826
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
1831
1827
  * @example
1832
1828
  * ```js
@@ -1855,7 +1851,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1855
1851
  * for the user.
1856
1852
  * Use this to disable actions.
1857
1853
  *
1858
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1854
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1859
1855
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1860
1856
  * @example
1861
1857
  * ```js
@@ -1870,7 +1866,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1870
1866
  /**
1871
1867
  * The tooltip to display for disabled actions.
1872
1868
  *
1873
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1869
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1874
1870
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1875
1871
  * @example
1876
1872
  * ```js
@@ -1888,7 +1884,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1888
1884
  * These actions will be hidden from the user.
1889
1885
  * Use this to hide an action.
1890
1886
  *
1891
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1887
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1892
1888
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1893
1889
  * @example
1894
1890
  * ```js
@@ -1909,7 +1905,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1909
1905
  *
1910
1906
  * Use either this or hiddenActions.
1911
1907
  *
1912
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1908
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1913
1909
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1914
1910
  * @important
1915
1911
  * @example
@@ -1925,7 +1921,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1925
1921
  /**
1926
1922
  * The locale settings to apply to the embedded view.
1927
1923
  *
1928
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1924
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1929
1925
  * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1930
1926
  * @example
1931
1927
  * ```js
@@ -1946,7 +1942,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1946
1942
  * to control embed behavior in non-regular ways. We do not publish the
1947
1943
  * list of supported keys and values associated with each.
1948
1944
  *
1949
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1945
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1950
1946
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1951
1947
  * @example
1952
1948
  * ```js
@@ -1974,7 +1970,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1974
1970
  * Insert as a sibling of the target container, instead of appending to a
1975
1971
  * child inside it.
1976
1972
  *
1977
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1973
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1978
1974
  * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
1979
1975
  * @example
1980
1976
  * ```js
@@ -2000,7 +1996,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2000
1996
  * Use PreRender to render the embed in the background and then
2001
1997
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
2002
1998
  *
2003
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1999
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2004
2000
  * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
2005
2001
  * @example
2006
2002
  * ```js
@@ -2037,7 +2033,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2037
2033
  * Enable the V2 shell. This can provide performance benefits
2038
2034
  * due to a lighter-weight shell.
2039
2035
  *
2040
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2036
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2041
2037
  * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
2042
2038
  * @example
2043
2039
  * ```js
@@ -2064,7 +2060,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2064
2060
  * This flag can be used to disable links inside the embedded app,
2065
2061
  * and disable redirection of links in a new tab.
2066
2062
  *
2067
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2063
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2068
2064
  * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
2069
2065
  * @example
2070
2066
  * ```js
@@ -2083,7 +2079,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2083
2079
  * The `overrideOrgId` setting is honoured only if the
2084
2080
  * Per Org URL feature is enabled on your ThoughtSpot instance.
2085
2081
  *
2086
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2082
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2087
2083
  * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
2088
2084
  * @example
2089
2085
  * ```js
@@ -2103,7 +2099,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2103
2099
  * {@link enableLinkOverridesV2} instead.
2104
2100
  *
2105
2101
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2106
- * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2102
+ * `SearchEmbed`, `SpotterAgentEmbed`,
2107
2103
  * `SpotterEmbed`, `SearchBarEmbed`
2108
2104
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2109
2105
  * @example
@@ -2127,7 +2123,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2127
2123
  * older ThoughtSpot versions.
2128
2124
  *
2129
2125
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2130
- * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2126
+ * `SearchEmbed`, `SpotterAgentEmbed`,
2131
2127
  * `SpotterEmbed`, `SearchBarEmbed`
2132
2128
  * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
2133
2129
  * @example
@@ -2186,7 +2182,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2186
2182
  * external app, calling an API, or opening a modal — based on the data context of
2187
2183
  * what they clicked can be used to trigger custom logic when the action is clicked.
2188
2184
  *
2189
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed`
2185
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterEmbed`
2190
2186
  * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
2191
2187
  * @example
2192
2188
  * ```ts
@@ -2538,11 +2534,11 @@ export interface SearchLiveboardCommonViewConfig {
2538
2534
  /**
2539
2535
  * flag to set ContextMenu Trigger to either left or right click.
2540
2536
  *
2541
- * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
2537
+ * Supported embed types: `AppEmbed`, `SearchEmbed`
2542
2538
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2543
2539
  * @example
2544
2540
  * ```js
2545
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
2541
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchEmbed
2546
2542
  * const embed = new <EmbedComponent>('#tsEmbed', {
2547
2543
  * ... // other embed view config
2548
2544
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
@@ -2579,12 +2575,12 @@ export interface SearchLiveboardCommonViewConfig {
2579
2575
  /**
2580
2576
  * To set the initial state of the search bar in case of saved Answers.
2581
2577
  *
2582
- * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`
2578
+ * Supported embed types: `AppEmbed`, `SearchBarEmbed`
2583
2579
  * @default true
2584
2580
  * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
2585
2581
  * @example
2586
2582
  * ```js
2587
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
2583
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
2588
2584
  * const embed = new <EmbedComponent>('#tsEmbed', {
2589
2585
  * ... // other embed view config
2590
2586
  * collapseSearchBar: true,
@@ -2595,12 +2591,12 @@ export interface SearchLiveboardCommonViewConfig {
2595
2591
  /**
2596
2592
  * Flag to control Data panel experience
2597
2593
  *
2598
- * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2594
+ * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2599
2595
  * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
2600
2596
  * @default true
2601
2597
  * @example
2602
2598
  * ```js
2603
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
2599
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
2604
2600
  * const embed = new <EmbedComponent>('#tsEmbed', {
2605
2601
  * ... // other embed view config
2606
2602
  * dataPanelV2: true,
@@ -2611,12 +2607,12 @@ export interface SearchLiveboardCommonViewConfig {
2611
2607
  /**
2612
2608
  * To enable custom column groups in data panel v2
2613
2609
  *
2614
- * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2610
+ * Supported embed types: `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2615
2611
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
2616
2612
  * @default false
2617
2613
  * @example
2618
2614
  * ```js
2619
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed
2615
+ * // Replace <EmbedComponent> with embed component name. For example, SearchBarEmbed, or LiveboardEmbed
2620
2616
  * const embed = new <EmbedComponent>('#tsEmbed', {
2621
2617
  * ... // other embed view config
2622
2618
  * enableCustomColumnGroups: true,
@@ -3984,19 +3980,6 @@ export declare enum EmbedEvent {
3984
3980
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3985
3981
  */
3986
3982
  FilterChanged = "filterChanged",
3987
- /**
3988
- * Emitted when a user clicks the **Go** button to initiate
3989
- * a Natural Language Search query
3990
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3991
- */
3992
- SageEmbedQuery = "sageEmbedQuery",
3993
- /**
3994
- * Emitted when a user selects a data source on the embedded
3995
- * Natural Language Search interface.
3996
- *
3997
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3998
- */
3999
- SageWorksheetUpdated = "sageWorksheetUpdated",
4000
3983
  /**
4001
3984
  * Emitted when a user updates a connection on the **Data** page
4002
3985
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
@@ -5459,7 +5442,7 @@ export declare enum HostEvent {
5459
5442
  * tml.answer.search_query // TML representation of the search query
5460
5443
  * );
5461
5444
  * })
5462
- * ```
5445
+ * ```
5463
5446
  * @example
5464
5447
  * ```js
5465
5448
  * // Get TML from search context
@@ -6082,21 +6065,6 @@ export declare enum HostEvent {
6082
6065
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
6083
6066
  */
6084
6067
  SetHiddenTabs = "SetPinboardHiddenTabs",
6085
- /**
6086
- * Updates the search query string for Natural Language Search operations.
6087
- * @param - Includes the following keys:
6088
- * - `queryString`: Text string in Natural Language format.
6089
- * - `executeSearch`: Boolean to execute search and update search query.
6090
- * @example
6091
- * ```js
6092
- * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
6093
- * queryString: 'revenue per year',
6094
- * executeSearch: true,
6095
- * })
6096
- * ```
6097
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
6098
- */
6099
- UpdateSageQuery = "updateSageQuery",
6100
6068
  /**
6101
6069
  * Get the Answer session for a Search or
6102
6070
  * Liveboard visualization.
@@ -7882,11 +7850,11 @@ export declare enum Action {
7882
7850
  */
7883
7851
  CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
7884
7852
  /**
7885
- * Action ID to hide or disable the Coaching workflow in Spotter conversations.
7886
- * When disabled, users cannot access **Add to Coaching** workflow in conversation.
7887
- * The **Add to Coaching** feature allows adding reference questions and
7888
- * business terms to improve Spotter’s responses. This feature is generally available
7889
- * (GA) from version 26.2.0.cl and enabled by default on embed deployments.
7853
+ * Action ID to hide or disable the Coaching workflow in Spotter conversations.
7854
+ * When disabled, users cannot access **Add to Coaching** workflow in conversation.
7855
+ * The **Add to Coaching** feature allows adding reference questions and
7856
+ * business terms to improve Spotter’s responses. This feature is generally available
7857
+ * (GA) from version 26.2.0.cl and enabled by default on embed deployments.
7890
7858
  * @example
7891
7859
  * ```js
7892
7860
  * hiddenAction: [Action.InConversationTraining]
@@ -7963,17 +7931,17 @@ export declare enum Action {
7963
7931
  */
7964
7932
  LiveboardStylePanel = "liveboardStylePanel",
7965
7933
  /**
7966
- * The **Publish** action for Liveboards, Answers and Models.
7967
- * Opens the publishing modal. It's a parent action for the
7968
- * **Manage Publishing** and **Unpublish** actions if the object
7969
- * is already published, otherwise appears standalone.
7970
- * @example
7971
- * ```js
7972
- * hiddenActions: [Action.Publish]
7973
- * disabledActions: [Action.Publish]
7974
- * ```
7975
- * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
7976
- */
7934
+ * The **Publish** action for Liveboards, Answers and Models.
7935
+ * Opens the publishing modal. It's a parent action for the
7936
+ * **Manage Publishing** and **Unpublish** actions if the object
7937
+ * is already published, otherwise appears standalone.
7938
+ * @example
7939
+ * ```js
7940
+ * hiddenActions: [Action.Publish]
7941
+ * disabledActions: [Action.Publish]
7942
+ * ```
7943
+ * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
7944
+ */
7977
7945
  Publish = "publish",
7978
7946
  /**
7979
7947
  * The **Manage Publishing** action for Liveboards, Answers and Models.
@@ -9989,150 +9957,6 @@ declare class SearchBarEmbed extends TsEmbed {
9989
9957
  protected getAppInitData(): Promise<SearchAppInitData$1>;
9990
9958
  }
9991
9959
  interface SearchOptions$1 {
9992
- /**
9993
- * The query string to pass for Natural Language Search.
9994
- */
9995
- searchQuery: string;
9996
- /**
9997
- * Boolean to define if the search should be executed or not.
9998
- * If it is executed, the focus is placed on the results.
9999
- * If it’s not executed, the focus is placed at the end of
10000
- * the token string in the search bar.
10001
- */
10002
- executeSearch?: boolean;
10003
- }
10004
- /**
10005
- * The configuration attributes for the embedded Natural language search view. Based on
10006
- * GPT and LLM.
10007
- * @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
10008
- *
10009
- * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
10010
- * @group Embed components
10011
- */
10012
- export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, "primaryAction" | "runtimeFilters" | "runtimeParameters" | "excludeRuntimeFiltersfromURL" | "excludeRuntimeParametersfromURL"> {
10013
- /**
10014
- * If set to true, a list of Liveboard and Answers related
10015
- * to the natural language search will be shown below the
10016
- * AI generated answer.
10017
- * @deprecated Currently Liveboard and Answers related
10018
- * to the natural language search will not be shown for sage
10019
- * embed
10020
- */
10021
- showObjectResults?: boolean;
10022
- /**
10023
- * flag used by the TS product tour page to show the blue search bar
10024
- * even after the search is completed. This is different from ThoughtSpot Embedded
10025
- * Sage Embed experience where it mimics closer to the non-embed case.
10026
- * The Sample questions container is collapsed when this value is set after
10027
- * does a search.
10028
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
10029
- * @hidden
10030
- */
10031
- isProductTour?: boolean;
10032
- /**
10033
- * Show or hide the search bar title.
10034
- * @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
10035
- * @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
10036
- */
10037
- hideSearchBarTitle?: boolean;
10038
- /**
10039
- * Show or hide the Answer header, that is, the `AI Answer` title
10040
- * at the top of the Answer page.
10041
- * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl
10042
- */
10043
- hideSageAnswerHeader?: boolean;
10044
- /**
10045
- * Disable the data source selection option.
10046
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
10047
- */
10048
- disableWorksheetChange?: boolean;
10049
- /**
10050
- * Hide the data source selection panel.
10051
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
10052
- */
10053
- hideWorksheetSelector?: boolean;
10054
- /**
10055
- * Show or hide autocomplete suggestions for the search query string.
10056
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
10057
- */
10058
- hideAutocompleteSuggestions?: boolean;
10059
- /**
10060
- * Show or hide autocomplete suggestions for the search query string.
10061
- * You can use {@link hideAutocompleteSuggestions} instead.
10062
- * @deprecated
10063
- * Currently, the object suggestions will not be shown for Natural Language Search.
10064
- */
10065
- showObjectSuggestions?: boolean;
10066
- /**
10067
- * Show or hide sample questions.
10068
- * The sample questions are autogenerated based on the data model
10069
- * selected for the search operation.
10070
- *
10071
- * Supported embed types: `SageEmbed`
10072
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
10073
- * @example
10074
- * ```js
10075
- * const embed = new SageEmbed('#tsEmbed', {
10076
- * ... //other embed view config
10077
- * hideSampleQuestions : true,
10078
- * })
10079
- * ```
10080
- */
10081
- hideSampleQuestions?: boolean;
10082
- /**
10083
- * The data source GUID (Model GUID) to set on load.
10084
- */
10085
- dataSource?: string;
10086
- /**
10087
- * Includes the following properties:
10088
- *
10089
- * `searchQuery`: The search query string to pass in the search bar.
10090
- * Supports Natural Language Search queries.
10091
- *
10092
- * `executeSearch`: Boolean to define if the search should be executed or not.
10093
- * If it is executed, the focus is placed on the results.
10094
- * If it’s not executed, the focus is placed at the end of
10095
- * the token string in the search bar.
10096
- *
10097
- * Supported embed types: `SageEmbed`
10098
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
10099
- * @example
10100
- * ```js
10101
- * searchOptions: {
10102
- * searchQuery: 'average sales by country and product type',
10103
- * executeSearch: true,
10104
- * }
10105
- * ```
10106
- */
10107
- searchOptions?: SearchOptions$1;
10108
- }
10109
- declare class SageEmbed extends V1Embed {
10110
- /**
10111
- * The view configuration for the embedded ThoughtSpot sage.
10112
- *
10113
- */
10114
- protected viewConfig: SageViewConfig;
10115
- constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
10116
- protected getEmbedParamsObject(): Record<any, any>;
10117
- /**
10118
- * Constructs a map of parameters to be passed on to the
10119
- * embedded Eureka or Sage search page.
10120
- * @returns {string} query string
10121
- */
10122
- protected getEmbedParams(): string;
10123
- /**
10124
- * Construct the URL of the embedded ThoughtSpot sage to be
10125
- * loaded in the iframe
10126
- * @returns {string} iframe url
10127
- */
10128
- getIFrameSrc(): string;
10129
- /**
10130
- * Render the embedded ThoughtSpot Sage
10131
- * @returns {SageEmbed} Eureka/Sage embed
10132
- */
10133
- render(): Promise<SageEmbed>;
10134
- }
10135
- interface SearchOptions$2 {
10136
9960
  /**
10137
9961
  * The query string to pass to start the Conversation.
10138
9962
  */
@@ -10249,7 +10073,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
10249
10073
  /**
10250
10074
  * Ability to pass a starting search query to the conversation.
10251
10075
  */
10252
- searchOptions?: SearchOptions$2;
10076
+ searchOptions?: SearchOptions$1;
10253
10077
  /**
10254
10078
  * disableSourceSelection : Disables data source selection
10255
10079
  * but still display the selected data source.
@@ -10287,7 +10111,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
10287
10111
  * @default true
10288
10112
  * @example
10289
10113
  * ```js
10290
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
10114
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
10291
10115
  * const embed = new <EmbedComponent>('#tsEmbed', {
10292
10116
  * ... // other embed view config
10293
10117
  * dataPanelV2: true,
@@ -10405,6 +10229,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
10405
10229
  * ```
10406
10230
  */
10407
10231
  updatedSpotterChatPrompt?: boolean;
10232
+ /**
10233
+ * Enables the stop answer generation button in the Spotter embed UI,
10234
+ * allowing users to interrupt an ongoing answer generation.
10235
+ *
10236
+ * Supported embed types: `SpotterEmbed`
10237
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
10238
+ * @default false
10239
+ */
10240
+ enableStopAnswerGenerationEmbed?: boolean;
10408
10241
  /**
10409
10242
  * Controls the visibility of the past conversations sidebar.
10410
10243
  *
@@ -11188,6 +11021,15 @@ export interface AppViewConfig extends AllEmbedViewConfig {
11188
11021
  * ```
11189
11022
  */
11190
11023
  spotterChatConfig?: SpotterChatViewConfig;
11024
+ /**
11025
+ * Enables the stop answer generation button in the Spotter embed UI,
11026
+ * allowing users to interrupt an ongoing answer generation.
11027
+ *
11028
+ * Supported embed types: `AppEmbed`
11029
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11030
+ * @default false
11031
+ */
11032
+ enableStopAnswerGenerationEmbed?: boolean;
11191
11033
  /**
11192
11034
  * This is the minimum height (in pixels) for a full-height App.
11193
11035
  * Setting this height helps resolve issues with empty Apps and
@@ -11785,6 +11627,15 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
11785
11627
  * ```
11786
11628
  */
11787
11629
  updatedSpotterChatPrompt?: boolean;
11630
+ /**
11631
+ * Enables the stop answer generation button in the Spotter embed UI,
11632
+ * allowing users to interrupt an ongoing answer generation.
11633
+ *
11634
+ * Supported embed types: `LiveboardEmbed`
11635
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11636
+ * @default false
11637
+ */
11638
+ enableStopAnswerGenerationEmbed?: boolean;
11788
11639
  /**
11789
11640
  * Configuration for customizing Spotter chat UI
11790
11641
  * branding in tool response cards.
@@ -12217,40 +12068,6 @@ declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbed
12217
12068
  * ```
12218
12069
  */
12219
12070
  export declare const PreRenderedSearchBarEmbed: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & PreRenderProps & React$1.RefAttributes<SearchBarEmbed>>;
12220
- export interface SageEmbedProps extends EmbedProps, SageViewConfig {
12221
- }
12222
- /**
12223
- * React component for LLM based search Sage embed.
12224
- * @example
12225
- * ```tsx
12226
- * function Sage() {
12227
- * return <SageEmbed
12228
- * showObjectResults={true}
12229
- * ... other view config props or event listeners.
12230
- * />
12231
- * }
12232
- * ```
12233
- */
12234
- declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
12235
- /**
12236
- * React component for PreRendered Sage embed.
12237
- *
12238
- * PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
12239
- * default.
12240
- *
12241
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
12242
- * @example
12243
- * ```tsx
12244
- * function LandingPageComponent() {
12245
- * return <PreRenderedSageEmbed preRenderId="someId" showObjectResults={true} />
12246
- * }
12247
- * ```
12248
- * function MyComponent() {
12249
- * return <SageEmbed preRenderId="someId" showObjectResults={true} />
12250
- * }
12251
- * ```
12252
- */
12253
- export declare const PreRenderedSageEmbed: React$1.ForwardRefExoticComponent<SageEmbedProps & PreRenderProps & React$1.RefAttributes<SageEmbed>>;
12254
12071
  export interface SpotterEmbedProps extends EmbedProps, SpotterEmbedViewConfig {
12255
12072
  }
12256
12073
  export interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
@@ -12344,7 +12161,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
12344
12161
  * ```
12345
12162
  */
12346
12163
  export declare const PreRenderedConversationEmbed: React$1.ForwardRefExoticComponent<SpotterEmbedProps & PreRenderProps & React$1.RefAttributes<SpotterEmbed>>;
12347
- export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof LiveboardEmbed$1 | typeof SearchBarEmbed$1 | typeof SageEmbed$1 | typeof ConversationMessage$1 | typeof SpotterMessage | typeof SpotterEmbed$1 | typeof ConversationEmbed$1;
12164
+ export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof LiveboardEmbed$1 | typeof SearchBarEmbed$1 | typeof ConversationMessage$1 | typeof SpotterMessage | typeof SpotterEmbed$1 | typeof ConversationEmbed$1;
12348
12165
  /**
12349
12166
  * Get a reference to the embed component to trigger events on the component.
12350
12167
  * @example
@@ -12426,7 +12243,6 @@ export {
12426
12243
  ConversationEmbed$1 as ConversationEmbed,
12427
12244
  DataPanelCustomColumnGroupsAccordionState$1 as DataPanelCustomColumnGroupsAccordionState,
12428
12245
  LiveboardEmbed$1 as LiveboardEmbed,
12429
- SageEmbed$1 as SageEmbed,
12430
12246
  SearchBarEmbed$1 as SearchBarEmbed,
12431
12247
  SearchEmbed$1 as SearchEmbed,
12432
12248
  SpotterEmbed$1 as SpotterEmbed,