@thoughtspot/visual-embed-sdk 1.41.0-pre-render-1 → 1.41.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 (259) hide show
  1. package/README.md +2 -4
  2. package/cjs/package.json +3 -3
  3. package/cjs/src/authToken.d.ts +1 -0
  4. package/cjs/src/authToken.d.ts.map +1 -1
  5. package/cjs/src/authToken.js +13 -3
  6. package/cjs/src/authToken.js.map +1 -1
  7. package/cjs/src/authToken.spec.js +29 -0
  8. package/cjs/src/authToken.spec.js.map +1 -1
  9. package/cjs/src/css-variables.d.ts +2 -1
  10. package/cjs/src/css-variables.d.ts.map +1 -1
  11. package/cjs/src/embed/app.d.ts +22 -1
  12. package/cjs/src/embed/app.d.ts.map +1 -1
  13. package/cjs/src/embed/app.js +22 -1
  14. package/cjs/src/embed/app.js.map +1 -1
  15. package/cjs/src/embed/app.spec.js +70 -3
  16. package/cjs/src/embed/app.spec.js.map +1 -1
  17. package/cjs/src/embed/bodyless-conversation.d.ts +0 -1
  18. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  19. package/cjs/src/embed/bodyless-conversation.js +3 -7
  20. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  21. package/cjs/src/embed/conversation.d.ts +2 -3
  22. package/cjs/src/embed/conversation.d.ts.map +1 -1
  23. package/cjs/src/embed/conversation.js +2 -7
  24. package/cjs/src/embed/conversation.js.map +1 -1
  25. package/cjs/src/embed/liveboard.d.ts +32 -1
  26. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  27. package/cjs/src/embed/liveboard.js +8 -25
  28. package/cjs/src/embed/liveboard.js.map +1 -1
  29. package/cjs/src/embed/liveboard.spec.js +96 -28
  30. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  31. package/cjs/src/embed/sage.d.ts +0 -1
  32. package/cjs/src/embed/sage.d.ts.map +1 -1
  33. package/cjs/src/embed/sage.js +6 -10
  34. package/cjs/src/embed/sage.js.map +1 -1
  35. package/cjs/src/embed/sage.spec.js +20 -10
  36. package/cjs/src/embed/sage.spec.js.map +1 -1
  37. package/cjs/src/embed/search-bar.d.ts +0 -1
  38. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  39. package/cjs/src/embed/search-bar.js +7 -11
  40. package/cjs/src/embed/search-bar.js.map +1 -1
  41. package/cjs/src/embed/search.d.ts +0 -1
  42. package/cjs/src/embed/search.d.ts.map +1 -1
  43. package/cjs/src/embed/search.js +8 -7
  44. package/cjs/src/embed/search.js.map +1 -1
  45. package/cjs/src/embed/search.spec.js +10 -10
  46. package/cjs/src/embed/search.spec.js.map +1 -1
  47. package/cjs/src/embed/ts-embed.d.ts +5 -7
  48. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  49. package/cjs/src/embed/ts-embed.js +25 -22
  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 +122 -0
  53. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  54. package/cjs/src/errors.d.ts +11 -0
  55. package/cjs/src/errors.d.ts.map +1 -1
  56. package/cjs/src/errors.js +12 -1
  57. package/cjs/src/errors.js.map +1 -1
  58. package/cjs/src/index.d.ts +2 -2
  59. package/cjs/src/index.d.ts.map +1 -1
  60. package/cjs/src/index.js +3 -1
  61. package/cjs/src/index.js.map +1 -1
  62. package/cjs/src/react/index.d.ts +1 -1
  63. package/cjs/src/react/index.d.ts.map +1 -1
  64. package/cjs/src/react/index.js +4 -2
  65. package/cjs/src/react/index.js.map +1 -1
  66. package/cjs/src/react/index.spec.js +1 -1
  67. package/cjs/src/react/index.spec.js.map +1 -1
  68. package/cjs/src/types.d.ts +163 -21
  69. package/cjs/src/types.d.ts.map +1 -1
  70. package/cjs/src/types.js +65 -22
  71. package/cjs/src/types.js.map +1 -1
  72. package/cjs/src/utils/custom-actions.d.ts +12 -0
  73. package/cjs/src/utils/custom-actions.d.ts.map +1 -0
  74. package/cjs/src/utils/custom-actions.js +180 -0
  75. package/cjs/src/utils/custom-actions.js.map +1 -0
  76. package/cjs/src/utils/custom-actions.spec.d.ts +2 -0
  77. package/cjs/src/utils/custom-actions.spec.d.ts.map +1 -0
  78. package/cjs/src/utils/custom-actions.spec.js +399 -0
  79. package/cjs/src/utils/custom-actions.spec.js.map +1 -0
  80. package/cjs/src/utils/processData.d.ts.map +1 -1
  81. package/cjs/src/utils/processData.js +10 -0
  82. package/cjs/src/utils/processData.js.map +1 -1
  83. package/cjs/src/utils/processData.spec.js +11 -0
  84. package/cjs/src/utils/processData.spec.js.map +1 -1
  85. package/cjs/src/utils.d.ts +21 -0
  86. package/cjs/src/utils.d.ts.map +1 -1
  87. package/cjs/src/utils.js +32 -1
  88. package/cjs/src/utils.js.map +1 -1
  89. package/cjs/src/utils.spec.js +38 -0
  90. package/cjs/src/utils.spec.js.map +1 -1
  91. package/dist/{index-CmEQfuE3.js → index-DQueHwfQ.js} +1 -1
  92. package/dist/src/authToken.d.ts +1 -0
  93. package/dist/src/authToken.d.ts.map +1 -1
  94. package/dist/src/css-variables.d.ts +2 -1
  95. package/dist/src/css-variables.d.ts.map +1 -1
  96. package/dist/src/embed/app.d.ts +22 -1
  97. package/dist/src/embed/app.d.ts.map +1 -1
  98. package/dist/src/embed/bodyless-conversation.d.ts +0 -1
  99. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  100. package/dist/src/embed/conversation.d.ts +2 -3
  101. package/dist/src/embed/conversation.d.ts.map +1 -1
  102. package/dist/src/embed/liveboard.d.ts +32 -1
  103. package/dist/src/embed/liveboard.d.ts.map +1 -1
  104. package/dist/src/embed/sage.d.ts +0 -1
  105. package/dist/src/embed/sage.d.ts.map +1 -1
  106. package/dist/src/embed/search-bar.d.ts +0 -1
  107. package/dist/src/embed/search-bar.d.ts.map +1 -1
  108. package/dist/src/embed/search.d.ts +0 -1
  109. package/dist/src/embed/search.d.ts.map +1 -1
  110. package/dist/src/embed/ts-embed.d.ts +5 -7
  111. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  112. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  113. package/dist/src/errors.d.ts +11 -0
  114. package/dist/src/errors.d.ts.map +1 -1
  115. package/dist/src/index.d.ts +2 -2
  116. package/dist/src/index.d.ts.map +1 -1
  117. package/dist/src/react/index.d.ts +1 -1
  118. package/dist/src/react/index.d.ts.map +1 -1
  119. package/dist/src/types.d.ts +163 -21
  120. package/dist/src/types.d.ts.map +1 -1
  121. package/dist/src/utils/custom-actions.d.ts +12 -0
  122. package/dist/src/utils/custom-actions.d.ts.map +1 -0
  123. package/dist/src/utils/custom-actions.spec.d.ts +2 -0
  124. package/dist/src/utils/custom-actions.spec.d.ts.map +1 -0
  125. package/dist/src/utils/processData.d.ts.map +1 -1
  126. package/dist/src/utils.d.ts +21 -0
  127. package/dist/src/utils.d.ts.map +1 -1
  128. package/dist/tsembed-react.es.js +1773 -251
  129. package/dist/tsembed-react.js +1772 -250
  130. package/dist/tsembed.es.js +1771 -250
  131. package/dist/tsembed.js +1770 -249
  132. package/dist/visual-embed-sdk-react-full.d.ts +228 -39
  133. package/dist/visual-embed-sdk-react.d.ts +228 -39
  134. package/dist/visual-embed-sdk.d.ts +228 -39
  135. package/lib/package.json +3 -3
  136. package/lib/src/authToken.d.ts +1 -0
  137. package/lib/src/authToken.d.ts.map +1 -1
  138. package/lib/src/authToken.js +11 -2
  139. package/lib/src/authToken.js.map +1 -1
  140. package/lib/src/authToken.spec.js +30 -1
  141. package/lib/src/authToken.spec.js.map +1 -1
  142. package/lib/src/css-variables.d.ts +2 -1
  143. package/lib/src/css-variables.d.ts.map +1 -1
  144. package/lib/src/embed/app.d.ts +22 -1
  145. package/lib/src/embed/app.d.ts.map +1 -1
  146. package/lib/src/embed/app.js +22 -1
  147. package/lib/src/embed/app.js.map +1 -1
  148. package/lib/src/embed/app.spec.js +70 -3
  149. package/lib/src/embed/app.spec.js.map +1 -1
  150. package/lib/src/embed/bodyless-conversation.d.ts +0 -1
  151. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  152. package/lib/src/embed/bodyless-conversation.js +3 -7
  153. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  154. package/lib/src/embed/conversation.d.ts +2 -3
  155. package/lib/src/embed/conversation.d.ts.map +1 -1
  156. package/lib/src/embed/conversation.js +2 -7
  157. package/lib/src/embed/conversation.js.map +1 -1
  158. package/lib/src/embed/liveboard.d.ts +32 -1
  159. package/lib/src/embed/liveboard.d.ts.map +1 -1
  160. package/lib/src/embed/liveboard.js +8 -25
  161. package/lib/src/embed/liveboard.js.map +1 -1
  162. package/lib/src/embed/liveboard.spec.js +96 -28
  163. package/lib/src/embed/liveboard.spec.js.map +1 -1
  164. package/lib/src/embed/sage.d.ts +0 -1
  165. package/lib/src/embed/sage.d.ts.map +1 -1
  166. package/lib/src/embed/sage.js +6 -10
  167. package/lib/src/embed/sage.js.map +1 -1
  168. package/lib/src/embed/sage.spec.js +20 -10
  169. package/lib/src/embed/sage.spec.js.map +1 -1
  170. package/lib/src/embed/search-bar.d.ts +0 -1
  171. package/lib/src/embed/search-bar.d.ts.map +1 -1
  172. package/lib/src/embed/search-bar.js +7 -11
  173. package/lib/src/embed/search-bar.js.map +1 -1
  174. package/lib/src/embed/search.d.ts +0 -1
  175. package/lib/src/embed/search.d.ts.map +1 -1
  176. package/lib/src/embed/search.js +8 -7
  177. package/lib/src/embed/search.js.map +1 -1
  178. package/lib/src/embed/search.spec.js +11 -11
  179. package/lib/src/embed/search.spec.js.map +1 -1
  180. package/lib/src/embed/ts-embed.d.ts +5 -7
  181. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  182. package/lib/src/embed/ts-embed.js +25 -22
  183. package/lib/src/embed/ts-embed.js.map +1 -1
  184. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  185. package/lib/src/embed/ts-embed.spec.js +123 -1
  186. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  187. package/lib/src/errors.d.ts +11 -0
  188. package/lib/src/errors.d.ts.map +1 -1
  189. package/lib/src/errors.js +11 -0
  190. package/lib/src/errors.js.map +1 -1
  191. package/lib/src/index.d.ts +2 -2
  192. package/lib/src/index.d.ts.map +1 -1
  193. package/lib/src/index.js +2 -2
  194. package/lib/src/index.js.map +1 -1
  195. package/lib/src/react/index.d.ts +1 -1
  196. package/lib/src/react/index.d.ts.map +1 -1
  197. package/lib/src/react/index.js +3 -2
  198. package/lib/src/react/index.js.map +1 -1
  199. package/lib/src/react/index.spec.js +1 -1
  200. package/lib/src/react/index.spec.js.map +1 -1
  201. package/lib/src/types.d.ts +163 -21
  202. package/lib/src/types.d.ts.map +1 -1
  203. package/lib/src/types.js +64 -21
  204. package/lib/src/types.js.map +1 -1
  205. package/lib/src/utils/custom-actions.d.ts +12 -0
  206. package/lib/src/utils/custom-actions.d.ts.map +1 -0
  207. package/lib/src/utils/custom-actions.js +175 -0
  208. package/lib/src/utils/custom-actions.js.map +1 -0
  209. package/lib/src/utils/custom-actions.spec.d.ts +2 -0
  210. package/lib/src/utils/custom-actions.spec.d.ts.map +1 -0
  211. package/lib/src/utils/custom-actions.spec.js +397 -0
  212. package/lib/src/utils/custom-actions.spec.js.map +1 -0
  213. package/lib/src/utils/processData.d.ts.map +1 -1
  214. package/lib/src/utils/processData.js +10 -0
  215. package/lib/src/utils/processData.js.map +1 -1
  216. package/lib/src/utils/processData.spec.js +11 -0
  217. package/lib/src/utils/processData.spec.js.map +1 -1
  218. package/lib/src/utils.d.ts +21 -0
  219. package/lib/src/utils.d.ts.map +1 -1
  220. package/lib/src/utils.js +29 -0
  221. package/lib/src/utils.js.map +1 -1
  222. package/lib/src/utils.spec.js +39 -1
  223. package/lib/src/utils.spec.js.map +1 -1
  224. package/lib/src/visual-embed-sdk.d.ts +229 -40
  225. package/package.json +3 -3
  226. package/src/authToken.spec.ts +48 -1
  227. package/src/authToken.ts +13 -2
  228. package/src/css-variables.ts +2 -1
  229. package/src/embed/app.spec.ts +99 -3
  230. package/src/embed/app.ts +44 -1
  231. package/src/embed/bodyless-conversation.ts +3 -8
  232. package/src/embed/conversation.ts +4 -19
  233. package/src/embed/liveboard.spec.ts +128 -30
  234. package/src/embed/liveboard.ts +66 -52
  235. package/src/embed/sage.spec.ts +24 -10
  236. package/src/embed/sage.ts +7 -12
  237. package/src/embed/search-bar.tsx +7 -14
  238. package/src/embed/search.spec.ts +13 -14
  239. package/src/embed/search.ts +8 -19
  240. package/src/embed/ts-embed.spec.ts +136 -2
  241. package/src/embed/ts-embed.ts +31 -28
  242. package/src/errors.ts +12 -0
  243. package/src/index.ts +4 -0
  244. package/src/react/index.spec.tsx +1 -1
  245. package/src/react/index.tsx +5 -2
  246. package/src/types.ts +225 -79
  247. package/src/utils/custom-actions.spec.ts +431 -0
  248. package/src/utils/custom-actions.ts +217 -0
  249. package/src/utils/processData.spec.ts +12 -0
  250. package/src/utils/processData.ts +10 -0
  251. package/src/utils.spec.ts +52 -0
  252. package/src/utils.ts +31 -0
  253. package/dist/index-BDlM0f0T.js +0 -7371
  254. package/dist/index-D1pyb7RG.js +0 -7371
  255. package/dist/index-DeFzsyFF.js +0 -7371
  256. package/dist/index-Dpf0rd6w.js +0 -7371
  257. package/dist/index-UuEbsISo.js +0 -7447
  258. package/dist/index-e3Uw3YFO.js +0 -7371
  259. package/dist/index-k7pkZMhx.js +0 -7371
@@ -652,7 +652,6 @@ export declare class SearchBarEmbed extends TsEmbed {
652
652
  protected viewConfig: SearchBarViewConfig;
653
653
  protected embedComponentType: string;
654
654
  constructor(domSelector: string, viewConfig: SearchBarViewConfig);
655
- protected getEmbedParamsObject(): Record<any, any>;
656
655
  /**
657
656
  * Render the embedded ThoughtSpot search
658
657
  */
@@ -805,7 +804,6 @@ export declare class SageEmbed extends V1Embed {
805
804
  */
806
805
  protected viewConfig: SageViewConfig;
807
806
  constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
808
- protected getEmbedParamsObject(): Record<any, any>;
809
807
  /**
810
808
  * Constructs a map of parameters to be passed on to the
811
809
  * embedded Eureka or Sage search page.
@@ -1143,7 +1141,6 @@ export declare class SearchEmbed extends TsEmbed {
1143
1141
  };
1144
1142
  };
1145
1143
  protected getAppInitData(): Promise<SearchAppInitData>;
1146
- protected getEmbedParamsObject(): Record<any, any>;
1147
1144
  protected getEmbedParams(): string;
1148
1145
  /**
1149
1146
  * Construct the URL of the embedded ThoughtSpot search to be
@@ -1248,7 +1245,12 @@ export declare enum HomePage {
1248
1245
  * Modular (v2) introduces the updated Modular Home Experience.
1249
1246
  * It serves as the foundational version of the home page.
1250
1247
  */
1251
- Modular = "v2"
1248
+ Modular = "v2",
1249
+ /**
1250
+ * ModularWithStylingChanges (v3) introduces Modular Home Experience
1251
+ * with styling changes.
1252
+ */
1253
+ ModularWithStylingChanges = "v3"
1252
1254
  }
1253
1255
  /**
1254
1256
  * Define the version of the list page
@@ -1669,6 +1671,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
1669
1671
  * ```
1670
1672
  */
1671
1673
  isLiveboardStylingAndGroupingEnabled?: boolean;
1674
+ /**
1675
+ * This flag is used to enable/disable the png embedding of liveboard in scheduled mails
1676
+ *
1677
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1678
+ * @type {boolean}
1679
+ * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
1680
+ * @example
1681
+ * ```js
1682
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
1683
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1684
+ * ... // other embed view config
1685
+ * isPNGInScheduledEmailsEnabled: true,
1686
+ * })
1687
+ * ```
1688
+ */
1689
+ isPNGInScheduledEmailsEnabled?: boolean;
1672
1690
  /**
1673
1691
  * This flag is used to enable the full height lazy load data.
1674
1692
  *
@@ -2060,6 +2078,22 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
2060
2078
  * ```
2061
2079
  */
2062
2080
  isLiveboardStylingAndGroupingEnabled?: boolean;
2081
+ /**
2082
+ * This flag is used to enable/disable the png embedding of liveboard in scheduled mails
2083
+ *
2084
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2085
+ * @type {boolean}
2086
+ * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
2087
+ * @example
2088
+ * ```js
2089
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
2090
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2091
+ * ... // other embed view config
2092
+ * isPNGInScheduledEmailsEnabled: true,
2093
+ * })
2094
+ * ```
2095
+ */
2096
+ isPNGInScheduledEmailsEnabled?: boolean;
2063
2097
  /**
2064
2098
  * This flag is used to enable the full height lazy load data.
2065
2099
  *
@@ -2100,6 +2134,22 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
2100
2134
  * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
2101
2135
  */
2102
2136
  lazyLoadingMargin?: string;
2137
+ /**
2138
+ * showSpotterLimitations : show limitation text
2139
+ * of the spotter underneath the chat input.
2140
+ * default is false.
2141
+ *
2142
+ * @example
2143
+ * ```js
2144
+ * const embed = new LiveboardEmbed('#embed-container', {
2145
+ * // ...other options
2146
+ * showSpotterLimitations: true,
2147
+ * })
2148
+ * ```
2149
+ * @type {boolean}
2150
+ * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
2151
+ */
2152
+ showSpotterLimitations?: boolean;
2103
2153
  }
2104
2154
  /**
2105
2155
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -2124,7 +2174,6 @@ export declare class LiveboardEmbed extends V1Embed {
2124
2174
  * embedded Liveboard or visualization.
2125
2175
  */
2126
2176
  protected getEmbedParams(): string;
2127
- protected getEmbedParamsObject(): any;
2128
2177
  /**
2129
2178
  * @hidden
2130
2179
  * Internal state to track the current liveboard id.
@@ -2198,7 +2247,6 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
2198
2247
  export declare class ConversationMessage extends TsEmbed {
2199
2248
  protected viewConfig: SpotterAgentMessageViewConfig;
2200
2249
  constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
2201
- protected getEmbedParamsObject(): Record<any, any>;
2202
2250
  getIframeSrc(): string;
2203
2251
  render(): Promise<ConversationMessage>;
2204
2252
  }
@@ -2914,6 +2962,31 @@ export interface EmbedConfig {
2914
2962
  * ```
2915
2963
  */
2916
2964
  disableFullscreenPresentation?: boolean;
2965
+ /**
2966
+ * Custom Actions allows users to define interactive UI actions (like buttons or menu
2967
+ * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These
2968
+ * actions enable users to trigger custom workflows — such as navigating to an
2969
+ * external app, calling an API, or opening a modal — based on the data context of
2970
+ * what they clicked can be used to trigger custom logic when the action is clicked.
2971
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
2972
+ * @example
2973
+ * ```js
2974
+ * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
2975
+ * init({
2976
+ * ... // other embed config options
2977
+ * customActions: [
2978
+ * {
2979
+ * name: 'customAction',
2980
+ * id: 'customAction',
2981
+ * target: CustomActionTarget.VISUALIZATION,
2982
+ * position: CustomActionPosition.PRIMARY,
2983
+ * }
2984
+ * }
2985
+ * ]
2986
+ * })
2987
+ * ```
2988
+ */
2989
+ customActions?: CustomAction[];
2917
2990
  }
2918
2991
  export interface LayoutConfig {
2919
2992
  }
@@ -3274,6 +3347,34 @@ export interface BaseViewConfig {
3274
3347
  * ```
3275
3348
  */
3276
3349
  showAlerts?: boolean;
3350
+ /**
3351
+ * Custom Actions allows users to define interactive UI actions (like buttons or menu
3352
+ * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These
3353
+ * actions enable users to trigger custom workflows — such as navigating to an
3354
+ * external app, calling an API, or opening a modal — based on the data context of
3355
+ * what they clicked can be used to trigger custom logic when the action is clicked.
3356
+ *
3357
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed`
3358
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
3359
+ * @example
3360
+ * ```js
3361
+ * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
3362
+ * // Use supported embed types such as AppEmbed or LiveboardEmbed
3363
+ * const embed = new LiveboardEmbed('#tsEmbed', {
3364
+ * ... // other embed config options
3365
+ * customActions: [
3366
+ * {
3367
+ * name: 'customAction',
3368
+ * id: 'customAction',
3369
+ * target: CustomActionTarget.VISUALIZATION,
3370
+ * position: CustomActionPosition.PRIMARY,
3371
+ * }
3372
+ * }
3373
+ * ]
3374
+ * })
3375
+ * ```
3376
+ */
3377
+ customActions?: CustomAction[];
3277
3378
  }
3278
3379
  /**
3279
3380
  * The configuration object for Home page embeds configs.
@@ -3283,7 +3384,8 @@ export interface HomePageConfig {
3283
3384
  * Hide list page columns
3284
3385
  * For example: hiddenListColumns = [ListPageColumns.Author]
3285
3386
  *
3286
- * **Note**: This option is available only in full app embedding. To use it, you need to import `ListPageColumns` enum.
3387
+ * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
3388
+ * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page.
3287
3389
  *
3288
3390
  * Supported embed types: `AppEmbed`
3289
3391
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
@@ -3468,8 +3570,8 @@ export interface SearchLiveboardCommonViewConfig {
3468
3570
  * Flag to control Data panel experience
3469
3571
  *
3470
3572
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
3471
- * @default false
3472
- * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3573
+ * @default true
3574
+ * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
3473
3575
  * @example
3474
3576
  * ```js
3475
3577
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -3599,7 +3701,8 @@ export interface LiveboardAppEmbedViewConfig {
3599
3701
  */
3600
3702
  isLiveboardCompactHeaderEnabled?: boolean;
3601
3703
  /**
3602
- * This flag can be used to show or hide the Liveboard verified icon in the compact header.
3704
+ * This flag can be used to show or hide the Liveboard verified icon in the compact
3705
+ * header.
3603
3706
  *
3604
3707
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3605
3708
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -3617,6 +3720,8 @@ export interface LiveboardAppEmbedViewConfig {
3617
3720
  /**
3618
3721
  * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
3619
3722
  *
3723
+ * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
3724
+ *
3620
3725
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3621
3726
  * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
3622
3727
  * @default false
@@ -3626,12 +3731,14 @@ export interface LiveboardAppEmbedViewConfig {
3626
3731
  * const embed = new <EmbedComponent>('#tsEmbed', {
3627
3732
  * ... // other embed view config
3628
3733
  * hideIrrelevantChipsInLiveboardTabs: true,
3734
+ * isLiveboardCompactHeaderEnabled: true,
3629
3735
  * })
3630
3736
  * ```
3631
3737
  */
3632
3738
  hideIrrelevantChipsInLiveboardTabs?: boolean;
3633
3739
  /**
3634
- * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
3740
+ * This flag can be used to show or hide the re-verify banner on the Liveboard
3741
+ * compact header
3635
3742
  *
3636
3743
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3637
3744
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -3678,6 +3785,21 @@ export interface LiveboardAppEmbedViewConfig {
3678
3785
  * ```
3679
3786
  */
3680
3787
  coverAndFilterOptionInPDF?: boolean;
3788
+ /**
3789
+ * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
3790
+ *
3791
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3792
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.14.0.cl
3793
+ * @example
3794
+ * ```js
3795
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3796
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3797
+ * ... // other embed view config
3798
+ * liveboardXLSXCSVDownload: true,
3799
+ * })
3800
+ * ```
3801
+ */
3802
+ liveboardXLSXCSVDownload?: boolean;
3681
3803
  }
3682
3804
  export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
3683
3805
  }
@@ -4565,6 +4687,11 @@ export declare enum EmbedEvent {
4565
4687
  * @hidden
4566
4688
  */
4567
4689
  APP_INIT = "appInit",
4690
+ /**
4691
+ * Internal event to clear the cached info
4692
+ * @hidden
4693
+ */
4694
+ CLEAR_INFO_CACHE = "clearInfoCache",
4568
4695
  /**
4569
4696
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
4570
4697
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
@@ -5032,7 +5159,18 @@ export declare enum EmbedEvent {
5032
5159
  * })
5033
5160
  * ```
5034
5161
  */
5035
- EmbedListenerReady = "EmbedListenerReady"
5162
+ EmbedListenerReady = "EmbedListenerReady",
5163
+ /**
5164
+ * Emitted when the organization is switched.
5165
+ * @example
5166
+ * ```js
5167
+ * appEmbed.on(EmbedEvent.OrgSwitched, (payload) => {
5168
+ * console.log('payload', payload);
5169
+ * })
5170
+ * ```
5171
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5172
+ */
5173
+ OrgSwitched = "orgSwitched"
5036
5174
  }
5037
5175
  /**
5038
5176
  * Event types that can be triggered by the host application
@@ -5949,7 +6087,7 @@ export declare enum HostEvent {
5949
6087
  * column: "Date",
5950
6088
  * oper: 'EQ',
5951
6089
  * values: ["2023-07-31"],
5952
- * types: "EXACT_DATE"
6090
+ * type: "EXACT_DATE"
5953
6091
  * }]
5954
6092
  * });
5955
6093
  * ```
@@ -6294,17 +6432,7 @@ export declare enum HostEvent {
6294
6432
  * ```
6295
6433
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
6296
6434
  */
6297
- AskSpotter = "AskSpotter",
6298
- /**
6299
- * @hidden
6300
- * Triggers the update of the embed params.
6301
- *
6302
- * @example
6303
- * ```js
6304
- * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
6305
- * ```
6306
- */
6307
- UpdateEmbedParams = "updateEmbedParams"
6435
+ AskSpotter = "AskSpotter"
6308
6436
  }
6309
6437
  /**
6310
6438
  * The different visual modes that the data sources panel within
@@ -6400,6 +6528,7 @@ export declare enum Param {
6400
6528
  Query = "query",
6401
6529
  HideHomepageLeftNav = "hideHomepageLeftNav",
6402
6530
  ModularHomeExperienceEnabled = "modularHomeExperience",
6531
+ HomepageVersion = "homepageVersion",
6403
6532
  ListPageVersion = "listpageVersion",
6404
6533
  PendoTrackingKey = "additionalPendoKey",
6405
6534
  LiveboardHeaderSticky = "isLiveboardHeaderSticky",
@@ -6440,7 +6569,9 @@ export declare enum Param {
6440
6569
  isSpotterAgentEmbed = "isSpotterAgentEmbed",
6441
6570
  IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
6442
6571
  IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
6443
- RootMarginForLazyLoad = "rootMarginForLazyLoad"
6572
+ RootMarginForLazyLoad = "rootMarginForLazyLoad",
6573
+ LiveboardXLSXCSVDownload = "isLiveboardXLSXCSVDownloadEnabled",
6574
+ isPNGInScheduledEmailsEnabled = "isPNGInScheduledEmailsEnabled"
6444
6575
  }
6445
6576
  /**
6446
6577
  * ThoughtSpot application pages include actions and menu commands
@@ -7012,7 +7143,7 @@ export declare enum Action {
7012
7143
  * The Favorites icon (*) for Answers,
7013
7144
  * Liveboard, and data objects like Worksheet, Model,
7014
7145
  * Tables and Views.
7015
- * Allows adding an object to the users favorites list.
7146
+ * Allows adding an object to the user's favorites list.
7016
7147
  * @example
7017
7148
  * ```js
7018
7149
  * disabledActions: [Action.AddToFavorites]
@@ -7720,7 +7851,30 @@ export declare enum Action {
7720
7851
  * ```
7721
7852
  * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7722
7853
  */
7723
- SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
7854
+ SpotterTokenQuickEdit = "SpotterTokenQuickEdit",
7855
+ /**
7856
+ * The **PNG screenshot in email** option in the schedule email dialog.
7857
+ * Includes a PNG screenshot in the notification email body.
7858
+ * @example
7859
+ * ```js
7860
+ * disabledActions: [Action.PngScreenshotInEmail]
7861
+ * ```
7862
+ * ```
7863
+ * @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
7864
+ */
7865
+ PngScreenshotInEmail = "pngScreenshotInEmail",
7866
+ /**
7867
+ * The **Remove attachment** action in the schedule email dialog.
7868
+ * Removes an attachment from the email configuration.
7869
+ * @example
7870
+ * ```js
7871
+ * disabledActions: [Action.RemoveAttachment]
7872
+ * ```
7873
+ * ```
7874
+ * ```
7875
+ * @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
7876
+ */
7877
+ RemoveAttachment = "removeAttachment"
7724
7878
  }
7725
7879
  export interface AnswerServiceType {
7726
7880
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -7781,6 +7935,41 @@ export interface CustomActionPayload {
7781
7935
  session: SessionInterface;
7782
7936
  vizId?: string;
7783
7937
  }
7938
+ export interface CustomAction {
7939
+ name: string;
7940
+ id: string;
7941
+ position: CustomActionsPosition;
7942
+ target: CustomActionTarget;
7943
+ metadataIds?: {
7944
+ answerIds?: string[];
7945
+ liveboardIds?: string[];
7946
+ vizIds?: string[];
7947
+ };
7948
+ dataModelIds?: {
7949
+ modelIds?: string[];
7950
+ modelColumnNames?: string[];
7951
+ };
7952
+ orgIds?: string[];
7953
+ groupIds?: string[];
7954
+ }
7955
+ /**
7956
+ * Enum options to show custom actions at different
7957
+ * positions in the application.
7958
+ */
7959
+ export declare enum CustomActionsPosition {
7960
+ PRIMARY = "PRIMARY",
7961
+ MENU = "MENU",
7962
+ CONTEXTMENU = "CONTEXTMENU"
7963
+ }
7964
+ /**
7965
+ * Enum options to mention the target of the custom action.
7966
+ */
7967
+ export declare enum CustomActionTarget {
7968
+ LIVEBOARD = "LIVEBOARD",
7969
+ VIZ = "VIZ",
7970
+ ANSWER = "ANSWER",
7971
+ SPOTTER = "SPOTTER"
7972
+ }
7784
7973
  /**
7785
7974
  * Enum options to show or suppress Visual Embed SDK and
7786
7975
  * ThoughtSpot application logs in the console output.
@@ -7875,6 +8064,7 @@ export interface DefaultAppInitData {
7875
8064
  hiddenHomeLeftNavItems: string[];
7876
8065
  customVariablesForThirdPartyTools: Record<string, any>;
7877
8066
  hiddenListColumns: ListPageColumns[];
8067
+ customActions: CustomAction[];
7878
8068
  }
7879
8069
 
7880
8070
  interface EmbedViewConfig extends AllEmbedViewConfig, EmbedEventHandlers {
@@ -7955,8 +8145,8 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
7955
8145
  * Flag to control Data panel experience
7956
8146
  *
7957
8147
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
7958
- * @default false
7959
- * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
8148
+ * @default true
8149
+ * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
7960
8150
  * @example
7961
8151
  * ```js
7962
8152
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -8085,7 +8275,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
8085
8275
  export declare class SpotterEmbed extends TsEmbed {
8086
8276
  protected viewConfig: SpotterEmbedViewConfig;
8087
8277
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
8088
- protected getEmbedParamsObject(): Record<any, any>;
8089
8278
  getIframeSrc(): string;
8090
8279
  render(): Promise<SpotterEmbed>;
8091
8280
  }
@@ -8119,7 +8308,7 @@ export declare class ConversationEmbed extends SpotterEmbed {
8119
8308
  * @summary ThoughtSpot Visual Embed SDK
8120
8309
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
8121
8310
  */
8122
- export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
8311
+ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, CustomActionsPosition, CustomActionTarget, };
8123
8312
 
8124
8313
  /**
8125
8314
  * Copyright (c) 2022
@@ -8195,7 +8384,6 @@ export declare class TsEmbed {
8195
8384
  * @param query
8196
8385
  */
8197
8386
  protected getEmbedBasePath(query: string): string;
8198
- protected getUpdateEmbedParamsObject(): Record<any, any>;
8199
8387
  /**
8200
8388
  * Common query params set for all the embed modes.
8201
8389
  * @param queryParams
@@ -8211,7 +8399,6 @@ export declare class TsEmbed {
8211
8399
  */
8212
8400
  protected getV1EmbedBasePath(queryString: string): string;
8213
8401
  protected getEmbedParams(): string;
8214
- protected getEmbedParamsObject(): Record<any, any>;
8215
8402
  protected getRootIframeSrc(): string;
8216
8403
  protected createIframeEl(frameSrc: string): HTMLIFrameElement;
8217
8404
  protected handleInsertionIntoDOM(child: string | Node): void;
@@ -8304,10 +8491,10 @@ export declare class TsEmbed {
8304
8491
  */
8305
8492
  off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
8306
8493
  /**
8307
- * @hidden
8308
- * Internal state to track if the embed container is loaded.
8309
- * This is used to trigger events after the embed container is loaded.
8310
- */
8494
+ * @hidden
8495
+ * Internal state to track if the embed container is loaded.
8496
+ * This is used to trigger events after the embed container is loaded.
8497
+ */
8311
8498
  isEmbedContainerLoaded: boolean;
8312
8499
  protected getPreRenderObj<T extends TsEmbed>(): T;
8313
8500
  /**
@@ -8344,7 +8531,7 @@ export declare class TsEmbed {
8344
8531
  * Creates the preRender shell
8345
8532
  * @param showPreRenderByDefault - Show the preRender after render, hidden by default
8346
8533
  */
8347
- preRender(showPreRenderByDefault?: boolean): Promise<TsEmbed>;
8534
+ preRender(showPreRenderByDefault?: boolean, replaceExistingPreRender?: boolean): Promise<TsEmbed>;
8348
8535
  /**
8349
8536
  * Get the Post Url Params for THOUGHTSPOT from the current
8350
8537
  * host app URL.
@@ -8552,7 +8739,8 @@ export interface CustomCssVariables {
8552
8739
  * Font color of the text on toggle buttons such as
8553
8740
  * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience),
8554
8741
  * the text color of the chart and table tiles on Home page (New modular Homepage
8555
- * experience), and title text on the AI-generated charts and tables.
8742
+ * experience), title text on the AI-generated charts and tables, and object titles on
8743
+ * list pages such as *Liveboards* and *Answers*.
8556
8744
  * The default color code is #2770EF.
8557
8745
  *
8558
8746
  */
@@ -9838,6 +10026,7 @@ export declare const createLiveboardWithAnswers: (answers: AnswerService[], name
9838
10026
  * @param embedConfig
9839
10027
  */
9840
10028
  export declare function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string>;
10029
+ export declare const validateAuthToken: (embedConfig: EmbedConfig, authToken: string, suppressAlert?: boolean) => Promise<boolean>;
9841
10030
  /**
9842
10031
  * Resets the auth token and a new token will be fetched on the next request.
9843
10032
  * @example