@thoughtspot/visual-embed-sdk 1.49.3 → 1.50.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/cjs/package.json +1 -1
- package/cjs/src/authToken.spec.js +5 -0
- package/cjs/src/authToken.spec.js.map +1 -1
- package/cjs/src/css-variables.d.ts +59 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +31 -2
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +19 -2
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +112 -2
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +38 -0
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +12 -2
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +53 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.spec.d.ts +2 -0
- package/cjs/src/embed/embedConfig.spec.d.ts.map +1 -0
- package/cjs/src/embed/embedConfig.spec.js +74 -0
- package/cjs/src/embed/embedConfig.spec.js.map +1 -0
- package/cjs/src/embed/events.spec.js +593 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.d.ts +2 -0
- package/cjs/src/embed/host-events.spec.d.ts.map +1 -0
- package/cjs/src/embed/host-events.spec.js +1325 -0
- package/cjs/src/embed/host-events.spec.js.map +1 -0
- package/cjs/src/embed/hostEventClient/contracts.d.ts +36 -14
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +10 -1
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +8 -0
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +209 -0
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.d.ts +2 -0
- package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.js +32 -2
- package/cjs/src/embed/hostEventClient/utils.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.spec.js +178 -0
- package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +6 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.d.ts +34 -0
- package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.spec.js +17 -0
- package/cjs/src/embed/spotter-viz-utils.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +14 -7
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +146 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +1 -0
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +1 -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 +3 -2
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.spec.js +14 -0
- package/cjs/src/mixpanel-service.spec.js.map +1 -1
- package/cjs/src/react/util.spec.js +251 -0
- package/cjs/src/react/util.spec.js.map +1 -1
- package/cjs/src/types.d.ts +212 -8
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +185 -3
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/custom-actions.spec.js +26 -0
- package/cjs/src/utils/custom-actions.spec.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +123 -0
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.spec.js +61 -0
- package/cjs/src/utils/processTrigger.spec.js.map +1 -1
- package/cjs/src/utils/reporting.spec.js +21 -0
- package/cjs/src/utils/reporting.spec.js.map +1 -1
- package/cjs/src/utils/sessionInfoService.spec.d.ts +2 -0
- package/cjs/src/utils/sessionInfoService.spec.d.ts.map +1 -0
- package/cjs/src/utils/sessionInfoService.spec.js +130 -0
- package/cjs/src/utils/sessionInfoService.spec.js.map +1 -0
- package/cjs/src/utils.spec.js +158 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/{index-DsSQndIB.js → index-fCne7kmU.js} +1 -1
- package/dist/src/css-variables.d.ts +59 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +31 -2
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +38 -0
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.spec.d.ts +2 -0
- package/dist/src/embed/embedConfig.spec.d.ts.map +1 -0
- package/dist/src/embed/host-events.spec.d.ts +2 -0
- package/dist/src/embed/host-events.spec.d.ts.map +1 -0
- package/dist/src/embed/hostEventClient/contracts.d.ts +36 -14
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/utils.d.ts +2 -0
- package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +6 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-viz-utils.d.ts +34 -0
- package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/errors.d.ts +1 -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 +212 -8
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/sessionInfoService.spec.d.ts +2 -0
- package/dist/src/utils/sessionInfoService.spec.d.ts.map +1 -0
- package/dist/tsembed-react.es.js +482 -86
- package/dist/tsembed-react.js +481 -85
- package/dist/tsembed.es.js +483 -87
- package/dist/tsembed.js +481 -85
- package/dist/visual-embed-sdk-react-full.d.ts +407 -23
- package/dist/visual-embed-sdk-react.d.ts +407 -23
- package/dist/visual-embed-sdk.d.ts +411 -23
- package/lib/package.json +1 -1
- package/lib/src/authToken.spec.js +5 -0
- package/lib/src/authToken.spec.js.map +1 -1
- package/lib/src/css-variables.d.ts +59 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +31 -2
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +19 -2
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +112 -2
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +38 -0
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +11 -1
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +54 -1
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.spec.d.ts +2 -0
- package/lib/src/embed/embedConfig.spec.d.ts.map +1 -0
- package/lib/src/embed/embedConfig.spec.js +72 -0
- package/lib/src/embed/embedConfig.spec.js.map +1 -0
- package/lib/src/embed/events.spec.js +593 -0
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.d.ts +2 -0
- package/lib/src/embed/host-events.spec.d.ts.map +1 -0
- package/lib/src/embed/host-events.spec.js +1322 -0
- package/lib/src/embed/host-events.spec.js.map +1 -0
- package/lib/src/embed/hostEventClient/contracts.d.ts +36 -14
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +9 -0
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +9 -1
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +209 -0
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.d.ts +2 -0
- package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/utils.js +28 -1
- package/lib/src/embed/hostEventClient/utils.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.spec.js +179 -1
- package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +6 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/spotter-viz-utils.d.ts +34 -0
- package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-viz-utils.js.map +1 -1
- package/lib/src/embed/spotter-viz-utils.spec.js +17 -0
- package/lib/src/embed/spotter-viz-utils.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +14 -7
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +146 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.d.ts +1 -0
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +1 -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/mixpanel-service.spec.js +14 -0
- package/lib/src/mixpanel-service.spec.js.map +1 -1
- package/lib/src/react/util.spec.js +251 -0
- package/lib/src/react/util.spec.js.map +1 -1
- package/lib/src/types.d.ts +212 -8
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +185 -3
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/custom-actions.spec.js +26 -0
- package/lib/src/utils/custom-actions.spec.js.map +1 -1
- package/lib/src/utils/processData.spec.js +123 -0
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.spec.js +61 -0
- package/lib/src/utils/processTrigger.spec.js.map +1 -1
- package/lib/src/utils/reporting.spec.js +21 -0
- package/lib/src/utils/reporting.spec.js.map +1 -1
- package/lib/src/utils/sessionInfoService.spec.d.ts +2 -0
- package/lib/src/utils/sessionInfoService.spec.d.ts.map +1 -0
- package/lib/src/utils/sessionInfoService.spec.js +127 -0
- package/lib/src/utils/sessionInfoService.spec.js.map +1 -0
- package/lib/src/utils.spec.js +159 -1
- package/lib/src/utils.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +411 -23
- package/package.json +1 -1
- package/src/authToken.spec.ts +6 -0
- package/src/css-variables.ts +73 -0
- package/src/embed/app.spec.ts +155 -2
- package/src/embed/app.ts +44 -2
- package/src/embed/conversation.spec.ts +64 -1
- package/src/embed/conversation.ts +41 -0
- package/src/embed/embedConfig.spec.ts +79 -0
- package/src/embed/events.spec.ts +705 -1
- package/src/embed/host-events.spec.ts +1759 -0
- package/src/embed/hostEventClient/contracts.ts +41 -14
- package/src/embed/hostEventClient/host-event-client.spec.ts +326 -0
- package/src/embed/hostEventClient/host-event-client.ts +15 -0
- package/src/embed/hostEventClient/utils.spec.ts +204 -0
- package/src/embed/hostEventClient/utils.ts +37 -10
- package/src/embed/liveboard.ts +6 -0
- package/src/embed/spotter-viz-utils.spec.ts +17 -0
- package/src/embed/spotter-viz-utils.ts +34 -0
- package/src/embed/ts-embed.spec.ts +186 -0
- package/src/embed/ts-embed.ts +12 -4
- package/src/errors.ts +1 -0
- package/src/index.ts +2 -1
- package/src/mixpanel-service.spec.ts +15 -0
- package/src/react/util.spec.tsx +255 -0
- package/src/types.ts +215 -6
- package/src/utils/custom-actions.spec.ts +28 -0
- package/src/utils/processData.spec.ts +129 -0
- package/src/utils/processTrigger.spec.ts +91 -0
- package/src/utils/reporting.spec.ts +27 -0
- package/src/utils/sessionInfoService.spec.ts +151 -0
- package/src/utils.spec.ts +195 -0
|
@@ -412,6 +412,14 @@ export interface CustomCssVariables {
|
|
|
412
412
|
* Background color of the tiles in the Liveboard.
|
|
413
413
|
*/
|
|
414
414
|
"--ts-var-liveboard-tile-background"?: string;
|
|
415
|
+
/**
|
|
416
|
+
* Font color of the insight tiles in the Liveboard.
|
|
417
|
+
*/
|
|
418
|
+
"--ts-var-liveboard-insight-tile-font-color"?: string;
|
|
419
|
+
/**
|
|
420
|
+
* Background color of the insight tiles in the Liveboard.
|
|
421
|
+
*/
|
|
422
|
+
"--ts-var-liveboard-insight-tile-background"?: string;
|
|
415
423
|
/**
|
|
416
424
|
* Border radius of the tiles in the Liveboard.
|
|
417
425
|
*/
|
|
@@ -960,6 +968,10 @@ export interface CustomCssVariables {
|
|
|
960
968
|
* header underline, left panel border, thinking step connector and dots.
|
|
961
969
|
*/
|
|
962
970
|
"--ts-var-spotterviz-border-color"?: string;
|
|
971
|
+
/**
|
|
972
|
+
* Expanded user chat message bubble border color in SpotterViz.
|
|
973
|
+
*/
|
|
974
|
+
"--ts-var-spotterviz-expanded-border-color"?: string;
|
|
963
975
|
/**
|
|
964
976
|
* Background color of the reference-mode toggle button in the SpotterViz
|
|
965
977
|
* chat input when it is unselected and the user hovers over it.
|
|
@@ -977,6 +989,53 @@ export interface CustomCssVariables {
|
|
|
977
989
|
* on each referenced-entity chip in the chat input.
|
|
978
990
|
*/
|
|
979
991
|
"--ts-var-spotterviz-reference-icon-selected-background"?: string;
|
|
992
|
+
/**
|
|
993
|
+
* Background color of the shared conversation header (recipient's read-only view).
|
|
994
|
+
*/
|
|
995
|
+
"--ts-var-shared-conv-header-background"?: string;
|
|
996
|
+
/**
|
|
997
|
+
* Border color of the shared conversation header.
|
|
998
|
+
*/
|
|
999
|
+
"--ts-var-shared-conv-header-border-color"?: string;
|
|
1000
|
+
/**
|
|
1001
|
+
* Font color of the title text in the shared conversation header.
|
|
1002
|
+
*/
|
|
1003
|
+
"--ts-var-shared-conv-title-color"?: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* Background gradient color-stop of the share chat header's outer container
|
|
1006
|
+
* (sender's pre-share header). Defaults to transparent.
|
|
1007
|
+
*/
|
|
1008
|
+
"--ts-var-share-chat-header-container-background"?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* Background color of the share chat header's inner title/actions row.
|
|
1011
|
+
* Defaults to transparent.
|
|
1012
|
+
*/
|
|
1013
|
+
"--ts-var-share-chat-header-background"?: string;
|
|
1014
|
+
/**
|
|
1015
|
+
* Font color of the title text in the share chat header.
|
|
1016
|
+
*/
|
|
1017
|
+
"--ts-var-share-chat-header-title-color"?: string;
|
|
1018
|
+
/**
|
|
1019
|
+
* Font color of the title input field in the share chat header.
|
|
1020
|
+
*/
|
|
1021
|
+
"--ts-var-share-chat-header-input-text-color"?: string;
|
|
1022
|
+
/**
|
|
1023
|
+
* Background color of the title input field in the share chat header.
|
|
1024
|
+
*/
|
|
1025
|
+
"--ts-var-share-chat-header-input-background"?: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* Border color of the title input field in the share chat header.
|
|
1028
|
+
*/
|
|
1029
|
+
"--ts-var-share-chat-header-input-border-color"?: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* Background color of the shimmer loading effect. Also affects the
|
|
1032
|
+
* saved chats sidebar's new-chat shimmer, which shares the same style.
|
|
1033
|
+
*/
|
|
1034
|
+
"--ts-var-shimmer-background"?: string;
|
|
1035
|
+
/**
|
|
1036
|
+
* Background color of the shimmer sweep animation's gradient mid-stop.
|
|
1037
|
+
*/
|
|
1038
|
+
"--ts-var-shimmer-sweep-background"?: string;
|
|
980
1039
|
}
|
|
981
1040
|
export interface SessionInterface {
|
|
982
1041
|
sessionId: string;
|
|
@@ -1406,7 +1465,14 @@ export enum HomeLeftNavItem {
|
|
|
1406
1465
|
* Available in the V3 navigation experience.
|
|
1407
1466
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1408
1467
|
*/
|
|
1409
|
-
Favorites = "favorites"
|
|
1468
|
+
Favorites = "favorites",
|
|
1469
|
+
/**
|
|
1470
|
+
* The *Collections* menu option in
|
|
1471
|
+
* the *Insights* left navigation panel.
|
|
1472
|
+
* Shown when collections are enabled on the cluster.
|
|
1473
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1474
|
+
*/
|
|
1475
|
+
Collections = "collections"
|
|
1410
1476
|
}
|
|
1411
1477
|
export type DOMSelector = string | HTMLElement;
|
|
1412
1478
|
/**
|
|
@@ -2096,7 +2162,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2096
2162
|
* The list of actions to completely remove from the embedded view.
|
|
2097
2163
|
* Hidden actions are not visible to the user at all (fully removed from the UI).
|
|
2098
2164
|
* Use this when you want to remove an action entirely.
|
|
2099
|
-
* To keep an action visible but non-interactive (grayed out), use {@link
|
|
2165
|
+
* To keep an action visible but non-interactive (grayed out), use {@link
|
|
2166
|
+
* disabledActions} instead.
|
|
2100
2167
|
*
|
|
2101
2168
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2102
2169
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
@@ -2116,7 +2183,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2116
2183
|
* (...), and the contextual menu. These will be only actions that
|
|
2117
2184
|
* are visible to the user.
|
|
2118
2185
|
* Use this as an allowlist — only the actions listed here will be shown.
|
|
2119
|
-
* All other actions will be hidden. Use either this or {@link hiddenActions}, not
|
|
2186
|
+
* All other actions will be hidden. Use either this or {@link hiddenActions}, not
|
|
2187
|
+
* both.
|
|
2120
2188
|
*
|
|
2121
2189
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2122
2190
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
@@ -2351,6 +2419,26 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2351
2419
|
* ```
|
|
2352
2420
|
*/
|
|
2353
2421
|
overrideOrgId?: number;
|
|
2422
|
+
/**
|
|
2423
|
+
* Overrides the browser history behavior for embedding application users.
|
|
2424
|
+
* This parameter changes standard history navigation (pushState) into a
|
|
2425
|
+
* state replacement (replaceState), preventing users from getting trapped in
|
|
2426
|
+
* back-button loops inside the embedded iframe environment.
|
|
2427
|
+
* The overrideHistoryState setting is honored only if the
|
|
2428
|
+
* application is running within an embedded context.
|
|
2429
|
+
*
|
|
2430
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2431
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
2432
|
+
* @example
|
|
2433
|
+
* ```js
|
|
2434
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2435
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2436
|
+
* // ... other embed view config
|
|
2437
|
+
* overrideHistoryState: true,
|
|
2438
|
+
* });
|
|
2439
|
+
* ```
|
|
2440
|
+
*/
|
|
2441
|
+
overrideHistoryState?: boolean;
|
|
2354
2442
|
/**
|
|
2355
2443
|
* Flag to override the *Open Link in New Tab* context
|
|
2356
2444
|
* menu option.
|
|
@@ -4811,6 +4899,30 @@ export enum EmbedEvent {
|
|
|
4811
4899
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4812
4900
|
*/
|
|
4813
4901
|
SpotterConversationSelected = "spotterConversationSelected",
|
|
4902
|
+
/**
|
|
4903
|
+
* Emitted when the Spotter agent finishes streaming/rendering a response.
|
|
4904
|
+
* Includes the conversation and message identifiers so the host app can
|
|
4905
|
+
* fetch the full conversation history via the REST API if needed.
|
|
4906
|
+
*
|
|
4907
|
+
* The payload data has the shape `{ convId: string, messageId: string }`.
|
|
4908
|
+
*
|
|
4909
|
+
* Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
|
|
4910
|
+
* inside the full application).
|
|
4911
|
+
* @example
|
|
4912
|
+
* ```js
|
|
4913
|
+
* spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
4914
|
+
* console.log('Spotter response complete', payload);
|
|
4915
|
+
* })
|
|
4916
|
+
* ```
|
|
4917
|
+
* @example
|
|
4918
|
+
* ```js
|
|
4919
|
+
* appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
4920
|
+
* console.log('Spotter response complete', payload);
|
|
4921
|
+
* })
|
|
4922
|
+
* ```
|
|
4923
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4924
|
+
*/
|
|
4925
|
+
SpotterResponseComplete = "spotterResponseComplete",
|
|
4814
4926
|
/**
|
|
4815
4927
|
* @hidden
|
|
4816
4928
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -4835,10 +4947,11 @@ export enum EmbedEvent {
|
|
|
4835
4947
|
*/
|
|
4836
4948
|
EmbedPageContextChanged = "EmbedPageContextChanged",
|
|
4837
4949
|
/**
|
|
4838
|
-
* Represents a special embed event that is triggered whenever any host event is
|
|
4950
|
+
* Represents a special embed event that is triggered whenever any host event is
|
|
4951
|
+
* subscribed.
|
|
4839
4952
|
*
|
|
4840
|
-
* You can listen to this event when you need to dispatch a host event during load or
|
|
4841
|
-
* particularly in situations where timing issues may occur.
|
|
4953
|
+
* You can listen to this event when you need to dispatch a host event during load or
|
|
4954
|
+
* render, particularly in situations where timing issues may occur.
|
|
4842
4955
|
*
|
|
4843
4956
|
* @example
|
|
4844
4957
|
* ```js
|
|
@@ -6373,6 +6486,14 @@ export enum HostEvent {
|
|
|
6373
6486
|
/**
|
|
6374
6487
|
* Get details of filters applied on the Liveboard.
|
|
6375
6488
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
6489
|
+
* Each Liveboard filter may include an `applicability` attribute
|
|
6490
|
+
* indicating the scope of the filter. It contains a `level`
|
|
6491
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
6492
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
6493
|
+
* level there is no `targetId`, since the filter applies to the
|
|
6494
|
+
* whole Liveboard.
|
|
6495
|
+
* The `applicability` attribute is available from SDK: 1.51.0 |
|
|
6496
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
6376
6497
|
* @example
|
|
6377
6498
|
* ```js
|
|
6378
6499
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
@@ -6412,6 +6533,16 @@ export enum HostEvent {
|
|
|
6412
6533
|
*
|
|
6413
6534
|
* `type` - To update filters for date time, specify the date format type.
|
|
6414
6535
|
* For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
|
|
6536
|
+
*
|
|
6537
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
6538
|
+
* for example, a single Liveboard tab. Available from SDK: 1.51.0 |
|
|
6539
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
6540
|
+
*
|
|
6541
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
6542
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
6543
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
6544
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
6545
|
+
* Liveboard.
|
|
6415
6546
|
* @example
|
|
6416
6547
|
* ```js
|
|
6417
6548
|
*
|
|
@@ -6488,6 +6619,21 @@ export enum HostEvent {
|
|
|
6488
6619
|
* }
|
|
6489
6620
|
* }, ContextType.Liveboard);
|
|
6490
6621
|
* ```
|
|
6622
|
+
* @example
|
|
6623
|
+
* ```js
|
|
6624
|
+
* // Scope the filter to a specific Liveboard tab
|
|
6625
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
6626
|
+
* filter: {
|
|
6627
|
+
* column: "item type",
|
|
6628
|
+
* oper: "IN",
|
|
6629
|
+
* values: ["bags", "shirts"],
|
|
6630
|
+
* applicability: {
|
|
6631
|
+
* level: "TAB",
|
|
6632
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
6633
|
+
* }
|
|
6634
|
+
* }
|
|
6635
|
+
* });
|
|
6636
|
+
* ```
|
|
6491
6637
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
6492
6638
|
*/
|
|
6493
6639
|
UpdateFilters = "updateFilters",
|
|
@@ -6639,6 +6785,15 @@ export enum HostEvent {
|
|
|
6639
6785
|
* - `name`: Name of the parameter.
|
|
6640
6786
|
* - `value`: The value to set for the parameter.
|
|
6641
6787
|
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
6788
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
6789
|
+
* for example, a single Liveboard tab. Available from SDK: 1.51.0 |
|
|
6790
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
6791
|
+
*
|
|
6792
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
6793
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
6794
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
6795
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
6796
|
+
* Liveboard.
|
|
6642
6797
|
*
|
|
6643
6798
|
* @example
|
|
6644
6799
|
* ```js
|
|
@@ -6650,6 +6805,18 @@ export enum HostEvent {
|
|
|
6650
6805
|
* ```
|
|
6651
6806
|
* @example
|
|
6652
6807
|
* ```js
|
|
6808
|
+
* // Scope the parameter to a specific Liveboard tab
|
|
6809
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
6810
|
+
* name: "Integer Range Param",
|
|
6811
|
+
* value: 10,
|
|
6812
|
+
* applicability: {
|
|
6813
|
+
* level: "TAB",
|
|
6814
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
6815
|
+
* }
|
|
6816
|
+
* }])
|
|
6817
|
+
* ```
|
|
6818
|
+
* @example
|
|
6819
|
+
* ```js
|
|
6653
6820
|
* // Update parameters from liveboard context
|
|
6654
6821
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
6655
6822
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -6663,6 +6830,14 @@ export enum HostEvent {
|
|
|
6663
6830
|
UpdateParameters = "UpdateParameters",
|
|
6664
6831
|
/**
|
|
6665
6832
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
6833
|
+
* Each parameter may include an `applicability` attribute
|
|
6834
|
+
* indicating the scope of the parameter. It contains a `level`
|
|
6835
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
6836
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
6837
|
+
* level there is no `targetId`, since the parameter applies to the
|
|
6838
|
+
* whole Liveboard.
|
|
6839
|
+
* The `applicability` attribute is available from SDK: 1.51.0 |
|
|
6840
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
6666
6841
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
6667
6842
|
* ```js
|
|
6668
6843
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
@@ -7076,6 +7251,24 @@ export enum HostEvent {
|
|
|
7076
7251
|
* ```
|
|
7077
7252
|
*/
|
|
7078
7253
|
InitSpotterVizConversation = "InitSpotterVizConversation",
|
|
7254
|
+
/**
|
|
7255
|
+
* Opens the SpotterViz panel.
|
|
7256
|
+
* @version SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
7257
|
+
* @example
|
|
7258
|
+
* ```js
|
|
7259
|
+
* liveboardEmbed.trigger(HostEvent.OpenSpotterVizPanel);
|
|
7260
|
+
* ```
|
|
7261
|
+
*/
|
|
7262
|
+
OpenSpotterVizPanel = "OpenSpotterVizPanel",
|
|
7263
|
+
/**
|
|
7264
|
+
* Closes the SpotterViz panel.
|
|
7265
|
+
* @version SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
7266
|
+
* @example
|
|
7267
|
+
* ```js
|
|
7268
|
+
* liveboardEmbed.trigger(HostEvent.CloseSpotterVizPanel);
|
|
7269
|
+
* ```
|
|
7270
|
+
*/
|
|
7271
|
+
CloseSpotterVizPanel = "CloseSpotterVizPanel",
|
|
7079
7272
|
/**
|
|
7080
7273
|
* Clears browser cache and fetches new data for liveboard ChartViz Containers.
|
|
7081
7274
|
* Requires `enableLiveboardDataCache` to be enabled.
|
|
@@ -8841,7 +9034,73 @@ export enum Action {
|
|
|
8841
9034
|
* ```
|
|
8842
9035
|
* @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
|
|
8843
9036
|
*/
|
|
8844
|
-
RefreshLiveboardBrowserCache = "refreshLiveboardBrowserCache"
|
|
9037
|
+
RefreshLiveboardBrowserCache = "refreshLiveboardBrowserCache",
|
|
9038
|
+
/**
|
|
9039
|
+
* Controls visibility and disable state of the share action
|
|
9040
|
+
* in the Spotter Analyst interface.
|
|
9041
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
|
|
9042
|
+
* @example
|
|
9043
|
+
* ```js
|
|
9044
|
+
* hiddenActions: [Action.SpotterAnalystShare]
|
|
9045
|
+
* disabledActions: [Action.SpotterAnalystShare]
|
|
9046
|
+
* ```
|
|
9047
|
+
*/
|
|
9048
|
+
SpotterAnalystShare = "spotterAnalystShare",
|
|
9049
|
+
/**
|
|
9050
|
+
* Controls visibility and disable state of the edit action
|
|
9051
|
+
* in the Spotter Analyst interface.
|
|
9052
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
|
|
9053
|
+
* @example
|
|
9054
|
+
* ```js
|
|
9055
|
+
* hiddenActions: [Action.SpotterAnalystEdit]
|
|
9056
|
+
* disabledActions: [Action.SpotterAnalystEdit]
|
|
9057
|
+
* ```
|
|
9058
|
+
*/
|
|
9059
|
+
SpotterAnalystEdit = "spotterAnalystEdit",
|
|
9060
|
+
/**
|
|
9061
|
+
* Controls visibility and disable state of the create action
|
|
9062
|
+
* in the Spotter Analyst interface.
|
|
9063
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
|
|
9064
|
+
* @example
|
|
9065
|
+
* ```js
|
|
9066
|
+
* hiddenActions: [Action.SpotterAnalystCreate]
|
|
9067
|
+
* disabledActions: [Action.SpotterAnalystCreate]
|
|
9068
|
+
* ```
|
|
9069
|
+
*/
|
|
9070
|
+
SpotterAnalystCreate = "spotterAnalystCreate",
|
|
9071
|
+
/**
|
|
9072
|
+
* Controls visibility and disable state of the delete action
|
|
9073
|
+
* in the Spotter Analyst interface.
|
|
9074
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
|
|
9075
|
+
* @example
|
|
9076
|
+
* ```js
|
|
9077
|
+
* hiddenActions: [Action.SpotterAnalystDelete]
|
|
9078
|
+
* disabledActions: [Action.SpotterAnalystDelete]
|
|
9079
|
+
* ```
|
|
9080
|
+
*/
|
|
9081
|
+
SpotterAnalystDelete = "spotterAnalystDelete",
|
|
9082
|
+
/**
|
|
9083
|
+
* Controls visibility and disable state of the make a copy action
|
|
9084
|
+
* in the Spotter Analyst interface.
|
|
9085
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
|
|
9086
|
+
* @example
|
|
9087
|
+
* ```js
|
|
9088
|
+
* hiddenActions: [Action.SpotterAnalystMakeACopy]
|
|
9089
|
+
* disabledActions: [Action.SpotterAnalystMakeACopy]
|
|
9090
|
+
* ```
|
|
9091
|
+
*/
|
|
9092
|
+
SpotterAnalystMakeACopy = "spotterAnalystMakeACopy",
|
|
9093
|
+
/**
|
|
9094
|
+
* Controls visibility and disable state of the sidebar
|
|
9095
|
+
* in the Spotter Analyst interface.
|
|
9096
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
|
|
9097
|
+
* @example
|
|
9098
|
+
* ```js
|
|
9099
|
+
* hiddenActions: [Action.SpotterAnalystSidebar]
|
|
9100
|
+
* disabledActions: [Action.SpotterAnalystSidebar]
|
|
9101
|
+
* ```
|
|
9102
|
+
*/
|
|
9103
|
+
SpotterAnalystSidebar = "spotterAnalystSidebar"
|
|
8845
9104
|
}
|
|
8846
9105
|
export enum PrefetchFeatures {
|
|
8847
9106
|
FullApp = "FullApp",
|
|
@@ -9179,7 +9438,9 @@ export enum EmbedErrorCodes {
|
|
|
9179
9438
|
/** UpdateFilters payload is invalid - missing or malformed filter/filters */
|
|
9180
9439
|
UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
|
|
9181
9440
|
/** DrillDown payload is invalid - missing or malformed points */
|
|
9182
|
-
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
|
|
9441
|
+
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD",
|
|
9442
|
+
/** UpdateParameters payload is invalid - malformed applicability */
|
|
9443
|
+
UPDATEPARAMETERS_INVALID_PAYLOAD = "UPDATEPARAMETERS_INVALID_PAYLOAD"
|
|
9183
9444
|
}
|
|
9184
9445
|
/**
|
|
9185
9446
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -9825,6 +10086,35 @@ export interface LiveboardTab {
|
|
|
9825
10086
|
name: string;
|
|
9826
10087
|
[key: string]: any;
|
|
9827
10088
|
}
|
|
10089
|
+
enum ApplicabilityLevel {
|
|
10090
|
+
Liveboard = "LIVEBOARD",
|
|
10091
|
+
Tab = "TAB",
|
|
10092
|
+
Group = "GROUP"
|
|
10093
|
+
}
|
|
10094
|
+
/**
|
|
10095
|
+
* Scopes a filter or parameter to a specific target.
|
|
10096
|
+
* At `LIVEBOARD` level the filter applies to the whole Liveboard, so `targetId`
|
|
10097
|
+
* is not required.
|
|
10098
|
+
*/
|
|
10099
|
+
export interface Applicability {
|
|
10100
|
+
level: ApplicabilityLevel;
|
|
10101
|
+
targetId?: string;
|
|
10102
|
+
}
|
|
10103
|
+
export interface FilterUpdate {
|
|
10104
|
+
column: string;
|
|
10105
|
+
oper: string;
|
|
10106
|
+
values: string[];
|
|
10107
|
+
type?: string;
|
|
10108
|
+
applicability?: Applicability;
|
|
10109
|
+
}
|
|
10110
|
+
export interface LiveboardFilter {
|
|
10111
|
+
applicability?: Applicability;
|
|
10112
|
+
[key: string]: any;
|
|
10113
|
+
}
|
|
10114
|
+
export interface LiveboardParameter {
|
|
10115
|
+
applicability?: Applicability;
|
|
10116
|
+
[key: string]: any;
|
|
10117
|
+
}
|
|
9828
10118
|
export enum UIPassthroughEvent {
|
|
9829
10119
|
PinAnswerToLiveboard = "addVizToPinboard",
|
|
9830
10120
|
SaveAnswer = "saveAnswer",
|
|
@@ -9919,7 +10209,7 @@ export type UIPassthroughContractBase = {
|
|
|
9919
10209
|
vizId?: string;
|
|
9920
10210
|
};
|
|
9921
10211
|
response: {
|
|
9922
|
-
liveboardFilters:
|
|
10212
|
+
liveboardFilters: LiveboardFilter[];
|
|
9923
10213
|
runtimeFilters: RuntimeFilter[];
|
|
9924
10214
|
};
|
|
9925
10215
|
};
|
|
@@ -9932,7 +10222,7 @@ export type UIPassthroughContractBase = {
|
|
|
9932
10222
|
[UIPassthroughEvent.GetParameters]: {
|
|
9933
10223
|
request: Record<string, never>;
|
|
9934
10224
|
response: {
|
|
9935
|
-
parameters:
|
|
10225
|
+
parameters: LiveboardParameter[];
|
|
9936
10226
|
};
|
|
9937
10227
|
};
|
|
9938
10228
|
[UIPassthroughEvent.GetTML]: {
|
|
@@ -9961,18 +10251,8 @@ export type UIPassthroughContractBase = {
|
|
|
9961
10251
|
};
|
|
9962
10252
|
[UIPassthroughEvent.UpdateFilters]: {
|
|
9963
10253
|
request: {
|
|
9964
|
-
filter?:
|
|
9965
|
-
|
|
9966
|
-
oper: string;
|
|
9967
|
-
values: string[];
|
|
9968
|
-
type?: string;
|
|
9969
|
-
};
|
|
9970
|
-
filters?: {
|
|
9971
|
-
column: string;
|
|
9972
|
-
oper: string;
|
|
9973
|
-
values: string[];
|
|
9974
|
-
type?: string;
|
|
9975
|
-
}[];
|
|
10254
|
+
filter?: FilterUpdate;
|
|
10255
|
+
filters?: FilterUpdate[];
|
|
9976
10256
|
};
|
|
9977
10257
|
response: unknown;
|
|
9978
10258
|
};
|
|
@@ -10049,6 +10329,7 @@ class HostEventClient {
|
|
|
10049
10329
|
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
10050
10330
|
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
10051
10331
|
protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
|
|
10332
|
+
protected handleUpdateParametersEvent(payload: HostEventRequest<HostEvent.UpdateParameters>, context?: ContextType): Promise<any>;
|
|
10052
10333
|
protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
|
|
10053
10334
|
/**
|
|
10054
10335
|
* Dispatches a host event using the appropriate channel:
|
|
@@ -10651,6 +10932,14 @@ export interface SearchOptions {
|
|
|
10651
10932
|
*/
|
|
10652
10933
|
searchQuery: string;
|
|
10653
10934
|
}
|
|
10935
|
+
/**
|
|
10936
|
+
* The query mode Spotter uses when answering a question.
|
|
10937
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
10938
|
+
*/
|
|
10939
|
+
export enum SpotterQueryMode {
|
|
10940
|
+
FAST_SEARCH = "fastSearch",
|
|
10941
|
+
RESEARCH = "research"
|
|
10942
|
+
}
|
|
10654
10943
|
/**
|
|
10655
10944
|
* Configuration for the Spotter sidebar.
|
|
10656
10945
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
@@ -10725,6 +11014,18 @@ export interface SpotterSidebarViewConfig {
|
|
|
10725
11014
|
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
10726
11015
|
*/
|
|
10727
11016
|
spotterNewChatButtonTitle?: string;
|
|
11017
|
+
/**
|
|
11018
|
+
* Custom label text for the Spotter Analyst section in the sidebar.
|
|
11019
|
+
* @version SDK: 1.51.0 | ThoughtSpot: 26.8.0.cl
|
|
11020
|
+
* @default Analyst
|
|
11021
|
+
*/
|
|
11022
|
+
spotterAnalystLabel?: string;
|
|
11023
|
+
/**
|
|
11024
|
+
* Custom label text for the Spotter Analysts section in the sidebar.
|
|
11025
|
+
* @version SDK: 1.51.0 | ThoughtSpot: 26.8.0.cl
|
|
11026
|
+
* @default Analysts
|
|
11027
|
+
*/
|
|
11028
|
+
spotterAnalystsLabel?: string;
|
|
10728
11029
|
}
|
|
10729
11030
|
/**
|
|
10730
11031
|
* Configuration for customizing Spotter chat UI branding.
|
|
@@ -10941,6 +11242,24 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
10941
11242
|
* ```
|
|
10942
11243
|
*/
|
|
10943
11244
|
updatedSpotterChatPrompt?: boolean;
|
|
11245
|
+
/**
|
|
11246
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
11247
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
11248
|
+
* instance only; it does not persist as a user preference and does
|
|
11249
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
11250
|
+
*
|
|
11251
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
11252
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11253
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
11254
|
+
* @example
|
|
11255
|
+
* ```js
|
|
11256
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
11257
|
+
* ... //other embed view config
|
|
11258
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
11259
|
+
* })
|
|
11260
|
+
* ```
|
|
11261
|
+
*/
|
|
11262
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
10944
11263
|
/**
|
|
10945
11264
|
* Enables the stop answer generation button in the Spotter embed UI,
|
|
10946
11265
|
* allowing users to interrupt an ongoing answer generation.
|
|
@@ -11111,6 +11430,12 @@ export interface SpotterVizStarterPrompt {
|
|
|
11111
11430
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
11112
11431
|
* { label: 'Tip', text: 'use natural language' },
|
|
11113
11432
|
* ],
|
|
11433
|
+
* // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11434
|
+
* liveboardBrandName: 'Reports',
|
|
11435
|
+
* spotterBrandName: 'Analyst',
|
|
11436
|
+
* insightTileBrandName: 'Insight card',
|
|
11437
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
11438
|
+
* insightTileLoaderText: 'Generating insight',
|
|
11114
11439
|
* },
|
|
11115
11440
|
* })
|
|
11116
11441
|
* ```
|
|
@@ -11167,6 +11492,34 @@ export interface SpotterVizConfig {
|
|
|
11167
11492
|
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
|
|
11168
11493
|
*/
|
|
11169
11494
|
loaderTips?: SpotterVizLoaderTip[];
|
|
11495
|
+
/**
|
|
11496
|
+
* Custom term used to replace "Liveboard" in the agent's responses.
|
|
11497
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11498
|
+
* @default ''
|
|
11499
|
+
*/
|
|
11500
|
+
liveboardBrandName?: string;
|
|
11501
|
+
/**
|
|
11502
|
+
* Custom term used to replace "Spotter" in the agent's responses.
|
|
11503
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11504
|
+
* @default ''
|
|
11505
|
+
*/
|
|
11506
|
+
spotterBrandName?: string;
|
|
11507
|
+
/**
|
|
11508
|
+
* Custom term used to replace "Insight tile" in the UI and in the agent's responses.
|
|
11509
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11510
|
+
* @default ''
|
|
11511
|
+
*/
|
|
11512
|
+
insightTileBrandName?: string;
|
|
11513
|
+
/**
|
|
11514
|
+
* Custom term used to replace "View plan" in the insight tile menu.
|
|
11515
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11516
|
+
*/
|
|
11517
|
+
insightTileViewPlanLabel?: string;
|
|
11518
|
+
/**
|
|
11519
|
+
* Custom loader text shown on the insight tile.
|
|
11520
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11521
|
+
*/
|
|
11522
|
+
insightTileLoaderText?: string;
|
|
11170
11523
|
}
|
|
11171
11524
|
/**
|
|
11172
11525
|
* A single tip shown in the SpotterViz loading state.
|
|
@@ -11214,7 +11567,11 @@ export enum Page {
|
|
|
11214
11567
|
/**
|
|
11215
11568
|
* Monitor Alerts Page
|
|
11216
11569
|
*/
|
|
11217
|
-
Monitor = "monitor"
|
|
11570
|
+
Monitor = "monitor",
|
|
11571
|
+
/**
|
|
11572
|
+
* Collections listing page
|
|
11573
|
+
*/
|
|
11574
|
+
Collections = "collections"
|
|
11218
11575
|
}
|
|
11219
11576
|
/**
|
|
11220
11577
|
* Define the initial state of column custom group accordions
|
|
@@ -11869,6 +12226,25 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11869
12226
|
* ```
|
|
11870
12227
|
*/
|
|
11871
12228
|
updatedSpotterChatPrompt?: boolean;
|
|
12229
|
+
/**
|
|
12230
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
12231
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
12232
|
+
* instance only; it does not persist as a user preference and does
|
|
12233
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
12234
|
+
* Only applicable when navigating to Spotter within the app.
|
|
12235
|
+
*
|
|
12236
|
+
* Supported embed types: `AppEmbed`
|
|
12237
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12238
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
12239
|
+
* @example
|
|
12240
|
+
* ```js
|
|
12241
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
12242
|
+
* ... //other embed view config
|
|
12243
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
12244
|
+
* })
|
|
12245
|
+
* ```
|
|
12246
|
+
*/
|
|
12247
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
11872
12248
|
/**
|
|
11873
12249
|
* Controls the visibility of the past conversations sidebar.
|
|
11874
12250
|
*
|
|
@@ -11941,6 +12317,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11941
12317
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
11942
12318
|
* { label: 'Tip', text: 'use natural language' },
|
|
11943
12319
|
* ],
|
|
12320
|
+
* // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12321
|
+
* liveboardBrandName: 'Reports',
|
|
12322
|
+
* spotterBrandName: 'Analyst',
|
|
12323
|
+
* insightTileBrandName: 'Insight card',
|
|
12324
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
12325
|
+
* insightTileLoaderText: 'Generating insight',
|
|
11944
12326
|
* },
|
|
11945
12327
|
* })
|
|
11946
12328
|
* ```
|
|
@@ -12930,6 +13312,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12930
13312
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
12931
13313
|
* { label: 'Tip', text: 'use natural language' },
|
|
12932
13314
|
* ],
|
|
13315
|
+
* // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13316
|
+
* liveboardBrandName: 'Reports',
|
|
13317
|
+
* spotterBrandName: 'Analyst',
|
|
13318
|
+
* insightTileBrandName: 'Insight card',
|
|
13319
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
13320
|
+
* insightTileLoaderText: 'Generating insight',
|
|
12933
13321
|
* },
|
|
12934
13322
|
* })
|
|
12935
13323
|
* ```
|
package/package.json
CHANGED
package/src/authToken.spec.ts
CHANGED
|
@@ -77,6 +77,12 @@ describe('AuthToken Unit tests', () => {
|
|
|
77
77
|
loggerSpy.mockRestore();
|
|
78
78
|
});
|
|
79
79
|
|
|
80
|
+
test('validateAuthToken: returns false when verifyTokenService throws (covers catch block)', async () => {
|
|
81
|
+
jest.spyOn(authServiceInstance, 'verifyTokenService').mockRejectedValueOnce(new Error('network error'));
|
|
82
|
+
const result = await validateAuthToken({ thoughtSpotHost: 'test', disableTokenVerification: false } as EmbedConfig, 'valid-token-string');
|
|
83
|
+
expect(result).toBe(false);
|
|
84
|
+
});
|
|
85
|
+
|
|
80
86
|
describe('getAuthenticationToken: cached token skip validation condition', () => {
|
|
81
87
|
beforeEach(() => {
|
|
82
88
|
resetCachedAuthToken();
|