@thoughtspot/visual-embed-sdk 1.27.0-alpha.0 → 1.27.0-alpha.2

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 (128) hide show
  1. package/README.md +2 -2
  2. package/cjs/.DS_Store +0 -0
  3. package/cjs/package.json +1 -1
  4. package/cjs/src/.DS_Store +0 -0
  5. package/cjs/src/embed/app.d.ts +0 -1
  6. package/cjs/src/embed/app.d.ts.map +1 -1
  7. package/cjs/src/embed/app.js +1 -1
  8. package/cjs/src/embed/app.js.map +1 -1
  9. package/cjs/src/embed/liveboard.d.ts +0 -1
  10. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  11. package/cjs/src/embed/liveboard.js +1 -1
  12. package/cjs/src/embed/liveboard.js.map +1 -1
  13. package/cjs/src/embed/sage.d.ts +0 -1
  14. package/cjs/src/embed/sage.d.ts.map +1 -1
  15. package/cjs/src/embed/sage.js +7 -6
  16. package/cjs/src/embed/sage.js.map +1 -1
  17. package/cjs/src/embed/sage.spec.js +3 -3
  18. package/cjs/src/embed/sage.spec.js.map +1 -1
  19. package/cjs/src/embed/search.d.ts +0 -1
  20. package/cjs/src/embed/search.d.ts.map +1 -1
  21. package/cjs/src/embed/search.js +2 -3
  22. package/cjs/src/embed/search.js.map +1 -1
  23. package/cjs/src/embed/ts-embed.d.ts +0 -1
  24. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  25. package/cjs/src/embed/ts-embed.js +1 -3
  26. package/cjs/src/embed/ts-embed.js.map +1 -1
  27. package/cjs/src/types.d.ts +19 -49
  28. package/cjs/src/types.d.ts.map +1 -1
  29. package/cjs/src/types.js +12 -49
  30. package/cjs/src/types.js.map +1 -1
  31. package/cjs/src/utils/answerService.d.ts +10 -0
  32. package/cjs/src/utils/answerService.d.ts.map +1 -0
  33. package/cjs/src/utils/answerService.js +61 -0
  34. package/cjs/src/utils/answerService.js.map +1 -0
  35. package/cjs/src/utils/answerService.spec.d.ts +2 -0
  36. package/cjs/src/utils/answerService.spec.d.ts.map +1 -0
  37. package/cjs/src/utils/answerService.spec.js +31 -0
  38. package/cjs/src/utils/answerService.spec.js.map +1 -0
  39. package/cjs/src/utils/authService.d.ts +37 -0
  40. package/cjs/src/utils/authService.d.ts.map +1 -0
  41. package/cjs/src/utils/authService.js +106 -0
  42. package/cjs/src/utils/authService.js.map +1 -0
  43. package/cjs/src/utils/authService.spec.d.ts +2 -0
  44. package/cjs/src/utils/authService.spec.d.ts.map +1 -0
  45. package/cjs/src/utils/authService.spec.js +72 -0
  46. package/cjs/src/utils/authService.spec.js.map +1 -0
  47. package/dist/src/embed/app.d.ts +0 -1
  48. package/dist/src/embed/app.d.ts.map +1 -1
  49. package/dist/src/embed/liveboard.d.ts +0 -1
  50. package/dist/src/embed/liveboard.d.ts.map +1 -1
  51. package/dist/src/embed/sage.d.ts +0 -1
  52. package/dist/src/embed/sage.d.ts.map +1 -1
  53. package/dist/src/embed/search.d.ts +0 -1
  54. package/dist/src/embed/search.d.ts.map +1 -1
  55. package/dist/src/embed/ts-embed.d.ts +0 -1
  56. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  57. package/dist/src/types.d.ts +19 -49
  58. package/dist/src/types.d.ts.map +1 -1
  59. package/dist/src/utils/answerService.d.ts +10 -0
  60. package/dist/src/utils/answerService.d.ts.map +1 -0
  61. package/dist/src/utils/answerService.spec.d.ts +2 -0
  62. package/dist/src/utils/answerService.spec.d.ts.map +1 -0
  63. package/dist/src/utils/authService.d.ts +37 -0
  64. package/dist/src/utils/authService.d.ts.map +1 -0
  65. package/dist/src/utils/authService.spec.d.ts +2 -0
  66. package/dist/src/utils/authService.spec.d.ts.map +1 -0
  67. package/dist/tsembed-react.es.js +25 -64
  68. package/dist/tsembed-react.js +25 -64
  69. package/dist/tsembed.es.js +25 -64
  70. package/dist/tsembed.js +25 -64
  71. package/dist/visual-embed-sdk-react-full.d.ts +19 -54
  72. package/dist/visual-embed-sdk-react.d.ts +19 -54
  73. package/dist/visual-embed-sdk.d.ts +19 -54
  74. package/lib/.DS_Store +0 -0
  75. package/lib/package.json +1 -1
  76. package/lib/src/.DS_Store +0 -0
  77. package/lib/src/embed/app.d.ts +0 -1
  78. package/lib/src/embed/app.d.ts.map +1 -1
  79. package/lib/src/embed/app.js +1 -1
  80. package/lib/src/embed/app.js.map +1 -1
  81. package/lib/src/embed/liveboard.d.ts +0 -1
  82. package/lib/src/embed/liveboard.d.ts.map +1 -1
  83. package/lib/src/embed/liveboard.js +1 -1
  84. package/lib/src/embed/liveboard.js.map +1 -1
  85. package/lib/src/embed/sage.d.ts +0 -1
  86. package/lib/src/embed/sage.d.ts.map +1 -1
  87. package/lib/src/embed/sage.js +7 -6
  88. package/lib/src/embed/sage.js.map +1 -1
  89. package/lib/src/embed/sage.spec.js +3 -3
  90. package/lib/src/embed/sage.spec.js.map +1 -1
  91. package/lib/src/embed/search.d.ts +0 -1
  92. package/lib/src/embed/search.d.ts.map +1 -1
  93. package/lib/src/embed/search.js +2 -3
  94. package/lib/src/embed/search.js.map +1 -1
  95. package/lib/src/embed/ts-embed.d.ts +0 -1
  96. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  97. package/lib/src/embed/ts-embed.js +1 -3
  98. package/lib/src/embed/ts-embed.js.map +1 -1
  99. package/lib/src/types.d.ts +19 -49
  100. package/lib/src/types.d.ts.map +1 -1
  101. package/lib/src/types.js +12 -49
  102. package/lib/src/types.js.map +1 -1
  103. package/lib/src/utils/answerService.d.ts +10 -0
  104. package/lib/src/utils/answerService.d.ts.map +1 -0
  105. package/lib/src/utils/answerService.js +57 -0
  106. package/lib/src/utils/answerService.js.map +1 -0
  107. package/lib/src/utils/answerService.spec.d.ts +2 -0
  108. package/lib/src/utils/answerService.spec.d.ts.map +1 -0
  109. package/lib/src/utils/answerService.spec.js +29 -0
  110. package/lib/src/utils/answerService.spec.js.map +1 -0
  111. package/lib/src/utils/authService.d.ts +37 -0
  112. package/lib/src/utils/authService.d.ts.map +1 -0
  113. package/lib/src/utils/authService.js +97 -0
  114. package/lib/src/utils/authService.js.map +1 -0
  115. package/lib/src/utils/authService.spec.d.ts +2 -0
  116. package/lib/src/utils/authService.spec.d.ts.map +1 -0
  117. package/lib/src/utils/authService.spec.js +70 -0
  118. package/lib/src/utils/authService.spec.js.map +1 -0
  119. package/lib/src/visual-embed-sdk.d.ts +19 -54
  120. package/package.json +1 -1
  121. package/src/.DS_Store +0 -0
  122. package/src/embed/app.ts +1 -2
  123. package/src/embed/liveboard.ts +1 -2
  124. package/src/embed/sage.spec.ts +3 -3
  125. package/src/embed/sage.ts +7 -8
  126. package/src/embed/search.ts +2 -4
  127. package/src/embed/ts-embed.ts +1 -4
  128. package/src/types.ts +29 -59
@@ -726,6 +726,7 @@ var EmbedEvent;
726
726
  (function (EmbedEvent) {
727
727
  /**
728
728
  * Rendering has initialized.
729
+ *
729
730
  * @example
730
731
  *```js
731
732
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
@@ -734,7 +735,6 @@ var EmbedEvent;
734
735
  * document.getElementById("loader");
735
736
  * }
736
737
  *```
737
- *
738
738
  * @returns timestamp - The timestamp when the event was generated.
739
739
  */
740
740
  EmbedEvent["Init"] = "init";
@@ -747,12 +747,12 @@ var EmbedEvent;
747
747
  * console.log('AuthInit', payload);
748
748
  * })
749
749
  *```
750
- *
751
750
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
752
751
  */
753
752
  EmbedEvent["AuthInit"] = "authInit";
754
753
  /**
755
754
  * The embed object container has loaded.
755
+ *
756
756
  * @returns timestamp - The timestamp when the event was generated.
757
757
  * @example
758
758
  *```js
@@ -766,6 +766,7 @@ var EmbedEvent;
766
766
  EmbedEvent["Load"] = "load";
767
767
  /**
768
768
  * Data pertaining to answer or Liveboard is received
769
+ *
769
770
  * @return data - The answer or Liveboard data
770
771
  * @example
771
772
  *```js
@@ -789,7 +790,6 @@ var EmbedEvent;
789
790
  *```js
790
791
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
791
792
  *```
792
- *
793
793
  */
794
794
  EmbedEvent["QueryChanged"] = "queryChanged";
795
795
  /**
@@ -798,7 +798,6 @@ var EmbedEvent;
798
798
  * @returns additionalFilters - Any additional filters applied
799
799
  * @returns drillDownColumns - The columns on which drill down was performed
800
800
  * @returns nonFilteredColumns - The columns that were not filtered
801
- *
802
801
  * @example
803
802
  *```js
804
803
  * searchEmbed.trigger(HostEvent.DrillDown, {
@@ -812,7 +811,6 @@ var EmbedEvent;
812
811
  * In this example, `VizPointDoubleClick` event is used for
813
812
  * triggering the `DrillDown` event when an area or specific
814
813
  * data point on a table or chart is double-clicked.
815
- *
816
814
  * @example
817
815
  *```js
818
816
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -829,34 +827,31 @@ var EmbedEvent;
829
827
  * })
830
828
  * })
831
829
  *```
832
- *
833
830
  */
834
831
  EmbedEvent["Drilldown"] = "drillDown";
835
832
  /**
836
833
  * One or more data sources have been selected.
837
- * @returns dataSourceIds - the list of data sources
838
834
  *
835
+ * @returns dataSourceIds - the list of data sources
839
836
  * @example
840
837
  * ```js
841
838
  * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
842
839
  * console.log('DataSourceSelected', payload);
843
840
  * })
844
841
  * ```
845
- *
846
842
  */
847
843
  EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
848
844
  /**
849
845
  * One or more data columns have been selected.
846
+ *
850
847
  * @returns columnIds - the list of columns
851
848
  * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
852
- *
853
849
  * @example
854
850
  * ```js
855
851
  * appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
856
852
  * console.log('AddRemoveColumns', payload);
857
853
  * })
858
854
  * ```
859
- *
860
855
  */
861
856
  EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
862
857
  /**
@@ -864,7 +859,6 @@ var EmbedEvent;
864
859
  *
865
860
  * @returns actionId - ID of the custom action
866
861
  * @returns data - Response payload with the Answer or Liveboard data
867
- *
868
862
  * @example
869
863
  * ```js
870
864
  * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -880,9 +874,7 @@ var EmbedEvent;
880
874
  * Listen to double click actions on a visualization.
881
875
  *
882
876
  * @return ContextMenuInputPoints - Data point that is double-clicked
883
- *
884
877
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
885
- *
886
878
  * @example
887
879
  * ```js
888
880
  * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
@@ -897,7 +889,6 @@ var EmbedEvent;
897
889
  * @return viz, clickedPoint - metadata about the point that is clicked
898
890
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
899
891
  * @important
900
- *
901
892
  * @example
902
893
  * ```js
903
894
  * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
@@ -916,7 +907,6 @@ var EmbedEvent;
916
907
  * An error has occurred.
917
908
  *
918
909
  * @returns error - An error object or message
919
- *
920
910
  * @example
921
911
  * ```js
922
912
  * SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
@@ -924,19 +914,16 @@ var EmbedEvent;
924
914
  * function showErrorMsg() {
925
915
  * document.getElementById("error");
926
916
  * ```
927
- *
928
917
  */
929
918
  EmbedEvent["Error"] = "Error";
930
919
  /**
931
920
  * The embedded object has sent an alert.
932
921
  *
933
922
  * @returns alert - An alert object
934
- *
935
923
  * @example
936
924
  * ```js
937
925
  * searchEmbed.on(EmbedEvent.Alert)
938
926
  * ```
939
- *
940
927
  */
941
928
  EmbedEvent["Alert"] = "alert";
942
929
  /**
@@ -983,7 +970,6 @@ var EmbedEvent;
983
970
  * Applicable to `SearchBarEmbed` only.
984
971
  *
985
972
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
986
- *
987
973
  * @example
988
974
  *```js
989
975
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
@@ -1030,8 +1016,8 @@ var EmbedEvent;
1030
1016
  EmbedEvent["SAMLComplete"] = "samlComplete";
1031
1017
  /**
1032
1018
  * Emitted when any modal is opened in the app
1033
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1034
1019
  *
1020
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1035
1021
  * @example
1036
1022
  *```js
1037
1023
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
@@ -1042,8 +1028,8 @@ var EmbedEvent;
1042
1028
  EmbedEvent["DialogOpen"] = "dialog-open";
1043
1029
  /**
1044
1030
  * Emitted when any modal is closed in the app
1045
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1046
1031
  *
1032
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1047
1033
  * @example
1048
1034
  *```js
1049
1035
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
@@ -1056,8 +1042,8 @@ var EmbedEvent;
1056
1042
  * Emitted when the Liveboard shell loads.
1057
1043
  * You can use this event as a hook to trigger
1058
1044
  * other events on the rendered Liveboard.
1059
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1060
1045
  *
1046
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1061
1047
  * @example
1062
1048
  *```js
1063
1049
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
@@ -1066,7 +1052,6 @@ var EmbedEvent;
1066
1052
  *```
1067
1053
  * The following example shows how to trigger
1068
1054
  * `SetVisibleVizs` event using LiveboardRendered embed event:
1069
- *
1070
1055
  * @example
1071
1056
  *```js
1072
1057
  * const embedRef = useEmbedRef();
@@ -1079,8 +1064,8 @@ var EmbedEvent;
1079
1064
  /**
1080
1065
  * This can be used to register an event listener which
1081
1066
  * is triggered on all events.
1082
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1083
1067
  *
1068
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1084
1069
  * @example
1085
1070
  *```js
1086
1071
  * appEmbed.on(EmbedEvent.ALL, payload => {
@@ -1091,6 +1076,7 @@ var EmbedEvent;
1091
1076
  EmbedEvent["ALL"] = "*";
1092
1077
  /**
1093
1078
  * Emitted when an Answer is saved in the app
1079
+ *
1094
1080
  * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1095
1081
  * @example
1096
1082
  *```js
@@ -1116,7 +1102,6 @@ var EmbedEvent;
1116
1102
  * or `EmbedEvent.DownloadAsXLSX`
1117
1103
  *
1118
1104
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1119
- *
1120
1105
  * @example
1121
1106
  *```js
1122
1107
  * liveboardEmbed.trigger(HostEvent.Download, {
@@ -1127,8 +1112,8 @@ var EmbedEvent;
1127
1112
  EmbedEvent["Download"] = "download";
1128
1113
  /**
1129
1114
  * Emitted when the download action is triggered on an answer
1130
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
1131
1115
  *
1116
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
1132
1117
  * @example
1133
1118
  *```js
1134
1119
  * //trigger when action starts
@@ -1138,14 +1123,12 @@ var EmbedEvent;
1138
1123
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
1139
1124
  * console.log('download PNG', payload)})
1140
1125
  *```
1141
- *
1142
1126
  */
1143
1127
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
1144
1128
  /**
1145
1129
  * Emitted when the Download as PDF action is triggered on an answer
1146
1130
  *
1147
1131
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1148
- *
1149
1132
  * @example
1150
1133
  *```js
1151
1134
  * //trigger when action starts
@@ -1155,7 +1138,6 @@ var EmbedEvent;
1155
1138
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
1156
1139
  * console.log('download PDF', payload)})
1157
1140
  *```
1158
- *
1159
1141
  */
1160
1142
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
1161
1143
  /**
@@ -1177,7 +1159,6 @@ var EmbedEvent;
1177
1159
  * Emitted when the Download as XLSX action is triggered on an answer
1178
1160
  *
1179
1161
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1180
- *
1181
1162
  * @example
1182
1163
  *```js
1183
1164
  * //trigger when action starts
@@ -1193,7 +1174,6 @@ var EmbedEvent;
1193
1174
  * Emitted when an Answer is deleted in the app
1194
1175
  *
1195
1176
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1196
- *
1197
1177
  * @example
1198
1178
  *```js
1199
1179
  * //trigger when action starts
@@ -1247,7 +1227,6 @@ var EmbedEvent;
1247
1227
  * Emitted when a user shares an object with another user or group
1248
1228
  *
1249
1229
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1250
- *
1251
1230
  * @example
1252
1231
  *```js
1253
1232
  * //trigger when action starts
@@ -1327,6 +1306,7 @@ var EmbedEvent;
1327
1306
  /**
1328
1307
  * Emitted when the **Export TML** action is triggered on an
1329
1308
  * an embedded object in the app
1309
+ *
1330
1310
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1331
1311
  * @example
1332
1312
  *```js
@@ -1464,7 +1444,6 @@ var EmbedEvent;
1464
1444
  *```js
1465
1445
  * liveboardEmbed.trigger(HostEvent.Present)
1466
1446
  *```
1467
- *
1468
1447
  * @example
1469
1448
  *```js
1470
1449
  * liveboardEmbed.on(EmbedEvent.Present, {
@@ -1482,77 +1461,65 @@ var EmbedEvent;
1482
1461
  * liveboardEmbed.trigger(HostEvent.Delete,
1483
1462
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1484
1463
  *```
1485
- *
1486
1464
  */
1487
1465
  EmbedEvent["Delete"] = "delete";
1488
1466
  /**
1489
1467
  * Emitted when a user clicks Manage schedules on a Liveboard
1490
1468
  *
1491
1469
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1492
- *
1493
1470
  * @example
1494
1471
  *```js
1495
1472
  * liveboardEmbed.trigger(HostEvent.SchedulesList)
1496
1473
  *```
1497
- *
1498
1474
  */
1499
1475
  EmbedEvent["SchedulesList"] = "schedule-list";
1500
1476
  /**
1501
1477
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
1502
1478
  *
1503
1479
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1504
- *
1505
1480
  * @example
1506
1481
  *```js
1507
1482
  * liveboardEmbed.trigger(HostEvent.Cancel)
1508
1483
  *```
1509
- *
1510
1484
  */
1511
1485
  EmbedEvent["Cancel"] = "cancel";
1512
1486
  /**
1513
1487
  * Emitted when a user clicks **Explore** on a visualization
1514
1488
  *
1515
1489
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1516
- *
1517
1490
  * @example
1518
1491
  *```js
1519
1492
  * liveboardEmbed.trigger(HostEvent.Explore, {
1520
1493
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1521
1494
  *```
1522
- *
1523
1495
  */
1524
1496
  EmbedEvent["Explore"] = "explore";
1525
1497
  /**
1526
1498
  * Emitted when a user clicks **Copy link** action on a visualization
1527
1499
  *
1528
1500
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1529
- *
1530
1501
  * @example
1531
1502
  *```js
1532
1503
  * liveboardEmbed.trigger(HostEvent.CopyLink, {
1533
1504
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1534
1505
  *```
1535
- *
1536
1506
  */
1537
1507
  EmbedEvent["CopyLink"] = "embedDocument";
1538
1508
  /**
1539
1509
  * Emitted when a user interacts with cross filters on a visualization or Liveboard
1540
1510
  *
1541
1511
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1542
- *
1543
1512
  * @example
1544
1513
  *```js
1545
1514
  * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
1546
1515
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1547
1516
  *```
1548
- *
1549
1517
  */
1550
1518
  EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
1551
1519
  /**
1552
1520
  * Emitted when a user right clicks on a visualization (chart or table)
1553
1521
  *
1554
1522
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1555
- *
1556
1523
  * @example
1557
1524
  *```js
1558
1525
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
@@ -1583,7 +1550,6 @@ var EmbedEvent;
1583
1550
  * Emitted when a user selects a data source.
1584
1551
  *
1585
1552
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1586
- *
1587
1553
  */
1588
1554
  EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
1589
1555
  /**
@@ -1812,7 +1778,6 @@ var HostEvent;
1812
1778
  *
1813
1779
  * @param - `path` - the path to navigate to to go forward or back. The path value can
1814
1780
  * be a number; for example, `1`, `-1`.
1815
- *
1816
1781
  * @example
1817
1782
  * ```js
1818
1783
  * appEmbed.navigateToPage(-1)
@@ -2383,9 +2348,7 @@ var HostEvent;
2383
2348
  * Updates the search query string for Natural Language Search operations.
2384
2349
  *
2385
2350
  * @param - `queryString`: Text string in Natural Language format
2386
- *
2387
2351
  * @param - `executeSearch`: Boolean to execute search and update search query
2388
- *
2389
2352
  * @example
2390
2353
  * ```js
2391
2354
  * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -13257,7 +13220,7 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
13257
13220
  });
13258
13221
  }
13259
13222
 
13260
- var name="@thoughtspot/visual-embed-sdk";var version="1.27.0-alpha.0";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/all-types-export.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/lcov.info | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","check-size":"npm run build && size-limit","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4","eslint-plugin-comment-length":"^0.9.2","eslint-plugin-jsdoc":"^46.9.0",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@size-limit/preset-big-lib":"^8.2.6","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.13.1","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"6.7.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0","node-sass":"^8.0.0",prettier:"2.1.2",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.js",limit:"44 kB"}],scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
13223
+ var name="@thoughtspot/visual-embed-sdk";var version="1.27.0-alpha.2";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/all-types-export.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/lcov.info | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","check-size":"npm run build && size-limit","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4","eslint-plugin-comment-length":"^0.9.2","eslint-plugin-jsdoc":"^46.9.0",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@size-limit/preset-big-lib":"^8.2.6","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.13.1","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"6.7.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0","node-sass":"^8.0.0",prettier:"2.1.2",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.js",limit:"44 kB"}],scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
13261
13224
 
13262
13225
  /**
13263
13226
  * Copyright (c) 2022
@@ -13293,7 +13256,6 @@ class TsEmbed {
13293
13256
  */
13294
13257
  this.embedNodeKey = '__tsEmbed';
13295
13258
  this.isAppInitialized = false;
13296
- this.embedComponentType = 'TsEmbed';
13297
13259
  /**
13298
13260
  * Should we encode URL Query Params using base64 encoding which thoughtspot
13299
13261
  * will generate for embedding. This provides additional security to
@@ -13385,7 +13347,7 @@ class TsEmbed {
13385
13347
  allOtherKeys.forEach((key) => {
13386
13348
  if (!isUndefined(viewConfig[key])
13387
13349
  && !isEqual_1(viewConfig[key], preRenderedObject.viewConfig[key])) {
13388
- console.warn(`${this.embedComponentType} was pre-rendered with `
13350
+ console.warn('TS Embed component was pre-rendered with '
13389
13351
  + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
13390
13352
  + `but a different value "${JSON.stringify(viewConfig[key])}" `
13391
13353
  + 'was passed to the Embed component. '
@@ -13410,7 +13372,6 @@ class TsEmbed {
13410
13372
  this.registerAppInit();
13411
13373
  uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_EMBED_CREATE, {
13412
13374
  ...viewConfig,
13413
- embedComponentType: this.embedComponentType,
13414
13375
  });
13415
13376
  }
13416
13377
  /**
@@ -14377,8 +14338,8 @@ const HiddenActionItemByDefaultForSageEmbed = [
14377
14338
  class SageEmbed extends V1Embed {
14378
14339
  // eslint-disable-next-line no-useless-constructor
14379
14340
  constructor(domSelector, viewConfig) {
14341
+ viewConfig.embedComponentType = 'SageEmbed';
14380
14342
  super(domSelector, viewConfig);
14381
- this.embedComponentType = 'SageEmbed';
14382
14343
  }
14383
14344
  /**
14384
14345
  * Constructs a map of parameters to be passed on to the
@@ -14422,15 +14383,16 @@ class SageEmbed extends V1Embed {
14422
14383
  const { dataSource, searchOptions, } = this.viewConfig;
14423
14384
  if (dataSource)
14424
14385
  postHashObj[Param.WorksheetId] = dataSource;
14425
- if (searchOptions === null || searchOptions === void 0 ? void 0 : searchOptions.searchQuery) {
14426
- postHashObj[Param.Query] = searchOptions === null || searchOptions === void 0 ? void 0 : searchOptions.searchQuery;
14427
- if (searchOptions.executeSearch) {
14428
- postHashObj[Param.executeSearch] = true;
14429
- }
14386
+ if ((searchOptions === null || searchOptions === void 0 ? void 0 : searchOptions.searchQuery) && searchOptions.executeSearch) {
14387
+ postHashObj[Param.executeSearch] = true;
14430
14388
  }
14431
14389
  let sagePostHashParams = new URLSearchParams(postHashObj).toString();
14432
14390
  if (sagePostHashParams)
14433
14391
  sagePostHashParams = `${tsPostHashParams ? '&' : '?'}${sagePostHashParams}`;
14392
+ if (searchOptions === null || searchOptions === void 0 ? void 0 : searchOptions.searchQuery)
14393
+ sagePostHashParams += `${sagePostHashParams ? '&' : '?'}${[Param.Query]}=${encodeURIComponent(searchOptions.searchQuery)}`;
14394
+ // use encodeURIComponent for query instead of URLSearchParams
14395
+ // as it adds + instead of %20 for spaces
14434
14396
  return `${this.getRootIframeSrc()}/embed/${path}${tsPostHashParams}${sagePostHashParams}`;
14435
14397
  }
14436
14398
  /**
@@ -14468,9 +14430,8 @@ const HiddenActionItemByDefaultForSearchEmbed = [
14468
14430
  */
14469
14431
  class SearchEmbed extends TsEmbed {
14470
14432
  constructor(domSelector, viewConfig) {
14471
- super(domSelector);
14472
- this.embedComponentType = 'SearchEmbed';
14473
- this.viewConfig = viewConfig;
14433
+ viewConfig.embedComponentType = 'SearchEmbed';
14434
+ super(domSelector, viewConfig);
14474
14435
  }
14475
14436
  /**
14476
14437
  * Get the state of the data sources panel that the embedded
@@ -14623,9 +14584,9 @@ var Page;
14623
14584
  class AppEmbed extends V1Embed {
14624
14585
  // eslint-disable-next-line no-useless-constructor
14625
14586
  constructor(domSelector, viewConfig) {
14587
+ viewConfig.embedComponentType = 'AppEmbed';
14626
14588
  super(domSelector, viewConfig);
14627
14589
  this.defaultHeight = '100%';
14628
- this.embedComponentType = 'AppEmbed';
14629
14590
  /**
14630
14591
  * Set the iframe height as per the computed height received
14631
14592
  * from the ThoughtSpot app.
@@ -14818,9 +14779,9 @@ class AppEmbed extends V1Embed {
14818
14779
  class LiveboardEmbed extends V1Embed {
14819
14780
  // eslint-disable-next-line no-useless-constructor
14820
14781
  constructor(domSelector, viewConfig) {
14782
+ viewConfig.embedComponentType = 'LiveboardEmbed';
14821
14783
  super(domSelector, viewConfig);
14822
14784
  this.defaultHeight = 500;
14823
- this.embedComponentType = 'LiveboardEmbed';
14824
14785
  /**
14825
14786
  * Set the iframe height as per the computed height received
14826
14787
  * from the ThoughtSpot app.