@thoughtspot/visual-embed-sdk 1.46.5-beta.1 → 1.47.0

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 (242) hide show
  1. package/cjs/package.json +4 -4
  2. package/cjs/src/css-variables.d.ts +36 -0
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +41 -17
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +26 -47
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +36 -79
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/conversation.d.ts +24 -2
  11. package/cjs/src/embed/conversation.d.ts.map +1 -1
  12. package/cjs/src/embed/conversation.js +18 -33
  13. package/cjs/src/embed/conversation.js.map +1 -1
  14. package/cjs/src/embed/conversation.spec.js +129 -97
  15. package/cjs/src/embed/conversation.spec.js.map +1 -1
  16. package/cjs/src/embed/hostEventClient/contracts.d.ts +31 -0
  17. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  18. package/cjs/src/embed/hostEventClient/contracts.js +2 -0
  19. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  20. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +18 -0
  21. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  22. package/cjs/src/embed/hostEventClient/host-event-client.js +69 -9
  23. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  24. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +185 -19
  25. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  26. package/cjs/src/embed/hostEventClient/utils.d.ts +22 -0
  27. package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -0
  28. package/cjs/src/embed/hostEventClient/utils.js +57 -0
  29. package/cjs/src/embed/hostEventClient/utils.js.map +1 -0
  30. package/cjs/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  31. package/cjs/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  32. package/cjs/src/embed/hostEventClient/utils.spec.js +190 -0
  33. package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -0
  34. package/cjs/src/embed/liveboard.d.ts +18 -1
  35. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  36. package/cjs/src/embed/liveboard.js +9 -11
  37. package/cjs/src/embed/liveboard.js.map +1 -1
  38. package/cjs/src/embed/liveboard.spec.js +29 -71
  39. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  40. package/cjs/src/embed/spotter-utils.d.ts +20 -0
  41. package/cjs/src/embed/spotter-utils.d.ts.map +1 -0
  42. package/cjs/src/embed/spotter-utils.js +52 -0
  43. package/cjs/src/embed/spotter-utils.js.map +1 -0
  44. package/cjs/src/embed/spotter-utils.spec.d.ts +2 -0
  45. package/cjs/src/embed/spotter-utils.spec.d.ts.map +1 -0
  46. package/cjs/src/embed/spotter-utils.spec.js +54 -0
  47. package/cjs/src/embed/spotter-utils.spec.js.map +1 -0
  48. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  49. package/cjs/src/embed/ts-embed.js +25 -5
  50. package/cjs/src/embed/ts-embed.js.map +1 -1
  51. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  52. package/cjs/src/embed/ts-embed.spec.js +28 -67
  53. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  54. package/cjs/src/errors.d.ts +2 -1
  55. package/cjs/src/errors.d.ts.map +1 -1
  56. package/cjs/src/errors.js +2 -1
  57. package/cjs/src/errors.js.map +1 -1
  58. package/cjs/src/index.d.ts +1 -2
  59. package/cjs/src/index.d.ts.map +1 -1
  60. package/cjs/src/index.js +2 -4
  61. package/cjs/src/index.js.map +1 -1
  62. package/cjs/src/react/all-types-export.d.ts +2 -2
  63. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  64. package/cjs/src/react/all-types-export.js +1 -3
  65. package/cjs/src/react/all-types-export.js.map +1 -1
  66. package/cjs/src/react/index.d.ts +1 -36
  67. package/cjs/src/react/index.d.ts.map +1 -1
  68. package/cjs/src/react/index.js +1 -34
  69. package/cjs/src/react/index.js.map +1 -1
  70. package/cjs/src/types.d.ts +143 -76
  71. package/cjs/src/types.d.ts.map +1 -1
  72. package/cjs/src/types.js +118 -47
  73. package/cjs/src/types.js.map +1 -1
  74. package/cjs/src/utils.d.ts +0 -9
  75. package/cjs/src/utils.d.ts.map +1 -1
  76. package/cjs/src/utils.js +1 -10
  77. package/cjs/src/utils.js.map +1 -1
  78. package/dist/{index-DW2wEHqy.js → index-Bm2Hck8q.js} +1 -1
  79. package/dist/src/css-variables.d.ts +36 -0
  80. package/dist/src/css-variables.d.ts.map +1 -1
  81. package/dist/src/embed/app.d.ts +41 -17
  82. package/dist/src/embed/app.d.ts.map +1 -1
  83. package/dist/src/embed/conversation.d.ts +24 -2
  84. package/dist/src/embed/conversation.d.ts.map +1 -1
  85. package/dist/src/embed/hostEventClient/contracts.d.ts +31 -0
  86. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  87. package/dist/src/embed/hostEventClient/host-event-client.d.ts +18 -0
  88. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  89. package/dist/src/embed/hostEventClient/utils.d.ts +22 -0
  90. package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -0
  91. package/dist/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  92. package/dist/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  93. package/dist/src/embed/liveboard.d.ts +18 -1
  94. package/dist/src/embed/liveboard.d.ts.map +1 -1
  95. package/dist/src/embed/spotter-utils.d.ts +20 -0
  96. package/dist/src/embed/spotter-utils.d.ts.map +1 -0
  97. package/dist/src/embed/spotter-utils.spec.d.ts +2 -0
  98. package/dist/src/embed/spotter-utils.spec.d.ts.map +1 -0
  99. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  100. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  101. package/dist/src/errors.d.ts +2 -1
  102. package/dist/src/errors.d.ts.map +1 -1
  103. package/dist/src/index.d.ts +1 -2
  104. package/dist/src/index.d.ts.map +1 -1
  105. package/dist/src/react/all-types-export.d.ts +2 -2
  106. package/dist/src/react/all-types-export.d.ts.map +1 -1
  107. package/dist/src/react/index.d.ts +1 -36
  108. package/dist/src/react/index.d.ts.map +1 -1
  109. package/dist/src/types.d.ts +143 -76
  110. package/dist/src/types.d.ts.map +1 -1
  111. package/dist/src/utils.d.ts +0 -9
  112. package/dist/src/utils.d.ts.map +1 -1
  113. package/dist/tsembed-react.es.js +378 -304
  114. package/dist/tsembed-react.js +366 -294
  115. package/dist/tsembed.es.js +393 -285
  116. package/dist/tsembed.js +30798 -30691
  117. package/dist/visual-embed-sdk-react-full.d.ts +310 -273
  118. package/dist/visual-embed-sdk-react.d.ts +310 -273
  119. package/dist/visual-embed-sdk.d.ts +308 -243
  120. package/lib/package.json +4 -4
  121. package/lib/src/css-variables.d.ts +36 -0
  122. package/lib/src/css-variables.d.ts.map +1 -1
  123. package/lib/src/embed/app.d.ts +41 -17
  124. package/lib/src/embed/app.d.ts.map +1 -1
  125. package/lib/src/embed/app.js +28 -49
  126. package/lib/src/embed/app.js.map +1 -1
  127. package/lib/src/embed/app.spec.js +36 -79
  128. package/lib/src/embed/app.spec.js.map +1 -1
  129. package/lib/src/embed/conversation.d.ts +24 -2
  130. package/lib/src/embed/conversation.d.ts.map +1 -1
  131. package/lib/src/embed/conversation.js +19 -34
  132. package/lib/src/embed/conversation.js.map +1 -1
  133. package/lib/src/embed/conversation.spec.js +131 -99
  134. package/lib/src/embed/conversation.spec.js.map +1 -1
  135. package/lib/src/embed/hostEventClient/contracts.d.ts +31 -0
  136. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  137. package/lib/src/embed/hostEventClient/contracts.js +2 -0
  138. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  139. package/lib/src/embed/hostEventClient/host-event-client.d.ts +18 -0
  140. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  141. package/lib/src/embed/hostEventClient/host-event-client.js +69 -9
  142. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  143. package/lib/src/embed/hostEventClient/host-event-client.spec.js +185 -19
  144. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  145. package/lib/src/embed/hostEventClient/utils.d.ts +22 -0
  146. package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -0
  147. package/lib/src/embed/hostEventClient/utils.js +49 -0
  148. package/lib/src/embed/hostEventClient/utils.js.map +1 -0
  149. package/lib/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  150. package/lib/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  151. package/lib/src/embed/hostEventClient/utils.spec.js +188 -0
  152. package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -0
  153. package/lib/src/embed/liveboard.d.ts +18 -1
  154. package/lib/src/embed/liveboard.d.ts.map +1 -1
  155. package/lib/src/embed/liveboard.js +9 -11
  156. package/lib/src/embed/liveboard.js.map +1 -1
  157. package/lib/src/embed/liveboard.spec.js +29 -71
  158. package/lib/src/embed/liveboard.spec.js.map +1 -1
  159. package/lib/src/embed/spotter-utils.d.ts +20 -0
  160. package/lib/src/embed/spotter-utils.d.ts.map +1 -0
  161. package/lib/src/embed/spotter-utils.js +47 -0
  162. package/lib/src/embed/spotter-utils.js.map +1 -0
  163. package/lib/src/embed/spotter-utils.spec.d.ts +2 -0
  164. package/lib/src/embed/spotter-utils.spec.d.ts.map +1 -0
  165. package/lib/src/embed/spotter-utils.spec.js +52 -0
  166. package/lib/src/embed/spotter-utils.spec.js.map +1 -0
  167. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  168. package/lib/src/embed/ts-embed.js +25 -5
  169. package/lib/src/embed/ts-embed.js.map +1 -1
  170. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  171. package/lib/src/embed/ts-embed.spec.js +30 -69
  172. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  173. package/lib/src/errors.d.ts +2 -1
  174. package/lib/src/errors.d.ts.map +1 -1
  175. package/lib/src/errors.js +2 -1
  176. package/lib/src/errors.js.map +1 -1
  177. package/lib/src/index.d.ts +1 -2
  178. package/lib/src/index.d.ts.map +1 -1
  179. package/lib/src/index.js +1 -2
  180. package/lib/src/index.js.map +1 -1
  181. package/lib/src/react/all-types-export.d.ts +2 -2
  182. package/lib/src/react/all-types-export.d.ts.map +1 -1
  183. package/lib/src/react/all-types-export.js +1 -1
  184. package/lib/src/react/all-types-export.js.map +1 -1
  185. package/lib/src/react/index.d.ts +1 -36
  186. package/lib/src/react/index.d.ts.map +1 -1
  187. package/lib/src/react/index.js +0 -33
  188. package/lib/src/react/index.js.map +1 -1
  189. package/lib/src/types.d.ts +143 -76
  190. package/lib/src/types.d.ts.map +1 -1
  191. package/lib/src/types.js +118 -47
  192. package/lib/src/types.js.map +1 -1
  193. package/lib/src/utils.d.ts +0 -9
  194. package/lib/src/utils.d.ts.map +1 -1
  195. package/lib/src/utils.js +0 -8
  196. package/lib/src/utils.js.map +1 -1
  197. package/lib/src/visual-embed-sdk.d.ts +308 -243
  198. package/package.json +4 -4
  199. package/src/css-variables.ts +45 -0
  200. package/src/embed/app.spec.ts +51 -107
  201. package/src/embed/app.ts +60 -82
  202. package/src/embed/conversation.spec.ts +150 -119
  203. package/src/embed/conversation.ts +34 -58
  204. package/src/embed/hostEventClient/contracts.ts +31 -0
  205. package/src/embed/hostEventClient/host-event-client.spec.ts +260 -19
  206. package/src/embed/hostEventClient/host-event-client.ts +87 -11
  207. package/src/embed/hostEventClient/utils.spec.ts +225 -0
  208. package/src/embed/hostEventClient/utils.ts +74 -0
  209. package/src/embed/liveboard.spec.ts +38 -93
  210. package/src/embed/liveboard.ts +28 -10
  211. package/src/embed/spotter-utils.spec.ts +56 -0
  212. package/src/embed/spotter-utils.ts +65 -0
  213. package/src/embed/ts-embed.spec.ts +56 -108
  214. package/src/embed/ts-embed.ts +25 -4
  215. package/src/errors.ts +2 -1
  216. package/src/index.ts +2 -5
  217. package/src/react/all-types-export.ts +0 -3
  218. package/src/react/index.tsx +15 -59
  219. package/src/types.ts +206 -138
  220. package/src/utils.ts +0 -14
  221. package/cjs/src/embed/sage.d.ts +0 -164
  222. package/cjs/src/embed/sage.d.ts.map +0 -1
  223. package/cjs/src/embed/sage.js +0 -88
  224. package/cjs/src/embed/sage.js.map +0 -1
  225. package/cjs/src/embed/sage.spec.d.ts +0 -2
  226. package/cjs/src/embed/sage.spec.d.ts.map +0 -1
  227. package/cjs/src/embed/sage.spec.js +0 -151
  228. package/cjs/src/embed/sage.spec.js.map +0 -1
  229. package/dist/src/embed/sage.d.ts +0 -164
  230. package/dist/src/embed/sage.d.ts.map +0 -1
  231. package/dist/src/embed/sage.spec.d.ts +0 -2
  232. package/dist/src/embed/sage.spec.d.ts.map +0 -1
  233. package/lib/src/embed/sage.d.ts +0 -164
  234. package/lib/src/embed/sage.d.ts.map +0 -1
  235. package/lib/src/embed/sage.js +0 -84
  236. package/lib/src/embed/sage.js.map +0 -1
  237. package/lib/src/embed/sage.spec.d.ts +0 -2
  238. package/lib/src/embed/sage.spec.d.ts.map +0 -1
  239. package/lib/src/embed/sage.spec.js +0 -148
  240. package/lib/src/embed/sage.spec.js.map +0 -1
  241. package/src/embed/sage.spec.ts +0 -206
  242. package/src/embed/sage.ts +0 -231
@@ -785,6 +785,42 @@ export interface CustomCssVariables {
785
785
  * Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar.
786
786
  */
787
787
  "--ts-var-saved-chats-section-title-color"?: string;
788
+ /**
789
+ * Text color of the styling panel in the Liveboard.
790
+ */
791
+ "--ts-var-liveboard-styling-panel-text-color"?: string;
792
+ /**
793
+ * Border color of the styling panel in the Liveboard.
794
+ */
795
+ "--ts-var-liveboard-styling-panel-border-color"?: string;
796
+ /**
797
+ * Background color of the styling button in the Liveboard.
798
+ */
799
+ "--ts-var-liveboard-styling-button-background"?: string;
800
+ /**
801
+ * Text color of the styling button in the Liveboard.
802
+ */
803
+ "--ts-var-liveboard-styling-button-text-color"?: string;
804
+ /**
805
+ * Background color of the styling button in the Liveboard on hover.
806
+ */
807
+ "--ts-var-liveboard-styling-button-hover-background"?: string;
808
+ /**
809
+ * Background color of the styling button in the Liveboard when active.
810
+ */
811
+ "--ts-var-liveboard-styling-button-active-background"?: string;
812
+ /**
813
+ * Text color of the styling button in the Liveboard on hover.
814
+ */
815
+ "--ts-var-liveboard-styling-button-hover-text-color"?: string;
816
+ /**
817
+ * Box shadow of the styling button in the Liveboard.
818
+ */
819
+ "--ts-var-liveboard-styling-button-shadow"?: string;
820
+ /**
821
+ * Background color of the color palette in the Liveboard styling panel.
822
+ */
823
+ "--ts-var-liveboard-styling-color-palette-background"?: string;
788
824
  }
789
825
  export interface SessionInterface {
790
826
  sessionId: string;
@@ -1402,11 +1438,6 @@ export interface EmbedConfig {
1402
1438
  * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
1403
1439
  */
1404
1440
  suppressSearchEmbedBetaWarning?: boolean;
1405
- /**
1406
- * Hide `beta` alert warning message for SageEmbed.
1407
- *
1408
- */
1409
- suppressSageEmbedBetaWarning?: boolean;
1410
1441
  /**
1411
1442
  * Custom style params for embed Config.
1412
1443
  * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
@@ -1488,6 +1519,7 @@ export interface EmbedConfig {
1488
1519
  /**
1489
1520
  * Disables the Mixpanel tracking from the SDK.
1490
1521
  * @version SDK: 1.27.9
1522
+ * @hidden
1491
1523
  */
1492
1524
  disableSDKTracking?: boolean;
1493
1525
  /**
@@ -1790,7 +1822,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1790
1822
  * The width and height dimensions to render an embedded
1791
1823
  * object inside your app. Specify the values in pixels or percentage.
1792
1824
  *
1793
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1825
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1794
1826
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
1795
1827
  * @example
1796
1828
  * ```js
@@ -1819,7 +1851,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1819
1851
  * for the user.
1820
1852
  * Use this to disable actions.
1821
1853
  *
1822
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1854
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1823
1855
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1824
1856
  * @example
1825
1857
  * ```js
@@ -1834,7 +1866,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1834
1866
  /**
1835
1867
  * The tooltip to display for disabled actions.
1836
1868
  *
1837
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1869
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1838
1870
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1839
1871
  * @example
1840
1872
  * ```js
@@ -1852,7 +1884,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1852
1884
  * These actions will be hidden from the user.
1853
1885
  * Use this to hide an action.
1854
1886
  *
1855
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1887
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1856
1888
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1857
1889
  * @example
1858
1890
  * ```js
@@ -1873,7 +1905,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1873
1905
  *
1874
1906
  * Use either this or hiddenActions.
1875
1907
  *
1876
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1908
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1877
1909
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1878
1910
  * @important
1879
1911
  * @example
@@ -1889,7 +1921,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1889
1921
  /**
1890
1922
  * The locale settings to apply to the embedded view.
1891
1923
  *
1892
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1924
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1893
1925
  * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1894
1926
  * @example
1895
1927
  * ```js
@@ -1910,7 +1942,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1910
1942
  * to control embed behavior in non-regular ways. We do not publish the
1911
1943
  * list of supported keys and values associated with each.
1912
1944
  *
1913
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1945
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1914
1946
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1915
1947
  * @example
1916
1948
  * ```js
@@ -1938,7 +1970,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1938
1970
  * Insert as a sibling of the target container, instead of appending to a
1939
1971
  * child inside it.
1940
1972
  *
1941
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1973
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1942
1974
  * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
1943
1975
  * @example
1944
1976
  * ```js
@@ -1964,7 +1996,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1964
1996
  * Use PreRender to render the embed in the background and then
1965
1997
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
1966
1998
  *
1967
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1999
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1968
2000
  * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1969
2001
  * @example
1970
2002
  * ```js
@@ -2001,7 +2033,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2001
2033
  * Enable the V2 shell. This can provide performance benefits
2002
2034
  * due to a lighter-weight shell.
2003
2035
  *
2004
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2036
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2005
2037
  * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
2006
2038
  * @example
2007
2039
  * ```js
@@ -2028,7 +2060,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2028
2060
  * This flag can be used to disable links inside the embedded app,
2029
2061
  * and disable redirection of links in a new tab.
2030
2062
  *
2031
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2063
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2032
2064
  * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
2033
2065
  * @example
2034
2066
  * ```js
@@ -2047,7 +2079,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2047
2079
  * The `overrideOrgId` setting is honoured only if the
2048
2080
  * Per Org URL feature is enabled on your ThoughtSpot instance.
2049
2081
  *
2050
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2082
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2051
2083
  * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
2052
2084
  * @example
2053
2085
  * ```js
@@ -2067,7 +2099,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2067
2099
  * {@link enableLinkOverridesV2} instead.
2068
2100
  *
2069
2101
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2070
- * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2102
+ * `SearchEmbed`, `SpotterAgentEmbed`,
2071
2103
  * `SpotterEmbed`, `SearchBarEmbed`
2072
2104
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2073
2105
  * @example
@@ -2091,7 +2123,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2091
2123
  * older ThoughtSpot versions.
2092
2124
  *
2093
2125
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2094
- * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2126
+ * `SearchEmbed`, `SpotterAgentEmbed`,
2095
2127
  * `SpotterEmbed`, `SearchBarEmbed`
2096
2128
  * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
2097
2129
  * @example
@@ -2150,7 +2182,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2150
2182
  * external app, calling an API, or opening a modal — based on the data context of
2151
2183
  * what they clicked can be used to trigger custom logic when the action is clicked.
2152
2184
  *
2153
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed`
2185
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterEmbed`
2154
2186
  * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
2155
2187
  * @example
2156
2188
  * ```ts
@@ -2502,11 +2534,11 @@ export interface SearchLiveboardCommonViewConfig {
2502
2534
  /**
2503
2535
  * flag to set ContextMenu Trigger to either left or right click.
2504
2536
  *
2505
- * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
2537
+ * Supported embed types: `AppEmbed`, `SearchEmbed`
2506
2538
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2507
2539
  * @example
2508
2540
  * ```js
2509
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
2541
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchEmbed
2510
2542
  * const embed = new <EmbedComponent>('#tsEmbed', {
2511
2543
  * ... // other embed view config
2512
2544
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
@@ -2543,12 +2575,12 @@ export interface SearchLiveboardCommonViewConfig {
2543
2575
  /**
2544
2576
  * To set the initial state of the search bar in case of saved Answers.
2545
2577
  *
2546
- * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`
2578
+ * Supported embed types: `AppEmbed`, `SearchBarEmbed`
2547
2579
  * @default true
2548
2580
  * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
2549
2581
  * @example
2550
2582
  * ```js
2551
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
2583
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
2552
2584
  * const embed = new <EmbedComponent>('#tsEmbed', {
2553
2585
  * ... // other embed view config
2554
2586
  * collapseSearchBar: true,
@@ -2559,12 +2591,12 @@ export interface SearchLiveboardCommonViewConfig {
2559
2591
  /**
2560
2592
  * Flag to control Data panel experience
2561
2593
  *
2562
- * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2594
+ * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2563
2595
  * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
2564
2596
  * @default true
2565
2597
  * @example
2566
2598
  * ```js
2567
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
2599
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
2568
2600
  * const embed = new <EmbedComponent>('#tsEmbed', {
2569
2601
  * ... // other embed view config
2570
2602
  * dataPanelV2: true,
@@ -2575,12 +2607,12 @@ export interface SearchLiveboardCommonViewConfig {
2575
2607
  /**
2576
2608
  * To enable custom column groups in data panel v2
2577
2609
  *
2578
- * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2610
+ * Supported embed types: `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2579
2611
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
2580
2612
  * @default false
2581
2613
  * @example
2582
2614
  * ```js
2583
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed
2615
+ * // Replace <EmbedComponent> with embed component name. For example, SearchBarEmbed, or LiveboardEmbed
2584
2616
  * const embed = new <EmbedComponent>('#tsEmbed', {
2585
2617
  * ... // other embed view config
2586
2618
  * enableCustomColumnGroups: true,
@@ -3560,6 +3592,17 @@ export declare enum EmbedEvent {
3560
3592
  * ```
3561
3593
  */
3562
3594
  DownloadAsXlsx = "downloadAsXlsx",
3595
+ /**
3596
+ * Emitted when the Download Liveboard as Continuous PDF action is triggered
3597
+ * on a Liveboard.
3598
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3599
+ * @example
3600
+ * ```js
3601
+ * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
3602
+ * console.log('download liveboard as continuous PDF', payload)})
3603
+ * ```
3604
+ */
3605
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
3563
3606
  /**
3564
3607
  * Emitted when an Answer is deleted in the app
3565
3608
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
@@ -3937,19 +3980,6 @@ export declare enum EmbedEvent {
3937
3980
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3938
3981
  */
3939
3982
  FilterChanged = "filterChanged",
3940
- /**
3941
- * Emitted when a user clicks the **Go** button to initiate
3942
- * a Natural Language Search query
3943
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3944
- */
3945
- SageEmbedQuery = "sageEmbedQuery",
3946
- /**
3947
- * Emitted when a user selects a data source on the embedded
3948
- * Natural Language Search interface.
3949
- *
3950
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3951
- */
3952
- SageWorksheetUpdated = "sageWorksheetUpdated",
3953
3983
  /**
3954
3984
  * Emitted when a user updates a connection on the **Data** page
3955
3985
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
@@ -5087,6 +5117,18 @@ export declare enum HostEvent {
5087
5117
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5088
5118
  */
5089
5119
  DownloadAsPdf = "downloadAsPdf",
5120
+ /**
5121
+ * Trigger the **Download Liveboard as Continuous PDF** action on an
5122
+ * embedded Liveboard.
5123
+ *
5124
+ * @example
5125
+ * ```js
5126
+ * liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
5127
+ * ```
5128
+ *
5129
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5130
+ */
5131
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
5090
5132
  /**
5091
5133
  * Trigger the **AI Highlights** action on an embedded Liveboard
5092
5134
  *
@@ -5313,6 +5355,20 @@ export declare enum HostEvent {
5313
5355
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5314
5356
  * }, ContextType.Liveboard);
5315
5357
  * ```
5358
+ * @example
5359
+ * ```js
5360
+ * // Copy link from liveboard context
5361
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5362
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
5363
+ * ```
5364
+ * @example
5365
+ * ```js
5366
+ * // Copy link from liveboard visualization context
5367
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5368
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
5369
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5370
+ * }, ContextType.Liveboard);
5371
+ * ```
5316
5372
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5317
5373
  */
5318
5374
  CopyLink = "embedDocument",
@@ -5344,6 +5400,20 @@ export declare enum HostEvent {
5344
5400
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5345
5401
  * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5346
5402
  * ```
5403
+ * @example
5404
+ * ```js
5405
+ * // Present from liveboard visualization context
5406
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5407
+ * liveboardEmbed.trigger(HostEvent.Present, {
5408
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5409
+ * }, ContextType.Liveboard);
5410
+ * ```
5411
+ * @example
5412
+ * ```js
5413
+ * // Present from liveboard context
5414
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5415
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
5416
+ * ```
5347
5417
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5348
5418
  */
5349
5419
  Present = "present",
@@ -5372,7 +5442,7 @@ export declare enum HostEvent {
5372
5442
  * tml.answer.search_query // TML representation of the search query
5373
5443
  * );
5374
5444
  * })
5375
- * ```
5445
+ * ```
5376
5446
  * @example
5377
5447
  * ```js
5378
5448
  * // Get TML from search context
@@ -5995,21 +6065,6 @@ export declare enum HostEvent {
5995
6065
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5996
6066
  */
5997
6067
  SetHiddenTabs = "SetPinboardHiddenTabs",
5998
- /**
5999
- * Updates the search query string for Natural Language Search operations.
6000
- * @param - Includes the following keys:
6001
- * - `queryString`: Text string in Natural Language format.
6002
- * - `executeSearch`: Boolean to execute search and update search query.
6003
- * @example
6004
- * ```js
6005
- * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
6006
- * queryString: 'revenue per year',
6007
- * executeSearch: true,
6008
- * })
6009
- * ```
6010
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
6011
- */
6012
- UpdateSageQuery = "updateSageQuery",
6013
6068
  /**
6014
6069
  * Get the Answer session for a Search or
6015
6070
  * Liveboard visualization.
@@ -6829,6 +6884,16 @@ export declare enum Action {
6829
6884
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
6830
6885
  */
6831
6886
  DownloadLiveboard = "downloadLiveboard",
6887
+ /**
6888
+ * The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
6889
+ * Allows downloading the entire Liveboard as a continuous PDF.
6890
+ * @example
6891
+ * ```js
6892
+ * disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
6893
+ * ```
6894
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6895
+ */
6896
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
6832
6897
  /**
6833
6898
  * @hidden
6834
6899
  */
@@ -7785,11 +7850,11 @@ export declare enum Action {
7785
7850
  */
7786
7851
  CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
7787
7852
  /**
7788
- * Action ID to hide or disable the Coaching workflow in Spotter conversations.
7789
- * When disabled, users cannot access **Add to Coaching** workflow in conversation.
7790
- * The **Add to Coaching** feature allows adding reference questions and
7791
- * business terms to improve Spotter’s responses. This feature is generally available
7792
- * (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.
7793
7858
  * @example
7794
7859
  * ```js
7795
7860
  * hiddenAction: [Action.InConversationTraining]
@@ -7866,17 +7931,17 @@ export declare enum Action {
7866
7931
  */
7867
7932
  LiveboardStylePanel = "liveboardStylePanel",
7868
7933
  /**
7869
- * The **Publish** action for Liveboards, Answers and Models.
7870
- * Opens the publishing modal. It's a parent action for the
7871
- * **Manage Publishing** and **Unpublish** actions if the object
7872
- * is already published, otherwise appears standalone.
7873
- * @example
7874
- * ```js
7875
- * hiddenActions: [Action.Publish]
7876
- * disabledActions: [Action.Publish]
7877
- * ```
7878
- * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
7879
- */
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
+ */
7880
7945
  Publish = "publish",
7881
7946
  /**
7882
7947
  * The **Manage Publishing** action for Liveboards, Answers and Models.
@@ -8044,6 +8109,39 @@ export declare enum Action {
8044
8109
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
8045
8110
  */
8046
8111
  SpotterDocs = "spotterDocs",
8112
+ /**
8113
+ * Controls visibility and disable state of the connector resources
8114
+ * section in the Spotter chat interface.
8115
+ * @example
8116
+ * ```js
8117
+ * hiddenActions: [Action.SpotterChatConnectorResources]
8118
+ * disabledActions: [Action.SpotterChatConnectorResources]
8119
+ * ```
8120
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8121
+ */
8122
+ SpotterChatConnectorResources = "spotterChatConnectorResources",
8123
+ /**
8124
+ * Controls visibility and disable state of the connectors
8125
+ * in the Spotter chat interface.
8126
+ * @example
8127
+ * ```js
8128
+ * hiddenActions: [Action.SpotterChatConnectors]
8129
+ * disabledActions: [Action.SpotterChatConnectors]
8130
+ * ```
8131
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8132
+ */
8133
+ SpotterChatConnectors = "spotterChatConnectors",
8134
+ /**
8135
+ * Controls visibility and disable state of the mode switcher
8136
+ * in the Spotter chat interface.
8137
+ * @example
8138
+ * ```js
8139
+ * hiddenActions: [Action.SpotterChatModeSwitcher]
8140
+ * disabledActions: [Action.SpotterChatModeSwitcher]
8141
+ * ```
8142
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8143
+ */
8144
+ SpotterChatModeSwitcher = "spotterChatModeSwitcher",
8047
8145
  /**
8048
8146
  * The **Include current period** checkbox for date filters.
8049
8147
  * Controls the visibility and availability of the option to include
@@ -8294,7 +8392,13 @@ declare enum EmbedErrorCodes {
8294
8392
  /** Failed to update embed parameters during pre-render */
8295
8393
  UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
8296
8394
  /** Invalid URL provided in configuration */
8297
- INVALID_URL = "INVALID_URL"
8395
+ INVALID_URL = "INVALID_URL",
8396
+ /** Host event payload validation failed */
8397
+ HOST_EVENT_VALIDATION = "HOST_EVENT_VALIDATION",
8398
+ /** UpdateFilters payload is invalid - missing or malformed filter/filters */
8399
+ UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
8400
+ /** DrillDown payload is invalid - missing or malformed points */
8401
+ DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
8298
8402
  }
8299
8403
  /**
8300
8404
  * Error event object emitted when an error occurs in an embedded component.
@@ -8683,6 +8787,8 @@ export declare enum UIPassthroughEvent {
8683
8787
  GetAnswerConfig = "getAnswerPageConfig",
8684
8788
  GetLiveboardConfig = "getPinboardPageConfig",
8685
8789
  GetUnsavedAnswerTML = "getUnsavedAnswerTML",
8790
+ UpdateFilters = "updateFilters",
8791
+ Drilldown = "drillDown",
8686
8792
  GetAnswerSession = "getAnswerSession",
8687
8793
  GetFilters = "getFilters",
8688
8794
  GetIframeUrl = "getIframeUrl",
@@ -8804,6 +8910,35 @@ export type UIPassthroughContractBase = {
8804
8910
  v2Content: string;
8805
8911
  };
8806
8912
  };
8913
+ [UIPassthroughEvent.UpdateFilters]: {
8914
+ request: {
8915
+ filter?: {
8916
+ column: string;
8917
+ oper: string;
8918
+ values: string[];
8919
+ type?: string;
8920
+ };
8921
+ filters?: {
8922
+ column: string;
8923
+ oper: string;
8924
+ values: string[];
8925
+ type?: string;
8926
+ }[];
8927
+ };
8928
+ response: unknown;
8929
+ };
8930
+ [UIPassthroughEvent.Drilldown]: {
8931
+ request: {
8932
+ points: {
8933
+ selectedPoints?: string[];
8934
+ clickedPoint?: string;
8935
+ };
8936
+ columnGuid?: string;
8937
+ autoDrillDown?: boolean;
8938
+ vizId?: string;
8939
+ };
8940
+ response: unknown;
8941
+ };
8807
8942
  };
8808
8943
  export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
8809
8944
  export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
@@ -8829,6 +8964,8 @@ export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT |
8829
8964
  export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
8830
8965
  declare class HostEventClient {
8831
8966
  iFrame: HTMLIFrameElement;
8967
+ /** Cached list of available UI passthrough keys from the embedded app */
8968
+ private availablePassthroughKeysCache;
8832
8969
  /** Host events with custom handlers
8833
8970
  * (setters or special logic) -
8834
8971
  * bound to instance for protected method access */
@@ -8854,9 +8991,25 @@ declare class HostEventClient {
8854
8991
  * @param {HTMLIFrameElement} iFrame - the iframe element to set
8855
8992
  */
8856
8993
  setIframeElement(iFrame: HTMLIFrameElement): void;
8994
+ /**
8995
+ * Fetches the list of available UI passthrough keys from the embedded app.
8996
+ * Result is cached for the session. Returns empty array on failure.
8997
+ */
8998
+ private getAvailableUIPassthroughKeys;
8857
8999
  triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
8858
9000
  protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
8859
9001
  protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
9002
+ protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
9003
+ protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
9004
+ /**
9005
+ * Dispatches a host event using the appropriate channel:
9006
+ * 1. If the embedded app supports UI passthrough for this event, use it (custom handler or getter).
9007
+ * 2. Otherwise fall back to the legacy host event channel.
9008
+ *
9009
+ * @param hostEvent - The host event to trigger
9010
+ * @param payload - Optional payload for the event
9011
+ * @param context - Optional context (e.g. vizId) for scoped operations
9012
+ */
8860
9013
  triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
8861
9014
  }
8862
9015
  declare class TsEmbed {
@@ -9804,150 +9957,6 @@ declare class SearchBarEmbed extends TsEmbed {
9804
9957
  protected getAppInitData(): Promise<SearchAppInitData$1>;
9805
9958
  }
9806
9959
  interface SearchOptions$1 {
9807
- /**
9808
- * The query string to pass for Natural Language Search.
9809
- */
9810
- searchQuery: string;
9811
- /**
9812
- * Boolean to define if the search should be executed or not.
9813
- * If it is executed, the focus is placed on the results.
9814
- * If it’s not executed, the focus is placed at the end of
9815
- * the token string in the search bar.
9816
- */
9817
- executeSearch?: boolean;
9818
- }
9819
- /**
9820
- * The configuration attributes for the embedded Natural language search view. Based on
9821
- * GPT and LLM.
9822
- * @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
9823
- *
9824
- * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
9825
- * @group Embed components
9826
- */
9827
- export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, "primaryAction" | "runtimeFilters" | "runtimeParameters" | "excludeRuntimeFiltersfromURL" | "excludeRuntimeParametersfromURL"> {
9828
- /**
9829
- * If set to true, a list of Liveboard and Answers related
9830
- * to the natural language search will be shown below the
9831
- * AI generated answer.
9832
- * @deprecated Currently Liveboard and Answers related
9833
- * to the natural language search will not be shown for sage
9834
- * embed
9835
- */
9836
- showObjectResults?: boolean;
9837
- /**
9838
- * flag used by the TS product tour page to show the blue search bar
9839
- * even after the search is completed. This is different from ThoughtSpot Embedded
9840
- * Sage Embed experience where it mimics closer to the non-embed case.
9841
- * The Sample questions container is collapsed when this value is set after
9842
- * does a search.
9843
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
9844
- * @hidden
9845
- */
9846
- isProductTour?: boolean;
9847
- /**
9848
- * Show or hide the search bar title.
9849
- * @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
9850
- * @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
9851
- */
9852
- hideSearchBarTitle?: boolean;
9853
- /**
9854
- * Show or hide the Answer header, that is, the `AI Answer` title
9855
- * at the top of the Answer page.
9856
- * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl
9857
- */
9858
- hideSageAnswerHeader?: boolean;
9859
- /**
9860
- * Disable the data source selection option.
9861
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
9862
- */
9863
- disableWorksheetChange?: boolean;
9864
- /**
9865
- * Hide the data source selection panel.
9866
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
9867
- */
9868
- hideWorksheetSelector?: boolean;
9869
- /**
9870
- * Show or hide autocomplete suggestions for the search query string.
9871
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
9872
- */
9873
- hideAutocompleteSuggestions?: boolean;
9874
- /**
9875
- * Show or hide autocomplete suggestions for the search query string.
9876
- * You can use {@link hideAutocompleteSuggestions} instead.
9877
- * @deprecated
9878
- * Currently, the object suggestions will not be shown for Natural Language Search.
9879
- */
9880
- showObjectSuggestions?: boolean;
9881
- /**
9882
- * Show or hide sample questions.
9883
- * The sample questions are autogenerated based on the data model
9884
- * selected for the search operation.
9885
- *
9886
- * Supported embed types: `SageEmbed`
9887
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
9888
- * @example
9889
- * ```js
9890
- * const embed = new SageEmbed('#tsEmbed', {
9891
- * ... //other embed view config
9892
- * hideSampleQuestions : true,
9893
- * })
9894
- * ```
9895
- */
9896
- hideSampleQuestions?: boolean;
9897
- /**
9898
- * The data source GUID (Model GUID) to set on load.
9899
- */
9900
- dataSource?: string;
9901
- /**
9902
- * Includes the following properties:
9903
- *
9904
- * `searchQuery`: The search query string to pass in the search bar.
9905
- * Supports Natural Language Search queries.
9906
- *
9907
- * `executeSearch`: Boolean to define if the search should be executed or not.
9908
- * If it is executed, the focus is placed on the results.
9909
- * If it’s not executed, the focus is placed at the end of
9910
- * the token string in the search bar.
9911
- *
9912
- * Supported embed types: `SageEmbed`
9913
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
9914
- * @example
9915
- * ```js
9916
- * searchOptions: {
9917
- * searchQuery: 'average sales by country and product type',
9918
- * executeSearch: true,
9919
- * }
9920
- * ```
9921
- */
9922
- searchOptions?: SearchOptions$1;
9923
- }
9924
- declare class SageEmbed extends V1Embed {
9925
- /**
9926
- * The view configuration for the embedded ThoughtSpot sage.
9927
- *
9928
- */
9929
- protected viewConfig: SageViewConfig;
9930
- constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
9931
- protected getEmbedParamsObject(): Record<any, any>;
9932
- /**
9933
- * Constructs a map of parameters to be passed on to the
9934
- * embedded Eureka or Sage search page.
9935
- * @returns {string} query string
9936
- */
9937
- protected getEmbedParams(): string;
9938
- /**
9939
- * Construct the URL of the embedded ThoughtSpot sage to be
9940
- * loaded in the iframe
9941
- * @returns {string} iframe url
9942
- */
9943
- getIFrameSrc(): string;
9944
- /**
9945
- * Render the embedded ThoughtSpot Sage
9946
- * @returns {SageEmbed} Eureka/Sage embed
9947
- */
9948
- render(): Promise<SageEmbed>;
9949
- }
9950
- interface SearchOptions$2 {
9951
9960
  /**
9952
9961
  * The query string to pass to start the Conversation.
9953
9962
  */
@@ -10064,7 +10073,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
10064
10073
  /**
10065
10074
  * Ability to pass a starting search query to the conversation.
10066
10075
  */
10067
- searchOptions?: SearchOptions$2;
10076
+ searchOptions?: SearchOptions$1;
10068
10077
  /**
10069
10078
  * disableSourceSelection : Disables data source selection
10070
10079
  * but still display the selected data source.
@@ -10102,7 +10111,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
10102
10111
  * @default true
10103
10112
  * @example
10104
10113
  * ```js
10105
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
10114
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
10106
10115
  * const embed = new <EmbedComponent>('#tsEmbed', {
10107
10116
  * ... // other embed view config
10108
10117
  * dataPanelV2: true,
@@ -10278,9 +10287,31 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
10278
10287
  */
10279
10288
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
10280
10289
  }
10290
+ /**
10291
+ * APP_INIT data shape for SpotterEmbed.
10292
+ * @internal
10293
+ */
10294
+ export interface SpotterAppInitData extends DefaultAppInitData {
10295
+ embedParams?: {
10296
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
10297
+ };
10298
+ }
10281
10299
  declare class SpotterEmbed extends TsEmbed {
10282
10300
  protected viewConfig: SpotterEmbedViewConfig;
10283
10301
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
10302
+ /**
10303
+ * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
10304
+ * so the conv-assist app can read sidebar configuration on initialisation.
10305
+ *
10306
+ * Precedence for `enablePastConversationsSidebar`:
10307
+ * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
10308
+ * deprecated top-level `enablePastConversationsSidebar` flag; if the former
10309
+ * is absent the latter is used as a fallback.
10310
+ *
10311
+ * An invalid `spotterDocumentationUrl` triggers a validation error and is
10312
+ * excluded from the payload rather than forwarded to the app.
10313
+ */
10314
+ protected getAppInitData(): Promise<SpotterAppInitData>;
10284
10315
  protected getEmbedParamsObject(): Record<any, any>;
10285
10316
  getIframeSrc(): string;
10286
10317
  render(): Promise<SpotterEmbed>;
@@ -10780,21 +10811,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10780
10811
  * @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
10781
10812
  */
10782
10813
  homePageSearchBarMode?: HomePageSearchBarMode;
10783
- /**
10784
- * This flag is used to enable unified search experience for full app embed.
10785
- *
10786
- * Supported embed types: `AppEmbed`
10787
- * @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
10788
- * @default true
10789
- * @example
10790
- * ```js
10791
- * const embed = new AppEmbed('#tsEmbed', {
10792
- * ... // other embed view config
10793
- * isUnifiedSearchExperienceEnabled: true,
10794
- * })
10795
- * ```
10796
- */
10797
- isUnifiedSearchExperienceEnabled?: boolean;
10798
10814
  /**
10799
10815
  * This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
10800
10816
  * @deprecated This flag is deprecated.
@@ -10829,6 +10845,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10829
10845
  * ```
10830
10846
  */
10831
10847
  isPNGInScheduledEmailsEnabled?: boolean;
10848
+ /**
10849
+ * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
10850
+ * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
10851
+ * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
10852
+ *
10853
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
10854
+ * @type {boolean}
10855
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
10856
+ * @example
10857
+ * ```js
10858
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
10859
+ * const embed = new <EmbedComponent>('#tsEmbed', {
10860
+ * ... // other embed view config
10861
+ * isContinuousLiveboardPDFEnabled: true,
10862
+ * })
10863
+ * ```
10864
+ */
10865
+ isContinuousLiveboardPDFEnabled?: boolean;
10832
10866
  /**
10833
10867
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
10834
10868
  *
@@ -10997,10 +11031,32 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10997
11031
  */
10998
11032
  enableHomepageAnnouncement?: boolean;
10999
11033
  }
11034
+ /**
11035
+ * APP_INIT data shape for AppEmbed.
11036
+ * @internal
11037
+ */
11038
+ export interface AppEmbedAppInitData extends DefaultAppInitData {
11039
+ embedParams?: {
11040
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
11041
+ };
11042
+ }
11000
11043
  declare class AppEmbed extends V1Embed {
11001
11044
  protected viewConfig: AppViewConfig;
11002
11045
  private defaultHeight;
11003
11046
  constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
11047
+ /**
11048
+ * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
11049
+ * so the conv-assist app can read sidebar configuration on initialisation.
11050
+ *
11051
+ * Precedence for `enablePastConversationsSidebar`:
11052
+ * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
11053
+ * deprecated top-level `enablePastConversationsSidebar` flag; if the former
11054
+ * is absent the latter is used as a fallback.
11055
+ *
11056
+ * An invalid `spotterDocumentationUrl` triggers a validation error and is
11057
+ * excluded from the payload rather than forwarded to the app.
11058
+ */
11059
+ protected getAppInitData(): Promise<AppEmbedAppInitData>;
11004
11060
  /**
11005
11061
  * Constructs a map of parameters to be passed on to the
11006
11062
  * embedded Liveboard or visualization.
@@ -11019,7 +11075,6 @@ declare class AppEmbed extends V1Embed {
11019
11075
  * @param pageId The ID of the page to be embedded.
11020
11076
  */
11021
11077
  getIFrameSrc(): string;
11022
- private HEIGHT_CHANAGE_THRESHOLD;
11023
11078
  /**
11024
11079
  * Set the iframe height as per the computed height received
11025
11080
  * from the ThoughtSpot app.
@@ -11419,6 +11474,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
11419
11474
  * ```
11420
11475
  */
11421
11476
  isPNGInScheduledEmailsEnabled?: boolean;
11477
+ /**
11478
+ * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
11479
+ * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
11480
+ * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
11481
+ *
11482
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
11483
+ * @type {boolean}
11484
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11485
+ * @example
11486
+ * ```js
11487
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
11488
+ * const embed = new <EmbedComponent>('#tsEmbed', {
11489
+ * ... // other embed view config
11490
+ * isContinuousLiveboardPDFEnabled: true,
11491
+ * })
11492
+ * ```
11493
+ */
11494
+ isContinuousLiveboardPDFEnabled?: boolean;
11422
11495
  /**
11423
11496
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
11424
11497
  *
@@ -11564,7 +11637,6 @@ declare class LiveboardEmbed extends V1Embed {
11564
11637
  * to be loaded within the iFrame.
11565
11638
  */
11566
11639
  private getIFrameSrc;
11567
- private HEIGHT_CHANAGE_THRESHOLD;
11568
11640
  /**
11569
11641
  * Set the iframe height as per the computed height received
11570
11642
  * from the ThoughtSpot app.
@@ -11954,40 +12026,6 @@ declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbed
11954
12026
  * ```
11955
12027
  */
11956
12028
  export declare const PreRenderedSearchBarEmbed: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & PreRenderProps & React$1.RefAttributes<SearchBarEmbed>>;
11957
- export interface SageEmbedProps extends EmbedProps, SageViewConfig {
11958
- }
11959
- /**
11960
- * React component for LLM based search Sage embed.
11961
- * @example
11962
- * ```tsx
11963
- * function Sage() {
11964
- * return <SageEmbed
11965
- * showObjectResults={true}
11966
- * ... other view config props or event listeners.
11967
- * />
11968
- * }
11969
- * ```
11970
- */
11971
- declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
11972
- /**
11973
- * React component for PreRendered Sage embed.
11974
- *
11975
- * PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
11976
- * default.
11977
- *
11978
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
11979
- * @example
11980
- * ```tsx
11981
- * function LandingPageComponent() {
11982
- * return <PreRenderedSageEmbed preRenderId="someId" showObjectResults={true} />
11983
- * }
11984
- * ```
11985
- * function MyComponent() {
11986
- * return <SageEmbed preRenderId="someId" showObjectResults={true} />
11987
- * }
11988
- * ```
11989
- */
11990
- export declare const PreRenderedSageEmbed: React$1.ForwardRefExoticComponent<SageEmbedProps & PreRenderProps & React$1.RefAttributes<SageEmbed>>;
11991
12029
  export interface SpotterEmbedProps extends EmbedProps, SpotterEmbedViewConfig {
11992
12030
  }
11993
12031
  export interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
@@ -12081,7 +12119,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
12081
12119
  * ```
12082
12120
  */
12083
12121
  export declare const PreRenderedConversationEmbed: React$1.ForwardRefExoticComponent<SpotterEmbedProps & PreRenderProps & React$1.RefAttributes<SpotterEmbed>>;
12084
- 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;
12122
+ 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;
12085
12123
  /**
12086
12124
  * Get a reference to the embed component to trigger events on the component.
12087
12125
  * @example
@@ -12163,7 +12201,6 @@ export {
12163
12201
  ConversationEmbed$1 as ConversationEmbed,
12164
12202
  DataPanelCustomColumnGroupsAccordionState$1 as DataPanelCustomColumnGroupsAccordionState,
12165
12203
  LiveboardEmbed$1 as LiveboardEmbed,
12166
- SageEmbed$1 as SageEmbed,
12167
12204
  SearchBarEmbed$1 as SearchBarEmbed,
12168
12205
  SearchEmbed$1 as SearchEmbed,
12169
12206
  SpotterEmbed$1 as SpotterEmbed,