@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
@@ -72,7 +72,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
72
72
  /**
73
73
  * SpotIQ listing page
74
74
  */
75
- SpotIQ = "insights"
75
+ SpotIQ = "insights",
76
+ /**
77
+ * Monitor Alerts Page
78
+ */
79
+ Monitor = "monitor"
76
80
  }
77
81
  /**
78
82
  * Define the initial state os column custom group accordions
@@ -283,19 +287,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
283
287
  * ```
284
288
  */
285
289
  fullHeight?: boolean;
286
- /**
287
- * Flag to control Data panel experience
288
- * @default true
289
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
290
- * @example
291
- * ```js
292
- * const embed = new AppEmbed('#tsEmbed', {
293
- * ... // other options
294
- * dataPanelV2: true,
295
- * })
296
- * ```
297
- */
298
- dataPanelV2?: boolean;
299
290
  /**
300
291
  * Show or hide Liveboard header
301
292
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
@@ -373,19 +364,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
373
364
  * @deprecated Use {@link collapseSearchBar} instead
374
365
  */
375
366
  collapseSearchBarInitially?: boolean;
376
- /**
377
- * To enable custom column groups in data panel v2.
378
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
379
- * @default false
380
- * @example
381
- * ```js
382
- * const embed = new AppEmbed('#embed', {
383
- * ... // other app view config
384
- * enableCustomColumnGroups: true,
385
- * });
386
- * ```
387
- */
388
- enableCustomColumnGroups?: boolean;
389
367
  /**
390
368
  * This controls the initial behaviour of custom column groups accordion.
391
369
  * It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
@@ -429,6 +407,48 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
429
407
  * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
430
408
  */
431
409
  homePageSearchBarMode?: HomePageSearchBarMode;
410
+ /**
411
+ * This flag is used to enable the compact header in liveboard
412
+ * @type {boolean}
413
+ * @default false
414
+ * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
415
+ * @example
416
+ * ```js
417
+ * const embed = new AppEmbed('#embed-container', {
418
+ * ... // other options
419
+ * isLiveboardCompactHeaderEnabled: true,
420
+ * })
421
+ * ```
422
+ */
423
+ isLiveboardCompactHeaderEnabled?: boolean;
424
+ /**
425
+ * This flag is used to show/hide verified Icon in liveboard compact header
426
+ * @type {boolean}
427
+ * @default true
428
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
429
+ * @example
430
+ * ```js
431
+ * const embed = new AppEmbed('#embed-container', {
432
+ * ... // other options
433
+ * showLiveboardVerifiedBadge: true,
434
+ * })
435
+ * ```
436
+ */
437
+ showLiveboardVerifiedBadge?: boolean;
438
+ /**
439
+ * This flag is used to show/hide re-verify banner in liveboard compact header
440
+ * @type {boolean}
441
+ * @default true
442
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
443
+ * @example
444
+ * ```js
445
+ * const embed = new AppEmbed('#embed-container', {
446
+ * ... // other options
447
+ * showLiveboardReverifyBanner: true,
448
+ * })
449
+ * ```
450
+ */
451
+ showLiveboardReverifyBanner?: boolean;
432
452
  }
433
453
  /**
434
454
  * Embeds full ThoughtSpot experience in a host application.
@@ -554,22 +574,23 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
554
574
  /**
555
575
  * Imports TML representation of the metadata objects into ThoughtSpot.
556
576
  * @param data
577
+ * @returns imports TML data into ThoughtSpot
557
578
  * @example
558
579
  * ```js
559
- * executeTML({
560
- * //Array of metadata Tmls
561
- metadata_tmls: [
562
- "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
563
- \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
564
- ],
565
- import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
566
- create_new: false, // If selected, creates TML objects with new GUIDs.
567
- }).then(result => {
568
- console.log(result);
569
- }).catch(error => {
570
- console.error(error);
571
- });
572
- *
580
+ * executeTML({
581
+ * //Array of metadata Tmls in string format
582
+ * metadata_tmls: [
583
+ * "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
584
+ * \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
585
+ * ],
586
+ * import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
587
+ * create_new: false, // If selected, creates TML objects with new GUIDs.
588
+ * }).then(result => {
589
+ * console.log(result);
590
+ * }).catch(error => {
591
+ * console.error(error);
592
+ * });
593
+ *```
573
594
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
574
595
  * @group Global methods
575
596
  */
@@ -578,27 +599,28 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
578
599
  * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
579
600
  * format.
580
601
  * @param data
602
+ * @returns exports TML data
581
603
  * @example
582
604
  * ```js
583
- exportTML({
584
- metadata: [
585
- {
586
- type: "LIVEBOARD", //Metadata Type
587
- identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
588
- }
589
- ],
590
- export_associated: false,//indicates whether to export associated metadata objects
591
- export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
592
- //exporting a Liveboard and its associated objects, the API
593
- //returns the Liveboard TML data with the FQNs of the referenced
594
- //worksheet. If the exported TML data includes FQNs, you don't need
595
- //to manually add FQNs of the referenced objects during TML import.
596
- edoc_format: "JSON" //It takes JSON or YAML value
597
- }).then(result => {
598
- console.log(result);
599
- }).catch(error => {
600
- console.error(error);
601
- });
605
+ * exportTML({
606
+ * metadata: [
607
+ * {
608
+ * type: "LIVEBOARD", //Metadata Type
609
+ * identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
610
+ * }
611
+ * ],
612
+ * export_associated: false,//indicates whether to export associated metadata objects
613
+ * export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
614
+ * //exporting a Liveboard and its associated objects, the API
615
+ * //returns the Liveboard TML data with the FQNs of the referenced
616
+ * //worksheet. If the exported TML data includes FQNs, you don't need
617
+ * //to manually add FQNs of the referenced objects during TML import.
618
+ * edoc_format: "JSON" //It takes JSON or YAML value
619
+ * }).then(result => {
620
+ * console.log(result);
621
+ * }).catch(error => {
622
+ * console.error(error);
623
+ * });
602
624
  * ```
603
625
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
604
626
  * @group Global methods
@@ -878,6 +900,48 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
878
900
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
879
901
  */
880
902
  showPreviewLoader?: boolean;
903
+ /**
904
+ * This flag is used to enable the compact header in liveboard
905
+ * @type {boolean}
906
+ * @default false
907
+ * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
908
+ * @example
909
+ * ```js
910
+ * const embed = new LiveboardEmbed('#embed-container', {
911
+ * ... // other options
912
+ * isLiveboardCompactHeaderEnabled: true,
913
+ * })
914
+ * ```
915
+ */
916
+ isLiveboardCompactHeaderEnabled?: boolean;
917
+ /**
918
+ * This flag is used to show/hide verified Icon in liveboard compact header
919
+ * @type {boolean}
920
+ * @default true
921
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
922
+ * @example
923
+ * ```js
924
+ * const embed = new LiveboardEmbed('#embed-container', {
925
+ * ... // other options
926
+ * showLiveboardVerifiedBadge: true,
927
+ * })
928
+ * ```
929
+ */
930
+ showLiveboardVerifiedBadge?: boolean;
931
+ /**
932
+ * This flag is used to show/hide re-verify banner in liveboard compact header
933
+ * @type {boolean}
934
+ * @default true
935
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
936
+ * @example
937
+ * ```js
938
+ * const embed = new LiveboardEmbed('#embed-container', {
939
+ * ... // other options
940
+ * showLiveboardReverifyBanner: true,
941
+ * })
942
+ * ```
943
+ */
944
+ showLiveboardReverifyBanner?: boolean;
881
945
  }
882
946
  /**
883
947
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1127,19 +1191,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1127
1191
  * ```
1128
1192
  */
1129
1193
  hideSearchBar?: boolean;
1130
- /**
1131
- * Flag to control Data panel experience
1132
- * @default true
1133
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1134
- * @example
1135
- * ```js
1136
- * const embed = new SearchEmbed('#tsEmbed', {
1137
- * ... // other options
1138
- * dataPanelV2:false,
1139
- * })
1140
- * ```
1141
- */
1142
- dataPanelV2?: boolean;
1143
1194
  /**
1144
1195
  * Flag to set if last selected dataSource should be used
1145
1196
  * @version: SDK: 1.24.0
@@ -1152,19 +1203,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1152
1203
  * @deprecated Use {@link collapseSearchBar} instead
1153
1204
  */
1154
1205
  collapseSearchBarInitially?: boolean;
1155
- /**
1156
- * To enable custom column groups in data panel v2
1157
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1158
- * @default false
1159
- * @example
1160
- * ```js
1161
- * const embed = new SearchEmbed('#tsEmbed', {
1162
- * ... // other options
1163
- * enableCustomColumnGroups: true,
1164
- * });
1165
- * ```
1166
- */
1167
- enableCustomColumnGroups?: boolean;
1168
1206
  /**
1169
1207
  * Flag to enable onBeforeSearchExecute Embed Event
1170
1208
  * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
@@ -1991,13 +2029,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1991
2029
  * @default false
1992
2030
  */
1993
2031
  queueMultiRenders?: boolean;
1994
- /**
1995
- * Dynamic CSS URL to be injected in the loaded application.
1996
- * You would also need to set `style-src` in the CSP settings.
1997
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1998
- * @default ''
1999
- */
2000
- customCssUrl?: string;
2001
2032
  /**
2002
2033
  * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
2003
2034
  * additional call. This is slower and should be avoided. Listen to the
@@ -2126,6 +2157,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2126
2157
  * @version SDK: 1.28.5 | Thoughtspot: *
2127
2158
  */
2128
2159
  disableTokenVerification?: boolean;
2160
+ /**
2161
+ * This flag is used to disable showing the login failure page in the embedded app.
2162
+ *
2163
+ * @version SDK 1.32.3 | Thoughtspot: *
2164
+ */
2165
+ disableLoginFailurePage?: boolean;
2129
2166
  }
2130
2167
  export interface LayoutConfig {
2131
2168
  }
@@ -2248,11 +2285,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2248
2285
  */
2249
2286
  visibleActions?: Action[];
2250
2287
  /**
2251
- * Show alert messages and toast messages in the embedded view.
2288
+ * Show alert messages and toast messages in the embedded
2289
+ * view in full app embed.
2252
2290
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2253
2291
  * @example
2254
2292
  * ```js
2255
- * const embed = new LiveboardEmbed('#embed-container', {
2293
+ * const embed = new AppEmbed('#embed-container', {
2256
2294
  * ... // other options
2257
2295
  * showAlerts:true,
2258
2296
  * })
@@ -2573,6 +2611,32 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2573
2611
  * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
2574
2612
  */
2575
2613
  disableRedirectionLinksInNewTab?: boolean;
2614
+ /**
2615
+ * Flag to control Data panel experience
2616
+ * @default true
2617
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2618
+ * @example
2619
+ * ```js
2620
+ * const embed = new AppEmbed('#tsEmbed', {
2621
+ * ... // other options
2622
+ * dataPanelV2: true,
2623
+ * })
2624
+ * ```
2625
+ */
2626
+ dataPanelV2?: boolean;
2627
+ /**
2628
+ * To enable custom column groups in data panel v2
2629
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
2630
+ * @default false
2631
+ * @example
2632
+ * ```js
2633
+ * const embed = new SearchEmbed('#tsEmbed', {
2634
+ * ... // other options
2635
+ * enableCustomColumnGroups: true,
2636
+ * });
2637
+ * ```
2638
+ */
2639
+ enableCustomColumnGroups?: boolean;
2576
2640
  }
2577
2641
  /**
2578
2642
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2769,6 +2833,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2769
2833
  * console.log('Drilldown event', drilldown);
2770
2834
  * }));
2771
2835
  * ```
2836
+ *
2837
+ * If you are using React components for embedding, you can register to any
2838
+ * events from the `EmbedEvent` list by using the `on<EventName>` convention.
2839
+ * For example,`onAlert`, `onCopyToClipboard` and so on.
2840
+ *
2841
+ * @example
2842
+ * ```js
2843
+ * // ...
2844
+ * const MyComponent = ({ dataSources }) => {
2845
+ * const onLoad = () => {
2846
+ * console.log(EmbedEvent.Load, {});
2847
+ * };
2848
+ *
2849
+ * return (
2850
+ * <SearchEmbed
2851
+ * dataSources={dataSources}
2852
+ * onLoad = {logEvent("Load")}
2853
+ * />
2854
+ * );
2855
+ * };
2856
+ * ```
2857
+ *
2772
2858
  * @group Events
2773
2859
  */
2774
2860
  export enum EmbedEvent {
@@ -3637,21 +3723,61 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3637
3723
  */
3638
3724
  Rename = "rename",
3639
3725
  /**
3640
- * Emitted when user wants to intercept the search execution
3726
+ * Emitted if the user wants to intercept the search execution
3727
+ * and implement logic to decide whether to run the search or not
3728
+ *
3729
+ * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
3730
+ * for this embed event to get emitted.
3731
+ *
3732
+ * @param: payload
3733
+ * @param: responder
3734
+ * Contains elements that lets developers define whether ThoughtSpot
3735
+ * will run the search or not, and if not, which error message to provide.
3641
3736
  *
3642
- * Set IsOnBeforeGetVizDataInterceptEnabled : true to use
3643
- * this embed event
3737
+ * execute: When execute returns true, the search will be run.
3738
+ * When execute returns false, the search will not be executed.
3739
+ *
3740
+ * error: Developers can customize the user facing message when execute is
3741
+ * set to false using the error parameter in responder
3742
+ *
3743
+ * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
3644
3744
  *
3745
+ * @example
3645
3746
  *```js
3646
- * searchEmbed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
3747
+ * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
3647
3748
  * (payload, responder) => {
3648
3749
  * responder({
3649
3750
  * data: {
3650
- * execute: true,
3651
- * }})
3751
+ * execute:false,
3752
+ * error: {
3753
+ * //Provide a custom error message to explain to your end user
3754
+ * //why their search did not run
3755
+ * errorText: "This search query cannot be run.
3756
+ * Please contact your administrator for more details."
3757
+ * }
3758
+ * }})
3759
+ * })
3760
+ * ```
3761
+ *
3762
+ *```js
3763
+ * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
3764
+ * (payload, responder) => {
3765
+ * const query = payload.data.data.answer.search_query
3766
+ * responder({
3767
+ * data: {
3768
+ * // returns true as long as the query does not include
3769
+ * // both the 'sales' AND the 'county' column
3770
+ * execute: !(query.includes("sales")&&query.includes("county")),
3771
+ * error: {
3772
+ * //Provide a custom error message to explain to your end user
3773
+ * // why their search did not run, and which searches are accepted by your custom logic.
3774
+ * errorText: "You can't use this query :" + query + ".
3775
+ * The 'sales' measures can never be used at the 'county' level.
3776
+ * Please try another measure, or remove 'county' from your search."
3777
+ * }
3778
+ * }})
3652
3779
  * })
3653
3780
  *```
3654
- * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
3655
3781
  */
3656
3782
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
3657
3783
  /**
@@ -3669,7 +3795,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3669
3795
  }
3670
3796
  /**
3671
3797
  * Event types that can be triggered by the host application
3672
- * to the embedded ThoughtSpot app
3798
+ * to the embedded ThoughtSpot app.
3673
3799
  *
3674
3800
  * To trigger an event use the corresponding
3675
3801
  * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
@@ -3686,6 +3812,40 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3686
3812
  * { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
3687
3813
  * ]);
3688
3814
  * ```
3815
+ * @example
3816
+ * If using React components to embed, use the format shown in this example:
3817
+ *
3818
+ * ```js
3819
+ * const selectVizs = () => {
3820
+ * embedRef.current.trigger(HostEvent.SetVisibleVizs, [
3821
+ * "715e4613-c891-4884-be44-aa8d13701c06",
3822
+ * "3f84d633-e325-44b2-be25-c6650e5a49cf"
3823
+ * ]);
3824
+ * };
3825
+ * ```
3826
+ *
3827
+ *
3828
+ * You can also attach an Embed event to a Host event to trigger
3829
+ * a specific action as shown in this example:
3830
+ *
3831
+ * @example
3832
+ * ```js
3833
+ * const EmbeddedComponent = () => {
3834
+ * const embedRef = useRef(null); // import { useRef } from react
3835
+ * const onLiveboardRendered = () => {
3836
+ * embedRef.current.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
3837
+ * };
3838
+ *
3839
+ * return (
3840
+ * <LiveboardEmbed
3841
+ * ref={embedRef}
3842
+ * liveboardId="<liveboard-guid>"
3843
+ * onLiveboardRendered={onLiveboardRendered}
3844
+ * />
3845
+ * );
3846
+ * }
3847
+ * ```
3848
+ *
3689
3849
  * @group Events
3690
3850
  */
3691
3851
  export enum HostEvent {
@@ -3769,6 +3929,15 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3769
3929
  * @hidden
3770
3930
  */
3771
3931
  Reload = "reload",
3932
+ /**
3933
+ * Get current iframe src
3934
+ * @example
3935
+ * ```js
3936
+ * const frameUrl = AppEmbed.trigger(HostEvent.GetIframeUrl)
3937
+ * ```
3938
+ * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
3939
+ */
3940
+ GetIframeUrl = "GetIframeUrl",
3772
3941
  /**
3773
3942
  * Display specific visualizations on a Liveboard.
3774
3943
  * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
@@ -4370,11 +4539,24 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4370
4539
  * filter: {
4371
4540
  * column: "item type",
4372
4541
  * oper: "IN",
4373
- * values: ["bags","shirts"],
4542
+ * values: ["bags","shirts"]
4374
4543
  * }
4375
4544
  * });
4376
4545
  * ```
4377
4546
  * @example
4547
+ * ```js
4548
+ *
4549
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
4550
+ * filter: {
4551
+ * column: "date",
4552
+ * oper: "EQ",
4553
+ * values: ["JULY","2023"],
4554
+ * type: "MONTH_YEAR"
4555
+ * }
4556
+ * });
4557
+ * ```
4558
+ *
4559
+ * @example
4378
4560
  *
4379
4561
  * ```js
4380
4562
  * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
@@ -4391,7 +4573,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4391
4573
  * {
4392
4574
  * column: "Date",
4393
4575
  * oper: 'EQ',
4394
- * values: ["1656680400"]
4576
+ * values: ["2023-07-31"],
4577
+ * types: "EXACT_DATE"
4395
4578
  * }]
4396
4579
  * });
4397
4580
  * ```
@@ -4577,7 +4760,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4577
4760
  ViewPortHeight = "viewPortHeight",
4578
4761
  ViewPortWidth = "viewPortWidth",
4579
4762
  VisibleActions = "visibleAction",
4580
- CustomCSSUrl = "customCssUrl",
4581
4763
  DisableLoginRedirect = "disableLoginRedirect",
4582
4764
  visibleVizs = "pinboardVisibleVizs",
4583
4765
  LiveboardV2Enabled = "isPinboardV2Enabled",
@@ -4634,7 +4816,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4634
4816
  IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
4635
4817
  FocusSearchBarOnRender = "focusSearchBarOnRender",
4636
4818
  DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab",
4637
- HomePageSearchBarMode = "homePageSearchBarMode"
4819
+ HomePageSearchBarMode = "homePageSearchBarMode",
4820
+ ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
4821
+ ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
4822
+ LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled"
4638
4823
  }
4639
4824
  /**
4640
4825
  * ThoughtSpot application pages include actions and menu commands
@@ -5556,7 +5741,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5556
5741
  *
5557
5742
  * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
5558
5743
  */
5559
- CreateLiveboard = "CreateLiveboard",
5744
+ CreateLiveboard = "createLiveboard",
5560
5745
  /**
5561
5746
  * Action ID for to hide Verified Liveboard Banner
5562
5747
  * @example
@@ -5647,6 +5832,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5647
5832
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5648
5833
  */
5649
5834
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
5835
+ /**
5836
+ * The **Manage Tags** action on Homepage Favourite Module.
5837
+ *
5838
+ * @example
5839
+ * ```js
5840
+ * disabledActions: [Action.ManageTags]
5841
+ * ```
5842
+ * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
5843
+ */
5844
+ ManageTags = "manageTags",
5650
5845
  /**
5651
5846
  * Action ID for delete schedule action on schedule on homepage
5652
5847
  * @example
@@ -5822,9 +6017,12 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
5822
6017
  */
5823
6018
  '--ts-var-root-text-transform'?: string;
5824
6019
  /**
5825
- * application color, it replaces #2770EF which is rd-color(blue,base) and
5826
- * its similar colors like rd-color(blue,60), rd-color(accent, base) and
5827
- * rd-color(text, accent) in the app.
6020
+ * Font color of the text on toggle buttons such as
6021
+ * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience),
6022
+ * the text color of the chart and table tiles on Home page (New modular Homepage experience),
6023
+ * and title text on the AI-generated charts and tables.
6024
+ * The default color code is #2770EF.
6025
+ *
5828
6026
  */
5829
6027
  '--ts-var-application-color'?: string;
5830
6028
  /**
@@ -5935,6 +6133,10 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
5935
6133
  * Background color of the primary buttons on hover.
5936
6134
  */
5937
6135
  '--ts-var-button--primary--hover-background'?: string;
6136
+ /**
6137
+ * Backgroud color of the primary buttons when active.
6138
+ */
6139
+ '--ts-var-button--primary--active-background'?: string;
5938
6140
  /**
5939
6141
  * Font color of the text on the secondary buttons.
5940
6142
  */
@@ -5951,6 +6153,10 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
5951
6153
  * Background color of the secondary button on hover.
5952
6154
  */
5953
6155
  '--ts-var-button--secondary--hover-background'?: string;
6156
+ /**
6157
+ * Backgroud color of the secondary buttons when active.
6158
+ */
6159
+ '--ts-var-button--secondary--active-background'?: string;
5954
6160
  /**
5955
6161
  * Font color of the tertiary button. For example, the *Undo*, *Redo*, and *Reset*
5956
6162
  * buttons on the *Search* page.
@@ -5964,6 +6170,10 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
5964
6170
  * Background color of the tertiary button when a user hovers over these buttons.
5965
6171
  */
5966
6172
  '--ts-var-button--tertiary--hover-background'?: string;
6173
+ /**
6174
+ * Backgroud color of the tertiary buttons when active.
6175
+ */
6176
+ '--ts-var-button--tertiary--active-background'?: string;
5967
6177
  /**
5968
6178
  * Font color of the title text of a visualization or Answer.
5969
6179
  */
@@ -6139,6 +6349,34 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
6139
6349
  * Background for favorite carousel find your favorites card in modular home.
6140
6350
  */
6141
6351
  '--ts-var-home-favorite-suggestion-card-background'?: string;
6352
+ /**
6353
+ * Border color of checkbox in error state.
6354
+ */
6355
+ '--ts-var-checkbox-error-border'?: string;
6356
+ /**
6357
+ * Border color of checkbox.
6358
+ */
6359
+ '--ts-var-checkbox-border-color'?: string;
6360
+ /**
6361
+ * Border color of checkbox in hover state.
6362
+ */
6363
+ '--ts-var-checkbox-hover-border'?: string;
6364
+ /**
6365
+ * Border and font color of checkbox in active state.
6366
+ */
6367
+ '--ts-var-checkbox-active-color'?: string;
6368
+ /**
6369
+ * Border color and font color of checkbox in checked state.
6370
+ */
6371
+ '--ts-var-checkbox-checked-color'?: string;
6372
+ /**
6373
+ * Border and font color of checkbox in disabled state.
6374
+ */
6375
+ '--ts-var-checkbox-checked-disabled'?: string;
6376
+ /**
6377
+ * Background color of checkbox.
6378
+ */
6379
+ '--ts-var-checkbox-background-color'?: string;
6142
6380
  }
6143
6381
  }
6144
6382
 
@@ -6387,6 +6625,7 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
6387
6625
  * @returns
6388
6626
  */
6389
6627
  addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
6628
+ getSQLQuery(): Promise<string>;
6390
6629
  /**
6391
6630
  * Fetch data from the answer.
6392
6631
  * @param offset
@@ -6405,6 +6644,15 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
6405
6644
  * @returns Response
6406
6645
  */
6407
6646
  fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
6647
+ /**
6648
+ * Fetch the data for the answer as a PNG blob. This might be
6649
+ * quicker for larger data.
6650
+ * @param userLocale
6651
+ * @param omitBackground Omit the background in the PNG
6652
+ * @param deviceScaleFactor The scale factor for the PNG
6653
+ * @return Response
6654
+ */
6655
+ fetchPNGBlob(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>;
6408
6656
  /**
6409
6657
  * Just get the internal URL for this answer's data
6410
6658
  * as a CSV blob.
@@ -6413,6 +6661,11 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
6413
6661
  * @returns
6414
6662
  */
6415
6663
  getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string;
6664
+ /**
6665
+ * Just get the internal URL for this answer's data
6666
+ * as a PNG blob.
6667
+ */
6668
+ getFetchPNGBlobUrl(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): string;
6416
6669
  /**
6417
6670
  * Get underlying data given a point and the output column names.
6418
6671
  * In case of a context menu action, the selectedPoints are
@@ -6471,6 +6724,10 @@ declare module '@thoughtspot/visual-embed-sdk/mixpanel-service' {
6471
6724
  export const EndPoints: {
6472
6725
  CONFIG: string;
6473
6726
  };
6727
+ /**
6728
+ * Enum of mixpanel events
6729
+ * @hidden
6730
+ */
6474
6731
  export const MIXPANEL_EVENT: {
6475
6732
  VISUAL_SDK_RENDER_START: string;
6476
6733
  VISUAL_SDK_CALLED_INIT: string;
@@ -6820,7 +7077,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
6820
7077
  on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
6821
7078
  /**
6822
7079
  * Only for testing purposes.
6823
- *
6824
7080
  * @hidden
6825
7081
  */
6826
7082
  test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;