@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.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 +1 -1
- package/cjs/src/css-variables.d.ts +95 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +136 -15
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +59 -37
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +419 -149
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +230 -1
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +30 -16
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +221 -17
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/events.spec.js +635 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.js +151 -0
- package/cjs/src/embed/host-events.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +51 -14
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +11 -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 +9 -0
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +218 -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 +42 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +26 -6
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +83 -2
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +8 -1
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-utils.js +14 -1
- package/cjs/src/embed/spotter-utils.js.map +1 -1
- package/cjs/src/embed/spotter-utils.spec.js +61 -0
- package/cjs/src/embed/spotter-utils.spec.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 +29 -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.d.ts +4 -0
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +4 -0
- package/cjs/src/mixpanel-service.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 +573 -11
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +519 -2
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +93 -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/dist/{index-B5xoN6Cp.js → index-aBzH5ZwF.js} +1 -1
- package/dist/src/css-variables.d.ts +95 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +136 -15
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +230 -1
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +51 -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 +42 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +8 -1
- package/dist/src/embed/spotter-utils.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/mixpanel-service.d.ts +4 -0
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/types.d.ts +573 -11
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +936 -142
- package/dist/tsembed-react.js +935 -141
- package/dist/tsembed.es.js +935 -142
- package/dist/tsembed.js +933 -140
- package/dist/visual-embed-sdk-react-full.d.ts +1147 -44
- package/dist/visual-embed-sdk-react.d.ts +1153 -46
- package/dist/visual-embed-sdk.d.ts +1161 -46
- package/lib/package.json +1 -1
- package/lib/src/css-variables.d.ts +95 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +136 -15
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +60 -38
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +420 -150
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +230 -1
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +31 -17
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +222 -18
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/events.spec.js +635 -0
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.js +152 -1
- package/lib/src/embed/host-events.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +51 -14
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +10 -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 +10 -1
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +218 -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 +42 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +26 -6
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +83 -2
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +8 -1
- package/lib/src/embed/spotter-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-utils.js +12 -0
- package/lib/src/embed/spotter-utils.js.map +1 -1
- package/lib/src/embed/spotter-utils.spec.js +62 -1
- package/lib/src/embed/spotter-utils.spec.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 +29 -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.d.ts +4 -0
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +4 -0
- package/lib/src/mixpanel-service.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 +573 -11
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +519 -2
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/processData.spec.js +93 -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/visual-embed-sdk.d.ts +1161 -46
- package/package.json +1 -1
- package/src/css-variables.ts +118 -0
- package/src/embed/app.spec.ts +530 -183
- package/src/embed/app.ts +209 -66
- package/src/embed/conversation.spec.ts +275 -21
- package/src/embed/conversation.ts +262 -17
- package/src/embed/events.spec.ts +757 -1
- package/src/embed/host-events.spec.ts +194 -0
- package/src/embed/hostEventClient/contracts.ts +57 -14
- package/src/embed/hostEventClient/host-event-client.spec.ts +338 -0
- package/src/embed/hostEventClient/host-event-client.ts +16 -0
- package/src/embed/hostEventClient/utils.spec.ts +204 -0
- package/src/embed/hostEventClient/utils.ts +37 -10
- package/src/embed/liveboard.spec.ts +108 -2
- package/src/embed/liveboard.ts +82 -14
- package/src/embed/spotter-utils.spec.ts +68 -1
- package/src/embed/spotter-utils.ts +16 -1
- 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 +30 -4
- package/src/errors.ts +1 -0
- package/src/index.ts +3 -1
- package/src/mixpanel-service.ts +4 -0
- package/src/react/util.spec.tsx +255 -0
- package/src/types.ts +575 -8
- package/src/utils/processData.spec.ts +97 -0
- package/src/utils/processTrigger.spec.ts +91 -0
package/lib/src/types.d.ts
CHANGED
|
@@ -169,7 +169,9 @@ export declare enum AuthType {
|
|
|
169
169
|
}
|
|
170
170
|
/**
|
|
171
171
|
*
|
|
172
|
-
* **Note**:
|
|
172
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
173
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
|
|
174
|
+
* V4 (Focused) home page experiences.
|
|
173
175
|
*
|
|
174
176
|
*/
|
|
175
177
|
export declare enum HomeLeftNavItem {
|
|
@@ -235,7 +237,14 @@ export declare enum HomeLeftNavItem {
|
|
|
235
237
|
* Available in the V3 navigation experience.
|
|
236
238
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
237
239
|
*/
|
|
238
|
-
Favorites = "favorites"
|
|
240
|
+
Favorites = "favorites",
|
|
241
|
+
/**
|
|
242
|
+
* The *Collections* menu option in
|
|
243
|
+
* the *Insights* left navigation panel.
|
|
244
|
+
* Shown when collections are enabled on the cluster.
|
|
245
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
246
|
+
*/
|
|
247
|
+
Collections = "collections"
|
|
239
248
|
}
|
|
240
249
|
export type DOMSelector = string | HTMLElement;
|
|
241
250
|
/**
|
|
@@ -1182,6 +1191,26 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1182
1191
|
* ```
|
|
1183
1192
|
*/
|
|
1184
1193
|
overrideOrgId?: number;
|
|
1194
|
+
/**
|
|
1195
|
+
* Overrides the browser history behavior for embedding application users.
|
|
1196
|
+
* This parameter changes standard history navigation (pushState) into a
|
|
1197
|
+
* state replacement (replaceState), preventing users from getting trapped in
|
|
1198
|
+
* back-button loops inside the embedded iframe environment.
|
|
1199
|
+
* The overrideHistoryState setting is honored only if the
|
|
1200
|
+
* application is running within an embedded context.
|
|
1201
|
+
*
|
|
1202
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1203
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1204
|
+
* @example
|
|
1205
|
+
* ```js
|
|
1206
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
1207
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1208
|
+
* // ... other embed view config
|
|
1209
|
+
* overrideHistoryState: true,
|
|
1210
|
+
* });
|
|
1211
|
+
* ```
|
|
1212
|
+
*/
|
|
1213
|
+
overrideHistoryState?: boolean;
|
|
1185
1214
|
/**
|
|
1186
1215
|
* Flag to override the *Open Link in New Tab* context
|
|
1187
1216
|
* menu option.
|
|
@@ -1540,7 +1569,9 @@ export interface HomePageConfig {
|
|
|
1540
1569
|
* To specify the modules, import the `HomepageModule` enum.
|
|
1541
1570
|
* For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
|
|
1542
1571
|
*
|
|
1543
|
-
* **Note**:
|
|
1572
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
1573
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
1574
|
+
* and V4 (Focused) home page experiences.
|
|
1544
1575
|
*
|
|
1545
1576
|
* Supported embed types: `AppEmbed`
|
|
1546
1577
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1549,7 +1580,7 @@ export interface HomePageConfig {
|
|
|
1549
1580
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
1550
1581
|
*
|
|
1551
1582
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1552
|
-
* ... //
|
|
1583
|
+
* ... // V3 navigation and home page experience attributes
|
|
1553
1584
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
1554
1585
|
* //...other embed view configuration attributes
|
|
1555
1586
|
* })
|
|
@@ -1560,8 +1591,11 @@ export interface HomePageConfig {
|
|
|
1560
1591
|
* Reorder home page modules.
|
|
1561
1592
|
* To specify the modules, import the `HomepageModule` enum.
|
|
1562
1593
|
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
1563
|
-
* HomepageModule.Watchlist]`
|
|
1564
|
-
*
|
|
1594
|
+
* HomepageModule.Watchlist]`
|
|
1595
|
+
*
|
|
1596
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
1597
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
1598
|
+
* and V4 (Focused) home page experiences.
|
|
1565
1599
|
*
|
|
1566
1600
|
* Supported embed types: `AppEmbed`
|
|
1567
1601
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1570,7 +1604,7 @@ export interface HomePageConfig {
|
|
|
1570
1604
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
1571
1605
|
*
|
|
1572
1606
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1573
|
-
* ...//
|
|
1607
|
+
* ...//V3 navigation and home page experience attributes
|
|
1574
1608
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
1575
1609
|
* //... other embed view configuration attributes
|
|
1576
1610
|
* })
|
|
@@ -1582,7 +1616,9 @@ export interface HomePageConfig {
|
|
|
1582
1616
|
* on the home page left navigation panel.
|
|
1583
1617
|
* To specify the menu items, import the `HomeLeftNavItem` enum.
|
|
1584
1618
|
*
|
|
1585
|
-
* **Note**:
|
|
1619
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
1620
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
1621
|
+
* and V4 (Focused) home page experiences.
|
|
1586
1622
|
*
|
|
1587
1623
|
* Supported embed types: `AppEmbed`
|
|
1588
1624
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1958,6 +1994,24 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1958
1994
|
* ```
|
|
1959
1995
|
*/
|
|
1960
1996
|
isCentralizedLiveboardFilterUXEnabled?: boolean;
|
|
1997
|
+
/**
|
|
1998
|
+
* This flag is used to enable or disable scoped Liveboard filtering.
|
|
1999
|
+
* When enabled, filters and parameters can be scoped to a group of
|
|
2000
|
+
* visualizations on a Liveboard, in addition to the Liveboard and
|
|
2001
|
+
* tab levels.
|
|
2002
|
+
*
|
|
2003
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2004
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
2005
|
+
* @example
|
|
2006
|
+
* ```js
|
|
2007
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
2008
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2009
|
+
* ... // other embed view config
|
|
2010
|
+
* isScopedLiveboardFilteringEnabled: true,
|
|
2011
|
+
* })
|
|
2012
|
+
* ```
|
|
2013
|
+
*/
|
|
2014
|
+
isScopedLiveboardFilteringEnabled?: boolean;
|
|
1961
2015
|
/**
|
|
1962
2016
|
* This flag is used to enable or disable the link parameters in liveboard.
|
|
1963
2017
|
*
|
|
@@ -2156,7 +2210,9 @@ export declare enum RuntimeFilterOp {
|
|
|
2156
2210
|
* via `hiddenHomepageModules` and reordered via
|
|
2157
2211
|
* `reorderedHomepageModules`.
|
|
2158
2212
|
*
|
|
2159
|
-
* **Note**:
|
|
2213
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2214
|
+
* deprecated. These modules apply to V3 (ModularWithStylingChanges) and
|
|
2215
|
+
* V4 (Focused) home page experiences.
|
|
2160
2216
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2161
2217
|
*/
|
|
2162
2218
|
export declare enum HomepageModule {
|
|
@@ -3145,11 +3201,19 @@ export declare enum EmbedEvent {
|
|
|
3145
3201
|
* Emitted when a user changes any filter on a Liveboard.
|
|
3146
3202
|
* Returns filter type and name, column name and ID, and runtime
|
|
3147
3203
|
* filter details.
|
|
3204
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
3205
|
+
* scope of the changed filter. It contains a `level` (`LIVEBOARD`,
|
|
3206
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
3207
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
3208
|
+
* is no `targetId`, since the filter applies to the whole Liveboard.
|
|
3209
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
3210
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
3148
3211
|
* @example
|
|
3149
3212
|
*
|
|
3150
3213
|
* ```js
|
|
3151
3214
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3152
3215
|
* console.log('payload', payload);
|
|
3216
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
3153
3217
|
* })
|
|
3154
3218
|
* ```
|
|
3155
3219
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
@@ -3341,9 +3405,17 @@ export declare enum EmbedEvent {
|
|
|
3341
3405
|
/**
|
|
3342
3406
|
* Emitted when parameter changes in an Answer
|
|
3343
3407
|
* or Liveboard.
|
|
3408
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
3409
|
+
* scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
|
|
3410
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
3411
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
3412
|
+
* is no `targetId`, since the parameter applies to the whole Liveboard.
|
|
3413
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
3414
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
3344
3415
|
* ```js
|
|
3345
3416
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
3346
3417
|
* console.log('payload', payload);
|
|
3418
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
3347
3419
|
* })
|
|
3348
3420
|
* ```
|
|
3349
3421
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
@@ -3645,6 +3717,158 @@ export declare enum EmbedEvent {
|
|
|
3645
3717
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3646
3718
|
*/
|
|
3647
3719
|
SpotterConversationDeleted = "spotterConversationDeleted",
|
|
3720
|
+
/**
|
|
3721
|
+
* Emitted when the header Share button is clicked. Fires `Start` then `End`
|
|
3722
|
+
* to bracket the interaction. App→host counterpart of the
|
|
3723
|
+
* `ShareSpotterConversation` host event (user-driven vs programmatic open).
|
|
3724
|
+
* @example
|
|
3725
|
+
* ```js
|
|
3726
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
|
|
3727
|
+
* // payload: { convId: string }
|
|
3728
|
+
* })
|
|
3729
|
+
* ```
|
|
3730
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3731
|
+
*/
|
|
3732
|
+
SpotterShareConversationButtonHeaderClicked = "spotterShareConversationButtonHeaderClicked",
|
|
3733
|
+
/**
|
|
3734
|
+
* Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
|
|
3735
|
+
* to bracket the interaction.
|
|
3736
|
+
* @example
|
|
3737
|
+
* ```js
|
|
3738
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
|
|
3739
|
+
* // payload: { convId: string }
|
|
3740
|
+
* })
|
|
3741
|
+
* ```
|
|
3742
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3743
|
+
*/
|
|
3744
|
+
SpotterShareConversationMenuItemSidebarClicked = "spotterShareConversationMenuItemSidebarClicked",
|
|
3745
|
+
/**
|
|
3746
|
+
* Emitted when a Spotter conversation is shared (recipients added, or a new
|
|
3747
|
+
* share created). The host builds its own link from shareId/convId + its
|
|
3748
|
+
* configured CONVERSATION_URL — no link string is sent. Distinct from
|
|
3749
|
+
* `SpotterShareModalConfirmButtonClicked`, which fires at click time before
|
|
3750
|
+
* the save resolves.
|
|
3751
|
+
* @example
|
|
3752
|
+
* ```js
|
|
3753
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
|
|
3754
|
+
* // payload: { convId: string, shareId: string,
|
|
3755
|
+
* // recipientsAdded: string[], recipientsRemoved: string[] }
|
|
3756
|
+
* })
|
|
3757
|
+
* ```
|
|
3758
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3759
|
+
*/
|
|
3760
|
+
SpotterConversationShared = "spotterConversationShared",
|
|
3761
|
+
/**
|
|
3762
|
+
* Emitted when access to a shared Spotter conversation is revoked
|
|
3763
|
+
* (recipients removed). `fullyRevoked` is true when the last sharee is removed
|
|
3764
|
+
* and the share is deleted entirely.
|
|
3765
|
+
* @example
|
|
3766
|
+
* ```js
|
|
3767
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
|
|
3768
|
+
* // payload: { convId: string, shareId: string,
|
|
3769
|
+
* // recipientsRemoved: string[], fullyRevoked: boolean }
|
|
3770
|
+
* })
|
|
3771
|
+
* ```
|
|
3772
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3773
|
+
*/
|
|
3774
|
+
SpotterConversationShareRevoked = "spotterConversationShareRevoked",
|
|
3775
|
+
/**
|
|
3776
|
+
* Emitted when a recipient opens a shared Spotter conversation (read-only
|
|
3777
|
+
* view). No shareId available viewer-side.
|
|
3778
|
+
* @example
|
|
3779
|
+
* ```js
|
|
3780
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
|
|
3781
|
+
* // payload: { convId: string, sourceConvId: string }
|
|
3782
|
+
* // convId = resolved snapshot conv id; sourceConvId = the shared URL id
|
|
3783
|
+
* })
|
|
3784
|
+
* ```
|
|
3785
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3786
|
+
*/
|
|
3787
|
+
SpotterSharedConversationViewed = "spotterSharedConversationViewed",
|
|
3788
|
+
/**
|
|
3789
|
+
* Emitted when the user toggles the share-modal "include new messages since
|
|
3790
|
+
* last shared version" checkbox.
|
|
3791
|
+
* @example
|
|
3792
|
+
* ```js
|
|
3793
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
|
|
3794
|
+
* // payload: { convId: string, includeNewMessages: boolean }
|
|
3795
|
+
* })
|
|
3796
|
+
* ```
|
|
3797
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3798
|
+
*/
|
|
3799
|
+
SpotterShareIncludeNewMessagesCheckboxToggled = "spotterShareIncludeNewMessagesCheckboxToggled",
|
|
3800
|
+
/**
|
|
3801
|
+
* Emitted when the user dismisses the stale-snapshot info banner via its
|
|
3802
|
+
* cross (distinct from the include-new-messages checkbox toggle).
|
|
3803
|
+
* @example
|
|
3804
|
+
* ```js
|
|
3805
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
|
|
3806
|
+
* // payload: { convId: string }
|
|
3807
|
+
* })
|
|
3808
|
+
* ```
|
|
3809
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3810
|
+
*/
|
|
3811
|
+
SpotterShareStaleInfoBannerDismissed = "spotterShareStaleInfoBannerDismissed",
|
|
3812
|
+
/**
|
|
3813
|
+
* Emitted when the modal Share (confirm) button is clicked — fires at click
|
|
3814
|
+
* time, before the save resolves. Distinct from the `SpotterConversationShared`
|
|
3815
|
+
* / `SpotterConversationShareRevoked` result events.
|
|
3816
|
+
* @example
|
|
3817
|
+
* ```js
|
|
3818
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
|
|
3819
|
+
* // payload: { convId: string }
|
|
3820
|
+
* })
|
|
3821
|
+
* ```
|
|
3822
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3823
|
+
*/
|
|
3824
|
+
SpotterShareModalConfirmButtonClicked = "spotterShareModalConfirmButtonClicked",
|
|
3825
|
+
/**
|
|
3826
|
+
* Emitted when the share modal is dismissed via the Cancel button.
|
|
3827
|
+
* @example
|
|
3828
|
+
* ```js
|
|
3829
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
|
|
3830
|
+
* // payload: { convId: string }
|
|
3831
|
+
* })
|
|
3832
|
+
* ```
|
|
3833
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3834
|
+
*/
|
|
3835
|
+
SpotterShareModalCancelButtonClicked = "spotterShareModalCancelButtonClicked",
|
|
3836
|
+
/**
|
|
3837
|
+
* Emitted when a recipient leaves the read-only shared view via the Exit
|
|
3838
|
+
* button.
|
|
3839
|
+
* @example
|
|
3840
|
+
* ```js
|
|
3841
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
|
|
3842
|
+
* // payload: { convId: string }
|
|
3843
|
+
* })
|
|
3844
|
+
* ```
|
|
3845
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3846
|
+
*/
|
|
3847
|
+
SpotterSharedConversationExitButtonClicked = "spotterSharedConversationExitButtonClicked",
|
|
3848
|
+
/**
|
|
3849
|
+
* Emitted when a Spotter conversation is pinned.
|
|
3850
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
3851
|
+
* @example
|
|
3852
|
+
* ```js
|
|
3853
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
|
|
3854
|
+
* console.log('Conversation pinned', payload);
|
|
3855
|
+
* // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
|
|
3856
|
+
* })
|
|
3857
|
+
* ```
|
|
3858
|
+
*/
|
|
3859
|
+
SpotterConversationPinned = "spotterConversationPinned",
|
|
3860
|
+
/**
|
|
3861
|
+
* Emitted when a Spotter conversation is unpinned.
|
|
3862
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
3863
|
+
* @example
|
|
3864
|
+
* ```js
|
|
3865
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
|
|
3866
|
+
* console.log('Conversation unpinned', payload);
|
|
3867
|
+
* // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
|
|
3868
|
+
* })
|
|
3869
|
+
* ```
|
|
3870
|
+
*/
|
|
3871
|
+
SpotterConversationUnpinned = "spotterConversationUnpinned",
|
|
3648
3872
|
/**
|
|
3649
3873
|
* Emitted when a Spotter conversation is selected/clicked.
|
|
3650
3874
|
* @example
|
|
@@ -3657,6 +3881,30 @@ export declare enum EmbedEvent {
|
|
|
3657
3881
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3658
3882
|
*/
|
|
3659
3883
|
SpotterConversationSelected = "spotterConversationSelected",
|
|
3884
|
+
/**
|
|
3885
|
+
* Emitted when the Spotter agent finishes streaming/rendering a response.
|
|
3886
|
+
* Includes the conversation and message identifiers so the host app can
|
|
3887
|
+
* fetch the full conversation history via the REST API if needed.
|
|
3888
|
+
*
|
|
3889
|
+
* The payload data has the shape `{ convId: string, messageId: string }`.
|
|
3890
|
+
*
|
|
3891
|
+
* Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
|
|
3892
|
+
* inside the full application).
|
|
3893
|
+
* @example
|
|
3894
|
+
* ```js
|
|
3895
|
+
* spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
3896
|
+
* console.log('Spotter response complete', payload);
|
|
3897
|
+
* })
|
|
3898
|
+
* ```
|
|
3899
|
+
* @example
|
|
3900
|
+
* ```js
|
|
3901
|
+
* appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
3902
|
+
* console.log('Spotter response complete', payload);
|
|
3903
|
+
* })
|
|
3904
|
+
* ```
|
|
3905
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3906
|
+
*/
|
|
3907
|
+
SpotterResponseComplete = "spotterResponseComplete",
|
|
3660
3908
|
/**
|
|
3661
3909
|
* @hidden
|
|
3662
3910
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -4136,6 +4384,17 @@ export declare enum HostEvent {
|
|
|
4136
4384
|
* name: string,
|
|
4137
4385
|
* type: ATTRIBUTE/MEASURE,
|
|
4138
4386
|
* dataType: INT64/CHAR/DATE }
|
|
4387
|
+
*
|
|
4388
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
4389
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
4390
|
+
* scoped filter is opened. Available from SDK: 1.53.0 |
|
|
4391
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
4392
|
+
*
|
|
4393
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
4394
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
4395
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
4396
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
4397
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
4139
4398
|
* @example
|
|
4140
4399
|
* ```js
|
|
4141
4400
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
@@ -4148,6 +4407,14 @@ export declare enum HostEvent {
|
|
|
4148
4407
|
* ```
|
|
4149
4408
|
* @example
|
|
4150
4409
|
* ```js
|
|
4410
|
+
* // Open a filter scoped to a specific Liveboard tab
|
|
4411
|
+
* liveboardEmbed.trigger(HostEvent.OpenFilter, {
|
|
4412
|
+
* column: { columnId: '<column-GUID>' },
|
|
4413
|
+
* applicability: { level: 'TAB', targetId: '<tab-GUID>' }
|
|
4414
|
+
* });
|
|
4415
|
+
* ```
|
|
4416
|
+
* @example
|
|
4417
|
+
* ```js
|
|
4151
4418
|
* // Open filter from search context
|
|
4152
4419
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
4153
4420
|
* searchEmbed.trigger(HostEvent.OpenFilter, {
|
|
@@ -4157,6 +4424,38 @@ export declare enum HostEvent {
|
|
|
4157
4424
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4158
4425
|
*/
|
|
4159
4426
|
OpenFilter = "openFilter",
|
|
4427
|
+
/**
|
|
4428
|
+
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
4429
|
+
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
4430
|
+
* @param - Includes the following keys:
|
|
4431
|
+
* - `parameter`: An object identifying the parameter to open, for
|
|
4432
|
+
* example, `{ parameterId: '<parameter-GUID>' }`.
|
|
4433
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
4434
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
4435
|
+
* scoped parameter is opened. Includes the following attributes:
|
|
4436
|
+
*
|
|
4437
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
4438
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
4439
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
4440
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
4441
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
4442
|
+
* @example
|
|
4443
|
+
* ```js
|
|
4444
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
4445
|
+
* parameter: { parameterId: '<parameter-GUID>' }
|
|
4446
|
+
* });
|
|
4447
|
+
* ```
|
|
4448
|
+
* @example
|
|
4449
|
+
* ```js
|
|
4450
|
+
* // Open a parameter scoped to a specific group
|
|
4451
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
4452
|
+
* parameter: { parameterId: '<parameter-GUID>' },
|
|
4453
|
+
* applicability: { level: 'GROUP', targetId: '<group-GUID>' }
|
|
4454
|
+
* });
|
|
4455
|
+
* ```
|
|
4456
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
4457
|
+
*/
|
|
4458
|
+
OpenParameter = "openParameter",
|
|
4160
4459
|
/**
|
|
4161
4460
|
* Add columns to the current search query.
|
|
4162
4461
|
* @param - { columnIds: string[] }
|
|
@@ -5220,6 +5519,14 @@ export declare enum HostEvent {
|
|
|
5220
5519
|
/**
|
|
5221
5520
|
* Get details of filters applied on the Liveboard.
|
|
5222
5521
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
5522
|
+
* Each Liveboard filter includes an optional `applicability` attribute
|
|
5523
|
+
* indicating the scope of the filter. It contains a `level`
|
|
5524
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
5525
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
5526
|
+
* level there is no `targetId`, since the filter applies to the
|
|
5527
|
+
* whole Liveboard.
|
|
5528
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
5529
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
5223
5530
|
* @example
|
|
5224
5531
|
* ```js
|
|
5225
5532
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
@@ -5259,6 +5566,16 @@ export declare enum HostEvent {
|
|
|
5259
5566
|
*
|
|
5260
5567
|
* `type` - To update filters for date time, specify the date format type.
|
|
5261
5568
|
* For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
|
|
5569
|
+
*
|
|
5570
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
5571
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
5572
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
5573
|
+
*
|
|
5574
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5575
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5576
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5577
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
5578
|
+
* Liveboard.
|
|
5262
5579
|
* @example
|
|
5263
5580
|
* ```js
|
|
5264
5581
|
*
|
|
@@ -5335,6 +5652,21 @@ export declare enum HostEvent {
|
|
|
5335
5652
|
* }
|
|
5336
5653
|
* }, ContextType.Liveboard);
|
|
5337
5654
|
* ```
|
|
5655
|
+
* @example
|
|
5656
|
+
* ```js
|
|
5657
|
+
* // Scope the filter to a specific Liveboard tab
|
|
5658
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
5659
|
+
* filter: {
|
|
5660
|
+
* column: "item type",
|
|
5661
|
+
* oper: "IN",
|
|
5662
|
+
* values: ["bags", "shirts"],
|
|
5663
|
+
* applicability: {
|
|
5664
|
+
* level: "TAB",
|
|
5665
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
5666
|
+
* }
|
|
5667
|
+
* }
|
|
5668
|
+
* });
|
|
5669
|
+
* ```
|
|
5338
5670
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
5339
5671
|
*/
|
|
5340
5672
|
UpdateFilters = "updateFilters",
|
|
@@ -5359,6 +5691,28 @@ export declare enum HostEvent {
|
|
|
5359
5691
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
5360
5692
|
*/
|
|
5361
5693
|
GetTabs = "getTabs",
|
|
5694
|
+
/**
|
|
5695
|
+
* Get group details for the current Liveboard.
|
|
5696
|
+
* Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
|
|
5697
|
+
* @example
|
|
5698
|
+
* ```js
|
|
5699
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
|
|
5700
|
+
* console.log(
|
|
5701
|
+
* groupDetails // GroupDetails of current Liveboard
|
|
5702
|
+
* );
|
|
5703
|
+
* })
|
|
5704
|
+
* ```
|
|
5705
|
+
* @example
|
|
5706
|
+
* ```js
|
|
5707
|
+
* // Get groups from liveboard context
|
|
5708
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5709
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
|
|
5710
|
+
* console.log('groups', groupDetails);
|
|
5711
|
+
* });
|
|
5712
|
+
* ```
|
|
5713
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
5714
|
+
*/
|
|
5715
|
+
GetGroups = "getGroups",
|
|
5362
5716
|
/**
|
|
5363
5717
|
* Set the visible tabs on a Liveboard.
|
|
5364
5718
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
@@ -5486,6 +5840,15 @@ export declare enum HostEvent {
|
|
|
5486
5840
|
* - `name`: Name of the parameter.
|
|
5487
5841
|
* - `value`: The value to set for the parameter.
|
|
5488
5842
|
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
5843
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
5844
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
5845
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
5846
|
+
*
|
|
5847
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5848
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5849
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5850
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
5851
|
+
* Liveboard.
|
|
5489
5852
|
*
|
|
5490
5853
|
* @example
|
|
5491
5854
|
* ```js
|
|
@@ -5497,6 +5860,18 @@ export declare enum HostEvent {
|
|
|
5497
5860
|
* ```
|
|
5498
5861
|
* @example
|
|
5499
5862
|
* ```js
|
|
5863
|
+
* // Scope the parameter to a specific Liveboard tab
|
|
5864
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
5865
|
+
* name: "Integer Range Param",
|
|
5866
|
+
* value: 10,
|
|
5867
|
+
* applicability: {
|
|
5868
|
+
* level: "TAB",
|
|
5869
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
5870
|
+
* }
|
|
5871
|
+
* }])
|
|
5872
|
+
* ```
|
|
5873
|
+
* @example
|
|
5874
|
+
* ```js
|
|
5500
5875
|
* // Update parameters from liveboard context
|
|
5501
5876
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5502
5877
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -5510,6 +5885,14 @@ export declare enum HostEvent {
|
|
|
5510
5885
|
UpdateParameters = "UpdateParameters",
|
|
5511
5886
|
/**
|
|
5512
5887
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
5888
|
+
* Each parameter includes an optional `applicability` attribute
|
|
5889
|
+
* indicating the scope of the parameter. It contains a `level`
|
|
5890
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
5891
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
5892
|
+
* level there is no `targetId`, since the parameter applies to the
|
|
5893
|
+
* whole Liveboard.
|
|
5894
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
5895
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
5513
5896
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5514
5897
|
* ```js
|
|
5515
5898
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
@@ -5776,6 +6159,36 @@ export declare enum HostEvent {
|
|
|
5776
6159
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5777
6160
|
*/
|
|
5778
6161
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
6162
|
+
/**
|
|
6163
|
+
* Opens the Spotter share-conversation modal for the given conversation.
|
|
6164
|
+
* `conversationId` is **mandatory** — you must pass the id of the
|
|
6165
|
+
* conversation to share. Also no-op when sharing is disabled
|
|
6166
|
+
* (enableShareConversation off) or when already in the read-only shared view.
|
|
6167
|
+
* @example
|
|
6168
|
+
* ```js
|
|
6169
|
+
* spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
|
|
6170
|
+
* ```
|
|
6171
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6172
|
+
*/
|
|
6173
|
+
ShareSpotterConversation = "ShareSpotterConversation",
|
|
6174
|
+
/**
|
|
6175
|
+
* Closes the Spotter share-conversation modal. No-op if none is open.
|
|
6176
|
+
* @example
|
|
6177
|
+
* ```js
|
|
6178
|
+
* spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
|
|
6179
|
+
* ```
|
|
6180
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6181
|
+
*/
|
|
6182
|
+
CloseSpotterShareConversation = "CloseSpotterShareConversation",
|
|
6183
|
+
/**
|
|
6184
|
+
* Exits the read-only shared-conversation view.
|
|
6185
|
+
* @example
|
|
6186
|
+
* ```js
|
|
6187
|
+
* spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
|
|
6188
|
+
* ```
|
|
6189
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6190
|
+
*/
|
|
6191
|
+
ExitSpotterSharedConversation = "ExitSpotterSharedConversation",
|
|
5779
6192
|
/**
|
|
5780
6193
|
* Deletes the last prompt in spotter embed.
|
|
5781
6194
|
* @example
|
|
@@ -5871,6 +6284,41 @@ export declare enum HostEvent {
|
|
|
5871
6284
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5872
6285
|
*/
|
|
5873
6286
|
StartNewSpotterConversation = "StartNewSpotterConversation",
|
|
6287
|
+
/**
|
|
6288
|
+
* Pins a saved Spotter conversation so it floats to the top of the past
|
|
6289
|
+
* conversations sidebar. The `conversationId` of the conversation to pin is
|
|
6290
|
+
* required.
|
|
6291
|
+
*
|
|
6292
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
6293
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
6294
|
+
* instance.
|
|
6295
|
+
*
|
|
6296
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6297
|
+
* @example
|
|
6298
|
+
* ```js
|
|
6299
|
+
* spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
|
|
6300
|
+
* conversationId: '<conversation-id>',
|
|
6301
|
+
* });
|
|
6302
|
+
* ```
|
|
6303
|
+
*/
|
|
6304
|
+
PinSpotterConversation = "PinSpotterConversation",
|
|
6305
|
+
/**
|
|
6306
|
+
* Unpins a previously pinned Spotter conversation. The `conversationId` of the
|
|
6307
|
+
* conversation to unpin is required.
|
|
6308
|
+
*
|
|
6309
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
6310
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
6311
|
+
* instance.
|
|
6312
|
+
*
|
|
6313
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6314
|
+
* @example
|
|
6315
|
+
* ```js
|
|
6316
|
+
* spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
|
|
6317
|
+
* conversationId: '<conversation-id>',
|
|
6318
|
+
* });
|
|
6319
|
+
* ```
|
|
6320
|
+
*/
|
|
6321
|
+
UnpinSpotterConversation = "UnpinSpotterConversation",
|
|
5874
6322
|
/**
|
|
5875
6323
|
* @hidden
|
|
5876
6324
|
* Get the current context of the embedded page.
|
|
@@ -6084,6 +6532,7 @@ export declare enum Param {
|
|
|
6084
6532
|
SpotterEnabled = "isSpotterExperienceEnabled",
|
|
6085
6533
|
IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled",
|
|
6086
6534
|
OverrideOrgId = "orgId",
|
|
6535
|
+
OverrideHistoryState = "overrideHistoryState",
|
|
6087
6536
|
OauthPollingInterval = "oAuthPollingInterval",
|
|
6088
6537
|
IsForceRedirect = "isForceRedirect",
|
|
6089
6538
|
DataSourceId = "dataSourceId",
|
|
@@ -6101,9 +6550,12 @@ export declare enum Param {
|
|
|
6101
6550
|
isGranularXLSXCSVSchedulesEnabled = "isGranularXLSXCSVSchedulesEnabled",
|
|
6102
6551
|
isSendNowLiveboardSchedulingEnabled = "isSendNowLiveboardSchedulingEnabled",
|
|
6103
6552
|
isCentralizedLiveboardFilterUXEnabled = "isCentralizedLiveboardFilterUXEnabled",
|
|
6553
|
+
isScopedLiveboardFilteringEnabled = "isScopedLiveboardFilteringEnabled",
|
|
6104
6554
|
isLinkParametersEnabled = "isLinkParametersEnabled",
|
|
6105
6555
|
EnablePastConversationsSidebar = "enablePastConversationsSidebar",
|
|
6106
6556
|
UpdatedSpotterChatPrompt = "updatedSpotterChatPrompt",
|
|
6557
|
+
ShowSpotterRadiance = "showSpotterRadiance",
|
|
6558
|
+
DefaultQueryMode = "defaultQueryMode",
|
|
6107
6559
|
EnableStopAnswerGenerationEmbed = "enableStopAnswerGenerationEmbed",
|
|
6108
6560
|
SpotterSidebarTitle = "spotterSidebarTitle",
|
|
6109
6561
|
SpotterSidebarDefaultExpanded = "spotterSidebarDefaultExpanded",
|
|
@@ -6122,7 +6574,9 @@ export declare enum Param {
|
|
|
6122
6574
|
EnableLiveboardDataCache = "enableLiveboardDataCache",
|
|
6123
6575
|
SpotterFileUploadEnabled = "spotterFileUploadEnabled",
|
|
6124
6576
|
SpotterFileUploadFileTypes = "spotterFileUploadFileTypes",
|
|
6125
|
-
IsStarterPromptsEnabled = "enableStarterPrompts"
|
|
6577
|
+
IsStarterPromptsEnabled = "enableStarterPrompts",
|
|
6578
|
+
UpdatedSpotterExperience = "updatedSpotterExperience",
|
|
6579
|
+
SpotterDataSources = "spotterDataSources"
|
|
6126
6580
|
}
|
|
6127
6581
|
/**
|
|
6128
6582
|
* Configuration for allowed file types in Spotter file upload.
|
|
@@ -7391,6 +7845,19 @@ export declare enum Action {
|
|
|
7391
7845
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
7392
7846
|
*/
|
|
7393
7847
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
7848
|
+
/**
|
|
7849
|
+
* Action ID to show, hide, or disable all filter surfaces on a Liveboard,
|
|
7850
|
+
* including filter, parameter, and cross-filter chips at the liveboard,
|
|
7851
|
+
* tab, and group levels. Parameter and cross-filter chips are hide-only.
|
|
7852
|
+
*
|
|
7853
|
+
* @example
|
|
7854
|
+
* ```js
|
|
7855
|
+
* hiddenActions: [Action.AllLiveboardFilters]
|
|
7856
|
+
* disabledActions: [Action.AllLiveboardFilters]
|
|
7857
|
+
* ```
|
|
7858
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
7859
|
+
*/
|
|
7860
|
+
AllLiveboardFilters = "allLiveboardFilters",
|
|
7394
7861
|
/**
|
|
7395
7862
|
* The **Data model instructions** button on the Spotter interface.
|
|
7396
7863
|
* Allows opening the data model instructions modal.
|
|
@@ -7726,6 +8193,89 @@ export declare enum Action {
|
|
|
7726
8193
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7727
8194
|
*/
|
|
7728
8195
|
SpotterChatRename = "spotterChatRename",
|
|
8196
|
+
/**
|
|
8197
|
+
* Controls visibility and disable state of the Spotter conversation Share
|
|
8198
|
+
* button in the chat header. Only takes effect once sharing is enabled
|
|
8199
|
+
* (enableShareConversation on).
|
|
8200
|
+
* @example
|
|
8201
|
+
* ```js
|
|
8202
|
+
* disabledActions: [Action.SpotterShareConversationButtonHeader]
|
|
8203
|
+
* ```
|
|
8204
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8205
|
+
*/
|
|
8206
|
+
SpotterShareConversationButtonHeader = "spotterShareConversationButtonHeader",
|
|
8207
|
+
/**
|
|
8208
|
+
* Controls visibility and disable state of the Share item in the Spotter
|
|
8209
|
+
* conversation history (sidebar) edit menu. Independent of the header button
|
|
8210
|
+
* above, so a host can show Share in one entry point and hide it in the other.
|
|
8211
|
+
* @example
|
|
8212
|
+
* ```js
|
|
8213
|
+
* disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
|
|
8214
|
+
* ```
|
|
8215
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8216
|
+
*/
|
|
8217
|
+
SpotterShareConversationMenuItemSidebar = "spotterShareConversationMenuItemSidebar",
|
|
8218
|
+
/**
|
|
8219
|
+
* Controls visibility of the entire read-only shared-conversation data-access
|
|
8220
|
+
* banner shown when a recipient opens a shared view. Hide-only.
|
|
8221
|
+
* @example
|
|
8222
|
+
* ```js
|
|
8223
|
+
* hiddenActions: [Action.SpotterSharedConversationBanner]
|
|
8224
|
+
* ```
|
|
8225
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8226
|
+
*/
|
|
8227
|
+
SpotterSharedConversationBanner = "spotterSharedConversationBanner",
|
|
8228
|
+
/**
|
|
8229
|
+
* Controls visibility and disable state of the cross/close button on the
|
|
8230
|
+
* read-only shared-conversation data-access banner (keeps the banner itself).
|
|
8231
|
+
* @example
|
|
8232
|
+
* ```js
|
|
8233
|
+
* hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
|
|
8234
|
+
* ```
|
|
8235
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8236
|
+
*/
|
|
8237
|
+
SpotterSharedConversationBannerDismissButton = "spotterSharedConversationBannerDismissButton",
|
|
8238
|
+
/**
|
|
8239
|
+
* Controls visibility and disable state of the Exit button in the read-only
|
|
8240
|
+
* shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
|
|
8241
|
+
* host event.
|
|
8242
|
+
* @example
|
|
8243
|
+
* ```js
|
|
8244
|
+
* hiddenActions: [Action.SpotterSharedConversationExitButton]
|
|
8245
|
+
* ```
|
|
8246
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8247
|
+
*/
|
|
8248
|
+
SpotterSharedConversationExitButton = "spotterSharedConversationExitButton",
|
|
8249
|
+
/**
|
|
8250
|
+
* Controls visibility of the share-modal footer note ("Chat will be shared up
|
|
8251
|
+
* to the current moment…"). Hide-only.
|
|
8252
|
+
* @example
|
|
8253
|
+
* ```js
|
|
8254
|
+
* hiddenActions: [Action.SpotterShareUpToCurrentInfo]
|
|
8255
|
+
* ```
|
|
8256
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8257
|
+
*/
|
|
8258
|
+
SpotterShareUpToCurrentInfo = "spotterShareUpToCurrentInfo",
|
|
8259
|
+
/**
|
|
8260
|
+
* Controls visibility and disable state of the share-modal "include new
|
|
8261
|
+
* messages since last shared version" checkbox.
|
|
8262
|
+
* @example
|
|
8263
|
+
* ```js
|
|
8264
|
+
* disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
|
|
8265
|
+
* ```
|
|
8266
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8267
|
+
*/
|
|
8268
|
+
SpotterShareIncludeNewMessagesCheckbox = "spotterShareIncludeNewMessagesCheckbox",
|
|
8269
|
+
/**
|
|
8270
|
+
* Controls visibility and disable state of the cross on the share-modal
|
|
8271
|
+
* stale-snapshot info banner.
|
|
8272
|
+
* @example
|
|
8273
|
+
* ```js
|
|
8274
|
+
* hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
|
|
8275
|
+
* ```
|
|
8276
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8277
|
+
*/
|
|
8278
|
+
SpotterShareStaleInfoBannerDismissButton = "spotterShareStaleInfoBannerDismissButton",
|
|
7729
8279
|
/**
|
|
7730
8280
|
* Controls visibility and disable state of the delete action
|
|
7731
8281
|
* in the Spotter conversation edit menu.
|
|
@@ -7736,6 +8286,16 @@ export declare enum Action {
|
|
|
7736
8286
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7737
8287
|
*/
|
|
7738
8288
|
SpotterChatDelete = "spotterChatDelete",
|
|
8289
|
+
/**
|
|
8290
|
+
* Controls visibility and disable state of the pin/unpin action
|
|
8291
|
+
* in the Spotter conversation edit menu.
|
|
8292
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
8293
|
+
* @example
|
|
8294
|
+
* ```js
|
|
8295
|
+
* disabledActions: [Action.SpotterChatPin]
|
|
8296
|
+
* ```
|
|
8297
|
+
*/
|
|
8298
|
+
SpotterChatPin = "spotterChatPin",
|
|
7739
8299
|
/**
|
|
7740
8300
|
* Controls visibility and disable state of the documentation/best practices
|
|
7741
8301
|
* link in the Spotter sidebar footer.
|
|
@@ -8267,7 +8827,9 @@ export declare enum EmbedErrorCodes {
|
|
|
8267
8827
|
/** UpdateFilters payload is invalid - missing or malformed filter/filters */
|
|
8268
8828
|
UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
|
|
8269
8829
|
/** DrillDown payload is invalid - missing or malformed points */
|
|
8270
|
-
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
|
|
8830
|
+
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD",
|
|
8831
|
+
/** UpdateParameters payload is invalid - malformed applicability */
|
|
8832
|
+
UPDATEPARAMETERS_INVALID_PAYLOAD = "UPDATEPARAMETERS_INVALID_PAYLOAD"
|
|
8271
8833
|
}
|
|
8272
8834
|
/**
|
|
8273
8835
|
* Error event object emitted when an error occurs in an embedded component.
|