@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
@@ -428,37 +428,37 @@ export interface CustomCssVariables {
428
428
  /**
429
429
  * Padding of the groups in the Liveboard.
430
430
  *
431
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
431
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
432
432
  */
433
433
  "--ts-var-liveboard-group-padding"?: string;
434
434
  /**
435
435
  * Font size of the title of the groups in the Liveboard.
436
436
  *
437
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
437
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
438
438
  */
439
439
  "--ts-var-liveboard-group-title-font-size"?: string;
440
440
  /**
441
441
  * Font weight of the title of the groups in the Liveboard.
442
442
  *
443
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
443
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
444
444
  */
445
445
  "--ts-var-liveboard-group-title-font-weight"?: string;
446
446
  /**
447
447
  * Font size of the title of the tiles inside the groups in the Liveboard.
448
448
  *
449
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
449
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
450
450
  */
451
451
  "--ts-var-liveboard-group-tile-title-font-size"?: string;
452
452
  /**
453
453
  * Font weight of the title of the tiles inside the groups in the Liveboard.
454
454
  *
455
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
455
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
456
456
  */
457
457
  "--ts-var-liveboard-group-tile-title-font-weight"?: string;
458
458
  /**
459
459
  * Padding of the group tiles in the Liveboard.
460
460
  *
461
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
461
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
462
462
  */
463
463
  "--ts-var-liveboard-group-tile-padding"?: string;
464
464
  /**
@@ -468,13 +468,13 @@ export interface CustomCssVariables {
468
468
  /**
469
469
  * Background color of the groups in the Liveboard.
470
470
  *
471
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
471
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
472
472
  */
473
473
  "--ts-var-liveboard-group-background"?: string;
474
474
  /**
475
475
  * Border color of the groups in the Liveboard.
476
476
  *
477
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
477
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
478
478
  */
479
479
  "--ts-var-liveboard-group-border-color"?: string;
480
480
  /**
@@ -488,55 +488,55 @@ export interface CustomCssVariables {
488
488
  /**
489
489
  * Font color of the title of the groups in the Liveboard.
490
490
  *
491
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
491
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
492
492
  */
493
493
  "--ts-var-liveboard-group-title-font-color"?: string;
494
494
  /**
495
495
  * Font color of the description of the groups in the Liveboard.
496
496
  *
497
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
497
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
498
498
  */
499
499
  "--ts-var-liveboard-group-description-font-color"?: string;
500
500
  /**
501
501
  * Font color of the title of the tiles inside the groups in the Liveboard.
502
502
  *
503
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
503
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
504
504
  */
505
505
  "--ts-var-liveboard-group-tile-title-font-color"?: string;
506
506
  /**
507
507
  * Font color of the description of the tiles inside the groups in the Liveboard.
508
508
  *
509
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
509
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
510
510
  */
511
511
  "--ts-var-liveboard-group-tile-description-font-color"?: string;
512
512
  /**
513
513
  * Background color of the tiles inside the groups in the Liveboard.
514
514
  *
515
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
515
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
516
516
  */
517
517
  "--ts-var-liveboard-group-tile-background"?: string;
518
518
  /**
519
519
  * Background color of the filter chips in the Liveboard.
520
520
  *
521
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
521
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
522
522
  */
523
523
  "--ts-var-liveboard-chip-background"?: string;
524
524
  /**
525
525
  * Font color of the filter chips in the Liveboard.
526
526
  *
527
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
527
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
528
528
  */
529
529
  "--ts-var-liveboard-chip-color"?: string;
530
530
  /**
531
531
  * Background color of the filter chips in the Liveboard on hover.
532
532
  *
533
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
533
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
534
534
  */
535
535
  "--ts-var-liveboard-chip--hover-background"?: string;
536
536
  /**
537
537
  * Background color of the filter chips in the Liveboard on active.
538
538
  *
539
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
539
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
540
540
  */
541
541
  "--ts-var-liveboard-chip--active-background"?: string;
542
542
  /**
@@ -809,6 +809,7 @@ declare class AnswerService {
809
809
  * ]);
810
810
  * console.log(await service.fetchData());
811
811
  * });
812
+ * ```
812
813
  */
813
814
  addColumnsByName(columnNames: string[]): Promise<any>;
814
815
  /**
@@ -880,7 +881,7 @@ declare class AnswerService {
880
881
  * const data = await underlying.fetchData(0, 100);
881
882
  * })
882
883
  * ```
883
- * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
884
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
884
885
  */
885
886
  getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
886
887
  /**
@@ -901,7 +902,7 @@ declare class AnswerService {
901
902
  setTMLOverride(override: any): void;
902
903
  }
903
904
  /**
904
- * The authentication mechanism for allowing access to the
905
+ * The authentication mechanism for allowing access to
905
906
  * the embedded app
906
907
  * @group Authentication / Init
907
908
  */
@@ -926,6 +927,7 @@ export declare enum AuthType {
926
927
  * To use this:
927
928
  * Your SAML or OpenID provider must allow iframe redirects.
928
929
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
930
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
929
931
  * @example
930
932
  * ```js
931
933
  * init({
@@ -933,18 +935,17 @@ export declare enum AuthType {
933
935
  * authType: AuthType.EmbeddedSSO,
934
936
  * });
935
937
  * ```
936
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
937
938
  */
938
939
  EmbeddedSSO = "EmbeddedSSO",
939
940
  /**
940
- * SSO using SAML
941
- * @deprecated Use {@link SAMLRedirect} instead
941
+ * SSO using SAML, Use {@link SAMLRedirect} instead
942
+ * @deprecated This option is deprecated.
942
943
  * @hidden
943
944
  */
944
945
  SSO = "SSO_SAML",
945
946
  /**
946
- * SSO using SAML
947
- * @deprecated Use {@link SAMLRedirect} instead
947
+ * SSO using SAML, Use {@link SAMLRedirect} instead
948
+ * @deprecated This option is deprecated.
948
949
  * @hidden
949
950
  */
950
951
  SAML = "SSO_SAML",
@@ -995,8 +996,9 @@ export declare enum AuthType {
995
996
  SAMLRedirect = "SSO_SAML",
996
997
  /**
997
998
  * SSO using OIDC
999
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
1000
+ * @deprecated This option is deprecated.
998
1001
  * @hidden
999
- * @deprecated Use {@link OIDCRedirect} instead
1000
1002
  */
1001
1003
  OIDC = "SSO_OIDC",
1002
1004
  /**
@@ -1007,8 +1009,9 @@ export declare enum AuthType {
1007
1009
  OIDCRedirect = "SSO_OIDC",
1008
1010
  /**
1009
1011
  * Trusted authentication server
1012
+ * Use {@link TrustedAuth} instead
1013
+ * @deprecated This option is deprecated.
1010
1014
  * @hidden
1011
- * @deprecated Use {@link TrustedAuth} instead
1012
1015
  */
1013
1016
  AuthServer = "AuthServer",
1014
1017
  /**
@@ -1035,6 +1038,7 @@ export declare enum AuthType {
1035
1038
  * obtained from ThoughtSpot. This uses a cookieless authentication
1036
1039
  * approach, recommended to bypass the third-party cookie-blocking restriction
1037
1040
  * implemented by some browsers.
1041
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1038
1042
  * @example
1039
1043
  * ```js
1040
1044
  * init({
@@ -1045,8 +1049,8 @@ export declare enum AuthType {
1045
1049
  * .then((response) => response.json())
1046
1050
  * .then((data) => data.token);
1047
1051
  * }
1052
+ * });
1048
1053
  * ```
1049
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1050
1054
  */
1051
1055
  TrustedAuthTokenCookieless = "AuthServerCookieless",
1052
1056
  /**
@@ -1061,43 +1065,43 @@ declare enum HomeLeftNavItem {
1061
1065
  /**
1062
1066
  * The *Search data* option in
1063
1067
  * the *Insights* left navigation panel.
1064
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1068
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1065
1069
  */
1066
1070
  SearchData = "search-data",
1067
1071
  /**
1068
1072
  * The *Home* menu option in
1069
1073
  * the *Insights* left navigation panel.
1070
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1074
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1071
1075
  */
1072
1076
  Home = "insights-home",
1073
1077
  /**
1074
1078
  * The *Liveboards* menu option in
1075
1079
  * the *Insights* left navigation panel.
1076
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1080
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1077
1081
  */
1078
1082
  Liveboards = "liveboards",
1079
1083
  /**
1080
1084
  * The *Answers* menu option in
1081
1085
  * the *Insights* left navigation panel.
1082
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1086
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1083
1087
  */
1084
1088
  Answers = "answers",
1085
1089
  /**
1086
1090
  * The *Monitor subscriptions* menu option in
1087
1091
  * the *Insights* left navigation panel.
1088
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1092
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1089
1093
  */
1090
1094
  MonitorSubscription = "monitor-alerts",
1091
1095
  /**
1092
1096
  * The *SpotIQ analysis* menu option in
1093
1097
  * the *Insights* left navigation panel.
1094
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1098
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1095
1099
  */
1096
1100
  SpotIQAnalysis = "spotiq-analysis",
1097
1101
  /**
1098
1102
  * The *Liveboard schedules* menu option in
1099
1103
  * the *Insights* left navigation panel.
1100
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
1104
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
1101
1105
  */
1102
1106
  LiveboardSchedules = "liveboard-schedules",
1103
1107
  /**
@@ -1268,8 +1272,8 @@ export interface EmbedConfig {
1268
1272
  * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
1269
1273
  * open the SAML auth flow in a popup, instead of redirecting the browser in
1270
1274
  * place.
1275
+ * @deprecated This option is deprecated.
1271
1276
  * @default false
1272
- * @deprecated
1273
1277
  */
1274
1278
  noRedirect?: boolean;
1275
1279
  /**
@@ -1278,8 +1282,8 @@ export interface EmbedConfig {
1278
1282
  *
1279
1283
  * Need to use this with `authTriggerContainer`. Or manually trigger
1280
1284
  * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
1281
- * @default false
1282
1285
  * @version SDK: 1.18.0
1286
+ * @default false
1283
1287
  */
1284
1288
  inPopup?: boolean;
1285
1289
  /**
@@ -1288,7 +1292,7 @@ export interface EmbedConfig {
1288
1292
  * terminated.
1289
1293
  *
1290
1294
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1291
- * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
1295
+ * @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1292
1296
  */
1293
1297
  redirectPath?: string;
1294
1298
  /** @internal */
@@ -1361,7 +1365,7 @@ export interface EmbedConfig {
1361
1365
  detectCookieAccessSlow?: boolean;
1362
1366
  /**
1363
1367
  * Hide the `beta` alert warning message for SearchEmbed.
1364
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
1368
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
1365
1369
  */
1366
1370
  suppressSearchEmbedBetaWarning?: boolean;
1367
1371
  /**
@@ -1378,6 +1382,7 @@ export interface EmbedConfig {
1378
1382
  * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
1379
1383
  * button that the user can click to trigger the flow.
1380
1384
  * This attribute sets a containing element for that button.
1385
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1381
1386
  * @example
1382
1387
  * ```js
1383
1388
  * init({
@@ -1386,7 +1391,6 @@ export interface EmbedConfig {
1386
1391
  * authTriggerContainer: '#auth-trigger-container'
1387
1392
  * })
1388
1393
  * ```
1389
- * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1390
1394
  */
1391
1395
  authTriggerContainer?: string | HTMLElement;
1392
1396
  /**
@@ -1403,11 +1407,10 @@ export interface EmbedConfig {
1403
1407
  */
1404
1408
  authTriggerText?: string;
1405
1409
  /**
1406
- * Prevent users from accessing the full application or ThoughtSpot application pages
1407
- * access to the embedded application users
1408
- * outside of the iframe.
1409
- * @default true
1410
+ * Prevent embedded application users from accessing ThoughtSpot
1411
+ * application pages outside of the iframe.
1410
1412
  * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1413
+ * @default true
1411
1414
  */
1412
1415
  blockNonEmbedFullAppAccess?: boolean;
1413
1416
  /**
@@ -1437,6 +1440,7 @@ export interface EmbedConfig {
1437
1440
  * other logs such as warnings, information alerts,
1438
1441
  * and debug messages in the console output.
1439
1442
  *
1443
+ * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
1440
1444
  * @default LogLevel.ERROR
1441
1445
  * @example
1442
1446
  * ```js
@@ -1445,7 +1449,6 @@ export interface EmbedConfig {
1445
1449
  * logLevel: LogLevel.SILENT
1446
1450
  * })
1447
1451
  * ```
1448
- * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
1449
1452
  */
1450
1453
  logLevel?: LogLevel;
1451
1454
  /**
@@ -1472,6 +1475,7 @@ export interface EmbedConfig {
1472
1475
  * This flag is used to disable the token verification in the SDK.
1473
1476
  * Enabling this flag will also disable the caching of the token.
1474
1477
  * @hidden
1478
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
1475
1479
  * @example
1476
1480
  * ```js
1477
1481
  * init({
@@ -1479,12 +1483,11 @@ export interface EmbedConfig {
1479
1483
  * disableTokenVerification : true
1480
1484
  * })
1481
1485
  * ```
1482
- * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
1483
1486
  */
1484
1487
  disableTokenVerification?: boolean;
1485
1488
  /**
1486
1489
  * This flag is used to disable showing the login failure page in the embedded app.
1487
- * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
1490
+ * @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
1488
1491
  */
1489
1492
  disableLoginFailurePage?: boolean;
1490
1493
  /**
@@ -1494,6 +1497,7 @@ export interface EmbedConfig {
1494
1497
  * Warning: This option is for advanced use only and is used internally
1495
1498
  * to control embed behavior in non-regular ways. We do not publish the
1496
1499
  * list of supported keys and values associated with each.
1500
+ * @version SDK: 1.33.5 | ThoughtSpot: *
1497
1501
  * @example
1498
1502
  * ```js
1499
1503
  * const embed = new LiveboardEmbed('#embed', {
@@ -1504,7 +1508,6 @@ export interface EmbedConfig {
1504
1508
  * }
1505
1509
  * });
1506
1510
  * ```
1507
- * @version SDK: 1.33.5 | ThoughtSpot: *
1508
1511
  */
1509
1512
  additionalFlags?: {
1510
1513
  [key: string]: string | number | boolean;
@@ -1512,6 +1515,7 @@ export interface EmbedConfig {
1512
1515
  /**
1513
1516
  * This is an object (key/val) for customVariables being
1514
1517
  * used by the third party tool's script.
1518
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
1515
1519
  * @example
1516
1520
  * ```js
1517
1521
  * const embed = new LiveboardEmbed('#embed', {
@@ -1522,15 +1526,14 @@ export interface EmbedConfig {
1522
1526
  * }
1523
1527
  * });
1524
1528
  * ```
1525
- * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
1526
1529
  */
1527
1530
  customVariablesForThirdPartyTools?: Record<string, any>;
1528
1531
  disablePreauthCache?: boolean;
1529
1532
  /**
1530
1533
  * Disable fullscreen presentation mode functionality. When enabled, prevents entering
1531
1534
  * and exiting fullscreen mode for embedded visualizations during presentations.
1532
- * @default true (feature is disabled by default)
1533
1535
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1536
+ * @default true (feature is disabled by default)
1534
1537
  * @example
1535
1538
  * ```js
1536
1539
  * init({
@@ -1549,18 +1552,154 @@ export interface EmbedConfig {
1549
1552
  * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
1550
1553
  * @example
1551
1554
  * ```js
1552
- * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
1555
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
1556
+ * init({
1557
+ * ... // other embed config options
1558
+ * customActions: [
1559
+ * {
1560
+ * // Unique identifier for the custom action
1561
+ * id: 'my-custom-action',
1562
+ *
1563
+ * // Display name shown to users in the UI
1564
+ * name: 'My Custom Action',
1565
+ *
1566
+ * // Where the action appears in the UI
1567
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1568
+ * // MENU: Shows in the "More" menu (three dots menu)
1569
+ * // CONTEXTMENU: Shows in the right-click context menu
1570
+ * position: CustomActionsPosition.PRIMARY,
1571
+ *
1572
+ * // What type of content this action applies to
1573
+ * // ANSWER: Available on answer pages
1574
+ * target: CustomActionTarget.ANSWER,
1575
+ *
1576
+ * // Optional: Restrict where this action appears based on data models
1577
+ * // dataModelIds: {
1578
+ * // // Restrict to specific data models
1579
+ * // modelIds: ['model-id-1', 'model-id-2'],
1580
+ * // // Restrict to specific columns within models
1581
+ * // modelColumnNames: ['model-id::column-name']
1582
+ * // },
1583
+ *
1584
+ * // Optional: Restrict where this action appears based on metadata
1585
+ * // metadataIds: {
1586
+ * // // Restrict to specific answers
1587
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
1588
+ * // },
1589
+ * // // Restrict to specific groups (for group-based access control)
1590
+ * // groupIds: ['group-id-1', 'group-id-2'],
1591
+ * // // Restrict to specific organizations (for multi-org deployments)
1592
+ * // orgIds: ['org-id-1', 'org-id-2'],
1593
+ * }
1594
+ * ],
1595
+ * })
1596
+ * ```
1597
+ * @example
1598
+ * ```js
1599
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
1600
+ * init({
1601
+ * ... // other embed config options
1602
+ * customActions: [
1603
+ * {
1604
+ * // Unique identifier for the custom action
1605
+ * id: 'my-custom-action',
1606
+ *
1607
+ * // Display name shown to users in the UI
1608
+ * name: 'My Custom Action',
1609
+ *
1610
+ * // Where the action appears in the UI
1611
+ * // MENU: Shows in the "More" menu (three dots menu)
1612
+ * // CONTEXTMENU: Shows in the right-click context menu
1613
+ * position: CustomActionsPosition.MENU,
1614
+ *
1615
+ * // What type of content this action applies to
1616
+ * // SPOTTER: Available in Spotter (AI-powered search)
1617
+ * target: CustomActionTarget.SPOTTER,
1618
+ *
1619
+ * // Optional: Restrict where this action appears based on data models
1620
+ * // dataModelIds: {
1621
+ * // // Restrict to specific data models
1622
+ * // modelIds: ['model-id-1', 'model-id-2'],
1623
+ * // },
1624
+ * // // Restrict to specific groups (for group-based access control)
1625
+ * // groupIds: ['group-id-1'],
1626
+ * // // Restrict to specific organizations (for multi-org deployments)
1627
+ * // orgIds: ['org-id-1'],
1628
+ * }
1629
+ * ],
1630
+ * })
1631
+ * ```
1632
+ * @example
1633
+ * ```js
1634
+ * import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
1553
1635
  * init({
1554
1636
  * ... // other embed config options
1555
1637
  * customActions: [
1556
1638
  * {
1557
- * name: 'customAction',
1558
- * id: 'customAction',
1639
+ * // Unique identifier for the custom action
1640
+ * id: 'my-liveboard-custom-action',
1641
+ *
1642
+ * // Display name shown to users in the UI
1643
+ * name: 'My Liveboard Custom Action',
1644
+ *
1645
+ * // Where the action appears in the UI
1646
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1647
+ * // MENU: Shows in the "More" menu (three dots menu)
1648
+ * position: CustomActionsPosition.PRIMARY,
1649
+ *
1650
+ * // What type of content this action applies to
1651
+ * // LIVEBOARD: Available on liveboard pages
1652
+ * target: CustomActionTarget.LIVEBOARD,
1653
+ *
1654
+ * // Optional: Restrict where this action appears based on metadata
1655
+ * // metadataIds: {
1656
+ * // // Restrict to specific liveboards
1657
+ * // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
1658
+ * // },
1659
+ * // // Restrict to specific groups (for group-based access control)
1660
+ * // groupIds: ['group-id-1', 'group-id-2'],
1661
+ * // // Restrict to specific organizations (for multi-org deployments)
1662
+ * // orgIds: ['org-id-1', 'org-id-2'],
1663
+ * },
1664
+ * {
1665
+ * // Unique identifier for the custom action
1666
+ * id: 'my-viz-custom-action',
1667
+ *
1668
+ * // Display name shown to users in the UI
1669
+ * name: 'My Viz Custom Action',
1670
+ *
1671
+ * // Where the action appears in the UI
1672
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
1673
+ * // MENU: Shows in the "More" menu (three dots menu)
1674
+ * // CONTEXTMENU: Shows in the right-click context menu
1675
+ * position: CustomActionsPosition.PRIMARY,
1676
+ *
1677
+ * // What type of content this action applies to
1678
+ * // VIZ: Available on individual visualizations
1559
1679
  * target: CustomActionTarget.VIZ,
1560
- * position: CustomActionPosition.PRIMARY,
1561
- * }
1680
+ *
1681
+ * // Optional: Restrict where this action appears based on metadata
1682
+ * // metadataIds: {
1683
+ * // // Restrict to specific answers
1684
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
1685
+ * // // Restrict to specific liveboard. If liveboardId is
1686
+ * // // passed, custom actions will appear on all vizzes of liveboard
1687
+ * // liveboardIds: ['liveboard-id-1'],
1688
+ * // // Restrict to specific vizIds
1689
+ * // vizIds: ['viz-id-1']
1690
+ * // },
1691
+ * // dataModelIds: {
1692
+ * // // Restrict to specific data models
1693
+ * // modelIds: ['model-id-1', 'model-id-2'],
1694
+ * // // Restrict to specific columns within models
1695
+ * // modelColumnNames: ['model-id::column-name']
1696
+ * // },
1697
+ * // // Restrict to specific groups (for group-based access control)
1698
+ * // groupIds: ['group-id-1', 'group-id-2'],
1699
+ * // // Restrict to specific organizations (for multi-org deployments)
1700
+ * // orgIds: ['org-id-1', 'org-id-2'],
1562
1701
  * }
1563
- * ]
1702
+ * ],
1564
1703
  * })
1565
1704
  * ```
1566
1705
  */
@@ -1600,7 +1739,7 @@ export interface FrameParams {
1600
1739
  */
1601
1740
  loading?: "lazy" | "eager" | "auto";
1602
1741
  /**
1603
- * This parameters will be passed on the iframe
1742
+ * These parameters will be passed to the iframe
1604
1743
  * as is.
1605
1744
  */
1606
1745
  [key: string]: string | number | boolean | undefined;
@@ -1675,8 +1814,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1675
1814
  */
1676
1815
  disabledActionReason?: string;
1677
1816
  /**
1678
- * The list of actions to hide from the embedded.
1679
- * This actions will be hidden from the user.
1817
+ * The list of actions to hide from the embedded view.
1818
+ * These actions will be hidden from the user.
1680
1819
  * Use this to hide an action.
1681
1820
  *
1682
1821
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
@@ -1717,7 +1856,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1717
1856
  * The locale settings to apply to the embedded view.
1718
1857
  *
1719
1858
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1720
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1859
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1721
1860
  * @example
1722
1861
  * ```js
1723
1862
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1732,12 +1871,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1732
1871
  * This is an object (key/val) of override flags which will be applied
1733
1872
  * to the internal embedded object. This can be used to add any
1734
1873
  * URL flag.
1735
- * If the same flags are passed in init, they will be overriden by the values here.
1874
+ * If the same flags are passed in init, they will be overridden by the values here.
1736
1875
  * Warning: This option is for advanced use only and is used internally
1737
1876
  * to control embed behavior in non-regular ways. We do not publish the
1738
1877
  * list of supported keys and values associated with each.
1739
1878
  *
1740
1879
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1880
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1741
1881
  * @example
1742
1882
  * ```js
1743
1883
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1749,7 +1889,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1749
1889
  * },
1750
1890
  * });
1751
1891
  * ```
1752
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1753
1892
  */
1754
1893
  additionalFlags?: {
1755
1894
  [key: string]: string | number | boolean;
@@ -1792,6 +1931,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1792
1931
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
1793
1932
  *
1794
1933
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1934
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1795
1935
  * @example
1796
1936
  * ```js
1797
1937
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1801,7 +1941,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1801
1941
  * });
1802
1942
  * embed.showPreRender();
1803
1943
  * ```
1804
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1805
1944
  */
1806
1945
  preRenderId?: string;
1807
1946
  /**
@@ -1811,7 +1950,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1811
1950
  * its dimensions based on changes to the size of the embedding element.
1812
1951
  * @type {boolean}
1813
1952
  * @default false
1814
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
1953
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
1815
1954
  * @example
1816
1955
  * ```js
1817
1956
  * // Disable tracking PreRender size in the configuration
@@ -1826,9 +1965,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1826
1965
  doNotTrackPreRenderSize?: boolean;
1827
1966
  /**
1828
1967
  * Enable the V2 shell. This can provide performance benefits
1829
- * due to a lighterweight shell.
1968
+ * due to a lighter-weight shell.
1830
1969
  *
1831
1970
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1971
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1832
1972
  * @example
1833
1973
  * ```js
1834
1974
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1837,7 +1977,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1837
1977
  * enableV2Shell_experimental: true,
1838
1978
  * });
1839
1979
  * ```
1840
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1841
1980
  */
1842
1981
  enableV2Shell_experimental?: boolean;
1843
1982
  /**
@@ -1856,6 +1995,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1856
1995
  * and disable redirection of links in a new tab.
1857
1996
  *
1858
1997
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1998
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1859
1999
  * @example
1860
2000
  * ```js
1861
2001
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1864,7 +2004,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1864
2004
  * disableRedirectionLinksInNewTab: true,
1865
2005
  * });
1866
2006
  * ```
1867
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1868
2007
  */
1869
2008
  disableRedirectionLinksInNewTab?: boolean;
1870
2009
  /**
@@ -1875,6 +2014,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1875
2014
  * Per Org URL feature is enabled on your ThoughtSpot instance.
1876
2015
  *
1877
2016
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2017
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
1878
2018
  * @example
1879
2019
  * ```js
1880
2020
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1883,24 +2023,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1883
2023
  * overrideOrgId: 142536,
1884
2024
  * });
1885
2025
  * ```
1886
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
1887
2026
  */
1888
2027
  overrideOrgId?: number;
1889
2028
  /**
1890
- * Flag to override the *Open Link in New Tab* context menu option.
2029
+ * Flag to override the *Open Link in New Tab* context
2030
+ * menu option.
1891
2031
  *
1892
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2032
+ * For improved link override handling, use
2033
+ * {@link enableLinkOverridesV2} instead.
2034
+ *
2035
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2036
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2037
+ * `SpotterEmbed`, `SearchBarEmbed`
1893
2038
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1894
2039
  * @example
1895
2040
  * ```js
1896
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
1897
- * const embed = new <EmbedComponent>('#tsEmbed', {
2041
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1898
2042
  * ... // other embed view config
1899
- * linkOverride:false,
2043
+ * linkOverride: true,
1900
2044
  * })
1901
2045
  * ```
1902
2046
  */
1903
2047
  linkOverride?: boolean;
2048
+ /**
2049
+ * Enables the V2 link override mechanism with improved
2050
+ * handling. When enabled, navigation links within the
2051
+ * embedded ThoughtSpot app are intercepted and routed
2052
+ * through the SDK via the `EmbedEvent.DialogOpen`
2053
+ * event.
2054
+ *
2055
+ * The SDK automatically sends {@link linkOverride}
2056
+ * alongside this flag for backward compatibility with
2057
+ * older ThoughtSpot versions.
2058
+ *
2059
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2060
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2061
+ * `SpotterEmbed`, `SearchBarEmbed`
2062
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
2063
+ * @example
2064
+ * ```js
2065
+ * const embed = new LiveboardEmbed('#tsEmbed', {
2066
+ * ... // other embed view config
2067
+ * enableLinkOverridesV2: true,
2068
+ * });
2069
+ *
2070
+ * embed.on(EmbedEvent.DialogOpen, (payload) => {
2071
+ * console.log('Link clicked:', payload);
2072
+ * });
2073
+ * ```
2074
+ */
2075
+ enableLinkOverridesV2?: boolean;
1904
2076
  /**
1905
2077
  * The primary action to display on top of the viz for Liveboard and App Embed.
1906
2078
  * Use this to set the primary action.
@@ -1925,7 +2097,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1925
2097
  insertInToSlide?: boolean;
1926
2098
  /**
1927
2099
  * Show alert messages and toast messages in the embed.
1928
- * Supported embed in all embed types.
2100
+ * Supported in all embed types.
1929
2101
  *
1930
2102
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1931
2103
  * @example
@@ -1950,7 +2122,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1950
2122
  * ```ts
1951
2123
  * import {
1952
2124
  * CustomActionPayload,
1953
- * CustomActionPosition,
2125
+ * CustomActionsPosition,
1954
2126
  * CustomActionTarget,
1955
2127
  * } from '@thoughtspot/visual-embed-sdk';
1956
2128
  * // Use supported embed types such as AppEmbed or LiveboardEmbed
@@ -1958,13 +2130,41 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1958
2130
  * ... // other embed config options
1959
2131
  * customActions: [
1960
2132
  * {
1961
- * name: 'customAction',
1962
- * id: 'customAction',
1963
- * target: CustomActionTarget.VIZ,
1964
- * position: CustomActionPosition.PRIMARY,
1965
- * }
2133
+ * // Unique identifier for the custom action
2134
+ * id: 'my-custom-action',
2135
+ *
2136
+ * // Display name shown to users in the UI
2137
+ * name: 'My Custom Action',
2138
+ *
2139
+ * // Where the action appears in the UI
2140
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
2141
+ * // MENU: Shows in the "More" menu (three dots menu)
2142
+ * // CONTEXTMENU: Shows in the right-click context menu
2143
+ * position: CustomActionsPosition.PRIMARY,
2144
+ *
2145
+ * // What type of content this action applies to
2146
+ * // ANSWER: Available on answer pages
2147
+ * target: CustomActionTarget.ANSWER,
2148
+ *
2149
+ * // Optional: Restrict where this action appears based on data models
2150
+ * // dataModelIds: {
2151
+ * // // Restrict to specific data models
2152
+ * // modelIds: ['model-id-1', 'model-id-2'],
2153
+ * // // Restrict to specific columns within models
2154
+ * // modelColumnNames: ['model-id::column-name']
2155
+ * // },
2156
+ *
2157
+ * // Optional: Restrict where this action appears based on metadata
2158
+ * // metadataIds: {
2159
+ * // // Restrict to specific answers
2160
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
2161
+ * // },
2162
+ * // // Restrict to specific groups (for group-based access control)
2163
+ * // groupIds: ['group-id-1', 'group-id-2'],
2164
+ * // // Restrict to specific organizations (for multi-org deployments)
2165
+ * // orgIds: ['org-id-1', 'org-id-2'],
1966
2166
  * }
1967
- * ]
2167
+ * ],
1968
2168
  * })
1969
2169
  *
1970
2170
  * // to trigger a custom flow on custom action click listen to Custom action embed event
@@ -1972,6 +2172,120 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1972
2172
  * console.log('Custom Action event:', payload);
1973
2173
  * })
1974
2174
  * ```
2175
+ * @example
2176
+ * ```ts
2177
+ * import {
2178
+ * CustomActionsPosition,
2179
+ * CustomActionTarget,
2180
+ * } from '@thoughtspot/visual-embed-sdk';
2181
+ * const embed = new LiveboardEmbed('#tsEmbed', {
2182
+ * ... // other embed config options
2183
+ * customActions: [
2184
+ * {
2185
+ * // Unique identifier for the custom action
2186
+ * id: 'my-custom-action',
2187
+ *
2188
+ * // Display name shown to users in the UI
2189
+ * name: 'My Custom Action',
2190
+ *
2191
+ * // Where the action appears in the UI
2192
+ * // MENU: Shows in the "More" menu (three dots menu)
2193
+ * // CONTEXTMENU: Shows in the right-click context menu
2194
+ * position: CustomActionsPosition.MENU,
2195
+ *
2196
+ * // What type of content this action applies to
2197
+ * // SPOTTER: Available in Spotter (AI-powered search)
2198
+ * target: CustomActionTarget.SPOTTER,
2199
+ *
2200
+ * // Optional: Restrict where this action appears based on data models
2201
+ * // dataModelIds: {
2202
+ * // // Restrict to specific data models
2203
+ * // modelIds: ['model-id-1', 'model-id-2'],
2204
+ * // },
2205
+ * // // Restrict to specific groups (for group-based access control)
2206
+ * // groupIds: ['group-id-1'],
2207
+ * // // Restrict to specific organizations (for multi-org deployments)
2208
+ * // orgIds: ['org-id-1'],
2209
+ * }
2210
+ * ],
2211
+ * })
2212
+ * ```
2213
+ * @example
2214
+ * ```ts
2215
+ * import {
2216
+ * CustomActionsPosition,
2217
+ * CustomActionTarget,
2218
+ * } from '@thoughtspot/visual-embed-sdk';
2219
+ * const embed = new LiveboardEmbed('#tsEmbed', {
2220
+ * ... // other embed config options
2221
+ * customActions: [
2222
+ * {
2223
+ * // Unique identifier for the custom action
2224
+ * id: 'my-liveboard-custom-action',
2225
+ *
2226
+ * // Display name shown to users in the UI
2227
+ * name: 'My Liveboard Custom Action',
2228
+ *
2229
+ * // Where the action appears in the UI
2230
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
2231
+ * // MENU: Shows in the "More" menu (three dots menu)
2232
+ * position: CustomActionsPosition.PRIMARY,
2233
+ *
2234
+ * // What type of content this action applies to
2235
+ * // LIVEBOARD: Available on liveboard pages
2236
+ * target: CustomActionTarget.LIVEBOARD,
2237
+ *
2238
+ * // Optional: Restrict where this action appears based on metadata
2239
+ * // metadataIds: {
2240
+ * // // Restrict to specific liveboards
2241
+ * // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
2242
+ * // },
2243
+ * // // Restrict to specific groups (for group-based access control)
2244
+ * // groupIds: ['group-id-1', 'group-id-2'],
2245
+ * // // Restrict to specific organizations (for multi-org deployments)
2246
+ * // orgIds: ['org-id-1', 'org-id-2'],
2247
+ * },
2248
+ * {
2249
+ * // Unique identifier for the custom action
2250
+ * id: 'my-viz-custom-action',
2251
+ *
2252
+ * // Display name shown to users in the UI
2253
+ * name: 'My Viz Custom Action',
2254
+ *
2255
+ * // Where the action appears in the UI
2256
+ * // PRIMARY: Shows as a primary button (e.g., in the toolbar)
2257
+ * // MENU: Shows in the "More" menu (three dots menu)
2258
+ * // CONTEXTMENU: Shows in the right-click context menu
2259
+ * position: CustomActionsPosition.PRIMARY,
2260
+ *
2261
+ * // What type of content this action applies to
2262
+ * // VIZ: Available on individual visualizations
2263
+ * target: CustomActionTarget.VIZ,
2264
+ *
2265
+ * // Optional: Restrict where this action appears based on metadata
2266
+ * // metadataIds: {
2267
+ * // // Restrict to specific answers
2268
+ * // answerIds: ['answer-id-1', 'answer-id-2'],
2269
+ * // // Restrict to specific liveboard. If liveboardId is
2270
+ * // // passed, custom actions will appear on all vizzes of liveboard
2271
+ * // liveboardIds: ['liveboard-id-1'],
2272
+ * // // Restrict to specific vizIds
2273
+ * // vizIds: ['viz-id-1']
2274
+ * // },
2275
+ * // dataModelIds: {
2276
+ * // // Restrict to specific data models
2277
+ * // modelIds: ['model-id-1', 'model-id-2'],
2278
+ * // // Restrict to specific columns within models
2279
+ * // modelColumnNames: ['model-id::column-name']
2280
+ * // },
2281
+ * // // Restrict to specific groups (for group-based access control)
2282
+ * // groupIds: ['group-id-1', 'group-id-2'],
2283
+ * // // Restrict to specific organizations (for multi-org deployments)
2284
+ * // orgIds: ['org-id-1', 'org-id-2'],
2285
+ * }
2286
+ * ],
2287
+ * })
2288
+ * ```
1975
2289
  */
1976
2290
  customActions?: CustomAction[];
1977
2291
  /**
@@ -2067,7 +2381,7 @@ export interface HomePageConfig {
2067
2381
  * **Note**: This attribute is not supported in the classic (v1) homepage.
2068
2382
  *
2069
2383
  * Supported embed types: `AppEmbed`
2070
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2384
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2071
2385
  * @example
2072
2386
  * ```js
2073
2387
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
@@ -2088,6 +2402,7 @@ export interface HomePageConfig {
2088
2402
  * **Note**: This attribute is not supported in the classic (v1) homepage.
2089
2403
  *
2090
2404
  * Supported embed types: `AppEmbed`
2405
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2091
2406
  * @example
2092
2407
  * ```js
2093
2408
  * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
@@ -2098,7 +2413,6 @@ export interface HomePageConfig {
2098
2413
  * ... //other embed view configuration attributes
2099
2414
  * })
2100
2415
  * ```
2101
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2102
2416
  */
2103
2417
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
2104
2418
  }
@@ -2111,7 +2425,7 @@ export interface SearchLiveboardCommonViewConfig {
2111
2425
  * visualization, or Liveboard.
2112
2426
  *
2113
2427
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
2114
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2428
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2115
2429
  * @example
2116
2430
  * ```js
2117
2431
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2129,11 +2443,11 @@ export interface SearchLiveboardCommonViewConfig {
2129
2443
  */
2130
2444
  runtimeFilters?: RuntimeFilter[];
2131
2445
  /**
2132
- * The list of parameter override to apply to a search Answer,
2446
+ * The list of parameter overrides to apply to a search Answer,
2133
2447
  * visualization, or Liveboard.
2134
2448
  *
2135
2449
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
2136
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2450
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2137
2451
  * @example
2138
2452
  * ```js
2139
2453
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2153,6 +2467,7 @@ export interface SearchLiveboardCommonViewConfig {
2153
2467
  * flag to set ContextMenu Trigger to either left or right click.
2154
2468
  *
2155
2469
  * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
2470
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2156
2471
  * @example
2157
2472
  * ```js
2158
2473
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
@@ -2161,7 +2476,6 @@ export interface SearchLiveboardCommonViewConfig {
2161
2476
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
2162
2477
  * })
2163
2478
  * ```
2164
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2165
2479
  */
2166
2480
  contextMenuTrigger?: ContextMenuTriggerOptions;
2167
2481
  /**
@@ -2184,7 +2498,7 @@ export interface SearchLiveboardCommonViewConfig {
2184
2498
  * when set to false, runtime parameters will be included in the URL
2185
2499
  * (default behavior before SDK 1.45.0).
2186
2500
  *
2187
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
2501
+ * Irrespective of this flag, runtime parameters (if passed) will be applied to the
2188
2502
  * embedded view.
2189
2503
  * @default true
2190
2504
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
@@ -2203,14 +2517,15 @@ export interface SearchLiveboardCommonViewConfig {
2203
2517
  * ... // other embed view config
2204
2518
  * collapseSearchBar: true,
2205
2519
  * });
2520
+ * ```
2206
2521
  */
2207
2522
  collapseSearchBar?: boolean;
2208
2523
  /**
2209
2524
  * Flag to control Data panel experience
2210
2525
  *
2211
2526
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2527
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
2212
2528
  * @default true
2213
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
2214
2529
  * @example
2215
2530
  * ```js
2216
2531
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -2243,6 +2558,7 @@ export interface SearchLiveboardCommonViewConfig {
2243
2558
  * the current time period in filter results.
2244
2559
  *
2245
2560
  * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2561
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
2246
2562
  * @example
2247
2563
  * ```js
2248
2564
  * const embed = new <EmbedComponent>('#tsEmbed', {
@@ -2250,7 +2566,6 @@ export interface SearchLiveboardCommonViewConfig {
2250
2566
  * isThisPeriodInDateFiltersEnabled: true,
2251
2567
  * })
2252
2568
  * ```
2253
- * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
2254
2569
  */
2255
2570
  isThisPeriodInDateFiltersEnabled?: boolean;
2256
2571
  }
@@ -2310,6 +2625,7 @@ export interface LiveboardAppEmbedViewConfig {
2310
2625
  * Boolean to control if Liveboard header is sticky or not.
2311
2626
  *
2312
2627
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2628
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2313
2629
  * @example
2314
2630
  * ```js
2315
2631
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2318,7 +2634,6 @@ export interface LiveboardAppEmbedViewConfig {
2318
2634
  * isLiveboardHeaderSticky: true,
2319
2635
  * });
2320
2636
  * ```
2321
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2322
2637
  */
2323
2638
  isLiveboardHeaderSticky?: boolean;
2324
2639
  /**
@@ -2326,8 +2641,8 @@ export interface LiveboardAppEmbedViewConfig {
2326
2641
  *
2327
2642
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2328
2643
  * @type {boolean}
2644
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
2329
2645
  * @default false
2330
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
2331
2646
  * @example
2332
2647
  * ```js
2333
2648
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2343,8 +2658,8 @@ export interface LiveboardAppEmbedViewConfig {
2343
2658
  *
2344
2659
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2345
2660
  * @type {boolean}
2661
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
2346
2662
  * @default false
2347
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
2348
2663
  * @example
2349
2664
  * ```js
2350
2665
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2360,7 +2675,7 @@ export interface LiveboardAppEmbedViewConfig {
2360
2675
  * header.
2361
2676
  *
2362
2677
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2363
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
2678
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2364
2679
  * @default true
2365
2680
  * @example
2366
2681
  * ```js
@@ -2378,7 +2693,7 @@ export interface LiveboardAppEmbedViewConfig {
2378
2693
  * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
2379
2694
  *
2380
2695
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2381
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
2696
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2382
2697
  * @default false
2383
2698
  * @example
2384
2699
  * ```js
@@ -2396,7 +2711,7 @@ export interface LiveboardAppEmbedViewConfig {
2396
2711
  * compact header
2397
2712
  *
2398
2713
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2399
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
2714
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2400
2715
  * @default true
2401
2716
  * @example
2402
2717
  * ```js
@@ -2429,7 +2744,7 @@ export interface LiveboardAppEmbedViewConfig {
2429
2744
  * the cover and filters pages in the Liveboard PDF.
2430
2745
  *
2431
2746
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2432
- * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
2747
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
2433
2748
  * @example
2434
2749
  * ```js
2435
2750
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2625,7 +2940,7 @@ declare enum HomepageModule {
2625
2940
  */
2626
2941
  Search = "SEARCH",
2627
2942
  /**
2628
- * kPI watchlist module
2943
+ * KPI watchlist module
2629
2944
  */
2630
2945
  Watchlist = "WATCHLIST",
2631
2946
  /**
@@ -2651,7 +2966,8 @@ declare enum ListPageColumns {
2651
2966
  */
2652
2967
  Favorites = "FAVOURITE",
2653
2968
  /**
2654
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
2969
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
2970
+ * @deprecated This option is deprecated.
2655
2971
  */
2656
2972
  Favourite = "FAVOURITE",
2657
2973
  /**
@@ -2752,13 +3068,13 @@ export declare enum EmbedEvent {
2752
3068
  /**
2753
3069
  * Rendering has initialized.
2754
3070
  * @example
2755
- *```js
3071
+ * ```js
2756
3072
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
2757
3073
  * //show a loader
2758
3074
  * function showLoader() {
2759
3075
  * document.getElementById("loader");
2760
3076
  * }
2761
- *```
3077
+ * ```
2762
3078
  * @returns timestamp - The timestamp when the event was generated.
2763
3079
  */
2764
3080
  Init = "init",
@@ -2766,11 +3082,11 @@ export declare enum EmbedEvent {
2766
3082
  * Authentication has either succeeded or failed.
2767
3083
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2768
3084
  * @example
2769
- *```js
3085
+ * ```js
2770
3086
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
2771
3087
  * console.log('AuthInit', payload);
2772
3088
  * })
2773
- *```
3089
+ * ```
2774
3090
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
2775
3091
  */
2776
3092
  AuthInit = "authInit",
@@ -2779,13 +3095,13 @@ export declare enum EmbedEvent {
2779
3095
  * @returns timestamp - The timestamp when the event was generated.
2780
3096
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2781
3097
  * @example
2782
- *```js
3098
+ * ```js
2783
3099
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
2784
3100
  * //hide loader
2785
3101
  * function hideLoader() {
2786
3102
  * document.getElementById("loader");
2787
3103
  * }
2788
- *```
3104
+ * ```
2789
3105
  */
2790
3106
  Load = "load",
2791
3107
  /**
@@ -2794,11 +3110,11 @@ export declare enum EmbedEvent {
2794
3110
  * @return data - Answer of Liveboard data
2795
3111
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2796
3112
  * @example
2797
- *```js
3113
+ * ```js
2798
3114
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
2799
3115
  * console.log('data', payload);
2800
3116
  * })
2801
- *```
3117
+ * ```
2802
3118
  * @important
2803
3119
  */
2804
3120
  Data = "data",
@@ -2806,9 +3122,9 @@ export declare enum EmbedEvent {
2806
3122
  * Search query has been updated by the user.
2807
3123
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2808
3124
  * @example
2809
- *```js
3125
+ * ```js
2810
3126
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
2811
- *```
3127
+ * ```
2812
3128
  */
2813
3129
  QueryChanged = "queryChanged",
2814
3130
  /**
@@ -2818,7 +3134,7 @@ export declare enum EmbedEvent {
2818
3134
  * @returns drillDownColumns - The columns on which drill down was performed
2819
3135
  * @returns nonFilteredColumns - The columns that were not filtered
2820
3136
  * @example
2821
- *```js
3137
+ * ```js
2822
3138
  * searchEmbed.on(EmbedEvent.DrillDown, {
2823
3139
  * points: {
2824
3140
  * clickedPoint,
@@ -2826,12 +3142,12 @@ export declare enum EmbedEvent {
2826
3142
  * },
2827
3143
  * autoDrillDown: true,
2828
3144
  * })
2829
- *```
3145
+ * ```
2830
3146
  * In this example, `VizPointDoubleClick` event is used for
2831
3147
  * triggering the `DrillDown` event when an area or specific
2832
3148
  * data point on a table or chart is double-clicked.
2833
3149
  * @example
2834
- *```js
3150
+ * ```js
2835
3151
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
2836
3152
  * console.log(payload);
2837
3153
  * const clickedPoint = payload.data.clickedPoint;
@@ -2845,7 +3161,7 @@ export declare enum EmbedEvent {
2845
3161
  * autoDrillDown: true,
2846
3162
  * })
2847
3163
  * })
2848
- *```
3164
+ * ```
2849
3165
  */
2850
3166
  Drilldown = "drillDown",
2851
3167
  /**
@@ -2970,13 +3286,13 @@ export declare enum EmbedEvent {
2970
3286
  * The ThoughtSpot authentication session has expired.
2971
3287
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2972
3288
  * @example
2973
- *```js
3289
+ * ```js
2974
3290
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
2975
3291
  * //show auth expired banner
2976
3292
  * function showAuthExpired() {
2977
3293
  * document.getElementById("authExpiredBanner");
2978
3294
  * }
2979
- *```
3295
+ * ```
2980
3296
  */
2981
3297
  AuthExpire = "ThoughtspotAuthExpired",
2982
3298
  /**
@@ -3011,22 +3327,22 @@ export declare enum EmbedEvent {
3011
3327
  * Applicable to `SearchBarEmbed` only.
3012
3328
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
3013
3329
  * @example
3014
- *```js
3330
+ * ```js
3015
3331
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
3016
3332
  * .then(data => {
3017
3333
  * console.log('Answer Data:', data);
3018
3334
  * })
3019
- *```
3335
+ * ```
3020
3336
  */
3021
3337
  GetDataClick = "getDataClick",
3022
3338
  /**
3023
3339
  * Detects the route change.
3024
3340
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
3025
3341
  * @example
3026
- *```js
3342
+ * ```js
3027
3343
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
3028
3344
  * console.log('data', payload))
3029
- *```
3345
+ * ```
3030
3346
  */
3031
3347
  RouteChange = "ROUTE_CHANGE",
3032
3348
  /**
@@ -3036,12 +3352,12 @@ export declare enum EmbedEvent {
3036
3352
  V1Data = "exportVizDataToParent",
3037
3353
  /**
3038
3354
  * Emitted when the embed does not have cookie access. This happens
3039
- * when Safari and other Web browsers block third-party cookies
3040
- * are blocked by default. `NoCookieAccess` can trigger.
3355
+ * when third-party cookies are blocked by Safari or other
3356
+ * web browsers. `NoCookieAccess` can trigger.
3041
3357
  * @example
3042
- *```js
3358
+ * ```js
3043
3359
  * appEmbed.on(EmbedEvent.NoCookieAccess)
3044
- *```
3360
+ * ```
3045
3361
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
3046
3362
  */
3047
3363
  NoCookieAccess = "noCookieAccess",
@@ -3055,22 +3371,22 @@ export declare enum EmbedEvent {
3055
3371
  * Emitted when any modal is opened in the app
3056
3372
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
3057
3373
  * @example
3058
- *```js
3374
+ * ```js
3059
3375
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
3060
3376
  * console.log('dialog open', payload);
3061
3377
  * })
3062
- *```
3378
+ * ```
3063
3379
  */
3064
3380
  DialogOpen = "dialog-open",
3065
3381
  /**
3066
3382
  * Emitted when any modal is closed in the app
3067
3383
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
3068
3384
  * @example
3069
- *```js
3385
+ * ```js
3070
3386
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
3071
3387
  * console.log('dialog close', payload);
3072
3388
  * })
3073
- *```
3389
+ * ```
3074
3390
  */
3075
3391
  DialogClose = "dialog-close",
3076
3392
  /**
@@ -3079,39 +3395,39 @@ export declare enum EmbedEvent {
3079
3395
  * other events on the rendered Liveboard.
3080
3396
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3081
3397
  * @example
3082
- *```js
3398
+ * ```js
3083
3399
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
3084
3400
  console.log('Liveboard is rendered', payload);
3085
3401
  })
3086
- *```
3402
+ * ```
3087
3403
  * The following example shows how to trigger
3088
3404
  * `SetVisibleVizs` event using LiveboardRendered embed event:
3089
3405
  * @example
3090
- *```js
3406
+ * ```js
3091
3407
  * const embedRef = useEmbedRef();
3092
3408
  * const onLiveboardRendered = () => {
3093
3409
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
3094
3410
  * };
3095
- *```
3411
+ * ```
3096
3412
  */
3097
3413
  LiveboardRendered = "PinboardRendered",
3098
3414
  /**
3099
3415
  * Emits all events.
3100
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
3416
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
3101
3417
  * @example
3102
- *```js
3418
+ * ```js
3103
3419
  * appEmbed.on(EmbedEvent.ALL, payload => {
3104
3420
  * console.log('Embed Events', payload)
3105
3421
  * })
3106
- *```
3422
+ * ```
3107
3423
  */
3108
3424
  ALL = "*",
3109
3425
  /**
3110
3426
  * Emitted when an Answer is saved in the app.
3111
3427
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
3112
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3428
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3113
3429
  * @example
3114
- *```js
3430
+ * ```js
3115
3431
  * //Emit when action starts
3116
3432
  * searchEmbed.on(EmbedEvent.Save, payload => {
3117
3433
  * console.log('Save', payload)
@@ -3122,7 +3438,7 @@ export declare enum EmbedEvent {
3122
3438
  * searchEmbed.on(EmbedEvent.Save, payload => {
3123
3439
  * console.log('Save', payload)
3124
3440
  * })
3125
- *```
3441
+ * ```
3126
3442
  */
3127
3443
  Save = "save",
3128
3444
  /**
@@ -3134,11 +3450,11 @@ export declare enum EmbedEvent {
3134
3450
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
3135
3451
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3136
3452
  * @example
3137
- *```js
3453
+ * ```js
3138
3454
  * liveboardEmbed.on(EmbedEvent.Download, {
3139
3455
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
3140
3456
  * })
3141
- *```
3457
+ * ```
3142
3458
  */
3143
3459
  Download = "download",
3144
3460
  /**
@@ -3146,14 +3462,14 @@ export declare enum EmbedEvent {
3146
3462
  * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
3147
3463
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
3148
3464
  * @example
3149
- *```js
3465
+ * ```js
3150
3466
  * //emit when action starts
3151
3467
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
3152
3468
  * console.log('download PNG', payload)}, {start: true })
3153
3469
  * //emit when action ends
3154
3470
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
3155
3471
  * console.log('download PNG', payload)})
3156
- *```
3472
+ * ```
3157
3473
  */
3158
3474
  DownloadAsPng = "downloadAsPng",
3159
3475
  /**
@@ -3161,14 +3477,14 @@ export declare enum EmbedEvent {
3161
3477
  * 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.
3162
3478
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3163
3479
  * @example
3164
- *```js
3480
+ * ```js
3165
3481
  * //emit when action starts
3166
3482
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
3167
3483
  * console.log('download PDF', payload)}, {start: true })
3168
3484
  * //emit when action ends
3169
3485
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
3170
3486
  * console.log('download PDF', payload)})
3171
- *```
3487
+ * ```
3172
3488
  */
3173
3489
  DownloadAsPdf = "downloadAsPdf",
3174
3490
  /**
@@ -3176,14 +3492,14 @@ export declare enum EmbedEvent {
3176
3492
  * 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.
3177
3493
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3178
3494
  * @example
3179
- *```js
3495
+ * ```js
3180
3496
  * //emit when action starts
3181
3497
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
3182
3498
  * console.log('download CSV', payload)}, {start: true })
3183
3499
  * //emit when action ends
3184
3500
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
3185
3501
  * console.log('download CSV', payload)})
3186
- *```
3502
+ * ```
3187
3503
  */
3188
3504
  DownloadAsCsv = "downloadAsCsv",
3189
3505
  /**
@@ -3191,14 +3507,14 @@ export declare enum EmbedEvent {
3191
3507
  * 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.
3192
3508
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3193
3509
  * @example
3194
- *```js
3510
+ * ```js
3195
3511
  * //emit when action starts
3196
3512
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
3197
3513
  * console.log('download Xlsx', payload)}, { start: true })
3198
3514
  * //emit when action ends
3199
3515
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
3200
3516
  * console.log('download Xlsx', payload)})
3201
- *```
3517
+ * ```
3202
3518
  */
3203
3519
  DownloadAsXlsx = "downloadAsXlsx",
3204
3520
  /**
@@ -3206,25 +3522,25 @@ export declare enum EmbedEvent {
3206
3522
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
3207
3523
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3208
3524
  * @example
3209
- *```js
3525
+ * ```js
3210
3526
  * //emit when action starts
3211
3527
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3212
3528
  * console.log('delete answer', payload)}, {start: true })
3213
3529
  * //trigger when action is completed
3214
3530
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3215
3531
  * console.log('delete answer', payload)})
3216
- *```
3532
+ * ```
3217
3533
  */
3218
3534
  AnswerDelete = "answerDelete",
3219
3535
  /**
3220
3536
  * Emitted when the AI Highlights action is triggered on a Liveboard
3221
3537
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
3222
3538
  * @example
3223
- *```js
3539
+ * ```js
3224
3540
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
3225
3541
  * console.log('AI Highlights', payload);
3226
3542
  * })
3227
- *```
3543
+ * ```
3228
3544
  */
3229
3545
  AIHighlights = "AIHighlights",
3230
3546
  /**
@@ -3233,7 +3549,7 @@ export declare enum EmbedEvent {
3233
3549
  * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
3234
3550
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3235
3551
  * @example
3236
- *```js
3552
+ * ```js
3237
3553
  * //emit when action starts
3238
3554
  * searchEmbed.on(EmbedEvent.Pin, payload => {
3239
3555
  * console.log('pin', payload)
@@ -3244,14 +3560,14 @@ export declare enum EmbedEvent {
3244
3560
  * searchEmbed.on(EmbedEvent.Pin, payload => {
3245
3561
  * console.log('pin', payload)
3246
3562
  * })
3247
- *```
3563
+ * ```
3248
3564
  */
3249
3565
  Pin = "pin",
3250
3566
  /**
3251
3567
  * Emitted when SpotIQ analysis is triggered
3252
3568
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3253
3569
  * @example
3254
- *```js
3570
+ * ```js
3255
3571
  * //emit when action starts
3256
3572
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
3257
3573
  * console.log('SpotIQAnalyze', payload)
@@ -3262,14 +3578,14 @@ export declare enum EmbedEvent {
3262
3578
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
3263
3579
  * console.log('SpotIQ analyze', payload)
3264
3580
  * })
3265
- *```
3581
+ * ```
3266
3582
  */
3267
3583
  SpotIQAnalyze = "spotIQAnalyze",
3268
3584
  /**
3269
3585
  * Emitted when a user shares an object with another user or group
3270
3586
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3271
3587
  * @example
3272
- *```js
3588
+ * ```js
3273
3589
  * //emit when action starts
3274
3590
  * searchEmbed.on(EmbedEvent.Share, payload => {
3275
3591
  * console.log('Share', payload)
@@ -3280,7 +3596,7 @@ export declare enum EmbedEvent {
3280
3596
  * searchEmbed.on(EmbedEvent.Share, payload => {
3281
3597
  * console.log('Share', payload)
3282
3598
  * })
3283
- *```
3599
+ * ```
3284
3600
  */
3285
3601
  Share = "share",
3286
3602
  /**
@@ -3288,11 +3604,11 @@ export declare enum EmbedEvent {
3288
3604
  * data on a chart or table.
3289
3605
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3290
3606
  * @example
3291
- *```js
3607
+ * ```js
3292
3608
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
3293
3609
  * console.log('Drill include', payload);
3294
3610
  * })
3295
- *```
3611
+ * ```
3296
3612
  */
3297
3613
  DrillInclude = "context-menu-item-include",
3298
3614
  /**
@@ -3300,22 +3616,22 @@ export declare enum EmbedEvent {
3300
3616
  * data on a chart or table
3301
3617
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3302
3618
  * @example
3303
- *```js
3619
+ * ```js
3304
3620
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
3305
3621
  * console.log('Drill exclude', payload);
3306
3622
  * })
3307
- *```
3623
+ * ```
3308
3624
  */
3309
3625
  DrillExclude = "context-menu-item-exclude",
3310
3626
  /**
3311
3627
  * Emitted when a column value is copied in the embedded app.
3312
3628
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3313
3629
  * @example
3314
- *```js
3315
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
3630
+ * ```js
3631
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
3316
3632
  * console.log('copy to clipboard', payload);
3317
3633
  * })
3318
- *```
3634
+ * ```
3319
3635
  */
3320
3636
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
3321
3637
  /**
@@ -3323,10 +3639,10 @@ export declare enum EmbedEvent {
3323
3639
  * embedded Liveboard.
3324
3640
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3325
3641
  * @example
3326
- *```js
3642
+ * ```js
3327
3643
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
3328
3644
  * })
3329
- *```
3645
+ * ```
3330
3646
  */
3331
3647
  UpdateTML = "updateTSL",
3332
3648
  /**
@@ -3334,11 +3650,11 @@ export declare enum EmbedEvent {
3334
3650
  * on an embedded Liveboard.
3335
3651
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3336
3652
  * @example
3337
- *```js
3653
+ * ```js
3338
3654
  * appEmbed.on(EmbedEvent.EditTML, payload => {
3339
3655
  * console.log('Edit TML', payload);
3340
3656
  * })
3341
- *```
3657
+ * ```
3342
3658
  */
3343
3659
  EditTML = "editTSL",
3344
3660
  /**
@@ -3347,25 +3663,25 @@ export declare enum EmbedEvent {
3347
3663
  * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
3348
3664
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3349
3665
  * @example
3350
- *```js
3666
+ * ```js
3351
3667
  * //emit when action starts
3352
3668
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
3353
3669
  * console.log('Export TML', payload)}, { start: true })
3354
3670
  * //emit when action ends
3355
3671
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
3356
3672
  * console.log('Export TML', payload)})
3357
- *```
3673
+ * ```
3358
3674
  */
3359
3675
  ExportTML = "exportTSL",
3360
3676
  /**
3361
3677
  * Emitted when an Answer is saved as a View.
3362
3678
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3363
3679
  * @example
3364
- *```js
3680
+ * ```js
3365
3681
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
3366
3682
  * console.log('View', payload);
3367
3683
  * })
3368
- *```
3684
+ * ```
3369
3685
  */
3370
3686
  SaveAsView = "saveAsView",
3371
3687
  /**
@@ -3373,36 +3689,36 @@ export declare enum EmbedEvent {
3373
3689
  * 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.
3374
3690
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3375
3691
  * @example
3376
- *```js
3692
+ * ```js
3377
3693
  * //emit when action starts
3378
3694
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
3379
3695
  * console.log('Copy and edit', payload)}, {start: true })
3380
3696
  * //emit when action ends
3381
3697
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
3382
3698
  * console.log('Copy and edit', payload)})
3383
- *```
3699
+ * ```
3384
3700
  */
3385
3701
  CopyAEdit = "copyAEdit",
3386
3702
  /**
3387
3703
  * Emitted when a user clicks *Show underlying data* on an Answer.
3388
3704
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3389
3705
  * @example
3390
- *```js
3706
+ * ```js
3391
3707
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
3392
3708
  * console.log('show data', payload);
3393
3709
  * })
3394
- *```
3710
+ * ```
3395
3711
  */
3396
3712
  ShowUnderlyingData = "showUnderlyingData",
3397
3713
  /**
3398
3714
  * Emitted when an Answer is switched to a chart or table view.
3399
3715
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3400
3716
  * @example
3401
- *```js
3717
+ * ```js
3402
3718
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
3403
3719
  * console.log('switch view', payload);
3404
3720
  * })
3405
- *```
3721
+ * ```
3406
3722
  */
3407
3723
  AnswerChartSwitcher = "answerChartSwitcher",
3408
3724
  /**
@@ -3419,118 +3735,118 @@ export declare enum EmbedEvent {
3419
3735
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
3420
3736
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3421
3737
  * @example
3422
- *```js
3738
+ * ```js
3423
3739
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
3424
3740
  * console.log('Liveboard details', payload);
3425
3741
  * })
3426
- *```
3742
+ * ```
3427
3743
  */
3428
3744
  LiveboardInfo = "pinboardInfo",
3429
3745
  /**
3430
3746
  * Emitted when a user clicks on the Favorite icon on a Liveboard
3431
3747
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3432
3748
  * @example
3433
- *```js
3749
+ * ```js
3434
3750
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
3435
3751
  * console.log('favorites', payload);
3436
3752
  * })
3437
- *```
3753
+ * ```
3438
3754
  */
3439
3755
  AddToFavorites = "addToFavorites",
3440
3756
  /**
3441
3757
  * Emitted when a user clicks **Schedule** on a Liveboard
3442
3758
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3443
3759
  * @example
3444
- *```js
3760
+ * ```js
3445
3761
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
3446
- * console.log(`Liveboard schedule', payload);
3762
+ * console.log('Liveboard schedule', payload);
3447
3763
  * })
3448
- *```
3764
+ * ```
3449
3765
  */
3450
3766
  Schedule = "subscription",
3451
3767
  /**
3452
3768
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
3453
3769
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3454
3770
  * @example
3455
- *```js
3771
+ * ```js
3456
3772
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
3457
- * console.log(`Liveboard edit', payload);
3773
+ * console.log('Liveboard edit', payload);
3458
3774
  * })
3459
- *```
3775
+ * ```
3460
3776
  */
3461
3777
  Edit = "edit",
3462
3778
  /**
3463
3779
  * Emitted when a user clicks *Make a copy* on a Liveboard
3464
3780
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3465
3781
  * @example
3466
- *```js
3782
+ * ```js
3467
3783
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
3468
- * console.log(`Copy', payload);
3784
+ * console.log('Copy', payload);
3469
3785
  * })
3470
- *```
3786
+ * ```
3471
3787
  */
3472
3788
  MakeACopy = "makeACopy",
3473
3789
  /**
3474
3790
  * Emitted when a user clicks **Present** on a Liveboard or visualization
3475
3791
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3476
3792
  * @example
3477
- *```js
3793
+ * ```js
3478
3794
  * liveboardEmbed.on(EmbedEvent.Present)
3479
- *```
3795
+ * ```
3480
3796
  * @example
3481
- *```js
3797
+ * ```js
3482
3798
  * liveboardEmbed.on(EmbedEvent.Present, {
3483
3799
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3484
3800
  * })
3485
- *```
3801
+ * ```
3486
3802
  */
3487
3803
  Present = "present",
3488
3804
  /**
3489
3805
  * Emitted when a user clicks **Delete** on a visualization
3490
3806
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3491
3807
  * @example
3492
- *```js
3808
+ * ```js
3493
3809
  * liveboardEmbed.on(EmbedEvent.Delete,
3494
3810
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3495
- *```
3811
+ * ```
3496
3812
  */
3497
3813
  Delete = "delete",
3498
3814
  /**
3499
3815
  * Emitted when a user clicks Manage schedules on a Liveboard
3500
3816
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3501
3817
  * @example
3502
- *```js
3818
+ * ```js
3503
3819
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
3504
- *```
3820
+ * ```
3505
3821
  */
3506
3822
  SchedulesList = "schedule-list",
3507
3823
  /**
3508
3824
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
3509
3825
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3510
3826
  * @example
3511
- *```js
3827
+ * ```js
3512
3828
  * liveboardEmbed.on(EmbedEvent.Cancel)
3513
- *```
3829
+ * ```
3514
3830
  */
3515
3831
  Cancel = "cancel",
3516
3832
  /**
3517
3833
  * Emitted when a user clicks **Explore** on a visualization
3518
3834
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3519
3835
  * @example
3520
- *```js
3836
+ * ```js
3521
3837
  * liveboardEmbed.on(EmbedEvent.Explore, {
3522
3838
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3523
- *```
3839
+ * ```
3524
3840
  */
3525
3841
  Explore = "explore",
3526
3842
  /**
3527
3843
  * Emitted when a user clicks **Copy link** action on a visualization.
3528
3844
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3529
3845
  * @example
3530
- *```js
3846
+ * ```js
3531
3847
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
3532
3848
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3533
- *```
3849
+ * ```
3534
3850
  */
3535
3851
  CopyLink = "embedDocument",
3536
3852
  /**
@@ -3538,21 +3854,21 @@ export declare enum EmbedEvent {
3538
3854
  * visualization or Liveboard.
3539
3855
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3540
3856
  * @example
3541
- *```js
3857
+ * ```js
3542
3858
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
3543
3859
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3544
- *```
3860
+ * ```
3545
3861
  */
3546
3862
  CrossFilterChanged = "cross-filter-changed",
3547
3863
  /**
3548
3864
  * Emitted when a user right clicks on a visualization (chart or table)
3549
3865
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3550
3866
  * @example
3551
- *```js
3867
+ * ```js
3552
3868
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
3553
3869
  * console.log('VizPointClick', payload)
3554
3870
  * })
3555
- *```
3871
+ * ```
3556
3872
  */
3557
3873
  VizPointRightClick = "vizPointRightClick",
3558
3874
  /**
@@ -3566,35 +3882,35 @@ export declare enum EmbedEvent {
3566
3882
  * filter details.
3567
3883
  * @example
3568
3884
  *
3569
- *```js
3885
+ * ```js
3570
3886
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3571
3887
  * console.log('payload', payload);
3572
3888
  * })
3573
- *
3889
+ * ```
3574
3890
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3575
3891
  */
3576
3892
  FilterChanged = "filterChanged",
3577
3893
  /**
3578
3894
  * Emitted when a user clicks the **Go** button to initiate
3579
3895
  * a Natural Language Search query
3580
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3896
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3581
3897
  */
3582
3898
  SageEmbedQuery = "sageEmbedQuery",
3583
3899
  /**
3584
3900
  * Emitted when a user selects a data source on the embedded
3585
3901
  * Natural Language Search interface.
3586
3902
  *
3587
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3903
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3588
3904
  */
3589
3905
  SageWorksheetUpdated = "sageWorksheetUpdated",
3590
3906
  /**
3591
3907
  * Emitted when a user updates a connection on the **Data** page
3592
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3908
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3593
3909
  */
3594
3910
  UpdateConnection = "updateConnection",
3595
3911
  /**
3596
3912
  * Emitted when a user updates a connection on the **Data** page
3597
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3913
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3598
3914
  */
3599
3915
  CreateConnection = "createConnection",
3600
3916
  /**
@@ -3604,7 +3920,7 @@ export declare enum EmbedEvent {
3604
3920
  * @returns viewId: string
3605
3921
  * @returns liveboardId: string
3606
3922
  * @returns isPublic: boolean
3607
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3923
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3608
3924
  */
3609
3925
  UpdatePersonalisedView = "updatePersonalisedView",
3610
3926
  /**
@@ -3613,7 +3929,7 @@ export declare enum EmbedEvent {
3613
3929
  * @returns viewId: string
3614
3930
  * @returns liveboardId: string
3615
3931
  * @returns isPublic: boolean
3616
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3932
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3617
3933
  */
3618
3934
  SavePersonalisedView = "savePersonalisedView",
3619
3935
  /**
@@ -3622,19 +3938,19 @@ export declare enum EmbedEvent {
3622
3938
  * @returns viewId: string
3623
3939
  * @returns liveboardId: string
3624
3940
  * @returns isPublic: boolean
3625
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3941
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3626
3942
  */
3627
3943
  ResetLiveboard = "resetLiveboard",
3628
3944
  /**
3629
3945
  * Emitted when a PersonalisedView is deleted.
3630
3946
  * @returns views: string[]
3631
3947
  * @returns liveboardId: string
3632
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3948
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3633
3949
  */
3634
3950
  DeletePersonalisedView = "deletePersonalisedView",
3635
3951
  /**
3636
3952
  * Emitted when a user creates a Worksheet.
3637
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3953
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3638
3954
  */
3639
3955
  CreateWorksheet = "createWorksheet",
3640
3956
  /**
@@ -3643,12 +3959,12 @@ export declare enum EmbedEvent {
3643
3959
  * @returns viewId: string
3644
3960
  * @returns liveboardId: string
3645
3961
  * @returns isPublic: boolean
3646
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3962
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3647
3963
  */
3648
3964
  AskSageInit = "AskSageInit",
3649
3965
  /**
3650
3966
  * Emitted when a Liveboard or visualization is renamed.
3651
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3967
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3652
3968
  */
3653
3969
  Rename = "rename",
3654
3970
  /**
@@ -3666,14 +3982,12 @@ export declare enum EmbedEvent {
3666
3982
  * - `payload`: The payload received from the embed related to the Data API call.
3667
3983
  * - `responder`: Contains elements that let developers define whether ThoughtSpot
3668
3984
  * will run or block the search operation, and if blocked, which error message to provide.
3669
- *
3670
- * `execute` - When `execute` returns `true`, the search is run.
3985
+ * - `execute` - When `execute` returns `true`, the search is run.
3671
3986
  * When `execute` returns `false`, the search is not executed.
3672
- *
3673
- * `error` - Developers can customize the user-facing error message when `execute`
3987
+ * - `error` - Developers can customize the user-facing error message when `execute`
3674
3988
  * is `false` by using the `error` parameters in `responder`.
3675
- * `errorText` - The error message text shown to the user.
3676
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3989
+ * - `errorText` - The error message text shown to the user.
3990
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3677
3991
  * @example
3678
3992
  *
3679
3993
  * This example blocks search operation and returns a custom error message:
@@ -3688,7 +4002,7 @@ export declare enum EmbedEvent {
3688
4002
  * },
3689
4003
  * },
3690
4004
  * });
3691
- * });
4005
+ * })
3692
4006
  * ```
3693
4007
  * @example
3694
4008
  *
@@ -3714,7 +4028,7 @@ export declare enum EmbedEvent {
3714
4028
  * },
3715
4029
  * },
3716
4030
  * });
3717
- * });
4031
+ * })
3718
4032
  * ```
3719
4033
  */
3720
4034
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
@@ -3725,8 +4039,8 @@ export declare enum EmbedEvent {
3725
4039
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
3726
4040
  * console.log('payload', payload);
3727
4041
  * })
3728
- *```
3729
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
4042
+ * ```
4043
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3730
4044
  */
3731
4045
  ParameterChanged = "parameterChanged",
3732
4046
  /**
@@ -3781,24 +4095,24 @@ export declare enum EmbedEvent {
3781
4095
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
3782
4096
  * console.log('payload', payload);
3783
4097
  * })
3784
- *```
3785
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
4098
+ * ```
4099
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
3786
4100
  */
3787
4101
  CreateLiveboard = "createLiveboard",
3788
4102
  /**
3789
4103
  * Emitted when a user creates a Model.
3790
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
4104
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
3791
4105
  */
3792
4106
  CreateModel = "createModel",
3793
4107
  /**
3794
4108
  * @hidden
3795
4109
  * Emitted when a user exits present mode.
3796
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
4110
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3797
4111
  */
3798
4112
  ExitPresentMode = "exitPresentMode",
3799
4113
  /**
3800
4114
  * Emitted when a user requests the full height lazy load data.
3801
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
4115
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3802
4116
  * @hidden
3803
4117
  */
3804
4118
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
@@ -3809,7 +4123,7 @@ export declare enum EmbedEvent {
3809
4123
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
3810
4124
  * console.log('payload', payload);
3811
4125
  * })
3812
- *```
4126
+ * ```
3813
4127
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3814
4128
  */
3815
4129
  SpotterData = "SpotterData",
@@ -3820,7 +4134,7 @@ export declare enum EmbedEvent {
3820
4134
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
3821
4135
  * console.log('payload', payload);
3822
4136
  * })
3823
- *```
4137
+ * ```
3824
4138
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3825
4139
  */
3826
4140
  PreviewSpotterData = "PreviewSpotterData",
@@ -3831,7 +4145,7 @@ export declare enum EmbedEvent {
3831
4145
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
3832
4146
  * console.log('payload', payload);
3833
4147
  * })
3834
- *```
4148
+ * ```
3835
4149
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3836
4150
  */
3837
4151
  AddToCoaching = "addToCoaching",
@@ -3853,7 +4167,7 @@ export declare enum EmbedEvent {
3853
4167
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
3854
4168
  * console.log('payload', payload);
3855
4169
  * })
3856
- *```
4170
+ * ```
3857
4171
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3858
4172
  */
3859
4173
  SpotterQueryTriggered = "SpotterQueryTriggered",
@@ -3864,7 +4178,7 @@ export declare enum EmbedEvent {
3864
4178
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
3865
4179
  * console.log('payload', payload);
3866
4180
  * })
3867
- *```
4181
+ * ```
3868
4182
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3869
4183
  */
3870
4184
  LastPromptEdited = "LastPromptEdited",
@@ -3875,18 +4189,18 @@ export declare enum EmbedEvent {
3875
4189
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
3876
4190
  * console.log('payload', payload);
3877
4191
  * })
3878
- *```
4192
+ * ```
3879
4193
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3880
4194
  */
3881
4195
  LastPromptDeleted = "LastPromptDeleted",
3882
4196
  /**
3883
- * Emitted when the coversation is reset in spotter embed.
4197
+ * Emitted when the conversation is reset in Spotter embed.
3884
4198
  * @example
3885
4199
  * ```js
3886
4200
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
3887
4201
  * console.log('payload', payload);
3888
4202
  * })
3889
- *```
4203
+ * ```
3890
4204
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3891
4205
  */
3892
4206
  ResetSpotterConversation = "ResetSpotterConversation",
@@ -3897,7 +4211,7 @@ export declare enum EmbedEvent {
3897
4211
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
3898
4212
  * console.log('payload', payload);
3899
4213
  * })
3900
- *```
4214
+ * ```
3901
4215
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
3902
4216
  */
3903
4217
  SpotterInit = "spotterInit",
@@ -3908,7 +4222,7 @@ export declare enum EmbedEvent {
3908
4222
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
3909
4223
  * console.log('payload', payload);
3910
4224
  * })
3911
- *```
4225
+ * ```
3912
4226
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
3913
4227
  */
3914
4228
  SpotterLoadComplete = "spotterLoadComplete",
@@ -4262,7 +4576,7 @@ export declare enum HostEvent {
4262
4576
  * ```js
4263
4577
  * appEmbed.navigateToPage(-1)
4264
4578
  * ```
4265
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
4579
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
4266
4580
  */
4267
4581
  Navigate = "Navigate",
4268
4582
  /**
@@ -4395,9 +4709,9 @@ export declare enum HostEvent {
4395
4709
  * Trigger the **Show Liveboard details** action
4396
4710
  * on an embedded Liveboard.
4397
4711
  * @example
4398
- *```js
4712
+ * ```js
4399
4713
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
4400
- *```
4714
+ * ```
4401
4715
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4402
4716
  */
4403
4717
  LiveboardInfo = "pinboardInfo",
@@ -4525,7 +4839,7 @@ export declare enum HostEvent {
4525
4839
  * appEmbed.trigger(HostEvent.Remove)
4526
4840
  * ```
4527
4841
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4528
- * * @example
4842
+ * @example
4529
4843
  * ```js
4530
4844
  * liveboardEmbed.trigger(HostEvent.Remove)
4531
4845
  * ```
@@ -4616,7 +4930,7 @@ export declare enum HostEvent {
4616
4930
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4617
4931
  * ```
4618
4932
  * ```js
4619
- * vizEmbed.trigger((HostEvent.CopyLink)
4933
+ * vizEmbed.trigger(HostEvent.CopyLink)
4620
4934
  * ```
4621
4935
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4622
4936
  */
@@ -4633,7 +4947,7 @@ export declare enum HostEvent {
4633
4947
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4634
4948
  * ```
4635
4949
  * ```js
4636
- * vizEmbed.trigger((HostEvent.Present)
4950
+ * vizEmbed.trigger(HostEvent.Present)
4637
4951
  * ```
4638
4952
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4639
4953
  */
@@ -4648,23 +4962,22 @@ export declare enum HostEvent {
4648
4962
  * );
4649
4963
  * })
4650
4964
  * ```
4651
- * * @example
4965
+ * @example
4652
4966
  * ```js
4653
-
4654
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
4655
- * let latestSpotterVizId = '';
4656
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4657
- * latestSpotterVizId = payload.data.id;
4658
- * });
4659
- *
4660
- * spotterEmbed.trigger(HostEvent.GetTML, {
4967
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
4968
+ * let latestSpotterVizId = '';
4969
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4970
+ * latestSpotterVizId = payload.data.id;
4971
+ * });
4972
+ *
4973
+ * spotterEmbed.trigger(HostEvent.GetTML, {
4661
4974
  * vizId: latestSpotterVizId
4662
4975
  * }).then((tml) => {
4663
4976
  * console.log(
4664
4977
  * tml.answer.search_query // TML representation of the search query
4665
4978
  * );
4666
4979
  * })
4667
- * ```
4980
+ * ```
4668
4981
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4669
4982
  * @important
4670
4983
  */
@@ -4728,6 +5041,11 @@ export declare enum HostEvent {
4728
5041
  /**
4729
5042
  * Trigger the **Download** action on charts in
4730
5043
  * the embedded view.
5044
+ * Use {@link HostEvent.DownloadAsPng} instead.
5045
+ *
5046
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5047
+ *
5048
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
4731
5049
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
4732
5050
  * @example
4733
5051
  * ```js
@@ -4746,9 +5064,6 @@ export declare enum HostEvent {
4746
5064
  *
4747
5065
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
4748
5066
  * ```
4749
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
4750
- * Use {@link DownloadAsPng}
4751
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4752
5067
  */
4753
5068
  Download = "downloadAsPng",
4754
5069
  /**
@@ -5186,8 +5501,8 @@ export declare enum HostEvent {
5186
5501
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
5187
5502
  * console.log('parameters', parameter);
5188
5503
  * });
5189
- *```
5190
- *```js
5504
+ * ```
5505
+ * ```js
5191
5506
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
5192
5507
  * let latestSpotterVizId = '';
5193
5508
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -5195,7 +5510,7 @@ export declare enum HostEvent {
5195
5510
  * });
5196
5511
  *
5197
5512
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
5198
- *```
5513
+ * ```
5199
5514
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5200
5515
  */
5201
5516
  GetParameters = "GetParameters",
@@ -5212,7 +5527,7 @@ export declare enum HostEvent {
5212
5527
  * Notify when info call is completed successfully
5213
5528
  * ```js
5214
5529
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
5215
- *```
5530
+ * ```
5216
5531
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5217
5532
  */
5218
5533
  InfoSuccess = "InfoSuccess",
@@ -5315,7 +5630,7 @@ export declare enum HostEvent {
5315
5630
  * ```js
5316
5631
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
5317
5632
  *
5318
- *```
5633
+ * ```
5319
5634
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5320
5635
  */
5321
5636
  AddToCoaching = "addToCoaching",
@@ -5357,7 +5672,7 @@ export declare enum HostEvent {
5357
5672
  * });
5358
5673
  *
5359
5674
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
5360
- *```
5675
+ * ```
5361
5676
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5362
5677
  */
5363
5678
  AnswerChartSwitcher = "answerChartSwitcher",
@@ -5367,7 +5682,7 @@ export declare enum HostEvent {
5367
5682
  * This is automatically triggered by the SDK when fullscreen mode is exited.
5368
5683
  * ```js
5369
5684
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
5370
- *```
5685
+ * ```
5371
5686
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5372
5687
  */
5373
5688
  ExitPresentMode = "exitPresentMode",
@@ -5618,14 +5933,14 @@ export declare enum Action {
5618
5933
  * ```js
5619
5934
  * disabledActions: [Action.CollapseDataPanel]
5620
5935
  * ```
5621
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5936
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5622
5937
  */
5623
5938
  CollapseDataSources = "collapseDataSources",
5624
5939
  /**
5625
5940
  * The **Collapse data panel** icon on the Search page.
5626
5941
  * Collapses the data panel view.
5627
5942
  *
5628
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5943
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5629
5944
  *
5630
5945
  * @example
5631
5946
  * ```js
@@ -6072,13 +6387,12 @@ export declare enum Action {
6072
6387
  */
6073
6388
  CreateMonitor = "createMonitor",
6074
6389
  /**
6075
- * @deprecated
6076
- * Reports errors
6390
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
6391
+ * @deprecated This action is deprecated. It was used for reporting errors.
6077
6392
  * @example
6078
6393
  * ```js
6079
6394
  * disabledActions: [Action.ReportError]
6080
6395
  * ```
6081
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
6082
6396
  */
6083
6397
  ReportError = "reportError",
6084
6398
  /**
@@ -6088,7 +6402,7 @@ export declare enum Action {
6088
6402
  * ```js
6089
6403
  * disabledActions: [Action.SyncToSheets]
6090
6404
  * ```
6091
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6405
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6092
6406
  */
6093
6407
  SyncToSheets = "sync-to-sheets",
6094
6408
  /**
@@ -6099,7 +6413,7 @@ export declare enum Action {
6099
6413
  * ```js
6100
6414
  * disabledActions: [Action.SyncToOtherApps]
6101
6415
  * ```
6102
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6416
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6103
6417
  */
6104
6418
  SyncToOtherApps = "sync-to-other-apps",
6105
6419
  /**
@@ -6109,7 +6423,7 @@ export declare enum Action {
6109
6423
  * ```js
6110
6424
  * disabledActions: [Action.ManagePipelines]
6111
6425
  * ```
6112
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6426
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6113
6427
  */
6114
6428
  ManagePipelines = "manage-pipeline",
6115
6429
  /**
@@ -6421,7 +6735,7 @@ export declare enum Action {
6421
6735
  * ```js
6422
6736
  * disabledActions: [Action.PersonalisedViewsDropdown]
6423
6737
  * ```
6424
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6738
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6425
6739
  */
6426
6740
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
6427
6741
  /**
@@ -6431,7 +6745,7 @@ export declare enum Action {
6431
6745
  * ```js
6432
6746
  * disabledActions: [Action.LiveboardUsers]
6433
6747
  * ```
6434
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6748
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6435
6749
  */
6436
6750
  LiveboardUsers = "liveboardUsers",
6437
6751
  /**
@@ -6449,7 +6763,7 @@ export declare enum Action {
6449
6763
  * hiddenAction: [Action.TML] // hide all TML actions
6450
6764
  * disabledActions: [Action.TML] // to disable all TML actions
6451
6765
  * ```
6452
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6766
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6453
6767
  */
6454
6768
  TML = "tml",
6455
6769
  /**
@@ -6495,7 +6809,7 @@ export declare enum Action {
6495
6809
  * ```js
6496
6810
  * disabledActions: [Action.AddToWatchlist]
6497
6811
  * ```
6498
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6812
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6499
6813
  */
6500
6814
  AddToWatchlist = "addToWatchlist",
6501
6815
  /**
@@ -6505,7 +6819,7 @@ export declare enum Action {
6505
6819
  * ```js
6506
6820
  * disabledActions: [Action.RemoveFromWatchlist]
6507
6821
  * ```
6508
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6822
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
6509
6823
  */
6510
6824
  RemoveFromWatchlist = "removeFromWatchlist",
6511
6825
  /**
@@ -6516,7 +6830,7 @@ export declare enum Action {
6516
6830
  * ```js
6517
6831
  * disabledActions: [Action.OrganiseFavourites]
6518
6832
  * ```
6519
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6833
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
6520
6834
  */
6521
6835
  OrganiseFavourites = "organiseFavourites",
6522
6836
  /**
@@ -6577,7 +6891,7 @@ export declare enum Action {
6577
6891
  * ```js
6578
6892
  * disabledActions: [Action.ManageTags]
6579
6893
  * ```
6580
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6894
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6581
6895
  */
6582
6896
  ManageTags = "manageTags",
6583
6897
  /**
@@ -7038,17 +7352,79 @@ export interface CustomAction {
7038
7352
  * positions in the application.
7039
7353
  */
7040
7354
  export declare enum CustomActionsPosition {
7355
+ /**
7356
+ * Shows the action as a primary button
7357
+ * in the toolbar area of the embed.
7358
+ */
7041
7359
  PRIMARY = "PRIMARY",
7360
+ /**
7361
+ * Shows the action inside the "More" menu
7362
+ * (three-dot overflow menu).
7363
+ */
7042
7364
  MENU = "MENU",
7365
+ /**
7366
+ * Shows the action in the right-click
7367
+ * context menu. Only supported for
7368
+ * {@link CustomActionTarget.VIZ},
7369
+ * {@link CustomActionTarget.ANSWER}, and
7370
+ * {@link CustomActionTarget.SPOTTER} targets.
7371
+ */
7043
7372
  CONTEXTMENU = "CONTEXTMENU"
7044
7373
  }
7045
7374
  /**
7046
- * Enum options to mention the target of the custom action.
7375
+ * Enum options to mention the target of the code-based custom action.
7376
+ * The target determines which type of ThoughtSpot object the action is
7377
+ * associated with, and also controls which positions and scoping options
7378
+ * are available.
7047
7379
  */
7048
7380
  export declare enum CustomActionTarget {
7381
+ /**
7382
+ * Action applies at the Liveboard level.
7383
+ * Supported positions:
7384
+ * {@link CustomActionsPosition.PRIMARY},
7385
+ * {@link CustomActionsPosition.MENU}.
7386
+ * Can be scoped with
7387
+ * `metadataIds.liveboardIds`,
7388
+ * `orgIds`, and `groupIds`.
7389
+ */
7049
7390
  LIVEBOARD = "LIVEBOARD",
7391
+ /**
7392
+ * Action applies to individual
7393
+ * visualizations (charts/tables).
7394
+ * Supported positions:
7395
+ * {@link CustomActionsPosition.PRIMARY},
7396
+ * {@link CustomActionsPosition.MENU},
7397
+ * {@link CustomActionsPosition.CONTEXTMENU}.
7398
+ * Can be scoped with `metadataIds`
7399
+ * (answerIds, liveboardIds, vizIds),
7400
+ * `dataModelIds` (modelIds,
7401
+ * modelColumnNames), `orgIds`,
7402
+ * and `groupIds`.
7403
+ */
7050
7404
  VIZ = "VIZ",
7405
+ /**
7406
+ * Action applies to saved or unsaved
7407
+ * Answers. Supported positions:
7408
+ * {@link CustomActionsPosition.PRIMARY},
7409
+ * {@link CustomActionsPosition.MENU},
7410
+ * {@link CustomActionsPosition.CONTEXTMENU}.
7411
+ * Can be scoped with
7412
+ * `metadataIds.answerIds`,
7413
+ * `dataModelIds` (modelIds,
7414
+ * modelColumnNames), `orgIds`,
7415
+ * and `groupIds`.
7416
+ */
7051
7417
  ANSWER = "ANSWER",
7418
+ /**
7419
+ * Action applies to Spotter
7420
+ * (AI-powered search).
7421
+ * Supported positions:
7422
+ * {@link CustomActionsPosition.MENU},
7423
+ * {@link CustomActionsPosition.CONTEXTMENU}.
7424
+ * Can be scoped with
7425
+ * `dataModelIds.modelIds`,
7426
+ * `orgIds`, and `groupIds`.
7427
+ */
7052
7428
  SPOTTER = "SPOTTER"
7053
7429
  }
7054
7430
  declare enum LogLevel {
@@ -7276,14 +7652,14 @@ export type ApiInterceptFlags = {
7276
7652
  /**
7277
7653
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
7278
7654
  *
7279
- * Can be used for Serach and App Embed from SDK 1.29.0
7655
+ * Can be used for Search and App Embed from SDK 1.29.0
7280
7656
  *
7281
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7657
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7282
7658
  */
7283
7659
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
7284
7660
  /**
7285
7661
  * This allows to intercept the urls passed, once intercepted the api will only
7286
- * run based on the reponse from the responder of ApiIntercept event.
7662
+ * run based on the response from the responder of ApiIntercept event.
7287
7663
  *
7288
7664
  * @example
7289
7665
  * ```js
@@ -7294,7 +7670,7 @@ export type ApiInterceptFlags = {
7294
7670
  * })
7295
7671
  * ```
7296
7672
  *
7297
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7673
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7298
7674
  */
7299
7675
  interceptUrls?: (string | InterceptedApiType)[];
7300
7676
  /**
@@ -7311,7 +7687,7 @@ export type ApiInterceptFlags = {
7311
7687
  * })
7312
7688
  * ```
7313
7689
  *
7314
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7690
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7315
7691
  */
7316
7692
  interceptTimeout?: number;
7317
7693
  };
@@ -7450,20 +7826,45 @@ export declare enum AuthFailureType {
7450
7826
  */
7451
7827
  export declare enum AuthStatus {
7452
7828
  /**
7453
- * Emits when the SDK fails to authenticate
7829
+ * Emits when the SDK fails to authenticate.
7454
7830
  */
7455
7831
  FAILURE = "FAILURE",
7456
7832
  /**
7457
- * Emits when the SDK authenticates successfully
7833
+ * Emits when the SDK authentication step completes
7834
+ * successfully (e.g., token exchange, cookie set).
7835
+ * This fires before any iframe is rendered. Use
7836
+ * this to know that auth passed and it is safe to
7837
+ * proceed with rendering. The callback receives no
7838
+ * arguments.
7839
+ * @example
7840
+ * ```js
7841
+ * const authEE = init({ ... });
7842
+ * authEE.on(AuthStatus.SDK_SUCCESS, () => {
7843
+ * // Auth done, iframe not loaded yet
7844
+ * });
7845
+ * ```
7458
7846
  */
7459
7847
  SDK_SUCCESS = "SDK_SUCCESS",
7460
7848
  /**
7461
7849
  * @hidden
7462
- * Emits when iframe is loaded and session info is available
7850
+ * Emits when iframe is loaded and session
7851
+ * information is available.
7463
7852
  */
7464
7853
  SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
7465
7854
  /**
7466
- * Emits when the app sends an authentication success message
7855
+ * Emits when the ThoughtSpot app inside the
7856
+ * embedded iframe confirms its session is active.
7857
+ * This fires after the iframe loads and sends back an `AuthInit` event.
7858
+ * @param sessionInfo Information about the user session, with details like `userGUID`.
7859
+ * @see EmbedEvent.AuthInit
7860
+ * @example
7861
+ * ```js
7862
+ * const authEE = init({ ... });
7863
+ * authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
7864
+ * // App is loaded and authenticated
7865
+ * console.log(sessionInfo.userGUID);
7866
+ * });
7867
+ * ```
7467
7868
  */
7468
7869
  SUCCESS = "SUCCESS",
7469
7870
  /**
@@ -7699,9 +8100,9 @@ declare class TsEmbed {
7699
8100
  */
7700
8101
  private isPreRendered;
7701
8102
  /**
7702
- * Should we encode URL Query Params using base64 encoding which thoughtspot
8103
+ * Should we encode URL Query Params using base64 encoding which ThoughtSpot
7703
8104
  * will generate for embedding. This provides additional security to
7704
- * thoughtspot clusters against Cross site scripting attacks.
8105
+ * ThoughtSpot clusters against Cross site scripting attacks.
7705
8106
  * @default false
7706
8107
  */
7707
8108
  private shouldEncodeUrlQueryParams;
@@ -8067,7 +8468,7 @@ declare class TsEmbed {
8067
8468
  * Returns the answerService which can be used to make arbitrary graphql calls on top
8068
8469
  * session.
8069
8470
  * @param vizId [Optional] to get for a specific viz in case of a Liveboard.
8070
- * @version SDK: 1.25.0 / ThoughtSpot 9.10.0
8471
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
8071
8472
  */
8072
8473
  getAnswerService(vizId?: string): Promise<AnswerService>;
8073
8474
  /**
@@ -8154,7 +8555,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8154
8555
  * but can be expanded manually.
8155
8556
  *
8156
8557
  * Supported embed types: `SearchEmbed`
8157
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8558
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8158
8559
  * @example
8159
8560
  * ```js
8160
8561
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8169,7 +8570,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8169
8570
  * but can be expanded manually.
8170
8571
  *
8171
8572
  * Supported embed types: `SearchEmbed`
8172
- * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
8573
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
8173
8574
  * @example
8174
8575
  * ```js
8175
8576
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8183,7 +8584,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8183
8584
  * Show or hide the data sources panel.
8184
8585
  *
8185
8586
  * Supported embed types: `SearchEmbed`
8186
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8587
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8187
8588
  * @example
8188
8589
  * ```js
8189
8590
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8199,7 +8600,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8199
8600
  * using raw answer data.
8200
8601
  *
8201
8602
  * Supported embed types: `SearchEmbed`
8202
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8603
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8203
8604
  * @example
8204
8605
  * ```js
8205
8606
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8228,7 +8629,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8228
8629
  * format for presenting search data.
8229
8630
  *
8230
8631
  * Supported embed types: `SearchEmbed`
8231
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8632
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8232
8633
  * @example
8233
8634
  * ```js
8234
8635
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8241,6 +8642,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8241
8642
  /**
8242
8643
  * The array of data source GUIDs to set on load.
8243
8644
  * Only a single data source is supported currently.
8645
+ * Use {@link dataSource} instead.
8244
8646
  * @deprecated Use `dataSource` instead.
8245
8647
  *
8246
8648
  * Supported embed types: `SearchEmbed`
@@ -8254,10 +8656,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8254
8656
  */
8255
8657
  dataSources?: string[];
8256
8658
  /**
8257
- * The array of data source GUIDs to set on load.
8659
+ * The data source GUID to set on load.
8258
8660
  *
8259
8661
  * Supported embed types: `SearchEmbed`
8260
- * @version: SDK: 1.19.0
8662
+ * @version SDK: 1.19.0
8261
8663
  * @example
8262
8664
  * ```js
8263
8665
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8269,9 +8671,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8269
8671
  dataSource?: string;
8270
8672
  /**
8271
8673
  * The initial search query to load the answer with.
8674
+ * Use {@link searchOptions} instead.
8272
8675
  * @deprecated
8273
8676
  *
8274
- * Use {@link searchOptions} instead.
8275
8677
  */
8276
8678
  searchQuery?: string;
8277
8679
  /**
@@ -8300,7 +8702,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8300
8702
  * If set to true, the search token string is not appended to the URL.
8301
8703
  *
8302
8704
  * Supported embed types: `SearchEmbed`
8303
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8705
+ * @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8304
8706
  * @example
8305
8707
  * ```js
8306
8708
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8317,7 +8719,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8317
8719
  * The GUID of a saved answer to load initially.
8318
8720
  *
8319
8721
  * Supported embed types: `SearchEmbed`
8320
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8722
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8321
8723
  * @example
8322
8724
  * ```js
8323
8725
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8346,14 +8748,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8346
8748
  * Flag to set if last selected dataSource should be used
8347
8749
  *
8348
8750
  * Supported embed types: `SearchEmbed`
8349
- * @version: SDK: 1.24.0
8751
+ * @version SDK: 1.24.0
8350
8752
  */
8351
8753
  useLastSelectedSources?: boolean;
8352
8754
  /**
8353
8755
  * To set the initial state of the search bar in case of saved-answers.
8354
- * @default false
8355
8756
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
8356
8757
  * @deprecated Use {@link collapseSearchBar} instead
8758
+ * @default false
8357
8759
  */
8358
8760
  collapseSearchBarInitially?: boolean;
8359
8761
  /**
@@ -8437,8 +8839,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8437
8839
  * Only a single data source is supported currently.
8438
8840
  *
8439
8841
  * Supported embed types: `SearchBarEmbed`
8842
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
8440
8843
  * @deprecated Use `dataSource` instead
8441
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
8442
8844
  * @example
8443
8845
  * ```js
8444
8846
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8452,7 +8854,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8452
8854
  * Pass the ID of the source to be selected.
8453
8855
  *
8454
8856
  * Supported embed types: `SearchBarEmbed`
8455
- * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
8857
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
8456
8858
  * @example
8457
8859
  * ```js
8458
8860
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8466,7 +8868,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8466
8868
  * Boolean to define if the last selected data source should be used
8467
8869
  *
8468
8870
  * Supported embed types: `SearchBarEmbed`
8469
- * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
8871
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
8470
8872
  * @example
8471
8873
  * ```js
8472
8874
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8488,7 +8890,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8488
8890
  * the token string in the search bar.
8489
8891
  *
8490
8892
  * Supported embed types: `SearchBarEmbed`
8491
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
8893
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
8492
8894
  * @example
8493
8895
  * ```js
8494
8896
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8506,10 +8908,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8506
8908
  * If set to true, the search token string is not appended to the URL.
8507
8909
  *
8508
8910
  * Supported embed types: `SearchBarEmbed`
8509
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8911
+ * @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8510
8912
  * @example
8511
8913
  * ```js
8512
- * const embed = new SearchEmbed('#tsEmbed', {
8914
+ * const embed = new SearchBarEmbed('#tsEmbed', {
8513
8915
  * searchOptions: {
8514
8916
  * searchTokenString: '[quantity purchased] [region]',
8515
8917
  * executeSearch: true,
@@ -8562,7 +8964,7 @@ interface SearchOptions$1 {
8562
8964
  /**
8563
8965
  * The configuration attributes for the embedded Natural language search view. Based on
8564
8966
  * GPT and LLM.
8565
- * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8967
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8566
8968
  *
8567
8969
  * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
8568
8970
  * @group Embed components
@@ -8616,14 +9018,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8616
9018
  hideAutocompleteSuggestions?: boolean;
8617
9019
  /**
8618
9020
  * Show or hide autocomplete suggestions for the search query string.
9021
+ * You can use {@link hideAutocompleteSuggestions} instead.
8619
9022
  * @deprecated
8620
9023
  * Currently, the object suggestions will not be shown for Natural Language Search.
8621
- * You can use {@link hideAutocompleteSuggestions} instead.
8622
9024
  */
8623
9025
  showObjectSuggestions?: boolean;
8624
9026
  /**
8625
9027
  * Show or hide sample questions.
8626
- * The sample questions are autogenerated based on the data Model.
9028
+ * The sample questions are autogenerated based on the data model
8627
9029
  * selected for the search operation.
8628
9030
  *
8629
9031
  * Supported embed types: `SageEmbed`
@@ -8653,6 +9055,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8653
9055
  * the token string in the search bar.
8654
9056
  *
8655
9057
  * Supported embed types: `SageEmbed`
9058
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8656
9059
  * @example
8657
9060
  * ```js
8658
9061
  * searchOptions: {
@@ -8660,7 +9063,6 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8660
9063
  * executeSearch: true,
8661
9064
  * }
8662
9065
  * ```
8663
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8664
9066
  */
8665
9067
  searchOptions?: SearchOptions$1;
8666
9068
  }
@@ -8700,81 +9102,81 @@ interface SearchOptions$2 {
8700
9102
  * Configuration for the Spotter sidebar.
8701
9103
  * Can be used in SpotterEmbed and AppEmbed.
8702
9104
  * @group Embed components
8703
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9105
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8704
9106
  */
8705
9107
  export interface SpotterSidebarViewConfig {
8706
9108
  /**
8707
9109
  * Controls the visibility of the past conversations sidebar.
8708
9110
  * @default false
8709
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9111
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8710
9112
  */
8711
9113
  enablePastConversationsSidebar?: boolean;
8712
9114
  /**
8713
9115
  * Custom title text for the sidebar header.
8714
9116
  * Defaults to translated "Spotter" text.
8715
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9117
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8716
9118
  */
8717
9119
  spotterSidebarTitle?: string;
8718
9120
  /**
8719
9121
  * Boolean to set the default expanded state of the sidebar.
8720
9122
  * @default false
8721
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9123
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8722
9124
  */
8723
9125
  spotterSidebarDefaultExpanded?: boolean;
8724
9126
  /**
8725
9127
  * Custom label text for the rename action in the conversation edit menu.
8726
9128
  * Defaults to translated "Rename" text.
8727
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9129
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8728
9130
  */
8729
9131
  spotterChatRenameLabel?: string;
8730
9132
  /**
8731
9133
  * Custom label text for the delete action in the conversation edit menu.
8732
9134
  * Defaults to translated "DELETE" text.
8733
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9135
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8734
9136
  */
8735
9137
  spotterChatDeleteLabel?: string;
8736
9138
  /**
8737
9139
  * Custom title text for the delete conversation confirmation modal.
8738
9140
  * Defaults to translated "Delete chat" text.
8739
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9141
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8740
9142
  */
8741
9143
  spotterDeleteConversationModalTitle?: string;
8742
9144
  /**
8743
9145
  * Custom message text for the past conversation banner alert.
8744
9146
  * Defaults to translated alert message.
8745
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9147
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8746
9148
  */
8747
9149
  spotterPastConversationAlertMessage?: string;
8748
9150
  /**
8749
9151
  * Custom URL for the documentation/best practices link.
8750
9152
  * Defaults to ThoughtSpot docs URL based on release version.
8751
9153
  * Note: URL must include the protocol (e.g., `https://www.example.com`).
8752
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9154
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8753
9155
  */
8754
9156
  spotterDocumentationUrl?: string;
8755
9157
  /**
8756
9158
  * Custom label text for the best practices button in the footer.
8757
9159
  * Defaults to translated "Best Practices" text.
8758
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9160
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8759
9161
  */
8760
9162
  spotterBestPracticesLabel?: string;
8761
9163
  /**
8762
9164
  * Number of conversations to fetch per batch when loading conversation history.
8763
9165
  * @default 30
8764
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9166
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8765
9167
  */
8766
9168
  spotterConversationsBatchSize?: number;
8767
9169
  /**
8768
9170
  * Custom title text for the "New Chat" button in the sidebar.
8769
9171
  * Defaults to translated "New Chat" text.
8770
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9172
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8771
9173
  */
8772
9174
  spotterNewChatButtonTitle?: string;
8773
9175
  }
8774
9176
  /**
8775
9177
  * Configuration for customizing Spotter chat UI branding.
8776
- * @group Embed components
8777
9178
  * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9179
+ * @group Embed components
8778
9180
  */
8779
9181
  export interface SpotterChatViewConfig {
8780
9182
  /**
@@ -8813,6 +9215,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8813
9215
  * but still display the selected data source.
8814
9216
  *
8815
9217
  * Supported embed types: `SpotterEmbed`
9218
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8816
9219
  * @example
8817
9220
  * ```js
8818
9221
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -8820,13 +9223,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8820
9223
  * disableSourceSelection : true,
8821
9224
  * })
8822
9225
  * ```
8823
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8824
9226
  */
8825
9227
  disableSourceSelection?: boolean;
8826
9228
  /**
8827
9229
  * hideSourceSelection : Hide data source selection
8828
9230
  *
8829
9231
  * Supported embed types: `SpotterEmbed`
9232
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8830
9233
  * @example
8831
9234
  * ```js
8832
9235
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -8834,15 +9237,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8834
9237
  * hideSourceSelection : true,
8835
9238
  * })
8836
9239
  * ```
8837
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8838
9240
  */
8839
9241
  hideSourceSelection?: boolean;
8840
9242
  /**
8841
9243
  * Flag to control Data panel experience
8842
9244
  *
8843
9245
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
9246
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
8844
9247
  * @default true
8845
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
8846
9248
  * @example
8847
9249
  * ```js
8848
9250
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -8859,6 +9261,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8859
9261
  * default is false.
8860
9262
  *
8861
9263
  * Supported embed types: `SpotterEmbed`
9264
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
8862
9265
  * @example
8863
9266
  * ```js
8864
9267
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -8866,7 +9269,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8866
9269
  * showSpotterLimitations : true,
8867
9270
  * })
8868
9271
  * ```
8869
- * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
8870
9272
  */
8871
9273
  showSpotterLimitations?: boolean;
8872
9274
  /**
@@ -8874,6 +9276,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8874
9276
  * the initial screen of the conversation.
8875
9277
  *
8876
9278
  * Supported embed types: `SpotterEmbed`
9279
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8877
9280
  * @example
8878
9281
  * ```js
8879
9282
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -8881,7 +9284,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8881
9284
  * hideSampleQuestions : true,
8882
9285
  * })
8883
9286
  * ```
8884
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8885
9287
  */
8886
9288
  hideSampleQuestions?: boolean;
8887
9289
  /**
@@ -8889,6 +9291,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8889
9291
  * visualization, or Liveboard.
8890
9292
  *
8891
9293
  * Supported embed types: `SpotterEmbed`
9294
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8892
9295
  * @example
8893
9296
  * ```js
8894
9297
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -8902,7 +9305,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8902
9305
  * ],
8903
9306
  * })
8904
9307
  * ```
8905
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8906
9308
  */
8907
9309
  runtimeFilters?: RuntimeFilter[];
8908
9310
  /**
@@ -8913,14 +9315,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8913
9315
  * (default behavior before SDK 1.45.0).
8914
9316
  *
8915
9317
  * Supported embed types: `SpotterEmbed`
8916
- * @default true
8917
9318
  * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9319
+ * @default true
8918
9320
  */
8919
9321
  excludeRuntimeFiltersfromURL?: boolean;
8920
9322
  /**
8921
9323
  * The list of runtime parameters to apply to the conversation.
8922
9324
  *
8923
9325
  * Supported embed types: `SpotterEmbed`
9326
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8924
9327
  * @example
8925
9328
  * ```js
8926
9329
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -8933,7 +9336,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8933
9336
  * ],
8934
9337
  * })
8935
9338
  * ```
8936
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8937
9339
  */
8938
9340
  runtimeParameters?: RuntimeParameter[];
8939
9341
  /**
@@ -8944,14 +9346,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8944
9346
  * the iframe URL instead (default behavior before SDK 1.45.0).
8945
9347
  *
8946
9348
  * Supported embed types: `SpotterEmbed`
8947
- * @default true
8948
9349
  * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9350
+ * @default true
8949
9351
  */
8950
9352
  excludeRuntimeParametersfromURL?: boolean;
8951
9353
  /**
8952
9354
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
8953
9355
  *
8954
9356
  * Supported embed types: `SpotterEmbed`
9357
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
8955
9358
  * @default false
8956
9359
  * @example
8957
9360
  * ```js
@@ -8960,17 +9363,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8960
9363
  * updatedSpotterChatPrompt : true,
8961
9364
  * })
8962
9365
  * ```
8963
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
8964
9366
  */
8965
9367
  updatedSpotterChatPrompt?: boolean;
9368
+ /**
9369
+ * Controls the visibility of the past conversations sidebar.
9370
+ *
9371
+ * Supported embed types: `SpotterEmbed`
9372
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9373
+ * @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9374
+ * Use `spotterSidebarConfig.enablePastConversationsSidebar`.
9375
+ * @default false
9376
+ */
9377
+ enablePastConversationsSidebar?: boolean;
8966
9378
  /**
8967
9379
  * Configuration for the Spotter sidebar UI customization.
8968
9380
  *
8969
9381
  * Supported embed types: `SpotterEmbed`, `AppEmbed`
9382
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
8970
9383
  * @example
8971
9384
  * ```js
8972
9385
  * const embed = new SpotterEmbed('#tsEmbed', {
8973
- * ... //other embed view config
9386
+ * worksheetId: 'worksheet-id',
9387
+ * // Deprecated standalone flag (backward compatibility)
9388
+ * enablePastConversationsSidebar: false,
9389
+ * // Recommended config; this value takes precedence
8974
9390
  * spotterSidebarConfig: {
8975
9391
  * enablePastConversationsSidebar: true,
8976
9392
  * spotterSidebarTitle: 'My Conversations',
@@ -8978,7 +9394,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8978
9394
  * },
8979
9395
  * })
8980
9396
  * ```
8981
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8982
9397
  */
8983
9398
  spotterSidebarConfig?: SpotterSidebarViewConfig;
8984
9399
  /**
@@ -8986,6 +9401,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8986
9401
  * branding in tool response cards.
8987
9402
  *
8988
9403
  * Supported embed types: `SpotterEmbed`
9404
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
8989
9405
  * @example
8990
9406
  * ```js
8991
9407
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -8996,14 +9412,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
8996
9412
  * },
8997
9413
  * })
8998
9414
  * ```
8999
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9000
9415
  */
9001
9416
  spotterChatConfig?: SpotterChatViewConfig;
9002
9417
  }
9003
9418
  /**
9004
9419
  * The configuration for the embedded spotterEmbed options.
9005
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
9006
9420
  * Use {@link SpotterEmbedViewConfig} instead
9421
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
9007
9422
  * @group Embed components
9008
9423
  */
9009
9424
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
@@ -9057,7 +9472,7 @@ export declare enum Page {
9057
9472
  Monitor = "monitor"
9058
9473
  }
9059
9474
  /**
9060
- * Define the initial state os column custom group accordions
9475
+ * Define the initial state of column custom group accordions
9061
9476
  * in data panel v2.
9062
9477
  */
9063
9478
  declare enum DataPanelCustomColumnGroupsAccordionState$1 {
@@ -9116,7 +9531,7 @@ declare enum ListPage {
9116
9531
  */
9117
9532
  export interface DiscoveryExperience {
9118
9533
  /**
9119
- * primaryNavbarVersion determines the version of the navigation version.
9534
+ * primaryNavbarVersion determines the version of the primary navigation bar.
9120
9535
  */
9121
9536
  primaryNavbarVersion?: PrimaryNavbarVersion;
9122
9537
  /**
@@ -9139,8 +9554,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9139
9554
  * This flag also controls the homepage left navigation bar.
9140
9555
  *
9141
9556
  * Supported embed types: `AppEmbed`
9142
- * @default true
9143
9557
  * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
9558
+ * @default true
9144
9559
  * @example
9145
9560
  * ```js
9146
9561
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9161,8 +9576,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9161
9576
  * **Note**: This attribute is not supported in the classic (V1) experience.
9162
9577
  *
9163
9578
  * Supported embed types: `AppEmbed`
9164
- * @default false
9165
9579
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
9580
+ * @default false
9166
9581
  * @example
9167
9582
  * ```js
9168
9583
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9179,8 +9594,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9179
9594
  * navigation bar is not hidden via `showPrimaryNavbar`.
9180
9595
  *
9181
9596
  * Supported embed types: `AppEmbed`
9182
- * @default false
9183
9597
  * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
9598
+ * @default false
9184
9599
  * @example
9185
9600
  * ```js
9186
9601
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9191,12 +9606,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9191
9606
  */
9192
9607
  disableProfileAndHelp?: boolean;
9193
9608
  /**
9194
- * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
9195
- * @default true
9196
9609
  * Whether the help menu in the top navigation bar should be served
9197
9610
  * from Pendo or ThoughtSpot's internal help items.
9198
9611
  *
9199
9612
  * Supported embed types: `AppEmbed`
9613
+ * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
9614
+ * @default true
9200
9615
  * @example
9201
9616
  * ```js
9202
9617
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9211,8 +9626,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9211
9626
  * the top navigation bar in the V3 navigation experience.
9212
9627
  *
9213
9628
  * Supported embed types: `AppEmbed`
9214
- * @default false
9215
9629
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9630
+ * @default false
9216
9631
  * @example
9217
9632
  * ```js
9218
9633
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9231,8 +9646,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9231
9646
  * in the classic (V1) experience.
9232
9647
  *
9233
9648
  * Supported embed types: `AppEmbed`
9234
- * @default true
9235
9649
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9650
+ * @default true
9236
9651
  * @example
9237
9652
  * ```js
9238
9653
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9250,8 +9665,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9250
9665
  * in the classic (V1) and V2 experience modes.
9251
9666
  *
9252
9667
  * Supported embed types: `AppEmbed`
9253
- * @default true
9254
9668
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9669
+ * @default true
9255
9670
  * @example
9256
9671
  * ```js
9257
9672
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9267,7 +9682,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9267
9682
  * In the V3 experience, it shows or hides application selection
9268
9683
  * icons on the left navigation panel.
9269
9684
  * By default, the application selection menu and icons are
9270
- * shown in the UI
9685
+ * shown in the UI.
9271
9686
  *
9272
9687
  * **Note**: This attribute is not supported in the classic (V1) experience.
9273
9688
  *
@@ -9307,7 +9722,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9307
9722
  * takes precedence. This is the path post the `#/` in the URL of the standalone
9308
9723
  * ThoughtSpot app. Use this to open the embedded view to a specific path.
9309
9724
  *
9310
- * For eg, if you want the component to open to a specific Liveboard
9725
+ * For example, if you want the component to open to a specific Liveboard
9311
9726
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
9312
9727
  *
9313
9728
  * Supported embed types: `AppEmbed`
@@ -9325,7 +9740,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9325
9740
  * The application page to set as the start page
9326
9741
  * in the embedded view.
9327
9742
  *
9328
- * Use this to open to particular page in the app. To open to a specific
9743
+ * Use this to open to a particular page in the app. To open to a specific
9329
9744
  * path within the app, use the `path` attribute which is more flexible.
9330
9745
  *
9331
9746
  * Supported embed types: `AppEmbed`
@@ -9405,8 +9820,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9405
9820
  * If set to true, the Search Assist feature is enabled.
9406
9821
  *
9407
9822
  * Supported embed types: `AppEmbed`
9408
- * @default true
9409
9823
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
9824
+ * @default true
9410
9825
  * @example
9411
9826
  * ```js
9412
9827
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9444,8 +9859,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9444
9859
  * For more information,
9445
9860
  * see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
9446
9861
  * Supported embed types: `AppEmbed`
9447
- * @default false
9448
9862
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
9863
+ * @default false
9449
9864
  * @example
9450
9865
  * ```js
9451
9866
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9460,8 +9875,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9460
9875
  * For more information, see
9461
9876
  * link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
9462
9877
  * Supported embed types: `AppEmbed`
9463
- * @default false
9464
9878
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9879
+ * @default false
9465
9880
  * @example
9466
9881
  * ```js
9467
9882
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9476,10 +9891,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9476
9891
  */
9477
9892
  discoveryExperience?: DiscoveryExperience;
9478
9893
  /**
9479
- * To set the initial state of the search bar in case of saved-answers.
9894
+ * To set the initial state of the search bar in case of saved-answers. Use {@link collapseSearchBar} instead.
9480
9895
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
9896
+ * @deprecated This flag is deprecated.
9481
9897
  * @default false
9482
- * @deprecated Use {@link collapseSearchBar} instead
9483
9898
  */
9484
9899
  collapseSearchBarInitially?: boolean;
9485
9900
  /**
@@ -9507,14 +9922,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9507
9922
  * Flag to use home page search bar mode
9508
9923
  *
9509
9924
  * Supported embed types: `AppEmbed`
9510
- * @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl
9925
+ * @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
9511
9926
  */
9512
9927
  homePageSearchBarMode?: HomePageSearchBarMode;
9513
9928
  /**
9514
9929
  * This flag is used to enable unified search experience for full app embed.
9515
9930
  *
9516
9931
  * Supported embed types: `AppEmbed`
9517
- * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
9932
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
9518
9933
  * @default true
9519
9934
  * @example
9520
9935
  * ```js
@@ -9526,7 +9941,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9526
9941
  */
9527
9942
  isUnifiedSearchExperienceEnabled?: boolean;
9528
9943
  /**
9529
- * This flag is used to enable/disable the styling and grouping in a Liveboard
9944
+ * This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
9945
+ * @deprecated This flag is deprecated.
9530
9946
  *
9531
9947
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
9532
9948
  * @type {boolean}
@@ -9592,6 +10008,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9592
10008
  /**
9593
10009
  * This flag is used to enable the full height lazy load data.
9594
10010
  *
10011
+ * @type {boolean}
10012
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
10013
+ * @default false
9595
10014
  * @example
9596
10015
  * ```js
9597
10016
  * const embed = new AppEmbed('#embed-container', {
@@ -9600,39 +10019,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9600
10019
  * lazyLoadingForFullHeight: true,
9601
10020
  * })
9602
10021
  * ```
9603
- *
9604
- * @type {boolean}
9605
- * @default false
9606
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
9607
10022
  */
9608
10023
  lazyLoadingForFullHeight?: boolean;
9609
10024
  /**
9610
10025
  * The margin to be used for lazy loading.
9611
10026
  *
9612
10027
  * For example, if the margin is set to '10px',
9613
- * the visualization will be loaded 10px before the its top edge is visible in the
10028
+ * the visualization will be loaded 10px before its top edge is visible in the
9614
10029
  * viewport.
9615
10030
  *
9616
10031
  * The format is similar to CSS margin.
9617
10032
  *
10033
+ * @type {string}
10034
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
9618
10035
  * @example
9619
10036
  * ```js
9620
10037
  * const embed = new AppEmbed('#embed-container', {
9621
10038
  * // ...other options
9622
10039
  * fullHeight: true,
9623
10040
  * lazyLoadingForFullHeight: true,
9624
- * // Using 0px, the visualization will be only loaded when its visible in the viewport.
10041
+ * // Using 0px, the visualization will be only loaded when it's visible in the viewport.
9625
10042
  * lazyLoadingMargin: '0px',
9626
10043
  * })
9627
10044
  * ```
9628
- * @type {string}
9629
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
9630
10045
  */
9631
10046
  lazyLoadingMargin?: string;
9632
10047
  /**
9633
10048
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
9634
10049
  *
9635
10050
  * Supported embed types: `AppEmbed`
10051
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9636
10052
  * @default false
9637
10053
  * @example
9638
10054
  * ```js
@@ -9641,25 +10057,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9641
10057
  * updatedSpotterChatPrompt : true,
9642
10058
  * })
9643
10059
  * ```
9644
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9645
10060
  */
9646
10061
  updatedSpotterChatPrompt?: boolean;
10062
+ /**
10063
+ * Controls the visibility of the past conversations sidebar.
10064
+ *
10065
+ * Supported embed types: `AppEmbed`
10066
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
10067
+ * @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
10068
+ * Use `spotterSidebarConfig.enablePastConversationsSidebar`.
10069
+ * @default false
10070
+ */
10071
+ enablePastConversationsSidebar?: boolean;
9647
10072
  /**
9648
10073
  * Configuration for the Spotter sidebar UI customization.
9649
10074
  * Only applicable when navigating to Spotter within the app.
9650
10075
  *
9651
10076
  * Supported embed types: `AppEmbed`
10077
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9652
10078
  * @example
9653
10079
  * ```js
9654
10080
  * const embed = new AppEmbed('#tsEmbed', {
9655
- * ... //other embed view config
10081
+ * // Deprecated standalone flag (backward compatibility)
10082
+ * enablePastConversationsSidebar: false,
10083
+ * // Recommended config; this value takes precedence
9656
10084
  * spotterSidebarConfig: {
9657
10085
  * enablePastConversationsSidebar: true,
9658
10086
  * spotterSidebarTitle: 'My Conversations',
9659
10087
  * },
9660
10088
  * })
9661
10089
  * ```
9662
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9663
10090
  */
9664
10091
  spotterSidebarConfig?: SpotterSidebarViewConfig;
9665
10092
  /**
@@ -9667,6 +10094,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9667
10094
  * branding in tool response cards.
9668
10095
  *
9669
10096
  * Supported embed types: `AppEmbed`
10097
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9670
10098
  * @example
9671
10099
  * ```js
9672
10100
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9677,7 +10105,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9677
10105
  * },
9678
10106
  * })
9679
10107
  * ```
9680
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9681
10108
  */
9682
10109
  spotterChatConfig?: SpotterChatViewConfig;
9683
10110
  /**
@@ -9697,6 +10124,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9697
10124
  * ```
9698
10125
  */
9699
10126
  minimumHeight?: number;
10127
+ /**
10128
+ * To enable the homepage announcement banner.
10129
+ * Controls the visibility of the announcement section
10130
+ * on the homepage.
10131
+ *
10132
+ * Supported embed types: `AppEmbed`
10133
+ * @example
10134
+ * ```js
10135
+ * const embed = new AppEmbed('#tsEmbed', {
10136
+ * ... // other embed view config
10137
+ * enableHomepageAnnouncement: true,
10138
+ * })
10139
+ * ```
10140
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
10141
+ */
10142
+ enableHomepageAnnouncement?: boolean;
9700
10143
  }
9701
10144
  declare class AppEmbed extends V1Embed {
9702
10145
  protected viewConfig: AppViewConfig;
@@ -9783,9 +10226,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9783
10226
  * Setting `fullHeight` to `false` fetches visualizations
9784
10227
  * incrementally as users scroll the page to view the charts and tables.
9785
10228
  *
9786
- * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
9787
10229
  *
9788
10230
  * Supported embed types: `LiveboardEmbed`
10231
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
9789
10232
  * @example
9790
10233
  * ```js
9791
10234
  * const embed = new LiveboardEmbed('#embed', {
@@ -9796,14 +10239,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9796
10239
  */
9797
10240
  fullHeight?: boolean;
9798
10241
  /**
9799
- * This is the minimum height(in pixels) for a full-height Liveboard.
10242
+ * This is the minimum height (in pixels) for a full-height Liveboard.
9800
10243
  * Setting this height helps resolve issues with empty Liveboards and
9801
10244
  * other screens navigable from a Liveboard.
9802
10245
  *
9803
10246
  * Supported embed types: `LiveboardEmbed`
9804
10247
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
9805
- * @default 500
9806
10248
  * @deprecated Use `minimumHeight` instead.
10249
+ * @default 500
9807
10250
  * @example
9808
10251
  * ```js
9809
10252
  * const embed = new LiveboardEmbed('#embed', {
@@ -9832,7 +10275,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9832
10275
  */
9833
10276
  minimumHeight?: number;
9834
10277
  /**
9835
- * @Deprecated If set to true, the context menu in visualizations will be enabled.
10278
+ * If set to true, the context menu in visualizations will be enabled.
10279
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
10280
+ * @deprecated this option is deprecated.
9836
10281
  * @example
9837
10282
  * ```js
9838
10283
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -9840,7 +10285,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9840
10285
  * enableVizTransformations:true,
9841
10286
  * })
9842
10287
  * ```
9843
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
9844
10288
  */
9845
10289
  enableVizTransformations?: boolean;
9846
10290
  /**
@@ -9853,8 +10297,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9853
10297
  * ```js
9854
10298
  * const embed = new LiveboardEmbed('#tsEmbed', {
9855
10299
  * ... //other embed view config
9856
- * liveboardId:id of liveboard,
10300
+ * liveboardId:'id of liveboard',
9857
10301
  * })
10302
+ * ```
9858
10303
  */
9859
10304
  liveboardId?: string;
9860
10305
  /**
@@ -9907,6 +10352,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9907
10352
  * 'f547ec54-2a37-4516-a222-2b06719af726'
9908
10353
  * ]
9909
10354
  * })
10355
+ * ```
9910
10356
  */
9911
10357
  visibleVizs?: string[];
9912
10358
  /**
@@ -9934,6 +10380,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9934
10380
  * Specify the tab ID.
9935
10381
  *
9936
10382
  * Supported embed types: `LiveboardEmbed`
10383
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
9937
10384
  * @example
9938
10385
  * ```js
9939
10386
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -9941,7 +10388,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9941
10388
  * activeTabId:'id-1234',
9942
10389
  * })
9943
10390
  * ```
9944
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
9945
10391
  */
9946
10392
  activeTabId?: string;
9947
10393
  /**
@@ -9950,6 +10396,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9950
10396
  * that includes specific filter selections.
9951
10397
  *
9952
10398
  * Supported embed types: `LiveboardEmbed`
10399
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9953
10400
  * @example
9954
10401
  * ```js
9955
10402
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -9958,7 +10405,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9958
10405
  * activeTabId: 'tab-guid',
9959
10406
  * })
9960
10407
  * ```
9961
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9962
10408
  */
9963
10409
  personalizedViewId?: string;
9964
10410
  /**
@@ -9979,13 +10425,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9979
10425
  * Show a preview image of the visualization before the visualization loads.
9980
10426
  * Only works for visualizations embeds with a viz id.
9981
10427
  *
9982
- * Also, viz snashot should be enabled in the ThoughtSpot instance.
10428
+ * Also, viz snapshot should be enabled in the ThoughtSpot instance.
9983
10429
  * Contact ThoughtSpot support to enable this feature.
9984
10430
  *
9985
- * Since, this will show preview images, be careful that it may show
10431
+ * Since this will show preview images, be careful that it may show
9986
10432
  * undesired data to the user when using row level security.
9987
10433
  *
9988
10434
  * Supported embed types: `LiveboardEmbed`
10435
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
9989
10436
  * @example
9990
10437
  * ```js
9991
10438
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -9995,7 +10442,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9995
10442
  * });
9996
10443
  * embed.render();
9997
10444
  * ```
9998
- * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
9999
10445
  */
10000
10446
  showPreviewLoader?: boolean;
10001
10447
  /**
@@ -10003,13 +10449,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10003
10449
  *
10004
10450
  * Supported embed types: `LiveboardEmbed`
10005
10451
  * @hidden
10006
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10452
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10007
10453
  * @example
10008
10454
  * ```js
10009
10455
  * const embed = new LiveboardEmbed('#tsEmbed', {
10010
10456
  * ... //other embed view config
10011
- * oAuthPollingInterval: value in milliseconds,
10457
+ * oAuthPollingInterval: 30000,
10012
10458
  * })
10459
+ * ```
10013
10460
  */
10014
10461
  oAuthPollingInterval?: number;
10015
10462
  /**
@@ -10017,35 +10464,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10017
10464
  *
10018
10465
  * Supported embed types: `LiveboardEmbed`
10019
10466
  * @hidden
10020
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10467
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10021
10468
  * @example
10022
10469
  * ```js
10023
10470
  * const embed = new LiveboardEmbed('#tsEmbed', {
10024
10471
  * ... //other embed view config
10025
10472
  * isForceRedirect: false,
10026
10473
  * })
10474
+ * ```
10027
10475
  */
10028
10476
  isForceRedirect?: boolean;
10029
10477
  /**
10030
10478
  * The source connection ID for authentication.
10031
- * @hidden
10032
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10033
10479
  *
10034
10480
  * Supported embed types: `LiveboardEmbed`
10481
+ * @hidden
10482
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10035
10483
  * @example
10036
10484
  * ```js
10037
10485
  * const embed = new LiveboardEmbed('#tsEmbed', {
10038
10486
  * ... //other embed view config
10039
10487
  * dataSourceId: '',
10040
10488
  * })
10489
+ * ```
10041
10490
  */
10042
10491
  dataSourceId?: string;
10043
10492
  /**
10044
- * The list of tab IDs to hide from the embedded.
10045
- * This Tabs will be hidden from their respective LBs.
10046
- * Use this to hide an tabID.
10493
+ * The list of tab IDs to hide from the embedded Liveboard.
10494
+ * These tabs will be hidden from their respective Liveboards.
10495
+ * Use this to hide a tab ID.
10047
10496
  *
10048
10497
  * Supported embed types: `LiveboardEmbed`
10498
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
10049
10499
  * @example
10050
10500
  * ```js
10051
10501
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10056,7 +10506,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10056
10506
  * ]
10057
10507
  * });
10058
10508
  * ```
10059
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
10060
10509
  */
10061
10510
  hiddenTabs?: string[];
10062
10511
  /**
@@ -10080,7 +10529,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10080
10529
  */
10081
10530
  visibleTabs?: string[];
10082
10531
  /**
10083
- * This flag is used to enable/disable the styling and grouping in a Liveboard
10532
+ * This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
10533
+ * @deprecated This flag is deprecated.
10084
10534
  *
10085
10535
  * Supported embed types: `LiveboardEmbed`, `AppEmbed`
10086
10536
  * @type {boolean}
@@ -10146,6 +10596,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10146
10596
  /**
10147
10597
  * This flag is used to enable the full height lazy load data.
10148
10598
  *
10599
+ * @type {boolean}
10600
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
10601
+ * @default false
10149
10602
  * @example
10150
10603
  * ```js
10151
10604
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -10154,33 +10607,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10154
10607
  * lazyLoadingForFullHeight: true,
10155
10608
  * })
10156
10609
  * ```
10157
- *
10158
- * @type {boolean}
10159
- * @default false
10160
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
10161
10610
  */
10162
10611
  lazyLoadingForFullHeight?: boolean;
10163
10612
  /**
10164
10613
  * The margin to be used for lazy loading.
10165
10614
  *
10166
10615
  * For example, if the margin is set to '10px',
10167
- * the visualization will be loaded 10px before the its top edge is visible in the
10616
+ * the visualization will be loaded 10px before its top edge is visible in the
10168
10617
  * viewport.
10169
10618
  *
10170
10619
  * The format is similar to CSS margin.
10171
10620
  *
10621
+ * @type {string}
10622
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
10172
10623
  * @example
10173
10624
  * ```js
10174
10625
  * const embed = new LiveboardEmbed('#embed-container', {
10175
10626
  * // ...other options
10176
10627
  * fullHeight: true,
10177
10628
  * lazyLoadingForFullHeight: true,
10178
- * // Using 0px, the visualization will be only loaded when its visible in the viewport.
10629
+ * // Using 0px, the visualization will be only loaded when it's visible in the viewport.
10179
10630
  * lazyLoadingMargin: '0px',
10180
10631
  * })
10181
10632
  * ```
10182
- * @type {string}
10183
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
10184
10633
  */
10185
10634
  lazyLoadingMargin?: string;
10186
10635
  /**
@@ -10188,6 +10637,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10188
10637
  * of the spotter underneath the chat input.
10189
10638
  * default is false.
10190
10639
  *
10640
+ * @type {boolean}
10641
+ * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
10191
10642
  * @example
10192
10643
  * ```js
10193
10644
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -10195,14 +10646,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10195
10646
  * showSpotterLimitations: true,
10196
10647
  * })
10197
10648
  * ```
10198
- * @type {boolean}
10199
- * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
10200
10649
  */
10201
10650
  showSpotterLimitations?: boolean;
10202
10651
  /**
10203
10652
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
10204
10653
  *
10205
10654
  * Supported embed types: `LiveboardEmbed`
10655
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
10206
10656
  * @default false
10207
10657
  * @example
10208
10658
  * ```js
@@ -10211,7 +10661,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10211
10661
  * updatedSpotterChatPrompt : true,
10212
10662
  * })
10213
10663
  * ```
10214
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
10215
10664
  */
10216
10665
  updatedSpotterChatPrompt?: boolean;
10217
10666
  /**
@@ -10219,6 +10668,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10219
10668
  * branding in tool response cards.
10220
10669
  *
10221
10670
  * Supported embed types: `LiveboardEmbed`
10671
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10222
10672
  * @example
10223
10673
  * ```js
10224
10674
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10229,7 +10679,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10229
10679
  * },
10230
10680
  * })
10231
10681
  * ```
10232
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10233
10682
  */
10234
10683
  spotterChatConfig?: SpotterChatViewConfig;
10235
10684
  }
@@ -10396,9 +10845,9 @@ export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter | null
10396
10845
  export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
10397
10846
  /**
10398
10847
  * Reloads the ThoughtSpot iframe.
10848
+ * @version SDK: 1.43.1
10399
10849
  * @param iFrame
10400
10850
  * @group Global methods
10401
- * @version SDK: 1.43.1
10402
10851
  */
10403
10852
  export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
10404
10853
  export type SessionInfo = {
@@ -10500,6 +10949,9 @@ export interface PreRenderProps {
10500
10949
  * PreRender id to be used for PreRendering the embed.
10501
10950
  * Use PreRender to render the embed in the background and then
10502
10951
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
10952
+ *
10953
+ * Use PreRendered react component for pre rendering embed components.
10954
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
10503
10955
  * @example
10504
10956
  * ```js
10505
10957
  * const embed = new LiveboardEmbed('#embed', {
@@ -10508,8 +10960,6 @@ export interface PreRenderProps {
10508
10960
  * });
10509
10961
  * embed.showPreRender();
10510
10962
  * ```
10511
- *
10512
- * Use PreRendered react component for pre rendering embed components.
10513
10963
  * @example
10514
10964
  * ```tsx
10515
10965
  * function LandingPageComponent() {
@@ -10520,7 +10970,6 @@ export interface PreRenderProps {
10520
10970
  * return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
10521
10971
  * }
10522
10972
  * ```
10523
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
10524
10973
  */
10525
10974
  preRenderId: string;
10526
10975
  }
@@ -10544,7 +10993,7 @@ export interface AppProps extends EmbedProps, AppViewConfig {
10544
10993
  * React component for Full app Embed.
10545
10994
  * @example
10546
10995
  * ```tsx
10547
- * function Search() {
10996
+ * function App() {
10548
10997
  * return <AppEmbed
10549
10998
  * showPrimaryNavbar={false}
10550
10999
  * pageId={Page.Liveboards}
@@ -10555,9 +11004,9 @@ export interface AppProps extends EmbedProps, AppViewConfig {
10555
11004
  */
10556
11005
  declare const AppEmbed$1: React$1.ForwardRefExoticComponent<AppProps & React$1.RefAttributes<AppEmbed>>;
10557
11006
  /**
10558
- * React component for PreRendered Liveboard embed.
11007
+ * React component for PreRendered App embed.
10559
11008
  *
10560
- * PreRenderedAppEmbed will preRender the SearchBarEmbed and will be hidden by
11009
+ * PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
10561
11010
  * default.
10562
11011
  *
10563
11012
  * AppEmbed with preRenderId passed will call showPreRender on the embed.
@@ -10598,7 +11047,7 @@ declare const LiveboardEmbed$1: React$1.ForwardRefExoticComponent<LiveboardProps
10598
11047
  * LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
10599
11048
  *
10600
11049
  * If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
10601
- * tries to preRender the LiveboardEmbed, so it is recommended to use pass the
11050
+ * tries to preRender the LiveboardEmbed, so it is recommended to pass the
10602
11051
  * liveboardId to both the components.
10603
11052
  * @example
10604
11053
  * ```tsx
@@ -10628,7 +11077,7 @@ export interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
10628
11077
  */
10629
11078
  declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & React$1.RefAttributes<SearchBarEmbed>>;
10630
11079
  /**
10631
- * React component for PreRendered Liveboard embed.
11080
+ * React component for PreRendered SearchBar embed.
10632
11081
  *
10633
11082
  * PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
10634
11083
  * default.
@@ -10662,9 +11111,9 @@ export interface SageEmbedProps extends EmbedProps, SageViewConfig {
10662
11111
  */
10663
11112
  declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
10664
11113
  /**
10665
- * React component for PreRendered Liveboard embed.
11114
+ * React component for PreRendered Sage embed.
10666
11115
  *
10667
- * PreRenderedSageEmbed will preRender the SearchBarEmbed and will be hidden by
11116
+ * PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
10668
11117
  * default.
10669
11118
  *
10670
11119
  * SageEmbed with preRenderId passed will call showPreRender on the embed.
@@ -10702,8 +11151,8 @@ export interface ConversationEmbedProps extends EmbedProps, ConversationViewConf
10702
11151
  declare const SpotterEmbed$1: React$1.ForwardRefExoticComponent<SpotterEmbedProps & React$1.RefAttributes<SpotterEmbed>>;
10703
11152
  /**
10704
11153
  * React component for LLM based conversation BI.
10705
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
10706
11154
  * Use {@link SpotterEmbed} instead
11155
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
10707
11156
  * @example
10708
11157
  * ```tsx
10709
11158
  * function Sage() {
@@ -10732,6 +11181,7 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
10732
11181
  * This component renders a single message response from your ThoughtSpot conversation,
10733
11182
  * showing charts, visualizations, or text responses based on the user's query.
10734
11183
  *
11184
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
10735
11185
  * @example
10736
11186
  * ```tsx
10737
11187
  * const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
@@ -10748,7 +11198,6 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
10748
11198
  * />
10749
11199
  * }
10750
11200
  * ```
10751
- * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
10752
11201
  */
10753
11202
  export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
10754
11203
  message: SpotterAgentMessageViewConfig;
@@ -10760,7 +11209,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
10760
11209
  * PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
10761
11210
  * default.
10762
11211
  *
10763
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
11212
+ * SpotterEmbed with preRenderId passed will call showPreRender on the embed.
10764
11213
  * @example
10765
11214
  * ```tsx
10766
11215
  * function LandingPageComponent() {
@@ -10793,6 +11242,7 @@ export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof L
10793
11242
  export declare function useEmbedRef<T extends EmbedComponent>(): React$1.MutableRefObject<React$1.ComponentRef<T>>;
10794
11243
  /**
10795
11244
  *
11245
+ * @version SDK: 1.36.2 | ThoughtSpot: *
10796
11246
  * @param config - EmbedConfig
10797
11247
  * @returns AuthEventEmitter
10798
11248
  * @example
@@ -10802,7 +11252,6 @@ export declare function useEmbedRef<T extends EmbedComponent>(): React$1.Mutable
10802
11252
  * return <LiveboardEmbed ref={ref} liveboardId={<id>} />
10803
11253
  * }
10804
11254
  * ```
10805
- * @version SDK: 1.36.2 | ThoughtSpot: *
10806
11255
  */
10807
11256
  export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<AuthEventEmitter>;
10808
11257
  /**
@@ -10811,6 +11260,7 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
10811
11260
  * This hook provides a sendMessage function that allows you to send natural language
10812
11261
  * queries to your data and get back AI-generated responses with visualizations.
10813
11262
  *
11263
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
10814
11264
  * @param config - Configuration object containing worksheetId and other options
10815
11265
  * @returns Object with sendMessage function that returns conversation results
10816
11266
  * @example
@@ -10828,7 +11278,6 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
10828
11278
  * }
10829
11279
  * };
10830
11280
  * ```
10831
- * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
10832
11281
  */
10833
11282
  export declare function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
10834
11283
  sendMessage: (query: string) => Promise<{