@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.js
CHANGED
|
@@ -172,7 +172,9 @@ export var AuthType;
|
|
|
172
172
|
})(AuthType || (AuthType = {}));
|
|
173
173
|
/**
|
|
174
174
|
*
|
|
175
|
-
* **Note**:
|
|
175
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
176
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
|
|
177
|
+
* V4 (Focused) home page experiences.
|
|
176
178
|
*
|
|
177
179
|
*/
|
|
178
180
|
export var HomeLeftNavItem;
|
|
@@ -240,6 +242,13 @@ export var HomeLeftNavItem;
|
|
|
240
242
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
241
243
|
*/
|
|
242
244
|
HomeLeftNavItem["Favorites"] = "favorites";
|
|
245
|
+
/**
|
|
246
|
+
* The *Collections* menu option in
|
|
247
|
+
* the *Insights* left navigation panel.
|
|
248
|
+
* Shown when collections are enabled on the cluster.
|
|
249
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
250
|
+
*/
|
|
251
|
+
HomeLeftNavItem["Collections"] = "collections";
|
|
243
252
|
})(HomeLeftNavItem || (HomeLeftNavItem = {}));
|
|
244
253
|
/**
|
|
245
254
|
* A map of the supported runtime filter operations
|
|
@@ -312,7 +321,9 @@ export var RuntimeFilterOp;
|
|
|
312
321
|
* via `hiddenHomepageModules` and reordered via
|
|
313
322
|
* `reorderedHomepageModules`.
|
|
314
323
|
*
|
|
315
|
-
* **Note**:
|
|
324
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
325
|
+
* deprecated. These modules apply to V3 (ModularWithStylingChanges) and
|
|
326
|
+
* V4 (Focused) home page experiences.
|
|
316
327
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
317
328
|
*/
|
|
318
329
|
export var HomepageModule;
|
|
@@ -1270,11 +1281,19 @@ export var EmbedEvent;
|
|
|
1270
1281
|
* Emitted when a user changes any filter on a Liveboard.
|
|
1271
1282
|
* Returns filter type and name, column name and ID, and runtime
|
|
1272
1283
|
* filter details.
|
|
1284
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
1285
|
+
* scope of the changed filter. It contains a `level` (`LIVEBOARD`,
|
|
1286
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
1287
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
1288
|
+
* is no `targetId`, since the filter applies to the whole Liveboard.
|
|
1289
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
1290
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
1273
1291
|
* @example
|
|
1274
1292
|
*
|
|
1275
1293
|
* ```js
|
|
1276
1294
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1277
1295
|
* console.log('payload', payload);
|
|
1296
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
1278
1297
|
* })
|
|
1279
1298
|
* ```
|
|
1280
1299
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
@@ -1466,9 +1485,17 @@ export var EmbedEvent;
|
|
|
1466
1485
|
/**
|
|
1467
1486
|
* Emitted when parameter changes in an Answer
|
|
1468
1487
|
* or Liveboard.
|
|
1488
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
1489
|
+
* scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
|
|
1490
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
1491
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
1492
|
+
* is no `targetId`, since the parameter applies to the whole Liveboard.
|
|
1493
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
1494
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
1469
1495
|
* ```js
|
|
1470
1496
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
1471
1497
|
* console.log('payload', payload);
|
|
1498
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
1472
1499
|
* })
|
|
1473
1500
|
* ```
|
|
1474
1501
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
@@ -1770,6 +1797,158 @@ export var EmbedEvent;
|
|
|
1770
1797
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
1771
1798
|
*/
|
|
1772
1799
|
EmbedEvent["SpotterConversationDeleted"] = "spotterConversationDeleted";
|
|
1800
|
+
/**
|
|
1801
|
+
* Emitted when the header Share button is clicked. Fires `Start` then `End`
|
|
1802
|
+
* to bracket the interaction. App→host counterpart of the
|
|
1803
|
+
* `ShareSpotterConversation` host event (user-driven vs programmatic open).
|
|
1804
|
+
* @example
|
|
1805
|
+
* ```js
|
|
1806
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
|
|
1807
|
+
* // payload: { convId: string }
|
|
1808
|
+
* })
|
|
1809
|
+
* ```
|
|
1810
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1811
|
+
*/
|
|
1812
|
+
EmbedEvent["SpotterShareConversationButtonHeaderClicked"] = "spotterShareConversationButtonHeaderClicked";
|
|
1813
|
+
/**
|
|
1814
|
+
* Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
|
|
1815
|
+
* to bracket the interaction.
|
|
1816
|
+
* @example
|
|
1817
|
+
* ```js
|
|
1818
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
|
|
1819
|
+
* // payload: { convId: string }
|
|
1820
|
+
* })
|
|
1821
|
+
* ```
|
|
1822
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1823
|
+
*/
|
|
1824
|
+
EmbedEvent["SpotterShareConversationMenuItemSidebarClicked"] = "spotterShareConversationMenuItemSidebarClicked";
|
|
1825
|
+
/**
|
|
1826
|
+
* Emitted when a Spotter conversation is shared (recipients added, or a new
|
|
1827
|
+
* share created). The host builds its own link from shareId/convId + its
|
|
1828
|
+
* configured CONVERSATION_URL — no link string is sent. Distinct from
|
|
1829
|
+
* `SpotterShareModalConfirmButtonClicked`, which fires at click time before
|
|
1830
|
+
* the save resolves.
|
|
1831
|
+
* @example
|
|
1832
|
+
* ```js
|
|
1833
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
|
|
1834
|
+
* // payload: { convId: string, shareId: string,
|
|
1835
|
+
* // recipientsAdded: string[], recipientsRemoved: string[] }
|
|
1836
|
+
* })
|
|
1837
|
+
* ```
|
|
1838
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1839
|
+
*/
|
|
1840
|
+
EmbedEvent["SpotterConversationShared"] = "spotterConversationShared";
|
|
1841
|
+
/**
|
|
1842
|
+
* Emitted when access to a shared Spotter conversation is revoked
|
|
1843
|
+
* (recipients removed). `fullyRevoked` is true when the last sharee is removed
|
|
1844
|
+
* and the share is deleted entirely.
|
|
1845
|
+
* @example
|
|
1846
|
+
* ```js
|
|
1847
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
|
|
1848
|
+
* // payload: { convId: string, shareId: string,
|
|
1849
|
+
* // recipientsRemoved: string[], fullyRevoked: boolean }
|
|
1850
|
+
* })
|
|
1851
|
+
* ```
|
|
1852
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1853
|
+
*/
|
|
1854
|
+
EmbedEvent["SpotterConversationShareRevoked"] = "spotterConversationShareRevoked";
|
|
1855
|
+
/**
|
|
1856
|
+
* Emitted when a recipient opens a shared Spotter conversation (read-only
|
|
1857
|
+
* view). No shareId available viewer-side.
|
|
1858
|
+
* @example
|
|
1859
|
+
* ```js
|
|
1860
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
|
|
1861
|
+
* // payload: { convId: string, sourceConvId: string }
|
|
1862
|
+
* // convId = resolved snapshot conv id; sourceConvId = the shared URL id
|
|
1863
|
+
* })
|
|
1864
|
+
* ```
|
|
1865
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1866
|
+
*/
|
|
1867
|
+
EmbedEvent["SpotterSharedConversationViewed"] = "spotterSharedConversationViewed";
|
|
1868
|
+
/**
|
|
1869
|
+
* Emitted when the user toggles the share-modal "include new messages since
|
|
1870
|
+
* last shared version" checkbox.
|
|
1871
|
+
* @example
|
|
1872
|
+
* ```js
|
|
1873
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
|
|
1874
|
+
* // payload: { convId: string, includeNewMessages: boolean }
|
|
1875
|
+
* })
|
|
1876
|
+
* ```
|
|
1877
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1878
|
+
*/
|
|
1879
|
+
EmbedEvent["SpotterShareIncludeNewMessagesCheckboxToggled"] = "spotterShareIncludeNewMessagesCheckboxToggled";
|
|
1880
|
+
/**
|
|
1881
|
+
* Emitted when the user dismisses the stale-snapshot info banner via its
|
|
1882
|
+
* cross (distinct from the include-new-messages checkbox toggle).
|
|
1883
|
+
* @example
|
|
1884
|
+
* ```js
|
|
1885
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
|
|
1886
|
+
* // payload: { convId: string }
|
|
1887
|
+
* })
|
|
1888
|
+
* ```
|
|
1889
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1890
|
+
*/
|
|
1891
|
+
EmbedEvent["SpotterShareStaleInfoBannerDismissed"] = "spotterShareStaleInfoBannerDismissed";
|
|
1892
|
+
/**
|
|
1893
|
+
* Emitted when the modal Share (confirm) button is clicked — fires at click
|
|
1894
|
+
* time, before the save resolves. Distinct from the `SpotterConversationShared`
|
|
1895
|
+
* / `SpotterConversationShareRevoked` result events.
|
|
1896
|
+
* @example
|
|
1897
|
+
* ```js
|
|
1898
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
|
|
1899
|
+
* // payload: { convId: string }
|
|
1900
|
+
* })
|
|
1901
|
+
* ```
|
|
1902
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1903
|
+
*/
|
|
1904
|
+
EmbedEvent["SpotterShareModalConfirmButtonClicked"] = "spotterShareModalConfirmButtonClicked";
|
|
1905
|
+
/**
|
|
1906
|
+
* Emitted when the share modal is dismissed via the Cancel button.
|
|
1907
|
+
* @example
|
|
1908
|
+
* ```js
|
|
1909
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
|
|
1910
|
+
* // payload: { convId: string }
|
|
1911
|
+
* })
|
|
1912
|
+
* ```
|
|
1913
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1914
|
+
*/
|
|
1915
|
+
EmbedEvent["SpotterShareModalCancelButtonClicked"] = "spotterShareModalCancelButtonClicked";
|
|
1916
|
+
/**
|
|
1917
|
+
* Emitted when a recipient leaves the read-only shared view via the Exit
|
|
1918
|
+
* button.
|
|
1919
|
+
* @example
|
|
1920
|
+
* ```js
|
|
1921
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
|
|
1922
|
+
* // payload: { convId: string }
|
|
1923
|
+
* })
|
|
1924
|
+
* ```
|
|
1925
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1926
|
+
*/
|
|
1927
|
+
EmbedEvent["SpotterSharedConversationExitButtonClicked"] = "spotterSharedConversationExitButtonClicked";
|
|
1928
|
+
/**
|
|
1929
|
+
* Emitted when a Spotter conversation is pinned.
|
|
1930
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
1931
|
+
* @example
|
|
1932
|
+
* ```js
|
|
1933
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
|
|
1934
|
+
* console.log('Conversation pinned', payload);
|
|
1935
|
+
* // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
|
|
1936
|
+
* })
|
|
1937
|
+
* ```
|
|
1938
|
+
*/
|
|
1939
|
+
EmbedEvent["SpotterConversationPinned"] = "spotterConversationPinned";
|
|
1940
|
+
/**
|
|
1941
|
+
* Emitted when a Spotter conversation is unpinned.
|
|
1942
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
1943
|
+
* @example
|
|
1944
|
+
* ```js
|
|
1945
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
|
|
1946
|
+
* console.log('Conversation unpinned', payload);
|
|
1947
|
+
* // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
|
|
1948
|
+
* })
|
|
1949
|
+
* ```
|
|
1950
|
+
*/
|
|
1951
|
+
EmbedEvent["SpotterConversationUnpinned"] = "spotterConversationUnpinned";
|
|
1773
1952
|
/**
|
|
1774
1953
|
* Emitted when a Spotter conversation is selected/clicked.
|
|
1775
1954
|
* @example
|
|
@@ -1782,6 +1961,30 @@ export var EmbedEvent;
|
|
|
1782
1961
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
1783
1962
|
*/
|
|
1784
1963
|
EmbedEvent["SpotterConversationSelected"] = "spotterConversationSelected";
|
|
1964
|
+
/**
|
|
1965
|
+
* Emitted when the Spotter agent finishes streaming/rendering a response.
|
|
1966
|
+
* Includes the conversation and message identifiers so the host app can
|
|
1967
|
+
* fetch the full conversation history via the REST API if needed.
|
|
1968
|
+
*
|
|
1969
|
+
* The payload data has the shape `{ convId: string, messageId: string }`.
|
|
1970
|
+
*
|
|
1971
|
+
* Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
|
|
1972
|
+
* inside the full application).
|
|
1973
|
+
* @example
|
|
1974
|
+
* ```js
|
|
1975
|
+
* spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
1976
|
+
* console.log('Spotter response complete', payload);
|
|
1977
|
+
* })
|
|
1978
|
+
* ```
|
|
1979
|
+
* @example
|
|
1980
|
+
* ```js
|
|
1981
|
+
* appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
1982
|
+
* console.log('Spotter response complete', payload);
|
|
1983
|
+
* })
|
|
1984
|
+
* ```
|
|
1985
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1986
|
+
*/
|
|
1987
|
+
EmbedEvent["SpotterResponseComplete"] = "spotterResponseComplete";
|
|
1785
1988
|
/**
|
|
1786
1989
|
* @hidden
|
|
1787
1990
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -2262,6 +2465,17 @@ export var HostEvent;
|
|
|
2262
2465
|
* name: string,
|
|
2263
2466
|
* type: ATTRIBUTE/MEASURE,
|
|
2264
2467
|
* dataType: INT64/CHAR/DATE }
|
|
2468
|
+
*
|
|
2469
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
2470
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
2471
|
+
* scoped filter is opened. Available from SDK: 1.53.0 |
|
|
2472
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
2473
|
+
*
|
|
2474
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
2475
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
2476
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
2477
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
2478
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
2265
2479
|
* @example
|
|
2266
2480
|
* ```js
|
|
2267
2481
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
@@ -2274,6 +2488,14 @@ export var HostEvent;
|
|
|
2274
2488
|
* ```
|
|
2275
2489
|
* @example
|
|
2276
2490
|
* ```js
|
|
2491
|
+
* // Open a filter scoped to a specific Liveboard tab
|
|
2492
|
+
* liveboardEmbed.trigger(HostEvent.OpenFilter, {
|
|
2493
|
+
* column: { columnId: '<column-GUID>' },
|
|
2494
|
+
* applicability: { level: 'TAB', targetId: '<tab-GUID>' }
|
|
2495
|
+
* });
|
|
2496
|
+
* ```
|
|
2497
|
+
* @example
|
|
2498
|
+
* ```js
|
|
2277
2499
|
* // Open filter from search context
|
|
2278
2500
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2279
2501
|
* searchEmbed.trigger(HostEvent.OpenFilter, {
|
|
@@ -2283,6 +2505,38 @@ export var HostEvent;
|
|
|
2283
2505
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2284
2506
|
*/
|
|
2285
2507
|
HostEvent["OpenFilter"] = "openFilter";
|
|
2508
|
+
/**
|
|
2509
|
+
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
2510
|
+
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
2511
|
+
* @param - Includes the following keys:
|
|
2512
|
+
* - `parameter`: An object identifying the parameter to open, for
|
|
2513
|
+
* example, `{ parameterId: '<parameter-GUID>' }`.
|
|
2514
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
2515
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
2516
|
+
* scoped parameter is opened. Includes the following attributes:
|
|
2517
|
+
*
|
|
2518
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
2519
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
2520
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
2521
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
2522
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
2523
|
+
* @example
|
|
2524
|
+
* ```js
|
|
2525
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
2526
|
+
* parameter: { parameterId: '<parameter-GUID>' }
|
|
2527
|
+
* });
|
|
2528
|
+
* ```
|
|
2529
|
+
* @example
|
|
2530
|
+
* ```js
|
|
2531
|
+
* // Open a parameter scoped to a specific group
|
|
2532
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
2533
|
+
* parameter: { parameterId: '<parameter-GUID>' },
|
|
2534
|
+
* applicability: { level: 'GROUP', targetId: '<group-GUID>' }
|
|
2535
|
+
* });
|
|
2536
|
+
* ```
|
|
2537
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
2538
|
+
*/
|
|
2539
|
+
HostEvent["OpenParameter"] = "openParameter";
|
|
2286
2540
|
/**
|
|
2287
2541
|
* Add columns to the current search query.
|
|
2288
2542
|
* @param - { columnIds: string[] }
|
|
@@ -3347,6 +3601,14 @@ export var HostEvent;
|
|
|
3347
3601
|
/**
|
|
3348
3602
|
* Get details of filters applied on the Liveboard.
|
|
3349
3603
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
3604
|
+
* Each Liveboard filter includes an optional `applicability` attribute
|
|
3605
|
+
* indicating the scope of the filter. It contains a `level`
|
|
3606
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
3607
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
3608
|
+
* level there is no `targetId`, since the filter applies to the
|
|
3609
|
+
* whole Liveboard.
|
|
3610
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
3611
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
3350
3612
|
* @example
|
|
3351
3613
|
* ```js
|
|
3352
3614
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
@@ -3386,6 +3648,16 @@ export var HostEvent;
|
|
|
3386
3648
|
*
|
|
3387
3649
|
* `type` - To update filters for date time, specify the date format type.
|
|
3388
3650
|
* For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
|
|
3651
|
+
*
|
|
3652
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
3653
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
3654
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
3655
|
+
*
|
|
3656
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
3657
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
3658
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
3659
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
3660
|
+
* Liveboard.
|
|
3389
3661
|
* @example
|
|
3390
3662
|
* ```js
|
|
3391
3663
|
*
|
|
@@ -3462,6 +3734,21 @@ export var HostEvent;
|
|
|
3462
3734
|
* }
|
|
3463
3735
|
* }, ContextType.Liveboard);
|
|
3464
3736
|
* ```
|
|
3737
|
+
* @example
|
|
3738
|
+
* ```js
|
|
3739
|
+
* // Scope the filter to a specific Liveboard tab
|
|
3740
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
3741
|
+
* filter: {
|
|
3742
|
+
* column: "item type",
|
|
3743
|
+
* oper: "IN",
|
|
3744
|
+
* values: ["bags", "shirts"],
|
|
3745
|
+
* applicability: {
|
|
3746
|
+
* level: "TAB",
|
|
3747
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
3748
|
+
* }
|
|
3749
|
+
* }
|
|
3750
|
+
* });
|
|
3751
|
+
* ```
|
|
3465
3752
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3466
3753
|
*/
|
|
3467
3754
|
HostEvent["UpdateFilters"] = "updateFilters";
|
|
@@ -3486,6 +3773,28 @@ export var HostEvent;
|
|
|
3486
3773
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
3487
3774
|
*/
|
|
3488
3775
|
HostEvent["GetTabs"] = "getTabs";
|
|
3776
|
+
/**
|
|
3777
|
+
* Get group details for the current Liveboard.
|
|
3778
|
+
* Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
|
|
3779
|
+
* @example
|
|
3780
|
+
* ```js
|
|
3781
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
|
|
3782
|
+
* console.log(
|
|
3783
|
+
* groupDetails // GroupDetails of current Liveboard
|
|
3784
|
+
* );
|
|
3785
|
+
* })
|
|
3786
|
+
* ```
|
|
3787
|
+
* @example
|
|
3788
|
+
* ```js
|
|
3789
|
+
* // Get groups from liveboard context
|
|
3790
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3791
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
|
|
3792
|
+
* console.log('groups', groupDetails);
|
|
3793
|
+
* });
|
|
3794
|
+
* ```
|
|
3795
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
3796
|
+
*/
|
|
3797
|
+
HostEvent["GetGroups"] = "getGroups";
|
|
3489
3798
|
/**
|
|
3490
3799
|
* Set the visible tabs on a Liveboard.
|
|
3491
3800
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
@@ -3613,6 +3922,15 @@ export var HostEvent;
|
|
|
3613
3922
|
* - `name`: Name of the parameter.
|
|
3614
3923
|
* - `value`: The value to set for the parameter.
|
|
3615
3924
|
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
3925
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
3926
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
3927
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
3928
|
+
*
|
|
3929
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
3930
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
3931
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
3932
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
3933
|
+
* Liveboard.
|
|
3616
3934
|
*
|
|
3617
3935
|
* @example
|
|
3618
3936
|
* ```js
|
|
@@ -3624,6 +3942,18 @@ export var HostEvent;
|
|
|
3624
3942
|
* ```
|
|
3625
3943
|
* @example
|
|
3626
3944
|
* ```js
|
|
3945
|
+
* // Scope the parameter to a specific Liveboard tab
|
|
3946
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
3947
|
+
* name: "Integer Range Param",
|
|
3948
|
+
* value: 10,
|
|
3949
|
+
* applicability: {
|
|
3950
|
+
* level: "TAB",
|
|
3951
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
3952
|
+
* }
|
|
3953
|
+
* }])
|
|
3954
|
+
* ```
|
|
3955
|
+
* @example
|
|
3956
|
+
* ```js
|
|
3627
3957
|
* // Update parameters from liveboard context
|
|
3628
3958
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3629
3959
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -3637,6 +3967,14 @@ export var HostEvent;
|
|
|
3637
3967
|
HostEvent["UpdateParameters"] = "UpdateParameters";
|
|
3638
3968
|
/**
|
|
3639
3969
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
3970
|
+
* Each parameter includes an optional `applicability` attribute
|
|
3971
|
+
* indicating the scope of the parameter. It contains a `level`
|
|
3972
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
3973
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
3974
|
+
* level there is no `targetId`, since the parameter applies to the
|
|
3975
|
+
* whole Liveboard.
|
|
3976
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
3977
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
3640
3978
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
3641
3979
|
* ```js
|
|
3642
3980
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
@@ -3903,6 +4241,36 @@ export var HostEvent;
|
|
|
3903
4241
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3904
4242
|
*/
|
|
3905
4243
|
HostEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
|
|
4244
|
+
/**
|
|
4245
|
+
* Opens the Spotter share-conversation modal for the given conversation.
|
|
4246
|
+
* `conversationId` is **mandatory** — you must pass the id of the
|
|
4247
|
+
* conversation to share. Also no-op when sharing is disabled
|
|
4248
|
+
* (enableShareConversation off) or when already in the read-only shared view.
|
|
4249
|
+
* @example
|
|
4250
|
+
* ```js
|
|
4251
|
+
* spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
|
|
4252
|
+
* ```
|
|
4253
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4254
|
+
*/
|
|
4255
|
+
HostEvent["ShareSpotterConversation"] = "ShareSpotterConversation";
|
|
4256
|
+
/**
|
|
4257
|
+
* Closes the Spotter share-conversation modal. No-op if none is open.
|
|
4258
|
+
* @example
|
|
4259
|
+
* ```js
|
|
4260
|
+
* spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
|
|
4261
|
+
* ```
|
|
4262
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4263
|
+
*/
|
|
4264
|
+
HostEvent["CloseSpotterShareConversation"] = "CloseSpotterShareConversation";
|
|
4265
|
+
/**
|
|
4266
|
+
* Exits the read-only shared-conversation view.
|
|
4267
|
+
* @example
|
|
4268
|
+
* ```js
|
|
4269
|
+
* spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
|
|
4270
|
+
* ```
|
|
4271
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4272
|
+
*/
|
|
4273
|
+
HostEvent["ExitSpotterSharedConversation"] = "ExitSpotterSharedConversation";
|
|
3906
4274
|
/**
|
|
3907
4275
|
* Deletes the last prompt in spotter embed.
|
|
3908
4276
|
* @example
|
|
@@ -3998,6 +4366,41 @@ export var HostEvent;
|
|
|
3998
4366
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3999
4367
|
*/
|
|
4000
4368
|
HostEvent["StartNewSpotterConversation"] = "StartNewSpotterConversation";
|
|
4369
|
+
/**
|
|
4370
|
+
* Pins a saved Spotter conversation so it floats to the top of the past
|
|
4371
|
+
* conversations sidebar. The `conversationId` of the conversation to pin is
|
|
4372
|
+
* required.
|
|
4373
|
+
*
|
|
4374
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
4375
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
4376
|
+
* instance.
|
|
4377
|
+
*
|
|
4378
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
4379
|
+
* @example
|
|
4380
|
+
* ```js
|
|
4381
|
+
* spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
|
|
4382
|
+
* conversationId: '<conversation-id>',
|
|
4383
|
+
* });
|
|
4384
|
+
* ```
|
|
4385
|
+
*/
|
|
4386
|
+
HostEvent["PinSpotterConversation"] = "PinSpotterConversation";
|
|
4387
|
+
/**
|
|
4388
|
+
* Unpins a previously pinned Spotter conversation. The `conversationId` of the
|
|
4389
|
+
* conversation to unpin is required.
|
|
4390
|
+
*
|
|
4391
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
4392
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
4393
|
+
* instance.
|
|
4394
|
+
*
|
|
4395
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
4396
|
+
* @example
|
|
4397
|
+
* ```js
|
|
4398
|
+
* spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
|
|
4399
|
+
* conversationId: '<conversation-id>',
|
|
4400
|
+
* });
|
|
4401
|
+
* ```
|
|
4402
|
+
*/
|
|
4403
|
+
HostEvent["UnpinSpotterConversation"] = "UnpinSpotterConversation";
|
|
4001
4404
|
/**
|
|
4002
4405
|
* @hidden
|
|
4003
4406
|
* Get the current context of the embedded page.
|
|
@@ -4219,6 +4622,7 @@ export var Param;
|
|
|
4219
4622
|
Param["SpotterEnabled"] = "isSpotterExperienceEnabled";
|
|
4220
4623
|
Param["IsUnifiedSearchExperienceEnabled"] = "isUnifiedSearchExperienceEnabled";
|
|
4221
4624
|
Param["OverrideOrgId"] = "orgId";
|
|
4625
|
+
Param["OverrideHistoryState"] = "overrideHistoryState";
|
|
4222
4626
|
Param["OauthPollingInterval"] = "oAuthPollingInterval";
|
|
4223
4627
|
Param["IsForceRedirect"] = "isForceRedirect";
|
|
4224
4628
|
Param["DataSourceId"] = "dataSourceId";
|
|
@@ -4236,9 +4640,12 @@ export var Param;
|
|
|
4236
4640
|
Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
|
|
4237
4641
|
Param["isSendNowLiveboardSchedulingEnabled"] = "isSendNowLiveboardSchedulingEnabled";
|
|
4238
4642
|
Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
|
|
4643
|
+
Param["isScopedLiveboardFilteringEnabled"] = "isScopedLiveboardFilteringEnabled";
|
|
4239
4644
|
Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
|
|
4240
4645
|
Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
|
|
4241
4646
|
Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
|
|
4647
|
+
Param["ShowSpotterRadiance"] = "showSpotterRadiance";
|
|
4648
|
+
Param["DefaultQueryMode"] = "defaultQueryMode";
|
|
4242
4649
|
Param["EnableStopAnswerGenerationEmbed"] = "enableStopAnswerGenerationEmbed";
|
|
4243
4650
|
Param["SpotterSidebarTitle"] = "spotterSidebarTitle";
|
|
4244
4651
|
Param["SpotterSidebarDefaultExpanded"] = "spotterSidebarDefaultExpanded";
|
|
@@ -4258,6 +4665,8 @@ export var Param;
|
|
|
4258
4665
|
Param["SpotterFileUploadEnabled"] = "spotterFileUploadEnabled";
|
|
4259
4666
|
Param["SpotterFileUploadFileTypes"] = "spotterFileUploadFileTypes";
|
|
4260
4667
|
Param["IsStarterPromptsEnabled"] = "enableStarterPrompts";
|
|
4668
|
+
Param["UpdatedSpotterExperience"] = "updatedSpotterExperience";
|
|
4669
|
+
Param["SpotterDataSources"] = "spotterDataSources";
|
|
4261
4670
|
})(Param || (Param = {}));
|
|
4262
4671
|
/**
|
|
4263
4672
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -5522,6 +5931,19 @@ export var Action;
|
|
|
5522
5931
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
5523
5932
|
*/
|
|
5524
5933
|
Action["ChangeFilterVisibilityInTab"] = "changeFilterVisibilityInTab";
|
|
5934
|
+
/**
|
|
5935
|
+
* Action ID to show, hide, or disable all filter surfaces on a Liveboard,
|
|
5936
|
+
* including filter, parameter, and cross-filter chips at the liveboard,
|
|
5937
|
+
* tab, and group levels. Parameter and cross-filter chips are hide-only.
|
|
5938
|
+
*
|
|
5939
|
+
* @example
|
|
5940
|
+
* ```js
|
|
5941
|
+
* hiddenActions: [Action.AllLiveboardFilters]
|
|
5942
|
+
* disabledActions: [Action.AllLiveboardFilters]
|
|
5943
|
+
* ```
|
|
5944
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
5945
|
+
*/
|
|
5946
|
+
Action["AllLiveboardFilters"] = "allLiveboardFilters";
|
|
5525
5947
|
/**
|
|
5526
5948
|
* The **Data model instructions** button on the Spotter interface.
|
|
5527
5949
|
* Allows opening the data model instructions modal.
|
|
@@ -5857,6 +6279,89 @@ export var Action;
|
|
|
5857
6279
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
5858
6280
|
*/
|
|
5859
6281
|
Action["SpotterChatRename"] = "spotterChatRename";
|
|
6282
|
+
/**
|
|
6283
|
+
* Controls visibility and disable state of the Spotter conversation Share
|
|
6284
|
+
* button in the chat header. Only takes effect once sharing is enabled
|
|
6285
|
+
* (enableShareConversation on).
|
|
6286
|
+
* @example
|
|
6287
|
+
* ```js
|
|
6288
|
+
* disabledActions: [Action.SpotterShareConversationButtonHeader]
|
|
6289
|
+
* ```
|
|
6290
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6291
|
+
*/
|
|
6292
|
+
Action["SpotterShareConversationButtonHeader"] = "spotterShareConversationButtonHeader";
|
|
6293
|
+
/**
|
|
6294
|
+
* Controls visibility and disable state of the Share item in the Spotter
|
|
6295
|
+
* conversation history (sidebar) edit menu. Independent of the header button
|
|
6296
|
+
* above, so a host can show Share in one entry point and hide it in the other.
|
|
6297
|
+
* @example
|
|
6298
|
+
* ```js
|
|
6299
|
+
* disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
|
|
6300
|
+
* ```
|
|
6301
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6302
|
+
*/
|
|
6303
|
+
Action["SpotterShareConversationMenuItemSidebar"] = "spotterShareConversationMenuItemSidebar";
|
|
6304
|
+
/**
|
|
6305
|
+
* Controls visibility of the entire read-only shared-conversation data-access
|
|
6306
|
+
* banner shown when a recipient opens a shared view. Hide-only.
|
|
6307
|
+
* @example
|
|
6308
|
+
* ```js
|
|
6309
|
+
* hiddenActions: [Action.SpotterSharedConversationBanner]
|
|
6310
|
+
* ```
|
|
6311
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6312
|
+
*/
|
|
6313
|
+
Action["SpotterSharedConversationBanner"] = "spotterSharedConversationBanner";
|
|
6314
|
+
/**
|
|
6315
|
+
* Controls visibility and disable state of the cross/close button on the
|
|
6316
|
+
* read-only shared-conversation data-access banner (keeps the banner itself).
|
|
6317
|
+
* @example
|
|
6318
|
+
* ```js
|
|
6319
|
+
* hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
|
|
6320
|
+
* ```
|
|
6321
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6322
|
+
*/
|
|
6323
|
+
Action["SpotterSharedConversationBannerDismissButton"] = "spotterSharedConversationBannerDismissButton";
|
|
6324
|
+
/**
|
|
6325
|
+
* Controls visibility and disable state of the Exit button in the read-only
|
|
6326
|
+
* shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
|
|
6327
|
+
* host event.
|
|
6328
|
+
* @example
|
|
6329
|
+
* ```js
|
|
6330
|
+
* hiddenActions: [Action.SpotterSharedConversationExitButton]
|
|
6331
|
+
* ```
|
|
6332
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6333
|
+
*/
|
|
6334
|
+
Action["SpotterSharedConversationExitButton"] = "spotterSharedConversationExitButton";
|
|
6335
|
+
/**
|
|
6336
|
+
* Controls visibility of the share-modal footer note ("Chat will be shared up
|
|
6337
|
+
* to the current moment…"). Hide-only.
|
|
6338
|
+
* @example
|
|
6339
|
+
* ```js
|
|
6340
|
+
* hiddenActions: [Action.SpotterShareUpToCurrentInfo]
|
|
6341
|
+
* ```
|
|
6342
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6343
|
+
*/
|
|
6344
|
+
Action["SpotterShareUpToCurrentInfo"] = "spotterShareUpToCurrentInfo";
|
|
6345
|
+
/**
|
|
6346
|
+
* Controls visibility and disable state of the share-modal "include new
|
|
6347
|
+
* messages since last shared version" checkbox.
|
|
6348
|
+
* @example
|
|
6349
|
+
* ```js
|
|
6350
|
+
* disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
|
|
6351
|
+
* ```
|
|
6352
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6353
|
+
*/
|
|
6354
|
+
Action["SpotterShareIncludeNewMessagesCheckbox"] = "spotterShareIncludeNewMessagesCheckbox";
|
|
6355
|
+
/**
|
|
6356
|
+
* Controls visibility and disable state of the cross on the share-modal
|
|
6357
|
+
* stale-snapshot info banner.
|
|
6358
|
+
* @example
|
|
6359
|
+
* ```js
|
|
6360
|
+
* hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
|
|
6361
|
+
* ```
|
|
6362
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6363
|
+
*/
|
|
6364
|
+
Action["SpotterShareStaleInfoBannerDismissButton"] = "spotterShareStaleInfoBannerDismissButton";
|
|
5860
6365
|
/**
|
|
5861
6366
|
* Controls visibility and disable state of the delete action
|
|
5862
6367
|
* in the Spotter conversation edit menu.
|
|
@@ -5867,6 +6372,16 @@ export var Action;
|
|
|
5867
6372
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
5868
6373
|
*/
|
|
5869
6374
|
Action["SpotterChatDelete"] = "spotterChatDelete";
|
|
6375
|
+
/**
|
|
6376
|
+
* Controls visibility and disable state of the pin/unpin action
|
|
6377
|
+
* in the Spotter conversation edit menu.
|
|
6378
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6379
|
+
* @example
|
|
6380
|
+
* ```js
|
|
6381
|
+
* disabledActions: [Action.SpotterChatPin]
|
|
6382
|
+
* ```
|
|
6383
|
+
*/
|
|
6384
|
+
Action["SpotterChatPin"] = "spotterChatPin";
|
|
5870
6385
|
/**
|
|
5871
6386
|
* Controls visibility and disable state of the documentation/best practices
|
|
5872
6387
|
* link in the Spotter sidebar footer.
|
|
@@ -6345,6 +6860,8 @@ export var EmbedErrorCodes;
|
|
|
6345
6860
|
EmbedErrorCodes["UPDATEFILTERS_INVALID_PAYLOAD"] = "UPDATEFILTERS_INVALID_PAYLOAD";
|
|
6346
6861
|
/** DrillDown payload is invalid - missing or malformed points */
|
|
6347
6862
|
EmbedErrorCodes["DRILLDOWN_INVALID_PAYLOAD"] = "DRILLDOWN_INVALID_PAYLOAD";
|
|
6863
|
+
/** UpdateParameters payload is invalid - malformed applicability */
|
|
6864
|
+
EmbedErrorCodes["UPDATEPARAMETERS_INVALID_PAYLOAD"] = "UPDATEPARAMETERS_INVALID_PAYLOAD";
|
|
6348
6865
|
})(EmbedErrorCodes || (EmbedErrorCodes = {}));
|
|
6349
6866
|
/**
|
|
6350
6867
|
* Context types for specifying the page context when triggering host events.
|