@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/src/types.ts
CHANGED
|
@@ -176,7 +176,9 @@ export enum AuthType {
|
|
|
176
176
|
}
|
|
177
177
|
/**
|
|
178
178
|
*
|
|
179
|
-
* **Note**:
|
|
179
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
180
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
|
|
181
|
+
* V4 (Focused) home page experiences.
|
|
180
182
|
*
|
|
181
183
|
*/
|
|
182
184
|
|
|
@@ -244,6 +246,13 @@ export enum HomeLeftNavItem {
|
|
|
244
246
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
245
247
|
*/
|
|
246
248
|
Favorites = 'favorites',
|
|
249
|
+
/**
|
|
250
|
+
* The *Collections* menu option in
|
|
251
|
+
* the *Insights* left navigation panel.
|
|
252
|
+
* Shown when collections are enabled on the cluster.
|
|
253
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
254
|
+
*/
|
|
255
|
+
Collections = 'collections',
|
|
247
256
|
}
|
|
248
257
|
export type DOMSelector = string | HTMLElement;
|
|
249
258
|
|
|
@@ -1220,6 +1229,26 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1220
1229
|
* ```
|
|
1221
1230
|
*/
|
|
1222
1231
|
overrideOrgId?: number;
|
|
1232
|
+
/**
|
|
1233
|
+
* Overrides the browser history behavior for embedding application users.
|
|
1234
|
+
* This parameter changes standard history navigation (pushState) into a
|
|
1235
|
+
* state replacement (replaceState), preventing users from getting trapped in
|
|
1236
|
+
* back-button loops inside the embedded iframe environment.
|
|
1237
|
+
* The overrideHistoryState setting is honored only if the
|
|
1238
|
+
* application is running within an embedded context.
|
|
1239
|
+
*
|
|
1240
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1241
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1242
|
+
* @example
|
|
1243
|
+
* ```js
|
|
1244
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
1245
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1246
|
+
* // ... other embed view config
|
|
1247
|
+
* overrideHistoryState: true,
|
|
1248
|
+
* });
|
|
1249
|
+
* ```
|
|
1250
|
+
*/
|
|
1251
|
+
overrideHistoryState?: boolean;
|
|
1223
1252
|
/**
|
|
1224
1253
|
* Flag to override the *Open Link in New Tab* context
|
|
1225
1254
|
* menu option.
|
|
@@ -1590,7 +1619,9 @@ export interface HomePageConfig {
|
|
|
1590
1619
|
* To specify the modules, import the `HomepageModule` enum.
|
|
1591
1620
|
* For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
|
|
1592
1621
|
*
|
|
1593
|
-
* **Note**:
|
|
1622
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
1623
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
1624
|
+
* and V4 (Focused) home page experiences.
|
|
1594
1625
|
*
|
|
1595
1626
|
* Supported embed types: `AppEmbed`
|
|
1596
1627
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1599,7 +1630,7 @@ export interface HomePageConfig {
|
|
|
1599
1630
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
1600
1631
|
*
|
|
1601
1632
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1602
|
-
* ... //
|
|
1633
|
+
* ... // V3 navigation and home page experience attributes
|
|
1603
1634
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
1604
1635
|
* //...other embed view configuration attributes
|
|
1605
1636
|
* })
|
|
@@ -1610,8 +1641,11 @@ export interface HomePageConfig {
|
|
|
1610
1641
|
* Reorder home page modules.
|
|
1611
1642
|
* To specify the modules, import the `HomepageModule` enum.
|
|
1612
1643
|
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
1613
|
-
* HomepageModule.Watchlist]`
|
|
1614
|
-
*
|
|
1644
|
+
* HomepageModule.Watchlist]`
|
|
1645
|
+
*
|
|
1646
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
1647
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
1648
|
+
* and V4 (Focused) home page experiences.
|
|
1615
1649
|
*
|
|
1616
1650
|
* Supported embed types: `AppEmbed`
|
|
1617
1651
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -1620,7 +1654,7 @@ export interface HomePageConfig {
|
|
|
1620
1654
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
1621
1655
|
*
|
|
1622
1656
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1623
|
-
* ...//
|
|
1657
|
+
* ...//V3 navigation and home page experience attributes
|
|
1624
1658
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
1625
1659
|
* //... other embed view configuration attributes
|
|
1626
1660
|
* })
|
|
@@ -1632,7 +1666,9 @@ export interface HomePageConfig {
|
|
|
1632
1666
|
* on the home page left navigation panel.
|
|
1633
1667
|
* To specify the menu items, import the `HomeLeftNavItem` enum.
|
|
1634
1668
|
*
|
|
1635
|
-
* **Note**:
|
|
1669
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
1670
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
1671
|
+
* and V4 (Focused) home page experiences.
|
|
1636
1672
|
*
|
|
1637
1673
|
* Supported embed types: `AppEmbed`
|
|
1638
1674
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2010,6 +2046,24 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2010
2046
|
* ```
|
|
2011
2047
|
*/
|
|
2012
2048
|
isCentralizedLiveboardFilterUXEnabled?: boolean;
|
|
2049
|
+
/**
|
|
2050
|
+
* This flag is used to enable or disable scoped Liveboard filtering.
|
|
2051
|
+
* When enabled, filters and parameters can be scoped to a group of
|
|
2052
|
+
* visualizations on a Liveboard, in addition to the Liveboard and
|
|
2053
|
+
* tab levels.
|
|
2054
|
+
*
|
|
2055
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2056
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
2057
|
+
* @example
|
|
2058
|
+
* ```js
|
|
2059
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
2060
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2061
|
+
* ... // other embed view config
|
|
2062
|
+
* isScopedLiveboardFilteringEnabled: true,
|
|
2063
|
+
* })
|
|
2064
|
+
* ```
|
|
2065
|
+
*/
|
|
2066
|
+
isScopedLiveboardFilteringEnabled?: boolean;
|
|
2013
2067
|
/**
|
|
2014
2068
|
* This flag is used to enable or disable the link parameters in liveboard.
|
|
2015
2069
|
*
|
|
@@ -2226,7 +2280,9 @@ export enum RuntimeFilterOp {
|
|
|
2226
2280
|
* via `hiddenHomepageModules` and reordered via
|
|
2227
2281
|
* `reorderedHomepageModules`.
|
|
2228
2282
|
*
|
|
2229
|
-
* **Note**:
|
|
2283
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2284
|
+
* deprecated. These modules apply to V3 (ModularWithStylingChanges) and
|
|
2285
|
+
* V4 (Focused) home page experiences.
|
|
2230
2286
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2231
2287
|
*/
|
|
2232
2288
|
|
|
@@ -3223,11 +3279,19 @@ export enum EmbedEvent {
|
|
|
3223
3279
|
* Emitted when a user changes any filter on a Liveboard.
|
|
3224
3280
|
* Returns filter type and name, column name and ID, and runtime
|
|
3225
3281
|
* filter details.
|
|
3282
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
3283
|
+
* scope of the changed filter. It contains a `level` (`LIVEBOARD`,
|
|
3284
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
3285
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
3286
|
+
* is no `targetId`, since the filter applies to the whole Liveboard.
|
|
3287
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
3288
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
3226
3289
|
* @example
|
|
3227
3290
|
*
|
|
3228
3291
|
* ```js
|
|
3229
3292
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3230
3293
|
* console.log('payload', payload);
|
|
3294
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
3231
3295
|
* })
|
|
3232
3296
|
* ```
|
|
3233
3297
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
@@ -3419,9 +3483,17 @@ export enum EmbedEvent {
|
|
|
3419
3483
|
/**
|
|
3420
3484
|
* Emitted when parameter changes in an Answer
|
|
3421
3485
|
* or Liveboard.
|
|
3486
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
3487
|
+
* scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
|
|
3488
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
3489
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
3490
|
+
* is no `targetId`, since the parameter applies to the whole Liveboard.
|
|
3491
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
3492
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
3422
3493
|
* ```js
|
|
3423
3494
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
3424
3495
|
* console.log('payload', payload);
|
|
3496
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
3425
3497
|
* })
|
|
3426
3498
|
* ```
|
|
3427
3499
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
@@ -3723,6 +3795,158 @@ export enum EmbedEvent {
|
|
|
3723
3795
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3724
3796
|
*/
|
|
3725
3797
|
SpotterConversationDeleted = 'spotterConversationDeleted',
|
|
3798
|
+
/**
|
|
3799
|
+
* Emitted when the header Share button is clicked. Fires `Start` then `End`
|
|
3800
|
+
* to bracket the interaction. App→host counterpart of the
|
|
3801
|
+
* `ShareSpotterConversation` host event (user-driven vs programmatic open).
|
|
3802
|
+
* @example
|
|
3803
|
+
* ```js
|
|
3804
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
|
|
3805
|
+
* // payload: { convId: string }
|
|
3806
|
+
* })
|
|
3807
|
+
* ```
|
|
3808
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3809
|
+
*/
|
|
3810
|
+
SpotterShareConversationButtonHeaderClicked = 'spotterShareConversationButtonHeaderClicked',
|
|
3811
|
+
/**
|
|
3812
|
+
* Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
|
|
3813
|
+
* to bracket the interaction.
|
|
3814
|
+
* @example
|
|
3815
|
+
* ```js
|
|
3816
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
|
|
3817
|
+
* // payload: { convId: string }
|
|
3818
|
+
* })
|
|
3819
|
+
* ```
|
|
3820
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3821
|
+
*/
|
|
3822
|
+
SpotterShareConversationMenuItemSidebarClicked = 'spotterShareConversationMenuItemSidebarClicked',
|
|
3823
|
+
/**
|
|
3824
|
+
* Emitted when a Spotter conversation is shared (recipients added, or a new
|
|
3825
|
+
* share created). The host builds its own link from shareId/convId + its
|
|
3826
|
+
* configured CONVERSATION_URL — no link string is sent. Distinct from
|
|
3827
|
+
* `SpotterShareModalConfirmButtonClicked`, which fires at click time before
|
|
3828
|
+
* the save resolves.
|
|
3829
|
+
* @example
|
|
3830
|
+
* ```js
|
|
3831
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
|
|
3832
|
+
* // payload: { convId: string, shareId: string,
|
|
3833
|
+
* // recipientsAdded: string[], recipientsRemoved: string[] }
|
|
3834
|
+
* })
|
|
3835
|
+
* ```
|
|
3836
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3837
|
+
*/
|
|
3838
|
+
SpotterConversationShared = 'spotterConversationShared',
|
|
3839
|
+
/**
|
|
3840
|
+
* Emitted when access to a shared Spotter conversation is revoked
|
|
3841
|
+
* (recipients removed). `fullyRevoked` is true when the last sharee is removed
|
|
3842
|
+
* and the share is deleted entirely.
|
|
3843
|
+
* @example
|
|
3844
|
+
* ```js
|
|
3845
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
|
|
3846
|
+
* // payload: { convId: string, shareId: string,
|
|
3847
|
+
* // recipientsRemoved: string[], fullyRevoked: boolean }
|
|
3848
|
+
* })
|
|
3849
|
+
* ```
|
|
3850
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3851
|
+
*/
|
|
3852
|
+
SpotterConversationShareRevoked = 'spotterConversationShareRevoked',
|
|
3853
|
+
/**
|
|
3854
|
+
* Emitted when a recipient opens a shared Spotter conversation (read-only
|
|
3855
|
+
* view). No shareId available viewer-side.
|
|
3856
|
+
* @example
|
|
3857
|
+
* ```js
|
|
3858
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
|
|
3859
|
+
* // payload: { convId: string, sourceConvId: string }
|
|
3860
|
+
* // convId = resolved snapshot conv id; sourceConvId = the shared URL id
|
|
3861
|
+
* })
|
|
3862
|
+
* ```
|
|
3863
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3864
|
+
*/
|
|
3865
|
+
SpotterSharedConversationViewed = 'spotterSharedConversationViewed',
|
|
3866
|
+
/**
|
|
3867
|
+
* Emitted when the user toggles the share-modal "include new messages since
|
|
3868
|
+
* last shared version" checkbox.
|
|
3869
|
+
* @example
|
|
3870
|
+
* ```js
|
|
3871
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
|
|
3872
|
+
* // payload: { convId: string, includeNewMessages: boolean }
|
|
3873
|
+
* })
|
|
3874
|
+
* ```
|
|
3875
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3876
|
+
*/
|
|
3877
|
+
SpotterShareIncludeNewMessagesCheckboxToggled = 'spotterShareIncludeNewMessagesCheckboxToggled',
|
|
3878
|
+
/**
|
|
3879
|
+
* Emitted when the user dismisses the stale-snapshot info banner via its
|
|
3880
|
+
* cross (distinct from the include-new-messages checkbox toggle).
|
|
3881
|
+
* @example
|
|
3882
|
+
* ```js
|
|
3883
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
|
|
3884
|
+
* // payload: { convId: string }
|
|
3885
|
+
* })
|
|
3886
|
+
* ```
|
|
3887
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3888
|
+
*/
|
|
3889
|
+
SpotterShareStaleInfoBannerDismissed = 'spotterShareStaleInfoBannerDismissed',
|
|
3890
|
+
/**
|
|
3891
|
+
* Emitted when the modal Share (confirm) button is clicked — fires at click
|
|
3892
|
+
* time, before the save resolves. Distinct from the `SpotterConversationShared`
|
|
3893
|
+
* / `SpotterConversationShareRevoked` result events.
|
|
3894
|
+
* @example
|
|
3895
|
+
* ```js
|
|
3896
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
|
|
3897
|
+
* // payload: { convId: string }
|
|
3898
|
+
* })
|
|
3899
|
+
* ```
|
|
3900
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3901
|
+
*/
|
|
3902
|
+
SpotterShareModalConfirmButtonClicked = 'spotterShareModalConfirmButtonClicked',
|
|
3903
|
+
/**
|
|
3904
|
+
* Emitted when the share modal is dismissed via the Cancel button.
|
|
3905
|
+
* @example
|
|
3906
|
+
* ```js
|
|
3907
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
|
|
3908
|
+
* // payload: { convId: string }
|
|
3909
|
+
* })
|
|
3910
|
+
* ```
|
|
3911
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3912
|
+
*/
|
|
3913
|
+
SpotterShareModalCancelButtonClicked = 'spotterShareModalCancelButtonClicked',
|
|
3914
|
+
/**
|
|
3915
|
+
* Emitted when a recipient leaves the read-only shared view via the Exit
|
|
3916
|
+
* button.
|
|
3917
|
+
* @example
|
|
3918
|
+
* ```js
|
|
3919
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
|
|
3920
|
+
* // payload: { convId: string }
|
|
3921
|
+
* })
|
|
3922
|
+
* ```
|
|
3923
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3924
|
+
*/
|
|
3925
|
+
SpotterSharedConversationExitButtonClicked = 'spotterSharedConversationExitButtonClicked',
|
|
3926
|
+
/**
|
|
3927
|
+
* Emitted when a Spotter conversation is pinned.
|
|
3928
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
3929
|
+
* @example
|
|
3930
|
+
* ```js
|
|
3931
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
|
|
3932
|
+
* console.log('Conversation pinned', payload);
|
|
3933
|
+
* // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
|
|
3934
|
+
* })
|
|
3935
|
+
* ```
|
|
3936
|
+
*/
|
|
3937
|
+
SpotterConversationPinned = 'spotterConversationPinned',
|
|
3938
|
+
/**
|
|
3939
|
+
* Emitted when a Spotter conversation is unpinned.
|
|
3940
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
3941
|
+
* @example
|
|
3942
|
+
* ```js
|
|
3943
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
|
|
3944
|
+
* console.log('Conversation unpinned', payload);
|
|
3945
|
+
* // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
|
|
3946
|
+
* })
|
|
3947
|
+
* ```
|
|
3948
|
+
*/
|
|
3949
|
+
SpotterConversationUnpinned = 'spotterConversationUnpinned',
|
|
3726
3950
|
/**
|
|
3727
3951
|
* Emitted when a Spotter conversation is selected/clicked.
|
|
3728
3952
|
* @example
|
|
@@ -3736,6 +3960,31 @@ export enum EmbedEvent {
|
|
|
3736
3960
|
*/
|
|
3737
3961
|
SpotterConversationSelected = 'spotterConversationSelected',
|
|
3738
3962
|
|
|
3963
|
+
/**
|
|
3964
|
+
* Emitted when the Spotter agent finishes streaming/rendering a response.
|
|
3965
|
+
* Includes the conversation and message identifiers so the host app can
|
|
3966
|
+
* fetch the full conversation history via the REST API if needed.
|
|
3967
|
+
*
|
|
3968
|
+
* The payload data has the shape `{ convId: string, messageId: string }`.
|
|
3969
|
+
*
|
|
3970
|
+
* Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
|
|
3971
|
+
* inside the full application).
|
|
3972
|
+
* @example
|
|
3973
|
+
* ```js
|
|
3974
|
+
* spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
3975
|
+
* console.log('Spotter response complete', payload);
|
|
3976
|
+
* })
|
|
3977
|
+
* ```
|
|
3978
|
+
* @example
|
|
3979
|
+
* ```js
|
|
3980
|
+
* appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
3981
|
+
* console.log('Spotter response complete', payload);
|
|
3982
|
+
* })
|
|
3983
|
+
* ```
|
|
3984
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
3985
|
+
*/
|
|
3986
|
+
SpotterResponseComplete = 'spotterResponseComplete',
|
|
3987
|
+
|
|
3739
3988
|
/**
|
|
3740
3989
|
* @hidden
|
|
3741
3990
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -4227,6 +4476,17 @@ export enum HostEvent {
|
|
|
4227
4476
|
* name: string,
|
|
4228
4477
|
* type: ATTRIBUTE/MEASURE,
|
|
4229
4478
|
* dataType: INT64/CHAR/DATE }
|
|
4479
|
+
*
|
|
4480
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
4481
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
4482
|
+
* scoped filter is opened. Available from SDK: 1.53.0 |
|
|
4483
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
4484
|
+
*
|
|
4485
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
4486
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
4487
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
4488
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
4489
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
4230
4490
|
* @example
|
|
4231
4491
|
* ```js
|
|
4232
4492
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
@@ -4239,6 +4499,14 @@ export enum HostEvent {
|
|
|
4239
4499
|
* ```
|
|
4240
4500
|
* @example
|
|
4241
4501
|
* ```js
|
|
4502
|
+
* // Open a filter scoped to a specific Liveboard tab
|
|
4503
|
+
* liveboardEmbed.trigger(HostEvent.OpenFilter, {
|
|
4504
|
+
* column: { columnId: '<column-GUID>' },
|
|
4505
|
+
* applicability: { level: 'TAB', targetId: '<tab-GUID>' }
|
|
4506
|
+
* });
|
|
4507
|
+
* ```
|
|
4508
|
+
* @example
|
|
4509
|
+
* ```js
|
|
4242
4510
|
* // Open filter from search context
|
|
4243
4511
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
4244
4512
|
* searchEmbed.trigger(HostEvent.OpenFilter, {
|
|
@@ -4248,6 +4516,38 @@ export enum HostEvent {
|
|
|
4248
4516
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4249
4517
|
*/
|
|
4250
4518
|
OpenFilter = 'openFilter',
|
|
4519
|
+
/**
|
|
4520
|
+
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
4521
|
+
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
4522
|
+
* @param - Includes the following keys:
|
|
4523
|
+
* - `parameter`: An object identifying the parameter to open, for
|
|
4524
|
+
* example, `{ parameterId: '<parameter-GUID>' }`.
|
|
4525
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
4526
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
4527
|
+
* scoped parameter is opened. Includes the following attributes:
|
|
4528
|
+
*
|
|
4529
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
4530
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
4531
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
4532
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
4533
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
4534
|
+
* @example
|
|
4535
|
+
* ```js
|
|
4536
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
4537
|
+
* parameter: { parameterId: '<parameter-GUID>' }
|
|
4538
|
+
* });
|
|
4539
|
+
* ```
|
|
4540
|
+
* @example
|
|
4541
|
+
* ```js
|
|
4542
|
+
* // Open a parameter scoped to a specific group
|
|
4543
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
4544
|
+
* parameter: { parameterId: '<parameter-GUID>' },
|
|
4545
|
+
* applicability: { level: 'GROUP', targetId: '<group-GUID>' }
|
|
4546
|
+
* });
|
|
4547
|
+
* ```
|
|
4548
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
4549
|
+
*/
|
|
4550
|
+
OpenParameter = 'openParameter',
|
|
4251
4551
|
/**
|
|
4252
4552
|
* Add columns to the current search query.
|
|
4253
4553
|
* @param - { columnIds: string[] }
|
|
@@ -5312,6 +5612,14 @@ export enum HostEvent {
|
|
|
5312
5612
|
/**
|
|
5313
5613
|
* Get details of filters applied on the Liveboard.
|
|
5314
5614
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
5615
|
+
* Each Liveboard filter includes an optional `applicability` attribute
|
|
5616
|
+
* indicating the scope of the filter. It contains a `level`
|
|
5617
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
5618
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
5619
|
+
* level there is no `targetId`, since the filter applies to the
|
|
5620
|
+
* whole Liveboard.
|
|
5621
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
5622
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
5315
5623
|
* @example
|
|
5316
5624
|
* ```js
|
|
5317
5625
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
@@ -5351,6 +5659,16 @@ export enum HostEvent {
|
|
|
5351
5659
|
*
|
|
5352
5660
|
* `type` - To update filters for date time, specify the date format type.
|
|
5353
5661
|
* For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
|
|
5662
|
+
*
|
|
5663
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
5664
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
5665
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
5666
|
+
*
|
|
5667
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5668
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5669
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5670
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
5671
|
+
* Liveboard.
|
|
5354
5672
|
* @example
|
|
5355
5673
|
* ```js
|
|
5356
5674
|
*
|
|
@@ -5427,6 +5745,21 @@ export enum HostEvent {
|
|
|
5427
5745
|
* }
|
|
5428
5746
|
* }, ContextType.Liveboard);
|
|
5429
5747
|
* ```
|
|
5748
|
+
* @example
|
|
5749
|
+
* ```js
|
|
5750
|
+
* // Scope the filter to a specific Liveboard tab
|
|
5751
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
5752
|
+
* filter: {
|
|
5753
|
+
* column: "item type",
|
|
5754
|
+
* oper: "IN",
|
|
5755
|
+
* values: ["bags", "shirts"],
|
|
5756
|
+
* applicability: {
|
|
5757
|
+
* level: "TAB",
|
|
5758
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
5759
|
+
* }
|
|
5760
|
+
* }
|
|
5761
|
+
* });
|
|
5762
|
+
* ```
|
|
5430
5763
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
5431
5764
|
*/
|
|
5432
5765
|
UpdateFilters = 'updateFilters',
|
|
@@ -5451,6 +5784,28 @@ export enum HostEvent {
|
|
|
5451
5784
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
5452
5785
|
*/
|
|
5453
5786
|
GetTabs = 'getTabs',
|
|
5787
|
+
/**
|
|
5788
|
+
* Get group details for the current Liveboard.
|
|
5789
|
+
* Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
|
|
5790
|
+
* @example
|
|
5791
|
+
* ```js
|
|
5792
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
|
|
5793
|
+
* console.log(
|
|
5794
|
+
* groupDetails // GroupDetails of current Liveboard
|
|
5795
|
+
* );
|
|
5796
|
+
* })
|
|
5797
|
+
* ```
|
|
5798
|
+
* @example
|
|
5799
|
+
* ```js
|
|
5800
|
+
* // Get groups from liveboard context
|
|
5801
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5802
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
|
|
5803
|
+
* console.log('groups', groupDetails);
|
|
5804
|
+
* });
|
|
5805
|
+
* ```
|
|
5806
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
5807
|
+
*/
|
|
5808
|
+
GetGroups = 'getGroups',
|
|
5454
5809
|
/**
|
|
5455
5810
|
* Set the visible tabs on a Liveboard.
|
|
5456
5811
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
@@ -5578,6 +5933,15 @@ export enum HostEvent {
|
|
|
5578
5933
|
* - `name`: Name of the parameter.
|
|
5579
5934
|
* - `value`: The value to set for the parameter.
|
|
5580
5935
|
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
5936
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
5937
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
5938
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
5939
|
+
*
|
|
5940
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5941
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5942
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5943
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
5944
|
+
* Liveboard.
|
|
5581
5945
|
*
|
|
5582
5946
|
* @example
|
|
5583
5947
|
* ```js
|
|
@@ -5589,6 +5953,18 @@ export enum HostEvent {
|
|
|
5589
5953
|
* ```
|
|
5590
5954
|
* @example
|
|
5591
5955
|
* ```js
|
|
5956
|
+
* // Scope the parameter to a specific Liveboard tab
|
|
5957
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
5958
|
+
* name: "Integer Range Param",
|
|
5959
|
+
* value: 10,
|
|
5960
|
+
* applicability: {
|
|
5961
|
+
* level: "TAB",
|
|
5962
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
5963
|
+
* }
|
|
5964
|
+
* }])
|
|
5965
|
+
* ```
|
|
5966
|
+
* @example
|
|
5967
|
+
* ```js
|
|
5592
5968
|
* // Update parameters from liveboard context
|
|
5593
5969
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5594
5970
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -5602,6 +5978,14 @@ export enum HostEvent {
|
|
|
5602
5978
|
UpdateParameters = 'UpdateParameters',
|
|
5603
5979
|
/**
|
|
5604
5980
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
5981
|
+
* Each parameter includes an optional `applicability` attribute
|
|
5982
|
+
* indicating the scope of the parameter. It contains a `level`
|
|
5983
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
5984
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
5985
|
+
* level there is no `targetId`, since the parameter applies to the
|
|
5986
|
+
* whole Liveboard.
|
|
5987
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
5988
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
5605
5989
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5606
5990
|
* ```js
|
|
5607
5991
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
@@ -5868,6 +6252,36 @@ export enum HostEvent {
|
|
|
5868
6252
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5869
6253
|
*/
|
|
5870
6254
|
ResetSpotterConversation = 'ResetSpotterConversation',
|
|
6255
|
+
/**
|
|
6256
|
+
* Opens the Spotter share-conversation modal for the given conversation.
|
|
6257
|
+
* `conversationId` is **mandatory** — you must pass the id of the
|
|
6258
|
+
* conversation to share. Also no-op when sharing is disabled
|
|
6259
|
+
* (enableShareConversation off) or when already in the read-only shared view.
|
|
6260
|
+
* @example
|
|
6261
|
+
* ```js
|
|
6262
|
+
* spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
|
|
6263
|
+
* ```
|
|
6264
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6265
|
+
*/
|
|
6266
|
+
ShareSpotterConversation = 'ShareSpotterConversation',
|
|
6267
|
+
/**
|
|
6268
|
+
* Closes the Spotter share-conversation modal. No-op if none is open.
|
|
6269
|
+
* @example
|
|
6270
|
+
* ```js
|
|
6271
|
+
* spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
|
|
6272
|
+
* ```
|
|
6273
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6274
|
+
*/
|
|
6275
|
+
CloseSpotterShareConversation = 'CloseSpotterShareConversation',
|
|
6276
|
+
/**
|
|
6277
|
+
* Exits the read-only shared-conversation view.
|
|
6278
|
+
* @example
|
|
6279
|
+
* ```js
|
|
6280
|
+
* spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
|
|
6281
|
+
* ```
|
|
6282
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6283
|
+
*/
|
|
6284
|
+
ExitSpotterSharedConversation = 'ExitSpotterSharedConversation',
|
|
5871
6285
|
/**
|
|
5872
6286
|
* Deletes the last prompt in spotter embed.
|
|
5873
6287
|
* @example
|
|
@@ -5965,6 +6379,43 @@ export enum HostEvent {
|
|
|
5965
6379
|
*/
|
|
5966
6380
|
StartNewSpotterConversation = 'StartNewSpotterConversation',
|
|
5967
6381
|
|
|
6382
|
+
/**
|
|
6383
|
+
* Pins a saved Spotter conversation so it floats to the top of the past
|
|
6384
|
+
* conversations sidebar. The `conversationId` of the conversation to pin is
|
|
6385
|
+
* required.
|
|
6386
|
+
*
|
|
6387
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
6388
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
6389
|
+
* instance.
|
|
6390
|
+
*
|
|
6391
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6392
|
+
* @example
|
|
6393
|
+
* ```js
|
|
6394
|
+
* spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
|
|
6395
|
+
* conversationId: '<conversation-id>',
|
|
6396
|
+
* });
|
|
6397
|
+
* ```
|
|
6398
|
+
*/
|
|
6399
|
+
PinSpotterConversation = 'PinSpotterConversation',
|
|
6400
|
+
|
|
6401
|
+
/**
|
|
6402
|
+
* Unpins a previously pinned Spotter conversation. The `conversationId` of the
|
|
6403
|
+
* conversation to unpin is required.
|
|
6404
|
+
*
|
|
6405
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
6406
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
6407
|
+
* instance.
|
|
6408
|
+
*
|
|
6409
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6410
|
+
* @example
|
|
6411
|
+
* ```js
|
|
6412
|
+
* spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
|
|
6413
|
+
* conversationId: '<conversation-id>',
|
|
6414
|
+
* });
|
|
6415
|
+
* ```
|
|
6416
|
+
*/
|
|
6417
|
+
UnpinSpotterConversation = 'UnpinSpotterConversation',
|
|
6418
|
+
|
|
5968
6419
|
/**
|
|
5969
6420
|
* @hidden
|
|
5970
6421
|
* Get the current context of the embedded page.
|
|
@@ -6193,6 +6644,7 @@ export enum Param {
|
|
|
6193
6644
|
SpotterEnabled = 'isSpotterExperienceEnabled',
|
|
6194
6645
|
IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
|
|
6195
6646
|
OverrideOrgId = 'orgId',
|
|
6647
|
+
OverrideHistoryState = 'overrideHistoryState',
|
|
6196
6648
|
OauthPollingInterval = 'oAuthPollingInterval',
|
|
6197
6649
|
IsForceRedirect = 'isForceRedirect',
|
|
6198
6650
|
DataSourceId = 'dataSourceId',
|
|
@@ -6210,9 +6662,12 @@ export enum Param {
|
|
|
6210
6662
|
isGranularXLSXCSVSchedulesEnabled = 'isGranularXLSXCSVSchedulesEnabled',
|
|
6211
6663
|
isSendNowLiveboardSchedulingEnabled = 'isSendNowLiveboardSchedulingEnabled',
|
|
6212
6664
|
isCentralizedLiveboardFilterUXEnabled = 'isCentralizedLiveboardFilterUXEnabled',
|
|
6665
|
+
isScopedLiveboardFilteringEnabled = 'isScopedLiveboardFilteringEnabled',
|
|
6213
6666
|
isLinkParametersEnabled = 'isLinkParametersEnabled',
|
|
6214
6667
|
EnablePastConversationsSidebar = 'enablePastConversationsSidebar',
|
|
6215
6668
|
UpdatedSpotterChatPrompt = 'updatedSpotterChatPrompt',
|
|
6669
|
+
ShowSpotterRadiance = 'showSpotterRadiance',
|
|
6670
|
+
DefaultQueryMode = 'defaultQueryMode',
|
|
6216
6671
|
EnableStopAnswerGenerationEmbed = 'enableStopAnswerGenerationEmbed',
|
|
6217
6672
|
SpotterSidebarTitle = 'spotterSidebarTitle',
|
|
6218
6673
|
SpotterSidebarDefaultExpanded = 'spotterSidebarDefaultExpanded',
|
|
@@ -6232,6 +6687,8 @@ export enum Param {
|
|
|
6232
6687
|
SpotterFileUploadEnabled = 'spotterFileUploadEnabled',
|
|
6233
6688
|
SpotterFileUploadFileTypes = 'spotterFileUploadFileTypes',
|
|
6234
6689
|
IsStarterPromptsEnabled = 'enableStarterPrompts',
|
|
6690
|
+
UpdatedSpotterExperience = 'updatedSpotterExperience',
|
|
6691
|
+
SpotterDataSources = 'spotterDataSources',
|
|
6235
6692
|
}
|
|
6236
6693
|
|
|
6237
6694
|
/**
|
|
@@ -7522,6 +7979,20 @@ export enum Action {
|
|
|
7522
7979
|
*/
|
|
7523
7980
|
ChangeFilterVisibilityInTab = 'changeFilterVisibilityInTab',
|
|
7524
7981
|
|
|
7982
|
+
/**
|
|
7983
|
+
* Action ID to show, hide, or disable all filter surfaces on a Liveboard,
|
|
7984
|
+
* including filter, parameter, and cross-filter chips at the liveboard,
|
|
7985
|
+
* tab, and group levels. Parameter and cross-filter chips are hide-only.
|
|
7986
|
+
*
|
|
7987
|
+
* @example
|
|
7988
|
+
* ```js
|
|
7989
|
+
* hiddenActions: [Action.AllLiveboardFilters]
|
|
7990
|
+
* disabledActions: [Action.AllLiveboardFilters]
|
|
7991
|
+
* ```
|
|
7992
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
7993
|
+
*/
|
|
7994
|
+
AllLiveboardFilters = 'allLiveboardFilters',
|
|
7995
|
+
|
|
7525
7996
|
/**
|
|
7526
7997
|
* The **Data model instructions** button on the Spotter interface.
|
|
7527
7998
|
* Allows opening the data model instructions modal.
|
|
@@ -7859,6 +8330,89 @@ export enum Action {
|
|
|
7859
8330
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7860
8331
|
*/
|
|
7861
8332
|
SpotterChatRename = 'spotterChatRename',
|
|
8333
|
+
/**
|
|
8334
|
+
* Controls visibility and disable state of the Spotter conversation Share
|
|
8335
|
+
* button in the chat header. Only takes effect once sharing is enabled
|
|
8336
|
+
* (enableShareConversation on).
|
|
8337
|
+
* @example
|
|
8338
|
+
* ```js
|
|
8339
|
+
* disabledActions: [Action.SpotterShareConversationButtonHeader]
|
|
8340
|
+
* ```
|
|
8341
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8342
|
+
*/
|
|
8343
|
+
SpotterShareConversationButtonHeader = 'spotterShareConversationButtonHeader',
|
|
8344
|
+
/**
|
|
8345
|
+
* Controls visibility and disable state of the Share item in the Spotter
|
|
8346
|
+
* conversation history (sidebar) edit menu. Independent of the header button
|
|
8347
|
+
* above, so a host can show Share in one entry point and hide it in the other.
|
|
8348
|
+
* @example
|
|
8349
|
+
* ```js
|
|
8350
|
+
* disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
|
|
8351
|
+
* ```
|
|
8352
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8353
|
+
*/
|
|
8354
|
+
SpotterShareConversationMenuItemSidebar = 'spotterShareConversationMenuItemSidebar',
|
|
8355
|
+
/**
|
|
8356
|
+
* Controls visibility of the entire read-only shared-conversation data-access
|
|
8357
|
+
* banner shown when a recipient opens a shared view. Hide-only.
|
|
8358
|
+
* @example
|
|
8359
|
+
* ```js
|
|
8360
|
+
* hiddenActions: [Action.SpotterSharedConversationBanner]
|
|
8361
|
+
* ```
|
|
8362
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8363
|
+
*/
|
|
8364
|
+
SpotterSharedConversationBanner = 'spotterSharedConversationBanner',
|
|
8365
|
+
/**
|
|
8366
|
+
* Controls visibility and disable state of the cross/close button on the
|
|
8367
|
+
* read-only shared-conversation data-access banner (keeps the banner itself).
|
|
8368
|
+
* @example
|
|
8369
|
+
* ```js
|
|
8370
|
+
* hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
|
|
8371
|
+
* ```
|
|
8372
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8373
|
+
*/
|
|
8374
|
+
SpotterSharedConversationBannerDismissButton = 'spotterSharedConversationBannerDismissButton',
|
|
8375
|
+
/**
|
|
8376
|
+
* Controls visibility and disable state of the Exit button in the read-only
|
|
8377
|
+
* shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
|
|
8378
|
+
* host event.
|
|
8379
|
+
* @example
|
|
8380
|
+
* ```js
|
|
8381
|
+
* hiddenActions: [Action.SpotterSharedConversationExitButton]
|
|
8382
|
+
* ```
|
|
8383
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8384
|
+
*/
|
|
8385
|
+
SpotterSharedConversationExitButton = 'spotterSharedConversationExitButton',
|
|
8386
|
+
/**
|
|
8387
|
+
* Controls visibility of the share-modal footer note ("Chat will be shared up
|
|
8388
|
+
* to the current moment…"). Hide-only.
|
|
8389
|
+
* @example
|
|
8390
|
+
* ```js
|
|
8391
|
+
* hiddenActions: [Action.SpotterShareUpToCurrentInfo]
|
|
8392
|
+
* ```
|
|
8393
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8394
|
+
*/
|
|
8395
|
+
SpotterShareUpToCurrentInfo = 'spotterShareUpToCurrentInfo',
|
|
8396
|
+
/**
|
|
8397
|
+
* Controls visibility and disable state of the share-modal "include new
|
|
8398
|
+
* messages since last shared version" checkbox.
|
|
8399
|
+
* @example
|
|
8400
|
+
* ```js
|
|
8401
|
+
* disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
|
|
8402
|
+
* ```
|
|
8403
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8404
|
+
*/
|
|
8405
|
+
SpotterShareIncludeNewMessagesCheckbox = 'spotterShareIncludeNewMessagesCheckbox',
|
|
8406
|
+
/**
|
|
8407
|
+
* Controls visibility and disable state of the cross on the share-modal
|
|
8408
|
+
* stale-snapshot info banner.
|
|
8409
|
+
* @example
|
|
8410
|
+
* ```js
|
|
8411
|
+
* hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
|
|
8412
|
+
* ```
|
|
8413
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8414
|
+
*/
|
|
8415
|
+
SpotterShareStaleInfoBannerDismissButton = 'spotterShareStaleInfoBannerDismissButton',
|
|
7862
8416
|
/**
|
|
7863
8417
|
* Controls visibility and disable state of the delete action
|
|
7864
8418
|
* in the Spotter conversation edit menu.
|
|
@@ -7869,6 +8423,16 @@ export enum Action {
|
|
|
7869
8423
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7870
8424
|
*/
|
|
7871
8425
|
SpotterChatDelete = 'spotterChatDelete',
|
|
8426
|
+
/**
|
|
8427
|
+
* Controls visibility and disable state of the pin/unpin action
|
|
8428
|
+
* in the Spotter conversation edit menu.
|
|
8429
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
8430
|
+
* @example
|
|
8431
|
+
* ```js
|
|
8432
|
+
* disabledActions: [Action.SpotterChatPin]
|
|
8433
|
+
* ```
|
|
8434
|
+
*/
|
|
8435
|
+
SpotterChatPin = 'spotterChatPin',
|
|
7872
8436
|
/**
|
|
7873
8437
|
* Controls visibility and disable state of the documentation/best practices
|
|
7874
8438
|
* link in the Spotter sidebar footer.
|
|
@@ -8436,6 +9000,9 @@ export enum EmbedErrorCodes {
|
|
|
8436
9000
|
|
|
8437
9001
|
/** DrillDown payload is invalid - missing or malformed points */
|
|
8438
9002
|
DRILLDOWN_INVALID_PAYLOAD = 'DRILLDOWN_INVALID_PAYLOAD',
|
|
9003
|
+
|
|
9004
|
+
/** UpdateParameters payload is invalid - malformed applicability */
|
|
9005
|
+
UPDATEPARAMETERS_INVALID_PAYLOAD = 'UPDATEPARAMETERS_INVALID_PAYLOAD',
|
|
8439
9006
|
}
|
|
8440
9007
|
|
|
8441
9008
|
/**
|