@thoughtspot/visual-embed-sdk 1.44.2 → 1.44.4-HE-beta.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.
- package/README.md +1 -1
- package/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +44 -32
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +1 -1
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +4 -0
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +60 -0
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +7 -0
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +9 -0
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +20 -3
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +6 -1
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts +8 -8
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +18 -18
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +7 -7
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +10 -4
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +12 -2
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +1 -1
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +7 -0
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +9 -0
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +7 -0
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js +9 -0
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +7 -0
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +9 -0
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +9 -3
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +41 -8
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +156 -24
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +2 -0
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +2 -0
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +5 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/types.d.ts +142 -45
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +91 -16
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/logger.spec.d.ts +20 -5
- package/cjs/src/utils/logger.spec.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.d.ts +3 -2
- package/cjs/src/utils/processTrigger.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.js +4 -2
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils.d.ts +15 -4
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +38 -6
- package/cjs/src/utils.js.map +1 -1
- package/cjs/src/utils.spec.js +53 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/index-BFdRRz03.js +7371 -0
- package/dist/index-BUfrYJ3w.js +7371 -0
- package/dist/index-CI6s4VMY.js +7371 -0
- package/dist/{index-CSFjfTVk.js → index-CWQnMX2L.js} +1 -1
- package/dist/index-CaW-1mu5.js +7371 -0
- package/dist/index-CcSgNJVi.js +7371 -0
- package/dist/index-Djtv-y7A.js +7371 -0
- package/dist/index-UY-4yjBN.js +7371 -0
- package/dist/src/embed/app.d.ts +44 -32
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +1 -1
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +7 -0
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +20 -3
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts +8 -8
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +10 -4
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +7 -0
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +7 -0
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +7 -0
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +9 -3
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/errors.d.ts +2 -0
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +142 -45
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/logger.spec.d.ts +20 -5
- package/dist/src/utils/logger.spec.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +3 -2
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +15 -4
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +288 -95
- package/dist/tsembed-react.js +287 -94
- package/dist/tsembed.es.js +289 -96
- package/dist/tsembed.js +314 -121
- package/dist/visual-embed-sdk-react-full.d.ts +246 -83
- package/dist/visual-embed-sdk-react.d.ts +251 -90
- package/dist/visual-embed-sdk.d.ts +299 -93
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +44 -32
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -1
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +5 -1
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +61 -1
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +7 -0
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +9 -0
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +20 -3
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +5 -0
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts +8 -8
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +18 -18
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +7 -7
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +10 -4
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +12 -2
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +1 -1
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +7 -0
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +9 -0
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +7 -0
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +9 -0
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +7 -0
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +9 -0
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +9 -3
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +41 -8
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +156 -24
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.d.ts +2 -0
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +2 -0
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/types.d.ts +142 -45
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +90 -15
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/logger.spec.d.ts +20 -5
- package/lib/src/utils/logger.spec.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.d.ts +3 -2
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +4 -2
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils.d.ts +15 -4
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +35 -5
- package/lib/src/utils.js.map +1 -1
- package/lib/src/utils.spec.js +54 -1
- package/lib/src/utils.spec.js.map +1 -1
- package/package.json +1 -1
- package/src/embed/app.ts +45 -32
- package/src/embed/base.spec.ts +79 -1
- package/src/embed/base.ts +5 -2
- package/src/embed/conversation.ts +11 -0
- package/src/embed/hostEventClient/contracts.ts +23 -4
- package/src/embed/hostEventClient/host-event-client.spec.ts +7 -1
- package/src/embed/hostEventClient/host-event-client.ts +22 -11
- package/src/embed/liveboard.spec.ts +1 -1
- package/src/embed/liveboard.ts +18 -5
- package/src/embed/sage.ts +11 -0
- package/src/embed/search-bar.tsx +11 -0
- package/src/embed/search.ts +11 -0
- package/src/embed/ts-embed.spec.ts +205 -18
- package/src/embed/ts-embed.ts +45 -9
- package/src/errors.ts +2 -0
- package/src/index.ts +6 -0
- package/src/types.ts +146 -43
- package/src/utils/processTrigger.ts +6 -3
- package/src/utils.spec.ts +78 -0
- package/src/utils.ts +35 -8
|
@@ -1005,56 +1005,70 @@ declare enum AuthType {
|
|
|
1005
1005
|
}
|
|
1006
1006
|
/**
|
|
1007
1007
|
*
|
|
1008
|
-
* This
|
|
1009
|
-
* To access the updated modular homepage,
|
|
1010
|
-
* set `modularHomeExperience` to `true`
|
|
1011
|
-
* (available as Early Access feature in 9.12.5.cl).
|
|
1008
|
+
* **Note**: This attribute is not supported in the classic (V1) homepage experience.
|
|
1012
1009
|
*
|
|
1013
1010
|
*/
|
|
1014
1011
|
export declare enum HomeLeftNavItem {
|
|
1015
1012
|
/**
|
|
1013
|
+
* The *Search data* option in
|
|
1014
|
+
* the *Insights* left navigation panel.
|
|
1016
1015
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1017
1016
|
*/
|
|
1018
1017
|
SearchData = "search-data",
|
|
1019
1018
|
/**
|
|
1019
|
+
* The *Home* menu option in
|
|
1020
|
+
* the *Insights* left navigation panel.
|
|
1020
1021
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1021
1022
|
*/
|
|
1022
1023
|
Home = "insights-home",
|
|
1023
1024
|
/**
|
|
1025
|
+
* The *Liveboards* menu option in
|
|
1026
|
+
* the *Insights* left navigation panel.
|
|
1024
1027
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1025
1028
|
*/
|
|
1026
1029
|
Liveboards = "liveboards",
|
|
1027
1030
|
/**
|
|
1031
|
+
* The *Answers* menu option in
|
|
1032
|
+
* the *Insights* left navigation panel.
|
|
1028
1033
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1029
1034
|
*/
|
|
1030
1035
|
Answers = "answers",
|
|
1031
1036
|
/**
|
|
1037
|
+
* The *Monitor subscriptions* menu option in
|
|
1038
|
+
* the *Insights* left navigation panel.
|
|
1032
1039
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1033
1040
|
*/
|
|
1034
1041
|
MonitorSubscription = "monitor-alerts",
|
|
1035
1042
|
/**
|
|
1043
|
+
* The *SpotIQ analysis* menu option in
|
|
1044
|
+
* the *Insights* left navigation panel.
|
|
1036
1045
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1037
1046
|
*/
|
|
1038
1047
|
SpotIQAnalysis = "spotiq-analysis",
|
|
1039
1048
|
/**
|
|
1049
|
+
* The *Liveboard schedules* menu option in
|
|
1050
|
+
* the *Insights* left navigation panel.
|
|
1040
1051
|
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
1041
1052
|
*/
|
|
1042
1053
|
LiveboardSchedules = "liveboard-schedules",
|
|
1043
1054
|
/**
|
|
1044
|
-
*
|
|
1045
|
-
*
|
|
1055
|
+
* The create option in the *Insights*
|
|
1056
|
+
* left navigation panel.
|
|
1057
|
+
* Available in the V3 navigation experience.
|
|
1046
1058
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1047
1059
|
*/
|
|
1048
1060
|
Create = "create",
|
|
1049
1061
|
/**
|
|
1050
|
-
* Spotter option in the
|
|
1051
|
-
*
|
|
1062
|
+
* The *Spotter* menu option in the *Insights*
|
|
1063
|
+
* left navigation panel.
|
|
1064
|
+
* Available in the V3 navigation experience.
|
|
1052
1065
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1053
1066
|
*/
|
|
1054
1067
|
Spotter = "spotter",
|
|
1055
1068
|
/**
|
|
1056
|
-
* Favorites
|
|
1057
|
-
*
|
|
1069
|
+
* The *Favorites* section in the *Insights*
|
|
1070
|
+
* left navigation panel.
|
|
1071
|
+
* Available in the V3 navigation experience.
|
|
1058
1072
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1059
1073
|
*/
|
|
1060
1074
|
Favorites = "favorites"
|
|
@@ -1911,17 +1925,45 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1911
1925
|
* ```
|
|
1912
1926
|
*/
|
|
1913
1927
|
customActions?: CustomAction[];
|
|
1928
|
+
/**
|
|
1929
|
+
* Flag to bypass host events payload validation
|
|
1930
|
+
* @default false
|
|
1931
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
1932
|
+
* @example
|
|
1933
|
+
* ```js
|
|
1934
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
1935
|
+
* ... // other embed view config
|
|
1936
|
+
* shouldBypassPayloadValidation:true,
|
|
1937
|
+
* })
|
|
1938
|
+
* ```
|
|
1939
|
+
*/
|
|
1940
|
+
shouldBypassPayloadValidation?: boolean;
|
|
1941
|
+
/**
|
|
1942
|
+
* Flag to use host events v2. This is used to enable the new host events v2 API.
|
|
1943
|
+
* @default false
|
|
1944
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
1945
|
+
* @example
|
|
1946
|
+
* ```js
|
|
1947
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
1948
|
+
* ... // other embed view config
|
|
1949
|
+
* useHostEventsV2:true,
|
|
1950
|
+
* })
|
|
1951
|
+
* ```
|
|
1952
|
+
*/
|
|
1953
|
+
useHostEventsV2?: boolean;
|
|
1914
1954
|
}
|
|
1915
1955
|
/**
|
|
1916
1956
|
* The configuration object for Home page embeds configs.
|
|
1917
1957
|
*/
|
|
1918
1958
|
export interface HomePageConfig {
|
|
1919
1959
|
/**
|
|
1920
|
-
* Hide list
|
|
1921
|
-
*
|
|
1960
|
+
* Hide columns on list pages such as
|
|
1961
|
+
* *Liveboards* and *Answers*.
|
|
1962
|
+
* For example: `hiddenListColumns = [ListPageColumns.Author]`
|
|
1922
1963
|
*
|
|
1923
|
-
* **Note**: This option is
|
|
1924
|
-
*
|
|
1964
|
+
* **Note**: This option is available only in full app embedding and requires importing the `ListPageColumns` enum.
|
|
1965
|
+
* Starting with version 10.14.0.cl, you can use this attribute to
|
|
1966
|
+
* hide the columns on all list pages in the *Insights* section.
|
|
1925
1967
|
*
|
|
1926
1968
|
* Supported embed types: `AppEmbed`
|
|
1927
1969
|
* @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
|
|
@@ -1937,13 +1979,11 @@ export interface HomePageConfig {
|
|
|
1937
1979
|
*/
|
|
1938
1980
|
hiddenListColumns?: ListPageColumns[];
|
|
1939
1981
|
/**
|
|
1940
|
-
*
|
|
1941
|
-
*
|
|
1982
|
+
* Control the visibility of home page modules.
|
|
1983
|
+
* To specify the modules, import the `HomepageModule` enum.
|
|
1984
|
+
* For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
|
|
1942
1985
|
*
|
|
1943
|
-
* **Note**: This
|
|
1944
|
-
* To access the updated modular homepage, set
|
|
1945
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1946
|
-
* To use it, you need to import `HomepageModule` enum.
|
|
1986
|
+
* **Note**: This attribute is not supported in the classic (v1) experience.
|
|
1947
1987
|
*
|
|
1948
1988
|
* Supported embed types: `AppEmbed`
|
|
1949
1989
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1952,20 +1992,18 @@ export interface HomePageConfig {
|
|
|
1952
1992
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
1953
1993
|
*
|
|
1954
1994
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1955
|
-
* ... //
|
|
1995
|
+
* ... // V2/V3 navigation and home page experience attributes
|
|
1956
1996
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
1997
|
+
* //...other embed view configuration attributes
|
|
1957
1998
|
* })
|
|
1958
1999
|
* ```
|
|
1959
2000
|
*/
|
|
1960
2001
|
hiddenHomepageModules?: HomepageModule[];
|
|
1961
2002
|
/**
|
|
1962
|
-
*
|
|
1963
|
-
*
|
|
1964
|
-
*
|
|
1965
|
-
* **Note**: This
|
|
1966
|
-
* To access the updated modular homepage, set
|
|
1967
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1968
|
-
* To use it, you need to import `HomepageModule` enum.
|
|
2003
|
+
* Reorder home page modules.
|
|
2004
|
+
* To specify the modules, import the `HomepageModule` enum.
|
|
2005
|
+
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]`
|
|
2006
|
+
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
1969
2007
|
*
|
|
1970
2008
|
* Supported embed types: `AppEmbed`
|
|
1971
2009
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1974,16 +2012,19 @@ export interface HomePageConfig {
|
|
|
1974
2012
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
1975
2013
|
*
|
|
1976
2014
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1977
|
-
*
|
|
2015
|
+
* ...//V2/V3 navigation and home page experience attributes
|
|
1978
2016
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
2017
|
+
* //... other embed view configuration attributes
|
|
1979
2018
|
* })
|
|
1980
2019
|
* ```
|
|
1981
2020
|
*/
|
|
1982
2021
|
reorderedHomepageModules?: HomepageModule[];
|
|
1983
2022
|
/**
|
|
1984
|
-
*
|
|
1985
|
-
*
|
|
1986
|
-
* To
|
|
2023
|
+
* Controls the visibility of the menu items
|
|
2024
|
+
* on the home page left navigation panel.
|
|
2025
|
+
* To specify the menu items, import the `HomeLeftNavItem` enum.
|
|
2026
|
+
*
|
|
2027
|
+
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
1987
2028
|
*
|
|
1988
2029
|
* Supported embed types: `AppEmbed`
|
|
1989
2030
|
* @example
|
|
@@ -1991,15 +2032,11 @@ export interface HomePageConfig {
|
|
|
1991
2032
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
1992
2033
|
*
|
|
1993
2034
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1994
|
-
*
|
|
2035
|
+
* //... V2/V3 experience attributes
|
|
1995
2036
|
* hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
|
|
2037
|
+
* ... //other embed view configuration attributes
|
|
1996
2038
|
* })
|
|
1997
2039
|
* ```
|
|
1998
|
-
*
|
|
1999
|
-
* **Note**: This option does not apply to the classic homepage.
|
|
2000
|
-
* To access the updated modular homepage, set
|
|
2001
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2002
|
-
* To use it, you need to import `HomeLeftNavItem` enum.
|
|
2003
2040
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2004
2041
|
*/
|
|
2005
2042
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -2517,10 +2554,11 @@ export declare enum RuntimeFilterOp {
|
|
|
2517
2554
|
NOT_IN = "NOT_IN"
|
|
2518
2555
|
}
|
|
2519
2556
|
/**
|
|
2520
|
-
* Home page
|
|
2521
|
-
*
|
|
2522
|
-
*
|
|
2523
|
-
*
|
|
2557
|
+
* Home page modules that can be hidden
|
|
2558
|
+
* via `hiddenHomepageModules` and reordered via
|
|
2559
|
+
* `reorderedHomepageModules`.
|
|
2560
|
+
*
|
|
2561
|
+
* **Note**: This option is not supported in the classic (v1) experience.
|
|
2524
2562
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2525
2563
|
*/
|
|
2526
2564
|
export declare enum HomepageModule {
|
|
@@ -2533,7 +2571,7 @@ export declare enum HomepageModule {
|
|
|
2533
2571
|
*/
|
|
2534
2572
|
Watchlist = "WATCHLIST",
|
|
2535
2573
|
/**
|
|
2536
|
-
*
|
|
2574
|
+
* Favorite module
|
|
2537
2575
|
*/
|
|
2538
2576
|
Favorite = "FAVORITE",
|
|
2539
2577
|
/**
|
|
@@ -3721,6 +3759,28 @@ export declare enum EmbedEvent {
|
|
|
3721
3759
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3722
3760
|
*/
|
|
3723
3761
|
PreviewSpotterData = "PreviewSpotterData",
|
|
3762
|
+
/**
|
|
3763
|
+
* Emitted when user opens up the Add to Coaching modal on any visualization in Spotter Embed.
|
|
3764
|
+
* @example
|
|
3765
|
+
* ```js
|
|
3766
|
+
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
3767
|
+
* console.log('payload', payload);
|
|
3768
|
+
* })
|
|
3769
|
+
*```
|
|
3770
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3771
|
+
*/
|
|
3772
|
+
AddToCoaching = "addToCoaching",
|
|
3773
|
+
/**
|
|
3774
|
+
* Emitted when user opens up the data model instructions modal in Spotter embed.
|
|
3775
|
+
* @example
|
|
3776
|
+
* ```js
|
|
3777
|
+
* spotterEmbed.on(EmbedEvent.DataModelInstructions, (payload) => {
|
|
3778
|
+
* console.log('payload', payload);
|
|
3779
|
+
* })
|
|
3780
|
+
* ```
|
|
3781
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3782
|
+
*/
|
|
3783
|
+
DataModelInstructions = "DataModelInstructions",
|
|
3724
3784
|
/**
|
|
3725
3785
|
* Emitted when the Spotter query is triggered in Spotter embed.
|
|
3726
3786
|
* @example
|
|
@@ -5144,6 +5204,26 @@ export declare enum HostEvent {
|
|
|
5144
5204
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5145
5205
|
*/
|
|
5146
5206
|
PreviewSpotterData = "PreviewSpotterData",
|
|
5207
|
+
/**
|
|
5208
|
+
* Opens the Add to Coaching modal from a visualization in Spotter Embed.
|
|
5209
|
+
* @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
|
|
5210
|
+
* @example
|
|
5211
|
+
* ```js
|
|
5212
|
+
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
5213
|
+
*
|
|
5214
|
+
*```
|
|
5215
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5216
|
+
*/
|
|
5217
|
+
AddToCoaching = "addToCoaching",
|
|
5218
|
+
/**
|
|
5219
|
+
* Opens the data model instructions modal in Spotter Embed.
|
|
5220
|
+
* @example
|
|
5221
|
+
* ```js
|
|
5222
|
+
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
5223
|
+
* ```
|
|
5224
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5225
|
+
*/
|
|
5226
|
+
DataModelInstructions = "DataModelInstructions",
|
|
5147
5227
|
/**
|
|
5148
5228
|
* Resets the Spotter Embed Conversation.
|
|
5149
5229
|
* @example
|
|
@@ -5245,7 +5325,16 @@ export declare enum HostEvent {
|
|
|
5245
5325
|
* ```
|
|
5246
5326
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5247
5327
|
*/
|
|
5248
|
-
StartNewSpotterConversation = "StartNewSpotterConversation"
|
|
5328
|
+
StartNewSpotterConversation = "StartNewSpotterConversation",
|
|
5329
|
+
/**
|
|
5330
|
+
* Get the current context of the embedded page.
|
|
5331
|
+
* @example
|
|
5332
|
+
* ```js
|
|
5333
|
+
* const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
|
|
5334
|
+
* ```
|
|
5335
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5336
|
+
*/
|
|
5337
|
+
GetPageContext = "GetPageContext"
|
|
5249
5338
|
}
|
|
5250
5339
|
/**
|
|
5251
5340
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -6768,7 +6857,9 @@ declare enum EmbedErrorCodes {
|
|
|
6768
6857
|
/** Host event type is undefined or invalid */
|
|
6769
6858
|
HOST_EVENT_TYPE_UNDEFINED = "HOST_EVENT_TYPE_UNDEFINED",
|
|
6770
6859
|
/** Error parsing api intercept body */
|
|
6771
|
-
PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR"
|
|
6860
|
+
PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
|
|
6861
|
+
/** Failed to update embed parameters during pre-render */
|
|
6862
|
+
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
|
|
6772
6863
|
}
|
|
6773
6864
|
/**
|
|
6774
6865
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -6841,6 +6932,12 @@ export interface EmbedErrorDetailsEvent {
|
|
|
6841
6932
|
/** Additional context-specific for backward compatibility */
|
|
6842
6933
|
[key: string]: any;
|
|
6843
6934
|
}
|
|
6935
|
+
declare enum ContextType {
|
|
6936
|
+
Search = "search-answer",
|
|
6937
|
+
Liveboard = "liveboard",
|
|
6938
|
+
Answer = "answer",
|
|
6939
|
+
Spotter = "spotter"
|
|
6940
|
+
}
|
|
6844
6941
|
export interface DefaultAppInitData {
|
|
6845
6942
|
customisations: CustomisationsInterface;
|
|
6846
6943
|
authToken: string;
|
|
@@ -7086,9 +7183,25 @@ export type EmbedApiHostEventMapping = {
|
|
|
7086
7183
|
[HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
|
|
7087
7184
|
};
|
|
7088
7185
|
export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7089
|
-
export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7186
|
+
export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7090
7187
|
export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
|
|
7091
|
-
export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
|
|
7188
|
+
export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
|
|
7189
|
+
declare enum PageType {
|
|
7190
|
+
PAGE = "page",
|
|
7191
|
+
DIALOG = "dialog"
|
|
7192
|
+
}
|
|
7193
|
+
export interface Objects {
|
|
7194
|
+
answerId?: string;
|
|
7195
|
+
liveboardId?: string;
|
|
7196
|
+
vizIds?: string[];
|
|
7197
|
+
dataModelIds?: string[];
|
|
7198
|
+
modalTitle?: string;
|
|
7199
|
+
}
|
|
7200
|
+
export interface PageContextOptions {
|
|
7201
|
+
page: ContextType;
|
|
7202
|
+
pageType: PageType;
|
|
7203
|
+
objects: Objects;
|
|
7204
|
+
}
|
|
7092
7205
|
declare class HostEventClient {
|
|
7093
7206
|
iFrame: HTMLIFrameElement;
|
|
7094
7207
|
constructor(iFrame?: HTMLIFrameElement);
|
|
@@ -7098,18 +7211,18 @@ declare class HostEventClient {
|
|
|
7098
7211
|
* @param {any} data Data to send with the host event
|
|
7099
7212
|
* @returns {Promise<any>} - the response from the process trigger
|
|
7100
7213
|
*/
|
|
7101
|
-
protected processTrigger(message: HostEvent, data: any): Promise<any>;
|
|
7102
|
-
handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT
|
|
7103
|
-
hostEventFallback(hostEvent: HostEvent, data: any): Promise<any>;
|
|
7214
|
+
protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
|
|
7215
|
+
handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
|
|
7216
|
+
hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
|
|
7104
7217
|
/**
|
|
7105
7218
|
* Setter for the iframe element used for host events
|
|
7106
7219
|
* @param {HTMLIFrameElement} iFrame - the iframe element to set
|
|
7107
7220
|
*/
|
|
7108
7221
|
setIframeElement(iFrame: HTMLIFrameElement): void;
|
|
7109
|
-
triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT
|
|
7110
|
-
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin
|
|
7111
|
-
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer
|
|
7112
|
-
triggerHostEvent<HostEventT extends HostEvent, PayloadT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT
|
|
7222
|
+
triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
|
|
7223
|
+
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
7224
|
+
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
7225
|
+
triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
|
|
7113
7226
|
}
|
|
7114
7227
|
declare class TsEmbed {
|
|
7115
7228
|
/**
|
|
@@ -7277,7 +7390,7 @@ declare class TsEmbed {
|
|
|
7277
7390
|
* @param query
|
|
7278
7391
|
*/
|
|
7279
7392
|
protected getEmbedBasePath(query: string): string;
|
|
7280
|
-
protected getUpdateEmbedParamsObject(): Record<any, any
|
|
7393
|
+
protected getUpdateEmbedParamsObject(): Promise<Record<any, any>>;
|
|
7281
7394
|
/**
|
|
7282
7395
|
* Common query params set for all the embed modes.
|
|
7283
7396
|
* @param queryParams
|
|
@@ -7431,7 +7544,7 @@ declare class TsEmbed {
|
|
|
7431
7544
|
* @param {any} data The payload to send with the message
|
|
7432
7545
|
* @returns A promise that resolves with the response from the embedded app
|
|
7433
7546
|
*/
|
|
7434
|
-
trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT
|
|
7547
|
+
trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
|
|
7435
7548
|
/**
|
|
7436
7549
|
* Triggers an event to the embedded app, skipping the UI flow.
|
|
7437
7550
|
* @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
|
|
@@ -7449,6 +7562,12 @@ declare class TsEmbed {
|
|
|
7449
7562
|
render(): Promise<TsEmbed>;
|
|
7450
7563
|
getIframeSrc(): string;
|
|
7451
7564
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
7565
|
+
/**
|
|
7566
|
+
* Get the current context of the embedded TS component.
|
|
7567
|
+
* @returns The current context object containing the page type and object ids.
|
|
7568
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7569
|
+
*/
|
|
7570
|
+
getCurrentContext(): Promise<any>;
|
|
7452
7571
|
/**
|
|
7453
7572
|
* Creates the preRender shell
|
|
7454
7573
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
@@ -7874,6 +7993,12 @@ declare class SearchEmbed extends TsEmbed {
|
|
|
7874
7993
|
* Render the embedded ThoughtSpot search
|
|
7875
7994
|
*/
|
|
7876
7995
|
render(): Promise<SearchEmbed>;
|
|
7996
|
+
/**
|
|
7997
|
+
* Get the current context of the embedded search.
|
|
7998
|
+
* @returns The current context object containing the page type and object ids.
|
|
7999
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8000
|
+
*/
|
|
8001
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
7877
8002
|
}
|
|
7878
8003
|
/**
|
|
7879
8004
|
* @group Embed components
|
|
@@ -7992,6 +8117,12 @@ declare class SearchBarEmbed extends TsEmbed {
|
|
|
7992
8117
|
searchOptions: SearchOptions;
|
|
7993
8118
|
};
|
|
7994
8119
|
protected getAppInitData(): Promise<SearchAppInitData$1>;
|
|
8120
|
+
/**
|
|
8121
|
+
* Get the current context of the embedded search bar.
|
|
8122
|
+
* @returns The current context object containing the page type and object ids.
|
|
8123
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8124
|
+
*/
|
|
8125
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
7995
8126
|
}
|
|
7996
8127
|
interface SearchOptions$1 {
|
|
7997
8128
|
/**
|
|
@@ -8136,6 +8267,12 @@ declare class SageEmbed extends V1Embed {
|
|
|
8136
8267
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
8137
8268
|
*/
|
|
8138
8269
|
render(): Promise<SageEmbed>;
|
|
8270
|
+
/**
|
|
8271
|
+
* Get the current context of the embedded SageEmbed.
|
|
8272
|
+
* @returns The current context object containing the page type and object ids.
|
|
8273
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8274
|
+
*/
|
|
8275
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
8139
8276
|
}
|
|
8140
8277
|
/**
|
|
8141
8278
|
* Pages within the ThoughtSpot app that can be embedded.
|
|
@@ -8265,14 +8402,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8265
8402
|
*/
|
|
8266
8403
|
showPrimaryNavbar?: boolean;
|
|
8267
8404
|
/**
|
|
8268
|
-
* Control the visibility of the left navigation
|
|
8269
|
-
*
|
|
8270
|
-
*
|
|
8271
|
-
*
|
|
8405
|
+
* Control the visibility of the left navigation panel on the home page
|
|
8406
|
+
* in the V2 and V3 navigation and home page experience.
|
|
8407
|
+
* If `showPrimaryNavbar` is true, that is, if the Global and Homepage
|
|
8408
|
+
* navigation bars are visible, this flag will only hide the left navigation bar
|
|
8409
|
+
* on the home page.
|
|
8410
|
+
* The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
|
|
8272
8411
|
*
|
|
8273
|
-
* **Note**: This
|
|
8274
|
-
* To access the updated modular homepage, set
|
|
8275
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
8412
|
+
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8276
8413
|
*
|
|
8277
8414
|
* Supported embed types: `AppEmbed`
|
|
8278
8415
|
* @default false
|
|
@@ -8287,8 +8424,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8287
8424
|
*/
|
|
8288
8425
|
hideHomepageLeftNav?: boolean;
|
|
8289
8426
|
/**
|
|
8290
|
-
* Control the visibility of the help (?) and profile
|
|
8291
|
-
*
|
|
8427
|
+
* Control the visibility of the help (?) and profile
|
|
8428
|
+
* buttons on the top navigation bar.
|
|
8429
|
+
* These buttons are visible if the
|
|
8430
|
+
* navigation bar is not hidden via `showPrimaryNavbar`.
|
|
8292
8431
|
*
|
|
8293
8432
|
* Supported embed types: `AppEmbed`
|
|
8294
8433
|
* @default false
|
|
@@ -8305,7 +8444,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8305
8444
|
/**
|
|
8306
8445
|
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
8307
8446
|
* @default true
|
|
8308
|
-
* Whether the help menu in the top
|
|
8447
|
+
* Whether the help menu in the top navigation bar should be served
|
|
8309
8448
|
* from Pendo or ThoughtSpot's internal help items.
|
|
8310
8449
|
*
|
|
8311
8450
|
* Supported embed types: `AppEmbed`
|
|
@@ -8319,8 +8458,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8319
8458
|
*/
|
|
8320
8459
|
enablePendoHelp?: boolean;
|
|
8321
8460
|
/**
|
|
8322
|
-
* Control the visibility of the hamburger icon on
|
|
8323
|
-
*
|
|
8461
|
+
* Control the visibility of the hamburger icon on
|
|
8462
|
+
* the top navigation bar in the V3 navigation experience.
|
|
8324
8463
|
*
|
|
8325
8464
|
* Supported embed types: `AppEmbed`
|
|
8326
8465
|
* @default false
|
|
@@ -8335,8 +8474,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8335
8474
|
*/
|
|
8336
8475
|
hideHamburger?: boolean;
|
|
8337
8476
|
/**
|
|
8338
|
-
* Control the visibility of the
|
|
8339
|
-
*
|
|
8477
|
+
* Control the visibility of the object search
|
|
8478
|
+
* on the top navigation bar in the
|
|
8479
|
+
* V2 and V3 navigation experience.
|
|
8480
|
+
*
|
|
8481
|
+
* **Note**: This attribute is not supported
|
|
8482
|
+
* in the classic (V1) experience.
|
|
8340
8483
|
*
|
|
8341
8484
|
* Supported embed types: `AppEmbed`
|
|
8342
8485
|
* @default true
|
|
@@ -8351,8 +8494,11 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8351
8494
|
*/
|
|
8352
8495
|
hideObjectSearch?: boolean;
|
|
8353
8496
|
/**
|
|
8354
|
-
* Control the visibility of the notification
|
|
8355
|
-
*
|
|
8497
|
+
* Control the visibility of the notification icon
|
|
8498
|
+
* on the top navigation bar in V3 navigation experience.
|
|
8499
|
+
*
|
|
8500
|
+
* **Note**: This attribute is not supported
|
|
8501
|
+
* in the classic (V1) and V2 experience modes.
|
|
8356
8502
|
*
|
|
8357
8503
|
* Supported embed types: `AppEmbed`
|
|
8358
8504
|
* @default true
|
|
@@ -8367,12 +8513,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8367
8513
|
*/
|
|
8368
8514
|
hideNotification?: boolean;
|
|
8369
8515
|
/**
|
|
8370
|
-
* Control the visibility of the application
|
|
8371
|
-
*
|
|
8516
|
+
* Control the visibility of the application selection menu
|
|
8517
|
+
* in the top navigation bar in the V2 experience.
|
|
8518
|
+
* In the V3 experience, it shows or hides application selection
|
|
8519
|
+
* icons on the left navigation panel.
|
|
8520
|
+
* By default, the application selection menu and icons are
|
|
8521
|
+
* shown in the UI
|
|
8372
8522
|
*
|
|
8373
|
-
* **Note**: This
|
|
8374
|
-
* To access the updated modular homepage, set
|
|
8375
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
8523
|
+
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8376
8524
|
*
|
|
8377
8525
|
* Supported embed types: `AppEmbed`
|
|
8378
8526
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -8390,9 +8538,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8390
8538
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
8391
8539
|
* By default, the Org switcher button is shown.
|
|
8392
8540
|
*
|
|
8393
|
-
* **Note**: This
|
|
8394
|
-
* To access the updated modular homepage, set
|
|
8395
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
8541
|
+
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8396
8542
|
*
|
|
8397
8543
|
* Supported embed types: `AppEmbed`
|
|
8398
8544
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -8545,8 +8691,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8545
8691
|
*/
|
|
8546
8692
|
fullHeight?: boolean;
|
|
8547
8693
|
/**
|
|
8548
|
-
*
|
|
8549
|
-
*
|
|
8694
|
+
* Enables the V2 navigation and modular home page experience.
|
|
8695
|
+
* For more information,
|
|
8696
|
+
* see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
8550
8697
|
* Supported embed types: `AppEmbed`
|
|
8551
8698
|
* @default false
|
|
8552
8699
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -8560,18 +8707,20 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8560
8707
|
*/
|
|
8561
8708
|
modularHomeExperience?: boolean;
|
|
8562
8709
|
/**
|
|
8563
|
-
*
|
|
8564
|
-
*
|
|
8710
|
+
* Configures the V3 navigation and home page experience.
|
|
8711
|
+
* For more information, see
|
|
8712
|
+
* link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
8565
8713
|
* Supported embed types: `AppEmbed`
|
|
8566
8714
|
* @default false
|
|
8567
8715
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
8568
8716
|
* @example
|
|
8569
8717
|
* ```js
|
|
8570
8718
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
8571
|
-
*
|
|
8719
|
+
* // Enable V3 navigation and home page experience
|
|
8572
8720
|
* discoveryExperience : {
|
|
8573
|
-
* primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
|
|
8574
|
-
* homePage: HomePage.
|
|
8721
|
+
* primaryNavbarVersion: PrimaryNavbarVersion.Sliding, // Enable V3 navigation
|
|
8722
|
+
* homePage: HomePage.ModularWithStylingChanges, // Enable V3 modular home page
|
|
8723
|
+
* ... // other embed view config
|
|
8575
8724
|
* },
|
|
8576
8725
|
* })
|
|
8577
8726
|
* ```
|
|
@@ -8719,7 +8868,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8719
8868
|
* Setting this height helps resolve issues with empty Apps and
|
|
8720
8869
|
* other screens navigable from an App.
|
|
8721
8870
|
*
|
|
8722
|
-
* @version SDK: 1.44.2 | ThoughtSpot:
|
|
8871
|
+
* @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
|
|
8723
8872
|
* @default 500
|
|
8724
8873
|
* @example
|
|
8725
8874
|
* ```js
|
|
@@ -8853,7 +9002,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8853
9002
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
8854
9003
|
* other screens navigable from a Liveboard.
|
|
8855
9004
|
*
|
|
8856
|
-
* @version SDK: 1.44.2 | ThoughtSpot:
|
|
9005
|
+
* @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
|
|
8857
9006
|
* @default 500
|
|
8858
9007
|
* @example
|
|
8859
9008
|
* ```js
|
|
@@ -9252,7 +9401,7 @@ declare class LiveboardEmbed extends V1Embed {
|
|
|
9252
9401
|
* @param {any} data The payload to send with the message
|
|
9253
9402
|
* @returns A promise that resolves with the response from the embedded app
|
|
9254
9403
|
*/
|
|
9255
|
-
trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT
|
|
9404
|
+
trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
|
|
9256
9405
|
/**
|
|
9257
9406
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
9258
9407
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
@@ -9274,6 +9423,12 @@ declare class LiveboardEmbed extends V1Embed {
|
|
|
9274
9423
|
* @returns url string
|
|
9275
9424
|
*/
|
|
9276
9425
|
getLiveboardUrl(): string;
|
|
9426
|
+
/**
|
|
9427
|
+
* Get the current context of the embedded liveboard.
|
|
9428
|
+
* @returns The current context object containing the page type and object ids.
|
|
9429
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9430
|
+
*/
|
|
9431
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
9277
9432
|
}
|
|
9278
9433
|
/**
|
|
9279
9434
|
* Configuration for bodyless conversation options.
|
|
@@ -9511,6 +9666,12 @@ declare class SpotterEmbed extends TsEmbed {
|
|
|
9511
9666
|
protected getEmbedParamsObject(): Record<any, any>;
|
|
9512
9667
|
getIframeSrc(): string;
|
|
9513
9668
|
render(): Promise<SpotterEmbed>;
|
|
9669
|
+
/**
|
|
9670
|
+
* Get the current context of the embedded SpotterEmbed.
|
|
9671
|
+
* @returns The current context object containing the page type and object ids.
|
|
9672
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9673
|
+
*/
|
|
9674
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
9514
9675
|
}
|
|
9515
9676
|
declare class ConversationEmbed extends SpotterEmbed {
|
|
9516
9677
|
protected viewConfig: ConversationViewConfig;
|