@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
@@ -8,7 +8,7 @@
8
8
  import { CustomCssVariables } from './css-variables';
9
9
  import type { SessionInterface } from './utils/graphql/answerService/answerService';
10
10
  /**
11
- * The authentication mechanism for allowing access to the
11
+ * The authentication mechanism for allowing access to
12
12
  * the embedded app
13
13
  * @group Authentication / Init
14
14
  */
@@ -33,6 +33,7 @@ export declare enum AuthType {
33
33
  * To use this:
34
34
  * Your SAML or OpenID provider must allow iframe redirects.
35
35
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
36
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
36
37
  * @example
37
38
  * ```js
38
39
  * init({
@@ -40,18 +41,17 @@ export declare enum AuthType {
40
41
  * authType: AuthType.EmbeddedSSO,
41
42
  * });
42
43
  * ```
43
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
44
44
  */
45
45
  EmbeddedSSO = "EmbeddedSSO",
46
46
  /**
47
- * SSO using SAML
48
- * @deprecated Use {@link SAMLRedirect} instead
47
+ * SSO using SAML, Use {@link SAMLRedirect} instead
48
+ * @deprecated This option is deprecated.
49
49
  * @hidden
50
50
  */
51
51
  SSO = "SSO_SAML",
52
52
  /**
53
- * SSO using SAML
54
- * @deprecated Use {@link SAMLRedirect} instead
53
+ * SSO using SAML, Use {@link SAMLRedirect} instead
54
+ * @deprecated This option is deprecated.
55
55
  * @hidden
56
56
  */
57
57
  SAML = "SSO_SAML",
@@ -102,8 +102,9 @@ export declare enum AuthType {
102
102
  SAMLRedirect = "SSO_SAML",
103
103
  /**
104
104
  * SSO using OIDC
105
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
106
+ * @deprecated This option is deprecated.
105
107
  * @hidden
106
- * @deprecated Use {@link OIDCRedirect} instead
107
108
  */
108
109
  OIDC = "SSO_OIDC",
109
110
  /**
@@ -114,8 +115,9 @@ export declare enum AuthType {
114
115
  OIDCRedirect = "SSO_OIDC",
115
116
  /**
116
117
  * Trusted authentication server
118
+ * Use {@link TrustedAuth} instead
119
+ * @deprecated This option is deprecated.
117
120
  * @hidden
118
- * @deprecated Use {@link TrustedAuth} instead
119
121
  */
120
122
  AuthServer = "AuthServer",
121
123
  /**
@@ -142,6 +144,7 @@ export declare enum AuthType {
142
144
  * obtained from ThoughtSpot. This uses a cookieless authentication
143
145
  * approach, recommended to bypass the third-party cookie-blocking restriction
144
146
  * implemented by some browsers.
147
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
145
148
  * @example
146
149
  * ```js
147
150
  * init({
@@ -152,8 +155,8 @@ export declare enum AuthType {
152
155
  * .then((response) => response.json())
153
156
  * .then((data) => data.token);
154
157
  * }
158
+ * });
155
159
  * ```
156
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
157
160
  */
158
161
  TrustedAuthTokenCookieless = "AuthServerCookieless",
159
162
  /**
@@ -173,43 +176,43 @@ export declare enum HomeLeftNavItem {
173
176
  /**
174
177
  * The *Search data* option in
175
178
  * the *Insights* left navigation panel.
176
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
179
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
177
180
  */
178
181
  SearchData = "search-data",
179
182
  /**
180
183
  * The *Home* menu option in
181
184
  * the *Insights* left navigation panel.
182
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
185
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
183
186
  */
184
187
  Home = "insights-home",
185
188
  /**
186
189
  * The *Liveboards* menu option in
187
190
  * the *Insights* left navigation panel.
188
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
191
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
189
192
  */
190
193
  Liveboards = "liveboards",
191
194
  /**
192
195
  * The *Answers* menu option in
193
196
  * the *Insights* left navigation panel.
194
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
197
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
195
198
  */
196
199
  Answers = "answers",
197
200
  /**
198
201
  * The *Monitor subscriptions* menu option in
199
202
  * the *Insights* left navigation panel.
200
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
203
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
201
204
  */
202
205
  MonitorSubscription = "monitor-alerts",
203
206
  /**
204
207
  * The *SpotIQ analysis* menu option in
205
208
  * the *Insights* left navigation panel.
206
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
209
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
207
210
  */
208
211
  SpotIQAnalysis = "spotiq-analysis",
209
212
  /**
210
213
  * The *Liveboard schedules* menu option in
211
214
  * the *Insights* left navigation panel.
212
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
215
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
213
216
  */
214
217
  LiveboardSchedules = "liveboard-schedules",
215
218
  /**
@@ -380,8 +383,8 @@ export interface EmbedConfig {
380
383
  * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
381
384
  * open the SAML auth flow in a popup, instead of redirecting the browser in
382
385
  * place.
386
+ * @deprecated This option is deprecated.
383
387
  * @default false
384
- * @deprecated
385
388
  */
386
389
  noRedirect?: boolean;
387
390
  /**
@@ -390,8 +393,8 @@ export interface EmbedConfig {
390
393
  *
391
394
  * Need to use this with `authTriggerContainer`. Or manually trigger
392
395
  * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
393
- * @default false
394
396
  * @version SDK: 1.18.0
397
+ * @default false
395
398
  */
396
399
  inPopup?: boolean;
397
400
  /**
@@ -400,7 +403,7 @@ export interface EmbedConfig {
400
403
  * terminated.
401
404
  *
402
405
  * Eg: "/dashboard", "#/foo" [Do not include the host]
403
- * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
406
+ * @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
404
407
  */
405
408
  redirectPath?: string;
406
409
  /** @internal */
@@ -473,7 +476,7 @@ export interface EmbedConfig {
473
476
  detectCookieAccessSlow?: boolean;
474
477
  /**
475
478
  * Hide the `beta` alert warning message for SearchEmbed.
476
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
479
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
477
480
  */
478
481
  suppressSearchEmbedBetaWarning?: boolean;
479
482
  /**
@@ -490,6 +493,7 @@ export interface EmbedConfig {
490
493
  * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
491
494
  * button that the user can click to trigger the flow.
492
495
  * This attribute sets a containing element for that button.
496
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
493
497
  * @example
494
498
  * ```js
495
499
  * init({
@@ -498,7 +502,6 @@ export interface EmbedConfig {
498
502
  * authTriggerContainer: '#auth-trigger-container'
499
503
  * })
500
504
  * ```
501
- * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
502
505
  */
503
506
  authTriggerContainer?: string | HTMLElement;
504
507
  /**
@@ -515,11 +518,10 @@ export interface EmbedConfig {
515
518
  */
516
519
  authTriggerText?: string;
517
520
  /**
518
- * Prevent users from accessing the full application or ThoughtSpot application pages
519
- * access to the embedded application users
520
- * outside of the iframe.
521
- * @default true
521
+ * Prevent embedded application users from accessing ThoughtSpot
522
+ * application pages outside of the iframe.
522
523
  * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
524
+ * @default true
523
525
  */
524
526
  blockNonEmbedFullAppAccess?: boolean;
525
527
  /**
@@ -549,6 +551,7 @@ export interface EmbedConfig {
549
551
  * other logs such as warnings, information alerts,
550
552
  * and debug messages in the console output.
551
553
  *
554
+ * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
552
555
  * @default LogLevel.ERROR
553
556
  * @example
554
557
  * ```js
@@ -557,7 +560,6 @@ export interface EmbedConfig {
557
560
  * logLevel: LogLevel.SILENT
558
561
  * })
559
562
  * ```
560
- * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
561
563
  */
562
564
  logLevel?: LogLevel;
563
565
  /**
@@ -584,6 +586,7 @@ export interface EmbedConfig {
584
586
  * This flag is used to disable the token verification in the SDK.
585
587
  * Enabling this flag will also disable the caching of the token.
586
588
  * @hidden
589
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
587
590
  * @example
588
591
  * ```js
589
592
  * init({
@@ -591,12 +594,11 @@ export interface EmbedConfig {
591
594
  * disableTokenVerification : true
592
595
  * })
593
596
  * ```
594
- * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
595
597
  */
596
598
  disableTokenVerification?: boolean;
597
599
  /**
598
600
  * This flag is used to disable showing the login failure page in the embedded app.
599
- * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
601
+ * @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
600
602
  */
601
603
  disableLoginFailurePage?: boolean;
602
604
  /**
@@ -606,6 +608,7 @@ export interface EmbedConfig {
606
608
  * Warning: This option is for advanced use only and is used internally
607
609
  * to control embed behavior in non-regular ways. We do not publish the
608
610
  * list of supported keys and values associated with each.
611
+ * @version SDK: 1.33.5 | ThoughtSpot: *
609
612
  * @example
610
613
  * ```js
611
614
  * const embed = new LiveboardEmbed('#embed', {
@@ -616,7 +619,6 @@ export interface EmbedConfig {
616
619
  * }
617
620
  * });
618
621
  * ```
619
- * @version SDK: 1.33.5 | ThoughtSpot: *
620
622
  */
621
623
  additionalFlags?: {
622
624
  [key: string]: string | number | boolean;
@@ -624,6 +626,7 @@ export interface EmbedConfig {
624
626
  /**
625
627
  * This is an object (key/val) for customVariables being
626
628
  * used by the third party tool's script.
629
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
627
630
  * @example
628
631
  * ```js
629
632
  * const embed = new LiveboardEmbed('#embed', {
@@ -634,15 +637,14 @@ export interface EmbedConfig {
634
637
  * }
635
638
  * });
636
639
  * ```
637
- * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
638
640
  */
639
641
  customVariablesForThirdPartyTools?: Record<string, any>;
640
642
  disablePreauthCache?: boolean;
641
643
  /**
642
644
  * Disable fullscreen presentation mode functionality. When enabled, prevents entering
643
645
  * and exiting fullscreen mode for embedded visualizations during presentations.
644
- * @default true (feature is disabled by default)
645
646
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
647
+ * @default true (feature is disabled by default)
646
648
  * @example
647
649
  * ```js
648
650
  * init({
@@ -661,18 +663,154 @@ export interface EmbedConfig {
661
663
  * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
662
664
  * @example
663
665
  * ```js
664
- * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
666
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
665
667
  * init({
666
668
  * ... // other embed config options
667
669
  * customActions: [
668
670
  * {
669
- * name: 'customAction',
670
- * id: 'customAction',
671
+ * // Unique identifier for the custom action
672
+ * id: 'my-custom-action',
673
+ *
674
+ * // Display name shown to users in the UI
675
+ * name: 'My Custom Action',
676
+ *
677
+ * // Where the action appears in the UI
678
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
679
+ * // MENU: Shows in the "More" menu (three dots menu)
680
+ * // CONTEXTMENU: Shows in the right-click context menu
681
+ * position: CustomActionsPosition.PRIMARY,
682
+ *
683
+ * // What type of content this action applies to
684
+ * // ANSWER: Available on answer pages
685
+ * target: CustomActionTarget.ANSWER,
686
+ *
687
+ * // Optional: Restrict where this action appears based on data models
688
+ * // dataModelIds: {
689
+ * // // Restrict to specific data models
690
+ * // modelIds: ['model-id-1', 'model-id-2'],
691
+ * // // Restrict to specific columns within models
692
+ * // modelColumnNames: ['model-id::column-name']
693
+ * // },
694
+ *
695
+ * // Optional: Restrict where this action appears based on metadata
696
+ * // metadataIds: {
697
+ * // // Restrict to specific answers
698
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
699
+ * // },
700
+ * // // Restrict to specific groups (for group-based access control)
701
+ * // groupIds: ['group-id-1', 'group-id-2'],
702
+ * // // Restrict to specific organizations (for multi-org deployments)
703
+ * // orgIds: ['org-id-1', 'org-id-2'],
704
+ * }
705
+ * ],
706
+ * })
707
+ * ```
708
+ * @example
709
+ * ```js
710
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
711
+ * init({
712
+ * ... // other embed config options
713
+ * customActions: [
714
+ * {
715
+ * // Unique identifier for the custom action
716
+ * id: 'my-custom-action',
717
+ *
718
+ * // Display name shown to users in the UI
719
+ * name: 'My Custom Action',
720
+ *
721
+ * // Where the action appears in the UI
722
+ * // MENU: Shows in the "More" menu (three dots menu)
723
+ * // CONTEXTMENU: Shows in the right-click context menu
724
+ * position: CustomActionsPosition.MENU,
725
+ *
726
+ * // What type of content this action applies to
727
+ * // SPOTTER: Available in Spotter (AI-powered search)
728
+ * target: CustomActionTarget.SPOTTER,
729
+ *
730
+ * // Optional: Restrict where this action appears based on data models
731
+ * // dataModelIds: {
732
+ * // // Restrict to specific data models
733
+ * // modelIds: ['model-id-1', 'model-id-2'],
734
+ * // },
735
+ * // // Restrict to specific groups (for group-based access control)
736
+ * // groupIds: ['group-id-1'],
737
+ * // // Restrict to specific organizations (for multi-org deployments)
738
+ * // orgIds: ['org-id-1'],
739
+ * }
740
+ * ],
741
+ * })
742
+ * ```
743
+ * @example
744
+ * ```js
745
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
746
+ * init({
747
+ * ... // other embed config options
748
+ * customActions: [
749
+ * {
750
+ * // Unique identifier for the custom action
751
+ * id: 'my-liveboard-custom-action',
752
+ *
753
+ * // Display name shown to users in the UI
754
+ * name: 'My Liveboard Custom Action',
755
+ *
756
+ * // Where the action appears in the UI
757
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
758
+ * // MENU: Shows in the "More" menu (three dots menu)
759
+ * position: CustomActionsPosition.PRIMARY,
760
+ *
761
+ * // What type of content this action applies to
762
+ * // LIVEBOARD: Available on liveboard pages
763
+ * target: CustomActionTarget.LIVEBOARD,
764
+ *
765
+ * // Optional: Restrict where this action appears based on metadata
766
+ * // metadataIds: {
767
+ * // // Restrict to specific liveboards
768
+ * // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
769
+ * // },
770
+ * // // Restrict to specific groups (for group-based access control)
771
+ * // groupIds: ['group-id-1', 'group-id-2'],
772
+ * // // Restrict to specific organizations (for multi-org deployments)
773
+ * // orgIds: ['org-id-1', 'org-id-2'],
774
+ * },
775
+ * {
776
+ * // Unique identifier for the custom action
777
+ * id: 'my-viz-custom-action',
778
+ *
779
+ * // Display name shown to users in the UI
780
+ * name: 'My Viz Custom Action',
781
+ *
782
+ * // Where the action appears in the UI
783
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
784
+ * // MENU: Shows in the "More" menu (three dots menu)
785
+ * // CONTEXTMENU: Shows in the right-click context menu
786
+ * position: CustomActionsPosition.PRIMARY,
787
+ *
788
+ * // What type of content this action applies to
789
+ * // VIZ: Available on individual visualizations
671
790
  * target: CustomActionTarget.VIZ,
672
- * position: CustomActionPosition.PRIMARY,
673
- * }
791
+ *
792
+ * // Optional: Restrict where this action appears based on metadata
793
+ * // metadataIds: {
794
+ * // // Restrict to specific answers
795
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
796
+ * // // Restrict to specific liveboard. If liveboardId is
797
+ * // // passed, custom actions will appear on all vizzes of liveboard
798
+ * // liveboardIds: ['liveboard-id-1'],
799
+ * // // Restrict to specific vizIds
800
+ * // vizIds: ['viz-id-1']
801
+ * // },
802
+ * // dataModelIds: {
803
+ * // // Restrict to specific data models
804
+ * // modelIds: ['model-id-1', 'model-id-2'],
805
+ * // // Restrict to specific columns within models
806
+ * // modelColumnNames: ['model-id::column-name']
807
+ * // },
808
+ * // // Restrict to specific groups (for group-based access control)
809
+ * // groupIds: ['group-id-1', 'group-id-2'],
810
+ * // // Restrict to specific organizations (for multi-org deployments)
811
+ * // orgIds: ['org-id-1', 'org-id-2'],
674
812
  * }
675
- * ]
813
+ * ],
676
814
  * })
677
815
  * ```
678
816
  */
@@ -712,7 +850,7 @@ export interface FrameParams {
712
850
  */
713
851
  loading?: 'lazy' | 'eager' | 'auto';
714
852
  /**
715
- * This parameters will be passed on the iframe
853
+ * These parameters will be passed to the iframe
716
854
  * as is.
717
855
  */
718
856
  [key: string]: string | number | boolean | undefined;
@@ -787,8 +925,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
787
925
  */
788
926
  disabledActionReason?: string;
789
927
  /**
790
- * The list of actions to hide from the embedded.
791
- * This actions will be hidden from the user.
928
+ * The list of actions to hide from the embedded view.
929
+ * These actions will be hidden from the user.
792
930
  * Use this to hide an action.
793
931
  *
794
932
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
@@ -829,7 +967,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
829
967
  * The locale settings to apply to the embedded view.
830
968
  *
831
969
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
832
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
970
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
833
971
  * @example
834
972
  * ```js
835
973
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -844,12 +982,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
844
982
  * This is an object (key/val) of override flags which will be applied
845
983
  * to the internal embedded object. This can be used to add any
846
984
  * URL flag.
847
- * If the same flags are passed in init, they will be overriden by the values here.
985
+ * If the same flags are passed in init, they will be overridden by the values here.
848
986
  * Warning: This option is for advanced use only and is used internally
849
987
  * to control embed behavior in non-regular ways. We do not publish the
850
988
  * list of supported keys and values associated with each.
851
989
  *
852
990
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
991
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
853
992
  * @example
854
993
  * ```js
855
994
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -861,7 +1000,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
861
1000
  * },
862
1001
  * });
863
1002
  * ```
864
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
865
1003
  */
866
1004
  additionalFlags?: {
867
1005
  [key: string]: string | number | boolean;
@@ -904,6 +1042,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
904
1042
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
905
1043
  *
906
1044
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1045
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
907
1046
  * @example
908
1047
  * ```js
909
1048
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -913,7 +1052,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
913
1052
  * });
914
1053
  * embed.showPreRender();
915
1054
  * ```
916
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
917
1055
  */
918
1056
  preRenderId?: string;
919
1057
  /**
@@ -923,7 +1061,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
923
1061
  * its dimensions based on changes to the size of the embedding element.
924
1062
  * @type {boolean}
925
1063
  * @default false
926
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
1064
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
927
1065
  * @example
928
1066
  * ```js
929
1067
  * // Disable tracking PreRender size in the configuration
@@ -938,9 +1076,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
938
1076
  doNotTrackPreRenderSize?: boolean;
939
1077
  /**
940
1078
  * Enable the V2 shell. This can provide performance benefits
941
- * due to a lighterweight shell.
1079
+ * due to a lighter-weight shell.
942
1080
  *
943
1081
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1082
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
944
1083
  * @example
945
1084
  * ```js
946
1085
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -949,7 +1088,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
949
1088
  * enableV2Shell_experimental: true,
950
1089
  * });
951
1090
  * ```
952
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
953
1091
  */
954
1092
  enableV2Shell_experimental?: boolean;
955
1093
  /**
@@ -968,6 +1106,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
968
1106
  * and disable redirection of links in a new tab.
969
1107
  *
970
1108
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1109
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
971
1110
  * @example
972
1111
  * ```js
973
1112
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -976,7 +1115,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
976
1115
  * disableRedirectionLinksInNewTab: true,
977
1116
  * });
978
1117
  * ```
979
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
980
1118
  */
981
1119
  disableRedirectionLinksInNewTab?: boolean;
982
1120
  /**
@@ -987,6 +1125,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
987
1125
  * Per Org URL feature is enabled on your ThoughtSpot instance.
988
1126
  *
989
1127
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1128
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
990
1129
  * @example
991
1130
  * ```js
992
1131
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -995,24 +1134,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
995
1134
  * overrideOrgId: 142536,
996
1135
  * });
997
1136
  * ```
998
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
999
1137
  */
1000
1138
  overrideOrgId?: number;
1001
1139
  /**
1002
- * Flag to override the *Open Link in New Tab* context menu option.
1140
+ * Flag to override the *Open Link in New Tab* context
1141
+ * menu option.
1003
1142
  *
1004
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1143
+ * For improved link override handling, use
1144
+ * {@link enableLinkOverridesV2} instead.
1145
+ *
1146
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
1147
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
1148
+ * `SpotterEmbed`, `SearchBarEmbed`
1005
1149
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1006
1150
  * @example
1007
1151
  * ```js
1008
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
1009
- * const embed = new <EmbedComponent>('#tsEmbed', {
1152
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1010
1153
  * ... // other embed view config
1011
- * linkOverride:false,
1154
+ * linkOverride: true,
1012
1155
  * })
1013
1156
  * ```
1014
1157
  */
1015
1158
  linkOverride?: boolean;
1159
+ /**
1160
+ * Enables the V2 link override mechanism with improved
1161
+ * handling. When enabled, navigation links within the
1162
+ * embedded ThoughtSpot app are intercepted and routed
1163
+ * through the SDK via the `EmbedEvent.DialogOpen`
1164
+ * event.
1165
+ *
1166
+ * The SDK automatically sends {@link linkOverride}
1167
+ * alongside this flag for backward compatibility with
1168
+ * older ThoughtSpot versions.
1169
+ *
1170
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
1171
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
1172
+ * `SpotterEmbed`, `SearchBarEmbed`
1173
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
1174
+ * @example
1175
+ * ```js
1176
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1177
+ * ... // other embed view config
1178
+ * enableLinkOverridesV2: true,
1179
+ * });
1180
+ *
1181
+ * embed.on(EmbedEvent.DialogOpen, (payload) => {
1182
+ * console.log('Link clicked:', payload);
1183
+ * });
1184
+ * ```
1185
+ */
1186
+ enableLinkOverridesV2?: boolean;
1016
1187
  /**
1017
1188
  * The primary action to display on top of the viz for Liveboard and App Embed.
1018
1189
  * Use this to set the primary action.
@@ -1037,7 +1208,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1037
1208
  insertInToSlide?: boolean;
1038
1209
  /**
1039
1210
  * Show alert messages and toast messages in the embed.
1040
- * Supported embed in all embed types.
1211
+ * Supported in all embed types.
1041
1212
  *
1042
1213
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1043
1214
  * @example
@@ -1062,7 +1233,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1062
1233
  * ```ts
1063
1234
  * import {
1064
1235
  * CustomActionPayload,
1065
- * CustomActionPosition,
1236
+ * CustomActionsPosition,
1066
1237
  * CustomActionTarget,
1067
1238
  * } from '@thoughtspot/visual-embed-sdk';
1068
1239
  * // Use supported embed types such as AppEmbed or LiveboardEmbed
@@ -1070,13 +1241,41 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1070
1241
  * ... // other embed config options
1071
1242
  * customActions: [
1072
1243
  * {
1073
- * name: 'customAction',
1074
- * id: 'customAction',
1075
- * target: CustomActionTarget.VIZ,
1076
- * position: CustomActionPosition.PRIMARY,
1077
- * }
1244
+ * // Unique identifier for the custom action
1245
+ * id: 'my-custom-action',
1246
+ *
1247
+ * // Display name shown to users in the UI
1248
+ * name: 'My Custom Action',
1249
+ *
1250
+ * // Where the action appears in the UI
1251
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1252
+ * // MENU: Shows in the "More" menu (three dots menu)
1253
+ * // CONTEXTMENU: Shows in the right-click context menu
1254
+ * position: CustomActionsPosition.PRIMARY,
1255
+ *
1256
+ * // What type of content this action applies to
1257
+ * // ANSWER: Available on answer pages
1258
+ * target: CustomActionTarget.ANSWER,
1259
+ *
1260
+ * // Optional: Restrict where this action appears based on data models
1261
+ * // dataModelIds: {
1262
+ * // // Restrict to specific data models
1263
+ * // modelIds: ['model-id-1', 'model-id-2'],
1264
+ * // // Restrict to specific columns within models
1265
+ * // modelColumnNames: ['model-id::column-name']
1266
+ * // },
1267
+ *
1268
+ * // Optional: Restrict where this action appears based on metadata
1269
+ * // metadataIds: {
1270
+ * // // Restrict to specific answers
1271
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
1272
+ * // },
1273
+ * // // Restrict to specific groups (for group-based access control)
1274
+ * // groupIds: ['group-id-1', 'group-id-2'],
1275
+ * // // Restrict to specific organizations (for multi-org deployments)
1276
+ * // orgIds: ['org-id-1', 'org-id-2'],
1078
1277
  * }
1079
- * ]
1278
+ * ],
1080
1279
  * })
1081
1280
  *
1082
1281
  * // to trigger a custom flow on custom action click listen to Custom action embed event
@@ -1084,6 +1283,120 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1084
1283
  * console.log('Custom Action event:', payload);
1085
1284
  * })
1086
1285
  * ```
1286
+ * @example
1287
+ * ```ts
1288
+ * import {
1289
+ * CustomActionsPosition,
1290
+ * CustomActionTarget,
1291
+ * } from '@thoughtspot/visual-embed-sdk';
1292
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1293
+ * ... // other embed config options
1294
+ * customActions: [
1295
+ * {
1296
+ * // Unique identifier for the custom action
1297
+ * id: 'my-custom-action',
1298
+ *
1299
+ * // Display name shown to users in the UI
1300
+ * name: 'My Custom Action',
1301
+ *
1302
+ * // Where the action appears in the UI
1303
+ * // MENU: Shows in the "More" menu (three dots menu)
1304
+ * // CONTEXTMENU: Shows in the right-click context menu
1305
+ * position: CustomActionsPosition.MENU,
1306
+ *
1307
+ * // What type of content this action applies to
1308
+ * // SPOTTER: Available in Spotter (AI-powered search)
1309
+ * target: CustomActionTarget.SPOTTER,
1310
+ *
1311
+ * // Optional: Restrict where this action appears based on data models
1312
+ * // dataModelIds: {
1313
+ * // // Restrict to specific data models
1314
+ * // modelIds: ['model-id-1', 'model-id-2'],
1315
+ * // },
1316
+ * // // Restrict to specific groups (for group-based access control)
1317
+ * // groupIds: ['group-id-1'],
1318
+ * // // Restrict to specific organizations (for multi-org deployments)
1319
+ * // orgIds: ['org-id-1'],
1320
+ * }
1321
+ * ],
1322
+ * })
1323
+ * ```
1324
+ * @example
1325
+ * ```ts
1326
+ * import {
1327
+ * CustomActionsPosition,
1328
+ * CustomActionTarget,
1329
+ * } from '@thoughtspot/visual-embed-sdk';
1330
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1331
+ * ... // other embed config options
1332
+ * customActions: [
1333
+ * {
1334
+ * // Unique identifier for the custom action
1335
+ * id: 'my-liveboard-custom-action',
1336
+ *
1337
+ * // Display name shown to users in the UI
1338
+ * name: 'My Liveboard Custom Action',
1339
+ *
1340
+ * // Where the action appears in the UI
1341
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1342
+ * // MENU: Shows in the "More" menu (three dots menu)
1343
+ * position: CustomActionsPosition.PRIMARY,
1344
+ *
1345
+ * // What type of content this action applies to
1346
+ * // LIVEBOARD: Available on liveboard pages
1347
+ * target: CustomActionTarget.LIVEBOARD,
1348
+ *
1349
+ * // Optional: Restrict where this action appears based on metadata
1350
+ * // metadataIds: {
1351
+ * // // Restrict to specific liveboards
1352
+ * // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
1353
+ * // },
1354
+ * // // Restrict to specific groups (for group-based access control)
1355
+ * // groupIds: ['group-id-1', 'group-id-2'],
1356
+ * // // Restrict to specific organizations (for multi-org deployments)
1357
+ * // orgIds: ['org-id-1', 'org-id-2'],
1358
+ * },
1359
+ * {
1360
+ * // Unique identifier for the custom action
1361
+ * id: 'my-viz-custom-action',
1362
+ *
1363
+ * // Display name shown to users in the UI
1364
+ * name: 'My Viz Custom Action',
1365
+ *
1366
+ * // Where the action appears in the UI
1367
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1368
+ * // MENU: Shows in the "More" menu (three dots menu)
1369
+ * // CONTEXTMENU: Shows in the right-click context menu
1370
+ * position: CustomActionsPosition.PRIMARY,
1371
+ *
1372
+ * // What type of content this action applies to
1373
+ * // VIZ: Available on individual visualizations
1374
+ * target: CustomActionTarget.VIZ,
1375
+ *
1376
+ * // Optional: Restrict where this action appears based on metadata
1377
+ * // metadataIds: {
1378
+ * // // Restrict to specific answers
1379
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
1380
+ * // // Restrict to specific liveboard. If liveboardId is
1381
+ * // // passed, custom actions will appear on all vizzes of liveboard
1382
+ * // liveboardIds: ['liveboard-id-1'],
1383
+ * // // Restrict to specific vizIds
1384
+ * // vizIds: ['viz-id-1']
1385
+ * // },
1386
+ * // dataModelIds: {
1387
+ * // // Restrict to specific data models
1388
+ * // modelIds: ['model-id-1', 'model-id-2'],
1389
+ * // // Restrict to specific columns within models
1390
+ * // modelColumnNames: ['model-id::column-name']
1391
+ * // },
1392
+ * // // Restrict to specific groups (for group-based access control)
1393
+ * // groupIds: ['group-id-1', 'group-id-2'],
1394
+ * // // Restrict to specific organizations (for multi-org deployments)
1395
+ * // orgIds: ['org-id-1', 'org-id-2'],
1396
+ * }
1397
+ * ],
1398
+ * })
1399
+ * ```
1087
1400
  */
1088
1401
  customActions?: CustomAction[];
1089
1402
  /**
@@ -1179,7 +1492,7 @@ export interface HomePageConfig {
1179
1492
  * **Note**: This attribute is not supported in the classic (v1) homepage.
1180
1493
  *
1181
1494
  * Supported embed types: `AppEmbed`
1182
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1495
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1183
1496
  * @example
1184
1497
  * ```js
1185
1498
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
@@ -1200,6 +1513,7 @@ export interface HomePageConfig {
1200
1513
  * **Note**: This attribute is not supported in the classic (v1) homepage.
1201
1514
  *
1202
1515
  * Supported embed types: `AppEmbed`
1516
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1203
1517
  * @example
1204
1518
  * ```js
1205
1519
  * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
@@ -1210,7 +1524,6 @@ export interface HomePageConfig {
1210
1524
  * ... //other embed view configuration attributes
1211
1525
  * })
1212
1526
  * ```
1213
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1214
1527
  */
1215
1528
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
1216
1529
  }
@@ -1223,7 +1536,7 @@ export interface SearchLiveboardCommonViewConfig {
1223
1536
  * visualization, or Liveboard.
1224
1537
  *
1225
1538
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
1226
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1539
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1227
1540
  * @example
1228
1541
  * ```js
1229
1542
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1241,11 +1554,11 @@ export interface SearchLiveboardCommonViewConfig {
1241
1554
  */
1242
1555
  runtimeFilters?: RuntimeFilter[];
1243
1556
  /**
1244
- * The list of parameter override to apply to a search Answer,
1557
+ * The list of parameter overrides to apply to a search Answer,
1245
1558
  * visualization, or Liveboard.
1246
1559
  *
1247
1560
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
1248
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1561
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1249
1562
  * @example
1250
1563
  * ```js
1251
1564
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1265,6 +1578,7 @@ export interface SearchLiveboardCommonViewConfig {
1265
1578
  * flag to set ContextMenu Trigger to either left or right click.
1266
1579
  *
1267
1580
  * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
1581
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1268
1582
  * @example
1269
1583
  * ```js
1270
1584
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
@@ -1273,7 +1587,6 @@ export interface SearchLiveboardCommonViewConfig {
1273
1587
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
1274
1588
  * })
1275
1589
  * ```
1276
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1277
1590
  */
1278
1591
  contextMenuTrigger?: ContextMenuTriggerOptions;
1279
1592
  /**
@@ -1296,7 +1609,7 @@ export interface SearchLiveboardCommonViewConfig {
1296
1609
  * when set to false, runtime parameters will be included in the URL
1297
1610
  * (default behavior before SDK 1.45.0).
1298
1611
  *
1299
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
1612
+ * Irrespective of this flag, runtime parameters (if passed) will be applied to the
1300
1613
  * embedded view.
1301
1614
  * @default true
1302
1615
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
@@ -1315,14 +1628,15 @@ export interface SearchLiveboardCommonViewConfig {
1315
1628
  * ... // other embed view config
1316
1629
  * collapseSearchBar: true,
1317
1630
  * });
1631
+ * ```
1318
1632
  */
1319
1633
  collapseSearchBar?: boolean;
1320
1634
  /**
1321
1635
  * Flag to control Data panel experience
1322
1636
  *
1323
1637
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1638
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
1324
1639
  * @default true
1325
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
1326
1640
  * @example
1327
1641
  * ```js
1328
1642
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -1355,6 +1669,7 @@ export interface SearchLiveboardCommonViewConfig {
1355
1669
  * the current time period in filter results.
1356
1670
  *
1357
1671
  * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1672
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
1358
1673
  * @example
1359
1674
  * ```js
1360
1675
  * const embed = new <EmbedComponent>('#tsEmbed', {
@@ -1362,7 +1677,6 @@ export interface SearchLiveboardCommonViewConfig {
1362
1677
  * isThisPeriodInDateFiltersEnabled: true,
1363
1678
  * })
1364
1679
  * ```
1365
- * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
1366
1680
  */
1367
1681
  isThisPeriodInDateFiltersEnabled?: boolean;
1368
1682
  }
@@ -1422,6 +1736,7 @@ export interface LiveboardAppEmbedViewConfig {
1422
1736
  * Boolean to control if Liveboard header is sticky or not.
1423
1737
  *
1424
1738
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1739
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1425
1740
  * @example
1426
1741
  * ```js
1427
1742
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1430,7 +1745,6 @@ export interface LiveboardAppEmbedViewConfig {
1430
1745
  * isLiveboardHeaderSticky: true,
1431
1746
  * });
1432
1747
  * ```
1433
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1434
1748
  */
1435
1749
  isLiveboardHeaderSticky?: boolean;
1436
1750
  /**
@@ -1438,8 +1752,8 @@ export interface LiveboardAppEmbedViewConfig {
1438
1752
  *
1439
1753
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1440
1754
  * @type {boolean}
1755
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
1441
1756
  * @default false
1442
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1443
1757
  * @example
1444
1758
  * ```js
1445
1759
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1455,8 +1769,8 @@ export interface LiveboardAppEmbedViewConfig {
1455
1769
  *
1456
1770
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1457
1771
  * @type {boolean}
1772
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
1458
1773
  * @default false
1459
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
1460
1774
  * @example
1461
1775
  * ```js
1462
1776
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1472,7 +1786,7 @@ export interface LiveboardAppEmbedViewConfig {
1472
1786
  * header.
1473
1787
  *
1474
1788
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1475
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1789
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1476
1790
  * @default true
1477
1791
  * @example
1478
1792
  * ```js
@@ -1490,7 +1804,7 @@ export interface LiveboardAppEmbedViewConfig {
1490
1804
  * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
1491
1805
  *
1492
1806
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1493
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
1807
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
1494
1808
  * @default false
1495
1809
  * @example
1496
1810
  * ```js
@@ -1508,7 +1822,7 @@ export interface LiveboardAppEmbedViewConfig {
1508
1822
  * compact header
1509
1823
  *
1510
1824
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1511
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1825
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1512
1826
  * @default true
1513
1827
  * @example
1514
1828
  * ```js
@@ -1541,7 +1855,7 @@ export interface LiveboardAppEmbedViewConfig {
1541
1855
  * the cover and filters pages in the Liveboard PDF.
1542
1856
  *
1543
1857
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1544
- * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
1858
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
1545
1859
  * @example
1546
1860
  * ```js
1547
1861
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1760,7 +2074,7 @@ export declare enum HomepageModule {
1760
2074
  */
1761
2075
  Search = "SEARCH",
1762
2076
  /**
1763
- * kPI watchlist module
2077
+ * KPI watchlist module
1764
2078
  */
1765
2079
  Watchlist = "WATCHLIST",
1766
2080
  /**
@@ -1791,7 +2105,8 @@ export declare enum ListPageColumns {
1791
2105
  */
1792
2106
  Favorites = "FAVOURITE",
1793
2107
  /**
1794
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
2108
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
2109
+ * @deprecated This option is deprecated.
1795
2110
  */
1796
2111
  Favourite = "FAVOURITE",
1797
2112
  /**
@@ -1892,13 +2207,13 @@ export declare enum EmbedEvent {
1892
2207
  /**
1893
2208
  * Rendering has initialized.
1894
2209
  * @example
1895
- *```js
2210
+ * ```js
1896
2211
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
1897
2212
  * //show a loader
1898
2213
  * function showLoader() {
1899
2214
  * document.getElementById("loader");
1900
2215
  * }
1901
- *```
2216
+ * ```
1902
2217
  * @returns timestamp - The timestamp when the event was generated.
1903
2218
  */
1904
2219
  Init = "init",
@@ -1906,11 +2221,11 @@ export declare enum EmbedEvent {
1906
2221
  * Authentication has either succeeded or failed.
1907
2222
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
1908
2223
  * @example
1909
- *```js
2224
+ * ```js
1910
2225
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
1911
2226
  * console.log('AuthInit', payload);
1912
2227
  * })
1913
- *```
2228
+ * ```
1914
2229
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
1915
2230
  */
1916
2231
  AuthInit = "authInit",
@@ -1919,13 +2234,13 @@ export declare enum EmbedEvent {
1919
2234
  * @returns timestamp - The timestamp when the event was generated.
1920
2235
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
1921
2236
  * @example
1922
- *```js
2237
+ * ```js
1923
2238
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
1924
2239
  * //hide loader
1925
2240
  * function hideLoader() {
1926
2241
  * document.getElementById("loader");
1927
2242
  * }
1928
- *```
2243
+ * ```
1929
2244
  */
1930
2245
  Load = "load",
1931
2246
  /**
@@ -1934,11 +2249,11 @@ export declare enum EmbedEvent {
1934
2249
  * @return data - Answer of Liveboard data
1935
2250
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
1936
2251
  * @example
1937
- *```js
2252
+ * ```js
1938
2253
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
1939
2254
  * console.log('data', payload);
1940
2255
  * })
1941
- *```
2256
+ * ```
1942
2257
  * @important
1943
2258
  */
1944
2259
  Data = "data",
@@ -1946,9 +2261,9 @@ export declare enum EmbedEvent {
1946
2261
  * Search query has been updated by the user.
1947
2262
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
1948
2263
  * @example
1949
- *```js
2264
+ * ```js
1950
2265
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
1951
- *```
2266
+ * ```
1952
2267
  */
1953
2268
  QueryChanged = "queryChanged",
1954
2269
  /**
@@ -1958,7 +2273,7 @@ export declare enum EmbedEvent {
1958
2273
  * @returns drillDownColumns - The columns on which drill down was performed
1959
2274
  * @returns nonFilteredColumns - The columns that were not filtered
1960
2275
  * @example
1961
- *```js
2276
+ * ```js
1962
2277
  * searchEmbed.on(EmbedEvent.DrillDown, {
1963
2278
  * points: {
1964
2279
  * clickedPoint,
@@ -1966,12 +2281,12 @@ export declare enum EmbedEvent {
1966
2281
  * },
1967
2282
  * autoDrillDown: true,
1968
2283
  * })
1969
- *```
2284
+ * ```
1970
2285
  * In this example, `VizPointDoubleClick` event is used for
1971
2286
  * triggering the `DrillDown` event when an area or specific
1972
2287
  * data point on a table or chart is double-clicked.
1973
2288
  * @example
1974
- *```js
2289
+ * ```js
1975
2290
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
1976
2291
  * console.log(payload);
1977
2292
  * const clickedPoint = payload.data.clickedPoint;
@@ -1985,7 +2300,7 @@ export declare enum EmbedEvent {
1985
2300
  * autoDrillDown: true,
1986
2301
  * })
1987
2302
  * })
1988
- *```
2303
+ * ```
1989
2304
  */
1990
2305
  Drilldown = "drillDown",
1991
2306
  /**
@@ -2110,13 +2425,13 @@ export declare enum EmbedEvent {
2110
2425
  * The ThoughtSpot authentication session has expired.
2111
2426
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2112
2427
  * @example
2113
- *```js
2428
+ * ```js
2114
2429
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
2115
2430
  * //show auth expired banner
2116
2431
  * function showAuthExpired() {
2117
2432
  * document.getElementById("authExpiredBanner");
2118
2433
  * }
2119
- *```
2434
+ * ```
2120
2435
  */
2121
2436
  AuthExpire = "ThoughtspotAuthExpired",
2122
2437
  /**
@@ -2151,22 +2466,22 @@ export declare enum EmbedEvent {
2151
2466
  * Applicable to `SearchBarEmbed` only.
2152
2467
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2153
2468
  * @example
2154
- *```js
2469
+ * ```js
2155
2470
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
2156
2471
  * .then(data => {
2157
2472
  * console.log('Answer Data:', data);
2158
2473
  * })
2159
- *```
2474
+ * ```
2160
2475
  */
2161
2476
  GetDataClick = "getDataClick",
2162
2477
  /**
2163
2478
  * Detects the route change.
2164
2479
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
2165
2480
  * @example
2166
- *```js
2481
+ * ```js
2167
2482
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
2168
2483
  * console.log('data', payload))
2169
- *```
2484
+ * ```
2170
2485
  */
2171
2486
  RouteChange = "ROUTE_CHANGE",
2172
2487
  /**
@@ -2176,12 +2491,12 @@ export declare enum EmbedEvent {
2176
2491
  V1Data = "exportVizDataToParent",
2177
2492
  /**
2178
2493
  * Emitted when the embed does not have cookie access. This happens
2179
- * when Safari and other Web browsers block third-party cookies
2180
- * are blocked by default. `NoCookieAccess` can trigger.
2494
+ * when third-party cookies are blocked by Safari or other
2495
+ * web browsers. `NoCookieAccess` can trigger.
2181
2496
  * @example
2182
- *```js
2497
+ * ```js
2183
2498
  * appEmbed.on(EmbedEvent.NoCookieAccess)
2184
- *```
2499
+ * ```
2185
2500
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
2186
2501
  */
2187
2502
  NoCookieAccess = "noCookieAccess",
@@ -2195,22 +2510,22 @@ export declare enum EmbedEvent {
2195
2510
  * Emitted when any modal is opened in the app
2196
2511
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2197
2512
  * @example
2198
- *```js
2513
+ * ```js
2199
2514
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
2200
2515
  * console.log('dialog open', payload);
2201
2516
  * })
2202
- *```
2517
+ * ```
2203
2518
  */
2204
2519
  DialogOpen = "dialog-open",
2205
2520
  /**
2206
2521
  * Emitted when any modal is closed in the app
2207
2522
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2208
2523
  * @example
2209
- *```js
2524
+ * ```js
2210
2525
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
2211
2526
  * console.log('dialog close', payload);
2212
2527
  * })
2213
- *```
2528
+ * ```
2214
2529
  */
2215
2530
  DialogClose = "dialog-close",
2216
2531
  /**
@@ -2219,39 +2534,39 @@ export declare enum EmbedEvent {
2219
2534
  * other events on the rendered Liveboard.
2220
2535
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2221
2536
  * @example
2222
- *```js
2537
+ * ```js
2223
2538
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
2224
2539
  console.log('Liveboard is rendered', payload);
2225
2540
  })
2226
- *```
2541
+ * ```
2227
2542
  * The following example shows how to trigger
2228
2543
  * `SetVisibleVizs` event using LiveboardRendered embed event:
2229
2544
  * @example
2230
- *```js
2545
+ * ```js
2231
2546
  * const embedRef = useEmbedRef();
2232
2547
  * const onLiveboardRendered = () => {
2233
2548
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
2234
2549
  * };
2235
- *```
2550
+ * ```
2236
2551
  */
2237
2552
  LiveboardRendered = "PinboardRendered",
2238
2553
  /**
2239
2554
  * Emits all events.
2240
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2555
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2241
2556
  * @example
2242
- *```js
2557
+ * ```js
2243
2558
  * appEmbed.on(EmbedEvent.ALL, payload => {
2244
2559
  * console.log('Embed Events', payload)
2245
2560
  * })
2246
- *```
2561
+ * ```
2247
2562
  */
2248
2563
  ALL = "*",
2249
2564
  /**
2250
2565
  * Emitted when an Answer is saved in the app.
2251
2566
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
2252
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2567
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2253
2568
  * @example
2254
- *```js
2569
+ * ```js
2255
2570
  * //Emit when action starts
2256
2571
  * searchEmbed.on(EmbedEvent.Save, payload => {
2257
2572
  * console.log('Save', payload)
@@ -2262,7 +2577,7 @@ export declare enum EmbedEvent {
2262
2577
  * searchEmbed.on(EmbedEvent.Save, payload => {
2263
2578
  * console.log('Save', payload)
2264
2579
  * })
2265
- *```
2580
+ * ```
2266
2581
  */
2267
2582
  Save = "save",
2268
2583
  /**
@@ -2274,11 +2589,11 @@ export declare enum EmbedEvent {
2274
2589
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
2275
2590
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2276
2591
  * @example
2277
- *```js
2592
+ * ```js
2278
2593
  * liveboardEmbed.on(EmbedEvent.Download, {
2279
2594
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2280
2595
  * })
2281
- *```
2596
+ * ```
2282
2597
  */
2283
2598
  Download = "download",
2284
2599
  /**
@@ -2286,14 +2601,14 @@ export declare enum EmbedEvent {
2286
2601
  * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
2287
2602
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
2288
2603
  * @example
2289
- *```js
2604
+ * ```js
2290
2605
  * //emit when action starts
2291
2606
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2292
2607
  * console.log('download PNG', payload)}, {start: true })
2293
2608
  * //emit when action ends
2294
2609
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2295
2610
  * console.log('download PNG', payload)})
2296
- *```
2611
+ * ```
2297
2612
  */
2298
2613
  DownloadAsPng = "downloadAsPng",
2299
2614
  /**
@@ -2301,14 +2616,14 @@ export declare enum EmbedEvent {
2301
2616
  * 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.
2302
2617
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2303
2618
  * @example
2304
- *```js
2619
+ * ```js
2305
2620
  * //emit when action starts
2306
2621
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2307
2622
  * console.log('download PDF', payload)}, {start: true })
2308
2623
  * //emit when action ends
2309
2624
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2310
2625
  * console.log('download PDF', payload)})
2311
- *```
2626
+ * ```
2312
2627
  */
2313
2628
  DownloadAsPdf = "downloadAsPdf",
2314
2629
  /**
@@ -2316,14 +2631,14 @@ export declare enum EmbedEvent {
2316
2631
  * 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.
2317
2632
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2318
2633
  * @example
2319
- *```js
2634
+ * ```js
2320
2635
  * //emit when action starts
2321
2636
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2322
2637
  * console.log('download CSV', payload)}, {start: true })
2323
2638
  * //emit when action ends
2324
2639
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2325
2640
  * console.log('download CSV', payload)})
2326
- *```
2641
+ * ```
2327
2642
  */
2328
2643
  DownloadAsCsv = "downloadAsCsv",
2329
2644
  /**
@@ -2331,14 +2646,14 @@ export declare enum EmbedEvent {
2331
2646
  * 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.
2332
2647
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2333
2648
  * @example
2334
- *```js
2649
+ * ```js
2335
2650
  * //emit when action starts
2336
2651
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2337
2652
  * console.log('download Xlsx', payload)}, { start: true })
2338
2653
  * //emit when action ends
2339
2654
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2340
2655
  * console.log('download Xlsx', payload)})
2341
- *```
2656
+ * ```
2342
2657
  */
2343
2658
  DownloadAsXlsx = "downloadAsXlsx",
2344
2659
  /**
@@ -2346,25 +2661,25 @@ export declare enum EmbedEvent {
2346
2661
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
2347
2662
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2348
2663
  * @example
2349
- *```js
2664
+ * ```js
2350
2665
  * //emit when action starts
2351
2666
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2352
2667
  * console.log('delete answer', payload)}, {start: true })
2353
2668
  * //trigger when action is completed
2354
2669
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2355
2670
  * console.log('delete answer', payload)})
2356
- *```
2671
+ * ```
2357
2672
  */
2358
2673
  AnswerDelete = "answerDelete",
2359
2674
  /**
2360
2675
  * Emitted when the AI Highlights action is triggered on a Liveboard
2361
2676
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
2362
2677
  * @example
2363
- *```js
2678
+ * ```js
2364
2679
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
2365
2680
  * console.log('AI Highlights', payload);
2366
2681
  * })
2367
- *```
2682
+ * ```
2368
2683
  */
2369
2684
  AIHighlights = "AIHighlights",
2370
2685
  /**
@@ -2373,7 +2688,7 @@ export declare enum EmbedEvent {
2373
2688
  * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
2374
2689
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2375
2690
  * @example
2376
- *```js
2691
+ * ```js
2377
2692
  * //emit when action starts
2378
2693
  * searchEmbed.on(EmbedEvent.Pin, payload => {
2379
2694
  * console.log('pin', payload)
@@ -2384,14 +2699,14 @@ export declare enum EmbedEvent {
2384
2699
  * searchEmbed.on(EmbedEvent.Pin, payload => {
2385
2700
  * console.log('pin', payload)
2386
2701
  * })
2387
- *```
2702
+ * ```
2388
2703
  */
2389
2704
  Pin = "pin",
2390
2705
  /**
2391
2706
  * Emitted when SpotIQ analysis is triggered
2392
2707
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2393
2708
  * @example
2394
- *```js
2709
+ * ```js
2395
2710
  * //emit when action starts
2396
2711
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2397
2712
  * console.log('SpotIQAnalyze', payload)
@@ -2402,14 +2717,14 @@ export declare enum EmbedEvent {
2402
2717
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2403
2718
  * console.log('SpotIQ analyze', payload)
2404
2719
  * })
2405
- *```
2720
+ * ```
2406
2721
  */
2407
2722
  SpotIQAnalyze = "spotIQAnalyze",
2408
2723
  /**
2409
2724
  * Emitted when a user shares an object with another user or group
2410
2725
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2411
2726
  * @example
2412
- *```js
2727
+ * ```js
2413
2728
  * //emit when action starts
2414
2729
  * searchEmbed.on(EmbedEvent.Share, payload => {
2415
2730
  * console.log('Share', payload)
@@ -2420,7 +2735,7 @@ export declare enum EmbedEvent {
2420
2735
  * searchEmbed.on(EmbedEvent.Share, payload => {
2421
2736
  * console.log('Share', payload)
2422
2737
  * })
2423
- *```
2738
+ * ```
2424
2739
  */
2425
2740
  Share = "share",
2426
2741
  /**
@@ -2428,11 +2743,11 @@ export declare enum EmbedEvent {
2428
2743
  * data on a chart or table.
2429
2744
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2430
2745
  * @example
2431
- *```js
2746
+ * ```js
2432
2747
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
2433
2748
  * console.log('Drill include', payload);
2434
2749
  * })
2435
- *```
2750
+ * ```
2436
2751
  */
2437
2752
  DrillInclude = "context-menu-item-include",
2438
2753
  /**
@@ -2440,22 +2755,22 @@ export declare enum EmbedEvent {
2440
2755
  * data on a chart or table
2441
2756
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2442
2757
  * @example
2443
- *```js
2758
+ * ```js
2444
2759
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
2445
2760
  * console.log('Drill exclude', payload);
2446
2761
  * })
2447
- *```
2762
+ * ```
2448
2763
  */
2449
2764
  DrillExclude = "context-menu-item-exclude",
2450
2765
  /**
2451
2766
  * Emitted when a column value is copied in the embedded app.
2452
2767
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2453
2768
  * @example
2454
- *```js
2455
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2769
+ * ```js
2770
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2456
2771
  * console.log('copy to clipboard', payload);
2457
2772
  * })
2458
- *```
2773
+ * ```
2459
2774
  */
2460
2775
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
2461
2776
  /**
@@ -2463,10 +2778,10 @@ export declare enum EmbedEvent {
2463
2778
  * embedded Liveboard.
2464
2779
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2465
2780
  * @example
2466
- *```js
2781
+ * ```js
2467
2782
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
2468
2783
  * })
2469
- *```
2784
+ * ```
2470
2785
  */
2471
2786
  UpdateTML = "updateTSL",
2472
2787
  /**
@@ -2474,11 +2789,11 @@ export declare enum EmbedEvent {
2474
2789
  * on an embedded Liveboard.
2475
2790
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2476
2791
  * @example
2477
- *```js
2792
+ * ```js
2478
2793
  * appEmbed.on(EmbedEvent.EditTML, payload => {
2479
2794
  * console.log('Edit TML', payload);
2480
2795
  * })
2481
- *```
2796
+ * ```
2482
2797
  */
2483
2798
  EditTML = "editTSL",
2484
2799
  /**
@@ -2487,25 +2802,25 @@ export declare enum EmbedEvent {
2487
2802
  * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
2488
2803
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2489
2804
  * @example
2490
- *```js
2805
+ * ```js
2491
2806
  * //emit when action starts
2492
2807
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2493
2808
  * console.log('Export TML', payload)}, { start: true })
2494
2809
  * //emit when action ends
2495
2810
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2496
2811
  * console.log('Export TML', payload)})
2497
- *```
2812
+ * ```
2498
2813
  */
2499
2814
  ExportTML = "exportTSL",
2500
2815
  /**
2501
2816
  * Emitted when an Answer is saved as a View.
2502
2817
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2503
2818
  * @example
2504
- *```js
2819
+ * ```js
2505
2820
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
2506
2821
  * console.log('View', payload);
2507
2822
  * })
2508
- *```
2823
+ * ```
2509
2824
  */
2510
2825
  SaveAsView = "saveAsView",
2511
2826
  /**
@@ -2513,36 +2828,36 @@ export declare enum EmbedEvent {
2513
2828
  * 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.
2514
2829
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2515
2830
  * @example
2516
- *```js
2831
+ * ```js
2517
2832
  * //emit when action starts
2518
2833
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2519
2834
  * console.log('Copy and edit', payload)}, {start: true })
2520
2835
  * //emit when action ends
2521
2836
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2522
2837
  * console.log('Copy and edit', payload)})
2523
- *```
2838
+ * ```
2524
2839
  */
2525
2840
  CopyAEdit = "copyAEdit",
2526
2841
  /**
2527
2842
  * Emitted when a user clicks *Show underlying data* on an Answer.
2528
2843
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2529
2844
  * @example
2530
- *```js
2845
+ * ```js
2531
2846
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
2532
2847
  * console.log('show data', payload);
2533
2848
  * })
2534
- *```
2849
+ * ```
2535
2850
  */
2536
2851
  ShowUnderlyingData = "showUnderlyingData",
2537
2852
  /**
2538
2853
  * Emitted when an Answer is switched to a chart or table view.
2539
2854
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2540
2855
  * @example
2541
- *```js
2856
+ * ```js
2542
2857
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
2543
2858
  * console.log('switch view', payload);
2544
2859
  * })
2545
- *```
2860
+ * ```
2546
2861
  */
2547
2862
  AnswerChartSwitcher = "answerChartSwitcher",
2548
2863
  /**
@@ -2559,118 +2874,118 @@ export declare enum EmbedEvent {
2559
2874
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
2560
2875
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2561
2876
  * @example
2562
- *```js
2877
+ * ```js
2563
2878
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
2564
2879
  * console.log('Liveboard details', payload);
2565
2880
  * })
2566
- *```
2881
+ * ```
2567
2882
  */
2568
2883
  LiveboardInfo = "pinboardInfo",
2569
2884
  /**
2570
2885
  * Emitted when a user clicks on the Favorite icon on a Liveboard
2571
2886
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2572
2887
  * @example
2573
- *```js
2888
+ * ```js
2574
2889
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
2575
2890
  * console.log('favorites', payload);
2576
2891
  * })
2577
- *```
2892
+ * ```
2578
2893
  */
2579
2894
  AddToFavorites = "addToFavorites",
2580
2895
  /**
2581
2896
  * Emitted when a user clicks **Schedule** on a Liveboard
2582
2897
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2583
2898
  * @example
2584
- *```js
2899
+ * ```js
2585
2900
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
2586
- * console.log(`Liveboard schedule', payload);
2901
+ * console.log('Liveboard schedule', payload);
2587
2902
  * })
2588
- *```
2903
+ * ```
2589
2904
  */
2590
2905
  Schedule = "subscription",
2591
2906
  /**
2592
2907
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
2593
2908
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2594
2909
  * @example
2595
- *```js
2910
+ * ```js
2596
2911
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
2597
- * console.log(`Liveboard edit', payload);
2912
+ * console.log('Liveboard edit', payload);
2598
2913
  * })
2599
- *```
2914
+ * ```
2600
2915
  */
2601
2916
  Edit = "edit",
2602
2917
  /**
2603
2918
  * Emitted when a user clicks *Make a copy* on a Liveboard
2604
2919
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2605
2920
  * @example
2606
- *```js
2921
+ * ```js
2607
2922
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
2608
- * console.log(`Copy', payload);
2923
+ * console.log('Copy', payload);
2609
2924
  * })
2610
- *```
2925
+ * ```
2611
2926
  */
2612
2927
  MakeACopy = "makeACopy",
2613
2928
  /**
2614
2929
  * Emitted when a user clicks **Present** on a Liveboard or visualization
2615
2930
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2616
2931
  * @example
2617
- *```js
2932
+ * ```js
2618
2933
  * liveboardEmbed.on(EmbedEvent.Present)
2619
- *```
2934
+ * ```
2620
2935
  * @example
2621
- *```js
2936
+ * ```js
2622
2937
  * liveboardEmbed.on(EmbedEvent.Present, {
2623
2938
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2624
2939
  * })
2625
- *```
2940
+ * ```
2626
2941
  */
2627
2942
  Present = "present",
2628
2943
  /**
2629
2944
  * Emitted when a user clicks **Delete** on a visualization
2630
2945
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2631
2946
  * @example
2632
- *```js
2947
+ * ```js
2633
2948
  * liveboardEmbed.on(EmbedEvent.Delete,
2634
2949
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2635
- *```
2950
+ * ```
2636
2951
  */
2637
2952
  Delete = "delete",
2638
2953
  /**
2639
2954
  * Emitted when a user clicks Manage schedules on a Liveboard
2640
2955
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2641
2956
  * @example
2642
- *```js
2957
+ * ```js
2643
2958
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
2644
- *```
2959
+ * ```
2645
2960
  */
2646
2961
  SchedulesList = "schedule-list",
2647
2962
  /**
2648
2963
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
2649
2964
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2650
2965
  * @example
2651
- *```js
2966
+ * ```js
2652
2967
  * liveboardEmbed.on(EmbedEvent.Cancel)
2653
- *```
2968
+ * ```
2654
2969
  */
2655
2970
  Cancel = "cancel",
2656
2971
  /**
2657
2972
  * Emitted when a user clicks **Explore** on a visualization
2658
2973
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2659
2974
  * @example
2660
- *```js
2975
+ * ```js
2661
2976
  * liveboardEmbed.on(EmbedEvent.Explore, {
2662
2977
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2663
- *```
2978
+ * ```
2664
2979
  */
2665
2980
  Explore = "explore",
2666
2981
  /**
2667
2982
  * Emitted when a user clicks **Copy link** action on a visualization.
2668
2983
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2669
2984
  * @example
2670
- *```js
2985
+ * ```js
2671
2986
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
2672
2987
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2673
- *```
2988
+ * ```
2674
2989
  */
2675
2990
  CopyLink = "embedDocument",
2676
2991
  /**
@@ -2678,21 +2993,21 @@ export declare enum EmbedEvent {
2678
2993
  * visualization or Liveboard.
2679
2994
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2680
2995
  * @example
2681
- *```js
2996
+ * ```js
2682
2997
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
2683
2998
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2684
- *```
2999
+ * ```
2685
3000
  */
2686
3001
  CrossFilterChanged = "cross-filter-changed",
2687
3002
  /**
2688
3003
  * Emitted when a user right clicks on a visualization (chart or table)
2689
3004
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2690
3005
  * @example
2691
- *```js
3006
+ * ```js
2692
3007
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
2693
3008
  * console.log('VizPointClick', payload)
2694
3009
  * })
2695
- *```
3010
+ * ```
2696
3011
  */
2697
3012
  VizPointRightClick = "vizPointRightClick",
2698
3013
  /**
@@ -2706,35 +3021,35 @@ export declare enum EmbedEvent {
2706
3021
  * filter details.
2707
3022
  * @example
2708
3023
  *
2709
- *```js
3024
+ * ```js
2710
3025
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
2711
3026
  * console.log('payload', payload);
2712
3027
  * })
2713
- *
3028
+ * ```
2714
3029
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
2715
3030
  */
2716
3031
  FilterChanged = "filterChanged",
2717
3032
  /**
2718
3033
  * Emitted when a user clicks the **Go** button to initiate
2719
3034
  * a Natural Language Search query
2720
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3035
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2721
3036
  */
2722
3037
  SageEmbedQuery = "sageEmbedQuery",
2723
3038
  /**
2724
3039
  * Emitted when a user selects a data source on the embedded
2725
3040
  * Natural Language Search interface.
2726
3041
  *
2727
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3042
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2728
3043
  */
2729
3044
  SageWorksheetUpdated = "sageWorksheetUpdated",
2730
3045
  /**
2731
3046
  * Emitted when a user updates a connection on the **Data** page
2732
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3047
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2733
3048
  */
2734
3049
  UpdateConnection = "updateConnection",
2735
3050
  /**
2736
3051
  * Emitted when a user updates a connection on the **Data** page
2737
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3052
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2738
3053
  */
2739
3054
  CreateConnection = "createConnection",
2740
3055
  /**
@@ -2744,7 +3059,7 @@ export declare enum EmbedEvent {
2744
3059
  * @returns viewId: string
2745
3060
  * @returns liveboardId: string
2746
3061
  * @returns isPublic: boolean
2747
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3062
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2748
3063
  */
2749
3064
  UpdatePersonalisedView = "updatePersonalisedView",
2750
3065
  /**
@@ -2753,7 +3068,7 @@ export declare enum EmbedEvent {
2753
3068
  * @returns viewId: string
2754
3069
  * @returns liveboardId: string
2755
3070
  * @returns isPublic: boolean
2756
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3071
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2757
3072
  */
2758
3073
  SavePersonalisedView = "savePersonalisedView",
2759
3074
  /**
@@ -2762,19 +3077,19 @@ export declare enum EmbedEvent {
2762
3077
  * @returns viewId: string
2763
3078
  * @returns liveboardId: string
2764
3079
  * @returns isPublic: boolean
2765
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3080
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2766
3081
  */
2767
3082
  ResetLiveboard = "resetLiveboard",
2768
3083
  /**
2769
3084
  * Emitted when a PersonalisedView is deleted.
2770
3085
  * @returns views: string[]
2771
3086
  * @returns liveboardId: string
2772
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3087
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2773
3088
  */
2774
3089
  DeletePersonalisedView = "deletePersonalisedView",
2775
3090
  /**
2776
3091
  * Emitted when a user creates a Worksheet.
2777
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3092
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2778
3093
  */
2779
3094
  CreateWorksheet = "createWorksheet",
2780
3095
  /**
@@ -2783,12 +3098,12 @@ export declare enum EmbedEvent {
2783
3098
  * @returns viewId: string
2784
3099
  * @returns liveboardId: string
2785
3100
  * @returns isPublic: boolean
2786
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3101
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
2787
3102
  */
2788
3103
  AskSageInit = "AskSageInit",
2789
3104
  /**
2790
3105
  * Emitted when a Liveboard or visualization is renamed.
2791
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3106
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
2792
3107
  */
2793
3108
  Rename = "rename",
2794
3109
  /**
@@ -2806,14 +3121,12 @@ export declare enum EmbedEvent {
2806
3121
  * - `payload`: The payload received from the embed related to the Data API call.
2807
3122
  * - `responder`: Contains elements that let developers define whether ThoughtSpot
2808
3123
  * will run or block the search operation, and if blocked, which error message to provide.
2809
- *
2810
- * `execute` - When `execute` returns `true`, the search is run.
3124
+ * - `execute` - When `execute` returns `true`, the search is run.
2811
3125
  * When `execute` returns `false`, the search is not executed.
2812
- *
2813
- * `error` - Developers can customize the user-facing error message when `execute`
3126
+ * - `error` - Developers can customize the user-facing error message when `execute`
2814
3127
  * is `false` by using the `error` parameters in `responder`.
2815
- * `errorText` - The error message text shown to the user.
2816
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3128
+ * - `errorText` - The error message text shown to the user.
3129
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
2817
3130
  * @example
2818
3131
  *
2819
3132
  * This example blocks search operation and returns a custom error message:
@@ -2828,7 +3141,7 @@ export declare enum EmbedEvent {
2828
3141
  * },
2829
3142
  * },
2830
3143
  * });
2831
- * });
3144
+ * })
2832
3145
  * ```
2833
3146
  * @example
2834
3147
  *
@@ -2854,7 +3167,7 @@ export declare enum EmbedEvent {
2854
3167
  * },
2855
3168
  * },
2856
3169
  * });
2857
- * });
3170
+ * })
2858
3171
  * ```
2859
3172
  */
2860
3173
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
@@ -2865,8 +3178,8 @@ export declare enum EmbedEvent {
2865
3178
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
2866
3179
  * console.log('payload', payload);
2867
3180
  * })
2868
- *```
2869
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3181
+ * ```
3182
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
2870
3183
  */
2871
3184
  ParameterChanged = "parameterChanged",
2872
3185
  /**
@@ -2921,24 +3234,24 @@ export declare enum EmbedEvent {
2921
3234
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
2922
3235
  * console.log('payload', payload);
2923
3236
  * })
2924
- *```
2925
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
3237
+ * ```
3238
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
2926
3239
  */
2927
3240
  CreateLiveboard = "createLiveboard",
2928
3241
  /**
2929
3242
  * Emitted when a user creates a Model.
2930
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
3243
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
2931
3244
  */
2932
3245
  CreateModel = "createModel",
2933
3246
  /**
2934
3247
  * @hidden
2935
3248
  * Emitted when a user exits present mode.
2936
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
3249
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2937
3250
  */
2938
3251
  ExitPresentMode = "exitPresentMode",
2939
3252
  /**
2940
3253
  * Emitted when a user requests the full height lazy load data.
2941
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
3254
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2942
3255
  * @hidden
2943
3256
  */
2944
3257
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
@@ -2949,7 +3262,7 @@ export declare enum EmbedEvent {
2949
3262
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
2950
3263
  * console.log('payload', payload);
2951
3264
  * })
2952
- *```
3265
+ * ```
2953
3266
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2954
3267
  */
2955
3268
  SpotterData = "SpotterData",
@@ -2960,7 +3273,7 @@ export declare enum EmbedEvent {
2960
3273
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
2961
3274
  * console.log('payload', payload);
2962
3275
  * })
2963
- *```
3276
+ * ```
2964
3277
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2965
3278
  */
2966
3279
  PreviewSpotterData = "PreviewSpotterData",
@@ -2971,7 +3284,7 @@ export declare enum EmbedEvent {
2971
3284
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
2972
3285
  * console.log('payload', payload);
2973
3286
  * })
2974
- *```
3287
+ * ```
2975
3288
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
2976
3289
  */
2977
3290
  AddToCoaching = "addToCoaching",
@@ -2993,7 +3306,7 @@ export declare enum EmbedEvent {
2993
3306
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
2994
3307
  * console.log('payload', payload);
2995
3308
  * })
2996
- *```
3309
+ * ```
2997
3310
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2998
3311
  */
2999
3312
  SpotterQueryTriggered = "SpotterQueryTriggered",
@@ -3004,7 +3317,7 @@ export declare enum EmbedEvent {
3004
3317
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
3005
3318
  * console.log('payload', payload);
3006
3319
  * })
3007
- *```
3320
+ * ```
3008
3321
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3009
3322
  */
3010
3323
  LastPromptEdited = "LastPromptEdited",
@@ -3015,18 +3328,18 @@ export declare enum EmbedEvent {
3015
3328
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (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
  LastPromptDeleted = "LastPromptDeleted",
3022
3335
  /**
3023
- * Emitted when the coversation is reset in spotter embed.
3336
+ * Emitted when the conversation is reset in Spotter embed.
3024
3337
  * @example
3025
3338
  * ```js
3026
3339
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (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
  ResetSpotterConversation = "ResetSpotterConversation",
@@ -3037,7 +3350,7 @@ export declare enum EmbedEvent {
3037
3350
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
3038
3351
  * console.log('payload', payload);
3039
3352
  * })
3040
- *```
3353
+ * ```
3041
3354
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
3042
3355
  */
3043
3356
  SpotterInit = "spotterInit",
@@ -3048,7 +3361,7 @@ export declare enum EmbedEvent {
3048
3361
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
3049
3362
  * console.log('payload', payload);
3050
3363
  * })
3051
- *```
3364
+ * ```
3052
3365
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
3053
3366
  */
3054
3367
  SpotterLoadComplete = "spotterLoadComplete",
@@ -3402,7 +3715,7 @@ export declare enum HostEvent {
3402
3715
  * ```js
3403
3716
  * appEmbed.navigateToPage(-1)
3404
3717
  * ```
3405
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
3718
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
3406
3719
  */
3407
3720
  Navigate = "Navigate",
3408
3721
  /**
@@ -3535,9 +3848,9 @@ export declare enum HostEvent {
3535
3848
  * Trigger the **Show Liveboard details** action
3536
3849
  * on an embedded Liveboard.
3537
3850
  * @example
3538
- *```js
3851
+ * ```js
3539
3852
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
3540
- *```
3853
+ * ```
3541
3854
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3542
3855
  */
3543
3856
  LiveboardInfo = "pinboardInfo",
@@ -3665,7 +3978,7 @@ export declare enum HostEvent {
3665
3978
  * appEmbed.trigger(HostEvent.Remove)
3666
3979
  * ```
3667
3980
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3668
- * * @example
3981
+ * @example
3669
3982
  * ```js
3670
3983
  * liveboardEmbed.trigger(HostEvent.Remove)
3671
3984
  * ```
@@ -3756,7 +4069,7 @@ export declare enum HostEvent {
3756
4069
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3757
4070
  * ```
3758
4071
  * ```js
3759
- * vizEmbed.trigger((HostEvent.CopyLink)
4072
+ * vizEmbed.trigger(HostEvent.CopyLink)
3760
4073
  * ```
3761
4074
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3762
4075
  */
@@ -3773,7 +4086,7 @@ export declare enum HostEvent {
3773
4086
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3774
4087
  * ```
3775
4088
  * ```js
3776
- * vizEmbed.trigger((HostEvent.Present)
4089
+ * vizEmbed.trigger(HostEvent.Present)
3777
4090
  * ```
3778
4091
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3779
4092
  */
@@ -3788,23 +4101,22 @@ export declare enum HostEvent {
3788
4101
  * );
3789
4102
  * })
3790
4103
  * ```
3791
- * * @example
4104
+ * @example
3792
4105
  * ```js
3793
-
3794
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
3795
- * let latestSpotterVizId = '';
3796
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
3797
- * latestSpotterVizId = payload.data.id;
3798
- * });
3799
- *
3800
- * spotterEmbed.trigger(HostEvent.GetTML, {
4106
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
4107
+ * let latestSpotterVizId = '';
4108
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4109
+ * latestSpotterVizId = payload.data.id;
4110
+ * });
4111
+ *
4112
+ * spotterEmbed.trigger(HostEvent.GetTML, {
3801
4113
  * vizId: latestSpotterVizId
3802
4114
  * }).then((tml) => {
3803
4115
  * console.log(
3804
4116
  * tml.answer.search_query // TML representation of the search query
3805
4117
  * );
3806
4118
  * })
3807
- * ```
4119
+ * ```
3808
4120
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3809
4121
  * @important
3810
4122
  */
@@ -3868,6 +4180,11 @@ export declare enum HostEvent {
3868
4180
  /**
3869
4181
  * Trigger the **Download** action on charts in
3870
4182
  * the embedded view.
4183
+ * Use {@link HostEvent.DownloadAsPng} instead.
4184
+ *
4185
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4186
+ *
4187
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
3871
4188
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
3872
4189
  * @example
3873
4190
  * ```js
@@ -3886,9 +4203,6 @@ export declare enum HostEvent {
3886
4203
  *
3887
4204
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
3888
4205
  * ```
3889
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
3890
- * Use {@link DownloadAsPng}
3891
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
3892
4206
  */
3893
4207
  Download = "downloadAsPng",
3894
4208
  /**
@@ -4326,8 +4640,8 @@ export declare enum HostEvent {
4326
4640
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
4327
4641
  * console.log('parameters', parameter);
4328
4642
  * });
4329
- *```
4330
- *```js
4643
+ * ```
4644
+ * ```js
4331
4645
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
4332
4646
  * let latestSpotterVizId = '';
4333
4647
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -4335,7 +4649,7 @@ export declare enum HostEvent {
4335
4649
  * });
4336
4650
  *
4337
4651
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
4338
- *```
4652
+ * ```
4339
4653
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4340
4654
  */
4341
4655
  GetParameters = "GetParameters",
@@ -4352,7 +4666,7 @@ export declare enum HostEvent {
4352
4666
  * Notify when info call is completed successfully
4353
4667
  * ```js
4354
4668
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
4355
- *```
4669
+ * ```
4356
4670
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4357
4671
  */
4358
4672
  InfoSuccess = "InfoSuccess",
@@ -4455,7 +4769,7 @@ export declare enum HostEvent {
4455
4769
  * ```js
4456
4770
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
4457
4771
  *
4458
- *```
4772
+ * ```
4459
4773
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4460
4774
  */
4461
4775
  AddToCoaching = "addToCoaching",
@@ -4497,7 +4811,7 @@ export declare enum HostEvent {
4497
4811
  * });
4498
4812
  *
4499
4813
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
4500
- *```
4814
+ * ```
4501
4815
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4502
4816
  */
4503
4817
  AnswerChartSwitcher = "answerChartSwitcher",
@@ -4507,7 +4821,7 @@ export declare enum HostEvent {
4507
4821
  * This is automatically triggered by the SDK when fullscreen mode is exited.
4508
4822
  * ```js
4509
4823
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
4510
- *```
4824
+ * ```
4511
4825
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4512
4826
  */
4513
4827
  ExitPresentMode = "exitPresentMode",
@@ -4649,6 +4963,7 @@ export declare enum Param {
4649
4963
  cookieless = "cookieless",
4650
4964
  ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
4651
4965
  LinkOverride = "linkOverride",
4966
+ EnableLinkOverridesV2 = "enableLinkOverridesV2",
4652
4967
  blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
4653
4968
  ShowInsertToSlide = "insertInToSlide",
4654
4969
  PrimaryNavHidden = "primaryNavHidden",
@@ -4742,7 +5057,8 @@ export declare enum Param {
4742
5057
  SpotterNewChatButtonTitle = "spotterNewChatButtonTitle",
4743
5058
  IsThisPeriodInDateFiltersEnabled = "isThisPeriodInDateFiltersEnabled",
4744
5059
  HideToolResponseCardBranding = "hideToolResponseCardBranding",
4745
- ToolResponseCardBrandingLabel = "toolResponseCardBrandingLabel"
5060
+ ToolResponseCardBrandingLabel = "toolResponseCardBrandingLabel",
5061
+ EnableHomepageAnnouncement = "enableHomepageAnnouncement"
4746
5062
  }
4747
5063
  /**
4748
5064
  * ThoughtSpot application pages include actions and menu commands
@@ -4901,14 +5217,14 @@ export declare enum Action {
4901
5217
  * ```js
4902
5218
  * disabledActions: [Action.CollapseDataPanel]
4903
5219
  * ```
4904
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5220
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
4905
5221
  */
4906
5222
  CollapseDataSources = "collapseDataSources",
4907
5223
  /**
4908
5224
  * The **Collapse data panel** icon on the Search page.
4909
5225
  * Collapses the data panel view.
4910
5226
  *
4911
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5227
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4912
5228
  *
4913
5229
  * @example
4914
5230
  * ```js
@@ -5355,13 +5671,12 @@ export declare enum Action {
5355
5671
  */
5356
5672
  CreateMonitor = "createMonitor",
5357
5673
  /**
5358
- * @deprecated
5359
- * Reports errors
5674
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5675
+ * @deprecated This action is deprecated. It was used for reporting errors.
5360
5676
  * @example
5361
5677
  * ```js
5362
5678
  * disabledActions: [Action.ReportError]
5363
5679
  * ```
5364
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5365
5680
  */
5366
5681
  ReportError = "reportError",
5367
5682
  /**
@@ -5371,7 +5686,7 @@ export declare enum Action {
5371
5686
  * ```js
5372
5687
  * disabledActions: [Action.SyncToSheets]
5373
5688
  * ```
5374
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5689
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5375
5690
  */
5376
5691
  SyncToSheets = "sync-to-sheets",
5377
5692
  /**
@@ -5382,7 +5697,7 @@ export declare enum Action {
5382
5697
  * ```js
5383
5698
  * disabledActions: [Action.SyncToOtherApps]
5384
5699
  * ```
5385
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5700
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5386
5701
  */
5387
5702
  SyncToOtherApps = "sync-to-other-apps",
5388
5703
  /**
@@ -5392,7 +5707,7 @@ export declare enum Action {
5392
5707
  * ```js
5393
5708
  * disabledActions: [Action.ManagePipelines]
5394
5709
  * ```
5395
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5710
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5396
5711
  */
5397
5712
  ManagePipelines = "manage-pipeline",
5398
5713
  /**
@@ -5704,7 +6019,7 @@ export declare enum Action {
5704
6019
  * ```js
5705
6020
  * disabledActions: [Action.PersonalisedViewsDropdown]
5706
6021
  * ```
5707
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6022
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5708
6023
  */
5709
6024
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
5710
6025
  /**
@@ -5714,7 +6029,7 @@ export declare enum Action {
5714
6029
  * ```js
5715
6030
  * disabledActions: [Action.LiveboardUsers]
5716
6031
  * ```
5717
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6032
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5718
6033
  */
5719
6034
  LiveboardUsers = "liveboardUsers",
5720
6035
  /**
@@ -5732,7 +6047,7 @@ export declare enum Action {
5732
6047
  * hiddenAction: [Action.TML] // hide all TML actions
5733
6048
  * disabledActions: [Action.TML] // to disable all TML actions
5734
6049
  * ```
5735
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6050
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
5736
6051
  */
5737
6052
  TML = "tml",
5738
6053
  /**
@@ -5778,7 +6093,7 @@ export declare enum Action {
5778
6093
  * ```js
5779
6094
  * disabledActions: [Action.AddToWatchlist]
5780
6095
  * ```
5781
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6096
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
5782
6097
  */
5783
6098
  AddToWatchlist = "addToWatchlist",
5784
6099
  /**
@@ -5788,7 +6103,7 @@ export declare enum Action {
5788
6103
  * ```js
5789
6104
  * disabledActions: [Action.RemoveFromWatchlist]
5790
6105
  * ```
5791
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6106
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
5792
6107
  */
5793
6108
  RemoveFromWatchlist = "removeFromWatchlist",
5794
6109
  /**
@@ -5799,7 +6114,7 @@ export declare enum Action {
5799
6114
  * ```js
5800
6115
  * disabledActions: [Action.OrganiseFavourites]
5801
6116
  * ```
5802
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6117
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
5803
6118
  */
5804
6119
  OrganiseFavourites = "organiseFavourites",
5805
6120
  /**
@@ -5860,7 +6175,7 @@ export declare enum Action {
5860
6175
  * ```js
5861
6176
  * disabledActions: [Action.ManageTags]
5862
6177
  * ```
5863
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6178
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5864
6179
  */
5865
6180
  ManageTags = "manageTags",
5866
6181
  /**
@@ -6351,17 +6666,79 @@ export interface CustomAction {
6351
6666
  * positions in the application.
6352
6667
  */
6353
6668
  export declare enum CustomActionsPosition {
6669
+ /**
6670
+ * Shows the action as a primary button
6671
+ * in the toolbar area of the embed.
6672
+ */
6354
6673
  PRIMARY = "PRIMARY",
6674
+ /**
6675
+ * Shows the action inside the "More" menu
6676
+ * (three-dot overflow menu).
6677
+ */
6355
6678
  MENU = "MENU",
6679
+ /**
6680
+ * Shows the action in the right-click
6681
+ * context menu. Only supported for
6682
+ * {@link CustomActionTarget.VIZ},
6683
+ * {@link CustomActionTarget.ANSWER}, and
6684
+ * {@link CustomActionTarget.SPOTTER} targets.
6685
+ */
6356
6686
  CONTEXTMENU = "CONTEXTMENU"
6357
6687
  }
6358
6688
  /**
6359
- * Enum options to mention the target of the custom action.
6689
+ * Enum options to mention the target of the code-based custom action.
6690
+ * The target determines which type of ThoughtSpot object the action is
6691
+ * associated with, and also controls which positions and scoping options
6692
+ * are available.
6360
6693
  */
6361
6694
  export declare enum CustomActionTarget {
6695
+ /**
6696
+ * Action applies at the Liveboard level.
6697
+ * Supported positions:
6698
+ * {@link CustomActionsPosition.PRIMARY},
6699
+ * {@link CustomActionsPosition.MENU}.
6700
+ * Can be scoped with
6701
+ * `metadataIds.liveboardIds`,
6702
+ * `orgIds`, and `groupIds`.
6703
+ */
6362
6704
  LIVEBOARD = "LIVEBOARD",
6705
+ /**
6706
+ * Action applies to individual
6707
+ * visualizations (charts/tables).
6708
+ * Supported positions:
6709
+ * {@link CustomActionsPosition.PRIMARY},
6710
+ * {@link CustomActionsPosition.MENU},
6711
+ * {@link CustomActionsPosition.CONTEXTMENU}.
6712
+ * Can be scoped with `metadataIds`
6713
+ * (answerIds, liveboardIds, vizIds),
6714
+ * `dataModelIds` (modelIds,
6715
+ * modelColumnNames), `orgIds`,
6716
+ * and `groupIds`.
6717
+ */
6363
6718
  VIZ = "VIZ",
6719
+ /**
6720
+ * Action applies to saved or unsaved
6721
+ * Answers. Supported positions:
6722
+ * {@link CustomActionsPosition.PRIMARY},
6723
+ * {@link CustomActionsPosition.MENU},
6724
+ * {@link CustomActionsPosition.CONTEXTMENU}.
6725
+ * Can be scoped with
6726
+ * `metadataIds.answerIds`,
6727
+ * `dataModelIds` (modelIds,
6728
+ * modelColumnNames), `orgIds`,
6729
+ * and `groupIds`.
6730
+ */
6364
6731
  ANSWER = "ANSWER",
6732
+ /**
6733
+ * Action applies to Spotter
6734
+ * (AI-powered search).
6735
+ * Supported positions:
6736
+ * {@link CustomActionsPosition.MENU},
6737
+ * {@link CustomActionsPosition.CONTEXTMENU}.
6738
+ * Can be scoped with
6739
+ * `dataModelIds.modelIds`,
6740
+ * `orgIds`, and `groupIds`.
6741
+ */
6365
6742
  SPOTTER = "SPOTTER"
6366
6743
  }
6367
6744
  /**
@@ -6653,14 +7030,14 @@ export type ApiInterceptFlags = {
6653
7030
  /**
6654
7031
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
6655
7032
  *
6656
- * Can be used for Serach and App Embed from SDK 1.29.0
7033
+ * Can be used for Search and App Embed from SDK 1.29.0
6657
7034
  *
6658
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7035
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
6659
7036
  */
6660
7037
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
6661
7038
  /**
6662
7039
  * This allows to intercept the urls passed, once intercepted the api will only
6663
- * run based on the reponse from the responder of ApiIntercept event.
7040
+ * run based on the response from the responder of ApiIntercept event.
6664
7041
  *
6665
7042
  * @example
6666
7043
  * ```js
@@ -6671,7 +7048,7 @@ export type ApiInterceptFlags = {
6671
7048
  * })
6672
7049
  * ```
6673
7050
  *
6674
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7051
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
6675
7052
  */
6676
7053
  interceptUrls?: (string | InterceptedApiType)[];
6677
7054
  /**
@@ -6688,7 +7065,7 @@ export type ApiInterceptFlags = {
6688
7065
  * })
6689
7066
  * ```
6690
7067
  *
6691
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7068
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
6692
7069
  */
6693
7070
  interceptTimeout?: number;
6694
7071
  };