@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/cjs/src/types.js CHANGED
@@ -9,7 +9,7 @@
9
9
  Object.defineProperty(exports, "__esModule", { value: true });
10
10
  exports.InterceptedApiType = exports.ContextType = exports.EmbedErrorCodes = exports.ErrorDetailsTypes = exports.LogLevel = exports.CustomActionTarget = exports.CustomActionsPosition = exports.ContextMenuTriggerOptions = exports.PrefetchFeatures = exports.Action = exports.Param = exports.DataSourceVisualMode = exports.HostEvent = exports.EmbedEvent = exports.ListPageColumns = exports.HomepageModule = exports.RuntimeFilterOp = exports.HomeLeftNavItem = exports.AuthType = void 0;
11
11
  /**
12
- * The authentication mechanism for allowing access to the
12
+ * The authentication mechanism for allowing access to
13
13
  * the embedded app
14
14
  * @group Authentication / Init
15
15
  */
@@ -35,6 +35,7 @@ var AuthType;
35
35
  * To use this:
36
36
  * Your SAML or OpenID provider must allow iframe redirects.
37
37
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
38
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
38
39
  * @example
39
40
  * ```js
40
41
  * init({
@@ -42,18 +43,17 @@ var AuthType;
42
43
  * authType: AuthType.EmbeddedSSO,
43
44
  * });
44
45
  * ```
45
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
46
46
  */
47
47
  AuthType["EmbeddedSSO"] = "EmbeddedSSO";
48
48
  /**
49
- * SSO using SAML
50
- * @deprecated Use {@link SAMLRedirect} instead
49
+ * SSO using SAML, Use {@link SAMLRedirect} instead
50
+ * @deprecated This option is deprecated.
51
51
  * @hidden
52
52
  */
53
53
  AuthType["SSO"] = "SSO_SAML";
54
54
  /**
55
- * SSO using SAML
56
- * @deprecated Use {@link SAMLRedirect} instead
55
+ * SSO using SAML, Use {@link SAMLRedirect} instead
56
+ * @deprecated This option is deprecated.
57
57
  * @hidden
58
58
  */
59
59
  AuthType["SAML"] = "SSO_SAML";
@@ -104,8 +104,9 @@ var AuthType;
104
104
  AuthType["SAMLRedirect"] = "SSO_SAML";
105
105
  /**
106
106
  * SSO using OIDC
107
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
108
+ * @deprecated This option is deprecated.
107
109
  * @hidden
108
- * @deprecated Use {@link OIDCRedirect} instead
109
110
  */
110
111
  AuthType["OIDC"] = "SSO_OIDC";
111
112
  /**
@@ -116,8 +117,9 @@ var AuthType;
116
117
  AuthType["OIDCRedirect"] = "SSO_OIDC";
117
118
  /**
118
119
  * Trusted authentication server
120
+ * Use {@link TrustedAuth} instead
121
+ * @deprecated This option is deprecated.
119
122
  * @hidden
120
- * @deprecated Use {@link TrustedAuth} instead
121
123
  */
122
124
  AuthType["AuthServer"] = "AuthServer";
123
125
  /**
@@ -144,6 +146,7 @@ var AuthType;
144
146
  * obtained from ThoughtSpot. This uses a cookieless authentication
145
147
  * approach, recommended to bypass the third-party cookie-blocking restriction
146
148
  * implemented by some browsers.
149
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
147
150
  * @example
148
151
  * ```js
149
152
  * init({
@@ -154,8 +157,8 @@ var AuthType;
154
157
  * .then((response) => response.json())
155
158
  * .then((data) => data.token);
156
159
  * }
160
+ * });
157
161
  * ```
158
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
159
162
  */
160
163
  AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
161
164
  /**
@@ -176,43 +179,43 @@ var HomeLeftNavItem;
176
179
  /**
177
180
  * The *Search data* option in
178
181
  * the *Insights* left navigation panel.
179
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
182
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
180
183
  */
181
184
  HomeLeftNavItem["SearchData"] = "search-data";
182
185
  /**
183
186
  * The *Home* menu option in
184
187
  * the *Insights* left navigation panel.
185
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
188
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
186
189
  */
187
190
  HomeLeftNavItem["Home"] = "insights-home";
188
191
  /**
189
192
  * The *Liveboards* menu option in
190
193
  * the *Insights* left navigation panel.
191
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
194
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
192
195
  */
193
196
  HomeLeftNavItem["Liveboards"] = "liveboards";
194
197
  /**
195
198
  * The *Answers* menu option in
196
199
  * the *Insights* left navigation panel.
197
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
200
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
198
201
  */
199
202
  HomeLeftNavItem["Answers"] = "answers";
200
203
  /**
201
204
  * The *Monitor subscriptions* menu option in
202
205
  * the *Insights* left navigation panel.
203
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
206
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
204
207
  */
205
208
  HomeLeftNavItem["MonitorSubscription"] = "monitor-alerts";
206
209
  /**
207
210
  * The *SpotIQ analysis* menu option in
208
211
  * the *Insights* left navigation panel.
209
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
212
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
210
213
  */
211
214
  HomeLeftNavItem["SpotIQAnalysis"] = "spotiq-analysis";
212
215
  /**
213
216
  * The *Liveboard schedules* menu option in
214
217
  * the *Insights* left navigation panel.
215
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
218
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
216
219
  */
217
220
  HomeLeftNavItem["LiveboardSchedules"] = "liveboard-schedules";
218
221
  /**
@@ -318,7 +321,7 @@ var HomepageModule;
318
321
  */
319
322
  HomepageModule["Search"] = "SEARCH";
320
323
  /**
321
- * kPI watchlist module
324
+ * KPI watchlist module
322
325
  */
323
326
  HomepageModule["Watchlist"] = "WATCHLIST";
324
327
  /**
@@ -350,7 +353,8 @@ var ListPageColumns;
350
353
  */
351
354
  ListPageColumns["Favorites"] = "FAVOURITE";
352
355
  /**
353
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
356
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
357
+ * @deprecated This option is deprecated.
354
358
  */
355
359
  ListPageColumns["Favourite"] = "FAVOURITE";
356
360
  /**
@@ -418,13 +422,13 @@ var EmbedEvent;
418
422
  /**
419
423
  * Rendering has initialized.
420
424
  * @example
421
- *```js
425
+ * ```js
422
426
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
423
427
  * //show a loader
424
428
  * function showLoader() {
425
429
  * document.getElementById("loader");
426
430
  * }
427
- *```
431
+ * ```
428
432
  * @returns timestamp - The timestamp when the event was generated.
429
433
  */
430
434
  EmbedEvent["Init"] = "init";
@@ -432,11 +436,11 @@ var EmbedEvent;
432
436
  * Authentication has either succeeded or failed.
433
437
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
434
438
  * @example
435
- *```js
439
+ * ```js
436
440
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
437
441
  * console.log('AuthInit', payload);
438
442
  * })
439
- *```
443
+ * ```
440
444
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
441
445
  */
442
446
  EmbedEvent["AuthInit"] = "authInit";
@@ -445,13 +449,13 @@ var EmbedEvent;
445
449
  * @returns timestamp - The timestamp when the event was generated.
446
450
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
447
451
  * @example
448
- *```js
452
+ * ```js
449
453
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
450
454
  * //hide loader
451
455
  * function hideLoader() {
452
456
  * document.getElementById("loader");
453
457
  * }
454
- *```
458
+ * ```
455
459
  */
456
460
  EmbedEvent["Load"] = "load";
457
461
  /**
@@ -460,11 +464,11 @@ var EmbedEvent;
460
464
  * @return data - Answer of Liveboard data
461
465
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
462
466
  * @example
463
- *```js
467
+ * ```js
464
468
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
465
469
  * console.log('data', payload);
466
470
  * })
467
- *```
471
+ * ```
468
472
  * @important
469
473
  */
470
474
  EmbedEvent["Data"] = "data";
@@ -472,9 +476,9 @@ var EmbedEvent;
472
476
  * Search query has been updated by the user.
473
477
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
474
478
  * @example
475
- *```js
479
+ * ```js
476
480
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
477
- *```
481
+ * ```
478
482
  */
479
483
  EmbedEvent["QueryChanged"] = "queryChanged";
480
484
  /**
@@ -484,7 +488,7 @@ var EmbedEvent;
484
488
  * @returns drillDownColumns - The columns on which drill down was performed
485
489
  * @returns nonFilteredColumns - The columns that were not filtered
486
490
  * @example
487
- *```js
491
+ * ```js
488
492
  * searchEmbed.on(EmbedEvent.DrillDown, {
489
493
  * points: {
490
494
  * clickedPoint,
@@ -492,12 +496,12 @@ var EmbedEvent;
492
496
  * },
493
497
  * autoDrillDown: true,
494
498
  * })
495
- *```
499
+ * ```
496
500
  * In this example, `VizPointDoubleClick` event is used for
497
501
  * triggering the `DrillDown` event when an area or specific
498
502
  * data point on a table or chart is double-clicked.
499
503
  * @example
500
- *```js
504
+ * ```js
501
505
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
502
506
  * console.log(payload);
503
507
  * const clickedPoint = payload.data.clickedPoint;
@@ -511,7 +515,7 @@ var EmbedEvent;
511
515
  * autoDrillDown: true,
512
516
  * })
513
517
  * })
514
- *```
518
+ * ```
515
519
  */
516
520
  EmbedEvent["Drilldown"] = "drillDown";
517
521
  /**
@@ -636,13 +640,13 @@ var EmbedEvent;
636
640
  * The ThoughtSpot authentication session has expired.
637
641
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
638
642
  * @example
639
- *```js
643
+ * ```js
640
644
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
641
645
  * //show auth expired banner
642
646
  * function showAuthExpired() {
643
647
  * document.getElementById("authExpiredBanner");
644
648
  * }
645
- *```
649
+ * ```
646
650
  */
647
651
  EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
648
652
  /**
@@ -677,22 +681,22 @@ var EmbedEvent;
677
681
  * Applicable to `SearchBarEmbed` only.
678
682
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
679
683
  * @example
680
- *```js
684
+ * ```js
681
685
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
682
686
  * .then(data => {
683
687
  * console.log('Answer Data:', data);
684
688
  * })
685
- *```
689
+ * ```
686
690
  */
687
691
  EmbedEvent["GetDataClick"] = "getDataClick";
688
692
  /**
689
693
  * Detects the route change.
690
694
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
691
695
  * @example
692
- *```js
696
+ * ```js
693
697
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
694
698
  * console.log('data', payload))
695
- *```
699
+ * ```
696
700
  */
697
701
  EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
698
702
  /**
@@ -702,12 +706,12 @@ var EmbedEvent;
702
706
  EmbedEvent["V1Data"] = "exportVizDataToParent";
703
707
  /**
704
708
  * Emitted when the embed does not have cookie access. This happens
705
- * when Safari and other Web browsers block third-party cookies
706
- * are blocked by default. `NoCookieAccess` can trigger.
709
+ * when third-party cookies are blocked by Safari or other
710
+ * web browsers. `NoCookieAccess` can trigger.
707
711
  * @example
708
- *```js
712
+ * ```js
709
713
  * appEmbed.on(EmbedEvent.NoCookieAccess)
710
- *```
714
+ * ```
711
715
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
712
716
  */
713
717
  EmbedEvent["NoCookieAccess"] = "noCookieAccess";
@@ -721,22 +725,22 @@ var EmbedEvent;
721
725
  * Emitted when any modal is opened in the app
722
726
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
723
727
  * @example
724
- *```js
728
+ * ```js
725
729
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
726
730
  * console.log('dialog open', payload);
727
731
  * })
728
- *```
732
+ * ```
729
733
  */
730
734
  EmbedEvent["DialogOpen"] = "dialog-open";
731
735
  /**
732
736
  * Emitted when any modal is closed in the app
733
737
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
734
738
  * @example
735
- *```js
739
+ * ```js
736
740
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
737
741
  * console.log('dialog close', payload);
738
742
  * })
739
- *```
743
+ * ```
740
744
  */
741
745
  EmbedEvent["DialogClose"] = "dialog-close";
742
746
  /**
@@ -745,39 +749,39 @@ var EmbedEvent;
745
749
  * other events on the rendered Liveboard.
746
750
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
747
751
  * @example
748
- *```js
752
+ * ```js
749
753
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
750
754
  console.log('Liveboard is rendered', payload);
751
755
  })
752
- *```
756
+ * ```
753
757
  * The following example shows how to trigger
754
758
  * `SetVisibleVizs` event using LiveboardRendered embed event:
755
759
  * @example
756
- *```js
760
+ * ```js
757
761
  * const embedRef = useEmbedRef();
758
762
  * const onLiveboardRendered = () => {
759
763
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
760
764
  * };
761
- *```
765
+ * ```
762
766
  */
763
767
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
764
768
  /**
765
769
  * Emits all events.
766
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
770
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
767
771
  * @example
768
- *```js
772
+ * ```js
769
773
  * appEmbed.on(EmbedEvent.ALL, payload => {
770
774
  * console.log('Embed Events', payload)
771
775
  * })
772
- *```
776
+ * ```
773
777
  */
774
778
  EmbedEvent["ALL"] = "*";
775
779
  /**
776
780
  * Emitted when an Answer is saved in the app.
777
781
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
778
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
782
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
779
783
  * @example
780
- *```js
784
+ * ```js
781
785
  * //Emit when action starts
782
786
  * searchEmbed.on(EmbedEvent.Save, payload => {
783
787
  * console.log('Save', payload)
@@ -788,7 +792,7 @@ var EmbedEvent;
788
792
  * searchEmbed.on(EmbedEvent.Save, payload => {
789
793
  * console.log('Save', payload)
790
794
  * })
791
- *```
795
+ * ```
792
796
  */
793
797
  EmbedEvent["Save"] = "save";
794
798
  /**
@@ -800,106 +804,112 @@ var EmbedEvent;
800
804
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
801
805
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
802
806
  * @example
803
- *```js
807
+ * ```js
804
808
  * liveboardEmbed.on(EmbedEvent.Download, {
805
809
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
806
810
  * })
807
- *```
811
+ * ```
808
812
  */
809
813
  EmbedEvent["Download"] = "download";
810
814
  /**
811
815
  * Emitted when the download action is triggered on an Answer.
812
- * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
816
+ * Use start:true to subscribe to when download is initiated, or end:true to
817
+ * subscribe to when download is completed. Default is end:true.
813
818
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
814
819
  * @example
815
- *```js
820
+ * ```js
816
821
  * //emit when action starts
817
822
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
818
823
  * console.log('download PNG', payload)}, {start: true })
819
824
  * //emit when action ends
820
825
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
821
826
  * console.log('download PNG', payload)})
822
- *```
827
+ * ```
823
828
  */
824
829
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
825
830
  /**
826
831
  * Emitted when the Download as PDF action is triggered on an Answer
827
- * 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.
832
+ * Use start:true to subscribe to when download as PDF is initiated, or end:true to
833
+ * subscribe to when download as PDF is completed. Default is end:true.
828
834
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
829
835
  * @example
830
- *```js
836
+ * ```js
831
837
  * //emit when action starts
832
838
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
833
839
  * console.log('download PDF', payload)}, {start: true })
834
840
  * //emit when action ends
835
841
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
836
842
  * console.log('download PDF', payload)})
837
- *```
843
+ * ```
838
844
  */
839
845
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
840
846
  /**
841
847
  * Emitted when the Download as CSV action is triggered on an Answer.
842
- * 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.
848
+ * Use start:true to subscribe to when download as CSV is initiated, or end:true to
849
+ * subscribe to when download as CSV is completed. Default is end:true.
843
850
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
844
851
  * @example
845
- *```js
852
+ * ```js
846
853
  * //emit when action starts
847
854
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
848
855
  * console.log('download CSV', payload)}, {start: true })
849
856
  * //emit when action ends
850
857
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
851
858
  * console.log('download CSV', payload)})
852
- *```
859
+ * ```
853
860
  */
854
861
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
855
862
  /**
856
863
  * Emitted when the Download as XLSX action is triggered on an Answer.
857
- * 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.
864
+ * Use start:true to subscribe to when download as XLSX is initiated, or end:true to
865
+ * subscribe to when download as XLSX is completed. Default is end:true.
858
866
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
859
867
  * @example
860
- *```js
868
+ * ```js
861
869
  * //emit when action starts
862
870
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
863
871
  * console.log('download Xlsx', payload)}, { start: true })
864
872
  * //emit when action ends
865
873
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
866
874
  * console.log('download Xlsx', payload)})
867
- *```
875
+ * ```
868
876
  */
869
877
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
870
878
  /**
871
879
  * Emitted when an Answer is deleted in the app
872
- * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
880
+ * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
881
+ * to when delete is completed. Default is end:true.
873
882
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
874
883
  * @example
875
- *```js
884
+ * ```js
876
885
  * //emit when action starts
877
886
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
878
887
  * console.log('delete answer', payload)}, {start: true })
879
888
  * //trigger when action is completed
880
889
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
881
890
  * console.log('delete answer', payload)})
882
- *```
891
+ * ```
883
892
  */
884
893
  EmbedEvent["AnswerDelete"] = "answerDelete";
885
894
  /**
886
895
  * Emitted when the AI Highlights action is triggered on a Liveboard
887
896
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
888
897
  * @example
889
- *```js
898
+ * ```js
890
899
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
891
900
  * console.log('AI Highlights', payload);
892
901
  * })
893
- *```
902
+ * ```
894
903
  */
895
904
  EmbedEvent["AIHighlights"] = "AIHighlights";
896
905
  /**
897
906
  * Emitted when a user initiates the Pin action to
898
907
  * add an Answer to a Liveboard.
899
- * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
908
+ * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
909
+ * when pin is completed. Default is end:true.
900
910
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
901
911
  * @example
902
- *```js
912
+ * ```js
903
913
  * //emit when action starts
904
914
  * searchEmbed.on(EmbedEvent.Pin, payload => {
905
915
  * console.log('pin', payload)
@@ -910,14 +920,14 @@ var EmbedEvent;
910
920
  * searchEmbed.on(EmbedEvent.Pin, payload => {
911
921
  * console.log('pin', payload)
912
922
  * })
913
- *```
923
+ * ```
914
924
  */
915
925
  EmbedEvent["Pin"] = "pin";
916
926
  /**
917
927
  * Emitted when SpotIQ analysis is triggered
918
928
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
919
929
  * @example
920
- *```js
930
+ * ```js
921
931
  * //emit when action starts
922
932
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
923
933
  * console.log('SpotIQAnalyze', payload)
@@ -928,14 +938,14 @@ var EmbedEvent;
928
938
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
929
939
  * console.log('SpotIQ analyze', payload)
930
940
  * })
931
- *```
941
+ * ```
932
942
  */
933
943
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
934
944
  /**
935
945
  * Emitted when a user shares an object with another user or group
936
946
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
937
947
  * @example
938
- *```js
948
+ * ```js
939
949
  * //emit when action starts
940
950
  * searchEmbed.on(EmbedEvent.Share, payload => {
941
951
  * console.log('Share', payload)
@@ -946,7 +956,7 @@ var EmbedEvent;
946
956
  * searchEmbed.on(EmbedEvent.Share, payload => {
947
957
  * console.log('Share', payload)
948
958
  * })
949
- *```
959
+ * ```
950
960
  */
951
961
  EmbedEvent["Share"] = "share";
952
962
  /**
@@ -954,11 +964,11 @@ var EmbedEvent;
954
964
  * data on a chart or table.
955
965
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
956
966
  * @example
957
- *```js
967
+ * ```js
958
968
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
959
969
  * console.log('Drill include', payload);
960
970
  * })
961
- *```
971
+ * ```
962
972
  */
963
973
  EmbedEvent["DrillInclude"] = "context-menu-item-include";
964
974
  /**
@@ -966,22 +976,22 @@ var EmbedEvent;
966
976
  * data on a chart or table
967
977
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
968
978
  * @example
969
- *```js
979
+ * ```js
970
980
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
971
981
  * console.log('Drill exclude', payload);
972
982
  * })
973
- *```
983
+ * ```
974
984
  */
975
985
  EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
976
986
  /**
977
987
  * Emitted when a column value is copied in the embedded app.
978
988
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
979
989
  * @example
980
- *```js
981
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
990
+ * ```js
991
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
982
992
  * console.log('copy to clipboard', payload);
983
993
  * })
984
- *```
994
+ * ```
985
995
  */
986
996
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
987
997
  /**
@@ -989,10 +999,10 @@ var EmbedEvent;
989
999
  * embedded Liveboard.
990
1000
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
991
1001
  * @example
992
- *```js
1002
+ * ```js
993
1003
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
994
1004
  * })
995
- *```
1005
+ * ```
996
1006
  */
997
1007
  EmbedEvent["UpdateTML"] = "updateTSL";
998
1008
  /**
@@ -1000,75 +1010,77 @@ var EmbedEvent;
1000
1010
  * on an embedded Liveboard.
1001
1011
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1002
1012
  * @example
1003
- *```js
1013
+ * ```js
1004
1014
  * appEmbed.on(EmbedEvent.EditTML, payload => {
1005
1015
  * console.log('Edit TML', payload);
1006
1016
  * })
1007
- *```
1017
+ * ```
1008
1018
  */
1009
1019
  EmbedEvent["EditTML"] = "editTSL";
1010
1020
  /**
1011
1021
  * Emitted when the **Export TML** action is triggered on an
1012
1022
  * an embedded object in the app
1013
- * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
1023
+ * Use start:true to subscribe to when export is initiated, or end:true to subscribe
1024
+ * to when export is completed. Default is end:true.
1014
1025
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1015
1026
  * @example
1016
- *```js
1027
+ * ```js
1017
1028
  * //emit when action starts
1018
1029
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
1019
1030
  * console.log('Export TML', payload)}, { start: true })
1020
1031
  * //emit when action ends
1021
1032
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
1022
1033
  * console.log('Export TML', payload)})
1023
- *```
1034
+ * ```
1024
1035
  */
1025
1036
  EmbedEvent["ExportTML"] = "exportTSL";
1026
1037
  /**
1027
1038
  * Emitted when an Answer is saved as a View.
1028
1039
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1029
1040
  * @example
1030
- *```js
1041
+ * ```js
1031
1042
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
1032
1043
  * console.log('View', payload);
1033
1044
  * })
1034
- *```
1045
+ * ```
1035
1046
  */
1036
1047
  EmbedEvent["SaveAsView"] = "saveAsView";
1037
1048
  /**
1038
1049
  * Emitted when the user creates a copy of an Answer.
1039
- * 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.
1050
+ * Use start:true to subscribe to when copy and edit is initiated, or end:true to
1051
+ * subscribe to when copy and edit is completed. Default is end:true.
1040
1052
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1041
1053
  * @example
1042
- *```js
1054
+ * ```js
1043
1055
  * //emit when action starts
1044
1056
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
1045
1057
  * console.log('Copy and edit', payload)}, {start: true })
1046
1058
  * //emit when action ends
1047
1059
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
1048
1060
  * console.log('Copy and edit', payload)})
1049
- *```
1061
+ * ```
1050
1062
  */
1051
1063
  EmbedEvent["CopyAEdit"] = "copyAEdit";
1052
1064
  /**
1053
1065
  * Emitted when a user clicks *Show underlying data* on an Answer.
1054
1066
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1055
1067
  * @example
1056
- *```js
1068
+ * ```js
1057
1069
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
1058
1070
  * console.log('show data', payload);
1059
1071
  * })
1060
- *```
1072
+ * ```
1061
1073
  */
1062
1074
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
1063
1075
  /**
1064
1076
  * Emitted when an Answer is switched to a chart or table view.
1065
1077
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1066
1078
  * @example
1067
- *```js
1079
+ * ```js
1068
1080
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
1069
1081
  * console.log('switch view', payload);
1070
1082
  * })
1071
- *```
1083
+ * ```
1072
1084
  */
1073
1085
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
1074
1086
  /**
@@ -1085,118 +1097,118 @@ var EmbedEvent;
1085
1097
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
1086
1098
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1087
1099
  * @example
1088
- *```js
1100
+ * ```js
1089
1101
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
1090
1102
  * console.log('Liveboard details', payload);
1091
1103
  * })
1092
- *```
1104
+ * ```
1093
1105
  */
1094
1106
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
1095
1107
  /**
1096
1108
  * Emitted when a user clicks on the Favorite icon on a Liveboard
1097
1109
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1098
1110
  * @example
1099
- *```js
1111
+ * ```js
1100
1112
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
1101
1113
  * console.log('favorites', payload);
1102
1114
  * })
1103
- *```
1115
+ * ```
1104
1116
  */
1105
1117
  EmbedEvent["AddToFavorites"] = "addToFavorites";
1106
1118
  /**
1107
1119
  * Emitted when a user clicks **Schedule** on a Liveboard
1108
1120
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1109
1121
  * @example
1110
- *```js
1122
+ * ```js
1111
1123
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
1112
- * console.log(`Liveboard schedule', payload);
1124
+ * console.log('Liveboard schedule', payload);
1113
1125
  * })
1114
- *```
1126
+ * ```
1115
1127
  */
1116
1128
  EmbedEvent["Schedule"] = "subscription";
1117
1129
  /**
1118
1130
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
1119
1131
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1120
1132
  * @example
1121
- *```js
1133
+ * ```js
1122
1134
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
1123
- * console.log(`Liveboard edit', payload);
1135
+ * console.log('Liveboard edit', payload);
1124
1136
  * })
1125
- *```
1137
+ * ```
1126
1138
  */
1127
1139
  EmbedEvent["Edit"] = "edit";
1128
1140
  /**
1129
1141
  * Emitted when a user clicks *Make a copy* on a Liveboard
1130
1142
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1131
1143
  * @example
1132
- *```js
1144
+ * ```js
1133
1145
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
1134
- * console.log(`Copy', payload);
1146
+ * console.log('Copy', payload);
1135
1147
  * })
1136
- *```
1148
+ * ```
1137
1149
  */
1138
1150
  EmbedEvent["MakeACopy"] = "makeACopy";
1139
1151
  /**
1140
1152
  * Emitted when a user clicks **Present** on a Liveboard or visualization
1141
1153
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1142
1154
  * @example
1143
- *```js
1155
+ * ```js
1144
1156
  * liveboardEmbed.on(EmbedEvent.Present)
1145
- *```
1157
+ * ```
1146
1158
  * @example
1147
- *```js
1159
+ * ```js
1148
1160
  * liveboardEmbed.on(EmbedEvent.Present, {
1149
1161
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1150
1162
  * })
1151
- *```
1163
+ * ```
1152
1164
  */
1153
1165
  EmbedEvent["Present"] = "present";
1154
1166
  /**
1155
1167
  * Emitted when a user clicks **Delete** on a visualization
1156
1168
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1157
1169
  * @example
1158
- *```js
1170
+ * ```js
1159
1171
  * liveboardEmbed.on(EmbedEvent.Delete,
1160
1172
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1161
- *```
1173
+ * ```
1162
1174
  */
1163
1175
  EmbedEvent["Delete"] = "delete";
1164
1176
  /**
1165
1177
  * Emitted when a user clicks Manage schedules on a Liveboard
1166
1178
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1167
1179
  * @example
1168
- *```js
1180
+ * ```js
1169
1181
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
1170
- *```
1182
+ * ```
1171
1183
  */
1172
1184
  EmbedEvent["SchedulesList"] = "schedule-list";
1173
1185
  /**
1174
1186
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
1175
1187
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1176
1188
  * @example
1177
- *```js
1189
+ * ```js
1178
1190
  * liveboardEmbed.on(EmbedEvent.Cancel)
1179
- *```
1191
+ * ```
1180
1192
  */
1181
1193
  EmbedEvent["Cancel"] = "cancel";
1182
1194
  /**
1183
1195
  * Emitted when a user clicks **Explore** on a visualization
1184
1196
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1185
1197
  * @example
1186
- *```js
1198
+ * ```js
1187
1199
  * liveboardEmbed.on(EmbedEvent.Explore, {
1188
1200
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1189
- *```
1201
+ * ```
1190
1202
  */
1191
1203
  EmbedEvent["Explore"] = "explore";
1192
1204
  /**
1193
1205
  * Emitted when a user clicks **Copy link** action on a visualization.
1194
1206
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1195
1207
  * @example
1196
- *```js
1208
+ * ```js
1197
1209
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
1198
1210
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1199
- *```
1211
+ * ```
1200
1212
  */
1201
1213
  EmbedEvent["CopyLink"] = "embedDocument";
1202
1214
  /**
@@ -1204,21 +1216,21 @@ var EmbedEvent;
1204
1216
  * visualization or Liveboard.
1205
1217
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1206
1218
  * @example
1207
- *```js
1219
+ * ```js
1208
1220
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
1209
1221
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1210
- *```
1222
+ * ```
1211
1223
  */
1212
1224
  EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
1213
1225
  /**
1214
1226
  * Emitted when a user right clicks on a visualization (chart or table)
1215
1227
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1216
1228
  * @example
1217
- *```js
1229
+ * ```js
1218
1230
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
1219
1231
  * console.log('VizPointClick', payload)
1220
1232
  * })
1221
- *```
1233
+ * ```
1222
1234
  */
1223
1235
  EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
1224
1236
  /**
@@ -1232,35 +1244,35 @@ var EmbedEvent;
1232
1244
  * filter details.
1233
1245
  * @example
1234
1246
  *
1235
- *```js
1247
+ * ```js
1236
1248
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
1237
1249
  * console.log('payload', payload);
1238
1250
  * })
1239
- *
1251
+ * ```
1240
1252
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
1241
1253
  */
1242
1254
  EmbedEvent["FilterChanged"] = "filterChanged";
1243
1255
  /**
1244
1256
  * Emitted when a user clicks the **Go** button to initiate
1245
1257
  * a Natural Language Search query
1246
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1258
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1247
1259
  */
1248
1260
  EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
1249
1261
  /**
1250
1262
  * Emitted when a user selects a data source on the embedded
1251
1263
  * Natural Language Search interface.
1252
1264
  *
1253
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1265
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1254
1266
  */
1255
1267
  EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
1256
1268
  /**
1257
1269
  * Emitted when a user updates a connection on the **Data** page
1258
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1270
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1259
1271
  */
1260
1272
  EmbedEvent["UpdateConnection"] = "updateConnection";
1261
1273
  /**
1262
1274
  * Emitted when a user updates a connection on the **Data** page
1263
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1275
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1264
1276
  */
1265
1277
  EmbedEvent["CreateConnection"] = "createConnection";
1266
1278
  /**
@@ -1270,7 +1282,7 @@ var EmbedEvent;
1270
1282
  * @returns viewId: string
1271
1283
  * @returns liveboardId: string
1272
1284
  * @returns isPublic: boolean
1273
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1285
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1274
1286
  */
1275
1287
  EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
1276
1288
  /**
@@ -1279,7 +1291,7 @@ var EmbedEvent;
1279
1291
  * @returns viewId: string
1280
1292
  * @returns liveboardId: string
1281
1293
  * @returns isPublic: boolean
1282
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1294
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1283
1295
  */
1284
1296
  EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
1285
1297
  /**
@@ -1288,19 +1300,19 @@ var EmbedEvent;
1288
1300
  * @returns viewId: string
1289
1301
  * @returns liveboardId: string
1290
1302
  * @returns isPublic: boolean
1291
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1303
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1292
1304
  */
1293
1305
  EmbedEvent["ResetLiveboard"] = "resetLiveboard";
1294
1306
  /**
1295
1307
  * Emitted when a PersonalisedView is deleted.
1296
1308
  * @returns views: string[]
1297
1309
  * @returns liveboardId: string
1298
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1310
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
1299
1311
  */
1300
1312
  EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
1301
1313
  /**
1302
1314
  * Emitted when a user creates a Worksheet.
1303
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1315
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
1304
1316
  */
1305
1317
  EmbedEvent["CreateWorksheet"] = "createWorksheet";
1306
1318
  /**
@@ -1309,12 +1321,12 @@ var EmbedEvent;
1309
1321
  * @returns viewId: string
1310
1322
  * @returns liveboardId: string
1311
1323
  * @returns isPublic: boolean
1312
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
1324
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
1313
1325
  */
1314
1326
  EmbedEvent["AskSageInit"] = "AskSageInit";
1315
1327
  /**
1316
1328
  * Emitted when a Liveboard or visualization is renamed.
1317
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
1329
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
1318
1330
  */
1319
1331
  EmbedEvent["Rename"] = "rename";
1320
1332
  /**
@@ -1337,7 +1349,7 @@ var EmbedEvent;
1337
1349
  * - `error` - Developers can customize the user-facing error message when `execute`
1338
1350
  * is `false` by using the `error` parameters in `responder`.
1339
1351
  * - `errorText` - The error message text shown to the user.
1340
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
1352
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
1341
1353
  * @example
1342
1354
  *
1343
1355
  * This example blocks search operation and returns a custom error message:
@@ -1389,8 +1401,8 @@ var EmbedEvent;
1389
1401
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
1390
1402
  * console.log('payload', payload);
1391
1403
  * })
1392
- *```
1393
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
1404
+ * ```
1405
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
1394
1406
  */
1395
1407
  EmbedEvent["ParameterChanged"] = "parameterChanged";
1396
1408
  /**
@@ -1445,24 +1457,24 @@ var EmbedEvent;
1445
1457
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
1446
1458
  * console.log('payload', payload);
1447
1459
  * })
1448
- *```
1449
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
1460
+ * ```
1461
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
1450
1462
  */
1451
1463
  EmbedEvent["CreateLiveboard"] = "createLiveboard";
1452
1464
  /**
1453
1465
  * Emitted when a user creates a Model.
1454
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
1466
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
1455
1467
  */
1456
1468
  EmbedEvent["CreateModel"] = "createModel";
1457
1469
  /**
1458
1470
  * @hidden
1459
1471
  * Emitted when a user exits present mode.
1460
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
1472
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1461
1473
  */
1462
1474
  EmbedEvent["ExitPresentMode"] = "exitPresentMode";
1463
1475
  /**
1464
1476
  * Emitted when a user requests the full height lazy load data.
1465
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
1477
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1466
1478
  * @hidden
1467
1479
  */
1468
1480
  EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
@@ -1473,7 +1485,7 @@ var EmbedEvent;
1473
1485
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
1474
1486
  * console.log('payload', payload);
1475
1487
  * })
1476
- *```
1488
+ * ```
1477
1489
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1478
1490
  */
1479
1491
  EmbedEvent["SpotterData"] = "SpotterData";
@@ -1484,7 +1496,7 @@ var EmbedEvent;
1484
1496
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
1485
1497
  * console.log('payload', payload);
1486
1498
  * })
1487
- *```
1499
+ * ```
1488
1500
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1489
1501
  */
1490
1502
  EmbedEvent["PreviewSpotterData"] = "PreviewSpotterData";
@@ -1495,7 +1507,7 @@ var EmbedEvent;
1495
1507
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
1496
1508
  * console.log('payload', payload);
1497
1509
  * })
1498
- *```
1510
+ * ```
1499
1511
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
1500
1512
  */
1501
1513
  EmbedEvent["AddToCoaching"] = "addToCoaching";
@@ -1517,7 +1529,7 @@ var EmbedEvent;
1517
1529
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
1518
1530
  * console.log('payload', payload);
1519
1531
  * })
1520
- *```
1532
+ * ```
1521
1533
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1522
1534
  */
1523
1535
  EmbedEvent["SpotterQueryTriggered"] = "SpotterQueryTriggered";
@@ -1528,7 +1540,7 @@ var EmbedEvent;
1528
1540
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
1529
1541
  * console.log('payload', payload);
1530
1542
  * })
1531
- *```
1543
+ * ```
1532
1544
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1533
1545
  */
1534
1546
  EmbedEvent["LastPromptEdited"] = "LastPromptEdited";
@@ -1539,18 +1551,18 @@ var EmbedEvent;
1539
1551
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
1540
1552
  * console.log('payload', payload);
1541
1553
  * })
1542
- *```
1554
+ * ```
1543
1555
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1544
1556
  */
1545
1557
  EmbedEvent["LastPromptDeleted"] = "LastPromptDeleted";
1546
1558
  /**
1547
- * Emitted when the coversation is reset in spotter embed.
1559
+ * Emitted when the conversation is reset in Spotter embed.
1548
1560
  * @example
1549
1561
  * ```js
1550
1562
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
1551
1563
  * console.log('payload', payload);
1552
1564
  * })
1553
- *```
1565
+ * ```
1554
1566
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1555
1567
  */
1556
1568
  EmbedEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
@@ -1561,7 +1573,7 @@ var EmbedEvent;
1561
1573
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
1562
1574
  * console.log('payload', payload);
1563
1575
  * })
1564
- *```
1576
+ * ```
1565
1577
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
1566
1578
  */
1567
1579
  EmbedEvent["SpotterInit"] = "spotterInit";
@@ -1572,7 +1584,7 @@ var EmbedEvent;
1572
1584
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
1573
1585
  * console.log('payload', payload);
1574
1586
  * })
1575
- *```
1587
+ * ```
1576
1588
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
1577
1589
  */
1578
1590
  EmbedEvent["SpotterLoadComplete"] = "spotterLoadComplete";
@@ -1800,7 +1812,8 @@ var HostEvent;
1800
1812
  * - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
1801
1813
  * on the most popular column.
1802
1814
  * - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
1803
- * of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
1815
+ * of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
1816
+ * **required**.
1804
1817
  * @example
1805
1818
  * ```js
1806
1819
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -1927,7 +1940,7 @@ var HostEvent;
1927
1940
  * ```js
1928
1941
  * appEmbed.navigateToPage(-1)
1929
1942
  * ```
1930
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
1943
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
1931
1944
  */
1932
1945
  HostEvent["Navigate"] = "Navigate";
1933
1946
  /**
@@ -1996,7 +2009,8 @@ var HostEvent;
1996
2009
  * the following parameters:
1997
2010
  *
1998
2011
  * @param - Includes the following keys:
1999
- * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
2012
+ * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
2013
+ * Liveboard.
2000
2014
  * Optional when pinning a new chart or table generated from a Search query.
2001
2015
  * **Required** in Spotter Embed.
2002
2016
  * - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
@@ -2060,9 +2074,9 @@ var HostEvent;
2060
2074
  * Trigger the **Show Liveboard details** action
2061
2075
  * on an embedded Liveboard.
2062
2076
  * @example
2063
- *```js
2077
+ * ```js
2064
2078
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
2065
- *```
2079
+ * ```
2066
2080
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2067
2081
  */
2068
2082
  HostEvent["LiveboardInfo"] = "pinboardInfo";
@@ -2190,7 +2204,7 @@ var HostEvent;
2190
2204
  * appEmbed.trigger(HostEvent.Remove)
2191
2205
  * ```
2192
2206
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2193
- * * @example
2207
+ * @example
2194
2208
  * ```js
2195
2209
  * liveboardEmbed.trigger(HostEvent.Remove)
2196
2210
  * ```
@@ -2252,7 +2266,8 @@ var HostEvent;
2252
2266
  * This event is not supported in visualization embed and search embed.
2253
2267
  * @param - Object parameter. Includes the following keys:
2254
2268
  * - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
2255
- * pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
2269
+ * pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
2270
+ * is **required**.
2256
2271
  *
2257
2272
  * @example
2258
2273
  * ```js
@@ -2281,7 +2296,7 @@ var HostEvent;
2281
2296
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2282
2297
  * ```
2283
2298
  * ```js
2284
- * vizEmbed.trigger((HostEvent.CopyLink)
2299
+ * vizEmbed.trigger(HostEvent.CopyLink)
2285
2300
  * ```
2286
2301
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2287
2302
  */
@@ -2298,7 +2313,7 @@ var HostEvent;
2298
2313
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2299
2314
  * ```
2300
2315
  * ```js
2301
- * vizEmbed.trigger((HostEvent.Present)
2316
+ * vizEmbed.trigger(HostEvent.Present)
2302
2317
  * ```
2303
2318
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2304
2319
  */
@@ -2313,23 +2328,22 @@ var HostEvent;
2313
2328
  * );
2314
2329
  * })
2315
2330
  * ```
2316
- * * @example
2331
+ * @example
2317
2332
  * ```js
2318
-
2319
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
2320
- * let latestSpotterVizId = '';
2321
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
2322
- * latestSpotterVizId = payload.data.id;
2323
- * });
2324
- *
2325
- * spotterEmbed.trigger(HostEvent.GetTML, {
2333
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
2334
+ * let latestSpotterVizId = '';
2335
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
2336
+ * latestSpotterVizId = payload.data.id;
2337
+ * });
2338
+ *
2339
+ * spotterEmbed.trigger(HostEvent.GetTML, {
2326
2340
  * vizId: latestSpotterVizId
2327
2341
  * }).then((tml) => {
2328
2342
  * console.log(
2329
2343
  * tml.answer.search_query // TML representation of the search query
2330
2344
  * );
2331
2345
  * })
2332
- * ```
2346
+ * ```
2333
2347
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2334
2348
  * @important
2335
2349
  */
@@ -2393,6 +2407,11 @@ var HostEvent;
2393
2407
  /**
2394
2408
  * Trigger the **Download** action on charts in
2395
2409
  * the embedded view.
2410
+ * Use {@link HostEvent.DownloadAsPng} instead.
2411
+ *
2412
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2413
+ *
2414
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
2396
2415
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
2397
2416
  * @example
2398
2417
  * ```js
@@ -2411,9 +2430,6 @@ var HostEvent;
2411
2430
  *
2412
2431
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
2413
2432
  * ```
2414
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
2415
- * Use {@link DownloadAsPng}
2416
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2417
2433
  */
2418
2434
  HostEvent["Download"] = "downloadAsPng";
2419
2435
  /**
@@ -2620,8 +2636,9 @@ var HostEvent;
2620
2636
  /**
2621
2637
  * Update one or several filters applied on a Liveboard.
2622
2638
  * @param - Includes the following keys:
2623
- * - `filter`: A single filter object containing column name, filter operator, and values.
2624
- * - `filters`: Multiple filter objects with column name, filter operator, and values for each.
2639
+ * - `filter`: A single filter object containing column name, filter operator, and
2640
+ * values. - `filters`: Multiple filter objects with column name, filter operator,
2641
+ * and values for each.
2625
2642
  *
2626
2643
  * Each filter object must include the following attributes:
2627
2644
  *
@@ -2851,8 +2868,8 @@ var HostEvent;
2851
2868
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
2852
2869
  * console.log('parameters', parameter);
2853
2870
  * });
2854
- *```
2855
- *```js
2871
+ * ```
2872
+ * ```js
2856
2873
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
2857
2874
  * let latestSpotterVizId = '';
2858
2875
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -2860,7 +2877,7 @@ var HostEvent;
2860
2877
  * });
2861
2878
  *
2862
2879
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
2863
- *```
2880
+ * ```
2864
2881
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
2865
2882
  */
2866
2883
  HostEvent["GetParameters"] = "GetParameters";
@@ -2877,7 +2894,7 @@ var HostEvent;
2877
2894
  * Notify when info call is completed successfully
2878
2895
  * ```js
2879
2896
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
2880
- *```
2897
+ * ```
2881
2898
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2882
2899
  */
2883
2900
  HostEvent["InfoSuccess"] = "InfoSuccess";
@@ -2890,8 +2907,8 @@ var HostEvent;
2890
2907
  * triggered with a modal to prompt users to
2891
2908
  * add a name and description for the Answer.
2892
2909
  * @param - Includes the following keys:
2893
- * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
2894
- * - `name`: Optional. Name string for the Answer.
2910
+ * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
2911
+ * embed. - `name`: Optional. Name string for the Answer.
2895
2912
  * - `description`: Optional. Description text for the Answer.
2896
2913
  * @example
2897
2914
  * ```js
@@ -2980,7 +2997,7 @@ var HostEvent;
2980
2997
  * ```js
2981
2998
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
2982
2999
  *
2983
- *```
3000
+ * ```
2984
3001
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
2985
3002
  */
2986
3003
  HostEvent["AddToCoaching"] = "addToCoaching";
@@ -3022,7 +3039,7 @@ var HostEvent;
3022
3039
  * });
3023
3040
  *
3024
3041
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
3025
- *```
3042
+ * ```
3026
3043
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3027
3044
  */
3028
3045
  HostEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
@@ -3032,7 +3049,7 @@ var HostEvent;
3032
3049
  * This is automatically triggered by the SDK when fullscreen mode is exited.
3033
3050
  * ```js
3034
3051
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
3035
- *```
3052
+ * ```
3036
3053
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3037
3054
  */
3038
3055
  HostEvent["ExitPresentMode"] = "exitPresentMode";
@@ -3086,8 +3103,9 @@ var HostEvent;
3086
3103
  /**
3087
3104
  * Triggers a new conversation in Spotter embed.
3088
3105
  *
3089
- * This feature is available only when chat history is enabled on your ThoughtSpot instance.
3090
- * Contact your admin or ThoughtSpot Support to enable chat history on your instance.
3106
+ * This feature is available only when chat history is enabled on your ThoughtSpot
3107
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
3108
+ * instance.
3091
3109
  *
3092
3110
  * @example
3093
3111
  * ```js
@@ -3133,6 +3151,7 @@ var DataSourceVisualMode;
3133
3151
  */
3134
3152
  var Param;
3135
3153
  (function (Param) {
3154
+ Param["Tsmcp"] = "tsmcp";
3136
3155
  Param["EmbedApp"] = "embedApp";
3137
3156
  Param["DataSources"] = "dataSources";
3138
3157
  Param["DataSourceMode"] = "dataSourceMode";
@@ -3182,6 +3201,7 @@ var Param;
3182
3201
  // 'both' clicks in `contextMenuTrigger` configuration.
3183
3202
  Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
3184
3203
  Param["LinkOverride"] = "linkOverride";
3204
+ Param["EnableLinkOverridesV2"] = "enableLinkOverridesV2";
3185
3205
  Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
3186
3206
  Param["ShowInsertToSlide"] = "insertInToSlide";
3187
3207
  Param["PrimaryNavHidden"] = "primaryNavHidden";
@@ -3276,6 +3296,7 @@ var Param;
3276
3296
  Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
3277
3297
  Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
3278
3298
  Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
3299
+ Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
3279
3300
  })(Param = exports.Param || (exports.Param = {}));
3280
3301
  /**
3281
3302
  * ThoughtSpot application pages include actions and menu commands
@@ -3435,14 +3456,14 @@ var Action;
3435
3456
  * ```js
3436
3457
  * disabledActions: [Action.CollapseDataPanel]
3437
3458
  * ```
3438
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
3459
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
3439
3460
  */
3440
3461
  Action["CollapseDataSources"] = "collapseDataSources";
3441
3462
  /**
3442
3463
  * The **Collapse data panel** icon on the Search page.
3443
3464
  * Collapses the data panel view.
3444
3465
  *
3445
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3466
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3446
3467
  *
3447
3468
  * @example
3448
3469
  * ```js
@@ -3889,13 +3910,12 @@ var Action;
3889
3910
  */
3890
3911
  Action["CreateMonitor"] = "createMonitor";
3891
3912
  /**
3892
- * @deprecated
3893
- * Reports errors
3913
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3914
+ * @deprecated This action is deprecated. It was used for reporting errors.
3894
3915
  * @example
3895
3916
  * ```js
3896
3917
  * disabledActions: [Action.ReportError]
3897
3918
  * ```
3898
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3899
3919
  */
3900
3920
  Action["ReportError"] = "reportError";
3901
3921
  /**
@@ -3905,7 +3925,7 @@ var Action;
3905
3925
  * ```js
3906
3926
  * disabledActions: [Action.SyncToSheets]
3907
3927
  * ```
3908
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3928
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3909
3929
  */
3910
3930
  Action["SyncToSheets"] = "sync-to-sheets";
3911
3931
  /**
@@ -3916,7 +3936,7 @@ var Action;
3916
3936
  * ```js
3917
3937
  * disabledActions: [Action.SyncToOtherApps]
3918
3938
  * ```
3919
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3939
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3920
3940
  */
3921
3941
  Action["SyncToOtherApps"] = "sync-to-other-apps";
3922
3942
  /**
@@ -3926,7 +3946,7 @@ var Action;
3926
3946
  * ```js
3927
3947
  * disabledActions: [Action.ManagePipelines]
3928
3948
  * ```
3929
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3949
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3930
3950
  */
3931
3951
  Action["ManagePipelines"] = "manage-pipeline";
3932
3952
  /**
@@ -4238,7 +4258,7 @@ var Action;
4238
4258
  * ```js
4239
4259
  * disabledActions: [Action.PersonalisedViewsDropdown]
4240
4260
  * ```
4241
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4261
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4242
4262
  */
4243
4263
  Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
4244
4264
  /**
@@ -4248,7 +4268,7 @@ var Action;
4248
4268
  * ```js
4249
4269
  * disabledActions: [Action.LiveboardUsers]
4250
4270
  * ```
4251
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4271
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4252
4272
  */
4253
4273
  Action["LiveboardUsers"] = "liveboardUsers";
4254
4274
  /**
@@ -4266,7 +4286,7 @@ var Action;
4266
4286
  * hiddenAction: [Action.TML] // hide all TML actions
4267
4287
  * disabledActions: [Action.TML] // to disable all TML actions
4268
4288
  * ```
4269
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
4289
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
4270
4290
  */
4271
4291
  Action["TML"] = "tml";
4272
4292
  /**
@@ -4312,7 +4332,7 @@ var Action;
4312
4332
  * ```js
4313
4333
  * disabledActions: [Action.AddToWatchlist]
4314
4334
  * ```
4315
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
4335
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
4316
4336
  */
4317
4337
  Action["AddToWatchlist"] = "addToWatchlist";
4318
4338
  /**
@@ -4322,7 +4342,7 @@ var Action;
4322
4342
  * ```js
4323
4343
  * disabledActions: [Action.RemoveFromWatchlist]
4324
4344
  * ```
4325
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
4345
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
4326
4346
  */
4327
4347
  Action["RemoveFromWatchlist"] = "removeFromWatchlist";
4328
4348
  /**
@@ -4333,7 +4353,7 @@ var Action;
4333
4353
  * ```js
4334
4354
  * disabledActions: [Action.OrganiseFavourites]
4335
4355
  * ```
4336
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
4356
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
4337
4357
  */
4338
4358
  Action["OrganiseFavourites"] = "organiseFavourites";
4339
4359
  /**
@@ -4394,7 +4414,7 @@ var Action;
4394
4414
  * ```js
4395
4415
  * disabledActions: [Action.ManageTags]
4396
4416
  * ```
4397
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4417
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4398
4418
  */
4399
4419
  Action["ManageTags"] = "manageTags";
4400
4420
  /**
@@ -5026,7 +5046,9 @@ var ErrorDetailsTypes;
5026
5046
  ErrorDetailsTypes["NETWORK"] = "NETWORK";
5027
5047
  })(ErrorDetailsTypes = exports.ErrorDetailsTypes || (exports.ErrorDetailsTypes = {}));
5028
5048
  /**
5029
- * Error codes for identifying specific issues in embedded ThoughtSpot components. Use {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error handling and debugging.
5049
+ * Error codes for identifying specific issues in embedded ThoughtSpot components. Use
5050
+ * {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error
5051
+ * handling and debugging.
5030
5052
  *
5031
5053
  * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
5032
5054
  * @group Error Handling