@thoughtspot/visual-embed-sdk 1.33.0-alpha.2 → 1.33.0

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 (198) hide show
  1. package/cjs/package.json +6 -24
  2. package/cjs/src/css-variables.d.ts +46 -3
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +47 -27
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +10 -1
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +32 -0
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/base.d.ts +35 -33
  11. package/cjs/src/embed/base.d.ts.map +1 -1
  12. package/cjs/src/embed/base.js +35 -33
  13. package/cjs/src/embed/base.js.map +1 -1
  14. package/cjs/src/embed/embed.spec.js +0 -19
  15. package/cjs/src/embed/embed.spec.js.map +1 -1
  16. package/cjs/src/embed/liveboard.d.ts +42 -0
  17. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  18. package/cjs/src/embed/liveboard.js +6 -1
  19. package/cjs/src/embed/liveboard.js.map +1 -1
  20. package/cjs/src/embed/liveboard.spec.js +43 -0
  21. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  22. package/cjs/src/embed/search.d.ts +0 -26
  23. package/cjs/src/embed/search.d.ts.map +1 -1
  24. package/cjs/src/embed/search.js.map +1 -1
  25. package/cjs/src/embed/ts-embed.d.ts +0 -1
  26. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  27. package/cjs/src/embed/ts-embed.js +8 -12
  28. package/cjs/src/embed/ts-embed.js.map +1 -1
  29. package/cjs/src/embed/ts-embed.spec.js +0 -9
  30. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  31. package/cjs/src/mixpanel-service.d.ts +4 -0
  32. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  33. package/cjs/src/mixpanel-service.js +4 -0
  34. package/cjs/src/mixpanel-service.js.map +1 -1
  35. package/cjs/src/tokenizedFetch.d.ts.map +1 -1
  36. package/cjs/src/tokenizedFetch.js +5 -1
  37. package/cjs/src/tokenizedFetch.js.map +1 -1
  38. package/cjs/src/types.d.ts +179 -22
  39. package/cjs/src/types.d.ts.map +1 -1
  40. package/cjs/src/types.js +143 -12
  41. package/cjs/src/types.js.map +1 -1
  42. package/cjs/src/utils/authService/authService.spec.js +3 -1
  43. package/cjs/src/utils/authService/authService.spec.js.map +1 -1
  44. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  45. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  46. package/cjs/src/utils/graphql/answerService/answer-queries.js +9 -2
  47. package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  48. package/cjs/src/utils/graphql/answerService/answerService.d.ts +15 -0
  49. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  50. package/cjs/src/utils/graphql/answerService/answerService.js +25 -0
  51. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  52. package/cjs/src/utils/graphql/answerService/answerService.spec.js +53 -0
  53. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  54. package/cjs/src/utils/graphql/graphql-request.spec.d.ts +2 -0
  55. package/cjs/src/utils/graphql/graphql-request.spec.d.ts.map +1 -0
  56. package/cjs/src/utils/graphql/graphql-request.spec.js +36 -0
  57. package/cjs/src/utils/graphql/graphql-request.spec.js.map +1 -0
  58. package/cjs/src/utils/processData.js +2 -2
  59. package/cjs/src/utils/processData.js.map +1 -1
  60. package/cjs/src/utils/processData.spec.js +14 -0
  61. package/cjs/src/utils/processData.spec.js.map +1 -1
  62. package/cjs/src/utils/processTrigger.d.ts +1 -0
  63. package/cjs/src/utils/processTrigger.d.ts.map +1 -1
  64. package/cjs/src/utils/processTrigger.js +3 -3
  65. package/cjs/src/utils/processTrigger.js.map +1 -1
  66. package/cjs/src/utils/processTrigger.spec.js +10 -0
  67. package/cjs/src/utils/processTrigger.spec.js.map +1 -1
  68. package/cjs/src/utils.d.ts.map +1 -1
  69. package/cjs/src/utils.js +1 -3
  70. package/cjs/src/utils.js.map +1 -1
  71. package/dist/src/css-variables.d.ts +46 -3
  72. package/dist/src/css-variables.d.ts.map +1 -1
  73. package/dist/src/embed/app.d.ts +47 -27
  74. package/dist/src/embed/app.d.ts.map +1 -1
  75. package/dist/src/embed/base.d.ts +35 -33
  76. package/dist/src/embed/base.d.ts.map +1 -1
  77. package/dist/src/embed/liveboard.d.ts +42 -0
  78. package/dist/src/embed/liveboard.d.ts.map +1 -1
  79. package/dist/src/embed/search.d.ts +0 -26
  80. package/dist/src/embed/search.d.ts.map +1 -1
  81. package/dist/src/embed/ts-embed.d.ts +0 -1
  82. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  83. package/dist/src/mixpanel-service.d.ts +4 -0
  84. package/dist/src/mixpanel-service.d.ts.map +1 -1
  85. package/dist/src/tokenizedFetch.d.ts.map +1 -1
  86. package/dist/src/types.d.ts +179 -22
  87. package/dist/src/types.d.ts.map +1 -1
  88. package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  89. package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  90. package/dist/src/utils/graphql/answerService/answerService.d.ts +15 -0
  91. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  92. package/dist/src/utils/graphql/graphql-request.spec.d.ts +2 -0
  93. package/dist/src/utils/graphql/graphql-request.spec.d.ts.map +1 -0
  94. package/dist/src/utils/processTrigger.d.ts +1 -0
  95. package/dist/src/utils/processTrigger.d.ts.map +1 -1
  96. package/dist/src/utils.d.ts.map +1 -1
  97. package/dist/tsembed-react.es.js +442 -107
  98. package/dist/tsembed-react.js +385 -106
  99. package/dist/tsembed.es.js +477 -140
  100. package/dist/tsembed.js +420 -139
  101. package/dist/visual-embed-sdk-react-full.d.ts +368 -112
  102. package/dist/visual-embed-sdk-react.d.ts +368 -112
  103. package/dist/visual-embed-sdk.d.ts +368 -112
  104. package/lib/package.json +6 -24
  105. package/lib/src/css-variables.d.ts +46 -3
  106. package/lib/src/css-variables.d.ts.map +1 -1
  107. package/lib/src/embed/app.d.ts +47 -27
  108. package/lib/src/embed/app.d.ts.map +1 -1
  109. package/lib/src/embed/app.js +10 -1
  110. package/lib/src/embed/app.js.map +1 -1
  111. package/lib/src/embed/app.spec.js +32 -0
  112. package/lib/src/embed/app.spec.js.map +1 -1
  113. package/lib/src/embed/base.d.ts +35 -33
  114. package/lib/src/embed/base.d.ts.map +1 -1
  115. package/lib/src/embed/base.js +35 -33
  116. package/lib/src/embed/base.js.map +1 -1
  117. package/lib/src/embed/embed.spec.js +0 -19
  118. package/lib/src/embed/embed.spec.js.map +1 -1
  119. package/lib/src/embed/liveboard.d.ts +42 -0
  120. package/lib/src/embed/liveboard.d.ts.map +1 -1
  121. package/lib/src/embed/liveboard.js +6 -1
  122. package/lib/src/embed/liveboard.js.map +1 -1
  123. package/lib/src/embed/liveboard.spec.js +43 -0
  124. package/lib/src/embed/liveboard.spec.js.map +1 -1
  125. package/lib/src/embed/search.d.ts +0 -26
  126. package/lib/src/embed/search.d.ts.map +1 -1
  127. package/lib/src/embed/search.js.map +1 -1
  128. package/lib/src/embed/ts-embed.d.ts +0 -1
  129. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  130. package/lib/src/embed/ts-embed.js +8 -12
  131. package/lib/src/embed/ts-embed.js.map +1 -1
  132. package/lib/src/embed/ts-embed.spec.js +0 -9
  133. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  134. package/lib/src/mixpanel-service.d.ts +4 -0
  135. package/lib/src/mixpanel-service.d.ts.map +1 -1
  136. package/lib/src/mixpanel-service.js +4 -0
  137. package/lib/src/mixpanel-service.js.map +1 -1
  138. package/lib/src/tokenizedFetch.d.ts.map +1 -1
  139. package/lib/src/tokenizedFetch.js +5 -1
  140. package/lib/src/tokenizedFetch.js.map +1 -1
  141. package/lib/src/types.d.ts +179 -22
  142. package/lib/src/types.d.ts.map +1 -1
  143. package/lib/src/types.js +143 -12
  144. package/lib/src/types.js.map +1 -1
  145. package/lib/src/utils/authService/authService.spec.js +3 -1
  146. package/lib/src/utils/authService/authService.spec.js.map +1 -1
  147. package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  148. package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  149. package/lib/src/utils/graphql/answerService/answer-queries.js +8 -1
  150. package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  151. package/lib/src/utils/graphql/answerService/answerService.d.ts +15 -0
  152. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  153. package/lib/src/utils/graphql/answerService/answerService.js +25 -0
  154. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  155. package/lib/src/utils/graphql/answerService/answerService.spec.js +54 -1
  156. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  157. package/lib/src/utils/graphql/graphql-request.spec.d.ts +2 -0
  158. package/lib/src/utils/graphql/graphql-request.spec.d.ts.map +1 -0
  159. package/lib/src/utils/graphql/graphql-request.spec.js +33 -0
  160. package/lib/src/utils/graphql/graphql-request.spec.js.map +1 -0
  161. package/lib/src/utils/processData.js +2 -2
  162. package/lib/src/utils/processData.js.map +1 -1
  163. package/lib/src/utils/processData.spec.js +14 -0
  164. package/lib/src/utils/processData.spec.js.map +1 -1
  165. package/lib/src/utils/processTrigger.d.ts +1 -0
  166. package/lib/src/utils/processTrigger.d.ts.map +1 -1
  167. package/lib/src/utils/processTrigger.js +1 -1
  168. package/lib/src/utils/processTrigger.js.map +1 -1
  169. package/lib/src/utils/processTrigger.spec.js +10 -0
  170. package/lib/src/utils/processTrigger.spec.js.map +1 -1
  171. package/lib/src/utils.d.ts.map +1 -1
  172. package/lib/src/utils.js +1 -3
  173. package/lib/src/utils.js.map +1 -1
  174. package/lib/src/visual-embed-sdk.d.ts +368 -112
  175. package/package.json +6 -24
  176. package/src/css-variables.ts +49 -3
  177. package/src/embed/app.spec.ts +47 -0
  178. package/src/embed/app.ts +54 -26
  179. package/src/embed/base.ts +35 -33
  180. package/src/embed/embed.spec.ts +0 -22
  181. package/src/embed/liveboard.spec.ts +62 -0
  182. package/src/embed/liveboard.ts +52 -0
  183. package/src/embed/search.ts +0 -26
  184. package/src/embed/ts-embed.spec.ts +0 -11
  185. package/src/embed/ts-embed.ts +9 -12
  186. package/src/mixpanel-service.ts +4 -0
  187. package/src/tokenizedFetch.ts +5 -1
  188. package/src/types.ts +180 -21
  189. package/src/utils/authService/authService.spec.ts +3 -1
  190. package/src/utils/graphql/answerService/answer-queries.ts +9 -1
  191. package/src/utils/graphql/answerService/answerService.spec.ts +69 -0
  192. package/src/utils/graphql/answerService/answerService.ts +35 -0
  193. package/src/utils/graphql/graphql-request.spec.ts +38 -0
  194. package/src/utils/processData.spec.ts +16 -0
  195. package/src/utils/processData.ts +2 -2
  196. package/src/utils/processTrigger.spec.ts +19 -0
  197. package/src/utils/processTrigger.ts +1 -1
  198. package/src/utils.ts +1 -3
@@ -643,19 +643,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
643
643
  * ```
644
644
  */
645
645
  hideSearchBar?: boolean;
646
- /**
647
- * Flag to control Data panel experience
648
- * @default true
649
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
650
- * @example
651
- * ```js
652
- * const embed = new SearchEmbed('#tsEmbed', {
653
- * ... // other options
654
- * dataPanelV2:false,
655
- * })
656
- * ```
657
- */
658
- dataPanelV2?: boolean;
659
646
  /**
660
647
  * Flag to set if last selected dataSource should be used
661
648
  * @version: SDK: 1.24.0
@@ -668,19 +655,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
668
655
  * @deprecated Use {@link collapseSearchBar} instead
669
656
  */
670
657
  collapseSearchBarInitially?: boolean;
671
- /**
672
- * To enable custom column groups in data panel v2
673
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
674
- * @default false
675
- * @example
676
- * ```js
677
- * const embed = new SearchEmbed('#tsEmbed', {
678
- * ... // other options
679
- * enableCustomColumnGroups: true,
680
- * });
681
- * ```
682
- */
683
- enableCustomColumnGroups?: boolean;
684
658
  /**
685
659
  * Flag to enable onBeforeSearchExecute Embed Event
686
660
  * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
@@ -785,7 +759,11 @@ export declare enum Page {
785
759
  /**
786
760
  * SpotIQ listing page
787
761
  */
788
- SpotIQ = "insights"
762
+ SpotIQ = "insights",
763
+ /**
764
+ * Monitor Alerts Page
765
+ */
766
+ Monitor = "monitor"
789
767
  }
790
768
  /**
791
769
  * Define the initial state os column custom group accordions
@@ -996,19 +974,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
996
974
  * ```
997
975
  */
998
976
  fullHeight?: boolean;
999
- /**
1000
- * Flag to control Data panel experience
1001
- * @default true
1002
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1003
- * @example
1004
- * ```js
1005
- * const embed = new AppEmbed('#tsEmbed', {
1006
- * ... // other options
1007
- * dataPanelV2: true,
1008
- * })
1009
- * ```
1010
- */
1011
- dataPanelV2?: boolean;
1012
977
  /**
1013
978
  * Show or hide Liveboard header
1014
979
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
@@ -1086,19 +1051,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1086
1051
  * @deprecated Use {@link collapseSearchBar} instead
1087
1052
  */
1088
1053
  collapseSearchBarInitially?: boolean;
1089
- /**
1090
- * To enable custom column groups in data panel v2.
1091
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1092
- * @default false
1093
- * @example
1094
- * ```js
1095
- * const embed = new AppEmbed('#embed', {
1096
- * ... // other app view config
1097
- * enableCustomColumnGroups: true,
1098
- * });
1099
- * ```
1100
- */
1101
- enableCustomColumnGroups?: boolean;
1102
1054
  /**
1103
1055
  * This controls the initial behaviour of custom column groups accordion.
1104
1056
  * It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
@@ -1142,6 +1094,48 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1142
1094
  * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
1143
1095
  */
1144
1096
  homePageSearchBarMode?: HomePageSearchBarMode;
1097
+ /**
1098
+ * This flag is used to enable the compact header in liveboard
1099
+ * @type {boolean}
1100
+ * @default false
1101
+ * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
1102
+ * @example
1103
+ * ```js
1104
+ * const embed = new AppEmbed('#embed-container', {
1105
+ * ... // other options
1106
+ * isLiveboardCompactHeaderEnabled: true,
1107
+ * })
1108
+ * ```
1109
+ */
1110
+ isLiveboardCompactHeaderEnabled?: boolean;
1111
+ /**
1112
+ * This flag is used to show/hide verified Icon in liveboard compact header
1113
+ * @type {boolean}
1114
+ * @default true
1115
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1116
+ * @example
1117
+ * ```js
1118
+ * const embed = new AppEmbed('#embed-container', {
1119
+ * ... // other options
1120
+ * showLiveboardVerifiedBadge: true,
1121
+ * })
1122
+ * ```
1123
+ */
1124
+ showLiveboardVerifiedBadge?: boolean;
1125
+ /**
1126
+ * This flag is used to show/hide re-verify banner in liveboard compact header
1127
+ * @type {boolean}
1128
+ * @default true
1129
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1130
+ * @example
1131
+ * ```js
1132
+ * const embed = new AppEmbed('#embed-container', {
1133
+ * ... // other options
1134
+ * showLiveboardReverifyBanner: true,
1135
+ * })
1136
+ * ```
1137
+ */
1138
+ showLiveboardReverifyBanner?: boolean;
1145
1139
  }
1146
1140
  /**
1147
1141
  * Embeds full ThoughtSpot experience in a host application.
@@ -1451,6 +1445,48 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1451
1445
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
1452
1446
  */
1453
1447
  showPreviewLoader?: boolean;
1448
+ /**
1449
+ * This flag is used to enable the compact header in liveboard
1450
+ * @type {boolean}
1451
+ * @default false
1452
+ * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
1453
+ * @example
1454
+ * ```js
1455
+ * const embed = new LiveboardEmbed('#embed-container', {
1456
+ * ... // other options
1457
+ * isLiveboardCompactHeaderEnabled: true,
1458
+ * })
1459
+ * ```
1460
+ */
1461
+ isLiveboardCompactHeaderEnabled?: boolean;
1462
+ /**
1463
+ * This flag is used to show/hide verified Icon in liveboard compact header
1464
+ * @type {boolean}
1465
+ * @default true
1466
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1467
+ * @example
1468
+ * ```js
1469
+ * const embed = new LiveboardEmbed('#embed-container', {
1470
+ * ... // other options
1471
+ * showLiveboardVerifiedBadge: true,
1472
+ * })
1473
+ * ```
1474
+ */
1475
+ showLiveboardVerifiedBadge?: boolean;
1476
+ /**
1477
+ * This flag is used to show/hide re-verify banner in liveboard compact header
1478
+ * @type {boolean}
1479
+ * @default true
1480
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1481
+ * @example
1482
+ * ```js
1483
+ * const embed = new LiveboardEmbed('#embed-container', {
1484
+ * ... // other options
1485
+ * showLiveboardReverifyBanner: true,
1486
+ * })
1487
+ * ```
1488
+ */
1489
+ showLiveboardReverifyBanner?: boolean;
1454
1490
  }
1455
1491
  /**
1456
1492
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1952,13 +1988,6 @@ export interface EmbedConfig {
1952
1988
  * @default false
1953
1989
  */
1954
1990
  queueMultiRenders?: boolean;
1955
- /**
1956
- * Dynamic CSS URL to be injected in the loaded application.
1957
- * You would also need to set `style-src` in the CSP settings.
1958
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1959
- * @default ''
1960
- */
1961
- customCssUrl?: string;
1962
1991
  /**
1963
1992
  * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
1964
1993
  * additional call. This is slower and should be avoided. Listen to the
@@ -2087,6 +2116,12 @@ export interface EmbedConfig {
2087
2116
  * @version SDK: 1.28.5 | Thoughtspot: *
2088
2117
  */
2089
2118
  disableTokenVerification?: boolean;
2119
+ /**
2120
+ * This flag is used to disable showing the login failure page in the embedded app.
2121
+ *
2122
+ * @version SDK 1.32.3 | Thoughtspot: *
2123
+ */
2124
+ disableLoginFailurePage?: boolean;
2090
2125
  }
2091
2126
  export interface LayoutConfig {
2092
2127
  }
@@ -2209,11 +2244,12 @@ export interface ViewConfig {
2209
2244
  */
2210
2245
  visibleActions?: Action[];
2211
2246
  /**
2212
- * Show alert messages and toast messages in the embedded view.
2247
+ * Show alert messages and toast messages in the embedded
2248
+ * view in full app embed.
2213
2249
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2214
2250
  * @example
2215
2251
  * ```js
2216
- * const embed = new LiveboardEmbed('#embed-container', {
2252
+ * const embed = new AppEmbed('#embed-container', {
2217
2253
  * ... // other options
2218
2254
  * showAlerts:true,
2219
2255
  * })
@@ -2534,6 +2570,32 @@ export interface ViewConfig {
2534
2570
  * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
2535
2571
  */
2536
2572
  disableRedirectionLinksInNewTab?: boolean;
2573
+ /**
2574
+ * Flag to control Data panel experience
2575
+ * @default true
2576
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2577
+ * @example
2578
+ * ```js
2579
+ * const embed = new AppEmbed('#tsEmbed', {
2580
+ * ... // other options
2581
+ * dataPanelV2: true,
2582
+ * })
2583
+ * ```
2584
+ */
2585
+ dataPanelV2?: boolean;
2586
+ /**
2587
+ * To enable custom column groups in data panel v2
2588
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
2589
+ * @default false
2590
+ * @example
2591
+ * ```js
2592
+ * const embed = new SearchEmbed('#tsEmbed', {
2593
+ * ... // other options
2594
+ * enableCustomColumnGroups: true,
2595
+ * });
2596
+ * ```
2597
+ */
2598
+ enableCustomColumnGroups?: boolean;
2537
2599
  }
2538
2600
  /**
2539
2601
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2730,6 +2792,28 @@ export interface RuntimeParameter {
2730
2792
  * console.log('Drilldown event', drilldown);
2731
2793
  * }));
2732
2794
  * ```
2795
+ *
2796
+ * If you are using React components for embedding, you can register to any
2797
+ * events from the `EmbedEvent` list by using the `on<EventName>` convention.
2798
+ * For example,`onAlert`, `onCopyToClipboard` and so on.
2799
+ *
2800
+ * @example
2801
+ * ```js
2802
+ * // ...
2803
+ * const MyComponent = ({ dataSources }) => {
2804
+ * const onLoad = () => {
2805
+ * console.log(EmbedEvent.Load, {});
2806
+ * };
2807
+ *
2808
+ * return (
2809
+ * <SearchEmbed
2810
+ * dataSources={dataSources}
2811
+ * onLoad = {logEvent("Load")}
2812
+ * />
2813
+ * );
2814
+ * };
2815
+ * ```
2816
+ *
2733
2817
  * @group Events
2734
2818
  */
2735
2819
  export declare enum EmbedEvent {
@@ -3598,21 +3682,61 @@ export declare enum EmbedEvent {
3598
3682
  */
3599
3683
  Rename = "rename",
3600
3684
  /**
3601
- * Emitted when user wants to intercept the search execution
3685
+ * Emitted if the user wants to intercept the search execution
3686
+ * and implement logic to decide whether to run the search or not
3602
3687
  *
3603
- * Set IsOnBeforeGetVizDataInterceptEnabled : true to use
3604
- * this embed event
3688
+ * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
3689
+ * for this embed event to get emitted.
3605
3690
  *
3691
+ * @param: payload
3692
+ * @param: responder
3693
+ * Contains elements that lets developers define whether ThoughtSpot
3694
+ * will run the search or not, and if not, which error message to provide.
3695
+ *
3696
+ * execute: When execute returns true, the search will be run.
3697
+ * When execute returns false, the search will not be executed.
3698
+ *
3699
+ * error: Developers can customize the user facing message when execute is
3700
+ * set to false using the error parameter in responder
3701
+ *
3702
+ * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
3703
+ *
3704
+ * @example
3606
3705
  *```js
3607
- * searchEmbed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
3706
+ * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
3608
3707
  * (payload, responder) => {
3609
3708
  * responder({
3610
3709
  * data: {
3611
- * execute: true,
3612
- * }})
3710
+ * execute:false,
3711
+ * error: {
3712
+ * //Provide a custom error message to explain to your end user
3713
+ * //why their search did not run
3714
+ * errorText: "This search query cannot be run.
3715
+ * Please contact your administrator for more details."
3716
+ * }
3717
+ * }})
3718
+ * })
3719
+ * ```
3720
+ *
3721
+ *```js
3722
+ * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
3723
+ * (payload, responder) => {
3724
+ * const query = payload.data.data.answer.search_query
3725
+ * responder({
3726
+ * data: {
3727
+ * // returns true as long as the query does not include
3728
+ * // both the 'sales' AND the 'county' column
3729
+ * execute: !(query.includes("sales")&&query.includes("county")),
3730
+ * error: {
3731
+ * //Provide a custom error message to explain to your end user
3732
+ * // why their search did not run, and which searches are accepted by your custom logic.
3733
+ * errorText: "You can't use this query :" + query + ".
3734
+ * The 'sales' measures can never be used at the 'county' level.
3735
+ * Please try another measure, or remove 'county' from your search."
3736
+ * }
3737
+ * }})
3613
3738
  * })
3614
3739
  *```
3615
- * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
3616
3740
  */
3617
3741
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
3618
3742
  /**
@@ -3630,7 +3754,7 @@ export declare enum EmbedEvent {
3630
3754
  }
3631
3755
  /**
3632
3756
  * Event types that can be triggered by the host application
3633
- * to the embedded ThoughtSpot app
3757
+ * to the embedded ThoughtSpot app.
3634
3758
  *
3635
3759
  * To trigger an event use the corresponding
3636
3760
  * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
@@ -3647,6 +3771,40 @@ export declare enum EmbedEvent {
3647
3771
  * { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
3648
3772
  * ]);
3649
3773
  * ```
3774
+ * @example
3775
+ * If using React components to embed, use the format shown in this example:
3776
+ *
3777
+ * ```js
3778
+ * const selectVizs = () => {
3779
+ * embedRef.current.trigger(HostEvent.SetVisibleVizs, [
3780
+ * "715e4613-c891-4884-be44-aa8d13701c06",
3781
+ * "3f84d633-e325-44b2-be25-c6650e5a49cf"
3782
+ * ]);
3783
+ * };
3784
+ * ```
3785
+ *
3786
+ *
3787
+ * You can also attach an Embed event to a Host event to trigger
3788
+ * a specific action as shown in this example:
3789
+ *
3790
+ * @example
3791
+ * ```js
3792
+ * const EmbeddedComponent = () => {
3793
+ * const embedRef = useRef(null); // import { useRef } from react
3794
+ * const onLiveboardRendered = () => {
3795
+ * embedRef.current.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
3796
+ * };
3797
+ *
3798
+ * return (
3799
+ * <LiveboardEmbed
3800
+ * ref={embedRef}
3801
+ * liveboardId="<liveboard-guid>"
3802
+ * onLiveboardRendered={onLiveboardRendered}
3803
+ * />
3804
+ * );
3805
+ * }
3806
+ * ```
3807
+ *
3650
3808
  * @group Events
3651
3809
  */
3652
3810
  export declare enum HostEvent {
@@ -3730,6 +3888,15 @@ export declare enum HostEvent {
3730
3888
  * @hidden
3731
3889
  */
3732
3890
  Reload = "reload",
3891
+ /**
3892
+ * Get current iframe src
3893
+ * @example
3894
+ * ```js
3895
+ * const frameUrl = AppEmbed.trigger(HostEvent.GetIframeUrl)
3896
+ * ```
3897
+ * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
3898
+ */
3899
+ GetIframeUrl = "GetIframeUrl",
3733
3900
  /**
3734
3901
  * Display specific visualizations on a Liveboard.
3735
3902
  * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
@@ -4331,11 +4498,24 @@ export declare enum HostEvent {
4331
4498
  * filter: {
4332
4499
  * column: "item type",
4333
4500
  * oper: "IN",
4334
- * values: ["bags","shirts"],
4501
+ * values: ["bags","shirts"]
4335
4502
  * }
4336
4503
  * });
4337
4504
  * ```
4338
4505
  * @example
4506
+ * ```js
4507
+ *
4508
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
4509
+ * filter: {
4510
+ * column: "date",
4511
+ * oper: "EQ",
4512
+ * values: ["JULY","2023"],
4513
+ * type: "MONTH_YEAR"
4514
+ * }
4515
+ * });
4516
+ * ```
4517
+ *
4518
+ * @example
4339
4519
  *
4340
4520
  * ```js
4341
4521
  * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
@@ -4352,7 +4532,8 @@ export declare enum HostEvent {
4352
4532
  * {
4353
4533
  * column: "Date",
4354
4534
  * oper: 'EQ',
4355
- * values: ["1656680400"]
4535
+ * values: ["2023-07-31"],
4536
+ * types: "EXACT_DATE"
4356
4537
  * }]
4357
4538
  * });
4358
4539
  * ```
@@ -4538,7 +4719,6 @@ export declare enum Param {
4538
4719
  ViewPortHeight = "viewPortHeight",
4539
4720
  ViewPortWidth = "viewPortWidth",
4540
4721
  VisibleActions = "visibleAction",
4541
- CustomCSSUrl = "customCssUrl",
4542
4722
  DisableLoginRedirect = "disableLoginRedirect",
4543
4723
  visibleVizs = "pinboardVisibleVizs",
4544
4724
  LiveboardV2Enabled = "isPinboardV2Enabled",
@@ -4595,7 +4775,10 @@ export declare enum Param {
4595
4775
  IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
4596
4776
  FocusSearchBarOnRender = "focusSearchBarOnRender",
4597
4777
  DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab",
4598
- HomePageSearchBarMode = "homePageSearchBarMode"
4778
+ HomePageSearchBarMode = "homePageSearchBarMode",
4779
+ ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
4780
+ ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
4781
+ LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled"
4599
4782
  }
4600
4783
  /**
4601
4784
  * ThoughtSpot application pages include actions and menu commands
@@ -5517,7 +5700,7 @@ export declare enum Action {
5517
5700
  *
5518
5701
  * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
5519
5702
  */
5520
- CreateLiveboard = "CreateLiveboard",
5703
+ CreateLiveboard = "createLiveboard",
5521
5704
  /**
5522
5705
  * Action ID for to hide Verified Liveboard Banner
5523
5706
  * @example
@@ -5608,6 +5791,16 @@ export declare enum Action {
5608
5791
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5609
5792
  */
5610
5793
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
5794
+ /**
5795
+ * The **Manage Tags** action on Homepage Favourite Module.
5796
+ *
5797
+ * @example
5798
+ * ```js
5799
+ * disabledActions: [Action.ManageTags]
5800
+ * ```
5801
+ * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
5802
+ */
5803
+ ManageTags = "manageTags",
5611
5804
  /**
5612
5805
  * Action ID for delete schedule action on schedule on homepage
5613
5806
  * @example
@@ -6042,7 +6235,6 @@ export declare class V1Embed extends TsEmbed {
6042
6235
  on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
6043
6236
  /**
6044
6237
  * Only for testing purposes.
6045
- *
6046
6238
  * @hidden
6047
6239
  */
6048
6240
  test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
@@ -6125,22 +6317,23 @@ export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise
6125
6317
  /**
6126
6318
  * Imports TML representation of the metadata objects into ThoughtSpot.
6127
6319
  * @param data
6320
+ * @returns imports TML data into ThoughtSpot
6128
6321
  * @example
6129
6322
  * ```js
6130
- * executeTML({
6131
- * //Array of metadata Tmls
6132
- metadata_tmls: [
6133
- "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
6134
- \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
6135
- ],
6136
- import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
6137
- create_new: false, // If selected, creates TML objects with new GUIDs.
6138
- }).then(result => {
6139
- console.log(result);
6140
- }).catch(error => {
6141
- console.error(error);
6142
- });
6143
- *
6323
+ * executeTML({
6324
+ * //Array of metadata Tmls in string format
6325
+ * metadata_tmls: [
6326
+ * "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
6327
+ * \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
6328
+ * ],
6329
+ * import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
6330
+ * create_new: false, // If selected, creates TML objects with new GUIDs.
6331
+ * }).then(result => {
6332
+ * console.log(result);
6333
+ * }).catch(error => {
6334
+ * console.error(error);
6335
+ * });
6336
+ *```
6144
6337
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
6145
6338
  * @group Global methods
6146
6339
  */
@@ -6149,27 +6342,28 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
6149
6342
  * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
6150
6343
  * format.
6151
6344
  * @param data
6345
+ * @returns exports TML data
6152
6346
  * @example
6153
6347
  * ```js
6154
- exportTML({
6155
- metadata: [
6156
- {
6157
- type: "LIVEBOARD", //Metadata Type
6158
- identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
6159
- }
6160
- ],
6161
- export_associated: false,//indicates whether to export associated metadata objects
6162
- export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
6163
- //exporting a Liveboard and its associated objects, the API
6164
- //returns the Liveboard TML data with the FQNs of the referenced
6165
- //worksheet. If the exported TML data includes FQNs, you don't need
6166
- //to manually add FQNs of the referenced objects during TML import.
6167
- edoc_format: "JSON" //It takes JSON or YAML value
6168
- }).then(result => {
6169
- console.log(result);
6170
- }).catch(error => {
6171
- console.error(error);
6172
- });
6348
+ * exportTML({
6349
+ * metadata: [
6350
+ * {
6351
+ * type: "LIVEBOARD", //Metadata Type
6352
+ * identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
6353
+ * }
6354
+ * ],
6355
+ * export_associated: false,//indicates whether to export associated metadata objects
6356
+ * export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
6357
+ * //exporting a Liveboard and its associated objects, the API
6358
+ * //returns the Liveboard TML data with the FQNs of the referenced
6359
+ * //worksheet. If the exported TML data includes FQNs, you don't need
6360
+ * //to manually add FQNs of the referenced objects during TML import.
6361
+ * edoc_format: "JSON" //It takes JSON or YAML value
6362
+ * }).then(result => {
6363
+ * console.log(result);
6364
+ * }).catch(error => {
6365
+ * console.error(error);
6366
+ * });
6173
6367
  * ```
6174
6368
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
6175
6369
  * @group Global methods
@@ -6438,9 +6632,12 @@ export interface CustomCssVariables {
6438
6632
  */
6439
6633
  '--ts-var-root-text-transform'?: string;
6440
6634
  /**
6441
- * application color, it replaces #2770EF which is rd-color(blue,base) and
6442
- * its similar colors like rd-color(blue,60), rd-color(accent, base) and
6443
- * rd-color(text, accent) in the app.
6635
+ * Font color of the text on toggle buttons such as
6636
+ * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience),
6637
+ * the text color of the chart and table tiles on Home page (New modular Homepage experience),
6638
+ * and title text on the AI-generated charts and tables.
6639
+ * The default color code is #2770EF.
6640
+ *
6444
6641
  */
6445
6642
  '--ts-var-application-color'?: string;
6446
6643
  /**
@@ -6551,6 +6748,10 @@ export interface CustomCssVariables {
6551
6748
  * Background color of the primary buttons on hover.
6552
6749
  */
6553
6750
  '--ts-var-button--primary--hover-background'?: string;
6751
+ /**
6752
+ * Backgroud color of the primary buttons when active.
6753
+ */
6754
+ '--ts-var-button--primary--active-background'?: string;
6554
6755
  /**
6555
6756
  * Font color of the text on the secondary buttons.
6556
6757
  */
@@ -6567,6 +6768,10 @@ export interface CustomCssVariables {
6567
6768
  * Background color of the secondary button on hover.
6568
6769
  */
6569
6770
  '--ts-var-button--secondary--hover-background'?: string;
6771
+ /**
6772
+ * Backgroud color of the secondary buttons when active.
6773
+ */
6774
+ '--ts-var-button--secondary--active-background'?: string;
6570
6775
  /**
6571
6776
  * Font color of the tertiary button. For example, the *Undo*, *Redo*, and *Reset*
6572
6777
  * buttons on the *Search* page.
@@ -6580,6 +6785,10 @@ export interface CustomCssVariables {
6580
6785
  * Background color of the tertiary button when a user hovers over these buttons.
6581
6786
  */
6582
6787
  '--ts-var-button--tertiary--hover-background'?: string;
6788
+ /**
6789
+ * Backgroud color of the tertiary buttons when active.
6790
+ */
6791
+ '--ts-var-button--tertiary--active-background'?: string;
6583
6792
  /**
6584
6793
  * Font color of the title text of a visualization or Answer.
6585
6794
  */
@@ -6755,6 +6964,34 @@ export interface CustomCssVariables {
6755
6964
  * Background for favorite carousel find your favorites card in modular home.
6756
6965
  */
6757
6966
  '--ts-var-home-favorite-suggestion-card-background'?: string;
6967
+ /**
6968
+ * Border color of checkbox in error state.
6969
+ */
6970
+ '--ts-var-checkbox-error-border'?: string;
6971
+ /**
6972
+ * Border color of checkbox.
6973
+ */
6974
+ '--ts-var-checkbox-border-color'?: string;
6975
+ /**
6976
+ * Border color of checkbox in hover state.
6977
+ */
6978
+ '--ts-var-checkbox-hover-border'?: string;
6979
+ /**
6980
+ * Border and font color of checkbox in active state.
6981
+ */
6982
+ '--ts-var-checkbox-active-color'?: string;
6983
+ /**
6984
+ * Border color and font color of checkbox in checked state.
6985
+ */
6986
+ '--ts-var-checkbox-checked-color'?: string;
6987
+ /**
6988
+ * Border and font color of checkbox in disabled state.
6989
+ */
6990
+ '--ts-var-checkbox-checked-disabled'?: string;
6991
+ /**
6992
+ * Background color of checkbox.
6993
+ */
6994
+ '--ts-var-checkbox-background-color'?: string;
6758
6995
  }
6759
6996
 
6760
6997
  export interface SessionInterface {
@@ -6850,6 +7087,7 @@ export declare class AnswerService {
6850
7087
  * @returns
6851
7088
  */
6852
7089
  addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
7090
+ getSQLQuery(): Promise<string>;
6853
7091
  /**
6854
7092
  * Fetch data from the answer.
6855
7093
  * @param offset
@@ -6868,6 +7106,15 @@ export declare class AnswerService {
6868
7106
  * @returns Response
6869
7107
  */
6870
7108
  fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
7109
+ /**
7110
+ * Fetch the data for the answer as a PNG blob. This might be
7111
+ * quicker for larger data.
7112
+ * @param userLocale
7113
+ * @param omitBackground Omit the background in the PNG
7114
+ * @param deviceScaleFactor The scale factor for the PNG
7115
+ * @return Response
7116
+ */
7117
+ fetchPNGBlob(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>;
6871
7118
  /**
6872
7119
  * Just get the internal URL for this answer's data
6873
7120
  * as a CSV blob.
@@ -6876,6 +7123,11 @@ export declare class AnswerService {
6876
7123
  * @returns
6877
7124
  */
6878
7125
  getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string;
7126
+ /**
7127
+ * Just get the internal URL for this answer's data
7128
+ * as a PNG blob.
7129
+ */
7130
+ getFetchPNGBlobUrl(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): string;
6879
7131
  /**
6880
7132
  * Get underlying data given a point and the output column names.
6881
7133
  * In case of a context menu action, the selectedPoints are
@@ -6928,6 +7180,10 @@ export declare const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
6928
7180
  export declare const EndPoints: {
6929
7181
  CONFIG: string;
6930
7182
  };
7183
+ /**
7184
+ * Enum of mixpanel events
7185
+ * @hidden
7186
+ */
6931
7187
  export declare const MIXPANEL_EVENT: {
6932
7188
  VISUAL_SDK_RENDER_START: string;
6933
7189
  VISUAL_SDK_CALLED_INIT: string;