@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
|
@@ -1010,48 +1010,65 @@ export declare enum AuthType {
|
|
|
1010
1010
|
}
|
|
1011
1011
|
declare enum HomeLeftNavItem {
|
|
1012
1012
|
/**
|
|
1013
|
+
* The *Search data* option in
|
|
1014
|
+
* the *Insights* left navigation panel.
|
|
1013
1015
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1014
1016
|
*/
|
|
1015
1017
|
SearchData = "search-data",
|
|
1016
1018
|
/**
|
|
1019
|
+
* The *Home* menu option in
|
|
1020
|
+
* the *Insights* left navigation panel.
|
|
1017
1021
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1018
1022
|
*/
|
|
1019
1023
|
Home = "insights-home",
|
|
1020
1024
|
/**
|
|
1025
|
+
* The *Liveboards* menu option in
|
|
1026
|
+
* the *Insights* left navigation panel.
|
|
1021
1027
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1022
1028
|
*/
|
|
1023
1029
|
Liveboards = "liveboards",
|
|
1024
1030
|
/**
|
|
1031
|
+
* The *Answers* menu option in
|
|
1032
|
+
* the *Insights* left navigation panel.
|
|
1025
1033
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1026
1034
|
*/
|
|
1027
1035
|
Answers = "answers",
|
|
1028
1036
|
/**
|
|
1037
|
+
* The *Monitor subscriptions* menu option in
|
|
1038
|
+
* the *Insights* left navigation panel.
|
|
1029
1039
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1030
1040
|
*/
|
|
1031
1041
|
MonitorSubscription = "monitor-alerts",
|
|
1032
1042
|
/**
|
|
1043
|
+
* The *SpotIQ analysis* menu option in
|
|
1044
|
+
* the *Insights* left navigation panel.
|
|
1033
1045
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1034
1046
|
*/
|
|
1035
1047
|
SpotIQAnalysis = "spotiq-analysis",
|
|
1036
1048
|
/**
|
|
1049
|
+
* The *Liveboard schedules* menu option in
|
|
1050
|
+
* the *Insights* left navigation panel.
|
|
1037
1051
|
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
1038
1052
|
*/
|
|
1039
1053
|
LiveboardSchedules = "liveboard-schedules",
|
|
1040
1054
|
/**
|
|
1041
|
-
*
|
|
1042
|
-
*
|
|
1055
|
+
* The create option in the *Insights*
|
|
1056
|
+
* left navigation panel.
|
|
1057
|
+
* Available in the V3 navigation experience.
|
|
1043
1058
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1044
1059
|
*/
|
|
1045
1060
|
Create = "create",
|
|
1046
1061
|
/**
|
|
1047
|
-
* Spotter option in the
|
|
1048
|
-
*
|
|
1062
|
+
* The *Spotter* menu option in the *Insights*
|
|
1063
|
+
* left navigation panel.
|
|
1064
|
+
* Available in the V3 navigation experience.
|
|
1049
1065
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1050
1066
|
*/
|
|
1051
1067
|
Spotter = "spotter",
|
|
1052
1068
|
/**
|
|
1053
|
-
* Favorites
|
|
1054
|
-
*
|
|
1069
|
+
* The *Favorites* section in the *Insights*
|
|
1070
|
+
* left navigation panel.
|
|
1071
|
+
* Available in the V3 navigation experience.
|
|
1055
1072
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1056
1073
|
*/
|
|
1057
1074
|
Favorites = "favorites"
|
|
@@ -1908,17 +1925,45 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1908
1925
|
* ```
|
|
1909
1926
|
*/
|
|
1910
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;
|
|
1911
1954
|
}
|
|
1912
1955
|
/**
|
|
1913
1956
|
* The configuration object for Home page embeds configs.
|
|
1914
1957
|
*/
|
|
1915
1958
|
export interface HomePageConfig {
|
|
1916
1959
|
/**
|
|
1917
|
-
* Hide list
|
|
1918
|
-
*
|
|
1960
|
+
* Hide columns on list pages such as
|
|
1961
|
+
* *Liveboards* and *Answers*.
|
|
1962
|
+
* For example: `hiddenListColumns = [ListPageColumns.Author]`
|
|
1919
1963
|
*
|
|
1920
|
-
* **Note**: This option is
|
|
1921
|
-
*
|
|
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.
|
|
1922
1967
|
*
|
|
1923
1968
|
* Supported embed types: `AppEmbed`
|
|
1924
1969
|
* @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
|
|
@@ -1934,13 +1979,11 @@ export interface HomePageConfig {
|
|
|
1934
1979
|
*/
|
|
1935
1980
|
hiddenListColumns?: ListPageColumns[];
|
|
1936
1981
|
/**
|
|
1937
|
-
*
|
|
1938
|
-
*
|
|
1982
|
+
* Control the visibility of home page modules.
|
|
1983
|
+
* To specify the modules, import the `HomepageModule` enum.
|
|
1984
|
+
* For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
|
|
1939
1985
|
*
|
|
1940
|
-
* **Note**: This
|
|
1941
|
-
* To access the updated modular homepage, set
|
|
1942
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1943
|
-
* To use it, you need to import `HomepageModule` enum.
|
|
1986
|
+
* **Note**: This attribute is not supported in the classic (v1) experience.
|
|
1944
1987
|
*
|
|
1945
1988
|
* Supported embed types: `AppEmbed`
|
|
1946
1989
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1949,20 +1992,18 @@ export interface HomePageConfig {
|
|
|
1949
1992
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
1950
1993
|
*
|
|
1951
1994
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1952
|
-
* ... //
|
|
1995
|
+
* ... // V2/V3 navigation and home page experience attributes
|
|
1953
1996
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
1997
|
+
* //...other embed view configuration attributes
|
|
1954
1998
|
* })
|
|
1955
1999
|
* ```
|
|
1956
2000
|
*/
|
|
1957
2001
|
hiddenHomepageModules?: HomepageModule[];
|
|
1958
2002
|
/**
|
|
1959
|
-
*
|
|
1960
|
-
*
|
|
1961
|
-
*
|
|
1962
|
-
* **Note**: This
|
|
1963
|
-
* To access the updated modular homepage, set
|
|
1964
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1965
|
-
* 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.
|
|
1966
2007
|
*
|
|
1967
2008
|
* Supported embed types: `AppEmbed`
|
|
1968
2009
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1971,16 +2012,19 @@ export interface HomePageConfig {
|
|
|
1971
2012
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
1972
2013
|
*
|
|
1973
2014
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1974
|
-
*
|
|
2015
|
+
* ...//V2/V3 navigation and home page experience attributes
|
|
1975
2016
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
2017
|
+
* //... other embed view configuration attributes
|
|
1976
2018
|
* })
|
|
1977
2019
|
* ```
|
|
1978
2020
|
*/
|
|
1979
2021
|
reorderedHomepageModules?: HomepageModule[];
|
|
1980
2022
|
/**
|
|
1981
|
-
*
|
|
1982
|
-
*
|
|
1983
|
-
* 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.
|
|
1984
2028
|
*
|
|
1985
2029
|
* Supported embed types: `AppEmbed`
|
|
1986
2030
|
* @example
|
|
@@ -1988,15 +2032,11 @@ export interface HomePageConfig {
|
|
|
1988
2032
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
1989
2033
|
*
|
|
1990
2034
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1991
|
-
*
|
|
2035
|
+
* //... V2/V3 experience attributes
|
|
1992
2036
|
* hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
|
|
2037
|
+
* ... //other embed view configuration attributes
|
|
1993
2038
|
* })
|
|
1994
2039
|
* ```
|
|
1995
|
-
*
|
|
1996
|
-
* **Note**: This option does not apply to the classic homepage.
|
|
1997
|
-
* To access the updated modular homepage, set
|
|
1998
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1999
|
-
* To use it, you need to import `HomeLeftNavItem` enum.
|
|
2000
2040
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2001
2041
|
*/
|
|
2002
2042
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -2523,7 +2563,7 @@ declare enum HomepageModule {
|
|
|
2523
2563
|
*/
|
|
2524
2564
|
Watchlist = "WATCHLIST",
|
|
2525
2565
|
/**
|
|
2526
|
-
*
|
|
2566
|
+
* Favorite module
|
|
2527
2567
|
*/
|
|
2528
2568
|
Favorite = "FAVORITE",
|
|
2529
2569
|
/**
|
|
@@ -3706,6 +3746,28 @@ export declare enum EmbedEvent {
|
|
|
3706
3746
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3707
3747
|
*/
|
|
3708
3748
|
PreviewSpotterData = "PreviewSpotterData",
|
|
3749
|
+
/**
|
|
3750
|
+
* Emitted when user opens up the Add to Coaching modal on any visualization in Spotter Embed.
|
|
3751
|
+
* @example
|
|
3752
|
+
* ```js
|
|
3753
|
+
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
3754
|
+
* console.log('payload', payload);
|
|
3755
|
+
* })
|
|
3756
|
+
*```
|
|
3757
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3758
|
+
*/
|
|
3759
|
+
AddToCoaching = "addToCoaching",
|
|
3760
|
+
/**
|
|
3761
|
+
* Emitted when user opens up the data model instructions modal in Spotter embed.
|
|
3762
|
+
* @example
|
|
3763
|
+
* ```js
|
|
3764
|
+
* spotterEmbed.on(EmbedEvent.DataModelInstructions, (payload) => {
|
|
3765
|
+
* console.log('payload', payload);
|
|
3766
|
+
* })
|
|
3767
|
+
* ```
|
|
3768
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3769
|
+
*/
|
|
3770
|
+
DataModelInstructions = "DataModelInstructions",
|
|
3709
3771
|
/**
|
|
3710
3772
|
* Emitted when the Spotter query is triggered in Spotter embed.
|
|
3711
3773
|
* @example
|
|
@@ -5129,6 +5191,26 @@ export declare enum HostEvent {
|
|
|
5129
5191
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5130
5192
|
*/
|
|
5131
5193
|
PreviewSpotterData = "PreviewSpotterData",
|
|
5194
|
+
/**
|
|
5195
|
+
* Opens the Add to Coaching modal from a visualization in Spotter Embed.
|
|
5196
|
+
* @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
|
|
5197
|
+
* @example
|
|
5198
|
+
* ```js
|
|
5199
|
+
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
5200
|
+
*
|
|
5201
|
+
*```
|
|
5202
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5203
|
+
*/
|
|
5204
|
+
AddToCoaching = "addToCoaching",
|
|
5205
|
+
/**
|
|
5206
|
+
* Opens the data model instructions modal in Spotter Embed.
|
|
5207
|
+
* @example
|
|
5208
|
+
* ```js
|
|
5209
|
+
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
5210
|
+
* ```
|
|
5211
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5212
|
+
*/
|
|
5213
|
+
DataModelInstructions = "DataModelInstructions",
|
|
5132
5214
|
/**
|
|
5133
5215
|
* Resets the Spotter Embed Conversation.
|
|
5134
5216
|
* @example
|
|
@@ -5230,7 +5312,16 @@ export declare enum HostEvent {
|
|
|
5230
5312
|
* ```
|
|
5231
5313
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5232
5314
|
*/
|
|
5233
|
-
StartNewSpotterConversation = "StartNewSpotterConversation"
|
|
5315
|
+
StartNewSpotterConversation = "StartNewSpotterConversation",
|
|
5316
|
+
/**
|
|
5317
|
+
* Get the current context of the embedded page.
|
|
5318
|
+
* @example
|
|
5319
|
+
* ```js
|
|
5320
|
+
* const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
|
|
5321
|
+
* ```
|
|
5322
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5323
|
+
*/
|
|
5324
|
+
GetPageContext = "GetPageContext"
|
|
5234
5325
|
}
|
|
5235
5326
|
/**
|
|
5236
5327
|
* The different visual modes that the data sources panel within
|
|
@@ -6774,7 +6865,9 @@ declare enum EmbedErrorCodes {
|
|
|
6774
6865
|
/** Host event type is undefined or invalid */
|
|
6775
6866
|
HOST_EVENT_TYPE_UNDEFINED = "HOST_EVENT_TYPE_UNDEFINED",
|
|
6776
6867
|
/** Error parsing api intercept body */
|
|
6777
|
-
PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR"
|
|
6868
|
+
PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
|
|
6869
|
+
/** Failed to update embed parameters during pre-render */
|
|
6870
|
+
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
|
|
6778
6871
|
}
|
|
6779
6872
|
/**
|
|
6780
6873
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -6847,6 +6940,12 @@ export interface EmbedErrorDetailsEvent {
|
|
|
6847
6940
|
/** Additional context-specific for backward compatibility */
|
|
6848
6941
|
[key: string]: any;
|
|
6849
6942
|
}
|
|
6943
|
+
declare enum ContextType {
|
|
6944
|
+
Search = "search-answer",
|
|
6945
|
+
Liveboard = "liveboard",
|
|
6946
|
+
Answer = "answer",
|
|
6947
|
+
Spotter = "spotter"
|
|
6948
|
+
}
|
|
6850
6949
|
export interface DefaultAppInitData {
|
|
6851
6950
|
customisations: CustomisationsInterface;
|
|
6852
6951
|
authToken: string;
|
|
@@ -7108,9 +7207,25 @@ export type EmbedApiHostEventMapping = {
|
|
|
7108
7207
|
[HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
|
|
7109
7208
|
};
|
|
7110
7209
|
export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7111
|
-
export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7210
|
+
export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7112
7211
|
export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
|
|
7113
|
-
export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
|
|
7212
|
+
export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
|
|
7213
|
+
declare enum PageType {
|
|
7214
|
+
PAGE = "page",
|
|
7215
|
+
DIALOG = "dialog"
|
|
7216
|
+
}
|
|
7217
|
+
export interface Objects {
|
|
7218
|
+
answerId?: string;
|
|
7219
|
+
liveboardId?: string;
|
|
7220
|
+
vizIds?: string[];
|
|
7221
|
+
dataModelIds?: string[];
|
|
7222
|
+
modalTitle?: string;
|
|
7223
|
+
}
|
|
7224
|
+
export interface PageContextOptions {
|
|
7225
|
+
page: ContextType;
|
|
7226
|
+
pageType: PageType;
|
|
7227
|
+
objects: Objects;
|
|
7228
|
+
}
|
|
7114
7229
|
declare class HostEventClient {
|
|
7115
7230
|
iFrame: HTMLIFrameElement;
|
|
7116
7231
|
constructor(iFrame?: HTMLIFrameElement);
|
|
@@ -7120,18 +7235,18 @@ declare class HostEventClient {
|
|
|
7120
7235
|
* @param {any} data Data to send with the host event
|
|
7121
7236
|
* @returns {Promise<any>} - the response from the process trigger
|
|
7122
7237
|
*/
|
|
7123
|
-
protected processTrigger(message: HostEvent, data: any): Promise<any>;
|
|
7124
|
-
handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT
|
|
7125
|
-
hostEventFallback(hostEvent: HostEvent, data: any): Promise<any>;
|
|
7238
|
+
protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
|
|
7239
|
+
handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
|
|
7240
|
+
hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
|
|
7126
7241
|
/**
|
|
7127
7242
|
* Setter for the iframe element used for host events
|
|
7128
7243
|
* @param {HTMLIFrameElement} iFrame - the iframe element to set
|
|
7129
7244
|
*/
|
|
7130
7245
|
setIframeElement(iFrame: HTMLIFrameElement): void;
|
|
7131
|
-
triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT
|
|
7132
|
-
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin
|
|
7133
|
-
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer
|
|
7134
|
-
triggerHostEvent<HostEventT extends HostEvent, PayloadT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT
|
|
7246
|
+
triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
|
|
7247
|
+
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
7248
|
+
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
7249
|
+
triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
|
|
7135
7250
|
}
|
|
7136
7251
|
declare class TsEmbed {
|
|
7137
7252
|
/**
|
|
@@ -7299,7 +7414,7 @@ declare class TsEmbed {
|
|
|
7299
7414
|
* @param query
|
|
7300
7415
|
*/
|
|
7301
7416
|
protected getEmbedBasePath(query: string): string;
|
|
7302
|
-
protected getUpdateEmbedParamsObject(): Record<any, any
|
|
7417
|
+
protected getUpdateEmbedParamsObject(): Promise<Record<any, any>>;
|
|
7303
7418
|
/**
|
|
7304
7419
|
* Common query params set for all the embed modes.
|
|
7305
7420
|
* @param queryParams
|
|
@@ -7453,7 +7568,7 @@ declare class TsEmbed {
|
|
|
7453
7568
|
* @param {any} data The payload to send with the message
|
|
7454
7569
|
* @returns A promise that resolves with the response from the embedded app
|
|
7455
7570
|
*/
|
|
7456
|
-
trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT
|
|
7571
|
+
trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
|
|
7457
7572
|
/**
|
|
7458
7573
|
* Triggers an event to the embedded app, skipping the UI flow.
|
|
7459
7574
|
* @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
|
|
@@ -7471,6 +7586,12 @@ declare class TsEmbed {
|
|
|
7471
7586
|
render(): Promise<TsEmbed>;
|
|
7472
7587
|
getIframeSrc(): string;
|
|
7473
7588
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
7589
|
+
/**
|
|
7590
|
+
* Get the current context of the embedded TS component.
|
|
7591
|
+
* @returns The current context object containing the page type and object ids.
|
|
7592
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7593
|
+
*/
|
|
7594
|
+
getCurrentContext(): Promise<any>;
|
|
7474
7595
|
/**
|
|
7475
7596
|
* Creates the preRender shell
|
|
7476
7597
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
@@ -7896,6 +8017,12 @@ declare class SearchEmbed extends TsEmbed {
|
|
|
7896
8017
|
* Render the embedded ThoughtSpot search
|
|
7897
8018
|
*/
|
|
7898
8019
|
render(): Promise<SearchEmbed>;
|
|
8020
|
+
/**
|
|
8021
|
+
* Get the current context of the embedded search.
|
|
8022
|
+
* @returns The current context object containing the page type and object ids.
|
|
8023
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8024
|
+
*/
|
|
8025
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
7899
8026
|
}
|
|
7900
8027
|
/**
|
|
7901
8028
|
* @group Embed components
|
|
@@ -8014,6 +8141,12 @@ declare class SearchBarEmbed extends TsEmbed {
|
|
|
8014
8141
|
searchOptions: SearchOptions;
|
|
8015
8142
|
};
|
|
8016
8143
|
protected getAppInitData(): Promise<SearchAppInitData$1>;
|
|
8144
|
+
/**
|
|
8145
|
+
* Get the current context of the embedded search bar.
|
|
8146
|
+
* @returns The current context object containing the page type and object ids.
|
|
8147
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8148
|
+
*/
|
|
8149
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
8017
8150
|
}
|
|
8018
8151
|
interface SearchOptions$1 {
|
|
8019
8152
|
/**
|
|
@@ -8158,6 +8291,12 @@ declare class SageEmbed extends V1Embed {
|
|
|
8158
8291
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
8159
8292
|
*/
|
|
8160
8293
|
render(): Promise<SageEmbed>;
|
|
8294
|
+
/**
|
|
8295
|
+
* Get the current context of the embedded SageEmbed.
|
|
8296
|
+
* @returns The current context object containing the page type and object ids.
|
|
8297
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8298
|
+
*/
|
|
8299
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
8161
8300
|
}
|
|
8162
8301
|
/**
|
|
8163
8302
|
* Pages within the ThoughtSpot app that can be embedded.
|
|
@@ -8291,14 +8430,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8291
8430
|
*/
|
|
8292
8431
|
showPrimaryNavbar?: boolean;
|
|
8293
8432
|
/**
|
|
8294
|
-
* Control the visibility of the left navigation
|
|
8295
|
-
*
|
|
8296
|
-
*
|
|
8297
|
-
*
|
|
8433
|
+
* Control the visibility of the left navigation panel on the home page
|
|
8434
|
+
* in the V2 and V3 navigation and home page experience.
|
|
8435
|
+
* If `showPrimaryNavbar` is true, that is, if the Global and Homepage
|
|
8436
|
+
* navigation bars are visible, this flag will only hide the left navigation bar
|
|
8437
|
+
* on the home page.
|
|
8438
|
+
* The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
|
|
8298
8439
|
*
|
|
8299
|
-
* **Note**: This
|
|
8300
|
-
* To access the updated modular homepage, set
|
|
8301
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
8440
|
+
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8302
8441
|
*
|
|
8303
8442
|
* Supported embed types: `AppEmbed`
|
|
8304
8443
|
* @default false
|
|
@@ -8313,8 +8452,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8313
8452
|
*/
|
|
8314
8453
|
hideHomepageLeftNav?: boolean;
|
|
8315
8454
|
/**
|
|
8316
|
-
* Control the visibility of the help (?) and profile
|
|
8317
|
-
*
|
|
8455
|
+
* Control the visibility of the help (?) and profile
|
|
8456
|
+
* buttons on the top navigation bar.
|
|
8457
|
+
* These buttons are visible if the
|
|
8458
|
+
* navigation bar is not hidden via `showPrimaryNavbar`.
|
|
8318
8459
|
*
|
|
8319
8460
|
* Supported embed types: `AppEmbed`
|
|
8320
8461
|
* @default false
|
|
@@ -8331,7 +8472,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8331
8472
|
/**
|
|
8332
8473
|
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
8333
8474
|
* @default true
|
|
8334
|
-
* Whether the help menu in the top
|
|
8475
|
+
* Whether the help menu in the top navigation bar should be served
|
|
8335
8476
|
* from Pendo or ThoughtSpot's internal help items.
|
|
8336
8477
|
*
|
|
8337
8478
|
* Supported embed types: `AppEmbed`
|
|
@@ -8345,8 +8486,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8345
8486
|
*/
|
|
8346
8487
|
enablePendoHelp?: boolean;
|
|
8347
8488
|
/**
|
|
8348
|
-
* Control the visibility of the hamburger icon on
|
|
8349
|
-
*
|
|
8489
|
+
* Control the visibility of the hamburger icon on
|
|
8490
|
+
* the top navigation bar in the V3 navigation experience.
|
|
8350
8491
|
*
|
|
8351
8492
|
* Supported embed types: `AppEmbed`
|
|
8352
8493
|
* @default false
|
|
@@ -8361,8 +8502,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8361
8502
|
*/
|
|
8362
8503
|
hideHamburger?: boolean;
|
|
8363
8504
|
/**
|
|
8364
|
-
* Control the visibility of the
|
|
8365
|
-
*
|
|
8505
|
+
* Control the visibility of the object search
|
|
8506
|
+
* on the top navigation bar in the
|
|
8507
|
+
* V2 and V3 navigation experience.
|
|
8508
|
+
*
|
|
8509
|
+
* **Note**: This attribute is not supported
|
|
8510
|
+
* in the classic (V1) experience.
|
|
8366
8511
|
*
|
|
8367
8512
|
* Supported embed types: `AppEmbed`
|
|
8368
8513
|
* @default true
|
|
@@ -8377,8 +8522,11 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8377
8522
|
*/
|
|
8378
8523
|
hideObjectSearch?: boolean;
|
|
8379
8524
|
/**
|
|
8380
|
-
* Control the visibility of the notification
|
|
8381
|
-
*
|
|
8525
|
+
* Control the visibility of the notification icon
|
|
8526
|
+
* on the top navigation bar in V3 navigation experience.
|
|
8527
|
+
*
|
|
8528
|
+
* **Note**: This attribute is not supported
|
|
8529
|
+
* in the classic (V1) and V2 experience modes.
|
|
8382
8530
|
*
|
|
8383
8531
|
* Supported embed types: `AppEmbed`
|
|
8384
8532
|
* @default true
|
|
@@ -8393,12 +8541,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8393
8541
|
*/
|
|
8394
8542
|
hideNotification?: boolean;
|
|
8395
8543
|
/**
|
|
8396
|
-
* Control the visibility of the application
|
|
8397
|
-
*
|
|
8544
|
+
* Control the visibility of the application selection menu
|
|
8545
|
+
* in the top navigation bar in the V2 experience.
|
|
8546
|
+
* In the V3 experience, it shows or hides application selection
|
|
8547
|
+
* icons on the left navigation panel.
|
|
8548
|
+
* By default, the application selection menu and icons are
|
|
8549
|
+
* shown in the UI
|
|
8398
8550
|
*
|
|
8399
|
-
* **Note**: This
|
|
8400
|
-
* To access the updated modular homepage, set
|
|
8401
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
8551
|
+
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8402
8552
|
*
|
|
8403
8553
|
* Supported embed types: `AppEmbed`
|
|
8404
8554
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -8416,9 +8566,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8416
8566
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
8417
8567
|
* By default, the Org switcher button is shown.
|
|
8418
8568
|
*
|
|
8419
|
-
* **Note**: This
|
|
8420
|
-
* To access the updated modular homepage, set
|
|
8421
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
8569
|
+
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8422
8570
|
*
|
|
8423
8571
|
* Supported embed types: `AppEmbed`
|
|
8424
8572
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -8571,8 +8719,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8571
8719
|
*/
|
|
8572
8720
|
fullHeight?: boolean;
|
|
8573
8721
|
/**
|
|
8574
|
-
*
|
|
8575
|
-
*
|
|
8722
|
+
* Enables the V2 navigation and modular home page experience.
|
|
8723
|
+
* For more information,
|
|
8724
|
+
* see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
8576
8725
|
* Supported embed types: `AppEmbed`
|
|
8577
8726
|
* @default false
|
|
8578
8727
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -8586,18 +8735,20 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8586
8735
|
*/
|
|
8587
8736
|
modularHomeExperience?: boolean;
|
|
8588
8737
|
/**
|
|
8589
|
-
*
|
|
8590
|
-
*
|
|
8738
|
+
* Configures the V3 navigation and home page experience.
|
|
8739
|
+
* For more information, see
|
|
8740
|
+
* link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
8591
8741
|
* Supported embed types: `AppEmbed`
|
|
8592
8742
|
* @default false
|
|
8593
8743
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
8594
8744
|
* @example
|
|
8595
8745
|
* ```js
|
|
8596
8746
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
8597
|
-
*
|
|
8747
|
+
* // Enable V3 navigation and home page experience
|
|
8598
8748
|
* discoveryExperience : {
|
|
8599
|
-
* primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
|
|
8600
|
-
* homePage: HomePage.
|
|
8749
|
+
* primaryNavbarVersion: PrimaryNavbarVersion.Sliding, // Enable V3 navigation
|
|
8750
|
+
* homePage: HomePage.ModularWithStylingChanges, // Enable V3 modular home page
|
|
8751
|
+
* ... // other embed view config
|
|
8601
8752
|
* },
|
|
8602
8753
|
* })
|
|
8603
8754
|
* ```
|
|
@@ -8745,7 +8896,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8745
8896
|
* Setting this height helps resolve issues with empty Apps and
|
|
8746
8897
|
* other screens navigable from an App.
|
|
8747
8898
|
*
|
|
8748
|
-
* @version SDK: 1.44.2 | ThoughtSpot:
|
|
8899
|
+
* @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
|
|
8749
8900
|
* @default 500
|
|
8750
8901
|
* @example
|
|
8751
8902
|
* ```js
|
|
@@ -8879,7 +9030,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8879
9030
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
8880
9031
|
* other screens navigable from a Liveboard.
|
|
8881
9032
|
*
|
|
8882
|
-
* @version SDK: 1.44.2 | ThoughtSpot:
|
|
9033
|
+
* @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
|
|
8883
9034
|
* @default 500
|
|
8884
9035
|
* @example
|
|
8885
9036
|
* ```js
|
|
@@ -9278,7 +9429,7 @@ declare class LiveboardEmbed extends V1Embed {
|
|
|
9278
9429
|
* @param {any} data The payload to send with the message
|
|
9279
9430
|
* @returns A promise that resolves with the response from the embedded app
|
|
9280
9431
|
*/
|
|
9281
|
-
trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT
|
|
9432
|
+
trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
|
|
9282
9433
|
/**
|
|
9283
9434
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
9284
9435
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
@@ -9300,6 +9451,12 @@ declare class LiveboardEmbed extends V1Embed {
|
|
|
9300
9451
|
* @returns url string
|
|
9301
9452
|
*/
|
|
9302
9453
|
getLiveboardUrl(): string;
|
|
9454
|
+
/**
|
|
9455
|
+
* Get the current context of the embedded liveboard.
|
|
9456
|
+
* @returns The current context object containing the page type and object ids.
|
|
9457
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9458
|
+
*/
|
|
9459
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
9303
9460
|
}
|
|
9304
9461
|
/**
|
|
9305
9462
|
* @hidden
|
|
@@ -9542,6 +9699,12 @@ declare class SpotterEmbed extends TsEmbed {
|
|
|
9542
9699
|
protected getEmbedParamsObject(): Record<any, any>;
|
|
9543
9700
|
getIframeSrc(): string;
|
|
9544
9701
|
render(): Promise<SpotterEmbed>;
|
|
9702
|
+
/**
|
|
9703
|
+
* Get the current context of the embedded SpotterEmbed.
|
|
9704
|
+
* @returns The current context object containing the page type and object ids.
|
|
9705
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9706
|
+
*/
|
|
9707
|
+
getCurrentContext(): Promise<PageContextOptions>;
|
|
9545
9708
|
}
|
|
9546
9709
|
declare class ConversationEmbed extends SpotterEmbed {
|
|
9547
9710
|
protected viewConfig: ConversationViewConfig;
|
|
@@ -9580,7 +9743,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
|
|
|
9580
9743
|
* @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
|
|
9581
9744
|
* @group Authentication / Init
|
|
9582
9745
|
*/
|
|
9583
|
-
export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter;
|
|
9746
|
+
export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter | null;
|
|
9584
9747
|
/**
|
|
9585
9748
|
* Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
|
|
9586
9749
|
* prevent the SDK from automatically logging in again.
|