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