@thoughtspot/visual-embed-sdk 1.46.5-beta.1 → 1.47.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.
- package/cjs/package.json +4 -4
- package/cjs/src/css-variables.d.ts +36 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +41 -17
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +26 -47
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +36 -79
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +24 -2
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +18 -33
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +129 -97
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +31 -0
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +2 -0
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts +18 -0
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +69 -9
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +185 -19
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.d.ts +22 -0
- package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -0
- package/cjs/src/embed/hostEventClient/utils.js +57 -0
- package/cjs/src/embed/hostEventClient/utils.js.map +1 -0
- package/cjs/src/embed/hostEventClient/utils.spec.d.ts +2 -0
- package/cjs/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
- package/cjs/src/embed/hostEventClient/utils.spec.js +190 -0
- package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -0
- package/cjs/src/embed/liveboard.d.ts +18 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +9 -11
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +29 -71
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +20 -0
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -0
- package/cjs/src/embed/spotter-utils.js +52 -0
- package/cjs/src/embed/spotter-utils.js.map +1 -0
- package/cjs/src/embed/spotter-utils.spec.d.ts +2 -0
- package/cjs/src/embed/spotter-utils.spec.d.ts.map +1 -0
- package/cjs/src/embed/spotter-utils.spec.js +54 -0
- package/cjs/src/embed/spotter-utils.spec.js.map +1 -0
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +25 -5
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +28 -67
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +2 -1
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +2 -1
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/index.d.ts +1 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -4
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/all-types-export.d.ts +2 -2
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +1 -3
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -36
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +1 -34
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/types.d.ts +143 -76
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +118 -47
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils.d.ts +0 -9
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +1 -10
- package/cjs/src/utils.js.map +1 -1
- package/dist/{index-DW2wEHqy.js → index-Bm2Hck8q.js} +1 -1
- package/dist/src/css-variables.d.ts +36 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +41 -17
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +24 -2
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +31 -0
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts +18 -0
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/utils.d.ts +22 -0
- package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -0
- package/dist/src/embed/hostEventClient/utils.spec.d.ts +2 -0
- package/dist/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
- package/dist/src/embed/liveboard.d.ts +18 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +20 -0
- package/dist/src/embed/spotter-utils.d.ts.map +1 -0
- package/dist/src/embed/spotter-utils.spec.d.ts +2 -0
- package/dist/src/embed/spotter-utils.spec.d.ts.map +1 -0
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/dist/src/errors.d.ts +2 -1
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts +1 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/all-types-export.d.ts +2 -2
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -36
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +143 -76
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils.d.ts +0 -9
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +378 -304
- package/dist/tsembed-react.js +366 -294
- package/dist/tsembed.es.js +393 -285
- package/dist/tsembed.js +30798 -30691
- package/dist/visual-embed-sdk-react-full.d.ts +310 -273
- package/dist/visual-embed-sdk-react.d.ts +310 -273
- package/dist/visual-embed-sdk.d.ts +308 -243
- package/lib/package.json +4 -4
- package/lib/src/css-variables.d.ts +36 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +41 -17
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +28 -49
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +36 -79
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +24 -2
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +19 -34
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +131 -99
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +31 -0
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +2 -0
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts +18 -0
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +69 -9
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +185 -19
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.d.ts +22 -0
- package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -0
- package/lib/src/embed/hostEventClient/utils.js +49 -0
- package/lib/src/embed/hostEventClient/utils.js.map +1 -0
- package/lib/src/embed/hostEventClient/utils.spec.d.ts +2 -0
- package/lib/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
- package/lib/src/embed/hostEventClient/utils.spec.js +188 -0
- package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -0
- package/lib/src/embed/liveboard.d.ts +18 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +9 -11
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +29 -71
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +20 -0
- package/lib/src/embed/spotter-utils.d.ts.map +1 -0
- package/lib/src/embed/spotter-utils.js +47 -0
- package/lib/src/embed/spotter-utils.js.map +1 -0
- package/lib/src/embed/spotter-utils.spec.d.ts +2 -0
- package/lib/src/embed/spotter-utils.spec.d.ts.map +1 -0
- package/lib/src/embed/spotter-utils.spec.js +52 -0
- package/lib/src/embed/spotter-utils.spec.js.map +1 -0
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +25 -5
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +30 -69
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.d.ts +2 -1
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +2 -1
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts +1 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/all-types-export.d.ts +2 -2
- package/lib/src/react/all-types-export.d.ts.map +1 -1
- package/lib/src/react/all-types-export.js +1 -1
- package/lib/src/react/all-types-export.js.map +1 -1
- package/lib/src/react/index.d.ts +1 -36
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +0 -33
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/types.d.ts +143 -76
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +118 -47
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils.d.ts +0 -9
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +0 -8
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +308 -243
- package/package.json +4 -4
- package/src/css-variables.ts +45 -0
- package/src/embed/app.spec.ts +51 -107
- package/src/embed/app.ts +60 -82
- package/src/embed/conversation.spec.ts +150 -119
- package/src/embed/conversation.ts +34 -58
- package/src/embed/hostEventClient/contracts.ts +31 -0
- package/src/embed/hostEventClient/host-event-client.spec.ts +260 -19
- package/src/embed/hostEventClient/host-event-client.ts +87 -11
- package/src/embed/hostEventClient/utils.spec.ts +225 -0
- package/src/embed/hostEventClient/utils.ts +74 -0
- package/src/embed/liveboard.spec.ts +38 -93
- package/src/embed/liveboard.ts +28 -10
- package/src/embed/spotter-utils.spec.ts +56 -0
- package/src/embed/spotter-utils.ts +65 -0
- package/src/embed/ts-embed.spec.ts +56 -108
- package/src/embed/ts-embed.ts +25 -4
- package/src/errors.ts +2 -1
- package/src/index.ts +2 -5
- package/src/react/all-types-export.ts +0 -3
- package/src/react/index.tsx +15 -59
- package/src/types.ts +206 -138
- package/src/utils.ts +0 -14
- package/cjs/src/embed/sage.d.ts +0 -164
- package/cjs/src/embed/sage.d.ts.map +0 -1
- package/cjs/src/embed/sage.js +0 -88
- package/cjs/src/embed/sage.js.map +0 -1
- package/cjs/src/embed/sage.spec.d.ts +0 -2
- package/cjs/src/embed/sage.spec.d.ts.map +0 -1
- package/cjs/src/embed/sage.spec.js +0 -151
- package/cjs/src/embed/sage.spec.js.map +0 -1
- package/dist/src/embed/sage.d.ts +0 -164
- package/dist/src/embed/sage.d.ts.map +0 -1
- package/dist/src/embed/sage.spec.d.ts +0 -2
- package/dist/src/embed/sage.spec.d.ts.map +0 -1
- package/lib/src/embed/sage.d.ts +0 -164
- package/lib/src/embed/sage.d.ts.map +0 -1
- package/lib/src/embed/sage.js +0 -84
- package/lib/src/embed/sage.js.map +0 -1
- package/lib/src/embed/sage.spec.d.ts +0 -2
- package/lib/src/embed/sage.spec.d.ts.map +0 -1
- package/lib/src/embed/sage.spec.js +0 -148
- package/lib/src/embed/sage.spec.js.map +0 -1
- package/src/embed/sage.spec.ts +0 -206
- package/src/embed/sage.ts +0 -231
package/src/types.ts
CHANGED
|
@@ -505,11 +505,6 @@ export interface EmbedConfig {
|
|
|
505
505
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
506
506
|
*/
|
|
507
507
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
508
|
-
/**
|
|
509
|
-
* Hide `beta` alert warning message for SageEmbed.
|
|
510
|
-
*
|
|
511
|
-
*/
|
|
512
|
-
suppressSageEmbedBetaWarning?: boolean;
|
|
513
508
|
/**
|
|
514
509
|
* Custom style params for embed Config.
|
|
515
510
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
@@ -595,6 +590,7 @@ export interface EmbedConfig {
|
|
|
595
590
|
/**
|
|
596
591
|
* Disables the Mixpanel tracking from the SDK.
|
|
597
592
|
* @version SDK: 1.27.9
|
|
593
|
+
* @hidden
|
|
598
594
|
*/
|
|
599
595
|
disableSDKTracking?: boolean;
|
|
600
596
|
/**
|
|
@@ -904,7 +900,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
904
900
|
* The width and height dimensions to render an embedded
|
|
905
901
|
* object inside your app. Specify the values in pixels or percentage.
|
|
906
902
|
*
|
|
907
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
903
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
908
904
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
909
905
|
* @example
|
|
910
906
|
* ```js
|
|
@@ -934,7 +930,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
934
930
|
* for the user.
|
|
935
931
|
* Use this to disable actions.
|
|
936
932
|
*
|
|
937
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
933
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
938
934
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
939
935
|
* @example
|
|
940
936
|
* ```js
|
|
@@ -949,7 +945,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
949
945
|
/**
|
|
950
946
|
* The tooltip to display for disabled actions.
|
|
951
947
|
*
|
|
952
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
948
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
953
949
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
954
950
|
* @example
|
|
955
951
|
* ```js
|
|
@@ -967,7 +963,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
967
963
|
* These actions will be hidden from the user.
|
|
968
964
|
* Use this to hide an action.
|
|
969
965
|
*
|
|
970
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
966
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
971
967
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
972
968
|
* @example
|
|
973
969
|
* ```js
|
|
@@ -988,7 +984,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
988
984
|
*
|
|
989
985
|
* Use either this or hiddenActions.
|
|
990
986
|
*
|
|
991
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
987
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
992
988
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
993
989
|
* @important
|
|
994
990
|
* @example
|
|
@@ -1004,7 +1000,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1004
1000
|
/**
|
|
1005
1001
|
* The locale settings to apply to the embedded view.
|
|
1006
1002
|
*
|
|
1007
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1003
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1008
1004
|
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1009
1005
|
* @example
|
|
1010
1006
|
* ```js
|
|
@@ -1025,7 +1021,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1025
1021
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1026
1022
|
* list of supported keys and values associated with each.
|
|
1027
1023
|
*
|
|
1028
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1024
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1029
1025
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1030
1026
|
* @example
|
|
1031
1027
|
* ```js
|
|
@@ -1051,7 +1047,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1051
1047
|
* Insert as a sibling of the target container, instead of appending to a
|
|
1052
1048
|
* child inside it.
|
|
1053
1049
|
*
|
|
1054
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1050
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1055
1051
|
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
1056
1052
|
* @example
|
|
1057
1053
|
* ```js
|
|
@@ -1077,7 +1073,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1077
1073
|
* Use PreRender to render the embed in the background and then
|
|
1078
1074
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1079
1075
|
*
|
|
1080
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1076
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1081
1077
|
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1082
1078
|
* @example
|
|
1083
1079
|
* ```js
|
|
@@ -1115,7 +1111,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1115
1111
|
* Enable the V2 shell. This can provide performance benefits
|
|
1116
1112
|
* due to a lighter-weight shell.
|
|
1117
1113
|
*
|
|
1118
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1114
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1119
1115
|
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1120
1116
|
* @example
|
|
1121
1117
|
* ```js
|
|
@@ -1143,7 +1139,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1143
1139
|
* This flag can be used to disable links inside the embedded app,
|
|
1144
1140
|
* and disable redirection of links in a new tab.
|
|
1145
1141
|
*
|
|
1146
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1142
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1147
1143
|
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1148
1144
|
* @example
|
|
1149
1145
|
* ```js
|
|
@@ -1162,7 +1158,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1162
1158
|
* The `overrideOrgId` setting is honoured only if the
|
|
1163
1159
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
1164
1160
|
*
|
|
1165
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1161
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1166
1162
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1167
1163
|
* @example
|
|
1168
1164
|
* ```js
|
|
@@ -1182,7 +1178,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1182
1178
|
* {@link enableLinkOverridesV2} instead.
|
|
1183
1179
|
*
|
|
1184
1180
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
1185
|
-
* `
|
|
1181
|
+
* `SearchEmbed`, `SpotterAgentEmbed`,
|
|
1186
1182
|
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1187
1183
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1188
1184
|
* @example
|
|
@@ -1206,7 +1202,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1206
1202
|
* older ThoughtSpot versions.
|
|
1207
1203
|
*
|
|
1208
1204
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
1209
|
-
* `
|
|
1205
|
+
* `SearchEmbed`, `SpotterAgentEmbed`,
|
|
1210
1206
|
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1211
1207
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
1212
1208
|
* @example
|
|
@@ -1265,7 +1261,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1265
1261
|
* external app, calling an API, or opening a modal — based on the data context of
|
|
1266
1262
|
* what they clicked can be used to trigger custom logic when the action is clicked.
|
|
1267
1263
|
*
|
|
1268
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1264
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterEmbed`
|
|
1269
1265
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
|
|
1270
1266
|
* @example
|
|
1271
1267
|
* ```ts
|
|
@@ -1438,7 +1434,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1438
1434
|
*/
|
|
1439
1435
|
customActions?: CustomAction[];
|
|
1440
1436
|
|
|
1441
|
-
|
|
1442
1437
|
/**
|
|
1443
1438
|
* Refresh the auth token when the token is near expiry.
|
|
1444
1439
|
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
@@ -1625,11 +1620,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1625
1620
|
/**
|
|
1626
1621
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
1627
1622
|
*
|
|
1628
|
-
* Supported embed types: `AppEmbed`, `
|
|
1623
|
+
* Supported embed types: `AppEmbed`, `SearchEmbed`
|
|
1629
1624
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1630
1625
|
* @example
|
|
1631
1626
|
* ```js
|
|
1632
|
-
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed,
|
|
1627
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchEmbed
|
|
1633
1628
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1634
1629
|
* ... // other embed view config
|
|
1635
1630
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
@@ -1666,12 +1661,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1666
1661
|
/**
|
|
1667
1662
|
* To set the initial state of the search bar in case of saved Answers.
|
|
1668
1663
|
*
|
|
1669
|
-
* Supported embed types: `
|
|
1664
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`
|
|
1670
1665
|
* @default true
|
|
1671
1666
|
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
1672
1667
|
* @example
|
|
1673
1668
|
* ```js
|
|
1674
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
1669
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
1675
1670
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1676
1671
|
* ... // other embed view config
|
|
1677
1672
|
* collapseSearchBar: true,
|
|
@@ -1682,12 +1677,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1682
1677
|
/**
|
|
1683
1678
|
* Flag to control Data panel experience
|
|
1684
1679
|
*
|
|
1685
|
-
* Supported embed types: `
|
|
1680
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1686
1681
|
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
1687
1682
|
* @default true
|
|
1688
1683
|
* @example
|
|
1689
1684
|
* ```js
|
|
1690
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
1685
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
1691
1686
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1692
1687
|
* ... // other embed view config
|
|
1693
1688
|
* dataPanelV2: true,
|
|
@@ -1698,12 +1693,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1698
1693
|
/**
|
|
1699
1694
|
* To enable custom column groups in data panel v2
|
|
1700
1695
|
*
|
|
1701
|
-
* Supported embed types: `
|
|
1696
|
+
* Supported embed types: `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1702
1697
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
1703
1698
|
* @default false
|
|
1704
1699
|
* @example
|
|
1705
1700
|
* ```js
|
|
1706
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
1701
|
+
* // Replace <EmbedComponent> with embed component name. For example, SearchBarEmbed, or LiveboardEmbed
|
|
1707
1702
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1708
1703
|
* ... // other embed view config
|
|
1709
1704
|
* enableCustomColumnGroups: true,
|
|
@@ -2738,6 +2733,17 @@ export enum EmbedEvent {
|
|
|
2738
2733
|
* ```
|
|
2739
2734
|
*/
|
|
2740
2735
|
DownloadAsXlsx = 'downloadAsXlsx',
|
|
2736
|
+
/**
|
|
2737
|
+
* Emitted when the Download Liveboard as Continuous PDF action is triggered
|
|
2738
|
+
* on a Liveboard.
|
|
2739
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
2740
|
+
* @example
|
|
2741
|
+
* ```js
|
|
2742
|
+
* liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
|
|
2743
|
+
* console.log('download liveboard as continuous PDF', payload)})
|
|
2744
|
+
* ```
|
|
2745
|
+
*/
|
|
2746
|
+
DownloadLiveboardAsContinuousPDF = 'downloadLiveboardAsContinuousPDF',
|
|
2741
2747
|
/**
|
|
2742
2748
|
* Emitted when an Answer is deleted in the app
|
|
2743
2749
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
@@ -3115,19 +3121,6 @@ export enum EmbedEvent {
|
|
|
3115
3121
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3116
3122
|
*/
|
|
3117
3123
|
FilterChanged = 'filterChanged',
|
|
3118
|
-
/**
|
|
3119
|
-
* Emitted when a user clicks the **Go** button to initiate
|
|
3120
|
-
* a Natural Language Search query
|
|
3121
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3122
|
-
*/
|
|
3123
|
-
SageEmbedQuery = 'sageEmbedQuery',
|
|
3124
|
-
/**
|
|
3125
|
-
* Emitted when a user selects a data source on the embedded
|
|
3126
|
-
* Natural Language Search interface.
|
|
3127
|
-
*
|
|
3128
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3129
|
-
*/
|
|
3130
|
-
SageWorksheetUpdated = 'sageWorksheetUpdated',
|
|
3131
3124
|
/**
|
|
3132
3125
|
* Emitted when a user updates a connection on the **Data** page
|
|
3133
3126
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
@@ -3254,7 +3247,7 @@ export enum EmbedEvent {
|
|
|
3254
3247
|
* **Prerequisite**: Set`isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
3255
3248
|
* to ensure that `EmbedEvent.OnBeforeGetVizDataIntercept` is emitted
|
|
3256
3249
|
* when the embedding application user tries to run a search query.
|
|
3257
|
-
*
|
|
3250
|
+
*
|
|
3258
3251
|
* This framework applies only to `AppEmbed` and `SearchEmbed`.
|
|
3259
3252
|
* @param - Includes the following parameters:
|
|
3260
3253
|
* - `payload`: The payload received from the embed related to the Data API call.
|
|
@@ -3630,7 +3623,7 @@ export enum EmbedEvent {
|
|
|
3630
3623
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3631
3624
|
*/
|
|
3632
3625
|
SpotterConversationSelected = 'spotterConversationSelected',
|
|
3633
|
-
|
|
3626
|
+
|
|
3634
3627
|
/**
|
|
3635
3628
|
* @hidden
|
|
3636
3629
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -4268,6 +4261,18 @@ export enum HostEvent {
|
|
|
4268
4261
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4269
4262
|
*/
|
|
4270
4263
|
DownloadAsPdf = 'downloadAsPdf',
|
|
4264
|
+
/**
|
|
4265
|
+
* Trigger the **Download Liveboard as Continuous PDF** action on an
|
|
4266
|
+
* embedded Liveboard.
|
|
4267
|
+
*
|
|
4268
|
+
* @example
|
|
4269
|
+
* ```js
|
|
4270
|
+
* liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
|
|
4271
|
+
* ```
|
|
4272
|
+
*
|
|
4273
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
4274
|
+
*/
|
|
4275
|
+
DownloadLiveboardAsContinuousPDF = 'downloadLiveboardAsContinuousPDF',
|
|
4271
4276
|
/**
|
|
4272
4277
|
* Trigger the **AI Highlights** action on an embedded Liveboard
|
|
4273
4278
|
*
|
|
@@ -4494,6 +4499,20 @@ export enum HostEvent {
|
|
|
4494
4499
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
4495
4500
|
* }, ContextType.Liveboard);
|
|
4496
4501
|
* ```
|
|
4502
|
+
* @example
|
|
4503
|
+
* ```js
|
|
4504
|
+
* // Copy link from liveboard context
|
|
4505
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
4506
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
|
|
4507
|
+
* ```
|
|
4508
|
+
* @example
|
|
4509
|
+
* ```js
|
|
4510
|
+
* // Copy link from liveboard visualization context
|
|
4511
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
4512
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {
|
|
4513
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
4514
|
+
* }, ContextType.Liveboard);
|
|
4515
|
+
* ```
|
|
4497
4516
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4498
4517
|
*/
|
|
4499
4518
|
CopyLink = 'embedDocument',
|
|
@@ -4525,6 +4544,20 @@ export enum HostEvent {
|
|
|
4525
4544
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
4526
4545
|
* liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
|
|
4527
4546
|
* ```
|
|
4547
|
+
* @example
|
|
4548
|
+
* ```js
|
|
4549
|
+
* // Present from liveboard visualization context
|
|
4550
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
4551
|
+
* liveboardEmbed.trigger(HostEvent.Present, {
|
|
4552
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
4553
|
+
* }, ContextType.Liveboard);
|
|
4554
|
+
* ```
|
|
4555
|
+
* @example
|
|
4556
|
+
* ```js
|
|
4557
|
+
* // Present from liveboard context
|
|
4558
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
4559
|
+
* liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
|
|
4560
|
+
* ```
|
|
4528
4561
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4529
4562
|
*/
|
|
4530
4563
|
Present = 'present',
|
|
@@ -4553,7 +4586,7 @@ export enum HostEvent {
|
|
|
4553
4586
|
* tml.answer.search_query // TML representation of the search query
|
|
4554
4587
|
* );
|
|
4555
4588
|
* })
|
|
4556
|
-
|
|
4589
|
+
* ```
|
|
4557
4590
|
* @example
|
|
4558
4591
|
* ```js
|
|
4559
4592
|
* // Get TML from search context
|
|
@@ -4674,9 +4707,9 @@ export enum HostEvent {
|
|
|
4674
4707
|
* Trigger the **Download** action on charts in
|
|
4675
4708
|
* the embedded view.
|
|
4676
4709
|
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
4677
|
-
*
|
|
4710
|
+
*
|
|
4678
4711
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
4679
|
-
*
|
|
4712
|
+
*
|
|
4680
4713
|
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4681
4714
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
4682
4715
|
* @example
|
|
@@ -5177,21 +5210,6 @@ export enum HostEvent {
|
|
|
5177
5210
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5178
5211
|
*/
|
|
5179
5212
|
SetHiddenTabs = 'SetPinboardHiddenTabs',
|
|
5180
|
-
/**
|
|
5181
|
-
* Updates the search query string for Natural Language Search operations.
|
|
5182
|
-
* @param - Includes the following keys:
|
|
5183
|
-
* - `queryString`: Text string in Natural Language format.
|
|
5184
|
-
* - `executeSearch`: Boolean to execute search and update search query.
|
|
5185
|
-
* @example
|
|
5186
|
-
* ```js
|
|
5187
|
-
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
5188
|
-
* queryString: 'revenue per year',
|
|
5189
|
-
* executeSearch: true,
|
|
5190
|
-
* })
|
|
5191
|
-
* ```
|
|
5192
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
5193
|
-
*/
|
|
5194
|
-
UpdateSageQuery = 'updateSageQuery',
|
|
5195
5213
|
/**
|
|
5196
5214
|
* Get the Answer session for a Search or
|
|
5197
5215
|
* Liveboard visualization.
|
|
@@ -5350,7 +5368,7 @@ export enum HostEvent {
|
|
|
5350
5368
|
* ```
|
|
5351
5369
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5352
5370
|
*/
|
|
5353
|
-
UpdatePersonalizedView = UpdatePersonalisedView,
|
|
5371
|
+
UpdatePersonalizedView = UpdatePersonalisedView,
|
|
5354
5372
|
/**
|
|
5355
5373
|
* Triggers selection of a specific Personalized View on a
|
|
5356
5374
|
* Liveboard without reloading the embed. Pass either a
|
|
@@ -5664,7 +5682,7 @@ export enum HostEvent {
|
|
|
5664
5682
|
/**
|
|
5665
5683
|
* @hidden
|
|
5666
5684
|
* Get the current context of the embedded page.
|
|
5667
|
-
*
|
|
5685
|
+
*
|
|
5668
5686
|
* @example
|
|
5669
5687
|
* ```js
|
|
5670
5688
|
* const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
|
|
@@ -5761,7 +5779,6 @@ export enum Param {
|
|
|
5761
5779
|
HideNotification = 'hideNotification',
|
|
5762
5780
|
HideApplicationSwitcher = 'applicationSwitcherHidden',
|
|
5763
5781
|
HideOrgSwitcher = 'orgSwitcherHidden',
|
|
5764
|
-
IsSageEmbed = 'isSageEmbed',
|
|
5765
5782
|
HideWorksheetSelector = 'hideWorksheetSelector',
|
|
5766
5783
|
DisableWorksheetChange = 'disableWorksheetChange',
|
|
5767
5784
|
HideSourceSelection = 'hideSourceSelection',
|
|
@@ -5812,7 +5829,6 @@ export enum Param {
|
|
|
5812
5829
|
HideIrrelevantFiltersInTab = 'hideIrrelevantFiltersAtTabLevel',
|
|
5813
5830
|
IsEnhancedFilterInteractivityEnabled = 'isLiveboardPermissionV2Enabled',
|
|
5814
5831
|
SpotterEnabled = 'isSpotterExperienceEnabled',
|
|
5815
|
-
IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
|
|
5816
5832
|
OverrideOrgId = 'orgId',
|
|
5817
5833
|
OauthPollingInterval = 'oAuthPollingInterval',
|
|
5818
5834
|
IsForceRedirect = 'isForceRedirect',
|
|
@@ -5826,6 +5842,7 @@ export enum Param {
|
|
|
5826
5842
|
IsLazyLoadingForEmbedEnabled = 'isLazyLoadingForEmbedEnabled',
|
|
5827
5843
|
RootMarginForLazyLoad = 'rootMarginForLazyLoad',
|
|
5828
5844
|
isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
|
|
5845
|
+
IsWYSIWYGLiveboardPDFEnabled = 'isWYSIWYGLiveboardPDFEnabled',
|
|
5829
5846
|
isLiveboardXLSXCSVDownloadEnabled = 'isLiveboardXLSXCSVDownloadEnabled',
|
|
5830
5847
|
isGranularXLSXCSVSchedulesEnabled = 'isGranularXLSXCSVSchedulesEnabled',
|
|
5831
5848
|
isCentralizedLiveboardFilterUXEnabled = 'isCentralizedLiveboardFilterUXEnabled',
|
|
@@ -6171,6 +6188,16 @@ export enum Action {
|
|
|
6171
6188
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
6172
6189
|
*/
|
|
6173
6190
|
DownloadLiveboard = 'downloadLiveboard',
|
|
6191
|
+
/**
|
|
6192
|
+
* The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
|
|
6193
|
+
* Allows downloading the entire Liveboard as a continuous PDF.
|
|
6194
|
+
* @example
|
|
6195
|
+
* ```js
|
|
6196
|
+
* disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
|
|
6197
|
+
* ```
|
|
6198
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
6199
|
+
*/
|
|
6200
|
+
DownloadLiveboardAsContinuousPDF = 'downloadLiveboardAsContinuousPDF',
|
|
6174
6201
|
/**
|
|
6175
6202
|
* @hidden
|
|
6176
6203
|
*/
|
|
@@ -6825,7 +6852,7 @@ export enum Action {
|
|
|
6825
6852
|
* ```
|
|
6826
6853
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
6827
6854
|
*/
|
|
6828
|
-
PersonalizedViewsDropdown = PersonalisedViewsDropdown,
|
|
6855
|
+
PersonalizedViewsDropdown = PersonalisedViewsDropdown,
|
|
6829
6856
|
/**
|
|
6830
6857
|
* Action ID for show or hide the user details on a
|
|
6831
6858
|
* Liveboard (Recently visited / social proof)
|
|
@@ -7148,11 +7175,11 @@ export enum Action {
|
|
|
7148
7175
|
*/
|
|
7149
7176
|
CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
|
|
7150
7177
|
/**
|
|
7151
|
-
|
|
7152
|
-
|
|
7153
|
-
|
|
7154
|
-
|
|
7155
|
-
|
|
7178
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
7179
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
7180
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
7181
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
7182
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
7156
7183
|
* @example
|
|
7157
7184
|
* ```js
|
|
7158
7185
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -7228,7 +7255,7 @@ export enum Action {
|
|
|
7228
7255
|
* @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
|
|
7229
7256
|
*/
|
|
7230
7257
|
LiveboardStylePanel = 'liveboardStylePanel',
|
|
7231
|
-
|
|
7258
|
+
/**
|
|
7232
7259
|
* The **Publish** action for Liveboards, Answers and Models.
|
|
7233
7260
|
* Opens the publishing modal. It's a parent action for the
|
|
7234
7261
|
* **Manage Publishing** and **Unpublish** actions if the object
|
|
@@ -7240,43 +7267,43 @@ export enum Action {
|
|
|
7240
7267
|
* ```
|
|
7241
7268
|
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7242
7269
|
*/
|
|
7243
|
-
|
|
7244
|
-
|
|
7245
|
-
|
|
7246
|
-
|
|
7247
|
-
|
|
7248
|
-
|
|
7249
|
-
|
|
7250
|
-
|
|
7251
|
-
|
|
7252
|
-
|
|
7253
|
-
|
|
7254
|
-
|
|
7255
|
-
|
|
7256
|
-
|
|
7257
|
-
|
|
7258
|
-
|
|
7259
|
-
|
|
7260
|
-
|
|
7261
|
-
|
|
7262
|
-
|
|
7263
|
-
|
|
7264
|
-
|
|
7265
|
-
|
|
7266
|
-
|
|
7267
|
-
|
|
7268
|
-
|
|
7269
|
-
|
|
7270
|
-
|
|
7271
|
-
|
|
7272
|
-
|
|
7273
|
-
|
|
7274
|
-
|
|
7275
|
-
|
|
7276
|
-
|
|
7277
|
-
|
|
7278
|
-
|
|
7279
|
-
|
|
7270
|
+
Publish = 'publish',
|
|
7271
|
+
/**
|
|
7272
|
+
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
7273
|
+
* Opens the same publishing modal as the **Publish** action.
|
|
7274
|
+
* Appears as a child action to the **Publish** action if the
|
|
7275
|
+
* object is already published.
|
|
7276
|
+
* @example
|
|
7277
|
+
* ```js
|
|
7278
|
+
* hiddenActions: [Action.ManagePublishing]
|
|
7279
|
+
* disabledActions: [Action.ManagePublishing]
|
|
7280
|
+
* ```
|
|
7281
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7282
|
+
*/
|
|
7283
|
+
ManagePublishing = 'managePublishing',
|
|
7284
|
+
/**
|
|
7285
|
+
* The **Unpublish** action for Liveboards, Answers and Models.
|
|
7286
|
+
* Opens the unpublishing modal. Appears as a child action to
|
|
7287
|
+
* the **Publish** action if the object is already published.
|
|
7288
|
+
* @example
|
|
7289
|
+
* ```js
|
|
7290
|
+
* hiddenActions: [Action.Unpublish]
|
|
7291
|
+
* disabledActions: [Action.Unpublish]
|
|
7292
|
+
* ```
|
|
7293
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7294
|
+
*/
|
|
7295
|
+
Unpublish = 'unpublish',
|
|
7296
|
+
/**
|
|
7297
|
+
* The **Parameterize** action for Tables and Connections.
|
|
7298
|
+
* Opens the parameterization modal.
|
|
7299
|
+
* @example
|
|
7300
|
+
* ```js
|
|
7301
|
+
* hiddenActions: [Action.Parameterize]
|
|
7302
|
+
* disabledActions: [Action.Parameterize]
|
|
7303
|
+
* ```
|
|
7304
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7305
|
+
*/
|
|
7306
|
+
Parameterize = 'parameterise',
|
|
7280
7307
|
/**
|
|
7281
7308
|
* The **Move to Group** menu action on a Liveboard.
|
|
7282
7309
|
* Allows moving a visualization to a different group.
|
|
@@ -7407,6 +7434,39 @@ export enum Action {
|
|
|
7407
7434
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7408
7435
|
*/
|
|
7409
7436
|
SpotterDocs = 'spotterDocs',
|
|
7437
|
+
/**
|
|
7438
|
+
* Controls visibility and disable state of the connector resources
|
|
7439
|
+
* section in the Spotter chat interface.
|
|
7440
|
+
* @example
|
|
7441
|
+
* ```js
|
|
7442
|
+
* hiddenActions: [Action.SpotterChatConnectorResources]
|
|
7443
|
+
* disabledActions: [Action.SpotterChatConnectorResources]
|
|
7444
|
+
* ```
|
|
7445
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
7446
|
+
*/
|
|
7447
|
+
SpotterChatConnectorResources = 'spotterChatConnectorResources',
|
|
7448
|
+
/**
|
|
7449
|
+
* Controls visibility and disable state of the connectors
|
|
7450
|
+
* in the Spotter chat interface.
|
|
7451
|
+
* @example
|
|
7452
|
+
* ```js
|
|
7453
|
+
* hiddenActions: [Action.SpotterChatConnectors]
|
|
7454
|
+
* disabledActions: [Action.SpotterChatConnectors]
|
|
7455
|
+
* ```
|
|
7456
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
7457
|
+
*/
|
|
7458
|
+
SpotterChatConnectors = 'spotterChatConnectors',
|
|
7459
|
+
/**
|
|
7460
|
+
* Controls visibility and disable state of the mode switcher
|
|
7461
|
+
* in the Spotter chat interface.
|
|
7462
|
+
* @example
|
|
7463
|
+
* ```js
|
|
7464
|
+
* hiddenActions: [Action.SpotterChatModeSwitcher]
|
|
7465
|
+
* disabledActions: [Action.SpotterChatModeSwitcher]
|
|
7466
|
+
* ```
|
|
7467
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
7468
|
+
*/
|
|
7469
|
+
SpotterChatModeSwitcher = 'spotterChatModeSwitcher',
|
|
7410
7470
|
/**
|
|
7411
7471
|
* The **Include current period** checkbox for date filters.
|
|
7412
7472
|
* Controls the visibility and availability of the option to include
|
|
@@ -7679,11 +7739,11 @@ export enum LogLevel {
|
|
|
7679
7739
|
* Error types emitted by embedded components.
|
|
7680
7740
|
*
|
|
7681
7741
|
* These enum values categorize different types of errors that can occur during
|
|
7682
|
-
* the lifecycle of an embedded ThoughtSpot component.
|
|
7742
|
+
* the lifecycle of an embedded ThoughtSpot component.
|
|
7683
7743
|
* Use {@link EmbedErrorDetailsEvent} and {@link EmbedErrorCodes} to handle specific errors.
|
|
7684
7744
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
7685
7745
|
* @group Error Handling
|
|
7686
|
-
*
|
|
7746
|
+
*
|
|
7687
7747
|
* @example
|
|
7688
7748
|
* Handle specific error types
|
|
7689
7749
|
* ```js
|
|
@@ -7783,6 +7843,15 @@ export enum EmbedErrorCodes {
|
|
|
7783
7843
|
|
|
7784
7844
|
/** Invalid URL provided in configuration */
|
|
7785
7845
|
INVALID_URL = 'INVALID_URL',
|
|
7846
|
+
|
|
7847
|
+
/** Host event payload validation failed */
|
|
7848
|
+
HOST_EVENT_VALIDATION = 'HOST_EVENT_VALIDATION',
|
|
7849
|
+
|
|
7850
|
+
/** UpdateFilters payload is invalid - missing or malformed filter/filters */
|
|
7851
|
+
UPDATEFILTERS_INVALID_PAYLOAD = 'UPDATEFILTERS_INVALID_PAYLOAD',
|
|
7852
|
+
|
|
7853
|
+
/** DrillDown payload is invalid - missing or malformed points */
|
|
7854
|
+
DRILLDOWN_INVALID_PAYLOAD = 'DRILLDOWN_INVALID_PAYLOAD',
|
|
7786
7855
|
}
|
|
7787
7856
|
|
|
7788
7857
|
/**
|
|
@@ -7811,7 +7880,7 @@ export enum EmbedErrorCodes {
|
|
|
7811
7880
|
*
|
|
7812
7881
|
* @example
|
|
7813
7882
|
* Handle specific error types
|
|
7814
|
-
*
|
|
7883
|
+
*
|
|
7815
7884
|
* ```js
|
|
7816
7885
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
7817
7886
|
* switch (error.code) {
|
|
@@ -7825,7 +7894,7 @@ export enum EmbedErrorCodes {
|
|
|
7825
7894
|
* ```
|
|
7826
7895
|
* @example
|
|
7827
7896
|
* Handle multiple error messages
|
|
7828
|
-
*
|
|
7897
|
+
*
|
|
7829
7898
|
* ```js
|
|
7830
7899
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
7831
7900
|
* const messages = Array.isArray(error.message)
|
|
@@ -7991,34 +8060,33 @@ export interface ObjectIds {
|
|
|
7991
8060
|
modalTitle?: string;
|
|
7992
8061
|
}
|
|
7993
8062
|
|
|
7994
|
-
|
|
7995
8063
|
export interface ContextObject {
|
|
7996
8064
|
/**
|
|
7997
8065
|
* Stack of context objects.
|
|
7998
8066
|
*/
|
|
7999
|
-
|
|
8000
|
-
|
|
8001
|
-
|
|
8002
|
-
|
|
8003
|
-
|
|
8004
|
-
|
|
8005
|
-
|
|
8006
|
-
|
|
8007
|
-
|
|
8008
|
-
|
|
8009
|
-
|
|
8010
|
-
|
|
8011
|
-
|
|
8012
|
-
|
|
8013
|
-
/**
|
|
8014
|
-
* Current context object.
|
|
8015
|
-
*/
|
|
8016
|
-
currentContext: {
|
|
8067
|
+
stack: Array<{
|
|
8068
|
+
/**
|
|
8069
|
+
* Name of the context object.
|
|
8070
|
+
*/
|
|
8071
|
+
name: string;
|
|
8072
|
+
/**
|
|
8073
|
+
* Type of the context object.
|
|
8074
|
+
*/
|
|
8075
|
+
type: ContextType;
|
|
8076
|
+
/**
|
|
8077
|
+
* Object IDs of the context object.
|
|
8078
|
+
*/
|
|
8079
|
+
objectIds: ObjectIds;
|
|
8080
|
+
}>;
|
|
8017
8081
|
/**
|
|
8018
|
-
*
|
|
8082
|
+
* Current context object.
|
|
8019
8083
|
*/
|
|
8020
|
-
|
|
8021
|
-
|
|
8022
|
-
|
|
8023
|
-
|
|
8084
|
+
currentContext: {
|
|
8085
|
+
/**
|
|
8086
|
+
* Name of the current context object.
|
|
8087
|
+
*/
|
|
8088
|
+
name: string;
|
|
8089
|
+
type: ContextType;
|
|
8090
|
+
objectIds: ObjectIds;
|
|
8091
|
+
};
|
|
8024
8092
|
}
|