@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
@@ -169,7 +169,9 @@ export declare enum AuthType {
169
169
  }
170
170
  /**
171
171
  *
172
- * **Note**: This attribute is not supported in the classic (V1) homepage experience.
172
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
173
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
174
+ * V4 (Focused) home page experiences.
173
175
  *
174
176
  */
175
177
  export declare enum HomeLeftNavItem {
@@ -1567,7 +1569,9 @@ export interface HomePageConfig {
1567
1569
  * To specify the modules, import the `HomepageModule` enum.
1568
1570
  * For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
1569
1571
  *
1570
- * **Note**: This attribute is not supported in the classic (v1) experience.
1572
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
1573
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
1574
+ * and V4 (Focused) home page experiences.
1571
1575
  *
1572
1576
  * Supported embed types: `AppEmbed`
1573
1577
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1576,7 +1580,7 @@ export interface HomePageConfig {
1576
1580
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
1577
1581
  *
1578
1582
  * const embed = new AppEmbed('#tsEmbed', {
1579
- * ... // V2/V3 navigation and home page experience attributes
1583
+ * ... // V3 navigation and home page experience attributes
1580
1584
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
1581
1585
  * //...other embed view configuration attributes
1582
1586
  * })
@@ -1587,8 +1591,11 @@ export interface HomePageConfig {
1587
1591
  * Reorder home page modules.
1588
1592
  * To specify the modules, import the `HomepageModule` enum.
1589
1593
  * For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
1590
- * HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
1591
- * classic (v1) homepage.
1594
+ * HomepageModule.Watchlist]`
1595
+ *
1596
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
1597
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
1598
+ * and V4 (Focused) home page experiences.
1592
1599
  *
1593
1600
  * Supported embed types: `AppEmbed`
1594
1601
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1597,7 +1604,7 @@ export interface HomePageConfig {
1597
1604
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
1598
1605
  *
1599
1606
  * const embed = new AppEmbed('#tsEmbed', {
1600
- * ...//V2/V3 navigation and home page experience attributes
1607
+ * ...//V3 navigation and home page experience attributes
1601
1608
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
1602
1609
  * //... other embed view configuration attributes
1603
1610
  * })
@@ -1609,7 +1616,9 @@ export interface HomePageConfig {
1609
1616
  * on the home page left navigation panel.
1610
1617
  * To specify the menu items, import the `HomeLeftNavItem` enum.
1611
1618
  *
1612
- * **Note**: This attribute is not supported in the classic (v1) homepage.
1619
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
1620
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
1621
+ * and V4 (Focused) home page experiences.
1613
1622
  *
1614
1623
  * Supported embed types: `AppEmbed`
1615
1624
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -1985,6 +1994,24 @@ export interface LiveboardAppEmbedViewConfig {
1985
1994
  * ```
1986
1995
  */
1987
1996
  isCentralizedLiveboardFilterUXEnabled?: boolean;
1997
+ /**
1998
+ * This flag is used to enable or disable scoped Liveboard filtering.
1999
+ * When enabled, filters and parameters can be scoped to a group of
2000
+ * visualizations on a Liveboard, in addition to the Liveboard and
2001
+ * tab levels.
2002
+ *
2003
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2004
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
2005
+ * @example
2006
+ * ```js
2007
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
2008
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2009
+ * ... // other embed view config
2010
+ * isScopedLiveboardFilteringEnabled: true,
2011
+ * })
2012
+ * ```
2013
+ */
2014
+ isScopedLiveboardFilteringEnabled?: boolean;
1988
2015
  /**
1989
2016
  * This flag is used to enable or disable the link parameters in liveboard.
1990
2017
  *
@@ -2183,7 +2210,9 @@ export declare enum RuntimeFilterOp {
2183
2210
  * via `hiddenHomepageModules` and reordered via
2184
2211
  * `reorderedHomepageModules`.
2185
2212
  *
2186
- * **Note**: This option is not supported in the classic (v1) experience.
2213
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
2214
+ * deprecated. These modules apply to V3 (ModularWithStylingChanges) and
2215
+ * V4 (Focused) home page experiences.
2187
2216
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2188
2217
  */
2189
2218
  export declare enum HomepageModule {
@@ -3172,11 +3201,19 @@ export declare enum EmbedEvent {
3172
3201
  * Emitted when a user changes any filter on a Liveboard.
3173
3202
  * Returns filter type and name, column name and ID, and runtime
3174
3203
  * filter details.
3204
+ * The payload includes an optional `applicability` attribute indicating the
3205
+ * scope of the changed filter. It contains a `level` (`LIVEBOARD`,
3206
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
3207
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
3208
+ * is no `targetId`, since the filter applies to the whole Liveboard.
3209
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3210
+ * ThoughtSpot: 26.10.0.cl.
3175
3211
  * @example
3176
3212
  *
3177
3213
  * ```js
3178
3214
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3179
3215
  * console.log('payload', payload);
3216
+ * // payload.data optionally includes applicability: { level, targetId }
3180
3217
  * })
3181
3218
  * ```
3182
3219
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
@@ -3368,9 +3405,17 @@ export declare enum EmbedEvent {
3368
3405
  /**
3369
3406
  * Emitted when parameter changes in an Answer
3370
3407
  * or Liveboard.
3408
+ * The payload includes an optional `applicability` attribute indicating the
3409
+ * scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
3410
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
3411
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
3412
+ * is no `targetId`, since the parameter applies to the whole Liveboard.
3413
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3414
+ * ThoughtSpot: 26.10.0.cl.
3371
3415
  * ```js
3372
3416
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
3373
3417
  * console.log('payload', payload);
3418
+ * // payload.data optionally includes applicability: { level, targetId }
3374
3419
  * })
3375
3420
  * ```
3376
3421
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
@@ -3672,6 +3717,158 @@ export declare enum EmbedEvent {
3672
3717
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
3673
3718
  */
3674
3719
  SpotterConversationDeleted = "spotterConversationDeleted",
3720
+ /**
3721
+ * Emitted when the header Share button is clicked. Fires `Start` then `End`
3722
+ * to bracket the interaction. App→host counterpart of the
3723
+ * `ShareSpotterConversation` host event (user-driven vs programmatic open).
3724
+ * @example
3725
+ * ```js
3726
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
3727
+ * // payload: { convId: string }
3728
+ * })
3729
+ * ```
3730
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3731
+ */
3732
+ SpotterShareConversationButtonHeaderClicked = "spotterShareConversationButtonHeaderClicked",
3733
+ /**
3734
+ * Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
3735
+ * to bracket the interaction.
3736
+ * @example
3737
+ * ```js
3738
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
3739
+ * // payload: { convId: string }
3740
+ * })
3741
+ * ```
3742
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3743
+ */
3744
+ SpotterShareConversationMenuItemSidebarClicked = "spotterShareConversationMenuItemSidebarClicked",
3745
+ /**
3746
+ * Emitted when a Spotter conversation is shared (recipients added, or a new
3747
+ * share created). The host builds its own link from shareId/convId + its
3748
+ * configured CONVERSATION_URL — no link string is sent. Distinct from
3749
+ * `SpotterShareModalConfirmButtonClicked`, which fires at click time before
3750
+ * the save resolves.
3751
+ * @example
3752
+ * ```js
3753
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
3754
+ * // payload: { convId: string, shareId: string,
3755
+ * // recipientsAdded: string[], recipientsRemoved: string[] }
3756
+ * })
3757
+ * ```
3758
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3759
+ */
3760
+ SpotterConversationShared = "spotterConversationShared",
3761
+ /**
3762
+ * Emitted when access to a shared Spotter conversation is revoked
3763
+ * (recipients removed). `fullyRevoked` is true when the last sharee is removed
3764
+ * and the share is deleted entirely.
3765
+ * @example
3766
+ * ```js
3767
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
3768
+ * // payload: { convId: string, shareId: string,
3769
+ * // recipientsRemoved: string[], fullyRevoked: boolean }
3770
+ * })
3771
+ * ```
3772
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3773
+ */
3774
+ SpotterConversationShareRevoked = "spotterConversationShareRevoked",
3775
+ /**
3776
+ * Emitted when a recipient opens a shared Spotter conversation (read-only
3777
+ * view). No shareId available viewer-side.
3778
+ * @example
3779
+ * ```js
3780
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
3781
+ * // payload: { convId: string, sourceConvId: string }
3782
+ * // convId = resolved snapshot conv id; sourceConvId = the shared URL id
3783
+ * })
3784
+ * ```
3785
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3786
+ */
3787
+ SpotterSharedConversationViewed = "spotterSharedConversationViewed",
3788
+ /**
3789
+ * Emitted when the user toggles the share-modal "include new messages since
3790
+ * last shared version" checkbox.
3791
+ * @example
3792
+ * ```js
3793
+ * spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
3794
+ * // payload: { convId: string, includeNewMessages: boolean }
3795
+ * })
3796
+ * ```
3797
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3798
+ */
3799
+ SpotterShareIncludeNewMessagesCheckboxToggled = "spotterShareIncludeNewMessagesCheckboxToggled",
3800
+ /**
3801
+ * Emitted when the user dismisses the stale-snapshot info banner via its
3802
+ * cross (distinct from the include-new-messages checkbox toggle).
3803
+ * @example
3804
+ * ```js
3805
+ * spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
3806
+ * // payload: { convId: string }
3807
+ * })
3808
+ * ```
3809
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3810
+ */
3811
+ SpotterShareStaleInfoBannerDismissed = "spotterShareStaleInfoBannerDismissed",
3812
+ /**
3813
+ * Emitted when the modal Share (confirm) button is clicked — fires at click
3814
+ * time, before the save resolves. Distinct from the `SpotterConversationShared`
3815
+ * / `SpotterConversationShareRevoked` result events.
3816
+ * @example
3817
+ * ```js
3818
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
3819
+ * // payload: { convId: string }
3820
+ * })
3821
+ * ```
3822
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3823
+ */
3824
+ SpotterShareModalConfirmButtonClicked = "spotterShareModalConfirmButtonClicked",
3825
+ /**
3826
+ * Emitted when the share modal is dismissed via the Cancel button.
3827
+ * @example
3828
+ * ```js
3829
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
3830
+ * // payload: { convId: string }
3831
+ * })
3832
+ * ```
3833
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3834
+ */
3835
+ SpotterShareModalCancelButtonClicked = "spotterShareModalCancelButtonClicked",
3836
+ /**
3837
+ * Emitted when a recipient leaves the read-only shared view via the Exit
3838
+ * button.
3839
+ * @example
3840
+ * ```js
3841
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
3842
+ * // payload: { convId: string }
3843
+ * })
3844
+ * ```
3845
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
3846
+ */
3847
+ SpotterSharedConversationExitButtonClicked = "spotterSharedConversationExitButtonClicked",
3848
+ /**
3849
+ * Emitted when a Spotter conversation is pinned.
3850
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
3851
+ * @example
3852
+ * ```js
3853
+ * spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
3854
+ * console.log('Conversation pinned', payload);
3855
+ * // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
3856
+ * })
3857
+ * ```
3858
+ */
3859
+ SpotterConversationPinned = "spotterConversationPinned",
3860
+ /**
3861
+ * Emitted when a Spotter conversation is unpinned.
3862
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
3863
+ * @example
3864
+ * ```js
3865
+ * spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
3866
+ * console.log('Conversation unpinned', payload);
3867
+ * // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
3868
+ * })
3869
+ * ```
3870
+ */
3871
+ SpotterConversationUnpinned = "spotterConversationUnpinned",
3675
3872
  /**
3676
3873
  * Emitted when a Spotter conversation is selected/clicked.
3677
3874
  * @example
@@ -4187,6 +4384,17 @@ export declare enum HostEvent {
4187
4384
  * name: string,
4188
4385
  * type: ATTRIBUTE/MEASURE,
4189
4386
  * dataType: INT64/CHAR/DATE }
4387
+ *
4388
+ * `applicability` - Optional. Scopes the filter to a specific target,
4389
+ * for example, a single Liveboard tab, so the panel for the correct
4390
+ * scoped filter is opened. Available from SDK: 1.53.0 |
4391
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
4392
+ *
4393
+ * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
4394
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
4395
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
4396
+ * `level` is `LIVEBOARD`, since the filter applies to the whole
4397
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
4190
4398
  * @example
4191
4399
  * ```js
4192
4400
  * searchEmbed.trigger(HostEvent.OpenFilter,
@@ -4199,6 +4407,14 @@ export declare enum HostEvent {
4199
4407
  * ```
4200
4408
  * @example
4201
4409
  * ```js
4410
+ * // Open a filter scoped to a specific Liveboard tab
4411
+ * liveboardEmbed.trigger(HostEvent.OpenFilter, {
4412
+ * column: { columnId: '<column-GUID>' },
4413
+ * applicability: { level: 'TAB', targetId: '<tab-GUID>' }
4414
+ * });
4415
+ * ```
4416
+ * @example
4417
+ * ```js
4202
4418
  * // Open filter from search context
4203
4419
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4204
4420
  * searchEmbed.trigger(HostEvent.OpenFilter, {
@@ -4208,6 +4424,38 @@ export declare enum HostEvent {
4208
4424
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4209
4425
  */
4210
4426
  OpenFilter = "openFilter",
4427
+ /**
4428
+ * Open the parameter panel for a particular parameter on a Liveboard.
4429
+ * Mirrors {@link HostEvent.OpenFilter} for parameters.
4430
+ * @param - Includes the following keys:
4431
+ * - `parameter`: An object identifying the parameter to open, for
4432
+ * example, `{ parameterId: '<parameter-GUID>' }`.
4433
+ * - `applicability`: Optional. Scopes the parameter to a specific target,
4434
+ * for example, a single Liveboard tab, so the panel for the correct
4435
+ * scoped parameter is opened. Includes the following attributes:
4436
+ *
4437
+ * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
4438
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
4439
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
4440
+ * `level` is `LIVEBOARD`, since the parameter applies to the whole
4441
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
4442
+ * @example
4443
+ * ```js
4444
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
4445
+ * parameter: { parameterId: '<parameter-GUID>' }
4446
+ * });
4447
+ * ```
4448
+ * @example
4449
+ * ```js
4450
+ * // Open a parameter scoped to a specific group
4451
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
4452
+ * parameter: { parameterId: '<parameter-GUID>' },
4453
+ * applicability: { level: 'GROUP', targetId: '<group-GUID>' }
4454
+ * });
4455
+ * ```
4456
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
4457
+ */
4458
+ OpenParameter = "openParameter",
4211
4459
  /**
4212
4460
  * Add columns to the current search query.
4213
4461
  * @param - { columnIds: string[] }
@@ -5271,13 +5519,13 @@ export declare enum HostEvent {
5271
5519
  /**
5272
5520
  * Get details of filters applied on the Liveboard.
5273
5521
  * Returns arrays containing Liveboard filter and runtime filter elements.
5274
- * Each Liveboard filter may include an `applicability` attribute
5522
+ * Each Liveboard filter includes an optional `applicability` attribute
5275
5523
  * indicating the scope of the filter. It contains a `level`
5276
5524
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
5277
5525
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
5278
5526
  * level there is no `targetId`, since the filter applies to the
5279
5527
  * whole Liveboard.
5280
- * The `applicability` attribute is available from SDK: 1.51.0 |
5528
+ * The `applicability` attribute is available from SDK: 1.53.0 |
5281
5529
  * ThoughtSpot: 26.10.0.cl.
5282
5530
  * @example
5283
5531
  * ```js
@@ -5320,7 +5568,7 @@ export declare enum HostEvent {
5320
5568
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
5321
5569
  *
5322
5570
  * `applicability` - Optional. Scopes the filter to a specific target,
5323
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
5571
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
5324
5572
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
5325
5573
  *
5326
5574
  * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -5443,6 +5691,28 @@ export declare enum HostEvent {
5443
5691
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5444
5692
  */
5445
5693
  GetTabs = "getTabs",
5694
+ /**
5695
+ * Get group details for the current Liveboard.
5696
+ * Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
5697
+ * @example
5698
+ * ```js
5699
+ * liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
5700
+ * console.log(
5701
+ * groupDetails // GroupDetails of current Liveboard
5702
+ * );
5703
+ * })
5704
+ * ```
5705
+ * @example
5706
+ * ```js
5707
+ * // Get groups from liveboard context
5708
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5709
+ * liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
5710
+ * console.log('groups', groupDetails);
5711
+ * });
5712
+ * ```
5713
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
5714
+ */
5715
+ GetGroups = "getGroups",
5446
5716
  /**
5447
5717
  * Set the visible tabs on a Liveboard.
5448
5718
  * @param - an array of ids of tabs to show, the IDs not passed
@@ -5571,7 +5841,7 @@ export declare enum HostEvent {
5571
5841
  * - `value`: The value to set for the parameter.
5572
5842
  * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
5573
5843
  * - `applicability`: Optional. Scopes the parameter to a specific target,
5574
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
5844
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
5575
5845
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
5576
5846
  *
5577
5847
  * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -5615,13 +5885,13 @@ export declare enum HostEvent {
5615
5885
  UpdateParameters = "UpdateParameters",
5616
5886
  /**
5617
5887
  * Triggers GetParameters to fetch the runtime Parameters.
5618
- * Each parameter may include an `applicability` attribute
5888
+ * Each parameter includes an optional `applicability` attribute
5619
5889
  * indicating the scope of the parameter. It contains a `level`
5620
5890
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
5621
5891
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
5622
5892
  * level there is no `targetId`, since the parameter applies to the
5623
5893
  * whole Liveboard.
5624
- * The `applicability` attribute is available from SDK: 1.51.0 |
5894
+ * The `applicability` attribute is available from SDK: 1.53.0 |
5625
5895
  * ThoughtSpot: 26.10.0.cl.
5626
5896
  * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5627
5897
  * ```js
@@ -5889,6 +6159,36 @@ export declare enum HostEvent {
5889
6159
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5890
6160
  */
5891
6161
  ResetSpotterConversation = "ResetSpotterConversation",
6162
+ /**
6163
+ * Opens the Spotter share-conversation modal for the given conversation.
6164
+ * `conversationId` is **mandatory** — you must pass the id of the
6165
+ * conversation to share. Also no-op when sharing is disabled
6166
+ * (enableShareConversation off) or when already in the read-only shared view.
6167
+ * @example
6168
+ * ```js
6169
+ * spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
6170
+ * ```
6171
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6172
+ */
6173
+ ShareSpotterConversation = "ShareSpotterConversation",
6174
+ /**
6175
+ * Closes the Spotter share-conversation modal. No-op if none is open.
6176
+ * @example
6177
+ * ```js
6178
+ * spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
6179
+ * ```
6180
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6181
+ */
6182
+ CloseSpotterShareConversation = "CloseSpotterShareConversation",
6183
+ /**
6184
+ * Exits the read-only shared-conversation view.
6185
+ * @example
6186
+ * ```js
6187
+ * spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
6188
+ * ```
6189
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6190
+ */
6191
+ ExitSpotterSharedConversation = "ExitSpotterSharedConversation",
5892
6192
  /**
5893
6193
  * Deletes the last prompt in spotter embed.
5894
6194
  * @example
@@ -5984,6 +6284,41 @@ export declare enum HostEvent {
5984
6284
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5985
6285
  */
5986
6286
  StartNewSpotterConversation = "StartNewSpotterConversation",
6287
+ /**
6288
+ * Pins a saved Spotter conversation so it floats to the top of the past
6289
+ * conversations sidebar. The `conversationId` of the conversation to pin is
6290
+ * required.
6291
+ *
6292
+ * This feature is available only when chat history is enabled on your ThoughtSpot
6293
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
6294
+ * instance.
6295
+ *
6296
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6297
+ * @example
6298
+ * ```js
6299
+ * spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
6300
+ * conversationId: '<conversation-id>',
6301
+ * });
6302
+ * ```
6303
+ */
6304
+ PinSpotterConversation = "PinSpotterConversation",
6305
+ /**
6306
+ * Unpins a previously pinned Spotter conversation. The `conversationId` of the
6307
+ * conversation to unpin is required.
6308
+ *
6309
+ * This feature is available only when chat history is enabled on your ThoughtSpot
6310
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
6311
+ * instance.
6312
+ *
6313
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6314
+ * @example
6315
+ * ```js
6316
+ * spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
6317
+ * conversationId: '<conversation-id>',
6318
+ * });
6319
+ * ```
6320
+ */
6321
+ UnpinSpotterConversation = "UnpinSpotterConversation",
5987
6322
  /**
5988
6323
  * @hidden
5989
6324
  * Get the current context of the embedded page.
@@ -6215,9 +6550,11 @@ export declare enum Param {
6215
6550
  isGranularXLSXCSVSchedulesEnabled = "isGranularXLSXCSVSchedulesEnabled",
6216
6551
  isSendNowLiveboardSchedulingEnabled = "isSendNowLiveboardSchedulingEnabled",
6217
6552
  isCentralizedLiveboardFilterUXEnabled = "isCentralizedLiveboardFilterUXEnabled",
6553
+ isScopedLiveboardFilteringEnabled = "isScopedLiveboardFilteringEnabled",
6218
6554
  isLinkParametersEnabled = "isLinkParametersEnabled",
6219
6555
  EnablePastConversationsSidebar = "enablePastConversationsSidebar",
6220
6556
  UpdatedSpotterChatPrompt = "updatedSpotterChatPrompt",
6557
+ ShowSpotterRadiance = "showSpotterRadiance",
6221
6558
  DefaultQueryMode = "defaultQueryMode",
6222
6559
  EnableStopAnswerGenerationEmbed = "enableStopAnswerGenerationEmbed",
6223
6560
  SpotterSidebarTitle = "spotterSidebarTitle",
@@ -6237,7 +6574,9 @@ export declare enum Param {
6237
6574
  EnableLiveboardDataCache = "enableLiveboardDataCache",
6238
6575
  SpotterFileUploadEnabled = "spotterFileUploadEnabled",
6239
6576
  SpotterFileUploadFileTypes = "spotterFileUploadFileTypes",
6240
- IsStarterPromptsEnabled = "enableStarterPrompts"
6577
+ IsStarterPromptsEnabled = "enableStarterPrompts",
6578
+ UpdatedSpotterExperience = "updatedSpotterExperience",
6579
+ SpotterDataSources = "spotterDataSources"
6241
6580
  }
6242
6581
  /**
6243
6582
  * Configuration for allowed file types in Spotter file upload.
@@ -7506,6 +7845,19 @@ export declare enum Action {
7506
7845
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
7507
7846
  */
7508
7847
  ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
7848
+ /**
7849
+ * Action ID to show, hide, or disable all filter surfaces on a Liveboard,
7850
+ * including filter, parameter, and cross-filter chips at the liveboard,
7851
+ * tab, and group levels. Parameter and cross-filter chips are hide-only.
7852
+ *
7853
+ * @example
7854
+ * ```js
7855
+ * hiddenActions: [Action.AllLiveboardFilters]
7856
+ * disabledActions: [Action.AllLiveboardFilters]
7857
+ * ```
7858
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
7859
+ */
7860
+ AllLiveboardFilters = "allLiveboardFilters",
7509
7861
  /**
7510
7862
  * The **Data model instructions** button on the Spotter interface.
7511
7863
  * Allows opening the data model instructions modal.
@@ -7841,6 +8193,89 @@ export declare enum Action {
7841
8193
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7842
8194
  */
7843
8195
  SpotterChatRename = "spotterChatRename",
8196
+ /**
8197
+ * Controls visibility and disable state of the Spotter conversation Share
8198
+ * button in the chat header. Only takes effect once sharing is enabled
8199
+ * (enableShareConversation on).
8200
+ * @example
8201
+ * ```js
8202
+ * disabledActions: [Action.SpotterShareConversationButtonHeader]
8203
+ * ```
8204
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8205
+ */
8206
+ SpotterShareConversationButtonHeader = "spotterShareConversationButtonHeader",
8207
+ /**
8208
+ * Controls visibility and disable state of the Share item in the Spotter
8209
+ * conversation history (sidebar) edit menu. Independent of the header button
8210
+ * above, so a host can show Share in one entry point and hide it in the other.
8211
+ * @example
8212
+ * ```js
8213
+ * disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
8214
+ * ```
8215
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8216
+ */
8217
+ SpotterShareConversationMenuItemSidebar = "spotterShareConversationMenuItemSidebar",
8218
+ /**
8219
+ * Controls visibility of the entire read-only shared-conversation data-access
8220
+ * banner shown when a recipient opens a shared view. Hide-only.
8221
+ * @example
8222
+ * ```js
8223
+ * hiddenActions: [Action.SpotterSharedConversationBanner]
8224
+ * ```
8225
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8226
+ */
8227
+ SpotterSharedConversationBanner = "spotterSharedConversationBanner",
8228
+ /**
8229
+ * Controls visibility and disable state of the cross/close button on the
8230
+ * read-only shared-conversation data-access banner (keeps the banner itself).
8231
+ * @example
8232
+ * ```js
8233
+ * hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
8234
+ * ```
8235
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8236
+ */
8237
+ SpotterSharedConversationBannerDismissButton = "spotterSharedConversationBannerDismissButton",
8238
+ /**
8239
+ * Controls visibility and disable state of the Exit button in the read-only
8240
+ * shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
8241
+ * host event.
8242
+ * @example
8243
+ * ```js
8244
+ * hiddenActions: [Action.SpotterSharedConversationExitButton]
8245
+ * ```
8246
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8247
+ */
8248
+ SpotterSharedConversationExitButton = "spotterSharedConversationExitButton",
8249
+ /**
8250
+ * Controls visibility of the share-modal footer note ("Chat will be shared up
8251
+ * to the current moment…"). Hide-only.
8252
+ * @example
8253
+ * ```js
8254
+ * hiddenActions: [Action.SpotterShareUpToCurrentInfo]
8255
+ * ```
8256
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8257
+ */
8258
+ SpotterShareUpToCurrentInfo = "spotterShareUpToCurrentInfo",
8259
+ /**
8260
+ * Controls visibility and disable state of the share-modal "include new
8261
+ * messages since last shared version" checkbox.
8262
+ * @example
8263
+ * ```js
8264
+ * disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
8265
+ * ```
8266
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8267
+ */
8268
+ SpotterShareIncludeNewMessagesCheckbox = "spotterShareIncludeNewMessagesCheckbox",
8269
+ /**
8270
+ * Controls visibility and disable state of the cross on the share-modal
8271
+ * stale-snapshot info banner.
8272
+ * @example
8273
+ * ```js
8274
+ * hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
8275
+ * ```
8276
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
8277
+ */
8278
+ SpotterShareStaleInfoBannerDismissButton = "spotterShareStaleInfoBannerDismissButton",
7844
8279
  /**
7845
8280
  * Controls visibility and disable state of the delete action
7846
8281
  * in the Spotter conversation edit menu.
@@ -7851,6 +8286,16 @@ export declare enum Action {
7851
8286
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7852
8287
  */
7853
8288
  SpotterChatDelete = "spotterChatDelete",
8289
+ /**
8290
+ * Controls visibility and disable state of the pin/unpin action
8291
+ * in the Spotter conversation edit menu.
8292
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
8293
+ * @example
8294
+ * ```js
8295
+ * disabledActions: [Action.SpotterChatPin]
8296
+ * ```
8297
+ */
8298
+ SpotterChatPin = "spotterChatPin",
7854
8299
  /**
7855
8300
  * Controls visibility and disable state of the documentation/best practices
7856
8301
  * link in the Spotter sidebar footer.