@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
|
@@ -785,6 +785,42 @@ export interface CustomCssVariables {
|
|
|
785
785
|
* Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar.
|
|
786
786
|
*/
|
|
787
787
|
"--ts-var-saved-chats-section-title-color"?: string;
|
|
788
|
+
/**
|
|
789
|
+
* Text color of the styling panel in the Liveboard.
|
|
790
|
+
*/
|
|
791
|
+
"--ts-var-liveboard-styling-panel-text-color"?: string;
|
|
792
|
+
/**
|
|
793
|
+
* Border color of the styling panel in the Liveboard.
|
|
794
|
+
*/
|
|
795
|
+
"--ts-var-liveboard-styling-panel-border-color"?: string;
|
|
796
|
+
/**
|
|
797
|
+
* Background color of the styling button in the Liveboard.
|
|
798
|
+
*/
|
|
799
|
+
"--ts-var-liveboard-styling-button-background"?: string;
|
|
800
|
+
/**
|
|
801
|
+
* Text color of the styling button in the Liveboard.
|
|
802
|
+
*/
|
|
803
|
+
"--ts-var-liveboard-styling-button-text-color"?: string;
|
|
804
|
+
/**
|
|
805
|
+
* Background color of the styling button in the Liveboard on hover.
|
|
806
|
+
*/
|
|
807
|
+
"--ts-var-liveboard-styling-button-hover-background"?: string;
|
|
808
|
+
/**
|
|
809
|
+
* Background color of the styling button in the Liveboard when active.
|
|
810
|
+
*/
|
|
811
|
+
"--ts-var-liveboard-styling-button-active-background"?: string;
|
|
812
|
+
/**
|
|
813
|
+
* Text color of the styling button in the Liveboard on hover.
|
|
814
|
+
*/
|
|
815
|
+
"--ts-var-liveboard-styling-button-hover-text-color"?: string;
|
|
816
|
+
/**
|
|
817
|
+
* Box shadow of the styling button in the Liveboard.
|
|
818
|
+
*/
|
|
819
|
+
"--ts-var-liveboard-styling-button-shadow"?: string;
|
|
820
|
+
/**
|
|
821
|
+
* Background color of the color palette in the Liveboard styling panel.
|
|
822
|
+
*/
|
|
823
|
+
"--ts-var-liveboard-styling-color-palette-background"?: string;
|
|
788
824
|
}
|
|
789
825
|
export interface SessionInterface {
|
|
790
826
|
sessionId: string;
|
|
@@ -1402,11 +1438,6 @@ export interface EmbedConfig {
|
|
|
1402
1438
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1403
1439
|
*/
|
|
1404
1440
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1405
|
-
/**
|
|
1406
|
-
* Hide `beta` alert warning message for SageEmbed.
|
|
1407
|
-
*
|
|
1408
|
-
*/
|
|
1409
|
-
suppressSageEmbedBetaWarning?: boolean;
|
|
1410
1441
|
/**
|
|
1411
1442
|
* Custom style params for embed Config.
|
|
1412
1443
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
@@ -1488,6 +1519,7 @@ export interface EmbedConfig {
|
|
|
1488
1519
|
/**
|
|
1489
1520
|
* Disables the Mixpanel tracking from the SDK.
|
|
1490
1521
|
* @version SDK: 1.27.9
|
|
1522
|
+
* @hidden
|
|
1491
1523
|
*/
|
|
1492
1524
|
disableSDKTracking?: boolean;
|
|
1493
1525
|
/**
|
|
@@ -1790,7 +1822,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1790
1822
|
* The width and height dimensions to render an embedded
|
|
1791
1823
|
* object inside your app. Specify the values in pixels or percentage.
|
|
1792
1824
|
*
|
|
1793
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1825
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1794
1826
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1795
1827
|
* @example
|
|
1796
1828
|
* ```js
|
|
@@ -1819,7 +1851,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1819
1851
|
* for the user.
|
|
1820
1852
|
* Use this to disable actions.
|
|
1821
1853
|
*
|
|
1822
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1854
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1823
1855
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1824
1856
|
* @example
|
|
1825
1857
|
* ```js
|
|
@@ -1834,7 +1866,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1834
1866
|
/**
|
|
1835
1867
|
* The tooltip to display for disabled actions.
|
|
1836
1868
|
*
|
|
1837
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1869
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1838
1870
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1839
1871
|
* @example
|
|
1840
1872
|
* ```js
|
|
@@ -1852,7 +1884,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1852
1884
|
* These actions will be hidden from the user.
|
|
1853
1885
|
* Use this to hide an action.
|
|
1854
1886
|
*
|
|
1855
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1887
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1856
1888
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1857
1889
|
* @example
|
|
1858
1890
|
* ```js
|
|
@@ -1873,7 +1905,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1873
1905
|
*
|
|
1874
1906
|
* Use either this or hiddenActions.
|
|
1875
1907
|
*
|
|
1876
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1908
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1877
1909
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1878
1910
|
* @important
|
|
1879
1911
|
* @example
|
|
@@ -1889,7 +1921,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1889
1921
|
/**
|
|
1890
1922
|
* The locale settings to apply to the embedded view.
|
|
1891
1923
|
*
|
|
1892
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1924
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1893
1925
|
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1894
1926
|
* @example
|
|
1895
1927
|
* ```js
|
|
@@ -1910,7 +1942,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1910
1942
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1911
1943
|
* list of supported keys and values associated with each.
|
|
1912
1944
|
*
|
|
1913
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1945
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1914
1946
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1915
1947
|
* @example
|
|
1916
1948
|
* ```js
|
|
@@ -1938,7 +1970,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1938
1970
|
* Insert as a sibling of the target container, instead of appending to a
|
|
1939
1971
|
* child inside it.
|
|
1940
1972
|
*
|
|
1941
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1973
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1942
1974
|
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
1943
1975
|
* @example
|
|
1944
1976
|
* ```js
|
|
@@ -1964,7 +1996,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1964
1996
|
* Use PreRender to render the embed in the background and then
|
|
1965
1997
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1966
1998
|
*
|
|
1967
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1999
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1968
2000
|
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1969
2001
|
* @example
|
|
1970
2002
|
* ```js
|
|
@@ -2001,7 +2033,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2001
2033
|
* Enable the V2 shell. This can provide performance benefits
|
|
2002
2034
|
* due to a lighter-weight shell.
|
|
2003
2035
|
*
|
|
2004
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2036
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2005
2037
|
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2006
2038
|
* @example
|
|
2007
2039
|
* ```js
|
|
@@ -2028,7 +2060,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2028
2060
|
* This flag can be used to disable links inside the embedded app,
|
|
2029
2061
|
* and disable redirection of links in a new tab.
|
|
2030
2062
|
*
|
|
2031
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2063
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2032
2064
|
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
2033
2065
|
* @example
|
|
2034
2066
|
* ```js
|
|
@@ -2047,7 +2079,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2047
2079
|
* The `overrideOrgId` setting is honoured only if the
|
|
2048
2080
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
2049
2081
|
*
|
|
2050
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2082
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2051
2083
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2052
2084
|
* @example
|
|
2053
2085
|
* ```js
|
|
@@ -2067,7 +2099,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2067
2099
|
* {@link enableLinkOverridesV2} instead.
|
|
2068
2100
|
*
|
|
2069
2101
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2070
|
-
* `
|
|
2102
|
+
* `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2071
2103
|
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2072
2104
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2073
2105
|
* @example
|
|
@@ -2091,7 +2123,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2091
2123
|
* older ThoughtSpot versions.
|
|
2092
2124
|
*
|
|
2093
2125
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2094
|
-
* `
|
|
2126
|
+
* `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2095
2127
|
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2096
2128
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
2097
2129
|
* @example
|
|
@@ -2150,7 +2182,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2150
2182
|
* external app, calling an API, or opening a modal — based on the data context of
|
|
2151
2183
|
* what they clicked can be used to trigger custom logic when the action is clicked.
|
|
2152
2184
|
*
|
|
2153
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2185
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterEmbed`
|
|
2154
2186
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
|
|
2155
2187
|
* @example
|
|
2156
2188
|
* ```ts
|
|
@@ -2502,11 +2534,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2502
2534
|
/**
|
|
2503
2535
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2504
2536
|
*
|
|
2505
|
-
* Supported embed types: `AppEmbed`, `
|
|
2537
|
+
* Supported embed types: `AppEmbed`, `SearchEmbed`
|
|
2506
2538
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2507
2539
|
* @example
|
|
2508
2540
|
* ```js
|
|
2509
|
-
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed,
|
|
2541
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchEmbed
|
|
2510
2542
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2511
2543
|
* ... // other embed view config
|
|
2512
2544
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
@@ -2543,12 +2575,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2543
2575
|
/**
|
|
2544
2576
|
* To set the initial state of the search bar in case of saved Answers.
|
|
2545
2577
|
*
|
|
2546
|
-
* Supported embed types: `
|
|
2578
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`
|
|
2547
2579
|
* @default true
|
|
2548
2580
|
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
2549
2581
|
* @example
|
|
2550
2582
|
* ```js
|
|
2551
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
2583
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
2552
2584
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2553
2585
|
* ... // other embed view config
|
|
2554
2586
|
* collapseSearchBar: true,
|
|
@@ -2559,12 +2591,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2559
2591
|
/**
|
|
2560
2592
|
* Flag to control Data panel experience
|
|
2561
2593
|
*
|
|
2562
|
-
* Supported embed types: `
|
|
2594
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2563
2595
|
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2564
2596
|
* @default true
|
|
2565
2597
|
* @example
|
|
2566
2598
|
* ```js
|
|
2567
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
2599
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
2568
2600
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2569
2601
|
* ... // other embed view config
|
|
2570
2602
|
* dataPanelV2: true,
|
|
@@ -2575,12 +2607,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2575
2607
|
/**
|
|
2576
2608
|
* To enable custom column groups in data panel v2
|
|
2577
2609
|
*
|
|
2578
|
-
* Supported embed types: `
|
|
2610
|
+
* Supported embed types: `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2579
2611
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
2580
2612
|
* @default false
|
|
2581
2613
|
* @example
|
|
2582
2614
|
* ```js
|
|
2583
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
2615
|
+
* // Replace <EmbedComponent> with embed component name. For example, SearchBarEmbed, or LiveboardEmbed
|
|
2584
2616
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2585
2617
|
* ... // other embed view config
|
|
2586
2618
|
* enableCustomColumnGroups: true,
|
|
@@ -3573,6 +3605,17 @@ export declare enum EmbedEvent {
|
|
|
3573
3605
|
* ```
|
|
3574
3606
|
*/
|
|
3575
3607
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3608
|
+
/**
|
|
3609
|
+
* Emitted when the Download Liveboard as Continuous PDF action is triggered
|
|
3610
|
+
* on a Liveboard.
|
|
3611
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
3612
|
+
* @example
|
|
3613
|
+
* ```js
|
|
3614
|
+
* liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
|
|
3615
|
+
* console.log('download liveboard as continuous PDF', payload)})
|
|
3616
|
+
* ```
|
|
3617
|
+
*/
|
|
3618
|
+
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
3576
3619
|
/**
|
|
3577
3620
|
* Emitted when an Answer is deleted in the app
|
|
3578
3621
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
@@ -3950,19 +3993,6 @@ export declare enum EmbedEvent {
|
|
|
3950
3993
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3951
3994
|
*/
|
|
3952
3995
|
FilterChanged = "filterChanged",
|
|
3953
|
-
/**
|
|
3954
|
-
* Emitted when a user clicks the **Go** button to initiate
|
|
3955
|
-
* a Natural Language Search query
|
|
3956
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3957
|
-
*/
|
|
3958
|
-
SageEmbedQuery = "sageEmbedQuery",
|
|
3959
|
-
/**
|
|
3960
|
-
* Emitted when a user selects a data source on the embedded
|
|
3961
|
-
* Natural Language Search interface.
|
|
3962
|
-
*
|
|
3963
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3964
|
-
*/
|
|
3965
|
-
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3966
3996
|
/**
|
|
3967
3997
|
* Emitted when a user updates a connection on the **Data** page
|
|
3968
3998
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
@@ -5100,6 +5130,18 @@ export declare enum HostEvent {
|
|
|
5100
5130
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5101
5131
|
*/
|
|
5102
5132
|
DownloadAsPdf = "downloadAsPdf",
|
|
5133
|
+
/**
|
|
5134
|
+
* Trigger the **Download Liveboard as Continuous PDF** action on an
|
|
5135
|
+
* embedded Liveboard.
|
|
5136
|
+
*
|
|
5137
|
+
* @example
|
|
5138
|
+
* ```js
|
|
5139
|
+
* liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
|
|
5140
|
+
* ```
|
|
5141
|
+
*
|
|
5142
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5143
|
+
*/
|
|
5144
|
+
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
5103
5145
|
/**
|
|
5104
5146
|
* Trigger the **AI Highlights** action on an embedded Liveboard
|
|
5105
5147
|
*
|
|
@@ -5326,6 +5368,20 @@ export declare enum HostEvent {
|
|
|
5326
5368
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
5327
5369
|
* }, ContextType.Liveboard);
|
|
5328
5370
|
* ```
|
|
5371
|
+
* @example
|
|
5372
|
+
* ```js
|
|
5373
|
+
* // Copy link from liveboard context
|
|
5374
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5375
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
|
|
5376
|
+
* ```
|
|
5377
|
+
* @example
|
|
5378
|
+
* ```js
|
|
5379
|
+
* // Copy link from liveboard visualization context
|
|
5380
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5381
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {
|
|
5382
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
5383
|
+
* }, ContextType.Liveboard);
|
|
5384
|
+
* ```
|
|
5329
5385
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5330
5386
|
*/
|
|
5331
5387
|
CopyLink = "embedDocument",
|
|
@@ -5357,6 +5413,20 @@ export declare enum HostEvent {
|
|
|
5357
5413
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5358
5414
|
* liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
|
|
5359
5415
|
* ```
|
|
5416
|
+
* @example
|
|
5417
|
+
* ```js
|
|
5418
|
+
* // Present from liveboard visualization context
|
|
5419
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5420
|
+
* liveboardEmbed.trigger(HostEvent.Present, {
|
|
5421
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
5422
|
+
* }, ContextType.Liveboard);
|
|
5423
|
+
* ```
|
|
5424
|
+
* @example
|
|
5425
|
+
* ```js
|
|
5426
|
+
* // Present from liveboard context
|
|
5427
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5428
|
+
* liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
|
|
5429
|
+
* ```
|
|
5360
5430
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5361
5431
|
*/
|
|
5362
5432
|
Present = "present",
|
|
@@ -5385,7 +5455,7 @@ export declare enum HostEvent {
|
|
|
5385
5455
|
* tml.answer.search_query // TML representation of the search query
|
|
5386
5456
|
* );
|
|
5387
5457
|
* })
|
|
5388
|
-
|
|
5458
|
+
* ```
|
|
5389
5459
|
* @example
|
|
5390
5460
|
* ```js
|
|
5391
5461
|
* // Get TML from search context
|
|
@@ -6008,21 +6078,6 @@ export declare enum HostEvent {
|
|
|
6008
6078
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
6009
6079
|
*/
|
|
6010
6080
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
6011
|
-
/**
|
|
6012
|
-
* Updates the search query string for Natural Language Search operations.
|
|
6013
|
-
* @param - Includes the following keys:
|
|
6014
|
-
* - `queryString`: Text string in Natural Language format.
|
|
6015
|
-
* - `executeSearch`: Boolean to execute search and update search query.
|
|
6016
|
-
* @example
|
|
6017
|
-
* ```js
|
|
6018
|
-
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
6019
|
-
* queryString: 'revenue per year',
|
|
6020
|
-
* executeSearch: true,
|
|
6021
|
-
* })
|
|
6022
|
-
* ```
|
|
6023
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
6024
|
-
*/
|
|
6025
|
-
UpdateSageQuery = "updateSageQuery",
|
|
6026
6081
|
/**
|
|
6027
6082
|
* Get the Answer session for a Search or
|
|
6028
6083
|
* Liveboard visualization.
|
|
@@ -6824,6 +6879,16 @@ export declare enum Action {
|
|
|
6824
6879
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
6825
6880
|
*/
|
|
6826
6881
|
DownloadLiveboard = "downloadLiveboard",
|
|
6882
|
+
/**
|
|
6883
|
+
* The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
|
|
6884
|
+
* Allows downloading the entire Liveboard as a continuous PDF.
|
|
6885
|
+
* @example
|
|
6886
|
+
* ```js
|
|
6887
|
+
* disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
|
|
6888
|
+
* ```
|
|
6889
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
6890
|
+
*/
|
|
6891
|
+
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
6827
6892
|
/**
|
|
6828
6893
|
* @hidden
|
|
6829
6894
|
*/
|
|
@@ -7780,11 +7845,11 @@ export declare enum Action {
|
|
|
7780
7845
|
*/
|
|
7781
7846
|
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
7782
7847
|
/**
|
|
7783
|
-
|
|
7784
|
-
|
|
7785
|
-
|
|
7786
|
-
|
|
7787
|
-
|
|
7848
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
7849
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
7850
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
7851
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
7852
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
7788
7853
|
* @example
|
|
7789
7854
|
* ```js
|
|
7790
7855
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -7861,17 +7926,17 @@ export declare enum Action {
|
|
|
7861
7926
|
*/
|
|
7862
7927
|
LiveboardStylePanel = "liveboardStylePanel",
|
|
7863
7928
|
/**
|
|
7864
|
-
|
|
7865
|
-
|
|
7866
|
-
|
|
7867
|
-
|
|
7868
|
-
|
|
7869
|
-
|
|
7870
|
-
|
|
7871
|
-
|
|
7872
|
-
|
|
7873
|
-
|
|
7874
|
-
|
|
7929
|
+
* The **Publish** action for Liveboards, Answers and Models.
|
|
7930
|
+
* Opens the publishing modal. It's a parent action for the
|
|
7931
|
+
* **Manage Publishing** and **Unpublish** actions if the object
|
|
7932
|
+
* is already published, otherwise appears standalone.
|
|
7933
|
+
* @example
|
|
7934
|
+
* ```js
|
|
7935
|
+
* hiddenActions: [Action.Publish]
|
|
7936
|
+
* disabledActions: [Action.Publish]
|
|
7937
|
+
* ```
|
|
7938
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7939
|
+
*/
|
|
7875
7940
|
Publish = "publish",
|
|
7876
7941
|
/**
|
|
7877
7942
|
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
@@ -8039,6 +8104,39 @@ export declare enum Action {
|
|
|
8039
8104
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8040
8105
|
*/
|
|
8041
8106
|
SpotterDocs = "spotterDocs",
|
|
8107
|
+
/**
|
|
8108
|
+
* Controls visibility and disable state of the connector resources
|
|
8109
|
+
* section in the Spotter chat interface.
|
|
8110
|
+
* @example
|
|
8111
|
+
* ```js
|
|
8112
|
+
* hiddenActions: [Action.SpotterChatConnectorResources]
|
|
8113
|
+
* disabledActions: [Action.SpotterChatConnectorResources]
|
|
8114
|
+
* ```
|
|
8115
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
8116
|
+
*/
|
|
8117
|
+
SpotterChatConnectorResources = "spotterChatConnectorResources",
|
|
8118
|
+
/**
|
|
8119
|
+
* Controls visibility and disable state of the connectors
|
|
8120
|
+
* in the Spotter chat interface.
|
|
8121
|
+
* @example
|
|
8122
|
+
* ```js
|
|
8123
|
+
* hiddenActions: [Action.SpotterChatConnectors]
|
|
8124
|
+
* disabledActions: [Action.SpotterChatConnectors]
|
|
8125
|
+
* ```
|
|
8126
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
8127
|
+
*/
|
|
8128
|
+
SpotterChatConnectors = "spotterChatConnectors",
|
|
8129
|
+
/**
|
|
8130
|
+
* Controls visibility and disable state of the mode switcher
|
|
8131
|
+
* in the Spotter chat interface.
|
|
8132
|
+
* @example
|
|
8133
|
+
* ```js
|
|
8134
|
+
* hiddenActions: [Action.SpotterChatModeSwitcher]
|
|
8135
|
+
* disabledActions: [Action.SpotterChatModeSwitcher]
|
|
8136
|
+
* ```
|
|
8137
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
8138
|
+
*/
|
|
8139
|
+
SpotterChatModeSwitcher = "spotterChatModeSwitcher",
|
|
8042
8140
|
/**
|
|
8043
8141
|
* The **Include current period** checkbox for date filters.
|
|
8044
8142
|
* Controls the visibility and availability of the option to include
|
|
@@ -8283,7 +8381,13 @@ declare enum EmbedErrorCodes {
|
|
|
8283
8381
|
/** Failed to update embed parameters during pre-render */
|
|
8284
8382
|
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
|
|
8285
8383
|
/** Invalid URL provided in configuration */
|
|
8286
|
-
INVALID_URL = "INVALID_URL"
|
|
8384
|
+
INVALID_URL = "INVALID_URL",
|
|
8385
|
+
/** Host event payload validation failed */
|
|
8386
|
+
HOST_EVENT_VALIDATION = "HOST_EVENT_VALIDATION",
|
|
8387
|
+
/** UpdateFilters payload is invalid - missing or malformed filter/filters */
|
|
8388
|
+
UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
|
|
8389
|
+
/** DrillDown payload is invalid - missing or malformed points */
|
|
8390
|
+
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
|
|
8287
8391
|
}
|
|
8288
8392
|
/**
|
|
8289
8393
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -8656,6 +8760,8 @@ declare enum UIPassthroughEvent {
|
|
|
8656
8760
|
GetAnswerConfig = "getAnswerPageConfig",
|
|
8657
8761
|
GetLiveboardConfig = "getPinboardPageConfig",
|
|
8658
8762
|
GetUnsavedAnswerTML = "getUnsavedAnswerTML",
|
|
8763
|
+
UpdateFilters = "updateFilters",
|
|
8764
|
+
Drilldown = "drillDown",
|
|
8659
8765
|
GetAnswerSession = "getAnswerSession",
|
|
8660
8766
|
GetFilters = "getFilters",
|
|
8661
8767
|
GetIframeUrl = "getIframeUrl",
|
|
@@ -8777,6 +8883,35 @@ export type UIPassthroughContractBase = {
|
|
|
8777
8883
|
v2Content: string;
|
|
8778
8884
|
};
|
|
8779
8885
|
};
|
|
8886
|
+
[UIPassthroughEvent.UpdateFilters]: {
|
|
8887
|
+
request: {
|
|
8888
|
+
filter?: {
|
|
8889
|
+
column: string;
|
|
8890
|
+
oper: string;
|
|
8891
|
+
values: string[];
|
|
8892
|
+
type?: string;
|
|
8893
|
+
};
|
|
8894
|
+
filters?: {
|
|
8895
|
+
column: string;
|
|
8896
|
+
oper: string;
|
|
8897
|
+
values: string[];
|
|
8898
|
+
type?: string;
|
|
8899
|
+
}[];
|
|
8900
|
+
};
|
|
8901
|
+
response: unknown;
|
|
8902
|
+
};
|
|
8903
|
+
[UIPassthroughEvent.Drilldown]: {
|
|
8904
|
+
request: {
|
|
8905
|
+
points: {
|
|
8906
|
+
selectedPoints?: string[];
|
|
8907
|
+
clickedPoint?: string;
|
|
8908
|
+
};
|
|
8909
|
+
columnGuid?: string;
|
|
8910
|
+
autoDrillDown?: boolean;
|
|
8911
|
+
vizId?: string;
|
|
8912
|
+
};
|
|
8913
|
+
response: unknown;
|
|
8914
|
+
};
|
|
8780
8915
|
};
|
|
8781
8916
|
export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
|
|
8782
8917
|
export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
|
|
@@ -8802,6 +8937,8 @@ export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT |
|
|
|
8802
8937
|
export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
|
|
8803
8938
|
declare class HostEventClient {
|
|
8804
8939
|
iFrame: HTMLIFrameElement;
|
|
8940
|
+
/** Cached list of available UI passthrough keys from the embedded app */
|
|
8941
|
+
private availablePassthroughKeysCache;
|
|
8805
8942
|
/** Host events with custom handlers
|
|
8806
8943
|
* (setters or special logic) -
|
|
8807
8944
|
* bound to instance for protected method access */
|
|
@@ -8827,9 +8964,25 @@ declare class HostEventClient {
|
|
|
8827
8964
|
* @param {HTMLIFrameElement} iFrame - the iframe element to set
|
|
8828
8965
|
*/
|
|
8829
8966
|
setIframeElement(iFrame: HTMLIFrameElement): void;
|
|
8967
|
+
/**
|
|
8968
|
+
* Fetches the list of available UI passthrough keys from the embedded app.
|
|
8969
|
+
* Result is cached for the session. Returns empty array on failure.
|
|
8970
|
+
*/
|
|
8971
|
+
private getAvailableUIPassthroughKeys;
|
|
8830
8972
|
triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
|
|
8831
8973
|
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
8832
8974
|
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
8975
|
+
protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
|
|
8976
|
+
protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
|
|
8977
|
+
/**
|
|
8978
|
+
* Dispatches a host event using the appropriate channel:
|
|
8979
|
+
* 1. If the embedded app supports UI passthrough for this event, use it (custom handler or getter).
|
|
8980
|
+
* 2. Otherwise fall back to the legacy host event channel.
|
|
8981
|
+
*
|
|
8982
|
+
* @param hostEvent - The host event to trigger
|
|
8983
|
+
* @param payload - Optional payload for the event
|
|
8984
|
+
* @param context - Optional context (e.g. vizId) for scoped operations
|
|
8985
|
+
*/
|
|
8833
8986
|
triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
|
|
8834
8987
|
}
|
|
8835
8988
|
declare class TsEmbed {
|
|
@@ -9777,150 +9930,6 @@ declare class SearchBarEmbed extends TsEmbed {
|
|
|
9777
9930
|
protected getAppInitData(): Promise<SearchAppInitData$1>;
|
|
9778
9931
|
}
|
|
9779
9932
|
interface SearchOptions$1 {
|
|
9780
|
-
/**
|
|
9781
|
-
* The query string to pass for Natural Language Search.
|
|
9782
|
-
*/
|
|
9783
|
-
searchQuery: string;
|
|
9784
|
-
/**
|
|
9785
|
-
* Boolean to define if the search should be executed or not.
|
|
9786
|
-
* If it is executed, the focus is placed on the results.
|
|
9787
|
-
* If it’s not executed, the focus is placed at the end of
|
|
9788
|
-
* the token string in the search bar.
|
|
9789
|
-
*/
|
|
9790
|
-
executeSearch?: boolean;
|
|
9791
|
-
}
|
|
9792
|
-
/**
|
|
9793
|
-
* The configuration attributes for the embedded Natural language search view. Based on
|
|
9794
|
-
* GPT and LLM.
|
|
9795
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
9796
|
-
*
|
|
9797
|
-
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
9798
|
-
* @group Embed components
|
|
9799
|
-
*/
|
|
9800
|
-
export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, "primaryAction" | "runtimeFilters" | "runtimeParameters" | "excludeRuntimeFiltersfromURL" | "excludeRuntimeParametersfromURL"> {
|
|
9801
|
-
/**
|
|
9802
|
-
* If set to true, a list of Liveboard and Answers related
|
|
9803
|
-
* to the natural language search will be shown below the
|
|
9804
|
-
* AI generated answer.
|
|
9805
|
-
* @deprecated Currently Liveboard and Answers related
|
|
9806
|
-
* to the natural language search will not be shown for sage
|
|
9807
|
-
* embed
|
|
9808
|
-
*/
|
|
9809
|
-
showObjectResults?: boolean;
|
|
9810
|
-
/**
|
|
9811
|
-
* flag used by the TS product tour page to show the blue search bar
|
|
9812
|
-
* even after the search is completed. This is different from ThoughtSpot Embedded
|
|
9813
|
-
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
9814
|
-
* The Sample questions container is collapsed when this value is set after
|
|
9815
|
-
* does a search.
|
|
9816
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
|
|
9817
|
-
* @hidden
|
|
9818
|
-
*/
|
|
9819
|
-
isProductTour?: boolean;
|
|
9820
|
-
/**
|
|
9821
|
-
* Show or hide the search bar title.
|
|
9822
|
-
* @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
9823
|
-
* @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
9824
|
-
*/
|
|
9825
|
-
hideSearchBarTitle?: boolean;
|
|
9826
|
-
/**
|
|
9827
|
-
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
9828
|
-
* at the top of the Answer page.
|
|
9829
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl
|
|
9830
|
-
*/
|
|
9831
|
-
hideSageAnswerHeader?: boolean;
|
|
9832
|
-
/**
|
|
9833
|
-
* Disable the data source selection option.
|
|
9834
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
9835
|
-
*/
|
|
9836
|
-
disableWorksheetChange?: boolean;
|
|
9837
|
-
/**
|
|
9838
|
-
* Hide the data source selection panel.
|
|
9839
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
9840
|
-
*/
|
|
9841
|
-
hideWorksheetSelector?: boolean;
|
|
9842
|
-
/**
|
|
9843
|
-
* Show or hide autocomplete suggestions for the search query string.
|
|
9844
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
9845
|
-
*/
|
|
9846
|
-
hideAutocompleteSuggestions?: boolean;
|
|
9847
|
-
/**
|
|
9848
|
-
* Show or hide autocomplete suggestions for the search query string.
|
|
9849
|
-
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
9850
|
-
* @deprecated
|
|
9851
|
-
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
9852
|
-
*/
|
|
9853
|
-
showObjectSuggestions?: boolean;
|
|
9854
|
-
/**
|
|
9855
|
-
* Show or hide sample questions.
|
|
9856
|
-
* The sample questions are autogenerated based on the data model
|
|
9857
|
-
* selected for the search operation.
|
|
9858
|
-
*
|
|
9859
|
-
* Supported embed types: `SageEmbed`
|
|
9860
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
9861
|
-
* @example
|
|
9862
|
-
* ```js
|
|
9863
|
-
* const embed = new SageEmbed('#tsEmbed', {
|
|
9864
|
-
* ... //other embed view config
|
|
9865
|
-
* hideSampleQuestions : true,
|
|
9866
|
-
* })
|
|
9867
|
-
* ```
|
|
9868
|
-
*/
|
|
9869
|
-
hideSampleQuestions?: boolean;
|
|
9870
|
-
/**
|
|
9871
|
-
* The data source GUID (Model GUID) to set on load.
|
|
9872
|
-
*/
|
|
9873
|
-
dataSource?: string;
|
|
9874
|
-
/**
|
|
9875
|
-
* Includes the following properties:
|
|
9876
|
-
*
|
|
9877
|
-
* `searchQuery`: The search query string to pass in the search bar.
|
|
9878
|
-
* Supports Natural Language Search queries.
|
|
9879
|
-
*
|
|
9880
|
-
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
9881
|
-
* If it is executed, the focus is placed on the results.
|
|
9882
|
-
* If it’s not executed, the focus is placed at the end of
|
|
9883
|
-
* the token string in the search bar.
|
|
9884
|
-
*
|
|
9885
|
-
* Supported embed types: `SageEmbed`
|
|
9886
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
9887
|
-
* @example
|
|
9888
|
-
* ```js
|
|
9889
|
-
* searchOptions: {
|
|
9890
|
-
* searchQuery: 'average sales by country and product type',
|
|
9891
|
-
* executeSearch: true,
|
|
9892
|
-
* }
|
|
9893
|
-
* ```
|
|
9894
|
-
*/
|
|
9895
|
-
searchOptions?: SearchOptions$1;
|
|
9896
|
-
}
|
|
9897
|
-
declare class SageEmbed extends V1Embed {
|
|
9898
|
-
/**
|
|
9899
|
-
* The view configuration for the embedded ThoughtSpot sage.
|
|
9900
|
-
*
|
|
9901
|
-
*/
|
|
9902
|
-
protected viewConfig: SageViewConfig;
|
|
9903
|
-
constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
|
|
9904
|
-
protected getEmbedParamsObject(): Record<any, any>;
|
|
9905
|
-
/**
|
|
9906
|
-
* Constructs a map of parameters to be passed on to the
|
|
9907
|
-
* embedded Eureka or Sage search page.
|
|
9908
|
-
* @returns {string} query string
|
|
9909
|
-
*/
|
|
9910
|
-
protected getEmbedParams(): string;
|
|
9911
|
-
/**
|
|
9912
|
-
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
9913
|
-
* loaded in the iframe
|
|
9914
|
-
* @returns {string} iframe url
|
|
9915
|
-
*/
|
|
9916
|
-
getIFrameSrc(): string;
|
|
9917
|
-
/**
|
|
9918
|
-
* Render the embedded ThoughtSpot Sage
|
|
9919
|
-
* @returns {SageEmbed} Eureka/Sage embed
|
|
9920
|
-
*/
|
|
9921
|
-
render(): Promise<SageEmbed>;
|
|
9922
|
-
}
|
|
9923
|
-
interface SearchOptions$2 {
|
|
9924
9933
|
/**
|
|
9925
9934
|
* The query string to pass to start the Conversation.
|
|
9926
9935
|
*/
|
|
@@ -10037,7 +10046,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
10037
10046
|
/**
|
|
10038
10047
|
* Ability to pass a starting search query to the conversation.
|
|
10039
10048
|
*/
|
|
10040
|
-
searchOptions?: SearchOptions$
|
|
10049
|
+
searchOptions?: SearchOptions$1;
|
|
10041
10050
|
/**
|
|
10042
10051
|
* disableSourceSelection : Disables data source selection
|
|
10043
10052
|
* but still display the selected data source.
|
|
@@ -10075,7 +10084,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
10075
10084
|
* @default true
|
|
10076
10085
|
* @example
|
|
10077
10086
|
* ```js
|
|
10078
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
10087
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
10079
10088
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
10080
10089
|
* ... // other embed view config
|
|
10081
10090
|
* dataPanelV2: true,
|
|
@@ -10251,9 +10260,31 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
10251
10260
|
*/
|
|
10252
10261
|
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
10253
10262
|
}
|
|
10263
|
+
/**
|
|
10264
|
+
* APP_INIT data shape for SpotterEmbed.
|
|
10265
|
+
* @internal
|
|
10266
|
+
*/
|
|
10267
|
+
export interface SpotterAppInitData extends DefaultAppInitData {
|
|
10268
|
+
embedParams?: {
|
|
10269
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
10270
|
+
};
|
|
10271
|
+
}
|
|
10254
10272
|
declare class SpotterEmbed extends TsEmbed {
|
|
10255
10273
|
protected viewConfig: SpotterEmbedViewConfig;
|
|
10256
10274
|
constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
|
|
10275
|
+
/**
|
|
10276
|
+
* Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
|
|
10277
|
+
* so the conv-assist app can read sidebar configuration on initialisation.
|
|
10278
|
+
*
|
|
10279
|
+
* Precedence for `enablePastConversationsSidebar`:
|
|
10280
|
+
* `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
|
|
10281
|
+
* deprecated top-level `enablePastConversationsSidebar` flag; if the former
|
|
10282
|
+
* is absent the latter is used as a fallback.
|
|
10283
|
+
*
|
|
10284
|
+
* An invalid `spotterDocumentationUrl` triggers a validation error and is
|
|
10285
|
+
* excluded from the payload rather than forwarded to the app.
|
|
10286
|
+
*/
|
|
10287
|
+
protected getAppInitData(): Promise<SpotterAppInitData>;
|
|
10257
10288
|
protected getEmbedParamsObject(): Record<any, any>;
|
|
10258
10289
|
getIframeSrc(): string;
|
|
10259
10290
|
render(): Promise<SpotterEmbed>;
|
|
@@ -10749,21 +10780,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10749
10780
|
* @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
10750
10781
|
*/
|
|
10751
10782
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
10752
|
-
/**
|
|
10753
|
-
* This flag is used to enable unified search experience for full app embed.
|
|
10754
|
-
*
|
|
10755
|
-
* Supported embed types: `AppEmbed`
|
|
10756
|
-
* @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
|
|
10757
|
-
* @default true
|
|
10758
|
-
* @example
|
|
10759
|
-
* ```js
|
|
10760
|
-
* const embed = new AppEmbed('#tsEmbed', {
|
|
10761
|
-
* ... // other embed view config
|
|
10762
|
-
* isUnifiedSearchExperienceEnabled: true,
|
|
10763
|
-
* })
|
|
10764
|
-
* ```
|
|
10765
|
-
*/
|
|
10766
|
-
isUnifiedSearchExperienceEnabled?: boolean;
|
|
10767
10783
|
/**
|
|
10768
10784
|
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
10769
10785
|
* @deprecated This flag is deprecated.
|
|
@@ -10798,6 +10814,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10798
10814
|
* ```
|
|
10799
10815
|
*/
|
|
10800
10816
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
10817
|
+
/**
|
|
10818
|
+
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
10819
|
+
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
10820
|
+
* This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
|
|
10821
|
+
*
|
|
10822
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
10823
|
+
* @type {boolean}
|
|
10824
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
10825
|
+
* @example
|
|
10826
|
+
* ```js
|
|
10827
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
10828
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
10829
|
+
* ... // other embed view config
|
|
10830
|
+
* isContinuousLiveboardPDFEnabled: true,
|
|
10831
|
+
* })
|
|
10832
|
+
* ```
|
|
10833
|
+
*/
|
|
10834
|
+
isContinuousLiveboardPDFEnabled?: boolean;
|
|
10801
10835
|
/**
|
|
10802
10836
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
10803
10837
|
*
|
|
@@ -10966,10 +11000,32 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10966
11000
|
*/
|
|
10967
11001
|
enableHomepageAnnouncement?: boolean;
|
|
10968
11002
|
}
|
|
11003
|
+
/**
|
|
11004
|
+
* APP_INIT data shape for AppEmbed.
|
|
11005
|
+
* @internal
|
|
11006
|
+
*/
|
|
11007
|
+
export interface AppEmbedAppInitData extends DefaultAppInitData {
|
|
11008
|
+
embedParams?: {
|
|
11009
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
11010
|
+
};
|
|
11011
|
+
}
|
|
10969
11012
|
declare class AppEmbed extends V1Embed {
|
|
10970
11013
|
protected viewConfig: AppViewConfig;
|
|
10971
11014
|
private defaultHeight;
|
|
10972
11015
|
constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
|
|
11016
|
+
/**
|
|
11017
|
+
* Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
|
|
11018
|
+
* so the conv-assist app can read sidebar configuration on initialisation.
|
|
11019
|
+
*
|
|
11020
|
+
* Precedence for `enablePastConversationsSidebar`:
|
|
11021
|
+
* `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
|
|
11022
|
+
* deprecated top-level `enablePastConversationsSidebar` flag; if the former
|
|
11023
|
+
* is absent the latter is used as a fallback.
|
|
11024
|
+
*
|
|
11025
|
+
* An invalid `spotterDocumentationUrl` triggers a validation error and is
|
|
11026
|
+
* excluded from the payload rather than forwarded to the app.
|
|
11027
|
+
*/
|
|
11028
|
+
protected getAppInitData(): Promise<AppEmbedAppInitData>;
|
|
10973
11029
|
/**
|
|
10974
11030
|
* Constructs a map of parameters to be passed on to the
|
|
10975
11031
|
* embedded Liveboard or visualization.
|
|
@@ -10988,7 +11044,6 @@ declare class AppEmbed extends V1Embed {
|
|
|
10988
11044
|
* @param pageId The ID of the page to be embedded.
|
|
10989
11045
|
*/
|
|
10990
11046
|
getIFrameSrc(): string;
|
|
10991
|
-
private HEIGHT_CHANAGE_THRESHOLD;
|
|
10992
11047
|
/**
|
|
10993
11048
|
* Set the iframe height as per the computed height received
|
|
10994
11049
|
* from the ThoughtSpot app.
|
|
@@ -11388,6 +11443,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
11388
11443
|
* ```
|
|
11389
11444
|
*/
|
|
11390
11445
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
11446
|
+
/**
|
|
11447
|
+
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
11448
|
+
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
11449
|
+
* This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
|
|
11450
|
+
*
|
|
11451
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
11452
|
+
* @type {boolean}
|
|
11453
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
11454
|
+
* @example
|
|
11455
|
+
* ```js
|
|
11456
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
11457
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
11458
|
+
* ... // other embed view config
|
|
11459
|
+
* isContinuousLiveboardPDFEnabled: true,
|
|
11460
|
+
* })
|
|
11461
|
+
* ```
|
|
11462
|
+
*/
|
|
11463
|
+
isContinuousLiveboardPDFEnabled?: boolean;
|
|
11391
11464
|
/**
|
|
11392
11465
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
11393
11466
|
*
|
|
@@ -11533,7 +11606,6 @@ declare class LiveboardEmbed extends V1Embed {
|
|
|
11533
11606
|
* to be loaded within the iFrame.
|
|
11534
11607
|
*/
|
|
11535
11608
|
private getIFrameSrc;
|
|
11536
|
-
private HEIGHT_CHANAGE_THRESHOLD;
|
|
11537
11609
|
/**
|
|
11538
11610
|
* Set the iframe height as per the computed height received
|
|
11539
11611
|
* from the ThoughtSpot app.
|
|
@@ -11799,40 +11871,6 @@ declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbed
|
|
|
11799
11871
|
* ```
|
|
11800
11872
|
*/
|
|
11801
11873
|
export declare const PreRenderedSearchBarEmbed: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & PreRenderProps & React$1.RefAttributes<SearchBarEmbed>>;
|
|
11802
|
-
export interface SageEmbedProps extends EmbedProps, SageViewConfig {
|
|
11803
|
-
}
|
|
11804
|
-
/**
|
|
11805
|
-
* React component for LLM based search Sage embed.
|
|
11806
|
-
* @example
|
|
11807
|
-
* ```tsx
|
|
11808
|
-
* function Sage() {
|
|
11809
|
-
* return <SageEmbed
|
|
11810
|
-
* showObjectResults={true}
|
|
11811
|
-
* ... other view config props or event listeners.
|
|
11812
|
-
* />
|
|
11813
|
-
* }
|
|
11814
|
-
* ```
|
|
11815
|
-
*/
|
|
11816
|
-
declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
|
|
11817
|
-
/**
|
|
11818
|
-
* React component for PreRendered Sage embed.
|
|
11819
|
-
*
|
|
11820
|
-
* PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
|
|
11821
|
-
* default.
|
|
11822
|
-
*
|
|
11823
|
-
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
11824
|
-
* @example
|
|
11825
|
-
* ```tsx
|
|
11826
|
-
* function LandingPageComponent() {
|
|
11827
|
-
* return <PreRenderedSageEmbed preRenderId="someId" showObjectResults={true} />
|
|
11828
|
-
* }
|
|
11829
|
-
* ```
|
|
11830
|
-
* function MyComponent() {
|
|
11831
|
-
* return <SageEmbed preRenderId="someId" showObjectResults={true} />
|
|
11832
|
-
* }
|
|
11833
|
-
* ```
|
|
11834
|
-
*/
|
|
11835
|
-
export declare const PreRenderedSageEmbed: React$1.ForwardRefExoticComponent<SageEmbedProps & PreRenderProps & React$1.RefAttributes<SageEmbed>>;
|
|
11836
11874
|
export interface SpotterEmbedProps extends EmbedProps, SpotterEmbedViewConfig {
|
|
11837
11875
|
}
|
|
11838
11876
|
export interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
|
|
@@ -11926,7 +11964,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
|
|
|
11926
11964
|
* ```
|
|
11927
11965
|
*/
|
|
11928
11966
|
export declare const PreRenderedConversationEmbed: React$1.ForwardRefExoticComponent<SpotterEmbedProps & PreRenderProps & React$1.RefAttributes<SpotterEmbed>>;
|
|
11929
|
-
export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof LiveboardEmbed$1 | typeof SearchBarEmbed$1 | typeof
|
|
11967
|
+
export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof LiveboardEmbed$1 | typeof SearchBarEmbed$1 | typeof ConversationMessage$1 | typeof SpotterMessage | typeof SpotterEmbed$1 | typeof ConversationEmbed$1;
|
|
11930
11968
|
/**
|
|
11931
11969
|
* Get a reference to the embed component to trigger events on the component.
|
|
11932
11970
|
* @example
|
|
@@ -12008,7 +12046,6 @@ export {
|
|
|
12008
12046
|
ConversationEmbed$1 as ConversationEmbed,
|
|
12009
12047
|
ConversationMessage$1 as ConversationMessage,
|
|
12010
12048
|
LiveboardEmbed$1 as LiveboardEmbed,
|
|
12011
|
-
SageEmbed$1 as SageEmbed,
|
|
12012
12049
|
SearchBarEmbed$1 as SearchBarEmbed,
|
|
12013
12050
|
SearchEmbed$1 as SearchEmbed,
|
|
12014
12051
|
SpotterEmbed$1 as SpotterEmbed,
|