@thoughtspot/visual-embed-sdk 1.28.0-alpha.5 → 1.28.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 (125) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +2 -2
  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 +0 -6
  7. package/cjs/src/authToken.d.ts.map +1 -1
  8. package/cjs/src/authToken.js +0 -6
  9. package/cjs/src/authToken.js.map +1 -1
  10. package/cjs/src/embed/app.d.ts +13 -20
  11. package/cjs/src/embed/app.d.ts.map +1 -1
  12. package/cjs/src/embed/app.js +2 -2
  13. package/cjs/src/embed/app.js.map +1 -1
  14. package/cjs/src/embed/base.d.ts +1 -1
  15. package/cjs/src/embed/base.d.ts.map +1 -1
  16. package/cjs/src/embed/base.js +5 -7
  17. package/cjs/src/embed/base.js.map +1 -1
  18. package/cjs/src/embed/base.spec.js +1 -1
  19. package/cjs/src/embed/base.spec.js.map +1 -1
  20. package/cjs/src/embed/liveboard.d.ts +2 -8
  21. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  22. package/cjs/src/embed/liveboard.js.map +1 -1
  23. package/cjs/src/embed/search.d.ts +5 -11
  24. package/cjs/src/embed/search.d.ts.map +1 -1
  25. package/cjs/src/embed/search.js +4 -4
  26. package/cjs/src/embed/search.js.map +1 -1
  27. package/cjs/src/embed/ts-embed.d.ts +1 -1
  28. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  29. package/cjs/src/embed/ts-embed.js +6 -6
  30. package/cjs/src/embed/ts-embed.js.map +1 -1
  31. package/cjs/src/embed/ts-embed.spec.js +18 -9
  32. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  33. package/cjs/src/index.d.ts +0 -1
  34. package/cjs/src/index.d.ts.map +1 -1
  35. package/cjs/src/index.js +1 -3
  36. package/cjs/src/index.js.map +1 -1
  37. package/cjs/src/react/index.spec.js +12 -0
  38. package/cjs/src/react/index.spec.js.map +1 -1
  39. package/cjs/src/types.d.ts +36 -29
  40. package/cjs/src/types.d.ts.map +1 -1
  41. package/cjs/src/types.js +23 -12
  42. package/cjs/src/types.js.map +1 -1
  43. package/dist/src/auth.d.ts.map +1 -1
  44. package/dist/src/authToken.d.ts +0 -6
  45. package/dist/src/authToken.d.ts.map +1 -1
  46. package/dist/src/embed/app.d.ts +13 -20
  47. package/dist/src/embed/app.d.ts.map +1 -1
  48. package/dist/src/embed/base.d.ts +1 -1
  49. package/dist/src/embed/base.d.ts.map +1 -1
  50. package/dist/src/embed/liveboard.d.ts +2 -8
  51. package/dist/src/embed/liveboard.d.ts.map +1 -1
  52. package/dist/src/embed/search.d.ts +5 -11
  53. package/dist/src/embed/search.d.ts.map +1 -1
  54. package/dist/src/embed/ts-embed.d.ts +1 -1
  55. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  56. package/dist/src/index.d.ts +0 -1
  57. package/dist/src/index.d.ts.map +1 -1
  58. package/dist/src/types.d.ts +36 -29
  59. package/dist/src/types.d.ts.map +1 -1
  60. package/dist/tsembed-react.es.js +1465 -1460
  61. package/dist/tsembed-react.js +2225 -2233
  62. package/dist/tsembed.es.js +1850 -1846
  63. package/dist/tsembed.js +15342 -15352
  64. package/dist/visual-embed-sdk-react-full.d.ts +54 -75
  65. package/dist/visual-embed-sdk-react.d.ts +54 -75
  66. package/dist/visual-embed-sdk.d.ts +54 -75
  67. package/lib/package.json +2 -2
  68. package/lib/src/auth.d.ts.map +1 -1
  69. package/lib/src/auth.js +3 -3
  70. package/lib/src/auth.js.map +1 -1
  71. package/lib/src/authToken.d.ts +0 -6
  72. package/lib/src/authToken.d.ts.map +1 -1
  73. package/lib/src/authToken.js +0 -6
  74. package/lib/src/authToken.js.map +1 -1
  75. package/lib/src/embed/app.d.ts +13 -20
  76. package/lib/src/embed/app.d.ts.map +1 -1
  77. package/lib/src/embed/app.js +2 -2
  78. package/lib/src/embed/app.js.map +1 -1
  79. package/lib/src/embed/base.d.ts +1 -1
  80. package/lib/src/embed/base.d.ts.map +1 -1
  81. package/lib/src/embed/base.js +5 -7
  82. package/lib/src/embed/base.js.map +1 -1
  83. package/lib/src/embed/base.spec.js +2 -2
  84. package/lib/src/embed/base.spec.js.map +1 -1
  85. package/lib/src/embed/liveboard.d.ts +2 -8
  86. package/lib/src/embed/liveboard.d.ts.map +1 -1
  87. package/lib/src/embed/liveboard.js +1 -1
  88. package/lib/src/embed/liveboard.js.map +1 -1
  89. package/lib/src/embed/search.d.ts +5 -11
  90. package/lib/src/embed/search.d.ts.map +1 -1
  91. package/lib/src/embed/search.js +5 -5
  92. package/lib/src/embed/search.js.map +1 -1
  93. package/lib/src/embed/ts-embed.d.ts +1 -1
  94. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  95. package/lib/src/embed/ts-embed.js +9 -9
  96. package/lib/src/embed/ts-embed.js.map +1 -1
  97. package/lib/src/embed/ts-embed.spec.js +18 -9
  98. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  99. package/lib/src/index.d.ts +0 -1
  100. package/lib/src/index.d.ts.map +1 -1
  101. package/lib/src/index.js +0 -1
  102. package/lib/src/index.js.map +1 -1
  103. package/lib/src/react/index.spec.js +12 -0
  104. package/lib/src/react/index.spec.js.map +1 -1
  105. package/lib/src/types.d.ts +36 -29
  106. package/lib/src/types.d.ts.map +1 -1
  107. package/lib/src/types.js +23 -12
  108. package/lib/src/types.js.map +1 -1
  109. package/lib/src/utils/authService/authService.spec.js +1 -1
  110. package/lib/src/utils/authService/authService.spec.js.map +1 -1
  111. package/lib/src/visual-embed-sdk.d.ts +58 -83
  112. package/package.json +2 -2
  113. package/src/auth.ts +6 -6
  114. package/src/authToken.ts +0 -6
  115. package/src/embed/app.ts +15 -27
  116. package/src/embed/base.spec.ts +3 -3
  117. package/src/embed/base.ts +12 -14
  118. package/src/embed/liveboard.ts +3 -16
  119. package/src/embed/search.ts +10 -19
  120. package/src/embed/ts-embed.spec.ts +34 -26
  121. package/src/embed/ts-embed.ts +39 -43
  122. package/src/index.ts +0 -2
  123. package/src/react/index.spec.tsx +29 -0
  124. package/src/types.ts +37 -29
  125. package/src/utils/authService/authService.spec.ts +4 -4
@@ -26,7 +26,6 @@ declare module '@thoughtspot/visual-embed-sdk' {
26
26
  import { uploadMixpanelEvent, MIXPANEL_EVENT } from '@thoughtspot/visual-embed-sdk/mixpanel-service';
27
27
  import { tokenizedFetch } from '@thoughtspot/visual-embed-sdk/tokenizedFetch';
28
28
  export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, VizPoint, CustomActionPayload, };
29
- export { resetCachedAuthToken } from '@thoughtspot/visual-embed-sdk/authToken';
30
29
  }
31
30
 
32
31
  declare module '@thoughtspot/visual-embed-sdk/embed/app' {
@@ -40,7 +39,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
40
39
  * @module
41
40
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
42
41
  */
43
- import { DOMSelector, ViewConfig, MessagePayload } from '@thoughtspot/visual-embed-sdk/types';
42
+ import { DOMSelector, MessagePayload, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
44
43
  import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
45
44
  /**
46
45
  * Pages within the ThoughtSpot app that can be embedded.
@@ -88,7 +87,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
88
87
  *
89
88
  * @default true
90
89
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
91
- *
92
90
  * @example
93
91
  * ```js
94
92
  * const embed = new AppEmbed('#tsEmbed', {
@@ -104,12 +102,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
104
102
  * nav-bars are visible, this flag will only hide the homepage left nav-bar.
105
103
  * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
106
104
  *
105
+ *
107
106
  * **Note**: This option does not apply to the classic homepage.
108
107
  * To access the updated modular homepage, set
109
- * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
108
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
110
109
  *
111
110
  * @default false
112
- * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
111
+ * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
113
112
  *
114
113
  * @example
115
114
  * ```js
@@ -123,9 +122,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
123
122
  /**
124
123
  * Control the visibility of the help (?) and profile buttons on the
125
124
  * Global nav-bar. By default, these buttons are visible on the nav-bar.
125
+ *
126
126
  * @default false
127
127
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
128
- *
129
128
  * @example
130
129
  * ```js
131
130
  * const embed = new AppEmbed('#tsEmbed', {
@@ -139,12 +138,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
139
138
  * Control the visibility of the application switcher button on the nav-bar.
140
139
  * By default, the application switcher is shown.
141
140
  *
141
+ *
142
142
  * **Note**: This option does not apply to the classic homepage.
143
143
  * To access the updated modular homepage, set
144
- * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
144
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
145
145
  *
146
+ * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
146
147
  * @default false
147
- * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
148
148
  *
149
149
  * @example
150
150
  * ```js
@@ -159,13 +159,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
159
159
  * Control the visibility of the Org switcher button on the nav-bar.
160
160
  * By default, the Org switcher button is shown.
161
161
  *
162
+ *
162
163
  * **Note**: This option does not apply to the classic homepage.
163
164
  * To access the updated modular homepage, set
164
- * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
165
- *
165
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
166
166
  *
167
+ * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
167
168
  * @default true
168
- * @version SDK: 1.2.0 | Thoughtspot: 9.4.0.cl
169
169
  *
170
170
  * @example
171
171
  * ```js
@@ -186,7 +186,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
186
186
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
187
187
  *
188
188
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
189
- *
190
189
  * @example
191
190
  * ```js
192
191
  * const embed = new AppEmbed('#tsEmbed', {
@@ -204,7 +203,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
204
203
  * path within the app, use the `path` attribute which is more flexible.
205
204
  *
206
205
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
207
- *
208
206
  * @example
209
207
  * ```js
210
208
  * const embed = new AppEmbed('#tsEmbed', {
@@ -233,7 +231,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
233
231
  * The array of GUIDs to be hidden
234
232
  *
235
233
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
236
- *
237
234
  * @example
238
235
  * ```js
239
236
  * const embed = new AppEmbed('#tsEmbed', {
@@ -256,10 +253,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
256
253
  liveboardV2?: boolean;
257
254
  /**
258
255
  * If set to true, the Search Assist feature is enabled.
259
- * @default true
260
256
  *
257
+ * @default true
261
258
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
262
- *
263
259
  * @example
264
260
  * ```js
265
261
  * const embed = new AppEmbed('#tsEmbed', {
@@ -274,7 +270,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
274
270
  * according to the height of the pages which support fullHeight mode.
275
271
  *
276
272
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
277
- *
278
273
  * @example
279
274
  * ```js
280
275
  * const embed = new AppEmbed('#tsEmbed', {
@@ -297,7 +292,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
297
292
  *
298
293
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
299
294
  * @default false
300
- *
301
295
  * @example
302
296
  * ```js
303
297
  * const embed = new AppEmbed('#tsEmbed', {
@@ -312,7 +306,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
312
306
  *
313
307
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
314
308
  * @default false
315
- *
316
309
  * @example
317
310
  * ```js
318
311
  * const embed = new AppEmbed('#tsEmbed', {
@@ -327,7 +320,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
327
320
  *
328
321
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
329
322
  * @default false
330
- *
331
323
  * @example
332
324
  * ```js
333
325
  * const embed = new AppEmbed('#tsEmbed', {
@@ -341,7 +333,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
341
333
  * Flag to control new Modular Home experience.
342
334
  *
343
335
  * @default false
344
- * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
336
+ * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
345
337
  *
346
338
  * @example
347
339
  * ```js
@@ -423,8 +415,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
423
415
  }
424
416
 
425
417
  declare module '@thoughtspot/visual-embed-sdk/embed/base' {
418
+ import { AuthEventEmitter, notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout } from '@thoughtspot/visual-embed-sdk/auth';
426
419
  import { EmbedConfig, PrefetchFeatures } from '@thoughtspot/visual-embed-sdk/types';
427
- import { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, AuthEventEmitter } from '@thoughtspot/visual-embed-sdk/auth';
428
420
  export interface executeTMLInput {
429
421
  metadata_tmls: string[];
430
422
  import_policy?: 'PARTIAL' | 'ALL_OR_NONE' | 'VALIDATE_ONLY';
@@ -594,7 +586,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
594
586
  * incrementally as users scroll the page to view the charts and tables.
595
587
  *
596
588
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
597
- *
598
589
  * @example
599
590
  * ```js
600
591
  * const embed = new LiveboardEmbed('#embed', {
@@ -623,7 +614,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
623
614
  defaultHeight?: number;
624
615
  /**
625
616
  * @Deprecated If set to true, the context menu in visualizations will be enabled.
626
- *
627
617
  * @example
628
618
  * ```js
629
619
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -631,7 +621,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
631
621
  * enableVizTransformations:true,
632
622
  * })
633
623
  * ```
634
- *
635
624
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
636
625
  */
637
626
  enableVizTransformations?: boolean;
@@ -658,7 +647,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
658
647
  * The visualization within the Liveboard to display.
659
648
  *
660
649
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
661
- *
662
650
  * @example
663
651
  * ```js
664
652
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -688,7 +676,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
688
676
  * event.
689
677
  *
690
678
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
691
- *
692
679
  * @example
693
680
  * ```js
694
681
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -738,7 +725,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
738
725
  * Show or hide the tab panel of the embedded Liveboard.
739
726
  *
740
727
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
741
- *
742
728
  * @example
743
729
  * ```js
744
730
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -764,9 +750,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
764
750
  hideLiveboardHeader?: boolean;
765
751
  /**
766
752
  * Show or hide the Liveboard title.
753
+ *
767
754
  * @default false
768
755
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
769
- *
770
756
  * @example
771
757
  * ```js
772
758
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -778,9 +764,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
778
764
  showLiveboardTitle?: boolean;
779
765
  /**
780
766
  * Show or hide the Liveboard description.
767
+ *
781
768
  * @default false
782
769
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
783
- *
784
770
  * @example
785
771
  * ```js
786
772
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -878,7 +864,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
878
864
  * @summary Search embed
879
865
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
880
866
  */
881
- import { DOMSelector, Action, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
867
+ import { Action, DOMSelector, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
882
868
  import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
883
869
  /**
884
870
  * Configuration for search options.
@@ -908,7 +894,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
908
894
  * but can be expanded manually.
909
895
  *
910
896
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
911
- *
912
897
  * @example
913
898
  * ```js
914
899
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -922,7 +907,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
922
907
  * Show or hide the data sources panel.
923
908
  *
924
909
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
925
- *
926
910
  * @example
927
911
  * ```js
928
912
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -938,7 +922,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
938
922
  * using raw answer data.
939
923
  *
940
924
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
941
- *
942
925
  * @example
943
926
  * ```js
944
927
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -948,11 +931,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
948
931
  * ```
949
932
  */
950
933
  hideResults?: boolean;
934
+ /**
935
+ * If set to true, expands all the data sources panel.
936
+ */
937
+ expandAllDataSource?: boolean;
951
938
  /**
952
939
  * If set to true, the Search Assist feature is enabled.
953
940
  *
954
941
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
955
- *
956
942
  * @example
957
943
  * ```js
958
944
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -967,7 +953,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
967
953
  * format for presenting search data.
968
954
  *
969
955
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
970
- *
971
956
  * @example
972
957
  * ```js
973
958
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -981,7 +966,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
981
966
  * Only a single data source is supported currently.
982
967
  *
983
968
  * @deprecated Use `dataSource` instead.
984
- *
985
969
  * @example
986
970
  * ```js
987
971
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -995,7 +979,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
995
979
  * The array of data source GUIDs to set on load.
996
980
  *
997
981
  * @version: SDK: 1.19.0
998
- *
999
982
  * @example
1000
983
  * ```js
1001
984
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -1037,7 +1020,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1037
1020
  * The GUID of a saved answer to load initially.
1038
1021
  *
1039
1022
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
1040
- *
1041
1023
  * @example
1042
1024
  * ```js
1043
1025
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -1052,7 +1034,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1052
1034
  * The chart/table should still be visible.
1053
1035
  *
1054
1036
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1055
- *
1056
1037
  * @example
1057
1038
  * ```js
1058
1039
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -1067,7 +1048,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1067
1048
  *
1068
1049
  * @default false
1069
1050
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1070
- *
1071
1051
  * @example
1072
1052
  * ```js
1073
1053
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -1548,6 +1528,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1548
1528
  * .then((data) => data.token);
1549
1529
  * }
1550
1530
  * });
1531
+ * });
1551
1532
  * ```
1552
1533
  */
1553
1534
  TrustedAuthToken = "AuthServer",
@@ -1580,29 +1561,37 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1580
1561
  */
1581
1562
  Basic = "Basic"
1582
1563
  }
1564
+ /**
1565
+ *
1566
+ * This option does not apply to the classic homepage experience.
1567
+ * To access the updated modular homepage,
1568
+ * set `modularHomeExperience` to `true`
1569
+ * (available as Early Access feature in 9.12.5.cl).
1570
+ *
1571
+ */
1583
1572
  export enum HomeLeftNavItem {
1584
1573
  /**
1585
- * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1574
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1586
1575
  */
1587
1576
  SearchData = "search-data",
1588
1577
  /**
1589
- * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1578
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1590
1579
  */
1591
1580
  Home = "insights-home",
1592
1581
  /**
1593
- * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1582
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1594
1583
  */
1595
1584
  Liveboards = "liveboards",
1596
1585
  /**
1597
- * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1586
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1598
1587
  */
1599
1588
  Answers = "answers",
1600
1589
  /**
1601
- * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1590
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1602
1591
  */
1603
1592
  MonitorSubscription = "monitor-alerts",
1604
1593
  /**
1605
- * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
1594
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1606
1595
  */
1607
1596
  SpotIQAnalysis = "spotiq-analysis"
1608
1597
  }
@@ -2005,7 +1994,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2005
1994
  * object inside your app. Specify the values in pixels or percentage.
2006
1995
  *
2007
1996
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
2008
- *
2009
1997
  * @example
2010
1998
  * ```js
2011
1999
  * const embed = new LiveboardEmbed('#embed', {
@@ -2044,6 +2032,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2044
2032
  disabledActions?: Action[];
2045
2033
  /**
2046
2034
  * The tooltip to display for disabled actions.
2035
+ *
2047
2036
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2048
2037
  * @example
2049
2038
  * ```js
@@ -2061,7 +2050,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2061
2050
  * Use this to hide an action.
2062
2051
  *
2063
2052
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2064
- *
2065
2053
  * @example
2066
2054
  * ```js
2067
2055
  * const embed = new LiveboardEmbed('#embed', {
@@ -2082,7 +2070,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2082
2070
  *
2083
2071
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2084
2072
  * @important
2085
- *
2086
2073
  * @example
2087
2074
  * ```js
2088
2075
  * const embed = new LiveboardEmbed('#embed', {
@@ -2096,7 +2083,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2096
2083
  * Show alert messages and toast messages in the embedded view.
2097
2084
  *
2098
2085
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2099
- *
2100
2086
  * @example
2101
2087
  * ```js
2102
2088
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2111,7 +2097,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2111
2097
  * visualization, or Liveboard.
2112
2098
  *
2113
2099
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2114
- *
2115
2100
  * @example
2116
2101
  * ```js
2117
2102
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2132,7 +2117,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2132
2117
  * visualization, or Liveboard.
2133
2118
  *
2134
2119
  * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
2135
- *
2136
2120
  * @example
2137
2121
  * ```js
2138
2122
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2167,6 +2151,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2167
2151
  * Warning: This option is for advanced use only and is used internally
2168
2152
  * to control embed behavior in non-regular ways. We do not publish the
2169
2153
  * list of supported keys and values associated with each.
2154
+ *
2170
2155
  * @example
2171
2156
  * ```js
2172
2157
  * const embed = new LiveboardEmbed('#embed', {
@@ -2195,7 +2180,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2195
2180
  * child inside it.
2196
2181
  *
2197
2182
  * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
2198
- *
2199
2183
  * @example
2200
2184
  * ```js
2201
2185
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2281,11 +2265,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2281
2265
  * Hide the home page modules
2282
2266
  * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
2283
2267
  *
2268
+ *
2269
+ *
2284
2270
  * **Note**: This option does not apply to the classic homepage.
2285
2271
  * To access the updated modular homepage, set
2286
- * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
2272
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.0.cl).
2287
2273
  *
2288
- * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
2274
+ * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2289
2275
  * @example
2290
2276
  * ```js
2291
2277
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2293,18 +2279,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2293
2279
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
2294
2280
  * })
2295
2281
  * ```
2296
- *
2297
2282
  */
2298
2283
  hiddenHomepageModules?: HomepageModule[];
2299
2284
  /**
2300
2285
  * reordering the home page modules
2301
2286
  * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
2302
2287
  *
2288
+ *
2303
2289
  * **Note**: This option does not apply to the classic homepage.
2304
2290
  * To access the updated modular homepage, set
2305
- * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl onwards).
2291
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2306
2292
  *
2307
- * @version SDK: 1.27.9| Thoughtspot: 9.12.0.cl
2293
+ * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
2308
2294
  *
2309
2295
  * @example
2310
2296
  * ```js
@@ -2322,7 +2308,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2322
2308
  * Use either `visibleTabs` or `hiddenTabs`.
2323
2309
  *
2324
2310
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2325
- *
2326
2311
  * @example
2327
2312
  * ```js
2328
2313
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2341,8 +2326,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2341
2326
  * To hide these items, specify the string in the array.
2342
2327
  *
2343
2328
  * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
2344
- *
2345
- * * @example
2329
+ * @example
2346
2330
  * ```js
2347
2331
  * const embed = new AppEmbed('#tsEmbed', {
2348
2332
  * ... // other options
@@ -2350,11 +2334,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2350
2334
  * })
2351
2335
  * ```
2352
2336
  *
2337
+ *
2338
+ *
2353
2339
  * **Note**: This option does not apply to the classic homepage.
2354
2340
  * To access the updated modular homepage, set
2355
2341
  * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
2356
2342
  *
2357
- * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
2343
+ * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2358
2344
  */
2359
2345
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
2360
2346
  /**
@@ -2382,7 +2368,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2382
2368
  * @type {boolean}
2383
2369
  * @default false
2384
2370
  * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
2385
- *
2386
2371
  * @example
2387
2372
  * ```js
2388
2373
  * // Disable tracking PreRender size in the configuration
@@ -2513,7 +2498,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2513
2498
  IN = "IN"
2514
2499
  }
2515
2500
  /**
2516
- * Home page module that can be hidden
2501
+ * Home page module that can be hidden.
2502
+ * **Note**: This option does not apply to the classic homepage.
2503
+ * To access the updated modular homepage, set
2504
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2505
+ *
2506
+ * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2517
2507
  */
2518
2508
  export enum HomepageModule {
2519
2509
  /**
@@ -2534,10 +2524,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2534
2524
  MyLibrary = "MY_LIBRARY",
2535
2525
  /**
2536
2526
  * Trending list
2537
- *
2538
- * **Note**: This option does not apply to the classic homepage.
2539
- * To access the updated modular homepage, set
2540
- * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl onwards).
2541
2527
  */
2542
2528
  Trending = "TRENDING",
2543
2529
  /**
@@ -2785,7 +2771,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2785
2771
  *
2786
2772
  * API - API call failure error.
2787
2773
  *
2788
- * FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
2774
+ * FULLSCREEN - Error when presenting a Liveboard or visualization in full screen
2775
+ * mode.
2789
2776
  *
2790
2777
  * SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
2791
2778
  *
@@ -6182,18 +6169,6 @@ declare module '@thoughtspot/visual-embed-sdk/tokenizedFetch' {
6182
6169
  export const tokenizedFetch: typeof fetch;
6183
6170
  }
6184
6171
 
6185
- declare module '@thoughtspot/visual-embed-sdk/authToken' {
6186
- import { EmbedConfig } from '@thoughtspot/visual-embed-sdk/types';
6187
- export const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
6188
- /**
6189
- * Resets the auth token and a new token will be fetched on the next request.
6190
- *
6191
- * @version SDK: 1.28.0 | ThoughtSpot: *
6192
- * @group Authentication / Init
6193
- */
6194
- export const resetCachedAuthToken: () => void;
6195
- }
6196
-
6197
6172
  declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
6198
6173
  /**
6199
6174
  * Copyright (c) 2022
@@ -6203,8 +6178,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
6203
6178
  * @summary Base classes
6204
6179
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
6205
6180
  */
6181
+ import { DOMSelector, EmbedConfig, EmbedEvent, HostEvent, MessageCallback, MessageOptions, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
6206
6182
  import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
6207
- import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
6208
6183
  /**
6209
6184
  * Global prefix for all Thoughtspot postHash Params.
6210
6185
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.28.0-alpha.5",
3
+ "version": "1.28.0",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
@@ -38,7 +38,7 @@
38
38
  "size-limit": [
39
39
  {
40
40
  "path": "dist/tsembed.js",
41
- "limit": "44 kB"
41
+ "limit": "45 kB"
42
42
  }
43
43
  ],
44
44
  "scripts": {
package/src/auth.ts CHANGED
@@ -1,18 +1,18 @@
1
1
  import EventEmitter from 'eventemitter3';
2
+ import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
2
3
  import { initMixpanel } from './mixpanel-service';
3
4
  import {
4
- AuthType, DOMSelector, EmbedConfig, EmbedEvent, Param,
5
+ AuthType, DOMSelector, EmbedConfig, EmbedEvent,
5
6
  } from './types';
6
7
  import { getDOMNode, getRedirectUrl } from './utils';
7
8
  import {
8
- fetchSessionInfoService,
9
+ EndPoints,
10
+ fetchAuthPostService,
9
11
  fetchAuthService,
10
12
  fetchBasicAuthService,
11
13
  fetchLogoutService,
12
- fetchAuthPostService,
13
- EndPoints,
14
+ fetchSessionInfoService,
14
15
  } from './utils/authService';
15
- import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
16
16
  import { logger } from './utils/logger';
17
17
  import { getEmbedConfig } from './embed/embedConfig';
18
18
 
@@ -492,7 +492,7 @@ export const logout = async (embedConfig: EmbedConfig): Promise<boolean> => {
492
492
  const { thoughtSpotHost } = embedConfig;
493
493
  await fetchLogoutService(thoughtSpotHost);
494
494
  resetCachedAuthToken();
495
- const thoughtspotIframes = document.querySelectorAll('[data-ts-iframe=\'true\']');
495
+ const thoughtspotIframes = document.querySelectorAll("[data-ts-iframe='true']");
496
496
  if (thoughtspotIframes?.length) {
497
497
  thoughtspotIframes.forEach((el) => {
498
498
  el.parentElement.innerHTML = embedConfig.loginFailedMessage;
package/src/authToken.ts CHANGED
@@ -61,12 +61,6 @@ const validateAuthToken = async (
61
61
  }
62
62
  };
63
63
 
64
- /**
65
- * Resets the auth token and a new token will be fetched on the next request.
66
- *
67
- * @version SDK: 1.28.0 | ThoughtSpot: *
68
- * @group Authentication / Init
69
- */
70
64
  export const resetCachedAuthToken = (): void => {
71
65
  cachedAuthToken = null;
72
66
  };