@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.3

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 (257) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/auth.d.ts +29 -4
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +29 -7
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/auth.spec.js +1 -3
  7. package/cjs/src/auth.spec.js.map +1 -1
  8. package/cjs/src/authToken.js +0 -1
  9. package/cjs/src/authToken.js.map +1 -1
  10. package/cjs/src/authToken.spec.js +2 -1
  11. package/cjs/src/authToken.spec.js.map +1 -1
  12. package/cjs/src/css-variables.d.ts +17 -17
  13. package/cjs/src/embed/app.d.ts +62 -33
  14. package/cjs/src/embed/app.d.ts.map +1 -1
  15. package/cjs/src/embed/app.js +10 -3
  16. package/cjs/src/embed/app.js.map +1 -1
  17. package/cjs/src/embed/app.spec.js +34 -1
  18. package/cjs/src/embed/app.spec.js.map +1 -1
  19. package/cjs/src/embed/auto-frame-renderer.d.ts +41 -0
  20. package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -0
  21. package/cjs/src/embed/auto-frame-renderer.js +145 -0
  22. package/cjs/src/embed/auto-frame-renderer.js.map +1 -0
  23. package/cjs/src/embed/auto-frame-renderer.spec.d.ts +2 -0
  24. package/cjs/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
  25. package/cjs/src/embed/auto-frame-renderer.spec.js +195 -0
  26. package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -0
  27. package/cjs/src/embed/base.d.ts +2 -2
  28. package/cjs/src/embed/base.d.ts.map +1 -1
  29. package/cjs/src/embed/base.js +6 -9
  30. package/cjs/src/embed/base.js.map +1 -1
  31. package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
  32. package/cjs/src/embed/bodyless-conversation.js +4 -4
  33. package/cjs/src/embed/conversation.d.ts +43 -30
  34. package/cjs/src/embed/conversation.d.ts.map +1 -1
  35. package/cjs/src/embed/conversation.js +10 -11
  36. package/cjs/src/embed/conversation.js.map +1 -1
  37. package/cjs/src/embed/conversation.spec.js +27 -0
  38. package/cjs/src/embed/conversation.spec.js.map +1 -1
  39. package/cjs/src/embed/hostEventClient/host-event-client.js +0 -2
  40. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  41. package/cjs/src/embed/liveboard.d.ts +42 -35
  42. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  43. package/cjs/src/embed/liveboard.js +6 -4
  44. package/cjs/src/embed/liveboard.js.map +1 -1
  45. package/cjs/src/embed/liveboard.spec.js +5 -3
  46. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  47. package/cjs/src/embed/sage.d.ts +5 -5
  48. package/cjs/src/embed/sage.js +1 -2
  49. package/cjs/src/embed/sage.js.map +1 -1
  50. package/cjs/src/embed/search-bar.d.ts +7 -7
  51. package/cjs/src/embed/search-bar.js +1 -1
  52. package/cjs/src/embed/search.d.ts +13 -12
  53. package/cjs/src/embed/search.d.ts.map +1 -1
  54. package/cjs/src/embed/search.js.map +1 -1
  55. package/cjs/src/embed/search.spec.js +0 -2
  56. package/cjs/src/embed/search.spec.js.map +1 -1
  57. package/cjs/src/embed/ts-embed.d.ts +3 -3
  58. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  59. package/cjs/src/embed/ts-embed.js +15 -9
  60. package/cjs/src/embed/ts-embed.js.map +1 -1
  61. package/cjs/src/embed/ts-embed.spec.js +37 -1
  62. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  63. package/cjs/src/index.d.ts +3 -2
  64. package/cjs/src/index.d.ts.map +1 -1
  65. package/cjs/src/index.js +3 -1
  66. package/cjs/src/index.js.map +1 -1
  67. package/cjs/src/react/index.d.ts +15 -15
  68. package/cjs/src/react/index.js +12 -13
  69. package/cjs/src/react/index.js.map +1 -1
  70. package/cjs/src/react/index.spec.js +6 -3
  71. package/cjs/src/react/index.spec.js.map +1 -1
  72. package/cjs/src/tokenizedFetch.d.ts +1 -1
  73. package/cjs/src/tokenizedFetch.js +1 -1
  74. package/cjs/src/types.d.ts +350 -287
  75. package/cjs/src/types.d.ts.map +1 -1
  76. package/cjs/src/types.js +240 -218
  77. package/cjs/src/types.js.map +1 -1
  78. package/cjs/src/utils/graphql/answerService/answerService.d.ts +9 -6
  79. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  80. package/cjs/src/utils/graphql/answerService/answerService.js +13 -15
  81. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  82. package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
  83. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  84. package/cjs/src/utils/graphql/preview-service.js +0 -1
  85. package/cjs/src/utils/graphql/preview-service.js.map +1 -1
  86. package/cjs/src/utils/processData.js +0 -5
  87. package/cjs/src/utils/processData.js.map +1 -1
  88. package/cjs/src/utils.d.ts +9 -0
  89. package/cjs/src/utils.d.ts.map +1 -1
  90. package/cjs/src/utils.js +10 -1
  91. package/cjs/src/utils.js.map +1 -1
  92. package/dist/{index-Vyh6Ha5f.js → index-DyX-x6uN.js} +1 -1
  93. package/dist/src/auth.d.ts +29 -4
  94. package/dist/src/auth.d.ts.map +1 -1
  95. package/dist/src/css-variables.d.ts +17 -17
  96. package/dist/src/embed/app.d.ts +62 -33
  97. package/dist/src/embed/app.d.ts.map +1 -1
  98. package/dist/src/embed/auto-frame-renderer.d.ts +41 -0
  99. package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -0
  100. package/dist/src/embed/auto-frame-renderer.spec.d.ts +2 -0
  101. package/dist/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
  102. package/dist/src/embed/base.d.ts +2 -2
  103. package/dist/src/embed/base.d.ts.map +1 -1
  104. package/dist/src/embed/bodyless-conversation.d.ts +5 -5
  105. package/dist/src/embed/conversation.d.ts +43 -30
  106. package/dist/src/embed/conversation.d.ts.map +1 -1
  107. package/dist/src/embed/liveboard.d.ts +42 -35
  108. package/dist/src/embed/liveboard.d.ts.map +1 -1
  109. package/dist/src/embed/sage.d.ts +5 -5
  110. package/dist/src/embed/search-bar.d.ts +7 -7
  111. package/dist/src/embed/search.d.ts +13 -12
  112. package/dist/src/embed/search.d.ts.map +1 -1
  113. package/dist/src/embed/ts-embed.d.ts +3 -3
  114. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  115. package/dist/src/index.d.ts +3 -2
  116. package/dist/src/index.d.ts.map +1 -1
  117. package/dist/src/react/index.d.ts +15 -15
  118. package/dist/src/tokenizedFetch.d.ts +1 -1
  119. package/dist/src/types.d.ts +350 -287
  120. package/dist/src/types.d.ts.map +1 -1
  121. package/dist/src/utils/graphql/answerService/answerService.d.ts +9 -6
  122. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  123. package/dist/src/utils.d.ts +9 -0
  124. package/dist/src/utils.d.ts.map +1 -1
  125. package/dist/tsembed-react.es.js +359 -329
  126. package/dist/tsembed-react.js +358 -328
  127. package/dist/tsembed.es.js +490 -321
  128. package/dist/tsembed.js +489 -319
  129. package/dist/visual-embed-sdk-react-full.d.ts +574 -442
  130. package/dist/visual-embed-sdk-react.d.ts +572 -440
  131. package/dist/visual-embed-sdk.d.ts +622 -446
  132. package/lib/package.json +1 -1
  133. package/lib/src/auth.d.ts +29 -4
  134. package/lib/src/auth.d.ts.map +1 -1
  135. package/lib/src/auth.js +29 -7
  136. package/lib/src/auth.js.map +1 -1
  137. package/lib/src/auth.spec.js +1 -3
  138. package/lib/src/auth.spec.js.map +1 -1
  139. package/lib/src/authToken.js +0 -1
  140. package/lib/src/authToken.js.map +1 -1
  141. package/lib/src/authToken.spec.js +2 -1
  142. package/lib/src/authToken.spec.js.map +1 -1
  143. package/lib/src/css-variables.d.ts +17 -17
  144. package/lib/src/embed/app.d.ts +62 -33
  145. package/lib/src/embed/app.d.ts.map +1 -1
  146. package/lib/src/embed/app.js +11 -4
  147. package/lib/src/embed/app.js.map +1 -1
  148. package/lib/src/embed/app.spec.js +34 -1
  149. package/lib/src/embed/app.spec.js.map +1 -1
  150. package/lib/src/embed/auto-frame-renderer.d.ts +41 -0
  151. package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -0
  152. package/lib/src/embed/auto-frame-renderer.js +141 -0
  153. package/lib/src/embed/auto-frame-renderer.js.map +1 -0
  154. package/lib/src/embed/auto-frame-renderer.spec.d.ts +2 -0
  155. package/lib/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
  156. package/lib/src/embed/auto-frame-renderer.spec.js +192 -0
  157. package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -0
  158. package/lib/src/embed/base.d.ts +2 -2
  159. package/lib/src/embed/base.d.ts.map +1 -1
  160. package/lib/src/embed/base.js +6 -9
  161. package/lib/src/embed/base.js.map +1 -1
  162. package/lib/src/embed/bodyless-conversation.d.ts +5 -5
  163. package/lib/src/embed/bodyless-conversation.js +4 -4
  164. package/lib/src/embed/conversation.d.ts +43 -30
  165. package/lib/src/embed/conversation.d.ts.map +1 -1
  166. package/lib/src/embed/conversation.js +11 -11
  167. package/lib/src/embed/conversation.js.map +1 -1
  168. package/lib/src/embed/conversation.spec.js +27 -0
  169. package/lib/src/embed/conversation.spec.js.map +1 -1
  170. package/lib/src/embed/hostEventClient/host-event-client.js +0 -2
  171. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  172. package/lib/src/embed/liveboard.d.ts +42 -35
  173. package/lib/src/embed/liveboard.d.ts.map +1 -1
  174. package/lib/src/embed/liveboard.js +6 -4
  175. package/lib/src/embed/liveboard.js.map +1 -1
  176. package/lib/src/embed/liveboard.spec.js +5 -3
  177. package/lib/src/embed/liveboard.spec.js.map +1 -1
  178. package/lib/src/embed/sage.d.ts +5 -5
  179. package/lib/src/embed/sage.js +1 -2
  180. package/lib/src/embed/sage.js.map +1 -1
  181. package/lib/src/embed/search-bar.d.ts +7 -7
  182. package/lib/src/embed/search-bar.js +1 -1
  183. package/lib/src/embed/search.d.ts +13 -12
  184. package/lib/src/embed/search.d.ts.map +1 -1
  185. package/lib/src/embed/search.js.map +1 -1
  186. package/lib/src/embed/search.spec.js +0 -2
  187. package/lib/src/embed/search.spec.js.map +1 -1
  188. package/lib/src/embed/ts-embed.d.ts +3 -3
  189. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  190. package/lib/src/embed/ts-embed.js +15 -9
  191. package/lib/src/embed/ts-embed.js.map +1 -1
  192. package/lib/src/embed/ts-embed.spec.js +37 -1
  193. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  194. package/lib/src/index.d.ts +3 -2
  195. package/lib/src/index.d.ts.map +1 -1
  196. package/lib/src/index.js +1 -0
  197. package/lib/src/index.js.map +1 -1
  198. package/lib/src/react/index.d.ts +15 -15
  199. package/lib/src/react/index.js +12 -13
  200. package/lib/src/react/index.js.map +1 -1
  201. package/lib/src/react/index.spec.js +6 -3
  202. package/lib/src/react/index.spec.js.map +1 -1
  203. package/lib/src/tokenizedFetch.d.ts +1 -1
  204. package/lib/src/tokenizedFetch.js +1 -1
  205. package/lib/src/types.d.ts +350 -287
  206. package/lib/src/types.d.ts.map +1 -1
  207. package/lib/src/types.js +240 -218
  208. package/lib/src/types.js.map +1 -1
  209. package/lib/src/utils/graphql/answerService/answerService.d.ts +9 -6
  210. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  211. package/lib/src/utils/graphql/answerService/answerService.js +12 -14
  212. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  213. package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
  214. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  215. package/lib/src/utils/graphql/preview-service.js +0 -1
  216. package/lib/src/utils/graphql/preview-service.js.map +1 -1
  217. package/lib/src/utils/processData.js +0 -5
  218. package/lib/src/utils/processData.js.map +1 -1
  219. package/lib/src/utils.d.ts +9 -0
  220. package/lib/src/utils.d.ts.map +1 -1
  221. package/lib/src/utils.js +8 -0
  222. package/lib/src/utils.js.map +1 -1
  223. package/lib/src/visual-embed-sdk.d.ts +11466 -0
  224. package/package.json +1 -1
  225. package/src/auth.spec.ts +1 -1
  226. package/src/auth.ts +32 -7
  227. package/src/authToken.spec.ts +2 -1
  228. package/src/authToken.ts +1 -1
  229. package/src/css-variables.ts +17 -17
  230. package/src/embed/app.spec.ts +46 -1
  231. package/src/embed/app.ts +74 -36
  232. package/src/embed/auto-frame-renderer.spec.ts +266 -0
  233. package/src/embed/auto-frame-renderer.ts +152 -0
  234. package/src/embed/base.spec.ts +1 -1
  235. package/src/embed/base.ts +9 -10
  236. package/src/embed/bodyless-conversation.ts +5 -5
  237. package/src/embed/conversation.spec.ts +37 -0
  238. package/src/embed/conversation.ts +55 -38
  239. package/src/embed/hostEventClient/host-event-client.ts +2 -2
  240. package/src/embed/liveboard.spec.ts +5 -3
  241. package/src/embed/liveboard.ts +47 -38
  242. package/src/embed/sage.ts +6 -6
  243. package/src/embed/search-bar.tsx +7 -7
  244. package/src/embed/search.spec.ts +2 -2
  245. package/src/embed/search.ts +13 -12
  246. package/src/embed/ts-embed.spec.ts +44 -1
  247. package/src/embed/ts-embed.ts +14 -9
  248. package/src/index.ts +3 -0
  249. package/src/react/index.spec.tsx +6 -3
  250. package/src/react/index.tsx +16 -16
  251. package/src/tokenizedFetch.ts +1 -1
  252. package/src/types.ts +350 -286
  253. package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
  254. package/src/utils/graphql/answerService/answerService.ts +14 -10
  255. package/src/utils/graphql/preview-service.ts +1 -1
  256. package/src/utils/processData.ts +5 -5
  257. package/src/utils.ts +14 -0
package/lib/src/types.js CHANGED
@@ -6,7 +6,7 @@
6
6
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
7
7
  */
8
8
  /**
9
- * The authentication mechanism for allowing access to the
9
+ * The authentication mechanism for allowing access to
10
10
  * the embedded app
11
11
  * @group Authentication / Init
12
12
  */
@@ -32,6 +32,7 @@ export var AuthType;
32
32
  * To use this:
33
33
  * Your SAML or OpenID provider must allow iframe redirects.
34
34
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
35
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
35
36
  * @example
36
37
  * ```js
37
38
  * init({
@@ -39,18 +40,17 @@ export var AuthType;
39
40
  * authType: AuthType.EmbeddedSSO,
40
41
  * });
41
42
  * ```
42
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
43
43
  */
44
44
  AuthType["EmbeddedSSO"] = "EmbeddedSSO";
45
45
  /**
46
- * SSO using SAML
47
- * @deprecated Use {@link SAMLRedirect} instead
46
+ * SSO using SAML, Use {@link SAMLRedirect} instead
47
+ * @deprecated This option is deprecated.
48
48
  * @hidden
49
49
  */
50
50
  AuthType["SSO"] = "SSO_SAML";
51
51
  /**
52
- * SSO using SAML
53
- * @deprecated Use {@link SAMLRedirect} instead
52
+ * SSO using SAML, Use {@link SAMLRedirect} instead
53
+ * @deprecated This option is deprecated.
54
54
  * @hidden
55
55
  */
56
56
  AuthType["SAML"] = "SSO_SAML";
@@ -101,8 +101,9 @@ export var AuthType;
101
101
  AuthType["SAMLRedirect"] = "SSO_SAML";
102
102
  /**
103
103
  * SSO using OIDC
104
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
105
+ * @deprecated This option is deprecated.
104
106
  * @hidden
105
- * @deprecated Use {@link OIDCRedirect} instead
106
107
  */
107
108
  AuthType["OIDC"] = "SSO_OIDC";
108
109
  /**
@@ -113,8 +114,9 @@ export var AuthType;
113
114
  AuthType["OIDCRedirect"] = "SSO_OIDC";
114
115
  /**
115
116
  * Trusted authentication server
117
+ * Use {@link TrustedAuth} instead
118
+ * @deprecated This option is deprecated.
116
119
  * @hidden
117
- * @deprecated Use {@link TrustedAuth} instead
118
120
  */
119
121
  AuthType["AuthServer"] = "AuthServer";
120
122
  /**
@@ -141,6 +143,7 @@ export var AuthType;
141
143
  * obtained from ThoughtSpot. This uses a cookieless authentication
142
144
  * approach, recommended to bypass the third-party cookie-blocking restriction
143
145
  * implemented by some browsers.
146
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
144
147
  * @example
145
148
  * ```js
146
149
  * init({
@@ -151,8 +154,8 @@ export var AuthType;
151
154
  * .then((response) => response.json())
152
155
  * .then((data) => data.token);
153
156
  * }
157
+ * });
154
158
  * ```
155
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
156
159
  */
157
160
  AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
158
161
  /**
@@ -173,43 +176,43 @@ export var HomeLeftNavItem;
173
176
  /**
174
177
  * The *Search data* option in
175
178
  * the *Insights* left navigation panel.
176
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
179
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
177
180
  */
178
181
  HomeLeftNavItem["SearchData"] = "search-data";
179
182
  /**
180
183
  * The *Home* menu option in
181
184
  * the *Insights* left navigation panel.
182
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
185
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
183
186
  */
184
187
  HomeLeftNavItem["Home"] = "insights-home";
185
188
  /**
186
189
  * The *Liveboards* menu option in
187
190
  * the *Insights* left navigation panel.
188
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
191
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
189
192
  */
190
193
  HomeLeftNavItem["Liveboards"] = "liveboards";
191
194
  /**
192
195
  * The *Answers* menu option in
193
196
  * the *Insights* left navigation panel.
194
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
197
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
195
198
  */
196
199
  HomeLeftNavItem["Answers"] = "answers";
197
200
  /**
198
201
  * The *Monitor subscriptions* menu option in
199
202
  * the *Insights* left navigation panel.
200
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
203
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
201
204
  */
202
205
  HomeLeftNavItem["MonitorSubscription"] = "monitor-alerts";
203
206
  /**
204
207
  * The *SpotIQ analysis* menu option in
205
208
  * the *Insights* left navigation panel.
206
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
209
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
207
210
  */
208
211
  HomeLeftNavItem["SpotIQAnalysis"] = "spotiq-analysis";
209
212
  /**
210
213
  * The *Liveboard schedules* menu option in
211
214
  * the *Insights* left navigation panel.
212
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
215
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
213
216
  */
214
217
  HomeLeftNavItem["LiveboardSchedules"] = "liveboard-schedules";
215
218
  /**
@@ -315,7 +318,7 @@ export var HomepageModule;
315
318
  */
316
319
  HomepageModule["Search"] = "SEARCH";
317
320
  /**
318
- * kPI watchlist module
321
+ * KPI watchlist module
319
322
  */
320
323
  HomepageModule["Watchlist"] = "WATCHLIST";
321
324
  /**
@@ -347,7 +350,8 @@ export var ListPageColumns;
347
350
  */
348
351
  ListPageColumns["Favorites"] = "FAVOURITE";
349
352
  /**
350
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
353
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
354
+ * @deprecated This option is deprecated.
351
355
  */
352
356
  ListPageColumns["Favourite"] = "FAVOURITE";
353
357
  /**
@@ -415,13 +419,13 @@ export var EmbedEvent;
415
419
  /**
416
420
  * Rendering has initialized.
417
421
  * @example
418
- *```js
422
+ * ```js
419
423
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
420
424
  * //show a loader
421
425
  * function showLoader() {
422
426
  * document.getElementById("loader");
423
427
  * }
424
- *```
428
+ * ```
425
429
  * @returns timestamp - The timestamp when the event was generated.
426
430
  */
427
431
  EmbedEvent["Init"] = "init";
@@ -429,11 +433,11 @@ export var EmbedEvent;
429
433
  * Authentication has either succeeded or failed.
430
434
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
431
435
  * @example
432
- *```js
436
+ * ```js
433
437
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
434
438
  * console.log('AuthInit', payload);
435
439
  * })
436
- *```
440
+ * ```
437
441
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
438
442
  */
439
443
  EmbedEvent["AuthInit"] = "authInit";
@@ -442,13 +446,13 @@ export var EmbedEvent;
442
446
  * @returns timestamp - The timestamp when the event was generated.
443
447
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
444
448
  * @example
445
- *```js
449
+ * ```js
446
450
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
447
451
  * //hide loader
448
452
  * function hideLoader() {
449
453
  * document.getElementById("loader");
450
454
  * }
451
- *```
455
+ * ```
452
456
  */
453
457
  EmbedEvent["Load"] = "load";
454
458
  /**
@@ -457,11 +461,11 @@ export var EmbedEvent;
457
461
  * @return data - Answer of Liveboard data
458
462
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
459
463
  * @example
460
- *```js
464
+ * ```js
461
465
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
462
466
  * console.log('data', payload);
463
467
  * })
464
- *```
468
+ * ```
465
469
  * @important
466
470
  */
467
471
  EmbedEvent["Data"] = "data";
@@ -469,9 +473,9 @@ export var EmbedEvent;
469
473
  * Search query has been updated by the user.
470
474
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
471
475
  * @example
472
- *```js
476
+ * ```js
473
477
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
474
- *```
478
+ * ```
475
479
  */
476
480
  EmbedEvent["QueryChanged"] = "queryChanged";
477
481
  /**
@@ -481,7 +485,7 @@ export var EmbedEvent;
481
485
  * @returns drillDownColumns - The columns on which drill down was performed
482
486
  * @returns nonFilteredColumns - The columns that were not filtered
483
487
  * @example
484
- *```js
488
+ * ```js
485
489
  * searchEmbed.on(EmbedEvent.DrillDown, {
486
490
  * points: {
487
491
  * clickedPoint,
@@ -489,12 +493,12 @@ export var EmbedEvent;
489
493
  * },
490
494
  * autoDrillDown: true,
491
495
  * })
492
- *```
496
+ * ```
493
497
  * In this example, `VizPointDoubleClick` event is used for
494
498
  * triggering the `DrillDown` event when an area or specific
495
499
  * data point on a table or chart is double-clicked.
496
500
  * @example
497
- *```js
501
+ * ```js
498
502
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
499
503
  * console.log(payload);
500
504
  * const clickedPoint = payload.data.clickedPoint;
@@ -508,7 +512,7 @@ export var EmbedEvent;
508
512
  * autoDrillDown: true,
509
513
  * })
510
514
  * })
511
- *```
515
+ * ```
512
516
  */
513
517
  EmbedEvent["Drilldown"] = "drillDown";
514
518
  /**
@@ -633,13 +637,13 @@ export var EmbedEvent;
633
637
  * The ThoughtSpot authentication session has expired.
634
638
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
635
639
  * @example
636
- *```js
640
+ * ```js
637
641
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
638
642
  * //show auth expired banner
639
643
  * function showAuthExpired() {
640
644
  * document.getElementById("authExpiredBanner");
641
645
  * }
642
- *```
646
+ * ```
643
647
  */
644
648
  EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
645
649
  /**
@@ -674,22 +678,22 @@ export var EmbedEvent;
674
678
  * Applicable to `SearchBarEmbed` only.
675
679
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
676
680
  * @example
677
- *```js
681
+ * ```js
678
682
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
679
683
  * .then(data => {
680
684
  * console.log('Answer Data:', data);
681
685
  * })
682
- *```
686
+ * ```
683
687
  */
684
688
  EmbedEvent["GetDataClick"] = "getDataClick";
685
689
  /**
686
690
  * Detects the route change.
687
691
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
688
692
  * @example
689
- *```js
693
+ * ```js
690
694
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
691
695
  * console.log('data', payload))
692
- *```
696
+ * ```
693
697
  */
694
698
  EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
695
699
  /**
@@ -699,12 +703,12 @@ export var EmbedEvent;
699
703
  EmbedEvent["V1Data"] = "exportVizDataToParent";
700
704
  /**
701
705
  * Emitted when the embed does not have cookie access. This happens
702
- * when Safari and other Web browsers block third-party cookies
703
- * are blocked by default. `NoCookieAccess` can trigger.
706
+ * when third-party cookies are blocked by Safari or other
707
+ * web browsers. `NoCookieAccess` can trigger.
704
708
  * @example
705
- *```js
709
+ * ```js
706
710
  * appEmbed.on(EmbedEvent.NoCookieAccess)
707
- *```
711
+ * ```
708
712
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
709
713
  */
710
714
  EmbedEvent["NoCookieAccess"] = "noCookieAccess";
@@ -718,22 +722,22 @@ export var EmbedEvent;
718
722
  * Emitted when any modal is opened in the app
719
723
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
720
724
  * @example
721
- *```js
725
+ * ```js
722
726
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
723
727
  * console.log('dialog open', payload);
724
728
  * })
725
- *```
729
+ * ```
726
730
  */
727
731
  EmbedEvent["DialogOpen"] = "dialog-open";
728
732
  /**
729
733
  * Emitted when any modal is closed in the app
730
734
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
731
735
  * @example
732
- *```js
736
+ * ```js
733
737
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
734
738
  * console.log('dialog close', payload);
735
739
  * })
736
- *```
740
+ * ```
737
741
  */
738
742
  EmbedEvent["DialogClose"] = "dialog-close";
739
743
  /**
@@ -742,39 +746,39 @@ export var EmbedEvent;
742
746
  * other events on the rendered Liveboard.
743
747
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
744
748
  * @example
745
- *```js
749
+ * ```js
746
750
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
747
751
  console.log('Liveboard is rendered', payload);
748
752
  })
749
- *```
753
+ * ```
750
754
  * The following example shows how to trigger
751
755
  * `SetVisibleVizs` event using LiveboardRendered embed event:
752
756
  * @example
753
- *```js
757
+ * ```js
754
758
  * const embedRef = useEmbedRef();
755
759
  * const onLiveboardRendered = () => {
756
760
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
757
761
  * };
758
- *```
762
+ * ```
759
763
  */
760
764
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
761
765
  /**
762
766
  * Emits all events.
763
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
767
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
764
768
  * @example
765
- *```js
769
+ * ```js
766
770
  * appEmbed.on(EmbedEvent.ALL, payload => {
767
771
  * console.log('Embed Events', payload)
768
772
  * })
769
- *```
773
+ * ```
770
774
  */
771
775
  EmbedEvent["ALL"] = "*";
772
776
  /**
773
777
  * Emitted when an Answer is saved in the app.
774
778
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
775
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
779
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
776
780
  * @example
777
- *```js
781
+ * ```js
778
782
  * //Emit when action starts
779
783
  * searchEmbed.on(EmbedEvent.Save, payload => {
780
784
  * console.log('Save', payload)
@@ -785,7 +789,7 @@ export var EmbedEvent;
785
789
  * searchEmbed.on(EmbedEvent.Save, payload => {
786
790
  * console.log('Save', payload)
787
791
  * })
788
- *```
792
+ * ```
789
793
  */
790
794
  EmbedEvent["Save"] = "save";
791
795
  /**
@@ -797,106 +801,112 @@ export var EmbedEvent;
797
801
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
798
802
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
799
803
  * @example
800
- *```js
804
+ * ```js
801
805
  * liveboardEmbed.on(EmbedEvent.Download, {
802
806
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
803
807
  * })
804
- *```
808
+ * ```
805
809
  */
806
810
  EmbedEvent["Download"] = "download";
807
811
  /**
808
812
  * Emitted when the download action is triggered on an Answer.
809
- * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
813
+ * Use start:true to subscribe to when download is initiated, or end:true to
814
+ * subscribe to when download is completed. Default is end:true.
810
815
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
811
816
  * @example
812
- *```js
817
+ * ```js
813
818
  * //emit when action starts
814
819
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
815
820
  * console.log('download PNG', payload)}, {start: true })
816
821
  * //emit when action ends
817
822
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
818
823
  * console.log('download PNG', payload)})
819
- *```
824
+ * ```
820
825
  */
821
826
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
822
827
  /**
823
828
  * Emitted when the Download as PDF action is triggered on an Answer
824
- * Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.
829
+ * Use start:true to subscribe to when download as PDF is initiated, or end:true to
830
+ * subscribe to when download as PDF is completed. Default is end:true.
825
831
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
826
832
  * @example
827
- *```js
833
+ * ```js
828
834
  * //emit when action starts
829
835
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
830
836
  * console.log('download PDF', payload)}, {start: true })
831
837
  * //emit when action ends
832
838
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
833
839
  * console.log('download PDF', payload)})
834
- *```
840
+ * ```
835
841
  */
836
842
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
837
843
  /**
838
844
  * Emitted when the Download as CSV action is triggered on an Answer.
839
- * Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.
845
+ * Use start:true to subscribe to when download as CSV is initiated, or end:true to
846
+ * subscribe to when download as CSV is completed. Default is end:true.
840
847
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
841
848
  * @example
842
- *```js
849
+ * ```js
843
850
  * //emit when action starts
844
851
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
845
852
  * console.log('download CSV', payload)}, {start: true })
846
853
  * //emit when action ends
847
854
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
848
855
  * console.log('download CSV', payload)})
849
- *```
856
+ * ```
850
857
  */
851
858
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
852
859
  /**
853
860
  * Emitted when the Download as XLSX action is triggered on an Answer.
854
- * Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.
861
+ * Use start:true to subscribe to when download as XLSX is initiated, or end:true to
862
+ * subscribe to when download as XLSX is completed. Default is end:true.
855
863
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
856
864
  * @example
857
- *```js
865
+ * ```js
858
866
  * //emit when action starts
859
867
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
860
868
  * console.log('download Xlsx', payload)}, { start: true })
861
869
  * //emit when action ends
862
870
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
863
871
  * console.log('download Xlsx', payload)})
864
- *```
872
+ * ```
865
873
  */
866
874
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
867
875
  /**
868
876
  * Emitted when an Answer is deleted in the app
869
- * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
877
+ * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
878
+ * to when delete is completed. Default is end:true.
870
879
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
871
880
  * @example
872
- *```js
881
+ * ```js
873
882
  * //emit when action starts
874
883
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
875
884
  * console.log('delete answer', payload)}, {start: true })
876
885
  * //trigger when action is completed
877
886
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
878
887
  * console.log('delete answer', payload)})
879
- *```
888
+ * ```
880
889
  */
881
890
  EmbedEvent["AnswerDelete"] = "answerDelete";
882
891
  /**
883
892
  * Emitted when the AI Highlights action is triggered on a Liveboard
884
893
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
885
894
  * @example
886
- *```js
895
+ * ```js
887
896
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
888
897
  * console.log('AI Highlights', payload);
889
898
  * })
890
- *```
899
+ * ```
891
900
  */
892
901
  EmbedEvent["AIHighlights"] = "AIHighlights";
893
902
  /**
894
903
  * Emitted when a user initiates the Pin action to
895
904
  * add an Answer to a Liveboard.
896
- * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
905
+ * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
906
+ * when pin is completed. Default is end:true.
897
907
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
898
908
  * @example
899
- *```js
909
+ * ```js
900
910
  * //emit when action starts
901
911
  * searchEmbed.on(EmbedEvent.Pin, payload => {
902
912
  * console.log('pin', payload)
@@ -907,14 +917,14 @@ export var EmbedEvent;
907
917
  * searchEmbed.on(EmbedEvent.Pin, payload => {
908
918
  * console.log('pin', payload)
909
919
  * })
910
- *```
920
+ * ```
911
921
  */
912
922
  EmbedEvent["Pin"] = "pin";
913
923
  /**
914
924
  * Emitted when SpotIQ analysis is triggered
915
925
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
916
926
  * @example
917
- *```js
927
+ * ```js
918
928
  * //emit when action starts
919
929
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
920
930
  * console.log('SpotIQAnalyze', payload)
@@ -925,14 +935,14 @@ export var EmbedEvent;
925
935
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
926
936
  * console.log('SpotIQ analyze', payload)
927
937
  * })
928
- *```
938
+ * ```
929
939
  */
930
940
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
931
941
  /**
932
942
  * Emitted when a user shares an object with another user or group
933
943
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
934
944
  * @example
935
- *```js
945
+ * ```js
936
946
  * //emit when action starts
937
947
  * searchEmbed.on(EmbedEvent.Share, payload => {
938
948
  * console.log('Share', payload)
@@ -943,7 +953,7 @@ export var EmbedEvent;
943
953
  * searchEmbed.on(EmbedEvent.Share, payload => {
944
954
  * console.log('Share', payload)
945
955
  * })
946
- *```
956
+ * ```
947
957
  */
948
958
  EmbedEvent["Share"] = "share";
949
959
  /**
@@ -951,11 +961,11 @@ export var EmbedEvent;
951
961
  * data on a chart or table.
952
962
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
953
963
  * @example
954
- *```js
964
+ * ```js
955
965
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
956
966
  * console.log('Drill include', payload);
957
967
  * })
958
- *```
968
+ * ```
959
969
  */
960
970
  EmbedEvent["DrillInclude"] = "context-menu-item-include";
961
971
  /**
@@ -963,22 +973,22 @@ export var EmbedEvent;
963
973
  * data on a chart or table
964
974
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
965
975
  * @example
966
- *```js
976
+ * ```js
967
977
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
968
978
  * console.log('Drill exclude', payload);
969
979
  * })
970
- *```
980
+ * ```
971
981
  */
972
982
  EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
973
983
  /**
974
984
  * Emitted when a column value is copied in the embedded app.
975
985
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
976
986
  * @example
977
- *```js
978
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
987
+ * ```js
988
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
979
989
  * console.log('copy to clipboard', payload);
980
990
  * })
981
- *```
991
+ * ```
982
992
  */
983
993
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
984
994
  /**
@@ -986,10 +996,10 @@ export var EmbedEvent;
986
996
  * embedded Liveboard.
987
997
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
988
998
  * @example
989
- *```js
999
+ * ```js
990
1000
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
991
1001
  * })
992
- *```
1002
+ * ```
993
1003
  */
994
1004
  EmbedEvent["UpdateTML"] = "updateTSL";
995
1005
  /**
@@ -997,75 +1007,77 @@ export var EmbedEvent;
997
1007
  * on an embedded Liveboard.
998
1008
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
999
1009
  * @example
1000
- *```js
1010
+ * ```js
1001
1011
  * appEmbed.on(EmbedEvent.EditTML, payload => {
1002
1012
  * console.log('Edit TML', payload);
1003
1013
  * })
1004
- *```
1014
+ * ```
1005
1015
  */
1006
1016
  EmbedEvent["EditTML"] = "editTSL";
1007
1017
  /**
1008
1018
  * Emitted when the **Export TML** action is triggered on an
1009
1019
  * an embedded object in the app
1010
- * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
1020
+ * Use start:true to subscribe to when export is initiated, or end:true to subscribe
1021
+ * to when export is completed. Default is end:true.
1011
1022
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1012
1023
  * @example
1013
- *```js
1024
+ * ```js
1014
1025
  * //emit when action starts
1015
1026
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
1016
1027
  * console.log('Export TML', payload)}, { start: true })
1017
1028
  * //emit when action ends
1018
1029
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
1019
1030
  * console.log('Export TML', payload)})
1020
- *```
1031
+ * ```
1021
1032
  */
1022
1033
  EmbedEvent["ExportTML"] = "exportTSL";
1023
1034
  /**
1024
1035
  * Emitted when an Answer is saved as a View.
1025
1036
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1026
1037
  * @example
1027
- *```js
1038
+ * ```js
1028
1039
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
1029
1040
  * console.log('View', payload);
1030
1041
  * })
1031
- *```
1042
+ * ```
1032
1043
  */
1033
1044
  EmbedEvent["SaveAsView"] = "saveAsView";
1034
1045
  /**
1035
1046
  * Emitted when the user creates a copy of an Answer.
1036
- * Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.
1047
+ * Use start:true to subscribe to when copy and edit is initiated, or end:true to
1048
+ * subscribe to when copy and edit is completed. Default is end:true.
1037
1049
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1038
1050
  * @example
1039
- *```js
1051
+ * ```js
1040
1052
  * //emit when action starts
1041
1053
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
1042
1054
  * console.log('Copy and edit', payload)}, {start: true })
1043
1055
  * //emit when action ends
1044
1056
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
1045
1057
  * console.log('Copy and edit', payload)})
1046
- *```
1058
+ * ```
1047
1059
  */
1048
1060
  EmbedEvent["CopyAEdit"] = "copyAEdit";
1049
1061
  /**
1050
1062
  * Emitted when a user clicks *Show underlying data* on an Answer.
1051
1063
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1052
1064
  * @example
1053
- *```js
1065
+ * ```js
1054
1066
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
1055
1067
  * console.log('show data', payload);
1056
1068
  * })
1057
- *```
1069
+ * ```
1058
1070
  */
1059
1071
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
1060
1072
  /**
1061
1073
  * Emitted when an Answer is switched to a chart or table view.
1062
1074
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1063
1075
  * @example
1064
- *```js
1076
+ * ```js
1065
1077
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
1066
1078
  * console.log('switch view', payload);
1067
1079
  * })
1068
- *```
1080
+ * ```
1069
1081
  */
1070
1082
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
1071
1083
  /**
@@ -1082,118 +1094,118 @@ export var EmbedEvent;
1082
1094
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
1083
1095
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1084
1096
  * @example
1085
- *```js
1097
+ * ```js
1086
1098
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
1087
1099
  * console.log('Liveboard details', payload);
1088
1100
  * })
1089
- *```
1101
+ * ```
1090
1102
  */
1091
1103
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
1092
1104
  /**
1093
1105
  * Emitted when a user clicks on the Favorite icon on a Liveboard
1094
1106
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1095
1107
  * @example
1096
- *```js
1108
+ * ```js
1097
1109
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
1098
1110
  * console.log('favorites', payload);
1099
1111
  * })
1100
- *```
1112
+ * ```
1101
1113
  */
1102
1114
  EmbedEvent["AddToFavorites"] = "addToFavorites";
1103
1115
  /**
1104
1116
  * Emitted when a user clicks **Schedule** on a Liveboard
1105
1117
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1106
1118
  * @example
1107
- *```js
1119
+ * ```js
1108
1120
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
1109
- * console.log(`Liveboard schedule', payload);
1121
+ * console.log('Liveboard schedule', payload);
1110
1122
  * })
1111
- *```
1123
+ * ```
1112
1124
  */
1113
1125
  EmbedEvent["Schedule"] = "subscription";
1114
1126
  /**
1115
1127
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
1116
1128
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1117
1129
  * @example
1118
- *```js
1130
+ * ```js
1119
1131
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
1120
- * console.log(`Liveboard edit', payload);
1132
+ * console.log('Liveboard edit', payload);
1121
1133
  * })
1122
- *```
1134
+ * ```
1123
1135
  */
1124
1136
  EmbedEvent["Edit"] = "edit";
1125
1137
  /**
1126
1138
  * Emitted when a user clicks *Make a copy* on a Liveboard
1127
1139
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1128
1140
  * @example
1129
- *```js
1141
+ * ```js
1130
1142
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
1131
- * console.log(`Copy', payload);
1143
+ * console.log('Copy', payload);
1132
1144
  * })
1133
- *```
1145
+ * ```
1134
1146
  */
1135
1147
  EmbedEvent["MakeACopy"] = "makeACopy";
1136
1148
  /**
1137
1149
  * Emitted when a user clicks **Present** on a Liveboard or visualization
1138
1150
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1139
1151
  * @example
1140
- *```js
1152
+ * ```js
1141
1153
  * liveboardEmbed.on(EmbedEvent.Present)
1142
- *```
1154
+ * ```
1143
1155
  * @example
1144
- *```js
1156
+ * ```js
1145
1157
  * liveboardEmbed.on(EmbedEvent.Present, {
1146
1158
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1147
1159
  * })
1148
- *```
1160
+ * ```
1149
1161
  */
1150
1162
  EmbedEvent["Present"] = "present";
1151
1163
  /**
1152
1164
  * Emitted when a user clicks **Delete** on a visualization
1153
1165
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1154
1166
  * @example
1155
- *```js
1167
+ * ```js
1156
1168
  * liveboardEmbed.on(EmbedEvent.Delete,
1157
1169
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1158
- *```
1170
+ * ```
1159
1171
  */
1160
1172
  EmbedEvent["Delete"] = "delete";
1161
1173
  /**
1162
1174
  * Emitted when a user clicks Manage schedules on a Liveboard
1163
1175
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1164
1176
  * @example
1165
- *```js
1177
+ * ```js
1166
1178
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
1167
- *```
1179
+ * ```
1168
1180
  */
1169
1181
  EmbedEvent["SchedulesList"] = "schedule-list";
1170
1182
  /**
1171
1183
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
1172
1184
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1173
1185
  * @example
1174
- *```js
1186
+ * ```js
1175
1187
  * liveboardEmbed.on(EmbedEvent.Cancel)
1176
- *```
1188
+ * ```
1177
1189
  */
1178
1190
  EmbedEvent["Cancel"] = "cancel";
1179
1191
  /**
1180
1192
  * Emitted when a user clicks **Explore** on a visualization
1181
1193
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1182
1194
  * @example
1183
- *```js
1195
+ * ```js
1184
1196
  * liveboardEmbed.on(EmbedEvent.Explore, {
1185
1197
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1186
- *```
1198
+ * ```
1187
1199
  */
1188
1200
  EmbedEvent["Explore"] = "explore";
1189
1201
  /**
1190
1202
  * Emitted when a user clicks **Copy link** action on a visualization.
1191
1203
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1192
1204
  * @example
1193
- *```js
1205
+ * ```js
1194
1206
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
1195
1207
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1196
- *```
1208
+ * ```
1197
1209
  */
1198
1210
  EmbedEvent["CopyLink"] = "embedDocument";
1199
1211
  /**
@@ -1201,21 +1213,21 @@ export var EmbedEvent;
1201
1213
  * visualization or Liveboard.
1202
1214
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1203
1215
  * @example
1204
- *```js
1216
+ * ```js
1205
1217
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
1206
1218
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1207
- *```
1219
+ * ```
1208
1220
  */
1209
1221
  EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
1210
1222
  /**
1211
1223
  * Emitted when a user right clicks on a visualization (chart or table)
1212
1224
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1213
1225
  * @example
1214
- *```js
1226
+ * ```js
1215
1227
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
1216
1228
  * console.log('VizPointClick', payload)
1217
1229
  * })
1218
- *```
1230
+ * ```
1219
1231
  */
1220
1232
  EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
1221
1233
  /**
@@ -1229,35 +1241,35 @@ export var EmbedEvent;
1229
1241
  * filter details.
1230
1242
  * @example
1231
1243
  *
1232
- *```js
1244
+ * ```js
1233
1245
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
1234
1246
  * console.log('payload', payload);
1235
1247
  * })
1236
- *
1248
+ * ```
1237
1249
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
1238
1250
  */
1239
1251
  EmbedEvent["FilterChanged"] = "filterChanged";
1240
1252
  /**
1241
1253
  * Emitted when a user clicks the **Go** button to initiate
1242
1254
  * a Natural Language Search query
1243
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1255
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1244
1256
  */
1245
1257
  EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
1246
1258
  /**
1247
1259
  * Emitted when a user selects a data source on the embedded
1248
1260
  * Natural Language Search interface.
1249
1261
  *
1250
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1262
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1251
1263
  */
1252
1264
  EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
1253
1265
  /**
1254
1266
  * Emitted when a user updates a connection on the **Data** page
1255
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1267
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1256
1268
  */
1257
1269
  EmbedEvent["UpdateConnection"] = "updateConnection";
1258
1270
  /**
1259
1271
  * Emitted when a user updates a connection on the **Data** page
1260
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1272
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1261
1273
  */
1262
1274
  EmbedEvent["CreateConnection"] = "createConnection";
1263
1275
  /**
@@ -1267,7 +1279,7 @@ export var EmbedEvent;
1267
1279
  * @returns viewId: string
1268
1280
  * @returns liveboardId: string
1269
1281
  * @returns isPublic: boolean
1270
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1282
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1271
1283
  */
1272
1284
  EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
1273
1285
  /**
@@ -1276,7 +1288,7 @@ export var EmbedEvent;
1276
1288
  * @returns viewId: string
1277
1289
  * @returns liveboardId: string
1278
1290
  * @returns isPublic: boolean
1279
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1291
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1280
1292
  */
1281
1293
  EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
1282
1294
  /**
@@ -1285,19 +1297,19 @@ export var EmbedEvent;
1285
1297
  * @returns viewId: string
1286
1298
  * @returns liveboardId: string
1287
1299
  * @returns isPublic: boolean
1288
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1300
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1289
1301
  */
1290
1302
  EmbedEvent["ResetLiveboard"] = "resetLiveboard";
1291
1303
  /**
1292
1304
  * Emitted when a PersonalisedView is deleted.
1293
1305
  * @returns views: string[]
1294
1306
  * @returns liveboardId: string
1295
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1307
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1296
1308
  */
1297
1309
  EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
1298
1310
  /**
1299
1311
  * Emitted when a user creates a Worksheet.
1300
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1312
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1301
1313
  */
1302
1314
  EmbedEvent["CreateWorksheet"] = "createWorksheet";
1303
1315
  /**
@@ -1306,12 +1318,12 @@ export var EmbedEvent;
1306
1318
  * @returns viewId: string
1307
1319
  * @returns liveboardId: string
1308
1320
  * @returns isPublic: boolean
1309
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
1321
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
1310
1322
  */
1311
1323
  EmbedEvent["AskSageInit"] = "AskSageInit";
1312
1324
  /**
1313
1325
  * Emitted when a Liveboard or visualization is renamed.
1314
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
1326
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
1315
1327
  */
1316
1328
  EmbedEvent["Rename"] = "rename";
1317
1329
  /**
@@ -1334,7 +1346,7 @@ export var EmbedEvent;
1334
1346
  * - `error` - Developers can customize the user-facing error message when `execute`
1335
1347
  * is `false` by using the `error` parameters in `responder`.
1336
1348
  * - `errorText` - The error message text shown to the user.
1337
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
1349
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
1338
1350
  * @example
1339
1351
  *
1340
1352
  * This example blocks search operation and returns a custom error message:
@@ -1386,8 +1398,8 @@ export var EmbedEvent;
1386
1398
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
1387
1399
  * console.log('payload', payload);
1388
1400
  * })
1389
- *```
1390
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
1401
+ * ```
1402
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
1391
1403
  */
1392
1404
  EmbedEvent["ParameterChanged"] = "parameterChanged";
1393
1405
  /**
@@ -1442,24 +1454,24 @@ export var EmbedEvent;
1442
1454
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
1443
1455
  * console.log('payload', payload);
1444
1456
  * })
1445
- *```
1446
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
1457
+ * ```
1458
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
1447
1459
  */
1448
1460
  EmbedEvent["CreateLiveboard"] = "createLiveboard";
1449
1461
  /**
1450
1462
  * Emitted when a user creates a Model.
1451
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
1463
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
1452
1464
  */
1453
1465
  EmbedEvent["CreateModel"] = "createModel";
1454
1466
  /**
1455
1467
  * @hidden
1456
1468
  * Emitted when a user exits present mode.
1457
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
1469
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1458
1470
  */
1459
1471
  EmbedEvent["ExitPresentMode"] = "exitPresentMode";
1460
1472
  /**
1461
1473
  * Emitted when a user requests the full height lazy load data.
1462
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
1474
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1463
1475
  * @hidden
1464
1476
  */
1465
1477
  EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
@@ -1470,7 +1482,7 @@ export var EmbedEvent;
1470
1482
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
1471
1483
  * console.log('payload', payload);
1472
1484
  * })
1473
- *```
1485
+ * ```
1474
1486
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1475
1487
  */
1476
1488
  EmbedEvent["SpotterData"] = "SpotterData";
@@ -1481,7 +1493,7 @@ export var EmbedEvent;
1481
1493
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
1482
1494
  * console.log('payload', payload);
1483
1495
  * })
1484
- *```
1496
+ * ```
1485
1497
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1486
1498
  */
1487
1499
  EmbedEvent["PreviewSpotterData"] = "PreviewSpotterData";
@@ -1492,7 +1504,7 @@ export var EmbedEvent;
1492
1504
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
1493
1505
  * console.log('payload', payload);
1494
1506
  * })
1495
- *```
1507
+ * ```
1496
1508
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
1497
1509
  */
1498
1510
  EmbedEvent["AddToCoaching"] = "addToCoaching";
@@ -1514,7 +1526,7 @@ export var EmbedEvent;
1514
1526
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
1515
1527
  * console.log('payload', payload);
1516
1528
  * })
1517
- *```
1529
+ * ```
1518
1530
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1519
1531
  */
1520
1532
  EmbedEvent["SpotterQueryTriggered"] = "SpotterQueryTriggered";
@@ -1525,7 +1537,7 @@ export var EmbedEvent;
1525
1537
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
1526
1538
  * console.log('payload', payload);
1527
1539
  * })
1528
- *```
1540
+ * ```
1529
1541
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1530
1542
  */
1531
1543
  EmbedEvent["LastPromptEdited"] = "LastPromptEdited";
@@ -1536,18 +1548,18 @@ export var EmbedEvent;
1536
1548
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
1537
1549
  * console.log('payload', payload);
1538
1550
  * })
1539
- *```
1551
+ * ```
1540
1552
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1541
1553
  */
1542
1554
  EmbedEvent["LastPromptDeleted"] = "LastPromptDeleted";
1543
1555
  /**
1544
- * Emitted when the coversation is reset in spotter embed.
1556
+ * Emitted when the conversation is reset in Spotter embed.
1545
1557
  * @example
1546
1558
  * ```js
1547
1559
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
1548
1560
  * console.log('payload', payload);
1549
1561
  * })
1550
- *```
1562
+ * ```
1551
1563
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1552
1564
  */
1553
1565
  EmbedEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
@@ -1558,7 +1570,7 @@ export var EmbedEvent;
1558
1570
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
1559
1571
  * console.log('payload', payload);
1560
1572
  * })
1561
- *```
1573
+ * ```
1562
1574
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
1563
1575
  */
1564
1576
  EmbedEvent["SpotterInit"] = "spotterInit";
@@ -1569,7 +1581,7 @@ export var EmbedEvent;
1569
1581
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
1570
1582
  * console.log('payload', payload);
1571
1583
  * })
1572
- *```
1584
+ * ```
1573
1585
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
1574
1586
  */
1575
1587
  EmbedEvent["SpotterLoadComplete"] = "spotterLoadComplete";
@@ -1797,7 +1809,8 @@ export var HostEvent;
1797
1809
  * - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
1798
1810
  * on the most popular column.
1799
1811
  * - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
1800
- * of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
1812
+ * of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
1813
+ * **required**.
1801
1814
  * @example
1802
1815
  * ```js
1803
1816
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -1924,7 +1937,7 @@ export var HostEvent;
1924
1937
  * ```js
1925
1938
  * appEmbed.navigateToPage(-1)
1926
1939
  * ```
1927
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
1940
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
1928
1941
  */
1929
1942
  HostEvent["Navigate"] = "Navigate";
1930
1943
  /**
@@ -1993,7 +2006,8 @@ export var HostEvent;
1993
2006
  * the following parameters:
1994
2007
  *
1995
2008
  * @param - Includes the following keys:
1996
- * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
2009
+ * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
2010
+ * Liveboard.
1997
2011
  * Optional when pinning a new chart or table generated from a Search query.
1998
2012
  * **Required** in Spotter Embed.
1999
2013
  * - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
@@ -2057,9 +2071,9 @@ export var HostEvent;
2057
2071
  * Trigger the **Show Liveboard details** action
2058
2072
  * on an embedded Liveboard.
2059
2073
  * @example
2060
- *```js
2074
+ * ```js
2061
2075
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
2062
- *```
2076
+ * ```
2063
2077
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2064
2078
  */
2065
2079
  HostEvent["LiveboardInfo"] = "pinboardInfo";
@@ -2187,7 +2201,7 @@ export var HostEvent;
2187
2201
  * appEmbed.trigger(HostEvent.Remove)
2188
2202
  * ```
2189
2203
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2190
- * * @example
2204
+ * @example
2191
2205
  * ```js
2192
2206
  * liveboardEmbed.trigger(HostEvent.Remove)
2193
2207
  * ```
@@ -2249,7 +2263,8 @@ export var HostEvent;
2249
2263
  * This event is not supported in visualization embed and search embed.
2250
2264
  * @param - Object parameter. Includes the following keys:
2251
2265
  * - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
2252
- * pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
2266
+ * pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
2267
+ * is **required**.
2253
2268
  *
2254
2269
  * @example
2255
2270
  * ```js
@@ -2278,7 +2293,7 @@ export var HostEvent;
2278
2293
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2279
2294
  * ```
2280
2295
  * ```js
2281
- * vizEmbed.trigger((HostEvent.CopyLink)
2296
+ * vizEmbed.trigger(HostEvent.CopyLink)
2282
2297
  * ```
2283
2298
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2284
2299
  */
@@ -2295,7 +2310,7 @@ export var HostEvent;
2295
2310
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2296
2311
  * ```
2297
2312
  * ```js
2298
- * vizEmbed.trigger((HostEvent.Present)
2313
+ * vizEmbed.trigger(HostEvent.Present)
2299
2314
  * ```
2300
2315
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2301
2316
  */
@@ -2310,23 +2325,22 @@ export var HostEvent;
2310
2325
  * );
2311
2326
  * })
2312
2327
  * ```
2313
- * * @example
2328
+ * @example
2314
2329
  * ```js
2315
-
2316
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
2317
- * let latestSpotterVizId = '';
2318
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
2319
- * latestSpotterVizId = payload.data.id;
2320
- * });
2321
- *
2322
- * spotterEmbed.trigger(HostEvent.GetTML, {
2330
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
2331
+ * let latestSpotterVizId = '';
2332
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
2333
+ * latestSpotterVizId = payload.data.id;
2334
+ * });
2335
+ *
2336
+ * spotterEmbed.trigger(HostEvent.GetTML, {
2323
2337
  * vizId: latestSpotterVizId
2324
2338
  * }).then((tml) => {
2325
2339
  * console.log(
2326
2340
  * tml.answer.search_query // TML representation of the search query
2327
2341
  * );
2328
2342
  * })
2329
- * ```
2343
+ * ```
2330
2344
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2331
2345
  * @important
2332
2346
  */
@@ -2390,6 +2404,11 @@ export var HostEvent;
2390
2404
  /**
2391
2405
  * Trigger the **Download** action on charts in
2392
2406
  * the embedded view.
2407
+ * Use {@link HostEvent.DownloadAsPng} instead.
2408
+ *
2409
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2410
+ *
2411
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
2393
2412
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
2394
2413
  * @example
2395
2414
  * ```js
@@ -2408,9 +2427,6 @@ export var HostEvent;
2408
2427
  *
2409
2428
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
2410
2429
  * ```
2411
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
2412
- * Use {@link DownloadAsPng}
2413
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2414
2430
  */
2415
2431
  HostEvent["Download"] = "downloadAsPng";
2416
2432
  /**
@@ -2617,8 +2633,9 @@ export var HostEvent;
2617
2633
  /**
2618
2634
  * Update one or several filters applied on a Liveboard.
2619
2635
  * @param - Includes the following keys:
2620
- * - `filter`: A single filter object containing column name, filter operator, and values.
2621
- * - `filters`: Multiple filter objects with column name, filter operator, and values for each.
2636
+ * - `filter`: A single filter object containing column name, filter operator, and
2637
+ * values. - `filters`: Multiple filter objects with column name, filter operator,
2638
+ * and values for each.
2622
2639
  *
2623
2640
  * Each filter object must include the following attributes:
2624
2641
  *
@@ -2848,8 +2865,8 @@ export var HostEvent;
2848
2865
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
2849
2866
  * console.log('parameters', parameter);
2850
2867
  * });
2851
- *```
2852
- *```js
2868
+ * ```
2869
+ * ```js
2853
2870
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
2854
2871
  * let latestSpotterVizId = '';
2855
2872
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -2857,7 +2874,7 @@ export var HostEvent;
2857
2874
  * });
2858
2875
  *
2859
2876
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
2860
- *```
2877
+ * ```
2861
2878
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
2862
2879
  */
2863
2880
  HostEvent["GetParameters"] = "GetParameters";
@@ -2874,7 +2891,7 @@ export var HostEvent;
2874
2891
  * Notify when info call is completed successfully
2875
2892
  * ```js
2876
2893
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
2877
- *```
2894
+ * ```
2878
2895
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2879
2896
  */
2880
2897
  HostEvent["InfoSuccess"] = "InfoSuccess";
@@ -2887,8 +2904,8 @@ export var HostEvent;
2887
2904
  * triggered with a modal to prompt users to
2888
2905
  * add a name and description for the Answer.
2889
2906
  * @param - Includes the following keys:
2890
- * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
2891
- * - `name`: Optional. Name string for the Answer.
2907
+ * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
2908
+ * embed. - `name`: Optional. Name string for the Answer.
2892
2909
  * - `description`: Optional. Description text for the Answer.
2893
2910
  * @example
2894
2911
  * ```js
@@ -2977,7 +2994,7 @@ export var HostEvent;
2977
2994
  * ```js
2978
2995
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
2979
2996
  *
2980
- *```
2997
+ * ```
2981
2998
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
2982
2999
  */
2983
3000
  HostEvent["AddToCoaching"] = "addToCoaching";
@@ -3019,7 +3036,7 @@ export var HostEvent;
3019
3036
  * });
3020
3037
  *
3021
3038
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
3022
- *```
3039
+ * ```
3023
3040
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3024
3041
  */
3025
3042
  HostEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
@@ -3029,7 +3046,7 @@ export var HostEvent;
3029
3046
  * This is automatically triggered by the SDK when fullscreen mode is exited.
3030
3047
  * ```js
3031
3048
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
3032
- *```
3049
+ * ```
3033
3050
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3034
3051
  */
3035
3052
  HostEvent["ExitPresentMode"] = "exitPresentMode";
@@ -3083,8 +3100,9 @@ export var HostEvent;
3083
3100
  /**
3084
3101
  * Triggers a new conversation in Spotter embed.
3085
3102
  *
3086
- * This feature is available only when chat history is enabled on your ThoughtSpot instance.
3087
- * Contact your admin or ThoughtSpot Support to enable chat history on your instance.
3103
+ * This feature is available only when chat history is enabled on your ThoughtSpot
3104
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
3105
+ * instance.
3088
3106
  *
3089
3107
  * @example
3090
3108
  * ```js
@@ -3130,6 +3148,7 @@ export var DataSourceVisualMode;
3130
3148
  */
3131
3149
  export var Param;
3132
3150
  (function (Param) {
3151
+ Param["Tsmcp"] = "tsmcp";
3133
3152
  Param["EmbedApp"] = "embedApp";
3134
3153
  Param["DataSources"] = "dataSources";
3135
3154
  Param["DataSourceMode"] = "dataSourceMode";
@@ -3179,6 +3198,7 @@ export var Param;
3179
3198
  // 'both' clicks in `contextMenuTrigger` configuration.
3180
3199
  Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
3181
3200
  Param["LinkOverride"] = "linkOverride";
3201
+ Param["EnableLinkOverridesV2"] = "enableLinkOverridesV2";
3182
3202
  Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
3183
3203
  Param["ShowInsertToSlide"] = "insertInToSlide";
3184
3204
  Param["PrimaryNavHidden"] = "primaryNavHidden";
@@ -3273,6 +3293,7 @@ export var Param;
3273
3293
  Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
3274
3294
  Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
3275
3295
  Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
3296
+ Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
3276
3297
  })(Param || (Param = {}));
3277
3298
  /**
3278
3299
  * ThoughtSpot application pages include actions and menu commands
@@ -3432,14 +3453,14 @@ export var Action;
3432
3453
  * ```js
3433
3454
  * disabledActions: [Action.CollapseDataPanel]
3434
3455
  * ```
3435
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
3456
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
3436
3457
  */
3437
3458
  Action["CollapseDataSources"] = "collapseDataSources";
3438
3459
  /**
3439
3460
  * The **Collapse data panel** icon on the Search page.
3440
3461
  * Collapses the data panel view.
3441
3462
  *
3442
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3463
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3443
3464
  *
3444
3465
  * @example
3445
3466
  * ```js
@@ -3886,13 +3907,12 @@ export var Action;
3886
3907
  */
3887
3908
  Action["CreateMonitor"] = "createMonitor";
3888
3909
  /**
3889
- * @deprecated
3890
- * Reports errors
3910
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3911
+ * @deprecated This action is deprecated. It was used for reporting errors.
3891
3912
  * @example
3892
3913
  * ```js
3893
3914
  * disabledActions: [Action.ReportError]
3894
3915
  * ```
3895
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3896
3916
  */
3897
3917
  Action["ReportError"] = "reportError";
3898
3918
  /**
@@ -3902,7 +3922,7 @@ export var Action;
3902
3922
  * ```js
3903
3923
  * disabledActions: [Action.SyncToSheets]
3904
3924
  * ```
3905
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3925
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3906
3926
  */
3907
3927
  Action["SyncToSheets"] = "sync-to-sheets";
3908
3928
  /**
@@ -3913,7 +3933,7 @@ export var Action;
3913
3933
  * ```js
3914
3934
  * disabledActions: [Action.SyncToOtherApps]
3915
3935
  * ```
3916
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3936
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3917
3937
  */
3918
3938
  Action["SyncToOtherApps"] = "sync-to-other-apps";
3919
3939
  /**
@@ -3923,7 +3943,7 @@ export var Action;
3923
3943
  * ```js
3924
3944
  * disabledActions: [Action.ManagePipelines]
3925
3945
  * ```
3926
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3946
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3927
3947
  */
3928
3948
  Action["ManagePipelines"] = "manage-pipeline";
3929
3949
  /**
@@ -4235,7 +4255,7 @@ export var Action;
4235
4255
  * ```js
4236
4256
  * disabledActions: [Action.PersonalisedViewsDropdown]
4237
4257
  * ```
4238
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4258
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4239
4259
  */
4240
4260
  Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
4241
4261
  /**
@@ -4245,7 +4265,7 @@ export var Action;
4245
4265
  * ```js
4246
4266
  * disabledActions: [Action.LiveboardUsers]
4247
4267
  * ```
4248
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4268
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4249
4269
  */
4250
4270
  Action["LiveboardUsers"] = "liveboardUsers";
4251
4271
  /**
@@ -4263,7 +4283,7 @@ export var Action;
4263
4283
  * hiddenAction: [Action.TML] // hide all TML actions
4264
4284
  * disabledActions: [Action.TML] // to disable all TML actions
4265
4285
  * ```
4266
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
4286
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
4267
4287
  */
4268
4288
  Action["TML"] = "tml";
4269
4289
  /**
@@ -4309,7 +4329,7 @@ export var Action;
4309
4329
  * ```js
4310
4330
  * disabledActions: [Action.AddToWatchlist]
4311
4331
  * ```
4312
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
4332
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
4313
4333
  */
4314
4334
  Action["AddToWatchlist"] = "addToWatchlist";
4315
4335
  /**
@@ -4319,7 +4339,7 @@ export var Action;
4319
4339
  * ```js
4320
4340
  * disabledActions: [Action.RemoveFromWatchlist]
4321
4341
  * ```
4322
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
4342
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
4323
4343
  */
4324
4344
  Action["RemoveFromWatchlist"] = "removeFromWatchlist";
4325
4345
  /**
@@ -4330,7 +4350,7 @@ export var Action;
4330
4350
  * ```js
4331
4351
  * disabledActions: [Action.OrganiseFavourites]
4332
4352
  * ```
4333
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
4353
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
4334
4354
  */
4335
4355
  Action["OrganiseFavourites"] = "organiseFavourites";
4336
4356
  /**
@@ -4391,7 +4411,7 @@ export var Action;
4391
4411
  * ```js
4392
4412
  * disabledActions: [Action.ManageTags]
4393
4413
  * ```
4394
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4414
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4395
4415
  */
4396
4416
  Action["ManageTags"] = "manageTags";
4397
4417
  /**
@@ -5023,7 +5043,9 @@ export var ErrorDetailsTypes;
5023
5043
  ErrorDetailsTypes["NETWORK"] = "NETWORK";
5024
5044
  })(ErrorDetailsTypes || (ErrorDetailsTypes = {}));
5025
5045
  /**
5026
- * Error codes for identifying specific issues in embedded ThoughtSpot components. Use {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error handling and debugging.
5046
+ * Error codes for identifying specific issues in embedded ThoughtSpot components. Use
5047
+ * {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error
5048
+ * handling and debugging.
5027
5049
  *
5028
5050
  * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
5029
5051
  * @group Error Handling