@thoughtspot/visual-embed-sdk 1.50.1 → 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.
Files changed (156) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/css-variables.d.ts +36 -0
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +106 -14
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +47 -36
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +318 -149
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/conversation.d.ts +204 -1
  11. package/cjs/src/embed/conversation.d.ts.map +1 -1
  12. package/cjs/src/embed/conversation.js +19 -15
  13. package/cjs/src/embed/conversation.js.map +1 -1
  14. package/cjs/src/embed/conversation.spec.js +198 -17
  15. package/cjs/src/embed/conversation.spec.js.map +1 -1
  16. package/cjs/src/embed/events.spec.js +42 -0
  17. package/cjs/src/embed/events.spec.js.map +1 -1
  18. package/cjs/src/embed/host-events.spec.js +45 -0
  19. package/cjs/src/embed/host-events.spec.js.map +1 -1
  20. package/cjs/src/embed/hostEventClient/contracts.d.ts +15 -0
  21. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  22. package/cjs/src/embed/hostEventClient/contracts.js +1 -0
  23. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  24. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  25. package/cjs/src/embed/hostEventClient/host-event-client.js +1 -0
  26. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  27. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +9 -0
  28. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  29. package/cjs/src/embed/liveboard.d.ts +36 -1
  30. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  31. package/cjs/src/embed/liveboard.js +26 -6
  32. package/cjs/src/embed/liveboard.js.map +1 -1
  33. package/cjs/src/embed/liveboard.spec.js +83 -2
  34. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  35. package/cjs/src/embed/spotter-utils.d.ts +8 -1
  36. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  37. package/cjs/src/embed/spotter-utils.js +14 -1
  38. package/cjs/src/embed/spotter-utils.js.map +1 -1
  39. package/cjs/src/embed/spotter-utils.spec.js +61 -0
  40. package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
  41. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  42. package/cjs/src/embed/ts-embed.js +15 -0
  43. package/cjs/src/embed/ts-embed.js.map +1 -1
  44. package/cjs/src/index.d.ts +2 -2
  45. package/cjs/src/index.d.ts.map +1 -1
  46. package/cjs/src/index.js.map +1 -1
  47. package/cjs/src/mixpanel-service.d.ts +4 -0
  48. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  49. package/cjs/src/mixpanel-service.js +4 -0
  50. package/cjs/src/mixpanel-service.js.map +1 -1
  51. package/cjs/src/types.d.ts +460 -15
  52. package/cjs/src/types.d.ts.map +1 -1
  53. package/cjs/src/types.js +428 -8
  54. package/cjs/src/types.js.map +1 -1
  55. package/dist/{index-fCne7kmU.js → index-aBzH5ZwF.js} +1 -1
  56. package/dist/src/css-variables.d.ts +36 -0
  57. package/dist/src/css-variables.d.ts.map +1 -1
  58. package/dist/src/embed/app.d.ts +106 -14
  59. package/dist/src/embed/app.d.ts.map +1 -1
  60. package/dist/src/embed/conversation.d.ts +204 -1
  61. package/dist/src/embed/conversation.d.ts.map +1 -1
  62. package/dist/src/embed/hostEventClient/contracts.d.ts +15 -0
  63. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  64. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  65. package/dist/src/embed/liveboard.d.ts +36 -1
  66. package/dist/src/embed/liveboard.d.ts.map +1 -1
  67. package/dist/src/embed/spotter-utils.d.ts +8 -1
  68. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  69. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  70. package/dist/src/index.d.ts +2 -2
  71. package/dist/src/index.d.ts.map +1 -1
  72. package/dist/src/mixpanel-service.d.ts +4 -0
  73. package/dist/src/mixpanel-service.d.ts.map +1 -1
  74. package/dist/src/types.d.ts +460 -15
  75. package/dist/src/types.d.ts.map +1 -1
  76. package/dist/tsembed-react.es.js +558 -69
  77. package/dist/tsembed-react.js +557 -68
  78. package/dist/tsembed.es.js +556 -68
  79. package/dist/tsembed.js +555 -67
  80. package/dist/visual-embed-sdk-react-full.d.ts +845 -27
  81. package/dist/visual-embed-sdk-react.d.ts +851 -29
  82. package/dist/visual-embed-sdk.d.ts +855 -29
  83. package/lib/package.json +1 -1
  84. package/lib/src/css-variables.d.ts +36 -0
  85. package/lib/src/css-variables.d.ts.map +1 -1
  86. package/lib/src/embed/app.d.ts +106 -14
  87. package/lib/src/embed/app.d.ts.map +1 -1
  88. package/lib/src/embed/app.js +48 -37
  89. package/lib/src/embed/app.js.map +1 -1
  90. package/lib/src/embed/app.spec.js +319 -150
  91. package/lib/src/embed/app.spec.js.map +1 -1
  92. package/lib/src/embed/conversation.d.ts +204 -1
  93. package/lib/src/embed/conversation.d.ts.map +1 -1
  94. package/lib/src/embed/conversation.js +21 -17
  95. package/lib/src/embed/conversation.js.map +1 -1
  96. package/lib/src/embed/conversation.spec.js +198 -17
  97. package/lib/src/embed/conversation.spec.js.map +1 -1
  98. package/lib/src/embed/events.spec.js +42 -0
  99. package/lib/src/embed/events.spec.js.map +1 -1
  100. package/lib/src/embed/host-events.spec.js +45 -0
  101. package/lib/src/embed/host-events.spec.js.map +1 -1
  102. package/lib/src/embed/hostEventClient/contracts.d.ts +15 -0
  103. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  104. package/lib/src/embed/hostEventClient/contracts.js +1 -0
  105. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  106. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  107. package/lib/src/embed/hostEventClient/host-event-client.js +1 -0
  108. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  109. package/lib/src/embed/hostEventClient/host-event-client.spec.js +9 -0
  110. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  111. package/lib/src/embed/liveboard.d.ts +36 -1
  112. package/lib/src/embed/liveboard.d.ts.map +1 -1
  113. package/lib/src/embed/liveboard.js +26 -6
  114. package/lib/src/embed/liveboard.js.map +1 -1
  115. package/lib/src/embed/liveboard.spec.js +83 -2
  116. package/lib/src/embed/liveboard.spec.js.map +1 -1
  117. package/lib/src/embed/spotter-utils.d.ts +8 -1
  118. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  119. package/lib/src/embed/spotter-utils.js +12 -0
  120. package/lib/src/embed/spotter-utils.js.map +1 -1
  121. package/lib/src/embed/spotter-utils.spec.js +62 -1
  122. package/lib/src/embed/spotter-utils.spec.js.map +1 -1
  123. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  124. package/lib/src/embed/ts-embed.js +15 -0
  125. package/lib/src/embed/ts-embed.js.map +1 -1
  126. package/lib/src/index.d.ts +2 -2
  127. package/lib/src/index.d.ts.map +1 -1
  128. package/lib/src/index.js.map +1 -1
  129. package/lib/src/mixpanel-service.d.ts +4 -0
  130. package/lib/src/mixpanel-service.d.ts.map +1 -1
  131. package/lib/src/mixpanel-service.js +4 -0
  132. package/lib/src/mixpanel-service.js.map +1 -1
  133. package/lib/src/types.d.ts +460 -15
  134. package/lib/src/types.d.ts.map +1 -1
  135. package/lib/src/types.js +428 -8
  136. package/lib/src/types.js.map +1 -1
  137. package/lib/src/visual-embed-sdk.d.ts +855 -29
  138. package/package.json +1 -1
  139. package/src/css-variables.ts +45 -0
  140. package/src/embed/app.spec.ts +390 -183
  141. package/src/embed/app.ts +172 -65
  142. package/src/embed/conversation.spec.ts +243 -20
  143. package/src/embed/conversation.ts +233 -17
  144. package/src/embed/events.spec.ts +52 -0
  145. package/src/embed/host-events.spec.ts +70 -0
  146. package/src/embed/hostEventClient/contracts.ts +16 -0
  147. package/src/embed/hostEventClient/host-event-client.spec.ts +12 -0
  148. package/src/embed/hostEventClient/host-event-client.ts +1 -0
  149. package/src/embed/liveboard.spec.ts +108 -2
  150. package/src/embed/liveboard.ts +76 -14
  151. package/src/embed/spotter-utils.spec.ts +68 -1
  152. package/src/embed/spotter-utils.ts +16 -1
  153. package/src/embed/ts-embed.ts +18 -0
  154. package/src/index.ts +2 -1
  155. package/src/mixpanel-service.ts +4 -0
  156. package/src/types.ts +462 -14
package/lib/src/types.js CHANGED
@@ -172,7 +172,9 @@ export var AuthType;
172
172
  })(AuthType || (AuthType = {}));
173
173
  /**
174
174
  *
175
- * **Note**: This attribute is not supported in the classic (V1) homepage experience.
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;
@@ -319,7 +321,9 @@ export var RuntimeFilterOp;
319
321
  * via `hiddenHomepageModules` and reordered via
320
322
  * `reorderedHomepageModules`.
321
323
  *
322
- * **Note**: This option is not supported in the classic (v1) experience.
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.
323
327
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
324
328
  */
325
329
  export var HomepageModule;
@@ -1277,11 +1281,19 @@ export var EmbedEvent;
1277
1281
  * Emitted when a user changes any filter on a Liveboard.
1278
1282
  * Returns filter type and name, column name and ID, and runtime
1279
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.
1280
1291
  * @example
1281
1292
  *
1282
1293
  * ```js
1283
1294
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
1284
1295
  * console.log('payload', payload);
1296
+ * // payload.data optionally includes applicability: { level, targetId }
1285
1297
  * })
1286
1298
  * ```
1287
1299
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
@@ -1473,9 +1485,17 @@ export var EmbedEvent;
1473
1485
  /**
1474
1486
  * Emitted when parameter changes in an Answer
1475
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.
1476
1495
  * ```js
1477
1496
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
1478
1497
  * console.log('payload', payload);
1498
+ * // payload.data optionally includes applicability: { level, targetId }
1479
1499
  * })
1480
1500
  * ```
1481
1501
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
@@ -1777,6 +1797,158 @@ export var EmbedEvent;
1777
1797
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
1778
1798
  */
1779
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";
1780
1952
  /**
1781
1953
  * Emitted when a Spotter conversation is selected/clicked.
1782
1954
  * @example
@@ -2293,6 +2465,17 @@ export var HostEvent;
2293
2465
  * name: string,
2294
2466
  * type: ATTRIBUTE/MEASURE,
2295
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.
2296
2479
  * @example
2297
2480
  * ```js
2298
2481
  * searchEmbed.trigger(HostEvent.OpenFilter,
@@ -2305,6 +2488,14 @@ export var HostEvent;
2305
2488
  * ```
2306
2489
  * @example
2307
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
2308
2499
  * // Open filter from search context
2309
2500
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
2310
2501
  * searchEmbed.trigger(HostEvent.OpenFilter, {
@@ -2314,6 +2505,38 @@ export var HostEvent;
2314
2505
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2315
2506
  */
2316
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";
2317
2540
  /**
2318
2541
  * Add columns to the current search query.
2319
2542
  * @param - { columnIds: string[] }
@@ -3378,13 +3601,13 @@ export var HostEvent;
3378
3601
  /**
3379
3602
  * Get details of filters applied on the Liveboard.
3380
3603
  * Returns arrays containing Liveboard filter and runtime filter elements.
3381
- * Each Liveboard filter may include an `applicability` attribute
3604
+ * Each Liveboard filter includes an optional `applicability` attribute
3382
3605
  * indicating the scope of the filter. It contains a `level`
3383
3606
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
3384
3607
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
3385
3608
  * level there is no `targetId`, since the filter applies to the
3386
3609
  * whole Liveboard.
3387
- * The `applicability` attribute is available from SDK: 1.51.0 |
3610
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3388
3611
  * ThoughtSpot: 26.10.0.cl.
3389
3612
  * @example
3390
3613
  * ```js
@@ -3427,7 +3650,7 @@ export var HostEvent;
3427
3650
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
3428
3651
  *
3429
3652
  * `applicability` - Optional. Scopes the filter to a specific target,
3430
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
3653
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
3431
3654
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
3432
3655
  *
3433
3656
  * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -3550,6 +3773,28 @@ export var HostEvent;
3550
3773
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
3551
3774
  */
3552
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";
3553
3798
  /**
3554
3799
  * Set the visible tabs on a Liveboard.
3555
3800
  * @param - an array of ids of tabs to show, the IDs not passed
@@ -3678,7 +3923,7 @@ export var HostEvent;
3678
3923
  * - `value`: The value to set for the parameter.
3679
3924
  * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
3680
3925
  * - `applicability`: Optional. Scopes the parameter to a specific target,
3681
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
3926
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
3682
3927
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
3683
3928
  *
3684
3929
  * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -3722,13 +3967,13 @@ export var HostEvent;
3722
3967
  HostEvent["UpdateParameters"] = "UpdateParameters";
3723
3968
  /**
3724
3969
  * Triggers GetParameters to fetch the runtime Parameters.
3725
- * Each parameter may include an `applicability` attribute
3970
+ * Each parameter includes an optional `applicability` attribute
3726
3971
  * indicating the scope of the parameter. It contains a `level`
3727
3972
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
3728
3973
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
3729
3974
  * level there is no `targetId`, since the parameter applies to the
3730
3975
  * whole Liveboard.
3731
- * The `applicability` attribute is available from SDK: 1.51.0 |
3976
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3732
3977
  * ThoughtSpot: 26.10.0.cl.
3733
3978
  * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3734
3979
  * ```js
@@ -3996,6 +4241,36 @@ export var HostEvent;
3996
4241
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3997
4242
  */
3998
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";
3999
4274
  /**
4000
4275
  * Deletes the last prompt in spotter embed.
4001
4276
  * @example
@@ -4091,6 +4366,41 @@ export var HostEvent;
4091
4366
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4092
4367
  */
4093
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";
4094
4404
  /**
4095
4405
  * @hidden
4096
4406
  * Get the current context of the embedded page.
@@ -4330,9 +4640,11 @@ export var Param;
4330
4640
  Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
4331
4641
  Param["isSendNowLiveboardSchedulingEnabled"] = "isSendNowLiveboardSchedulingEnabled";
4332
4642
  Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
4643
+ Param["isScopedLiveboardFilteringEnabled"] = "isScopedLiveboardFilteringEnabled";
4333
4644
  Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
4334
4645
  Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
4335
4646
  Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
4647
+ Param["ShowSpotterRadiance"] = "showSpotterRadiance";
4336
4648
  Param["DefaultQueryMode"] = "defaultQueryMode";
4337
4649
  Param["EnableStopAnswerGenerationEmbed"] = "enableStopAnswerGenerationEmbed";
4338
4650
  Param["SpotterSidebarTitle"] = "spotterSidebarTitle";
@@ -4353,6 +4665,8 @@ export var Param;
4353
4665
  Param["SpotterFileUploadEnabled"] = "spotterFileUploadEnabled";
4354
4666
  Param["SpotterFileUploadFileTypes"] = "spotterFileUploadFileTypes";
4355
4667
  Param["IsStarterPromptsEnabled"] = "enableStarterPrompts";
4668
+ Param["UpdatedSpotterExperience"] = "updatedSpotterExperience";
4669
+ Param["SpotterDataSources"] = "spotterDataSources";
4356
4670
  })(Param || (Param = {}));
4357
4671
  /**
4358
4672
  * ThoughtSpot application pages include actions and menu commands
@@ -5617,6 +5931,19 @@ export var Action;
5617
5931
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
5618
5932
  */
5619
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";
5620
5947
  /**
5621
5948
  * The **Data model instructions** button on the Spotter interface.
5622
5949
  * Allows opening the data model instructions modal.
@@ -5952,6 +6279,89 @@ export var Action;
5952
6279
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
5953
6280
  */
5954
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";
5955
6365
  /**
5956
6366
  * Controls visibility and disable state of the delete action
5957
6367
  * in the Spotter conversation edit menu.
@@ -5962,6 +6372,16 @@ export var Action;
5962
6372
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
5963
6373
  */
5964
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";
5965
6385
  /**
5966
6386
  * Controls visibility and disable state of the documentation/best practices
5967
6387
  * link in the Spotter sidebar footer.