@thoughtspot/visual-embed-sdk 1.46.0 → 1.46.2

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 (176) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +2 -2
  3. package/cjs/src/auth.d.ts +29 -4
  4. package/cjs/src/auth.d.ts.map +1 -1
  5. package/cjs/src/auth.js +30 -5
  6. package/cjs/src/auth.js.map +1 -1
  7. package/cjs/src/css-variables.d.ts +17 -17
  8. package/cjs/src/embed/app.d.ts +61 -33
  9. package/cjs/src/embed/app.d.ts.map +1 -1
  10. package/cjs/src/embed/app.js +11 -4
  11. package/cjs/src/embed/app.js.map +1 -1
  12. package/cjs/src/embed/app.spec.js +34 -1
  13. package/cjs/src/embed/app.spec.js.map +1 -1
  14. package/cjs/src/embed/base.d.ts +2 -2
  15. package/cjs/src/embed/base.js +2 -2
  16. package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
  17. package/cjs/src/embed/bodyless-conversation.js +4 -4
  18. package/cjs/src/embed/conversation.d.ts +43 -30
  19. package/cjs/src/embed/conversation.d.ts.map +1 -1
  20. package/cjs/src/embed/conversation.js +10 -11
  21. package/cjs/src/embed/conversation.js.map +1 -1
  22. package/cjs/src/embed/conversation.spec.js +27 -0
  23. package/cjs/src/embed/conversation.spec.js.map +1 -1
  24. package/cjs/src/embed/liveboard.d.ts +42 -36
  25. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  26. package/cjs/src/embed/liveboard.js +3 -3
  27. package/cjs/src/embed/liveboard.js.map +1 -1
  28. package/cjs/src/embed/liveboard.spec.js +1 -1
  29. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  30. package/cjs/src/embed/sage.d.ts +5 -5
  31. package/cjs/src/embed/sage.js +1 -1
  32. package/cjs/src/embed/search-bar.d.ts +7 -7
  33. package/cjs/src/embed/search-bar.js +1 -1
  34. package/cjs/src/embed/search.d.ts +16 -14
  35. package/cjs/src/embed/search.d.ts.map +1 -1
  36. package/cjs/src/embed/search.js +3 -2
  37. package/cjs/src/embed/search.js.map +1 -1
  38. package/cjs/src/embed/ts-embed.d.ts +4 -4
  39. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  40. package/cjs/src/embed/ts-embed.js +13 -7
  41. package/cjs/src/embed/ts-embed.js.map +1 -1
  42. package/cjs/src/embed/ts-embed.spec.js +35 -0
  43. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  44. package/cjs/src/react/index.d.ts +15 -15
  45. package/cjs/src/react/index.js +12 -12
  46. package/cjs/src/tokenizedFetch.d.ts +1 -1
  47. package/cjs/src/tokenizedFetch.js +1 -1
  48. package/cjs/src/types.d.ts +653 -276
  49. package/cjs/src/types.d.ts.map +1 -1
  50. package/cjs/src/types.js +274 -208
  51. package/cjs/src/types.js.map +1 -1
  52. package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
  53. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  54. package/cjs/src/utils/graphql/answerService/answerService.js +6 -4
  55. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  56. package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
  57. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  58. package/cjs/src/utils.d.ts +9 -0
  59. package/cjs/src/utils.d.ts.map +1 -1
  60. package/cjs/src/utils.js +10 -1
  61. package/cjs/src/utils.js.map +1 -1
  62. package/dist/{index-BQvLEoxp.js → index-DkizS4xM.js} +1 -1
  63. package/dist/src/auth.d.ts +29 -4
  64. package/dist/src/auth.d.ts.map +1 -1
  65. package/dist/src/css-variables.d.ts +17 -17
  66. package/dist/src/embed/app.d.ts +61 -33
  67. package/dist/src/embed/app.d.ts.map +1 -1
  68. package/dist/src/embed/base.d.ts +2 -2
  69. package/dist/src/embed/bodyless-conversation.d.ts +5 -5
  70. package/dist/src/embed/conversation.d.ts +43 -30
  71. package/dist/src/embed/conversation.d.ts.map +1 -1
  72. package/dist/src/embed/liveboard.d.ts +42 -36
  73. package/dist/src/embed/liveboard.d.ts.map +1 -1
  74. package/dist/src/embed/sage.d.ts +5 -5
  75. package/dist/src/embed/search-bar.d.ts +7 -7
  76. package/dist/src/embed/search.d.ts +16 -14
  77. package/dist/src/embed/search.d.ts.map +1 -1
  78. package/dist/src/embed/ts-embed.d.ts +4 -4
  79. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  80. package/dist/src/react/index.d.ts +15 -15
  81. package/dist/src/tokenizedFetch.d.ts +1 -1
  82. package/dist/src/types.d.ts +653 -276
  83. package/dist/src/types.d.ts.map +1 -1
  84. package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
  85. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  86. package/dist/src/utils.d.ts +9 -0
  87. package/dist/src/utils.d.ts.map +1 -1
  88. package/dist/tsembed-react.es.js +383 -290
  89. package/dist/tsembed-react.js +382 -289
  90. package/dist/tsembed.es.js +375 -282
  91. package/dist/tsembed.js +374 -281
  92. package/dist/visual-embed-sdk-react-full.d.ts +880 -431
  93. package/dist/visual-embed-sdk-react.d.ts +873 -427
  94. package/dist/visual-embed-sdk.d.ts +879 -430
  95. package/lib/package.json +2 -2
  96. package/lib/src/auth.d.ts +29 -4
  97. package/lib/src/auth.d.ts.map +1 -1
  98. package/lib/src/auth.js +30 -5
  99. package/lib/src/auth.js.map +1 -1
  100. package/lib/src/css-variables.d.ts +17 -17
  101. package/lib/src/embed/app.d.ts +61 -33
  102. package/lib/src/embed/app.d.ts.map +1 -1
  103. package/lib/src/embed/app.js +12 -5
  104. package/lib/src/embed/app.js.map +1 -1
  105. package/lib/src/embed/app.spec.js +34 -1
  106. package/lib/src/embed/app.spec.js.map +1 -1
  107. package/lib/src/embed/base.d.ts +2 -2
  108. package/lib/src/embed/base.js +2 -2
  109. package/lib/src/embed/bodyless-conversation.d.ts +5 -5
  110. package/lib/src/embed/bodyless-conversation.js +4 -4
  111. package/lib/src/embed/conversation.d.ts +43 -30
  112. package/lib/src/embed/conversation.d.ts.map +1 -1
  113. package/lib/src/embed/conversation.js +11 -11
  114. package/lib/src/embed/conversation.js.map +1 -1
  115. package/lib/src/embed/conversation.spec.js +27 -0
  116. package/lib/src/embed/conversation.spec.js.map +1 -1
  117. package/lib/src/embed/liveboard.d.ts +42 -36
  118. package/lib/src/embed/liveboard.d.ts.map +1 -1
  119. package/lib/src/embed/liveboard.js +3 -3
  120. package/lib/src/embed/liveboard.js.map +1 -1
  121. package/lib/src/embed/liveboard.spec.js +1 -1
  122. package/lib/src/embed/liveboard.spec.js.map +1 -1
  123. package/lib/src/embed/sage.d.ts +5 -5
  124. package/lib/src/embed/sage.js +1 -1
  125. package/lib/src/embed/search-bar.d.ts +7 -7
  126. package/lib/src/embed/search-bar.js +1 -1
  127. package/lib/src/embed/search.d.ts +16 -14
  128. package/lib/src/embed/search.d.ts.map +1 -1
  129. package/lib/src/embed/search.js +3 -2
  130. package/lib/src/embed/search.js.map +1 -1
  131. package/lib/src/embed/ts-embed.d.ts +4 -4
  132. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  133. package/lib/src/embed/ts-embed.js +13 -7
  134. package/lib/src/embed/ts-embed.js.map +1 -1
  135. package/lib/src/embed/ts-embed.spec.js +35 -0
  136. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  137. package/lib/src/react/index.d.ts +15 -15
  138. package/lib/src/react/index.js +12 -12
  139. package/lib/src/tokenizedFetch.d.ts +1 -1
  140. package/lib/src/tokenizedFetch.js +1 -1
  141. package/lib/src/types.d.ts +653 -276
  142. package/lib/src/types.d.ts.map +1 -1
  143. package/lib/src/types.js +274 -208
  144. package/lib/src/types.js.map +1 -1
  145. package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
  146. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  147. package/lib/src/utils/graphql/answerService/answerService.js +5 -3
  148. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  149. package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
  150. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  151. package/lib/src/utils.d.ts +9 -0
  152. package/lib/src/utils.d.ts.map +1 -1
  153. package/lib/src/utils.js +8 -0
  154. package/lib/src/utils.js.map +1 -1
  155. package/package.json +2 -2
  156. package/src/auth.ts +30 -5
  157. package/src/css-variables.ts +17 -17
  158. package/src/embed/app.spec.ts +46 -1
  159. package/src/embed/app.ts +73 -36
  160. package/src/embed/base.ts +2 -2
  161. package/src/embed/bodyless-conversation.ts +5 -5
  162. package/src/embed/conversation.spec.ts +37 -0
  163. package/src/embed/conversation.ts +55 -38
  164. package/src/embed/liveboard.spec.ts +1 -1
  165. package/src/embed/liveboard.ts +42 -36
  166. package/src/embed/sage.ts +5 -5
  167. package/src/embed/search-bar.tsx +7 -7
  168. package/src/embed/search.ts +16 -14
  169. package/src/embed/ts-embed.spec.ts +42 -0
  170. package/src/embed/ts-embed.ts +12 -7
  171. package/src/react/index.tsx +15 -15
  172. package/src/tokenizedFetch.ts +1 -1
  173. package/src/types.ts +652 -275
  174. package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
  175. package/src/utils/graphql/answerService/answerService.ts +6 -3
  176. package/src/utils.ts +14 -0
package/src/types.ts CHANGED
@@ -10,7 +10,7 @@ import { CustomCssVariables } from './css-variables';
10
10
  import type { SessionInterface } from './utils/graphql/answerService/answerService';
11
11
 
12
12
  /**
13
- * The authentication mechanism for allowing access to the
13
+ * The authentication mechanism for allowing access to
14
14
  * the embedded app
15
15
  * @group Authentication / Init
16
16
  */
@@ -36,6 +36,7 @@ export enum AuthType {
36
36
  * To use this:
37
37
  * Your SAML or OpenID provider must allow iframe redirects.
38
38
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
39
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
39
40
  * @example
40
41
  * ```js
41
42
  * init({
@@ -43,18 +44,17 @@ export enum AuthType {
43
44
  * authType: AuthType.EmbeddedSSO,
44
45
  * });
45
46
  * ```
46
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
47
47
  */
48
48
  EmbeddedSSO = 'EmbeddedSSO',
49
49
  /**
50
- * SSO using SAML
51
- * @deprecated Use {@link SAMLRedirect} instead
50
+ * SSO using SAML, Use {@link SAMLRedirect} instead
51
+ * @deprecated This option is deprecated.
52
52
  * @hidden
53
53
  */
54
54
  SSO = 'SSO_SAML',
55
55
  /**
56
- * SSO using SAML
57
- * @deprecated Use {@link SAMLRedirect} instead
56
+ * SSO using SAML, Use {@link SAMLRedirect} instead
57
+ * @deprecated This option is deprecated.
58
58
  * @hidden
59
59
  */
60
60
  SAML = 'SSO_SAML',
@@ -105,8 +105,9 @@ export enum AuthType {
105
105
  SAMLRedirect = 'SSO_SAML',
106
106
  /**
107
107
  * SSO using OIDC
108
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
109
+ * @deprecated This option is deprecated.
108
110
  * @hidden
109
- * @deprecated Use {@link OIDCRedirect} instead
110
111
  */
111
112
  OIDC = 'SSO_OIDC',
112
113
  /**
@@ -117,8 +118,9 @@ export enum AuthType {
117
118
  OIDCRedirect = 'SSO_OIDC',
118
119
  /**
119
120
  * Trusted authentication server
121
+ * Use {@link TrustedAuth} instead
122
+ * @deprecated This option is deprecated.
120
123
  * @hidden
121
- * @deprecated Use {@link TrustedAuth} instead
122
124
  */
123
125
  AuthServer = 'AuthServer',
124
126
  /**
@@ -145,6 +147,7 @@ export enum AuthType {
145
147
  * obtained from ThoughtSpot. This uses a cookieless authentication
146
148
  * approach, recommended to bypass the third-party cookie-blocking restriction
147
149
  * implemented by some browsers.
150
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
148
151
  * @example
149
152
  * ```js
150
153
  * init({
@@ -155,8 +158,8 @@ export enum AuthType {
155
158
  * .then((response) => response.json())
156
159
  * .then((data) => data.token);
157
160
  * }
161
+ * });
158
162
  * ```
159
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
160
163
  */
161
164
  TrustedAuthTokenCookieless = 'AuthServerCookieless',
162
165
  /**
@@ -177,43 +180,43 @@ export enum HomeLeftNavItem {
177
180
  /**
178
181
  * The *Search data* option in
179
182
  * the *Insights* left navigation panel.
180
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
183
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
181
184
  */
182
185
  SearchData = 'search-data',
183
186
  /**
184
187
  * The *Home* menu option in
185
188
  * the *Insights* left navigation panel.
186
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
189
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
187
190
  */
188
191
  Home = 'insights-home',
189
192
  /**
190
193
  * The *Liveboards* menu option in
191
194
  * the *Insights* left navigation panel.
192
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
195
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
193
196
  */
194
197
  Liveboards = 'liveboards',
195
198
  /**
196
199
  * The *Answers* menu option in
197
200
  * the *Insights* left navigation panel.
198
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
201
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
199
202
  */
200
203
  Answers = 'answers',
201
204
  /**
202
205
  * The *Monitor subscriptions* menu option in
203
206
  * the *Insights* left navigation panel.
204
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
207
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
205
208
  */
206
209
  MonitorSubscription = 'monitor-alerts',
207
210
  /**
208
211
  * The *SpotIQ analysis* menu option in
209
212
  * the *Insights* left navigation panel.
210
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
213
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
211
214
  */
212
215
  SpotIQAnalysis = 'spotiq-analysis',
213
216
  /**
214
217
  * The *Liveboard schedules* menu option in
215
218
  * the *Insights* left navigation panel.
216
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
219
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
217
220
  */
218
221
  LiveboardSchedules = 'liveboard-schedules',
219
222
  /**
@@ -390,8 +393,8 @@ export interface EmbedConfig {
390
393
  * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
391
394
  * open the SAML auth flow in a popup, instead of redirecting the browser in
392
395
  * place.
396
+ * @deprecated This option is deprecated.
393
397
  * @default false
394
- * @deprecated
395
398
  */
396
399
  noRedirect?: boolean;
397
400
 
@@ -401,8 +404,8 @@ export interface EmbedConfig {
401
404
  *
402
405
  * Need to use this with `authTriggerContainer`. Or manually trigger
403
406
  * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
404
- * @default false
405
407
  * @version SDK: 1.18.0
408
+ * @default false
406
409
  */
407
410
  inPopup?: boolean;
408
411
 
@@ -412,7 +415,7 @@ export interface EmbedConfig {
412
415
  * terminated.
413
416
  *
414
417
  * Eg: "/dashboard", "#/foo" [Do not include the host]
415
- * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
418
+ * @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
416
419
  */
417
420
  redirectPath?: string;
418
421
 
@@ -495,7 +498,7 @@ export interface EmbedConfig {
495
498
  detectCookieAccessSlow?: boolean;
496
499
  /**
497
500
  * Hide the `beta` alert warning message for SearchEmbed.
498
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
501
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
499
502
  */
500
503
  suppressSearchEmbedBetaWarning?: boolean;
501
504
  /**
@@ -512,6 +515,7 @@ export interface EmbedConfig {
512
515
  * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
513
516
  * button that the user can click to trigger the flow.
514
517
  * This attribute sets a containing element for that button.
518
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
515
519
  * @example
516
520
  * ```js
517
521
  * init({
@@ -520,7 +524,6 @@ export interface EmbedConfig {
520
524
  * authTriggerContainer: '#auth-trigger-container'
521
525
  * })
522
526
  * ```
523
- * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
524
527
  */
525
528
  authTriggerContainer?: string | HTMLElement;
526
529
  /**
@@ -537,11 +540,10 @@ export interface EmbedConfig {
537
540
  */
538
541
  authTriggerText?: string;
539
542
  /**
540
- * Prevent users from accessing the full application or ThoughtSpot application pages
541
- * access to the embedded application users
542
- * outside of the iframe.
543
- * @default true
543
+ * Prevent embedded application users from accessing ThoughtSpot
544
+ * application pages outside of the iframe.
544
545
  * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
546
+ * @default true
545
547
  */
546
548
  blockNonEmbedFullAppAccess?: boolean;
547
549
 
@@ -575,6 +577,7 @@ export interface EmbedConfig {
575
577
  * other logs such as warnings, information alerts,
576
578
  * and debug messages in the console output.
577
579
  *
580
+ * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
578
581
  * @default LogLevel.ERROR
579
582
  * @example
580
583
  * ```js
@@ -583,7 +586,6 @@ export interface EmbedConfig {
583
586
  * logLevel: LogLevel.SILENT
584
587
  * })
585
588
  * ```
586
- * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
587
589
  */
588
590
  logLevel?: LogLevel;
589
591
  /**
@@ -611,6 +613,7 @@ export interface EmbedConfig {
611
613
  * This flag is used to disable the token verification in the SDK.
612
614
  * Enabling this flag will also disable the caching of the token.
613
615
  * @hidden
616
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
614
617
  * @example
615
618
  * ```js
616
619
  * init({
@@ -618,13 +621,12 @@ export interface EmbedConfig {
618
621
  * disableTokenVerification : true
619
622
  * })
620
623
  * ```
621
- * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
622
624
  */
623
625
  disableTokenVerification?: boolean;
624
626
 
625
627
  /**
626
628
  * This flag is used to disable showing the login failure page in the embedded app.
627
- * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
629
+ * @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
628
630
  */
629
631
  disableLoginFailurePage?: boolean;
630
632
  /**
@@ -634,6 +636,7 @@ export interface EmbedConfig {
634
636
  * Warning: This option is for advanced use only and is used internally
635
637
  * to control embed behavior in non-regular ways. We do not publish the
636
638
  * list of supported keys and values associated with each.
639
+ * @version SDK: 1.33.5 | ThoughtSpot: *
637
640
  * @example
638
641
  * ```js
639
642
  * const embed = new LiveboardEmbed('#embed', {
@@ -644,12 +647,12 @@ export interface EmbedConfig {
644
647
  * }
645
648
  * });
646
649
  * ```
647
- * @version SDK: 1.33.5 | ThoughtSpot: *
648
650
  */
649
651
  additionalFlags?: { [key: string]: string | number | boolean };
650
652
  /**
651
653
  * This is an object (key/val) for customVariables being
652
654
  * used by the third party tool's script.
655
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
653
656
  * @example
654
657
  * ```js
655
658
  * const embed = new LiveboardEmbed('#embed', {
@@ -660,7 +663,6 @@ export interface EmbedConfig {
660
663
  * }
661
664
  * });
662
665
  * ```
663
- * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
664
666
  */
665
667
  customVariablesForThirdPartyTools?: Record<string, any>;
666
668
 
@@ -669,8 +671,8 @@ export interface EmbedConfig {
669
671
  /**
670
672
  * Disable fullscreen presentation mode functionality. When enabled, prevents entering
671
673
  * and exiting fullscreen mode for embedded visualizations during presentations.
672
- * @default true (feature is disabled by default)
673
674
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
675
+ * @default true (feature is disabled by default)
674
676
  * @example
675
677
  * ```js
676
678
  * init({
@@ -690,18 +692,154 @@ export interface EmbedConfig {
690
692
  * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
691
693
  * @example
692
694
  * ```js
693
- * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
695
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
694
696
  * init({
695
697
  * ... // other embed config options
696
698
  * customActions: [
697
699
  * {
698
- * name: 'customAction',
699
- * id: 'customAction',
700
+ * // Unique identifier for the custom action
701
+ * id: 'my-custom-action',
702
+ *
703
+ * // Display name shown to users in the UI
704
+ * name: 'My Custom Action',
705
+ *
706
+ * // Where the action appears in the UI
707
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
708
+ * // MENU: Shows in the "More" menu (three dots menu)
709
+ * // CONTEXTMENU: Shows in the right-click context menu
710
+ * position: CustomActionsPosition.PRIMARY,
711
+ *
712
+ * // What type of content this action applies to
713
+ * // ANSWER: Available on answer pages
714
+ * target: CustomActionTarget.ANSWER,
715
+ *
716
+ * // Optional: Restrict where this action appears based on data models
717
+ * // dataModelIds: {
718
+ * // // Restrict to specific data models
719
+ * // modelIds: ['model-id-1', 'model-id-2'],
720
+ * // // Restrict to specific columns within models
721
+ * // modelColumnNames: ['model-id::column-name']
722
+ * // },
723
+ *
724
+ * // Optional: Restrict where this action appears based on metadata
725
+ * // metadataIds: {
726
+ * // // Restrict to specific answers
727
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
728
+ * // },
729
+ * // // Restrict to specific groups (for group-based access control)
730
+ * // groupIds: ['group-id-1', 'group-id-2'],
731
+ * // // Restrict to specific organizations (for multi-org deployments)
732
+ * // orgIds: ['org-id-1', 'org-id-2'],
733
+ * }
734
+ * ],
735
+ * })
736
+ * ```
737
+ * @example
738
+ * ```js
739
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
740
+ * init({
741
+ * ... // other embed config options
742
+ * customActions: [
743
+ * {
744
+ * // Unique identifier for the custom action
745
+ * id: 'my-custom-action',
746
+ *
747
+ * // Display name shown to users in the UI
748
+ * name: 'My Custom Action',
749
+ *
750
+ * // Where the action appears in the UI
751
+ * // MENU: Shows in the "More" menu (three dots menu)
752
+ * // CONTEXTMENU: Shows in the right-click context menu
753
+ * position: CustomActionsPosition.MENU,
754
+ *
755
+ * // What type of content this action applies to
756
+ * // SPOTTER: Available in Spotter (AI-powered search)
757
+ * target: CustomActionTarget.SPOTTER,
758
+ *
759
+ * // Optional: Restrict where this action appears based on data models
760
+ * // dataModelIds: {
761
+ * // // Restrict to specific data models
762
+ * // modelIds: ['model-id-1', 'model-id-2'],
763
+ * // },
764
+ * // // Restrict to specific groups (for group-based access control)
765
+ * // groupIds: ['group-id-1'],
766
+ * // // Restrict to specific organizations (for multi-org deployments)
767
+ * // orgIds: ['org-id-1'],
768
+ * }
769
+ * ],
770
+ * })
771
+ * ```
772
+ * @example
773
+ * ```js
774
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
775
+ * init({
776
+ * ... // other embed config options
777
+ * customActions: [
778
+ * {
779
+ * // Unique identifier for the custom action
780
+ * id: 'my-liveboard-custom-action',
781
+ *
782
+ * // Display name shown to users in the UI
783
+ * name: 'My Liveboard Custom Action',
784
+ *
785
+ * // Where the action appears in the UI
786
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
787
+ * // MENU: Shows in the "More" menu (three dots menu)
788
+ * position: CustomActionsPosition.PRIMARY,
789
+ *
790
+ * // What type of content this action applies to
791
+ * // LIVEBOARD: Available on liveboard pages
792
+ * target: CustomActionTarget.LIVEBOARD,
793
+ *
794
+ * // Optional: Restrict where this action appears based on metadata
795
+ * // metadataIds: {
796
+ * // // Restrict to specific liveboards
797
+ * // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
798
+ * // },
799
+ * // // Restrict to specific groups (for group-based access control)
800
+ * // groupIds: ['group-id-1', 'group-id-2'],
801
+ * // // Restrict to specific organizations (for multi-org deployments)
802
+ * // orgIds: ['org-id-1', 'org-id-2'],
803
+ * },
804
+ * {
805
+ * // Unique identifier for the custom action
806
+ * id: 'my-viz-custom-action',
807
+ *
808
+ * // Display name shown to users in the UI
809
+ * name: 'My Viz Custom Action',
810
+ *
811
+ * // Where the action appears in the UI
812
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
813
+ * // MENU: Shows in the "More" menu (three dots menu)
814
+ * // CONTEXTMENU: Shows in the right-click context menu
815
+ * position: CustomActionsPosition.PRIMARY,
816
+ *
817
+ * // What type of content this action applies to
818
+ * // VIZ: Available on individual visualizations
700
819
  * target: CustomActionTarget.VIZ,
701
- * position: CustomActionPosition.PRIMARY,
702
- * }
820
+ *
821
+ * // Optional: Restrict where this action appears based on metadata
822
+ * // metadataIds: {
823
+ * // // Restrict to specific answers
824
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
825
+ * // // Restrict to specific liveboard. If liveboardId is
826
+ * // // passed, custom actions will appear on all vizzes of liveboard
827
+ * // liveboardIds: ['liveboard-id-1'],
828
+ * // // Restrict to specific vizIds
829
+ * // vizIds: ['viz-id-1']
830
+ * // },
831
+ * // dataModelIds: {
832
+ * // // Restrict to specific data models
833
+ * // modelIds: ['model-id-1', 'model-id-2'],
834
+ * // // Restrict to specific columns within models
835
+ * // modelColumnNames: ['model-id::column-name']
836
+ * // },
837
+ * // // Restrict to specific groups (for group-based access control)
838
+ * // groupIds: ['group-id-1', 'group-id-2'],
839
+ * // // Restrict to specific organizations (for multi-org deployments)
840
+ * // orgIds: ['org-id-1', 'org-id-2'],
703
841
  * }
704
- * ]
842
+ * ],
705
843
  * })
706
844
  * ```
707
845
  */
@@ -744,7 +882,7 @@ export interface FrameParams {
744
882
  */
745
883
  loading?: 'lazy' | 'eager' | 'auto';
746
884
  /**
747
- * This parameters will be passed on the iframe
885
+ * These parameters will be passed to the iframe
748
886
  * as is.
749
887
  */
750
888
  [key: string]: string | number | boolean | undefined;
@@ -821,8 +959,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
821
959
  */
822
960
  disabledActionReason?: string;
823
961
  /**
824
- * The list of actions to hide from the embedded.
825
- * This actions will be hidden from the user.
962
+ * The list of actions to hide from the embedded view.
963
+ * These actions will be hidden from the user.
826
964
  * Use this to hide an action.
827
965
  *
828
966
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
@@ -863,7 +1001,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
863
1001
  * The locale settings to apply to the embedded view.
864
1002
  *
865
1003
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
866
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1004
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
867
1005
  * @example
868
1006
  * ```js
869
1007
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -878,12 +1016,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
878
1016
  * This is an object (key/val) of override flags which will be applied
879
1017
  * to the internal embedded object. This can be used to add any
880
1018
  * URL flag.
881
- * If the same flags are passed in init, they will be overriden by the values here.
1019
+ * If the same flags are passed in init, they will be overridden by the values here.
882
1020
  * Warning: This option is for advanced use only and is used internally
883
1021
  * to control embed behavior in non-regular ways. We do not publish the
884
1022
  * list of supported keys and values associated with each.
885
1023
  *
886
1024
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1025
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
887
1026
  * @example
888
1027
  * ```js
889
1028
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -895,7 +1034,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
895
1034
  * },
896
1035
  * });
897
1036
  * ```
898
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
899
1037
  */
900
1038
  additionalFlags?: { [key: string]: string | number | boolean };
901
1039
  /**
@@ -936,6 +1074,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
936
1074
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
937
1075
  *
938
1076
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1077
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
939
1078
  * @example
940
1079
  * ```js
941
1080
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -945,7 +1084,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
945
1084
  * });
946
1085
  * embed.showPreRender();
947
1086
  * ```
948
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
949
1087
  */
950
1088
  preRenderId?: string;
951
1089
 
@@ -956,7 +1094,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
956
1094
  * its dimensions based on changes to the size of the embedding element.
957
1095
  * @type {boolean}
958
1096
  * @default false
959
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
1097
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
960
1098
  * @example
961
1099
  * ```js
962
1100
  * // Disable tracking PreRender size in the configuration
@@ -971,9 +1109,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
971
1109
  doNotTrackPreRenderSize?: boolean;
972
1110
  /**
973
1111
  * Enable the V2 shell. This can provide performance benefits
974
- * due to a lighterweight shell.
1112
+ * due to a lighter-weight shell.
975
1113
  *
976
1114
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1115
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
977
1116
  * @example
978
1117
  * ```js
979
1118
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -982,7 +1121,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
982
1121
  * enableV2Shell_experimental: true,
983
1122
  * });
984
1123
  * ```
985
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
986
1124
  */
987
1125
 
988
1126
  enableV2Shell_experimental?: boolean;
@@ -1002,6 +1140,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1002
1140
  * and disable redirection of links in a new tab.
1003
1141
  *
1004
1142
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1143
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1005
1144
  * @example
1006
1145
  * ```js
1007
1146
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1010,7 +1149,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1010
1149
  * disableRedirectionLinksInNewTab: true,
1011
1150
  * });
1012
1151
  * ```
1013
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1014
1152
  */
1015
1153
  disableRedirectionLinksInNewTab?: boolean;
1016
1154
  /**
@@ -1021,6 +1159,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1021
1159
  * Per Org URL feature is enabled on your ThoughtSpot instance.
1022
1160
  *
1023
1161
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1162
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
1024
1163
  * @example
1025
1164
  * ```js
1026
1165
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1029,24 +1168,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1029
1168
  * overrideOrgId: 142536,
1030
1169
  * });
1031
1170
  * ```
1032
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
1033
1171
  */
1034
1172
  overrideOrgId?: number;
1035
1173
  /**
1036
- * Flag to override the *Open Link in New Tab* context menu option.
1174
+ * Flag to override the *Open Link in New Tab* context
1175
+ * menu option.
1037
1176
  *
1038
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1177
+ * For improved link override handling, use
1178
+ * {@link enableLinkOverridesV2} instead.
1179
+ *
1180
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
1181
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
1182
+ * `SpotterEmbed`, `SearchBarEmbed`
1039
1183
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1040
1184
  * @example
1041
1185
  * ```js
1042
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
1043
- * const embed = new <EmbedComponent>('#tsEmbed', {
1186
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1044
1187
  * ... // other embed view config
1045
- * linkOverride:false,
1188
+ * linkOverride: true,
1046
1189
  * })
1047
1190
  * ```
1048
1191
  */
1049
1192
  linkOverride?: boolean;
1193
+ /**
1194
+ * Enables the V2 link override mechanism with improved
1195
+ * handling. When enabled, navigation links within the
1196
+ * embedded ThoughtSpot app are intercepted and routed
1197
+ * through the SDK via the `EmbedEvent.DialogOpen`
1198
+ * event.
1199
+ *
1200
+ * The SDK automatically sends {@link linkOverride}
1201
+ * alongside this flag for backward compatibility with
1202
+ * older ThoughtSpot versions.
1203
+ *
1204
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
1205
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
1206
+ * `SpotterEmbed`, `SearchBarEmbed`
1207
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
1208
+ * @example
1209
+ * ```js
1210
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1211
+ * ... // other embed view config
1212
+ * enableLinkOverridesV2: true,
1213
+ * });
1214
+ *
1215
+ * embed.on(EmbedEvent.DialogOpen, (payload) => {
1216
+ * console.log('Link clicked:', payload);
1217
+ * });
1218
+ * ```
1219
+ */
1220
+ enableLinkOverridesV2?: boolean;
1050
1221
  /**
1051
1222
  * The primary action to display on top of the viz for Liveboard and App Embed.
1052
1223
  * Use this to set the primary action.
@@ -1071,7 +1242,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1071
1242
  insertInToSlide?: boolean;
1072
1243
  /**
1073
1244
  * Show alert messages and toast messages in the embed.
1074
- * Supported embed in all embed types.
1245
+ * Supported in all embed types.
1075
1246
  *
1076
1247
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1077
1248
  * @example
@@ -1096,7 +1267,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1096
1267
  * ```ts
1097
1268
  * import {
1098
1269
  * CustomActionPayload,
1099
- * CustomActionPosition,
1270
+ * CustomActionsPosition,
1100
1271
  * CustomActionTarget,
1101
1272
  * } from '@thoughtspot/visual-embed-sdk';
1102
1273
  * // Use supported embed types such as AppEmbed or LiveboardEmbed
@@ -1104,13 +1275,41 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1104
1275
  * ... // other embed config options
1105
1276
  * customActions: [
1106
1277
  * {
1107
- * name: 'customAction',
1108
- * id: 'customAction',
1109
- * target: CustomActionTarget.VIZ,
1110
- * position: CustomActionPosition.PRIMARY,
1111
- * }
1278
+ * // Unique identifier for the custom action
1279
+ * id: 'my-custom-action',
1280
+ *
1281
+ * // Display name shown to users in the UI
1282
+ * name: 'My Custom Action',
1283
+ *
1284
+ * // Where the action appears in the UI
1285
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1286
+ * // MENU: Shows in the "More" menu (three dots menu)
1287
+ * // CONTEXTMENU: Shows in the right-click context menu
1288
+ * position: CustomActionsPosition.PRIMARY,
1289
+ *
1290
+ * // What type of content this action applies to
1291
+ * // ANSWER: Available on answer pages
1292
+ * target: CustomActionTarget.ANSWER,
1293
+ *
1294
+ * // Optional: Restrict where this action appears based on data models
1295
+ * // dataModelIds: {
1296
+ * // // Restrict to specific data models
1297
+ * // modelIds: ['model-id-1', 'model-id-2'],
1298
+ * // // Restrict to specific columns within models
1299
+ * // modelColumnNames: ['model-id::column-name']
1300
+ * // },
1301
+ *
1302
+ * // Optional: Restrict where this action appears based on metadata
1303
+ * // metadataIds: {
1304
+ * // // Restrict to specific answers
1305
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
1306
+ * // },
1307
+ * // // Restrict to specific groups (for group-based access control)
1308
+ * // groupIds: ['group-id-1', 'group-id-2'],
1309
+ * // // Restrict to specific organizations (for multi-org deployments)
1310
+ * // orgIds: ['org-id-1', 'org-id-2'],
1112
1311
  * }
1113
- * ]
1312
+ * ],
1114
1313
  * })
1115
1314
  *
1116
1315
  * // to trigger a custom flow on custom action click listen to Custom action embed event
@@ -1118,6 +1317,120 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1118
1317
  * console.log('Custom Action event:', payload);
1119
1318
  * })
1120
1319
  * ```
1320
+ * @example
1321
+ * ```ts
1322
+ * import {
1323
+ * CustomActionsPosition,
1324
+ * CustomActionTarget,
1325
+ * } from '@thoughtspot/visual-embed-sdk';
1326
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1327
+ * ... // other embed config options
1328
+ * customActions: [
1329
+ * {
1330
+ * // Unique identifier for the custom action
1331
+ * id: 'my-custom-action',
1332
+ *
1333
+ * // Display name shown to users in the UI
1334
+ * name: 'My Custom Action',
1335
+ *
1336
+ * // Where the action appears in the UI
1337
+ * // MENU: Shows in the "More" menu (three dots menu)
1338
+ * // CONTEXTMENU: Shows in the right-click context menu
1339
+ * position: CustomActionsPosition.MENU,
1340
+ *
1341
+ * // What type of content this action applies to
1342
+ * // SPOTTER: Available in Spotter (AI-powered search)
1343
+ * target: CustomActionTarget.SPOTTER,
1344
+ *
1345
+ * // Optional: Restrict where this action appears based on data models
1346
+ * // dataModelIds: {
1347
+ * // // Restrict to specific data models
1348
+ * // modelIds: ['model-id-1', 'model-id-2'],
1349
+ * // },
1350
+ * // // Restrict to specific groups (for group-based access control)
1351
+ * // groupIds: ['group-id-1'],
1352
+ * // // Restrict to specific organizations (for multi-org deployments)
1353
+ * // orgIds: ['org-id-1'],
1354
+ * }
1355
+ * ],
1356
+ * })
1357
+ * ```
1358
+ * @example
1359
+ * ```ts
1360
+ * import {
1361
+ * CustomActionsPosition,
1362
+ * CustomActionTarget,
1363
+ * } from '@thoughtspot/visual-embed-sdk';
1364
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1365
+ * ... // other embed config options
1366
+ * customActions: [
1367
+ * {
1368
+ * // Unique identifier for the custom action
1369
+ * id: 'my-liveboard-custom-action',
1370
+ *
1371
+ * // Display name shown to users in the UI
1372
+ * name: 'My Liveboard Custom Action',
1373
+ *
1374
+ * // Where the action appears in the UI
1375
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1376
+ * // MENU: Shows in the "More" menu (three dots menu)
1377
+ * position: CustomActionsPosition.PRIMARY,
1378
+ *
1379
+ * // What type of content this action applies to
1380
+ * // LIVEBOARD: Available on liveboard pages
1381
+ * target: CustomActionTarget.LIVEBOARD,
1382
+ *
1383
+ * // Optional: Restrict where this action appears based on metadata
1384
+ * // metadataIds: {
1385
+ * // // Restrict to specific liveboards
1386
+ * // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
1387
+ * // },
1388
+ * // // Restrict to specific groups (for group-based access control)
1389
+ * // groupIds: ['group-id-1', 'group-id-2'],
1390
+ * // // Restrict to specific organizations (for multi-org deployments)
1391
+ * // orgIds: ['org-id-1', 'org-id-2'],
1392
+ * },
1393
+ * {
1394
+ * // Unique identifier for the custom action
1395
+ * id: 'my-viz-custom-action',
1396
+ *
1397
+ * // Display name shown to users in the UI
1398
+ * name: 'My Viz Custom Action',
1399
+ *
1400
+ * // Where the action appears in the UI
1401
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1402
+ * // MENU: Shows in the "More" menu (three dots menu)
1403
+ * // CONTEXTMENU: Shows in the right-click context menu
1404
+ * position: CustomActionsPosition.PRIMARY,
1405
+ *
1406
+ * // What type of content this action applies to
1407
+ * // VIZ: Available on individual visualizations
1408
+ * target: CustomActionTarget.VIZ,
1409
+ *
1410
+ * // Optional: Restrict where this action appears based on metadata
1411
+ * // metadataIds: {
1412
+ * // // Restrict to specific answers
1413
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
1414
+ * // // Restrict to specific liveboard. If liveboardId is
1415
+ * // // passed, custom actions will appear on all vizzes of liveboard
1416
+ * // liveboardIds: ['liveboard-id-1'],
1417
+ * // // Restrict to specific vizIds
1418
+ * // vizIds: ['viz-id-1']
1419
+ * // },
1420
+ * // dataModelIds: {
1421
+ * // // Restrict to specific data models
1422
+ * // modelIds: ['model-id-1', 'model-id-2'],
1423
+ * // // Restrict to specific columns within models
1424
+ * // modelColumnNames: ['model-id::column-name']
1425
+ * // },
1426
+ * // // Restrict to specific groups (for group-based access control)
1427
+ * // groupIds: ['group-id-1', 'group-id-2'],
1428
+ * // // Restrict to specific organizations (for multi-org deployments)
1429
+ * // orgIds: ['org-id-1', 'org-id-2'],
1430
+ * }
1431
+ * ],
1432
+ * })
1433
+ * ```
1121
1434
  */
1122
1435
  customActions?: CustomAction[];
1123
1436
 
@@ -1217,7 +1530,7 @@ export interface HomePageConfig {
1217
1530
  * **Note**: This attribute is not supported in the classic (v1) homepage.
1218
1531
  *
1219
1532
  * Supported embed types: `AppEmbed`
1220
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1533
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1221
1534
  * @example
1222
1535
  * ```js
1223
1536
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
@@ -1238,6 +1551,7 @@ export interface HomePageConfig {
1238
1551
  * **Note**: This attribute is not supported in the classic (v1) homepage.
1239
1552
  *
1240
1553
  * Supported embed types: `AppEmbed`
1554
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1241
1555
  * @example
1242
1556
  * ```js
1243
1557
  * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
@@ -1248,7 +1562,6 @@ export interface HomePageConfig {
1248
1562
  * ... //other embed view configuration attributes
1249
1563
  * })
1250
1564
  * ```
1251
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1252
1565
  */
1253
1566
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
1254
1567
  }
@@ -1262,7 +1575,7 @@ export interface SearchLiveboardCommonViewConfig {
1262
1575
  * visualization, or Liveboard.
1263
1576
  *
1264
1577
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
1265
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1578
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1266
1579
  * @example
1267
1580
  * ```js
1268
1581
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1280,11 +1593,11 @@ export interface SearchLiveboardCommonViewConfig {
1280
1593
  */
1281
1594
  runtimeFilters?: RuntimeFilter[];
1282
1595
  /**
1283
- * The list of parameter override to apply to a search Answer,
1596
+ * The list of parameter overrides to apply to a search Answer,
1284
1597
  * visualization, or Liveboard.
1285
1598
  *
1286
1599
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
1287
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1600
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1288
1601
  * @example
1289
1602
  * ```js
1290
1603
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1304,6 +1617,7 @@ export interface SearchLiveboardCommonViewConfig {
1304
1617
  * flag to set ContextMenu Trigger to either left or right click.
1305
1618
  *
1306
1619
  * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
1620
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1307
1621
  * @example
1308
1622
  * ```js
1309
1623
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
@@ -1312,7 +1626,6 @@ export interface SearchLiveboardCommonViewConfig {
1312
1626
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
1313
1627
  * })
1314
1628
  * ```
1315
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1316
1629
  */
1317
1630
  contextMenuTrigger?: ContextMenuTriggerOptions;
1318
1631
  /**
@@ -1335,7 +1648,7 @@ export interface SearchLiveboardCommonViewConfig {
1335
1648
  * when set to false, runtime parameters will be included in the URL
1336
1649
  * (default behavior before SDK 1.45.0).
1337
1650
  *
1338
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
1651
+ * Irrespective of this flag, runtime parameters (if passed) will be applied to the
1339
1652
  * embedded view.
1340
1653
  * @default true
1341
1654
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
@@ -1354,14 +1667,15 @@ export interface SearchLiveboardCommonViewConfig {
1354
1667
  * ... // other embed view config
1355
1668
  * collapseSearchBar: true,
1356
1669
  * });
1670
+ * ```
1357
1671
  */
1358
1672
  collapseSearchBar?: boolean;
1359
1673
  /**
1360
1674
  * Flag to control Data panel experience
1361
1675
  *
1362
1676
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1677
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
1363
1678
  * @default true
1364
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
1365
1679
  * @example
1366
1680
  * ```js
1367
1681
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -1394,6 +1708,7 @@ export interface SearchLiveboardCommonViewConfig {
1394
1708
  * the current time period in filter results.
1395
1709
  *
1396
1710
  * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1711
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
1397
1712
  * @example
1398
1713
  * ```js
1399
1714
  * const embed = new <EmbedComponent>('#tsEmbed', {
@@ -1401,7 +1716,6 @@ export interface SearchLiveboardCommonViewConfig {
1401
1716
  * isThisPeriodInDateFiltersEnabled: true,
1402
1717
  * })
1403
1718
  * ```
1404
- * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
1405
1719
  */
1406
1720
  isThisPeriodInDateFiltersEnabled?: boolean;
1407
1721
  }
@@ -1462,6 +1776,7 @@ export interface LiveboardAppEmbedViewConfig {
1462
1776
  * Boolean to control if Liveboard header is sticky or not.
1463
1777
  *
1464
1778
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1779
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1465
1780
  * @example
1466
1781
  * ```js
1467
1782
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1470,7 +1785,6 @@ export interface LiveboardAppEmbedViewConfig {
1470
1785
  * isLiveboardHeaderSticky: true,
1471
1786
  * });
1472
1787
  * ```
1473
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1474
1788
  */
1475
1789
  isLiveboardHeaderSticky?: boolean;
1476
1790
  /**
@@ -1478,8 +1792,8 @@ export interface LiveboardAppEmbedViewConfig {
1478
1792
  *
1479
1793
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1480
1794
  * @type {boolean}
1795
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
1481
1796
  * @default false
1482
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1483
1797
  * @example
1484
1798
  * ```js
1485
1799
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1495,8 +1809,8 @@ export interface LiveboardAppEmbedViewConfig {
1495
1809
  *
1496
1810
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1497
1811
  * @type {boolean}
1812
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
1498
1813
  * @default false
1499
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
1500
1814
  * @example
1501
1815
  * ```js
1502
1816
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1512,7 +1826,7 @@ export interface LiveboardAppEmbedViewConfig {
1512
1826
  * header.
1513
1827
  *
1514
1828
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1515
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1829
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1516
1830
  * @default true
1517
1831
  * @example
1518
1832
  * ```js
@@ -1530,7 +1844,7 @@ export interface LiveboardAppEmbedViewConfig {
1530
1844
  * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
1531
1845
  *
1532
1846
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1533
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
1847
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
1534
1848
  * @default false
1535
1849
  * @example
1536
1850
  * ```js
@@ -1548,7 +1862,7 @@ export interface LiveboardAppEmbedViewConfig {
1548
1862
  * compact header
1549
1863
  *
1550
1864
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1551
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1865
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1552
1866
  * @default true
1553
1867
  * @example
1554
1868
  * ```js
@@ -1581,7 +1895,7 @@ export interface LiveboardAppEmbedViewConfig {
1581
1895
  * the cover and filters pages in the Liveboard PDF.
1582
1896
  *
1583
1897
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1584
- * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
1898
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
1585
1899
  * @example
1586
1900
  * ```js
1587
1901
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1819,7 +2133,7 @@ export enum HomepageModule {
1819
2133
  */
1820
2134
  Search = 'SEARCH',
1821
2135
  /**
1822
- * kPI watchlist module
2136
+ * KPI watchlist module
1823
2137
  */
1824
2138
  Watchlist = 'WATCHLIST',
1825
2139
  /**
@@ -1852,7 +2166,8 @@ export enum ListPageColumns {
1852
2166
  */
1853
2167
  Favorites = 'FAVOURITE',
1854
2168
  /**
1855
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
2169
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
2170
+ * @deprecated This option is deprecated.
1856
2171
  */
1857
2172
  Favourite = Favorites,
1858
2173
  /**
@@ -1956,13 +2271,13 @@ export enum EmbedEvent {
1956
2271
  /**
1957
2272
  * Rendering has initialized.
1958
2273
  * @example
1959
- *```js
2274
+ * ```js
1960
2275
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
1961
2276
  * //show a loader
1962
2277
  * function showLoader() {
1963
2278
  * document.getElementById("loader");
1964
2279
  * }
1965
- *```
2280
+ * ```
1966
2281
  * @returns timestamp - The timestamp when the event was generated.
1967
2282
  */
1968
2283
  Init = 'init',
@@ -1970,11 +2285,11 @@ export enum EmbedEvent {
1970
2285
  * Authentication has either succeeded or failed.
1971
2286
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
1972
2287
  * @example
1973
- *```js
2288
+ * ```js
1974
2289
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
1975
2290
  * console.log('AuthInit', payload);
1976
2291
  * })
1977
- *```
2292
+ * ```
1978
2293
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
1979
2294
  */
1980
2295
  AuthInit = 'authInit',
@@ -1983,13 +2298,13 @@ export enum EmbedEvent {
1983
2298
  * @returns timestamp - The timestamp when the event was generated.
1984
2299
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
1985
2300
  * @example
1986
- *```js
2301
+ * ```js
1987
2302
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
1988
2303
  * //hide loader
1989
2304
  * function hideLoader() {
1990
2305
  * document.getElementById("loader");
1991
2306
  * }
1992
- *```
2307
+ * ```
1993
2308
  */
1994
2309
  Load = 'load',
1995
2310
  /**
@@ -1998,11 +2313,11 @@ export enum EmbedEvent {
1998
2313
  * @return data - Answer of Liveboard data
1999
2314
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2000
2315
  * @example
2001
- *```js
2316
+ * ```js
2002
2317
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
2003
2318
  * console.log('data', payload);
2004
2319
  * })
2005
- *```
2320
+ * ```
2006
2321
  * @important
2007
2322
  */
2008
2323
  Data = 'data',
@@ -2010,9 +2325,9 @@ export enum EmbedEvent {
2010
2325
  * Search query has been updated by the user.
2011
2326
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2012
2327
  * @example
2013
- *```js
2328
+ * ```js
2014
2329
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
2015
- *```
2330
+ * ```
2016
2331
  */
2017
2332
  QueryChanged = 'queryChanged',
2018
2333
  /**
@@ -2022,7 +2337,7 @@ export enum EmbedEvent {
2022
2337
  * @returns drillDownColumns - The columns on which drill down was performed
2023
2338
  * @returns nonFilteredColumns - The columns that were not filtered
2024
2339
  * @example
2025
- *```js
2340
+ * ```js
2026
2341
  * searchEmbed.on(EmbedEvent.DrillDown, {
2027
2342
  * points: {
2028
2343
  * clickedPoint,
@@ -2030,12 +2345,12 @@ export enum EmbedEvent {
2030
2345
  * },
2031
2346
  * autoDrillDown: true,
2032
2347
  * })
2033
- *```
2348
+ * ```
2034
2349
  * In this example, `VizPointDoubleClick` event is used for
2035
2350
  * triggering the `DrillDown` event when an area or specific
2036
2351
  * data point on a table or chart is double-clicked.
2037
2352
  * @example
2038
- *```js
2353
+ * ```js
2039
2354
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
2040
2355
  * console.log(payload);
2041
2356
  * const clickedPoint = payload.data.clickedPoint;
@@ -2049,7 +2364,7 @@ export enum EmbedEvent {
2049
2364
  * autoDrillDown: true,
2050
2365
  * })
2051
2366
  * })
2052
- *```
2367
+ * ```
2053
2368
  */
2054
2369
  Drilldown = 'drillDown',
2055
2370
  /**
@@ -2174,13 +2489,13 @@ export enum EmbedEvent {
2174
2489
  * The ThoughtSpot authentication session has expired.
2175
2490
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2176
2491
  * @example
2177
- *```js
2492
+ * ```js
2178
2493
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
2179
2494
  * //show auth expired banner
2180
2495
  * function showAuthExpired() {
2181
2496
  * document.getElementById("authExpiredBanner");
2182
2497
  * }
2183
- *```
2498
+ * ```
2184
2499
  */
2185
2500
  AuthExpire = 'ThoughtspotAuthExpired',
2186
2501
  /**
@@ -2217,22 +2532,22 @@ export enum EmbedEvent {
2217
2532
  * Applicable to `SearchBarEmbed` only.
2218
2533
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2219
2534
  * @example
2220
- *```js
2535
+ * ```js
2221
2536
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
2222
2537
  * .then(data => {
2223
2538
  * console.log('Answer Data:', data);
2224
2539
  * })
2225
- *```
2540
+ * ```
2226
2541
  */
2227
2542
  GetDataClick = 'getDataClick',
2228
2543
  /**
2229
2544
  * Detects the route change.
2230
2545
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
2231
2546
  * @example
2232
- *```js
2547
+ * ```js
2233
2548
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
2234
2549
  * console.log('data', payload))
2235
- *```
2550
+ * ```
2236
2551
  */
2237
2552
  RouteChange = 'ROUTE_CHANGE',
2238
2553
  /**
@@ -2242,12 +2557,12 @@ export enum EmbedEvent {
2242
2557
  V1Data = 'exportVizDataToParent',
2243
2558
  /**
2244
2559
  * Emitted when the embed does not have cookie access. This happens
2245
- * when Safari and other Web browsers block third-party cookies
2246
- * are blocked by default. `NoCookieAccess` can trigger.
2560
+ * when third-party cookies are blocked by Safari or other
2561
+ * web browsers. `NoCookieAccess` can trigger.
2247
2562
  * @example
2248
- *```js
2563
+ * ```js
2249
2564
  * appEmbed.on(EmbedEvent.NoCookieAccess)
2250
- *```
2565
+ * ```
2251
2566
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
2252
2567
  */
2253
2568
  NoCookieAccess = 'noCookieAccess',
@@ -2261,22 +2576,22 @@ export enum EmbedEvent {
2261
2576
  * Emitted when any modal is opened in the app
2262
2577
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2263
2578
  * @example
2264
- *```js
2579
+ * ```js
2265
2580
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
2266
2581
  * console.log('dialog open', payload);
2267
2582
  * })
2268
- *```
2583
+ * ```
2269
2584
  */
2270
2585
  DialogOpen = 'dialog-open',
2271
2586
  /**
2272
2587
  * Emitted when any modal is closed in the app
2273
2588
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2274
2589
  * @example
2275
- *```js
2590
+ * ```js
2276
2591
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
2277
2592
  * console.log('dialog close', payload);
2278
2593
  * })
2279
- *```
2594
+ * ```
2280
2595
  */
2281
2596
  DialogClose = 'dialog-close',
2282
2597
  /**
@@ -2285,39 +2600,39 @@ export enum EmbedEvent {
2285
2600
  * other events on the rendered Liveboard.
2286
2601
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2287
2602
  * @example
2288
- *```js
2603
+ * ```js
2289
2604
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
2290
2605
  console.log('Liveboard is rendered', payload);
2291
2606
  })
2292
- *```
2607
+ * ```
2293
2608
  * The following example shows how to trigger
2294
2609
  * `SetVisibleVizs` event using LiveboardRendered embed event:
2295
2610
  * @example
2296
- *```js
2611
+ * ```js
2297
2612
  * const embedRef = useEmbedRef();
2298
2613
  * const onLiveboardRendered = () => {
2299
2614
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
2300
2615
  * };
2301
- *```
2616
+ * ```
2302
2617
  */
2303
2618
  LiveboardRendered = 'PinboardRendered',
2304
2619
  /**
2305
2620
  * Emits all events.
2306
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2621
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2307
2622
  * @example
2308
- *```js
2623
+ * ```js
2309
2624
  * appEmbed.on(EmbedEvent.ALL, payload => {
2310
2625
  * console.log('Embed Events', payload)
2311
2626
  * })
2312
- *```
2627
+ * ```
2313
2628
  */
2314
2629
  ALL = '*',
2315
2630
  /**
2316
2631
  * Emitted when an Answer is saved in the app.
2317
2632
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
2318
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2633
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2319
2634
  * @example
2320
- *```js
2635
+ * ```js
2321
2636
  * //Emit when action starts
2322
2637
  * searchEmbed.on(EmbedEvent.Save, payload => {
2323
2638
  * console.log('Save', payload)
@@ -2328,7 +2643,7 @@ export enum EmbedEvent {
2328
2643
  * searchEmbed.on(EmbedEvent.Save, payload => {
2329
2644
  * console.log('Save', payload)
2330
2645
  * })
2331
- *```
2646
+ * ```
2332
2647
  */
2333
2648
  Save = 'save',
2334
2649
  /**
@@ -2340,11 +2655,11 @@ export enum EmbedEvent {
2340
2655
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
2341
2656
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2342
2657
  * @example
2343
- *```js
2658
+ * ```js
2344
2659
  * liveboardEmbed.on(EmbedEvent.Download, {
2345
2660
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2346
2661
  * })
2347
- *```
2662
+ * ```
2348
2663
  */
2349
2664
  Download = 'download',
2350
2665
  /**
@@ -2352,14 +2667,14 @@ export enum EmbedEvent {
2352
2667
  * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
2353
2668
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
2354
2669
  * @example
2355
- *```js
2670
+ * ```js
2356
2671
  * //emit when action starts
2357
2672
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2358
2673
  * console.log('download PNG', payload)}, {start: true })
2359
2674
  * //emit when action ends
2360
2675
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2361
2676
  * console.log('download PNG', payload)})
2362
- *```
2677
+ * ```
2363
2678
  */
2364
2679
  DownloadAsPng = 'downloadAsPng',
2365
2680
  /**
@@ -2367,14 +2682,14 @@ export enum EmbedEvent {
2367
2682
  * 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.
2368
2683
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2369
2684
  * @example
2370
- *```js
2685
+ * ```js
2371
2686
  * //emit when action starts
2372
2687
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2373
2688
  * console.log('download PDF', payload)}, {start: true })
2374
2689
  * //emit when action ends
2375
2690
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2376
2691
  * console.log('download PDF', payload)})
2377
- *```
2692
+ * ```
2378
2693
  */
2379
2694
  DownloadAsPdf = 'downloadAsPdf',
2380
2695
  /**
@@ -2382,14 +2697,14 @@ export enum EmbedEvent {
2382
2697
  * 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.
2383
2698
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2384
2699
  * @example
2385
- *```js
2700
+ * ```js
2386
2701
  * //emit when action starts
2387
2702
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2388
2703
  * console.log('download CSV', payload)}, {start: true })
2389
2704
  * //emit when action ends
2390
2705
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2391
2706
  * console.log('download CSV', payload)})
2392
- *```
2707
+ * ```
2393
2708
  */
2394
2709
  DownloadAsCsv = 'downloadAsCsv',
2395
2710
  /**
@@ -2397,14 +2712,14 @@ export enum EmbedEvent {
2397
2712
  * 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.
2398
2713
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2399
2714
  * @example
2400
- *```js
2715
+ * ```js
2401
2716
  * //emit when action starts
2402
2717
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2403
2718
  * console.log('download Xlsx', payload)}, { start: true })
2404
2719
  * //emit when action ends
2405
2720
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2406
2721
  * console.log('download Xlsx', payload)})
2407
- *```
2722
+ * ```
2408
2723
  */
2409
2724
  DownloadAsXlsx = 'downloadAsXlsx',
2410
2725
  /**
@@ -2412,25 +2727,25 @@ export enum EmbedEvent {
2412
2727
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
2413
2728
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2414
2729
  * @example
2415
- *```js
2730
+ * ```js
2416
2731
  * //emit when action starts
2417
2732
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2418
2733
  * console.log('delete answer', payload)}, {start: true })
2419
2734
  * //trigger when action is completed
2420
2735
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2421
2736
  * console.log('delete answer', payload)})
2422
- *```
2737
+ * ```
2423
2738
  */
2424
2739
  AnswerDelete = 'answerDelete',
2425
2740
  /**
2426
2741
  * Emitted when the AI Highlights action is triggered on a Liveboard
2427
2742
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
2428
2743
  * @example
2429
- *```js
2744
+ * ```js
2430
2745
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
2431
2746
  * console.log('AI Highlights', payload);
2432
2747
  * })
2433
- *```
2748
+ * ```
2434
2749
  */
2435
2750
  AIHighlights = 'AIHighlights',
2436
2751
  /**
@@ -2439,7 +2754,7 @@ export enum EmbedEvent {
2439
2754
  * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
2440
2755
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2441
2756
  * @example
2442
- *```js
2757
+ * ```js
2443
2758
  * //emit when action starts
2444
2759
  * searchEmbed.on(EmbedEvent.Pin, payload => {
2445
2760
  * console.log('pin', payload)
@@ -2450,14 +2765,14 @@ export enum EmbedEvent {
2450
2765
  * searchEmbed.on(EmbedEvent.Pin, payload => {
2451
2766
  * console.log('pin', payload)
2452
2767
  * })
2453
- *```
2768
+ * ```
2454
2769
  */
2455
2770
  Pin = 'pin',
2456
2771
  /**
2457
2772
  * Emitted when SpotIQ analysis is triggered
2458
2773
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2459
2774
  * @example
2460
- *```js
2775
+ * ```js
2461
2776
  * //emit when action starts
2462
2777
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2463
2778
  * console.log('SpotIQAnalyze', payload)
@@ -2468,14 +2783,14 @@ export enum EmbedEvent {
2468
2783
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2469
2784
  * console.log('SpotIQ analyze', payload)
2470
2785
  * })
2471
- *```
2786
+ * ```
2472
2787
  */
2473
2788
  SpotIQAnalyze = 'spotIQAnalyze',
2474
2789
  /**
2475
2790
  * Emitted when a user shares an object with another user or group
2476
2791
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2477
2792
  * @example
2478
- *```js
2793
+ * ```js
2479
2794
  * //emit when action starts
2480
2795
  * searchEmbed.on(EmbedEvent.Share, payload => {
2481
2796
  * console.log('Share', payload)
@@ -2486,7 +2801,7 @@ export enum EmbedEvent {
2486
2801
  * searchEmbed.on(EmbedEvent.Share, payload => {
2487
2802
  * console.log('Share', payload)
2488
2803
  * })
2489
- *```
2804
+ * ```
2490
2805
  */
2491
2806
  Share = 'share',
2492
2807
  /**
@@ -2494,11 +2809,11 @@ export enum EmbedEvent {
2494
2809
  * data on a chart or table.
2495
2810
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2496
2811
  * @example
2497
- *```js
2812
+ * ```js
2498
2813
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
2499
2814
  * console.log('Drill include', payload);
2500
2815
  * })
2501
- *```
2816
+ * ```
2502
2817
  */
2503
2818
  DrillInclude = 'context-menu-item-include',
2504
2819
  /**
@@ -2506,22 +2821,22 @@ export enum EmbedEvent {
2506
2821
  * data on a chart or table
2507
2822
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2508
2823
  * @example
2509
- *```js
2824
+ * ```js
2510
2825
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
2511
2826
  * console.log('Drill exclude', payload);
2512
2827
  * })
2513
- *```
2828
+ * ```
2514
2829
  */
2515
2830
  DrillExclude = 'context-menu-item-exclude',
2516
2831
  /**
2517
2832
  * Emitted when a column value is copied in the embedded app.
2518
2833
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2519
2834
  * @example
2520
- *```js
2521
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2835
+ * ```js
2836
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2522
2837
  * console.log('copy to clipboard', payload);
2523
2838
  * })
2524
- *```
2839
+ * ```
2525
2840
  */
2526
2841
  CopyToClipboard = 'context-menu-item-copy-to-clipboard',
2527
2842
  /**
@@ -2529,10 +2844,10 @@ export enum EmbedEvent {
2529
2844
  * embedded Liveboard.
2530
2845
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2531
2846
  * @example
2532
- *```js
2847
+ * ```js
2533
2848
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
2534
2849
  * })
2535
- *```
2850
+ * ```
2536
2851
  */
2537
2852
  UpdateTML = 'updateTSL',
2538
2853
  /**
@@ -2540,11 +2855,11 @@ export enum EmbedEvent {
2540
2855
  * on an embedded Liveboard.
2541
2856
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2542
2857
  * @example
2543
- *```js
2858
+ * ```js
2544
2859
  * appEmbed.on(EmbedEvent.EditTML, payload => {
2545
2860
  * console.log('Edit TML', payload);
2546
2861
  * })
2547
- *```
2862
+ * ```
2548
2863
  */
2549
2864
  EditTML = 'editTSL',
2550
2865
  /**
@@ -2553,25 +2868,25 @@ export enum EmbedEvent {
2553
2868
  * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
2554
2869
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2555
2870
  * @example
2556
- *```js
2871
+ * ```js
2557
2872
  * //emit when action starts
2558
2873
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2559
2874
  * console.log('Export TML', payload)}, { start: true })
2560
2875
  * //emit when action ends
2561
2876
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2562
2877
  * console.log('Export TML', payload)})
2563
- *```
2878
+ * ```
2564
2879
  */
2565
2880
  ExportTML = 'exportTSL',
2566
2881
  /**
2567
2882
  * Emitted when an Answer is saved as a View.
2568
2883
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2569
2884
  * @example
2570
- *```js
2885
+ * ```js
2571
2886
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
2572
2887
  * console.log('View', payload);
2573
2888
  * })
2574
- *```
2889
+ * ```
2575
2890
  */
2576
2891
  SaveAsView = 'saveAsView',
2577
2892
  /**
@@ -2579,36 +2894,36 @@ export enum EmbedEvent {
2579
2894
  * 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.
2580
2895
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2581
2896
  * @example
2582
- *```js
2897
+ * ```js
2583
2898
  * //emit when action starts
2584
2899
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2585
2900
  * console.log('Copy and edit', payload)}, {start: true })
2586
2901
  * //emit when action ends
2587
2902
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2588
2903
  * console.log('Copy and edit', payload)})
2589
- *```
2904
+ * ```
2590
2905
  */
2591
2906
  CopyAEdit = 'copyAEdit',
2592
2907
  /**
2593
2908
  * Emitted when a user clicks *Show underlying data* on an Answer.
2594
2909
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2595
2910
  * @example
2596
- *```js
2911
+ * ```js
2597
2912
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
2598
2913
  * console.log('show data', payload);
2599
2914
  * })
2600
- *```
2915
+ * ```
2601
2916
  */
2602
2917
  ShowUnderlyingData = 'showUnderlyingData',
2603
2918
  /**
2604
2919
  * Emitted when an Answer is switched to a chart or table view.
2605
2920
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2606
2921
  * @example
2607
- *```js
2922
+ * ```js
2608
2923
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
2609
2924
  * console.log('switch view', payload);
2610
2925
  * })
2611
- *```
2926
+ * ```
2612
2927
  */
2613
2928
  AnswerChartSwitcher = 'answerChartSwitcher',
2614
2929
  /**
@@ -2625,118 +2940,118 @@ export enum EmbedEvent {
2625
2940
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
2626
2941
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2627
2942
  * @example
2628
- *```js
2943
+ * ```js
2629
2944
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
2630
2945
  * console.log('Liveboard details', payload);
2631
2946
  * })
2632
- *```
2947
+ * ```
2633
2948
  */
2634
2949
  LiveboardInfo = 'pinboardInfo',
2635
2950
  /**
2636
2951
  * Emitted when a user clicks on the Favorite icon on a Liveboard
2637
2952
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2638
2953
  * @example
2639
- *```js
2954
+ * ```js
2640
2955
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
2641
2956
  * console.log('favorites', payload);
2642
2957
  * })
2643
- *```
2958
+ * ```
2644
2959
  */
2645
2960
  AddToFavorites = 'addToFavorites',
2646
2961
  /**
2647
2962
  * Emitted when a user clicks **Schedule** on a Liveboard
2648
2963
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2649
2964
  * @example
2650
- *```js
2965
+ * ```js
2651
2966
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
2652
- * console.log(`Liveboard schedule', payload);
2967
+ * console.log('Liveboard schedule', payload);
2653
2968
  * })
2654
- *```
2969
+ * ```
2655
2970
  */
2656
2971
  Schedule = 'subscription',
2657
2972
  /**
2658
2973
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
2659
2974
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2660
2975
  * @example
2661
- *```js
2976
+ * ```js
2662
2977
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
2663
- * console.log(`Liveboard edit', payload);
2978
+ * console.log('Liveboard edit', payload);
2664
2979
  * })
2665
- *```
2980
+ * ```
2666
2981
  */
2667
2982
  Edit = 'edit',
2668
2983
  /**
2669
2984
  * Emitted when a user clicks *Make a copy* on a Liveboard
2670
2985
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2671
2986
  * @example
2672
- *```js
2987
+ * ```js
2673
2988
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
2674
- * console.log(`Copy', payload);
2989
+ * console.log('Copy', payload);
2675
2990
  * })
2676
- *```
2991
+ * ```
2677
2992
  */
2678
2993
  MakeACopy = 'makeACopy',
2679
2994
  /**
2680
2995
  * Emitted when a user clicks **Present** on a Liveboard or visualization
2681
2996
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2682
2997
  * @example
2683
- *```js
2998
+ * ```js
2684
2999
  * liveboardEmbed.on(EmbedEvent.Present)
2685
- *```
3000
+ * ```
2686
3001
  * @example
2687
- *```js
3002
+ * ```js
2688
3003
  * liveboardEmbed.on(EmbedEvent.Present, {
2689
3004
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2690
3005
  * })
2691
- *```
3006
+ * ```
2692
3007
  */
2693
3008
  Present = 'present',
2694
3009
  /**
2695
3010
  * Emitted when a user clicks **Delete** on a visualization
2696
3011
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2697
3012
  * @example
2698
- *```js
3013
+ * ```js
2699
3014
  * liveboardEmbed.on(EmbedEvent.Delete,
2700
3015
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2701
- *```
3016
+ * ```
2702
3017
  */
2703
3018
  Delete = 'delete',
2704
3019
  /**
2705
3020
  * Emitted when a user clicks Manage schedules on a Liveboard
2706
3021
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2707
3022
  * @example
2708
- *```js
3023
+ * ```js
2709
3024
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
2710
- *```
3025
+ * ```
2711
3026
  */
2712
3027
  SchedulesList = 'schedule-list',
2713
3028
  /**
2714
3029
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
2715
3030
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2716
3031
  * @example
2717
- *```js
3032
+ * ```js
2718
3033
  * liveboardEmbed.on(EmbedEvent.Cancel)
2719
- *```
3034
+ * ```
2720
3035
  */
2721
3036
  Cancel = 'cancel',
2722
3037
  /**
2723
3038
  * Emitted when a user clicks **Explore** on a visualization
2724
3039
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2725
3040
  * @example
2726
- *```js
3041
+ * ```js
2727
3042
  * liveboardEmbed.on(EmbedEvent.Explore, {
2728
3043
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2729
- *```
3044
+ * ```
2730
3045
  */
2731
3046
  Explore = 'explore',
2732
3047
  /**
2733
3048
  * Emitted when a user clicks **Copy link** action on a visualization.
2734
3049
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2735
3050
  * @example
2736
- *```js
3051
+ * ```js
2737
3052
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
2738
3053
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2739
- *```
3054
+ * ```
2740
3055
  */
2741
3056
  CopyLink = 'embedDocument',
2742
3057
  /**
@@ -2744,21 +3059,21 @@ export enum EmbedEvent {
2744
3059
  * visualization or Liveboard.
2745
3060
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2746
3061
  * @example
2747
- *```js
3062
+ * ```js
2748
3063
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
2749
3064
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2750
- *```
3065
+ * ```
2751
3066
  */
2752
3067
  CrossFilterChanged = 'cross-filter-changed',
2753
3068
  /**
2754
3069
  * Emitted when a user right clicks on a visualization (chart or table)
2755
3070
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2756
3071
  * @example
2757
- *```js
3072
+ * ```js
2758
3073
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
2759
3074
  * console.log('VizPointClick', payload)
2760
3075
  * })
2761
- *```
3076
+ * ```
2762
3077
  */
2763
3078
  VizPointRightClick = 'vizPointRightClick',
2764
3079
  /**
@@ -2772,35 +3087,35 @@ export enum EmbedEvent {
2772
3087
  * filter details.
2773
3088
  * @example
2774
3089
  *
2775
- *```js
3090
+ * ```js
2776
3091
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
2777
3092
  * console.log('payload', payload);
2778
3093
  * })
2779
- *
3094
+ * ```
2780
3095
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
2781
3096
  */
2782
3097
  FilterChanged = 'filterChanged',
2783
3098
  /**
2784
3099
  * Emitted when a user clicks the **Go** button to initiate
2785
3100
  * a Natural Language Search query
2786
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3101
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2787
3102
  */
2788
3103
  SageEmbedQuery = 'sageEmbedQuery',
2789
3104
  /**
2790
3105
  * Emitted when a user selects a data source on the embedded
2791
3106
  * Natural Language Search interface.
2792
3107
  *
2793
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3108
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2794
3109
  */
2795
3110
  SageWorksheetUpdated = 'sageWorksheetUpdated',
2796
3111
  /**
2797
3112
  * Emitted when a user updates a connection on the **Data** page
2798
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3113
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2799
3114
  */
2800
3115
  UpdateConnection = 'updateConnection',
2801
3116
  /**
2802
3117
  * Emitted when a user updates a connection on the **Data** page
2803
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3118
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2804
3119
  */
2805
3120
  CreateConnection = 'createConnection',
2806
3121
  /**
@@ -2810,7 +3125,7 @@ export enum EmbedEvent {
2810
3125
  * @returns viewId: string
2811
3126
  * @returns liveboardId: string
2812
3127
  * @returns isPublic: boolean
2813
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3128
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2814
3129
  */
2815
3130
  UpdatePersonalisedView = 'updatePersonalisedView',
2816
3131
  /**
@@ -2819,7 +3134,7 @@ export enum EmbedEvent {
2819
3134
  * @returns viewId: string
2820
3135
  * @returns liveboardId: string
2821
3136
  * @returns isPublic: boolean
2822
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3137
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2823
3138
  */
2824
3139
  SavePersonalisedView = 'savePersonalisedView',
2825
3140
  /**
@@ -2828,19 +3143,19 @@ export enum EmbedEvent {
2828
3143
  * @returns viewId: string
2829
3144
  * @returns liveboardId: string
2830
3145
  * @returns isPublic: boolean
2831
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3146
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2832
3147
  */
2833
3148
  ResetLiveboard = 'resetLiveboard',
2834
3149
  /**
2835
3150
  * Emitted when a PersonalisedView is deleted.
2836
3151
  * @returns views: string[]
2837
3152
  * @returns liveboardId: string
2838
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3153
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2839
3154
  */
2840
3155
  DeletePersonalisedView = 'deletePersonalisedView',
2841
3156
  /**
2842
3157
  * Emitted when a user creates a Worksheet.
2843
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3158
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2844
3159
  */
2845
3160
  CreateWorksheet = 'createWorksheet',
2846
3161
  /**
@@ -2849,12 +3164,12 @@ export enum EmbedEvent {
2849
3164
  * @returns viewId: string
2850
3165
  * @returns liveboardId: string
2851
3166
  * @returns isPublic: boolean
2852
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3167
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
2853
3168
  */
2854
3169
  AskSageInit = 'AskSageInit',
2855
3170
  /**
2856
3171
  * Emitted when a Liveboard or visualization is renamed.
2857
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3172
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
2858
3173
  */
2859
3174
  Rename = 'rename',
2860
3175
  /**
@@ -2872,14 +3187,12 @@ export enum EmbedEvent {
2872
3187
  * - `payload`: The payload received from the embed related to the Data API call.
2873
3188
  * - `responder`: Contains elements that let developers define whether ThoughtSpot
2874
3189
  * will run or block the search operation, and if blocked, which error message to provide.
2875
- *
2876
- * `execute` - When `execute` returns `true`, the search is run.
3190
+ * - `execute` - When `execute` returns `true`, the search is run.
2877
3191
  * When `execute` returns `false`, the search is not executed.
2878
- *
2879
- * `error` - Developers can customize the user-facing error message when `execute`
3192
+ * - `error` - Developers can customize the user-facing error message when `execute`
2880
3193
  * is `false` by using the `error` parameters in `responder`.
2881
- * `errorText` - The error message text shown to the user.
2882
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3194
+ * - `errorText` - The error message text shown to the user.
3195
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
2883
3196
  * @example
2884
3197
  *
2885
3198
  * This example blocks search operation and returns a custom error message:
@@ -2894,7 +3207,7 @@ export enum EmbedEvent {
2894
3207
  * },
2895
3208
  * },
2896
3209
  * });
2897
- * });
3210
+ * })
2898
3211
  * ```
2899
3212
  * @example
2900
3213
  *
@@ -2920,7 +3233,7 @@ export enum EmbedEvent {
2920
3233
  * },
2921
3234
  * },
2922
3235
  * });
2923
- * });
3236
+ * })
2924
3237
  * ```
2925
3238
  */
2926
3239
  OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
@@ -2931,8 +3244,8 @@ export enum EmbedEvent {
2931
3244
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
2932
3245
  * console.log('payload', payload);
2933
3246
  * })
2934
- *```
2935
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3247
+ * ```
3248
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
2936
3249
  */
2937
3250
  ParameterChanged = 'parameterChanged',
2938
3251
  /**
@@ -2987,24 +3300,24 @@ export enum EmbedEvent {
2987
3300
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
2988
3301
  * console.log('payload', payload);
2989
3302
  * })
2990
- *```
2991
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
3303
+ * ```
3304
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
2992
3305
  */
2993
3306
  CreateLiveboard = 'createLiveboard',
2994
3307
  /**
2995
3308
  * Emitted when a user creates a Model.
2996
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
3309
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
2997
3310
  */
2998
3311
  CreateModel = 'createModel',
2999
3312
  /**
3000
3313
  * @hidden
3001
3314
  * Emitted when a user exits present mode.
3002
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
3315
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3003
3316
  */
3004
3317
  ExitPresentMode = 'exitPresentMode',
3005
3318
  /**
3006
3319
  * Emitted when a user requests the full height lazy load data.
3007
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
3320
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3008
3321
  * @hidden
3009
3322
  */
3010
3323
  RequestVisibleEmbedCoordinates = 'requestVisibleEmbedCoordinates',
@@ -3015,7 +3328,7 @@ export enum EmbedEvent {
3015
3328
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
3016
3329
  * console.log('payload', payload);
3017
3330
  * })
3018
- *```
3331
+ * ```
3019
3332
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3020
3333
  */
3021
3334
  SpotterData = 'SpotterData',
@@ -3026,7 +3339,7 @@ export enum EmbedEvent {
3026
3339
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
3027
3340
  * console.log('payload', payload);
3028
3341
  * })
3029
- *```
3342
+ * ```
3030
3343
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3031
3344
  */
3032
3345
  PreviewSpotterData = 'PreviewSpotterData',
@@ -3037,7 +3350,7 @@ export enum EmbedEvent {
3037
3350
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
3038
3351
  * console.log('payload', payload);
3039
3352
  * })
3040
- *```
3353
+ * ```
3041
3354
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3042
3355
  */
3043
3356
  AddToCoaching = 'addToCoaching',
@@ -3059,7 +3372,7 @@ export enum EmbedEvent {
3059
3372
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
3060
3373
  * console.log('payload', payload);
3061
3374
  * })
3062
- *```
3375
+ * ```
3063
3376
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3064
3377
  */
3065
3378
  SpotterQueryTriggered = 'SpotterQueryTriggered',
@@ -3070,7 +3383,7 @@ export enum EmbedEvent {
3070
3383
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
3071
3384
  * console.log('payload', payload);
3072
3385
  * })
3073
- *```
3386
+ * ```
3074
3387
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3075
3388
  */
3076
3389
  LastPromptEdited = 'LastPromptEdited',
@@ -3081,18 +3394,18 @@ export enum EmbedEvent {
3081
3394
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
3082
3395
  * console.log('payload', payload);
3083
3396
  * })
3084
- *```
3397
+ * ```
3085
3398
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3086
3399
  */
3087
3400
  LastPromptDeleted = 'LastPromptDeleted',
3088
3401
  /**
3089
- * Emitted when the coversation is reset in spotter embed.
3402
+ * Emitted when the conversation is reset in Spotter embed.
3090
3403
  * @example
3091
3404
  * ```js
3092
3405
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
3093
3406
  * console.log('payload', payload);
3094
3407
  * })
3095
- *```
3408
+ * ```
3096
3409
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3097
3410
  */
3098
3411
  ResetSpotterConversation = 'ResetSpotterConversation',
@@ -3103,7 +3416,7 @@ export enum EmbedEvent {
3103
3416
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
3104
3417
  * console.log('payload', payload);
3105
3418
  * })
3106
- *```
3419
+ * ```
3107
3420
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
3108
3421
  */
3109
3422
  SpotterInit = 'spotterInit',
@@ -3114,7 +3427,7 @@ export enum EmbedEvent {
3114
3427
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
3115
3428
  * console.log('payload', payload);
3116
3429
  * })
3117
- *```
3430
+ * ```
3118
3431
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
3119
3432
  */
3120
3433
  SpotterLoadComplete = 'spotterLoadComplete',
@@ -3471,7 +3784,7 @@ export enum HostEvent {
3471
3784
  * ```js
3472
3785
  * appEmbed.navigateToPage(-1)
3473
3786
  * ```
3474
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
3787
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
3475
3788
  */
3476
3789
  Navigate = 'Navigate',
3477
3790
  /**
@@ -3604,9 +3917,9 @@ export enum HostEvent {
3604
3917
  * Trigger the **Show Liveboard details** action
3605
3918
  * on an embedded Liveboard.
3606
3919
  * @example
3607
- *```js
3920
+ * ```js
3608
3921
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
3609
- *```
3922
+ * ```
3610
3923
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3611
3924
  */
3612
3925
  LiveboardInfo = 'pinboardInfo',
@@ -3734,7 +4047,7 @@ export enum HostEvent {
3734
4047
  * appEmbed.trigger(HostEvent.Remove)
3735
4048
  * ```
3736
4049
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3737
- * * @example
4050
+ * @example
3738
4051
  * ```js
3739
4052
  * liveboardEmbed.trigger(HostEvent.Remove)
3740
4053
  * ```
@@ -3825,7 +4138,7 @@ export enum HostEvent {
3825
4138
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3826
4139
  * ```
3827
4140
  * ```js
3828
- * vizEmbed.trigger((HostEvent.CopyLink)
4141
+ * vizEmbed.trigger(HostEvent.CopyLink)
3829
4142
  * ```
3830
4143
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3831
4144
  */
@@ -3842,7 +4155,7 @@ export enum HostEvent {
3842
4155
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3843
4156
  * ```
3844
4157
  * ```js
3845
- * vizEmbed.trigger((HostEvent.Present)
4158
+ * vizEmbed.trigger(HostEvent.Present)
3846
4159
  * ```
3847
4160
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3848
4161
  */
@@ -3857,23 +4170,22 @@ export enum HostEvent {
3857
4170
  * );
3858
4171
  * })
3859
4172
  * ```
3860
- * * @example
4173
+ * @example
3861
4174
  * ```js
3862
-
3863
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
3864
- * let latestSpotterVizId = '';
3865
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
3866
- * latestSpotterVizId = payload.data.id;
3867
- * });
3868
- *
3869
- * spotterEmbed.trigger(HostEvent.GetTML, {
4175
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
4176
+ * let latestSpotterVizId = '';
4177
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4178
+ * latestSpotterVizId = payload.data.id;
4179
+ * });
4180
+ *
4181
+ * spotterEmbed.trigger(HostEvent.GetTML, {
3870
4182
  * vizId: latestSpotterVizId
3871
4183
  * }).then((tml) => {
3872
4184
  * console.log(
3873
4185
  * tml.answer.search_query // TML representation of the search query
3874
4186
  * );
3875
4187
  * })
3876
- * ```
4188
+ * ```
3877
4189
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3878
4190
  * @important
3879
4191
  */
@@ -3937,6 +4249,11 @@ export enum HostEvent {
3937
4249
  /**
3938
4250
  * Trigger the **Download** action on charts in
3939
4251
  * the embedded view.
4252
+ * Use {@link HostEvent.DownloadAsPng} instead.
4253
+ *
4254
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4255
+ *
4256
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
3940
4257
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
3941
4258
  * @example
3942
4259
  * ```js
@@ -3955,9 +4272,6 @@ export enum HostEvent {
3955
4272
  *
3956
4273
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
3957
4274
  * ```
3958
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
3959
- * Use {@link DownloadAsPng}
3960
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
3961
4275
  */
3962
4276
  Download = 'downloadAsPng',
3963
4277
  /**
@@ -4395,8 +4709,8 @@ export enum HostEvent {
4395
4709
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
4396
4710
  * console.log('parameters', parameter);
4397
4711
  * });
4398
- *```
4399
- *```js
4712
+ * ```
4713
+ * ```js
4400
4714
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
4401
4715
  * let latestSpotterVizId = '';
4402
4716
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -4404,7 +4718,7 @@ export enum HostEvent {
4404
4718
  * });
4405
4719
  *
4406
4720
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
4407
- *```
4721
+ * ```
4408
4722
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4409
4723
  */
4410
4724
  GetParameters = 'GetParameters',
@@ -4421,7 +4735,7 @@ export enum HostEvent {
4421
4735
  * Notify when info call is completed successfully
4422
4736
  * ```js
4423
4737
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
4424
- *```
4738
+ * ```
4425
4739
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4426
4740
  */
4427
4741
  InfoSuccess = 'InfoSuccess',
@@ -4524,7 +4838,7 @@ export enum HostEvent {
4524
4838
  * ```js
4525
4839
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
4526
4840
  *
4527
- *```
4841
+ * ```
4528
4842
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4529
4843
  */
4530
4844
  AddToCoaching = 'addToCoaching',
@@ -4566,7 +4880,7 @@ export enum HostEvent {
4566
4880
  * });
4567
4881
  *
4568
4882
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
4569
- *```
4883
+ * ```
4570
4884
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4571
4885
  */
4572
4886
  AnswerChartSwitcher = 'answerChartSwitcher',
@@ -4576,7 +4890,7 @@ export enum HostEvent {
4576
4890
  * This is automatically triggered by the SDK when fullscreen mode is exited.
4577
4891
  * ```js
4578
4892
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
4579
- *```
4893
+ * ```
4580
4894
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4581
4895
  */
4582
4896
  ExitPresentMode = 'exitPresentMode',
@@ -4730,6 +5044,7 @@ export enum Param {
4730
5044
  // 'both' clicks in `contextMenuTrigger` configuration.
4731
5045
  ContextMenuTrigger = 'contextMenuEnabledOnWhichClick',
4732
5046
  LinkOverride = 'linkOverride',
5047
+ EnableLinkOverridesV2 = 'enableLinkOverridesV2',
4733
5048
  blockNonEmbedFullAppAccess = 'blockNonEmbedFullAppAccess',
4734
5049
  ShowInsertToSlide = 'insertInToSlide',
4735
5050
  PrimaryNavHidden = 'primaryNavHidden',
@@ -4824,6 +5139,7 @@ export enum Param {
4824
5139
  IsThisPeriodInDateFiltersEnabled = 'isThisPeriodInDateFiltersEnabled',
4825
5140
  HideToolResponseCardBranding = 'hideToolResponseCardBranding',
4826
5141
  ToolResponseCardBrandingLabel = 'toolResponseCardBrandingLabel',
5142
+ EnableHomepageAnnouncement = 'enableHomepageAnnouncement',
4827
5143
  }
4828
5144
 
4829
5145
  /**
@@ -4984,14 +5300,14 @@ export enum Action {
4984
5300
  * ```js
4985
5301
  * disabledActions: [Action.CollapseDataPanel]
4986
5302
  * ```
4987
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5303
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
4988
5304
  */
4989
5305
  CollapseDataSources = 'collapseDataSources',
4990
5306
  /**
4991
5307
  * The **Collapse data panel** icon on the Search page.
4992
5308
  * Collapses the data panel view.
4993
5309
  *
4994
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5310
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4995
5311
  *
4996
5312
  * @example
4997
5313
  * ```js
@@ -5439,13 +5755,12 @@ export enum Action {
5439
5755
  */
5440
5756
  CreateMonitor = 'createMonitor',
5441
5757
  /**
5442
- * @deprecated
5443
- * Reports errors
5758
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5759
+ * @deprecated This action is deprecated. It was used for reporting errors.
5444
5760
  * @example
5445
5761
  * ```js
5446
5762
  * disabledActions: [Action.ReportError]
5447
5763
  * ```
5448
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5449
5764
  */
5450
5765
  ReportError = 'reportError',
5451
5766
  /**
@@ -5455,7 +5770,7 @@ export enum Action {
5455
5770
  * ```js
5456
5771
  * disabledActions: [Action.SyncToSheets]
5457
5772
  * ```
5458
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5773
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5459
5774
  */
5460
5775
  SyncToSheets = 'sync-to-sheets',
5461
5776
  /**
@@ -5466,7 +5781,7 @@ export enum Action {
5466
5781
  * ```js
5467
5782
  * disabledActions: [Action.SyncToOtherApps]
5468
5783
  * ```
5469
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5784
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5470
5785
  */
5471
5786
  SyncToOtherApps = 'sync-to-other-apps',
5472
5787
  /**
@@ -5476,7 +5791,7 @@ export enum Action {
5476
5791
  * ```js
5477
5792
  * disabledActions: [Action.ManagePipelines]
5478
5793
  * ```
5479
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5794
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5480
5795
  */
5481
5796
  ManagePipelines = 'manage-pipeline',
5482
5797
  /**
@@ -5788,7 +6103,7 @@ export enum Action {
5788
6103
  * ```js
5789
6104
  * disabledActions: [Action.PersonalisedViewsDropdown]
5790
6105
  * ```
5791
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6106
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5792
6107
  */
5793
6108
  PersonalisedViewsDropdown = 'personalisedViewsDropdown',
5794
6109
  /**
@@ -5798,7 +6113,7 @@ export enum Action {
5798
6113
  * ```js
5799
6114
  * disabledActions: [Action.LiveboardUsers]
5800
6115
  * ```
5801
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6116
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5802
6117
  */
5803
6118
  LiveboardUsers = 'liveboardUsers',
5804
6119
 
@@ -5817,7 +6132,7 @@ export enum Action {
5817
6132
  * hiddenAction: [Action.TML] // hide all TML actions
5818
6133
  * disabledActions: [Action.TML] // to disable all TML actions
5819
6134
  * ```
5820
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6135
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
5821
6136
  */
5822
6137
  TML = 'tml',
5823
6138
  /**
@@ -5866,7 +6181,7 @@ export enum Action {
5866
6181
  * ```js
5867
6182
  * disabledActions: [Action.AddToWatchlist]
5868
6183
  * ```
5869
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6184
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
5870
6185
  */
5871
6186
  AddToWatchlist = 'addToWatchlist',
5872
6187
 
@@ -5877,7 +6192,7 @@ export enum Action {
5877
6192
  * ```js
5878
6193
  * disabledActions: [Action.RemoveFromWatchlist]
5879
6194
  * ```
5880
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6195
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
5881
6196
  */
5882
6197
  RemoveFromWatchlist = 'removeFromWatchlist',
5883
6198
  /**
@@ -5888,7 +6203,7 @@ export enum Action {
5888
6203
  * ```js
5889
6204
  * disabledActions: [Action.OrganiseFavourites]
5890
6205
  * ```
5891
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6206
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
5892
6207
  */
5893
6208
  OrganiseFavourites = 'organiseFavourites',
5894
6209
 
@@ -5955,7 +6270,7 @@ export enum Action {
5955
6270
  * ```js
5956
6271
  * disabledActions: [Action.ManageTags]
5957
6272
  * ```
5958
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6273
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5959
6274
  */
5960
6275
  ManageTags = 'manageTags',
5961
6276
 
@@ -6463,18 +6778,80 @@ export interface CustomAction {
6463
6778
  * positions in the application.
6464
6779
  */
6465
6780
  export enum CustomActionsPosition {
6781
+ /**
6782
+ * Shows the action as a primary button
6783
+ * in the toolbar area of the embed.
6784
+ */
6466
6785
  PRIMARY = 'PRIMARY',
6786
+ /**
6787
+ * Shows the action inside the "More" menu
6788
+ * (three-dot overflow menu).
6789
+ */
6467
6790
  MENU = 'MENU',
6791
+ /**
6792
+ * Shows the action in the right-click
6793
+ * context menu. Only supported for
6794
+ * {@link CustomActionTarget.VIZ},
6795
+ * {@link CustomActionTarget.ANSWER}, and
6796
+ * {@link CustomActionTarget.SPOTTER} targets.
6797
+ */
6468
6798
  CONTEXTMENU = 'CONTEXTMENU',
6469
6799
  }
6470
6800
 
6471
6801
  /**
6472
- * Enum options to mention the target of the custom action.
6802
+ * Enum options to mention the target of the code-based custom action.
6803
+ * The target determines which type of ThoughtSpot object the action is
6804
+ * associated with, and also controls which positions and scoping options
6805
+ * are available.
6473
6806
  */
6474
6807
  export enum CustomActionTarget {
6808
+ /**
6809
+ * Action applies at the Liveboard level.
6810
+ * Supported positions:
6811
+ * {@link CustomActionsPosition.PRIMARY},
6812
+ * {@link CustomActionsPosition.MENU}.
6813
+ * Can be scoped with
6814
+ * `metadataIds.liveboardIds`,
6815
+ * `orgIds`, and `groupIds`.
6816
+ */
6475
6817
  LIVEBOARD = 'LIVEBOARD',
6818
+ /**
6819
+ * Action applies to individual
6820
+ * visualizations (charts/tables).
6821
+ * Supported positions:
6822
+ * {@link CustomActionsPosition.PRIMARY},
6823
+ * {@link CustomActionsPosition.MENU},
6824
+ * {@link CustomActionsPosition.CONTEXTMENU}.
6825
+ * Can be scoped with `metadataIds`
6826
+ * (answerIds, liveboardIds, vizIds),
6827
+ * `dataModelIds` (modelIds,
6828
+ * modelColumnNames), `orgIds`,
6829
+ * and `groupIds`.
6830
+ */
6476
6831
  VIZ = 'VIZ',
6832
+ /**
6833
+ * Action applies to saved or unsaved
6834
+ * Answers. Supported positions:
6835
+ * {@link CustomActionsPosition.PRIMARY},
6836
+ * {@link CustomActionsPosition.MENU},
6837
+ * {@link CustomActionsPosition.CONTEXTMENU}.
6838
+ * Can be scoped with
6839
+ * `metadataIds.answerIds`,
6840
+ * `dataModelIds` (modelIds,
6841
+ * modelColumnNames), `orgIds`,
6842
+ * and `groupIds`.
6843
+ */
6477
6844
  ANSWER = 'ANSWER',
6845
+ /**
6846
+ * Action applies to Spotter
6847
+ * (AI-powered search).
6848
+ * Supported positions:
6849
+ * {@link CustomActionsPosition.MENU},
6850
+ * {@link CustomActionsPosition.CONTEXTMENU}.
6851
+ * Can be scoped with
6852
+ * `dataModelIds.modelIds`,
6853
+ * `orgIds`, and `groupIds`.
6854
+ */
6478
6855
  SPOTTER = 'SPOTTER',
6479
6856
  }
6480
6857
 
@@ -6788,14 +7165,14 @@ export type ApiInterceptFlags = {
6788
7165
  /**
6789
7166
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
6790
7167
  *
6791
- * Can be used for Serach and App Embed from SDK 1.29.0
7168
+ * Can be used for Search and App Embed from SDK 1.29.0
6792
7169
  *
6793
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7170
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
6794
7171
  */
6795
7172
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
6796
7173
  /**
6797
7174
  * This allows to intercept the urls passed, once intercepted the api will only
6798
- * run based on the reponse from the responder of ApiIntercept event.
7175
+ * run based on the response from the responder of ApiIntercept event.
6799
7176
  *
6800
7177
  * @example
6801
7178
  * ```js
@@ -6806,7 +7183,7 @@ export type ApiInterceptFlags = {
6806
7183
  * })
6807
7184
  * ```
6808
7185
  *
6809
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7186
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
6810
7187
  */
6811
7188
  interceptUrls?: (string | InterceptedApiType)[];
6812
7189
  /**
@@ -6823,7 +7200,7 @@ export type ApiInterceptFlags = {
6823
7200
  * })
6824
7201
  * ```
6825
7202
  *
6826
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7203
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
6827
7204
  */
6828
7205
  interceptTimeout?: number;
6829
7206
  };