@thoughtspot/visual-embed-sdk 1.13.0 → 1.14.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 (59) hide show
  1. package/CHANGELOG.md +7 -2
  2. package/dist/src/embed/app.d.ts +4 -3
  3. package/dist/src/embed/base.d.ts +1 -1
  4. package/dist/src/embed/liveboard.d.ts +6 -8
  5. package/dist/src/embed/pinboard.d.ts +91 -0
  6. package/dist/src/embed/search.d.ts +1 -1
  7. package/dist/src/embed/ts-embed.d.ts +4 -4
  8. package/dist/src/types.d.ts +83 -76
  9. package/dist/src/utils/authService.d.ts +1 -0
  10. package/dist/src/utils/plugin.d.ts +0 -0
  11. package/dist/src/v1/api.d.ts +19 -0
  12. package/dist/tsembed.es.js +103 -76
  13. package/dist/tsembed.js +103 -76
  14. package/lib/package.json +1 -1
  15. package/lib/src/auth.js +8 -2
  16. package/lib/src/auth.js.map +1 -1
  17. package/lib/src/auth.spec.js +18 -0
  18. package/lib/src/auth.spec.js.map +1 -1
  19. package/lib/src/embed/app.d.ts +4 -3
  20. package/lib/src/embed/app.js +2 -1
  21. package/lib/src/embed/app.js.map +1 -1
  22. package/lib/src/embed/base.d.ts +1 -1
  23. package/lib/src/embed/base.js +1 -1
  24. package/lib/src/embed/liveboard.d.ts +6 -8
  25. package/lib/src/embed/liveboard.js.map +1 -1
  26. package/lib/src/embed/pinboard.d.ts +91 -0
  27. package/lib/src/embed/pinboard.js +110 -0
  28. package/lib/src/embed/pinboard.js.map +1 -0
  29. package/lib/src/embed/search.d.ts +1 -1
  30. package/lib/src/embed/ts-embed.d.ts +4 -4
  31. package/lib/src/types.d.ts +83 -76
  32. package/lib/src/types.js +73 -68
  33. package/lib/src/types.js.map +1 -1
  34. package/lib/src/utils/authService.d.ts +1 -0
  35. package/lib/src/utils/authService.js +13 -0
  36. package/lib/src/utils/authService.js.map +1 -1
  37. package/lib/src/utils/authService.spec.js +15 -1
  38. package/lib/src/utils/authService.spec.js.map +1 -1
  39. package/lib/src/utils/plugin.d.ts +0 -0
  40. package/lib/src/utils/plugin.js +1 -0
  41. package/lib/src/utils/plugin.js.map +1 -0
  42. package/lib/src/utils/processData.js +7 -5
  43. package/lib/src/utils/processData.js.map +1 -1
  44. package/lib/src/utils/processData.spec.js +14 -0
  45. package/lib/src/utils/processData.spec.js.map +1 -1
  46. package/lib/src/visual-embed-sdk.d.ts +99 -93
  47. package/package.json +1 -1
  48. package/src/auth.spec.ts +39 -0
  49. package/src/auth.ts +11 -5
  50. package/src/embed/app.ts +4 -3
  51. package/src/embed/base.ts +1 -1
  52. package/src/embed/liveboard.ts +6 -8
  53. package/src/embed/search.ts +1 -1
  54. package/src/embed/ts-embed.ts +4 -4
  55. package/src/types.ts +83 -76
  56. package/src/utils/authService.spec.ts +21 -0
  57. package/src/utils/authService.ts +20 -0
  58. package/src/utils/processData.spec.ts +17 -0
  59. package/src/utils/processData.ts +7 -5
@@ -106,13 +106,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
106
106
  * Render liveboards using the new v2 rendering mode
107
107
  * This is a transient flag which is primarily meant for internal use
108
108
  * @default false
109
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
109
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
110
110
  * @hidden
111
111
  */
112
112
  liveboardV2?: boolean;
113
113
  /**
114
114
  * If set to true, the Search Assist feature is enabled.
115
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
115
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
116
116
  */
117
117
  enableSearchAssist?: boolean;
118
118
  }
@@ -129,7 +129,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
129
129
  * @param path string | number The string, set to iframe src and navigate to new page
130
130
  * eg: appEmbed.navigateToPage('pinboards')
131
131
  * When used with `noReload` this can also be a number like 1/-1 to go forward/back.
132
- * @param noReload boolean Trigger the navigation without reloading the page (version: 1.12.0 | 8.4.0.cl)
132
+ * @param noReload boolean Trigger the navigation without reloading the page
133
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
133
134
  */
134
135
  navigateToPage(path: string | number, noReload?: boolean): void;
135
136
  /**
@@ -191,7 +192,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
191
192
  *
192
193
  * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
193
194
  * @returns Promise which resolves when logout completes.
194
- * @version SDK: 1.10.1 | ThoughtSpot: *
195
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
195
196
  */
196
197
  export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
197
198
  /**
@@ -229,7 +230,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
229
230
  * This is the minimum height(in pixels) for a full height Liveboard.
230
231
  * Setting this height helps resolves issues with empty Liveboards and
231
232
  * other screens navigable from a Liveboard.
232
- * @version 1.5.0 or later
233
+ * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
233
234
  * @default 500
234
235
  */
235
236
  defaultHeight?: number;
@@ -243,7 +244,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
243
244
  */
244
245
  liveboardId?: string;
245
246
  /**
246
- * To support backward compatibilty
247
+ * To support backward compatibility
247
248
  * @hidden
248
249
  */
249
250
  pinboardId?: string;
@@ -260,7 +261,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
260
261
  * Array of viz ids which should be visible when the liveboard
261
262
  * first renders. This can be changed by triggering the "SetVisibleVizs"
262
263
  * event.
263
- * @version 1.9.1 or later
264
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
264
265
  */
265
266
  visibleVizs?: string[];
266
267
  /**
@@ -269,16 +270,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
269
270
  */
270
271
  preventPinboardFilterRemoval?: boolean;
271
272
  /**
272
- * Render embedded liveboards and visualizations using the new v2 rendering mode
273
- * This is a transient flag which is primarily meant for internal use
273
+ * Render embedded Liveboards and visualizations in the new Liveboard experience mode
274
274
  * @default false
275
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
276
- * @hidden
275
+ * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
277
276
  */
278
277
  liveboardV2?: boolean;
279
278
  /**
280
279
  * Tab Id of the Liveboard that is supposed to be active
281
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
280
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
282
281
  */
283
282
  activeTabId?: string;
284
283
  }
@@ -362,7 +361,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
362
361
  expandAllDataSource?: boolean;
363
362
  /**
364
363
  * If set to true, the Search Assist feature is enabled.
365
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
364
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
366
365
  */
367
366
  enableSearchAssist?: boolean;
368
367
  /**
@@ -490,9 +489,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
490
489
  */
491
490
  export enum AuthType {
492
491
  /**
493
- * No authentication. Use this only for testing purposes.
492
+ * No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
494
493
  */
495
494
  None = "None",
495
+ /**
496
+ * No authentication on the SDK. Passthrough to the embedded App.
497
+ */
498
+ Passthrough = "None",
496
499
  /**
497
500
  * SSO using SAML
498
501
  * @deprecated Use {@link SAML} instead
@@ -599,7 +602,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
599
602
  * terminated.
600
603
  *
601
604
  * Eg: "/dashboard", "#/foo" [Do not include the host]
602
- * @version SDK: 1.10.2 | ThoughtSpot: *
605
+ * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
603
606
  */
604
607
  redirectPath?: string;
605
608
  /** @internal */
@@ -627,13 +630,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
627
630
  /**
628
631
  * Disable redirection to the login page when the embedded session expires
629
632
  * This flag is typically used alongside the combination of auth modes such as {@link AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
630
- * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl
633
+ * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
631
634
  * @default false
632
635
  */
633
636
  disableLoginRedirect?: boolean;
634
637
  /**
635
638
  * This message is displayed on the embed view when the login fails.
636
- * @version 1.10.1 | ThoughtSpot: *
639
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
637
640
  */
638
641
  loginFailedMessage?: string;
639
642
  /**
@@ -645,14 +648,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
645
648
  * When there are multiple embeds, queue the render of embed to start
646
649
  * after the previous embed's render is complete. This helps in the load performance
647
650
  * by decreasing the load on the browser.
648
- * @version 1.5.0 or later
651
+ * @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
649
652
  * @default false
650
653
  */
651
654
  queueMultiRenders?: boolean;
652
655
  /**
653
656
  * Dynamic CSS Url to be injected in the loaded application.
654
657
  * You would also need to set `style-src` in the CSP settings.
655
- * @version 1.6.0 or later
658
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
656
659
  * @default ''
657
660
  */
658
661
  customCssUrl?: string;
@@ -661,17 +664,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
661
664
  * and should be avoided. Listen to the NO_COOKIE_ACCESS event to handle the situation.
662
665
  *
663
666
  * This is slightly slower than letting the browser handle the cookie check, as it involves an extra network call.
664
- * @version SDK: 1.10.4 | ThoughtSpot: *
667
+ * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
665
668
  */
666
669
  detectCookieAccessSlow?: boolean;
667
670
  /**
668
671
  * Hide beta alert warning message for SearchEmbed.
669
672
  *
670
- * @version SDK: 1.12.0 | ThoughtSpot: *
673
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
671
674
  */
672
675
  suppressSearchEmbedBetaWarning?: boolean;
673
676
  /**
674
- * Custom style params for embed Config
677
+ * Custom style params for embed Config.
678
+ *
679
+ * @version SDK: 1.16.0 | ThoughtSpot: 8.8.0.cl, 8.8.1-sw
675
680
  */
676
681
  customisations?: CustomisationsInterface;
677
682
  }
@@ -832,7 +837,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
832
837
  /**
833
838
  * One or more data columns have been selected.
834
839
  * @return columnIds - the list of columns
835
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl
840
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
836
841
  */
837
842
  AddRemoveColumns = "addRemoveColumns",
838
843
  /**
@@ -844,13 +849,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
844
849
  /**
845
850
  * A double click has been triggered on table/chart
846
851
  * @return ContextMenuInputPoints - data point that is double clicked
847
- * @version 1.5.0 or later
852
+ * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
848
853
  */
849
854
  VizPointDoubleClick = "vizPointDoubleClick",
850
855
  /**
851
856
  * A click has been triggered on table/chart
852
857
  * @return ContextMenuInputPoints - data point that is clicked
853
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
858
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
854
859
  */
855
860
  VizPointClick = "vizPointClick",
856
861
  /**
@@ -902,7 +907,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
902
907
  * Emitted when the embed does not have cookie access. This
903
908
  * happens on Safari where third-party cookies are blocked by default.
904
909
  *
905
- * @version 1.1.0 or later
910
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
906
911
  */
907
912
  NoCookieAccess = "noCookieAccess",
908
913
  /**
@@ -913,179 +918,180 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
913
918
  SAMLComplete = "samlComplete",
914
919
  /**
915
920
  * Emitted when any modal is opened in the app
916
- * @version 1.6.0 or later
921
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
917
922
  */
918
923
  DialogOpen = "dialog-open",
919
924
  /**
920
925
  * Emitted when any modal is closed in the app
921
- * @version 1.6.0 or later
926
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
922
927
  */
923
928
  DialogClose = "dialog-close",
924
929
  /**
925
930
  * Emitted when a liveboard has completed rendering,
926
931
  * this event can be used as a hook to trigger events on the
927
932
  * rendered liveboard
928
- * @version 1.9.1 or later
933
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
929
934
  */
930
935
  LiveboardRendered = "PinboardRendered",
931
936
  /**
932
937
  * This can be used to register an event listener which
933
938
  * is triggered on all events.
934
- * @version SDK: 1.10.0 | ThoughtSpot: any
939
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
935
940
  */
936
941
  ALL = "*",
937
942
  /**
938
943
  * Emitted when answer is saved in the app
939
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
944
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
940
945
  */
941
946
  Save = "save",
942
947
  /**
943
948
  * Emitted when the download action is triggered on an answer
944
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
949
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
945
950
  */
946
951
  Download = "download",
947
952
  /**
948
953
  * Emitted when the Download as PDF action is triggered on an answer
949
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
954
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
950
955
  */
951
956
  DownloadAsPdf = "downloadAsPdf",
952
957
  /**
953
958
  * Emitted when the Download as CSV action is triggered on an answer
954
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
959
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
955
960
  */
956
961
  DownloadAsCsv = "downloadAsCsv",
957
962
  /**
958
963
  * Emitted when the Download as XLSX action is triggered on an answer
959
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
964
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
960
965
  */
961
966
  DownloadAsXlsx = "downloadAsXlsx",
962
967
  /**
963
968
  * Emitted when an answer is deleted in the app
964
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
969
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
965
970
  */
966
971
  AnswerDelete = "answerDelete",
967
972
  /**
968
973
  * Emitted when an answer is pinned to a Liveboard
969
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
974
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
970
975
  */
971
976
  Pin = "pin",
972
977
  /**
973
978
  * Emitted when SpotIQ analysis is triggered
974
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
979
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
975
980
  */
976
981
  SpotIQAnalyze = "spotIQAnalyze",
977
982
  /**
978
983
  * Emitted when a user shares an object with another user or group
979
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
984
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
980
985
  */
981
986
  Share = "share",
982
987
  /**
983
988
  * Emitted when a user clicks the Include action to include a specific value or data on a chart or table
984
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
989
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
985
990
  */
986
991
  DrillInclude = "context-menu-item-include",
987
992
  /**
988
993
  * Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table
989
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
994
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
990
995
  */
991
996
  DrillExclude = "context-menu-item-exclude",
992
997
  /**
993
998
  * Emitted when copied column value on the app
994
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
999
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
995
1000
  */
996
1001
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
997
1002
  /**
998
1003
  * Emitted when a user clicks the Update TML action
999
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
1004
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1000
1005
  */
1001
1006
  UpdateTML = "updateTSL",
1002
1007
  /**
1003
1008
  * Emitted when a user clicks the Edit TML action
1004
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
1009
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1005
1010
  */
1006
1011
  EditTML = "editTSL",
1007
1012
  /**
1008
1013
  * Emitted when ExportTML trigger in answer on the app
1009
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
1014
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1010
1015
  */
1011
1016
  ExportTML = "exportTSL",
1012
1017
  /**
1013
1018
  * Emitted when an answer is saved as a view
1014
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
1019
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1015
1020
  */
1016
1021
  SaveAsView = "saveAsView",
1017
1022
  /**
1018
1023
  * Emitted when copy of existing answer on the app
1019
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
1024
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1020
1025
  */
1021
1026
  CopyAEdit = "copyAEdit",
1022
1027
  /**
1023
1028
  * Emitted when a user clicks Show underlying data on an answe
1024
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
1029
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1025
1030
  */
1026
1031
  ShowUnderlyingData = "showUnderlyingData",
1027
1032
  /**
1028
1033
  * Emitted when an answer is switched to a chart or table view
1029
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
1034
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1030
1035
  */
1031
1036
  AnswerChartSwitcher = "answerChartSwitcher",
1032
1037
  /**
1033
- *
1038
+ * Internal event to communicate the initial settings back to the TS APP
1039
+ * @hidden
1034
1040
  */
1035
1041
  APP_INIT = "appInit",
1036
1042
  /**
1037
1043
  * Emitted when a user clicks Show Liveboard details on a Liveboard
1038
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1044
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1039
1045
  */
1040
1046
  LiveboardInfo = "pinboardInfo",
1041
1047
  /**
1042
1048
  * Emitted when a user clicks on the Favorite icon on a Liveboard
1043
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1049
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1044
1050
  */
1045
1051
  AddToFavorites = "addToFavorites",
1046
1052
  /**
1047
1053
  * Emitted when a user clicks Schedule on a Liveboard
1048
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1054
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1049
1055
  */
1050
1056
  Schedule = "subscription",
1051
1057
  /**
1052
1058
  * Emitted when a user clicks Edit on a Liveboard or visualization
1053
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1059
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1054
1060
  */
1055
1061
  Edit = "edit",
1056
1062
  /**
1057
1063
  * Emitted when a user clicks Make a copy on a Liveboard
1058
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1064
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1059
1065
  */
1060
1066
  MakeACopy = "makeACopy",
1061
1067
  /**
1062
1068
  * Emitted when a user clicks Present on a Liveboard or visualization
1063
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1069
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1064
1070
  */
1065
1071
  Present = "present",
1066
1072
  /**
1067
1073
  * Emitted when a user clicks Delete on a Liveboard
1068
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1074
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1069
1075
  */
1070
1076
  Delete = "delete",
1071
1077
  /**
1072
1078
  * Emitted when a user clicks Manage schedules on a Liveboard
1073
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1079
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1074
1080
  */
1075
1081
  SchedulesList = "schedule-list",
1076
1082
  /**
1077
1083
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
1078
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1084
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1079
1085
  */
1080
1086
  Cancel = "cancel",
1081
1087
  /**
1082
1088
  * Emitted when a user clicks Explore on a visualization
1083
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1089
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1084
1090
  */
1085
1091
  Explore = "explore",
1086
1092
  /**
1087
1093
  * Emitted when a user clicks Copy link action on a visualization
1088
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1094
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1089
1095
  */
1090
1096
  CopyLink = "embedDocument"
1091
1097
  }
@@ -1108,8 +1114,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1108
1114
  * @param points - an object containing selectedPoints/clickedPoints
1109
1115
  * eg. { selectedPoints: []}
1110
1116
  * @param columnGuid - a string guid of the column to drill by. This is optional,
1111
- * if not provided it will auto drill by the configured column. \
1112
- * @version 1.5.0 or later
1117
+ * if not provided it will auto drill by the configured column.
1118
+ * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
1113
1119
  */
1114
1120
  DrillDown = "triggerDrillDown",
1115
1121
  /**
@@ -1126,97 +1132,97 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1126
1132
  * Set the visible visualizations on a Liveboard.
1127
1133
  * @param - an array of ids of visualizations to show, the ids not passed
1128
1134
  * will be hidden.
1129
- * @version 1.6.0 or later
1135
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1130
1136
  */
1131
1137
  SetVisibleVizs = "SetPinboardVisibleVizs",
1132
1138
  /**
1133
1139
  * Update the runtime filters. The runtime filters passed here are extended
1134
1140
  * on to the existing runtime filters if they exist.
1135
1141
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1136
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
1142
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1137
1143
  */
1138
1144
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
1139
1145
  /**
1140
1146
  * Navigate to a specific page in App embed without any reload.
1141
1147
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
1142
1148
  * @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
1143
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl
1149
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
1144
1150
  */
1145
1151
  Navigate = "Navigate",
1146
1152
  /**
1147
1153
  * Gets the current pinboard content.
1148
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
1154
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
1149
1155
  */
1150
1156
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
1151
1157
  /**
1152
1158
  * Triggers the Pin action on an embedded object
1153
1159
  * @param - incase of Liveboard embed, takes in an object with vizId as a key
1154
1160
  * can be left empty for search and visualization embeds
1155
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1161
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1156
1162
  */
1157
1163
  Pin = "pin",
1158
1164
  /**
1159
1165
  * Triggers the Show Liveboard details action on a Liveboard
1160
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1166
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1161
1167
  */
1162
1168
  LiveboardInfo = "pinboardInfo",
1163
1169
  /**
1164
1170
  * Triggers the Schedule action on a Liveboard
1165
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1171
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1166
1172
  */
1167
1173
  Schedule = "subscription",
1168
1174
  /**
1169
1175
  * Triggers the Manage schedule action on a Liveboard
1170
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1176
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1171
1177
  */
1172
1178
  SchedulesList = "schedule-list",
1173
1179
  /**
1174
1180
  * Triggers the Export TML action on a Liveboard
1175
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1181
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1176
1182
  */
1177
1183
  ExportTML = "exportTSL",
1178
1184
  /**
1179
1185
  * Triggers the Edit TML action on a Liveboard
1180
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1186
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1181
1187
  */
1182
1188
  EditTML = "editTSL",
1183
1189
  /**
1184
1190
  * Triggers the Update TML action on a Liveboard
1185
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1191
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1186
1192
  */
1187
1193
  UpdateTML = "updateTSL",
1188
1194
  /**
1189
1195
  * Triggers the Download PDF action on a Liveboard
1190
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1196
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1191
1197
  */
1192
1198
  DownloadAsPdf = "downloadAsPdf",
1193
1199
  /**
1194
1200
  * Triggers the Make a copy action on a Liveboard
1195
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1201
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1196
1202
  */
1197
1203
  MakeACopy = "makeACopy",
1198
1204
  /**
1199
1205
  * Triggers the Delete action on a Liveboard
1200
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1206
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1201
1207
  */
1202
1208
  Remove = "delete",
1203
1209
  /**
1204
1210
  * Triggers the Explore action on a visualization
1205
1211
  * @param - an object with vizId as a key
1206
1212
  * eg: {vizId: '730496d6-6903-4601-937e-2c691821af3c'}
1207
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1213
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1208
1214
  */
1209
1215
  Explore = "explore",
1210
1216
  /**
1211
1217
  * Triggers the Create alert action on a visualization
1212
1218
  * @param - an object with vizId as a key
1213
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1219
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1214
1220
  */
1215
1221
  CreateMonitor = "createMonitor",
1216
1222
  /**
1217
1223
  * Triggers the Manage alert action on a visualization
1218
1224
  * @param - an object with vizId as a key
1219
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1225
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1220
1226
  */
1221
1227
  ManageMonitor = "manageMonitor",
1222
1228
  /**
@@ -1226,7 +1232,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1226
1232
  * liveboardEmbed.trigger(HostEvent.Edit)
1227
1233
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1228
1234
  * vizEmbed.trigger((HostEvent.Edit)
1229
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1235
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1230
1236
  */
1231
1237
  Edit = "edit",
1232
1238
  /**
@@ -1236,7 +1242,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1236
1242
  * liveboardEmbed.trigger(HostEvent.CopyLink)
1237
1243
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1238
1244
  * vizEmbed.trigger((HostEvent.CopyLink)
1239
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1245
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1240
1246
  */
1241
1247
  CopyLink = "embedDocument",
1242
1248
  /**
@@ -1246,7 +1252,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1246
1252
  * liveboardEmbed.trigger(HostEvent.Present)
1247
1253
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1248
1254
  * vizEmbed.trigger((HostEvent.Present)
1249
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
1255
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1250
1256
  */
1251
1257
  Present = "present"
1252
1258
  }
@@ -1426,27 +1432,27 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1426
1432
  RequestAccess = "requestAccess",
1427
1433
  QueryDetailsButtons = "queryDetailsButtons",
1428
1434
  /**
1429
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
1435
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1430
1436
  */
1431
1437
  AnswerDelete = "onDeleteAnswer",
1432
1438
  /**
1433
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
1439
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1434
1440
  */
1435
1441
  AnswerChartSwitcher = "answerChartSwitcher",
1436
1442
  /**
1437
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
1443
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1438
1444
  */
1439
1445
  AddToFavorites = "addToFavorites",
1440
1446
  /**
1441
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
1447
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1442
1448
  */
1443
1449
  EditDetails = "editDetails",
1444
1450
  /**
1445
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
1451
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1446
1452
  */
1447
1453
  CreateMonitor = "createMonitor",
1448
1454
  /**
1449
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl
1455
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1450
1456
  */
1451
1457
  ReportError = "reportError"
1452
1458
  }
@@ -1539,12 +1545,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
1539
1545
  /**
1540
1546
  * The list of actions to display from the primary menu, more menu
1541
1547
  * (...), and the contextual menu.
1542
- * @version 1.6.0 or later
1548
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1543
1549
  */
1544
1550
  visibleActions?: Action[];
1545
1551
  /**
1546
1552
  * Show alert messages and toast messages in the embedded view.
1547
- * @version 1.11.0 | ThoughtSpot: 8.3.0.cl
1553
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1548
1554
  */
1549
1555
  showAlerts?: boolean;
1550
1556
  /**
@@ -1554,7 +1560,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
1554
1560
  runtimeFilters?: RuntimeFilter[];
1555
1561
  /**
1556
1562
  * The locale/language to use for the embedded view.
1557
- * @version 1.9.4 or later
1563
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
1558
1564
  */
1559
1565
  locale?: string;
1560
1566
  /**
@@ -1564,7 +1570,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
1564
1570
  * Warning: This option is for advanced use only and is used internally
1565
1571
  * to control embed behavior in non-regular ways. We do not publish the
1566
1572
  * list of supported keys and values associated with each.
1567
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
1573
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1568
1574
  */
1569
1575
  additionalFlags?: {
1570
1576
  [key: string]: string | number | boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.13.0",
3
+ "version": "1.14.1",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",