@thoughtspot/visual-embed-sdk 1.28.3 → 1.28.5-alpha-1

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 (171) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +2 -1
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +2 -2
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/authToken.d.ts +1 -1
  7. package/cjs/src/authToken.d.ts.map +1 -1
  8. package/cjs/src/authToken.js +9 -2
  9. package/cjs/src/authToken.js.map +1 -1
  10. package/cjs/src/embed/app.d.ts +50 -6
  11. package/cjs/src/embed/app.d.ts.map +1 -1
  12. package/cjs/src/embed/app.js +9 -3
  13. package/cjs/src/embed/app.js.map +1 -1
  14. package/cjs/src/embed/app.spec.js +10 -0
  15. package/cjs/src/embed/app.spec.js.map +1 -1
  16. package/cjs/src/embed/base.d.ts +1 -1
  17. package/cjs/src/embed/base.d.ts.map +1 -1
  18. package/cjs/src/embed/base.js +6 -6
  19. package/cjs/src/embed/base.js.map +1 -1
  20. package/cjs/src/embed/base.spec.js +1 -1
  21. package/cjs/src/embed/base.spec.js.map +1 -1
  22. package/cjs/src/embed/liveboard.d.ts +24 -2
  23. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  24. package/cjs/src/embed/liveboard.js +8 -3
  25. package/cjs/src/embed/liveboard.js.map +1 -1
  26. package/cjs/src/embed/liveboard.spec.js +61 -4
  27. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  28. package/cjs/src/embed/sage.d.ts +4 -4
  29. package/cjs/src/embed/sage.d.ts.map +1 -1
  30. package/cjs/src/embed/sage.js +2 -18
  31. package/cjs/src/embed/sage.js.map +1 -1
  32. package/cjs/src/embed/sage.spec.js +20 -31
  33. package/cjs/src/embed/sage.spec.js.map +1 -1
  34. package/cjs/src/embed/search.d.ts +33 -5
  35. package/cjs/src/embed/search.d.ts.map +1 -1
  36. package/cjs/src/embed/search.js +6 -4
  37. package/cjs/src/embed/search.js.map +1 -1
  38. package/cjs/src/embed/search.spec.js +2 -1
  39. package/cjs/src/embed/search.spec.js.map +1 -1
  40. package/cjs/src/embed/ts-embed.d.ts +1 -1
  41. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  42. package/cjs/src/embed/ts-embed.js +15 -6
  43. package/cjs/src/embed/ts-embed.js.map +1 -1
  44. package/cjs/src/embed/ts-embed.spec.js +27 -18
  45. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  46. package/cjs/src/errors.js +1 -1
  47. package/cjs/src/errors.js.map +1 -1
  48. package/cjs/src/react/index.spec.js +1 -13
  49. package/cjs/src/react/index.spec.js.map +1 -1
  50. package/cjs/src/types.d.ts +114 -15
  51. package/cjs/src/types.d.ts.map +1 -1
  52. package/cjs/src/types.js +68 -7
  53. package/cjs/src/types.js.map +1 -1
  54. package/cjs/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
  55. package/cjs/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
  56. package/cjs/src/utils/authService/tokenizedAuthService.spec.js +32 -0
  57. package/cjs/src/utils/authService/tokenizedAuthService.spec.js.map +1 -0
  58. package/cjs/src/utils/sessionInfoService.d.ts +66 -0
  59. package/cjs/src/utils/sessionInfoService.d.ts.map +1 -0
  60. package/cjs/src/utils/sessionInfoService.js +92 -0
  61. package/cjs/src/utils/sessionInfoService.js.map +1 -0
  62. package/dist/src/auth.d.ts.map +1 -1
  63. package/dist/src/authToken.d.ts +1 -1
  64. package/dist/src/authToken.d.ts.map +1 -1
  65. package/dist/src/embed/app.d.ts +50 -6
  66. package/dist/src/embed/app.d.ts.map +1 -1
  67. package/dist/src/embed/base.d.ts +1 -1
  68. package/dist/src/embed/base.d.ts.map +1 -1
  69. package/dist/src/embed/liveboard.d.ts +24 -2
  70. package/dist/src/embed/liveboard.d.ts.map +1 -1
  71. package/dist/src/embed/sage.d.ts +4 -4
  72. package/dist/src/embed/sage.d.ts.map +1 -1
  73. package/dist/src/embed/search.d.ts +33 -5
  74. package/dist/src/embed/search.d.ts.map +1 -1
  75. package/dist/src/embed/ts-embed.d.ts +1 -1
  76. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  77. package/dist/src/types.d.ts +114 -15
  78. package/dist/src/types.d.ts.map +1 -1
  79. package/dist/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
  80. package/dist/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
  81. package/dist/src/utils/sessionInfoService.d.ts +66 -0
  82. package/dist/src/utils/sessionInfoService.d.ts.map +1 -0
  83. package/dist/tsembed-react.es.js +1764 -1691
  84. package/dist/tsembed-react.js +7024 -6951
  85. package/dist/tsembed.es.js +7275 -7202
  86. package/dist/tsembed.js +15449 -15376
  87. package/dist/visual-embed-sdk-react-full.d.ts +223 -30
  88. package/dist/visual-embed-sdk-react.d.ts +223 -30
  89. package/dist/visual-embed-sdk.d.ts +223 -30
  90. package/lib/package.json +2 -1
  91. package/lib/src/auth.d.ts.map +1 -1
  92. package/lib/src/auth.js +3 -3
  93. package/lib/src/auth.js.map +1 -1
  94. package/lib/src/authToken.d.ts +1 -1
  95. package/lib/src/authToken.d.ts.map +1 -1
  96. package/lib/src/authToken.js +9 -2
  97. package/lib/src/authToken.js.map +1 -1
  98. package/lib/src/embed/app.d.ts +50 -6
  99. package/lib/src/embed/app.d.ts.map +1 -1
  100. package/lib/src/embed/app.js +9 -3
  101. package/lib/src/embed/app.js.map +1 -1
  102. package/lib/src/embed/app.spec.js +10 -0
  103. package/lib/src/embed/app.spec.js.map +1 -1
  104. package/lib/src/embed/base.d.ts +1 -1
  105. package/lib/src/embed/base.d.ts.map +1 -1
  106. package/lib/src/embed/base.js +5 -5
  107. package/lib/src/embed/base.js.map +1 -1
  108. package/lib/src/embed/base.spec.js +2 -2
  109. package/lib/src/embed/base.spec.js.map +1 -1
  110. package/lib/src/embed/liveboard.d.ts +24 -2
  111. package/lib/src/embed/liveboard.d.ts.map +1 -1
  112. package/lib/src/embed/liveboard.js +9 -4
  113. package/lib/src/embed/liveboard.js.map +1 -1
  114. package/lib/src/embed/liveboard.spec.js +61 -4
  115. package/lib/src/embed/liveboard.spec.js.map +1 -1
  116. package/lib/src/embed/sage.d.ts +4 -4
  117. package/lib/src/embed/sage.d.ts.map +1 -1
  118. package/lib/src/embed/sage.js +2 -18
  119. package/lib/src/embed/sage.js.map +1 -1
  120. package/lib/src/embed/sage.spec.js +20 -31
  121. package/lib/src/embed/sage.spec.js.map +1 -1
  122. package/lib/src/embed/search.d.ts +33 -5
  123. package/lib/src/embed/search.d.ts.map +1 -1
  124. package/lib/src/embed/search.js +7 -5
  125. package/lib/src/embed/search.js.map +1 -1
  126. package/lib/src/embed/search.spec.js +2 -1
  127. package/lib/src/embed/search.spec.js.map +1 -1
  128. package/lib/src/embed/ts-embed.d.ts +1 -1
  129. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  130. package/lib/src/embed/ts-embed.js +18 -9
  131. package/lib/src/embed/ts-embed.js.map +1 -1
  132. package/lib/src/embed/ts-embed.spec.js +27 -18
  133. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  134. package/lib/src/errors.js +1 -1
  135. package/lib/src/errors.js.map +1 -1
  136. package/lib/src/react/index.spec.js +1 -13
  137. package/lib/src/react/index.spec.js.map +1 -1
  138. package/lib/src/types.d.ts +114 -15
  139. package/lib/src/types.d.ts.map +1 -1
  140. package/lib/src/types.js +68 -7
  141. package/lib/src/types.js.map +1 -1
  142. package/lib/src/utils/authService/authService.spec.js +1 -1
  143. package/lib/src/utils/authService/authService.spec.js.map +1 -1
  144. package/lib/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
  145. package/lib/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
  146. package/lib/src/utils/authService/tokenizedAuthService.spec.js +29 -0
  147. package/lib/src/utils/authService/tokenizedAuthService.spec.js.map +1 -0
  148. package/lib/src/utils/sessionInfoService.d.ts +66 -0
  149. package/lib/src/utils/sessionInfoService.d.ts.map +1 -0
  150. package/lib/src/utils/sessionInfoService.js +85 -0
  151. package/lib/src/utils/sessionInfoService.js.map +1 -0
  152. package/lib/src/visual-embed-sdk.d.ts +228 -35
  153. package/package.json +2 -1
  154. package/src/auth.ts +6 -6
  155. package/src/authToken.ts +9 -2
  156. package/src/embed/app.spec.ts +15 -0
  157. package/src/embed/app.ts +67 -8
  158. package/src/embed/base.spec.ts +3 -3
  159. package/src/embed/base.ts +14 -14
  160. package/src/embed/liveboard.spec.ts +82 -9
  161. package/src/embed/liveboard.ts +42 -5
  162. package/src/embed/sage.spec.ts +20 -35
  163. package/src/embed/sage.ts +4 -21
  164. package/src/embed/search.spec.ts +2 -1
  165. package/src/embed/search.ts +45 -10
  166. package/src/embed/ts-embed.spec.ts +48 -34
  167. package/src/embed/ts-embed.ts +52 -39
  168. package/src/errors.ts +1 -1
  169. package/src/react/index.spec.tsx +1 -30
  170. package/src/types.ts +114 -15
  171. package/src/utils/authService/authService.spec.ts +4 -4
@@ -71,6 +71,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
71
71
  *
72
72
  * @default true
73
73
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
74
+ *
74
75
  * @example
75
76
  * ```js
76
77
  * const embed = new AppEmbed('#tsEmbed', {
@@ -86,7 +87,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
86
87
  * nav-bars are visible, this flag will only hide the homepage left nav-bar.
87
88
  * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
88
89
  *
89
- *
90
90
  * **Note**: This option does not apply to the classic homepage.
91
91
  * To access the updated modular homepage, set
92
92
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -106,9 +106,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
106
106
  /**
107
107
  * Control the visibility of the help (?) and profile buttons on the
108
108
  * Global nav-bar. By default, these buttons are visible on the nav-bar.
109
- *
110
109
  * @default false
111
110
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
111
+ *
112
112
  * @example
113
113
  * ```js
114
114
  * const embed = new AppEmbed('#tsEmbed', {
@@ -122,7 +122,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
122
122
  * Control the visibility of the application switcher button on the nav-bar.
123
123
  * By default, the application switcher is shown.
124
124
  *
125
- *
126
125
  * **Note**: This option does not apply to the classic homepage.
127
126
  * To access the updated modular homepage, set
128
127
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -143,7 +142,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
143
142
  * Control the visibility of the Org switcher button on the nav-bar.
144
143
  * By default, the Org switcher button is shown.
145
144
  *
146
- *
147
145
  * **Note**: This option does not apply to the classic homepage.
148
146
  * To access the updated modular homepage, set
149
147
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -170,6 +168,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
170
168
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
171
169
  *
172
170
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
171
+ *
173
172
  * @example
174
173
  * ```js
175
174
  * const embed = new AppEmbed('#tsEmbed', {
@@ -187,6 +186,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
187
186
  * path within the app, use the `path` attribute which is more flexible.
188
187
  *
189
188
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
189
+ *
190
190
  * @example
191
191
  * ```js
192
192
  * const embed = new AppEmbed('#tsEmbed', {
@@ -215,6 +215,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
215
215
  * The array of GUIDs to be hidden
216
216
  *
217
217
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
218
+ *
218
219
  * @example
219
220
  * ```js
220
221
  * const embed = new AppEmbed('#tsEmbed', {
@@ -237,9 +238,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
237
238
  liveboardV2?: boolean;
238
239
  /**
239
240
  * If set to true, the Search Assist feature is enabled.
240
- *
241
241
  * @default true
242
+ *
242
243
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
244
+ *
243
245
  * @example
244
246
  * ```js
245
247
  * const embed = new AppEmbed('#tsEmbed', {
@@ -254,6 +256,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
254
256
  * according to the height of the pages which support fullHeight mode.
255
257
  *
256
258
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
259
+ *
257
260
  * @example
258
261
  * ```js
259
262
  * const embed = new AppEmbed('#tsEmbed', {
@@ -276,6 +279,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
276
279
  *
277
280
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
278
281
  * @default false
282
+ *
279
283
  * @example
280
284
  * ```js
281
285
  * const embed = new AppEmbed('#tsEmbed', {
@@ -290,6 +294,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
290
294
  *
291
295
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
292
296
  * @default false
297
+ *
293
298
  * @example
294
299
  * ```js
295
300
  * const embed = new AppEmbed('#tsEmbed', {
@@ -304,6 +309,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
304
309
  *
305
310
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
306
311
  * @default false
312
+ *
307
313
  * @example
308
314
  * ```js
309
315
  * const embed = new AppEmbed('#tsEmbed', {
@@ -348,6 +354,44 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
348
354
  * @default false
349
355
  */
350
356
  enableAskSage?: boolean;
357
+ /**
358
+ * To set the initial state of the search bar in case of saved-answers.
359
+ *
360
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
361
+ * @default false
362
+ */
363
+ collapseSearchBarInitially?: boolean;
364
+ /**
365
+ * To enable custom column groups in data panel v2
366
+ *
367
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
368
+ * @default false
369
+ *
370
+ * @example
371
+ * ```js
372
+ * const embed = new AppEmbed('#embed', {
373
+ * ... // other app view config
374
+ * enableCustomColumnGroups: true,
375
+ * });
376
+ * ```
377
+ */
378
+ enableCustomColumnGroups?: boolean;
379
+ /**
380
+ * This flag is used to enable the 2 column layout in liveboard
381
+ *
382
+ * @type {boolean}
383
+ * @default false
384
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
385
+ *
386
+ * @example
387
+ * ```js
388
+ * const embed = new LiveboardEmbed('#embed-container', {
389
+ * ... // other options
390
+ * enable2ColumnLayout: true,
391
+ * })
392
+ * ```
393
+ */
394
+ enable2ColumnLayout?: boolean;
351
395
  }
352
396
  /**
353
397
  * Embeds full ThoughtSpot experience in a host application.
@@ -562,6 +606,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
562
606
  * incrementally as users scroll the page to view the charts and tables.
563
607
  *
564
608
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
609
+ *
565
610
  * @example
566
611
  * ```js
567
612
  * const embed = new LiveboardEmbed('#embed', {
@@ -590,6 +635,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
590
635
  defaultHeight?: number;
591
636
  /**
592
637
  * @Deprecated If set to true, the context menu in visualizations will be enabled.
638
+ *
593
639
  * @example
594
640
  * ```js
595
641
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -597,6 +643,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
597
643
  * enableVizTransformations:true,
598
644
  * })
599
645
  * ```
646
+ *
600
647
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
601
648
  */
602
649
  enableVizTransformations?: boolean;
@@ -623,6 +670,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
623
670
  * The visualization within the Liveboard to display.
624
671
  *
625
672
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
673
+ *
626
674
  * @example
627
675
  * ```js
628
676
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -652,6 +700,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
652
700
  * event.
653
701
  *
654
702
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
703
+ *
655
704
  * @example
656
705
  * ```js
657
706
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -701,6 +750,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
701
750
  * Show or hide the tab panel of the embedded Liveboard.
702
751
  *
703
752
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
753
+ *
704
754
  * @example
705
755
  * ```js
706
756
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -726,9 +776,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
726
776
  hideLiveboardHeader?: boolean;
727
777
  /**
728
778
  * Show or hide the Liveboard title.
729
- *
730
779
  * @default false
731
780
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
781
+ *
732
782
  * @example
733
783
  * ```js
734
784
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -740,9 +790,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
740
790
  showLiveboardTitle?: boolean;
741
791
  /**
742
792
  * Show or hide the Liveboard description.
743
- *
744
793
  * @default false
745
794
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
795
+ *
746
796
  * @example
747
797
  * ```js
748
798
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -781,6 +831,22 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
781
831
  * ```
782
832
  */
783
833
  enableAskSage?: boolean;
834
+ /**
835
+ * This flag is used to enable the 2 column layout in liveboard
836
+ *
837
+ * @type {boolean}
838
+ * @default false
839
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
840
+ *
841
+ * @example
842
+ * ```js
843
+ * const embed = new LiveboardEmbed('#embed-container', {
844
+ * ... // other options
845
+ * enable2ColumnLayout: true,
846
+ * })
847
+ * ```
848
+ */
849
+ enable2ColumnLayout?: boolean;
784
850
  }
785
851
  /**
786
852
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -866,6 +932,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
866
932
  * but can be expanded manually.
867
933
  *
868
934
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
935
+ *
869
936
  * @example
870
937
  * ```js
871
938
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -879,6 +946,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
879
946
  * Show or hide the data sources panel.
880
947
  *
881
948
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
949
+ *
882
950
  * @example
883
951
  * ```js
884
952
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -894,6 +962,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
894
962
  * using raw answer data.
895
963
  *
896
964
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
965
+ *
897
966
  * @example
898
967
  * ```js
899
968
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -903,14 +972,11 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
903
972
  * ```
904
973
  */
905
974
  hideResults?: boolean;
906
- /**
907
- * If set to true, expands all the data sources panel.
908
- */
909
- expandAllDataSource?: boolean;
910
975
  /**
911
976
  * If set to true, the Search Assist feature is enabled.
912
977
  *
913
978
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
979
+ *
914
980
  * @example
915
981
  * ```js
916
982
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -925,6 +991,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
925
991
  * format for presenting search data.
926
992
  *
927
993
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
994
+ *
928
995
  * @example
929
996
  * ```js
930
997
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -938,6 +1005,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
938
1005
  * Only a single data source is supported currently.
939
1006
  *
940
1007
  * @deprecated Use `dataSource` instead.
1008
+ *
941
1009
  * @example
942
1010
  * ```js
943
1011
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -951,6 +1019,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
951
1019
  * The array of data source GUIDs to set on load.
952
1020
  *
953
1021
  * @version: SDK: 1.19.0
1022
+ *
954
1023
  * @example
955
1024
  * ```js
956
1025
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -992,6 +1061,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
992
1061
  * The GUID of a saved answer to load initially.
993
1062
  *
994
1063
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
1064
+ *
995
1065
  * @example
996
1066
  * ```js
997
1067
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -1006,6 +1076,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1006
1076
  * The chart/table should still be visible.
1007
1077
  *
1008
1078
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1079
+ *
1009
1080
  * @example
1010
1081
  * ```js
1011
1082
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -1020,6 +1091,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1020
1091
  *
1021
1092
  * @default false
1022
1093
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1094
+ *
1023
1095
  * @example
1024
1096
  * ```js
1025
1097
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -1035,6 +1107,28 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1035
1107
  * @version: SDK: 1.24.0
1036
1108
  */
1037
1109
  useLastSelectedSources?: boolean;
1110
+ /**
1111
+ * To set the initial state of the search bar in case of saved-answers.
1112
+ *
1113
+ * @default false
1114
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1115
+ */
1116
+ collapseSearchBarInitially?: boolean;
1117
+ /**
1118
+ * To enable custom column groups in data panel v2
1119
+ *
1120
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1121
+ * @default false
1122
+ *
1123
+ * @example
1124
+ * ```js
1125
+ * const embed = new SearchEmbed('#tsEmbed', {
1126
+ * ... // other options
1127
+ * enableCustomColumnGroups: true,
1128
+ * });
1129
+ * ```
1130
+ */
1131
+ enableCustomColumnGroups?: boolean;
1038
1132
  }
1039
1133
  export const HiddenActionItemByDefaultForSearchEmbed: Action[];
1040
1134
  /**
@@ -1487,7 +1581,6 @@ export enum AuthType {
1487
1581
  * .then((data) => data.token);
1488
1582
  * }
1489
1583
  * });
1490
- * });
1491
1584
  * ```
1492
1585
  */
1493
1586
  TrustedAuthToken = "AuthServer",
@@ -1911,6 +2004,41 @@ export interface EmbedConfig {
1911
2004
  * @version SDK: 1.27.9
1912
2005
  */
1913
2006
  disableSDKTracking?: boolean;
2007
+ /**
2008
+ * Overrides default/user preffered locale for date formatting
2009
+ *
2010
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2011
+ */
2012
+ dateFormatLocale?: string;
2013
+ /**
2014
+ * Overrides default/user preffered locale for number formatting
2015
+ *
2016
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2017
+ */
2018
+ numberFormatLocale?: string;
2019
+ /**
2020
+ * Format to be used for currency when currency format is set to infer from browser
2021
+ *
2022
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2023
+ */
2024
+ currencyFormat?: string;
2025
+ /**
2026
+ * This flag is used to disable the token verification in the SDK.
2027
+ * Enabling this flag will also disable the caching of the token.
2028
+ *
2029
+ * @hidden
2030
+ *
2031
+ * @example
2032
+ * ```js
2033
+ * init({
2034
+ * ...embedConfig,
2035
+ * disableTokenVerification : true
2036
+ * })
2037
+ * ```
2038
+ *
2039
+ * @version SDK: 1.28.5 | Thoughtspot: *
2040
+ */
2041
+ disableTokenVerification?: boolean;
1914
2042
  }
1915
2043
  export interface LayoutConfig {
1916
2044
  }
@@ -1953,6 +2081,7 @@ export interface ViewConfig {
1953
2081
  * object inside your app. Specify the values in pixels or percentage.
1954
2082
  *
1955
2083
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
2084
+ *
1956
2085
  * @example
1957
2086
  * ```js
1958
2087
  * const embed = new LiveboardEmbed('#embed', {
@@ -1991,7 +2120,6 @@ export interface ViewConfig {
1991
2120
  disabledActions?: Action[];
1992
2121
  /**
1993
2122
  * The tooltip to display for disabled actions.
1994
- *
1995
2123
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1996
2124
  * @example
1997
2125
  * ```js
@@ -2009,6 +2137,7 @@ export interface ViewConfig {
2009
2137
  * Use this to hide an action.
2010
2138
  *
2011
2139
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2140
+ *
2012
2141
  * @example
2013
2142
  * ```js
2014
2143
  * const embed = new LiveboardEmbed('#embed', {
@@ -2029,6 +2158,7 @@ export interface ViewConfig {
2029
2158
  *
2030
2159
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2031
2160
  * @important
2161
+ *
2032
2162
  * @example
2033
2163
  * ```js
2034
2164
  * const embed = new LiveboardEmbed('#embed', {
@@ -2042,6 +2172,7 @@ export interface ViewConfig {
2042
2172
  * Show alert messages and toast messages in the embedded view.
2043
2173
  *
2044
2174
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2175
+ *
2045
2176
  * @example
2046
2177
  * ```js
2047
2178
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2056,6 +2187,7 @@ export interface ViewConfig {
2056
2187
  * visualization, or Liveboard.
2057
2188
  *
2058
2189
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2190
+ *
2059
2191
  * @example
2060
2192
  * ```js
2061
2193
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2076,6 +2208,7 @@ export interface ViewConfig {
2076
2208
  * visualization, or Liveboard.
2077
2209
  *
2078
2210
  * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
2211
+ *
2079
2212
  * @example
2080
2213
  * ```js
2081
2214
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2110,7 +2243,6 @@ export interface ViewConfig {
2110
2243
  * Warning: This option is for advanced use only and is used internally
2111
2244
  * to control embed behavior in non-regular ways. We do not publish the
2112
2245
  * list of supported keys and values associated with each.
2113
- *
2114
2246
  * @example
2115
2247
  * ```js
2116
2248
  * const embed = new LiveboardEmbed('#embed', {
@@ -2139,6 +2271,7 @@ export interface ViewConfig {
2139
2271
  * child inside it.
2140
2272
  *
2141
2273
  * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
2274
+ *
2142
2275
  * @example
2143
2276
  * ```js
2144
2277
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2224,8 +2357,6 @@ export interface ViewConfig {
2224
2357
  * Hide the home page modules
2225
2358
  * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
2226
2359
  *
2227
- *
2228
- *
2229
2360
  * **Note**: This option does not apply to the classic homepage.
2230
2361
  * To access the updated modular homepage, set
2231
2362
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2238,13 +2369,13 @@ export interface ViewConfig {
2238
2369
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
2239
2370
  * })
2240
2371
  * ```
2372
+ *
2241
2373
  */
2242
2374
  hiddenHomepageModules?: HomepageModule[];
2243
2375
  /**
2244
2376
  * reordering the home page modules
2245
2377
  * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
2246
2378
  *
2247
- *
2248
2379
  * **Note**: This option does not apply to the classic homepage.
2249
2380
  * To access the updated modular homepage, set
2250
2381
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2267,6 +2398,7 @@ export interface ViewConfig {
2267
2398
  * Use either `visibleTabs` or `hiddenTabs`.
2268
2399
  *
2269
2400
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2401
+ *
2270
2402
  * @example
2271
2403
  * ```js
2272
2404
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2292,8 +2424,6 @@ export interface ViewConfig {
2292
2424
  * })
2293
2425
  * ```
2294
2426
  *
2295
- *
2296
- *
2297
2427
  * **Note**: This option does not apply to the classic homepage.
2298
2428
  * To access the updated modular homepage, set
2299
2429
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2326,6 +2456,7 @@ export interface ViewConfig {
2326
2456
  * @type {boolean}
2327
2457
  * @default false
2328
2458
  * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
2459
+ *
2329
2460
  * @example
2330
2461
  * ```js
2331
2462
  * // Disable tracking PreRender size in the configuration
@@ -2729,8 +2860,7 @@ export enum EmbedEvent {
2729
2860
  *
2730
2861
  * API - API call failure error.
2731
2862
  *
2732
- * FULLSCREEN - Error when presenting a Liveboard or visualization in full screen
2733
- * mode.
2863
+ * FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
2734
2864
  *
2735
2865
  * SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
2736
2866
  *
@@ -4371,7 +4501,14 @@ export enum Param {
4371
4501
  HideSearchBar = "hideSearchBar",
4372
4502
  ClientLogLevel = "clientLogLevel",
4373
4503
  OverrideNativeConsole = "overrideConsoleLogs",
4374
- enableAskSage = "enableAskSage"
4504
+ enableAskSage = "enableAskSage",
4505
+ CollapseSearchBarInitially = "collapseSearchBarInitially",
4506
+ EnableCustomColumnGroups = "enableCustomColumnGroups",
4507
+ DateFormatLocale = "dateFormatLocale",
4508
+ NumberFormatLocale = "numberFormatLocale",
4509
+ CurrencyFormat = "currencyFormat",
4510
+ Enable2ColumnLayout = "enable2ColumnLayout",
4511
+ IsFullAppEmbed = "isFullAppEmbed"
4375
4512
  }
4376
4513
  /**
4377
4514
  * ThoughtSpot application pages include actions and menu commands
@@ -4507,6 +4644,18 @@ export enum Action {
4507
4644
  * ```
4508
4645
  */
4509
4646
  AddFilter = "addFilter",
4647
+ /**
4648
+ * The **Add Data Panel Objects** action on the data panel v2.
4649
+ * Allows to show action menu to add different objects (like
4650
+ * formulas, parameters) in data panel v2.
4651
+ *
4652
+ * @example
4653
+ * ```js
4654
+ * disabledActions: [Action.AddDataPanelObjects]
4655
+ * ```
4656
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4657
+ */
4658
+ AddDataPanelObjects = "addDataPanelObjects",
4510
4659
  /**
4511
4660
  * Filter configuration options on a Liveboard and Search page.
4512
4661
  * Allows configuring filter options when adding filters to a
@@ -4549,6 +4698,28 @@ export enum Action {
4549
4698
  * ```
4550
4699
  */
4551
4700
  AddParameter = "addParameter",
4701
+ /**
4702
+ * The **Add Column Set** action on a Answer.
4703
+ * Allows adding column sets to a Answer.
4704
+ *
4705
+ * @example
4706
+ * ```js
4707
+ * disabledActions: [Action.AddColumnSet]
4708
+ * ```
4709
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4710
+ */
4711
+ AddColumnSet = "addSimpleCohort",
4712
+ /**
4713
+ * The **Add Query Set** action on a Answer.
4714
+ * Allows adding query sets to a Answer.
4715
+ *
4716
+ * @example
4717
+ * ```js
4718
+ * disabledActions: [Action.AddQuerySet]
4719
+ * ```
4720
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4721
+ */
4722
+ AddQuerySet = "addAdvancedCohort",
4552
4723
  /**
4553
4724
  * @hidden
4554
4725
  */
@@ -4980,6 +5151,28 @@ export enum Action {
4980
5151
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4981
5152
  */
4982
5153
  CrossFilter = "context-menu-item-cross-filter",
5154
+ /**
5155
+ * The **Sync to Slack** action on Liveboard visualizations.
5156
+ * Allows sending data to third-party apps Slack
5157
+ *
5158
+ * @example
5159
+ * ```js
5160
+ * disabledActions: [Action.SyncToSlack]
5161
+ * ```
5162
+ * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5163
+ */
5164
+ SyncToSlack = "syncToSlack",
5165
+ /**
5166
+ * The **Sync to Teams** action on Liveboard visualizations.
5167
+ * Allows sending data to third-party apps Team
5168
+ *
5169
+ * @example
5170
+ * ```js
5171
+ * disabledActions: [Action.SyncToTeams]
5172
+ * ```
5173
+ * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5174
+ */
5175
+ SyncToTeams = "syncToTeams",
4983
5176
  /**
4984
5177
  * The **Remove** action that appears when cross filters are applied
4985
5178
  * on a Liveboard.
@@ -5282,15 +5475,15 @@ export enum Action {
5282
5475
  */
5283
5476
  RemoveFromWatchlist = "removeFromWatchlist",
5284
5477
  /**
5285
- * The **Copy KPI Link** menu action on KPI watchlist.
5478
+ * The **Organise Favourites** action on Homepage Favourite Module.
5286
5479
  *
5287
5480
  * @example
5288
5481
  * ```js
5289
- * disabledActions: [Action.CopyKpiLink]
5482
+ * disabledActions: [Action.OrganiseFavourites]
5290
5483
  * ```
5291
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
5484
+ * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
5292
5485
  */
5293
- CopyKpiLink = "copyKpiLink",
5486
+ OrganiseFavourites = "organiseFavourites",
5294
5487
  /**
5295
5488
  * Action ID for AI Highlights button
5296
5489
  *
@@ -5825,7 +6018,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
5825
6018
  showObjectResults?: boolean;
5826
6019
  /**
5827
6020
  * flag used by the TS product tour page to show the blue search bar
5828
- * even after the search is completed. This is different from TSE Sage Embed
6021
+ * even after the search is completed. This is different from Thoughtspot Embedded Sage Embed
5829
6022
  * experience where it mimics closer to the non-embed case.
5830
6023
  * The Sample questions container is collapsed when this value is set after
5831
6024
  * does a search.
@@ -5836,8 +6029,9 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
5836
6029
  isProductTour?: boolean;
5837
6030
  /**
5838
6031
  * Show or hide the search bar title.
6032
+ * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
5839
6033
  *
5840
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
6034
+ * @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
5841
6035
  */
5842
6036
  hideSearchBarTitle?: boolean;
5843
6037
  /**
@@ -5907,7 +6101,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
5907
6101
  */
5908
6102
  searchOptions?: SearchOptions;
5909
6103
  }
5910
- export const HiddenActionItemByDefaultForSageEmbed: Action[];
5911
6104
  /**
5912
6105
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
5913
6106
  *
@@ -6138,7 +6331,7 @@ export const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<strin
6138
6331
  * ```js
6139
6332
  * resetCachedAuthToken();
6140
6333
  * ```
6141
- * @version SDK: 1.28.2 | ThoughtSpot: *
6334
+ * @version SDK: 1.28.0 | ThoughtSpot: *
6142
6335
  * @group Authentication / Init
6143
6336
  */
6144
6337
  export const resetCachedAuthToken: () => void;
package/lib/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.28.3",
3
+ "version": "1.28.5-alpha-1",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
@@ -175,6 +175,7 @@
175
175
  "keywords": [
176
176
  "thoughtspot",
177
177
  "everywhere",
178
+ "embedded",
178
179
  "embed",
179
180
  "sdk",
180
181
  "analytics"