@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
@@ -41,6 +41,42 @@ export interface CustomCssVariables {
41
41
  * Font color of the top navigation panel.
42
42
  */
43
43
  "--ts-var-nav-color"?: string;
44
+ /**
45
+ * Background color of the left navigation panel.
46
+ */
47
+ "--ts-var-left-nav-background"?: string;
48
+ /**
49
+ * Background color of the active tab in the left navigation panel.
50
+ */
51
+ "--ts-var-left-nav-active-tab-background"?: string;
52
+ /**
53
+ * Border color of the active tab in the left navigation panel.
54
+ */
55
+ "--ts-var-left-nav-active-tab-border-color"?: string;
56
+ /**
57
+ * Font color of the section title in the left navigation panel.
58
+ */
59
+ "--ts-var-left-nav-section-title-color"?: string;
60
+ /**
61
+ * Font color of the items in the left navigation panel.
62
+ */
63
+ "--ts-var-left-nav-item-color"?: string;
64
+ /**
65
+ * Font color of the selected item in the left navigation panel.
66
+ */
67
+ "--ts-var-left-nav-item-selection-color"?: string;
68
+ /**
69
+ * Background color of the selected item in the left navigation panel.
70
+ */
71
+ "--ts-var-left-nav-item-selection-background"?: string;
72
+ /**
73
+ * Color of the active tab icon in the left navigation panel.
74
+ */
75
+ "--ts-var-left-nav-tab-icon-active-color"?: string;
76
+ /**
77
+ * Color of the inactive tab icon in the left navigation panel.
78
+ */
79
+ "--ts-var-left-nav-tab-icon-inactive-color"?: string;
44
80
  /**
45
81
  * Background color of the *Search data* button.
46
82
  */
@@ -2727,7 +2763,9 @@ export interface HomePageConfig {
2727
2763
  * To specify the modules, import the `HomepageModule` enum.
2728
2764
  * For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
2729
2765
  *
2730
- * **Note**: This attribute is not supported in the classic (v1) experience.
2766
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
2767
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
2768
+ * and V4 (Focused) home page experiences.
2731
2769
  *
2732
2770
  * Supported embed types: `AppEmbed`
2733
2771
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -2736,7 +2774,7 @@ export interface HomePageConfig {
2736
2774
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
2737
2775
  *
2738
2776
  * const embed = new AppEmbed('#tsEmbed', {
2739
- * ... // V2/V3 navigation and home page experience attributes
2777
+ * ... // V3 navigation and home page experience attributes
2740
2778
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
2741
2779
  * //...other embed view configuration attributes
2742
2780
  * })
@@ -2747,8 +2785,11 @@ export interface HomePageConfig {
2747
2785
  * Reorder home page modules.
2748
2786
  * To specify the modules, import the `HomepageModule` enum.
2749
2787
  * For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
2750
- * HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
2751
- * classic (v1) homepage.
2788
+ * HomepageModule.Watchlist]`
2789
+ *
2790
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
2791
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
2792
+ * and V4 (Focused) home page experiences.
2752
2793
  *
2753
2794
  * Supported embed types: `AppEmbed`
2754
2795
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -2757,7 +2798,7 @@ export interface HomePageConfig {
2757
2798
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
2758
2799
  *
2759
2800
  * const embed = new AppEmbed('#tsEmbed', {
2760
- * ...//V2/V3 navigation and home page experience attributes
2801
+ * ...//V3 navigation and home page experience attributes
2761
2802
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
2762
2803
  * //... other embed view configuration attributes
2763
2804
  * })
@@ -2769,7 +2810,9 @@ export interface HomePageConfig {
2769
2810
  * on the home page left navigation panel.
2770
2811
  * To specify the menu items, import the `HomeLeftNavItem` enum.
2771
2812
  *
2772
- * **Note**: This attribute is not supported in the classic (v1) homepage.
2813
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
2814
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges)
2815
+ * and V4 (Focused) home page experiences.
2773
2816
  *
2774
2817
  * Supported embed types: `AppEmbed`
2775
2818
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -3145,6 +3188,24 @@ export interface LiveboardAppEmbedViewConfig {
3145
3188
  * ```
3146
3189
  */
3147
3190
  isCentralizedLiveboardFilterUXEnabled?: boolean;
3191
+ /**
3192
+ * This flag is used to enable or disable scoped Liveboard filtering.
3193
+ * When enabled, filters and parameters can be scoped to a group of
3194
+ * visualizations on a Liveboard, in addition to the Liveboard and
3195
+ * tab levels.
3196
+ *
3197
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3198
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
3199
+ * @example
3200
+ * ```js
3201
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3202
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3203
+ * ... // other embed view config
3204
+ * isScopedLiveboardFilteringEnabled: true,
3205
+ * })
3206
+ * ```
3207
+ */
3208
+ isScopedLiveboardFilteringEnabled?: boolean;
3148
3209
  /**
3149
3210
  * This flag is used to enable or disable the link parameters in liveboard.
3150
3211
  *
@@ -4304,11 +4365,19 @@ export declare enum EmbedEvent {
4304
4365
  * Emitted when a user changes any filter on a Liveboard.
4305
4366
  * Returns filter type and name, column name and ID, and runtime
4306
4367
  * filter details.
4368
+ * The payload includes an optional `applicability` attribute indicating the
4369
+ * scope of the changed filter. It contains a `level` (`LIVEBOARD`,
4370
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
4371
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
4372
+ * is no `targetId`, since the filter applies to the whole Liveboard.
4373
+ * The `applicability` attribute is available from SDK: 1.53.0 |
4374
+ * ThoughtSpot: 26.10.0.cl.
4307
4375
  * @example
4308
4376
  *
4309
4377
  * ```js
4310
4378
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
4311
4379
  * console.log('payload', payload);
4380
+ * // payload.data optionally includes applicability: { level, targetId }
4312
4381
  * })
4313
4382
  * ```
4314
4383
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
@@ -4500,9 +4569,17 @@ export declare enum EmbedEvent {
4500
4569
  /**
4501
4570
  * Emitted when parameter changes in an Answer
4502
4571
  * or Liveboard.
4572
+ * The payload includes an optional `applicability` attribute indicating the
4573
+ * scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
4574
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
4575
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
4576
+ * is no `targetId`, since the parameter applies to the whole Liveboard.
4577
+ * The `applicability` attribute is available from SDK: 1.53.0 |
4578
+ * ThoughtSpot: 26.10.0.cl.
4503
4579
  * ```js
4504
4580
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
4505
4581
  * console.log('payload', payload);
4582
+ * // payload.data optionally includes applicability: { level, targetId }
4506
4583
  * })
4507
4584
  * ```
4508
4585
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
@@ -4804,6 +4881,158 @@ export declare enum EmbedEvent {
4804
4881
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
4805
4882
  */
4806
4883
  SpotterConversationDeleted = "spotterConversationDeleted",
4884
+ /**
4885
+ * Emitted when the header Share button is clicked. Fires `Start` then `End`
4886
+ * to bracket the interaction. App→host counterpart of the
4887
+ * `ShareSpotterConversation` host event (user-driven vs programmatic open).
4888
+ * @example
4889
+ * ```js
4890
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
4891
+ * // payload: { convId: string }
4892
+ * })
4893
+ * ```
4894
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4895
+ */
4896
+ SpotterShareConversationButtonHeaderClicked = "spotterShareConversationButtonHeaderClicked",
4897
+ /**
4898
+ * Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
4899
+ * to bracket the interaction.
4900
+ * @example
4901
+ * ```js
4902
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
4903
+ * // payload: { convId: string }
4904
+ * })
4905
+ * ```
4906
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4907
+ */
4908
+ SpotterShareConversationMenuItemSidebarClicked = "spotterShareConversationMenuItemSidebarClicked",
4909
+ /**
4910
+ * Emitted when a Spotter conversation is shared (recipients added, or a new
4911
+ * share created). The host builds its own link from shareId/convId + its
4912
+ * configured CONVERSATION_URL — no link string is sent. Distinct from
4913
+ * `SpotterShareModalConfirmButtonClicked`, which fires at click time before
4914
+ * the save resolves.
4915
+ * @example
4916
+ * ```js
4917
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
4918
+ * // payload: { convId: string, shareId: string,
4919
+ * // recipientsAdded: string[], recipientsRemoved: string[] }
4920
+ * })
4921
+ * ```
4922
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4923
+ */
4924
+ SpotterConversationShared = "spotterConversationShared",
4925
+ /**
4926
+ * Emitted when access to a shared Spotter conversation is revoked
4927
+ * (recipients removed). `fullyRevoked` is true when the last sharee is removed
4928
+ * and the share is deleted entirely.
4929
+ * @example
4930
+ * ```js
4931
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
4932
+ * // payload: { convId: string, shareId: string,
4933
+ * // recipientsRemoved: string[], fullyRevoked: boolean }
4934
+ * })
4935
+ * ```
4936
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4937
+ */
4938
+ SpotterConversationShareRevoked = "spotterConversationShareRevoked",
4939
+ /**
4940
+ * Emitted when a recipient opens a shared Spotter conversation (read-only
4941
+ * view). No shareId available viewer-side.
4942
+ * @example
4943
+ * ```js
4944
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
4945
+ * // payload: { convId: string, sourceConvId: string }
4946
+ * // convId = resolved snapshot conv id; sourceConvId = the shared URL id
4947
+ * })
4948
+ * ```
4949
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4950
+ */
4951
+ SpotterSharedConversationViewed = "spotterSharedConversationViewed",
4952
+ /**
4953
+ * Emitted when the user toggles the share-modal "include new messages since
4954
+ * last shared version" checkbox.
4955
+ * @example
4956
+ * ```js
4957
+ * spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
4958
+ * // payload: { convId: string, includeNewMessages: boolean }
4959
+ * })
4960
+ * ```
4961
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4962
+ */
4963
+ SpotterShareIncludeNewMessagesCheckboxToggled = "spotterShareIncludeNewMessagesCheckboxToggled",
4964
+ /**
4965
+ * Emitted when the user dismisses the stale-snapshot info banner via its
4966
+ * cross (distinct from the include-new-messages checkbox toggle).
4967
+ * @example
4968
+ * ```js
4969
+ * spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
4970
+ * // payload: { convId: string }
4971
+ * })
4972
+ * ```
4973
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4974
+ */
4975
+ SpotterShareStaleInfoBannerDismissed = "spotterShareStaleInfoBannerDismissed",
4976
+ /**
4977
+ * Emitted when the modal Share (confirm) button is clicked — fires at click
4978
+ * time, before the save resolves. Distinct from the `SpotterConversationShared`
4979
+ * / `SpotterConversationShareRevoked` result events.
4980
+ * @example
4981
+ * ```js
4982
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
4983
+ * // payload: { convId: string }
4984
+ * })
4985
+ * ```
4986
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4987
+ */
4988
+ SpotterShareModalConfirmButtonClicked = "spotterShareModalConfirmButtonClicked",
4989
+ /**
4990
+ * Emitted when the share modal is dismissed via the Cancel button.
4991
+ * @example
4992
+ * ```js
4993
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
4994
+ * // payload: { convId: string }
4995
+ * })
4996
+ * ```
4997
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4998
+ */
4999
+ SpotterShareModalCancelButtonClicked = "spotterShareModalCancelButtonClicked",
5000
+ /**
5001
+ * Emitted when a recipient leaves the read-only shared view via the Exit
5002
+ * button.
5003
+ * @example
5004
+ * ```js
5005
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
5006
+ * // payload: { convId: string }
5007
+ * })
5008
+ * ```
5009
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
5010
+ */
5011
+ SpotterSharedConversationExitButtonClicked = "spotterSharedConversationExitButtonClicked",
5012
+ /**
5013
+ * Emitted when a Spotter conversation is pinned.
5014
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
5015
+ * @example
5016
+ * ```js
5017
+ * spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
5018
+ * console.log('Conversation pinned', payload);
5019
+ * // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
5020
+ * })
5021
+ * ```
5022
+ */
5023
+ SpotterConversationPinned = "spotterConversationPinned",
5024
+ /**
5025
+ * Emitted when a Spotter conversation is unpinned.
5026
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
5027
+ * @example
5028
+ * ```js
5029
+ * spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
5030
+ * console.log('Conversation unpinned', payload);
5031
+ * // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
5032
+ * })
5033
+ * ```
5034
+ */
5035
+ SpotterConversationUnpinned = "spotterConversationUnpinned",
4807
5036
  /**
4808
5037
  * Emitted when a Spotter conversation is selected/clicked.
4809
5038
  * @example
@@ -5319,6 +5548,17 @@ export declare enum HostEvent {
5319
5548
  * name: string,
5320
5549
  * type: ATTRIBUTE/MEASURE,
5321
5550
  * dataType: INT64/CHAR/DATE }
5551
+ *
5552
+ * `applicability` - Optional. Scopes the filter to a specific target,
5553
+ * for example, a single Liveboard tab, so the panel for the correct
5554
+ * scoped filter is opened. Available from SDK: 1.53.0 |
5555
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
5556
+ *
5557
+ * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
5558
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
5559
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
5560
+ * `level` is `LIVEBOARD`, since the filter applies to the whole
5561
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
5322
5562
  * @example
5323
5563
  * ```js
5324
5564
  * searchEmbed.trigger(HostEvent.OpenFilter,
@@ -5331,6 +5571,14 @@ export declare enum HostEvent {
5331
5571
  * ```
5332
5572
  * @example
5333
5573
  * ```js
5574
+ * // Open a filter scoped to a specific Liveboard tab
5575
+ * liveboardEmbed.trigger(HostEvent.OpenFilter, {
5576
+ * column: { columnId: '<column-GUID>' },
5577
+ * applicability: { level: 'TAB', targetId: '<tab-GUID>' }
5578
+ * });
5579
+ * ```
5580
+ * @example
5581
+ * ```js
5334
5582
  * // Open filter from search context
5335
5583
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5336
5584
  * searchEmbed.trigger(HostEvent.OpenFilter, {
@@ -5340,6 +5588,38 @@ export declare enum HostEvent {
5340
5588
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5341
5589
  */
5342
5590
  OpenFilter = "openFilter",
5591
+ /**
5592
+ * Open the parameter panel for a particular parameter on a Liveboard.
5593
+ * Mirrors {@link HostEvent.OpenFilter} for parameters.
5594
+ * @param - Includes the following keys:
5595
+ * - `parameter`: An object identifying the parameter to open, for
5596
+ * example, `{ parameterId: '<parameter-GUID>' }`.
5597
+ * - `applicability`: Optional. Scopes the parameter to a specific target,
5598
+ * for example, a single Liveboard tab, so the panel for the correct
5599
+ * scoped parameter is opened. Includes the following attributes:
5600
+ *
5601
+ * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
5602
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
5603
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
5604
+ * `level` is `LIVEBOARD`, since the parameter applies to the whole
5605
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
5606
+ * @example
5607
+ * ```js
5608
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
5609
+ * parameter: { parameterId: '<parameter-GUID>' }
5610
+ * });
5611
+ * ```
5612
+ * @example
5613
+ * ```js
5614
+ * // Open a parameter scoped to a specific group
5615
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
5616
+ * parameter: { parameterId: '<parameter-GUID>' },
5617
+ * applicability: { level: 'GROUP', targetId: '<group-GUID>' }
5618
+ * });
5619
+ * ```
5620
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
5621
+ */
5622
+ OpenParameter = "openParameter",
5343
5623
  /**
5344
5624
  * Add columns to the current search query.
5345
5625
  * @param - { columnIds: string[] }
@@ -6403,13 +6683,13 @@ export declare enum HostEvent {
6403
6683
  /**
6404
6684
  * Get details of filters applied on the Liveboard.
6405
6685
  * Returns arrays containing Liveboard filter and runtime filter elements.
6406
- * Each Liveboard filter may include an `applicability` attribute
6686
+ * Each Liveboard filter includes an optional `applicability` attribute
6407
6687
  * indicating the scope of the filter. It contains a `level`
6408
6688
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
6409
6689
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
6410
6690
  * level there is no `targetId`, since the filter applies to the
6411
6691
  * whole Liveboard.
6412
- * The `applicability` attribute is available from SDK: 1.51.0 |
6692
+ * The `applicability` attribute is available from SDK: 1.53.0 |
6413
6693
  * ThoughtSpot: 26.10.0.cl.
6414
6694
  * @example
6415
6695
  * ```js
@@ -6452,7 +6732,7 @@ export declare enum HostEvent {
6452
6732
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
6453
6733
  *
6454
6734
  * `applicability` - Optional. Scopes the filter to a specific target,
6455
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
6735
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
6456
6736
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
6457
6737
  *
6458
6738
  * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -6575,6 +6855,28 @@ export declare enum HostEvent {
6575
6855
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
6576
6856
  */
6577
6857
  GetTabs = "getTabs",
6858
+ /**
6859
+ * Get group details for the current Liveboard.
6860
+ * Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
6861
+ * @example
6862
+ * ```js
6863
+ * liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
6864
+ * console.log(
6865
+ * groupDetails // GroupDetails of current Liveboard
6866
+ * );
6867
+ * })
6868
+ * ```
6869
+ * @example
6870
+ * ```js
6871
+ * // Get groups from liveboard context
6872
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6873
+ * liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
6874
+ * console.log('groups', groupDetails);
6875
+ * });
6876
+ * ```
6877
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
6878
+ */
6879
+ GetGroups = "getGroups",
6578
6880
  /**
6579
6881
  * Set the visible tabs on a Liveboard.
6580
6882
  * @param - an array of ids of tabs to show, the IDs not passed
@@ -6703,7 +7005,7 @@ export declare enum HostEvent {
6703
7005
  * - `value`: The value to set for the parameter.
6704
7006
  * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
6705
7007
  * - `applicability`: Optional. Scopes the parameter to a specific target,
6706
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
7008
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
6707
7009
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
6708
7010
  *
6709
7011
  * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -6747,13 +7049,13 @@ export declare enum HostEvent {
6747
7049
  UpdateParameters = "UpdateParameters",
6748
7050
  /**
6749
7051
  * Triggers GetParameters to fetch the runtime Parameters.
6750
- * Each parameter may include an `applicability` attribute
7052
+ * Each parameter includes an optional `applicability` attribute
6751
7053
  * indicating the scope of the parameter. It contains a `level`
6752
7054
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
6753
7055
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
6754
7056
  * level there is no `targetId`, since the parameter applies to the
6755
7057
  * whole Liveboard.
6756
- * The `applicability` attribute is available from SDK: 1.51.0 |
7058
+ * The `applicability` attribute is available from SDK: 1.53.0 |
6757
7059
  * ThoughtSpot: 26.10.0.cl.
6758
7060
  * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6759
7061
  * ```js
@@ -7021,6 +7323,36 @@ export declare enum HostEvent {
7021
7323
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
7022
7324
  */
7023
7325
  ResetSpotterConversation = "ResetSpotterConversation",
7326
+ /**
7327
+ * Opens the Spotter share-conversation modal for the given conversation.
7328
+ * `conversationId` is **mandatory** — you must pass the id of the
7329
+ * conversation to share. Also no-op when sharing is disabled
7330
+ * (enableShareConversation off) or when already in the read-only shared view.
7331
+ * @example
7332
+ * ```js
7333
+ * spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
7334
+ * ```
7335
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
7336
+ */
7337
+ ShareSpotterConversation = "ShareSpotterConversation",
7338
+ /**
7339
+ * Closes the Spotter share-conversation modal. No-op if none is open.
7340
+ * @example
7341
+ * ```js
7342
+ * spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
7343
+ * ```
7344
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
7345
+ */
7346
+ CloseSpotterShareConversation = "CloseSpotterShareConversation",
7347
+ /**
7348
+ * Exits the read-only shared-conversation view.
7349
+ * @example
7350
+ * ```js
7351
+ * spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
7352
+ * ```
7353
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
7354
+ */
7355
+ ExitSpotterSharedConversation = "ExitSpotterSharedConversation",
7024
7356
  /**
7025
7357
  * Deletes the last prompt in spotter embed.
7026
7358
  * @example
@@ -7116,6 +7448,41 @@ export declare enum HostEvent {
7116
7448
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
7117
7449
  */
7118
7450
  StartNewSpotterConversation = "StartNewSpotterConversation",
7451
+ /**
7452
+ * Pins a saved Spotter conversation so it floats to the top of the past
7453
+ * conversations sidebar. The `conversationId` of the conversation to pin is
7454
+ * required.
7455
+ *
7456
+ * This feature is available only when chat history is enabled on your ThoughtSpot
7457
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
7458
+ * instance.
7459
+ *
7460
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
7461
+ * @example
7462
+ * ```js
7463
+ * spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
7464
+ * conversationId: '<conversation-id>',
7465
+ * });
7466
+ * ```
7467
+ */
7468
+ PinSpotterConversation = "PinSpotterConversation",
7469
+ /**
7470
+ * Unpins a previously pinned Spotter conversation. The `conversationId` of the
7471
+ * conversation to unpin is required.
7472
+ *
7473
+ * This feature is available only when chat history is enabled on your ThoughtSpot
7474
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
7475
+ * instance.
7476
+ *
7477
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
7478
+ * @example
7479
+ * ```js
7480
+ * spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
7481
+ * conversationId: '<conversation-id>',
7482
+ * });
7483
+ * ```
7484
+ */
7485
+ UnpinSpotterConversation = "UnpinSpotterConversation",
7119
7486
  /**
7120
7487
  * @hidden
7121
7488
  * Get the current context of the embedded page.
@@ -8482,6 +8849,19 @@ export declare enum Action {
8482
8849
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
8483
8850
  */
8484
8851
  ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
8852
+ /**
8853
+ * Action ID to show, hide, or disable all filter surfaces on a Liveboard,
8854
+ * including filter, parameter, and cross-filter chips at the liveboard,
8855
+ * tab, and group levels. Parameter and cross-filter chips are hide-only.
8856
+ *
8857
+ * @example
8858
+ * ```js
8859
+ * hiddenActions: [Action.AllLiveboardFilters]
8860
+ * disabledActions: [Action.AllLiveboardFilters]
8861
+ * ```
8862
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
8863
+ */
8864
+ AllLiveboardFilters = "allLiveboardFilters",
8485
8865
  /**
8486
8866
  * The **Data model instructions** button on the Spotter interface.
8487
8867
  * Allows opening the data model instructions modal.
@@ -8817,6 +9197,89 @@ export declare enum Action {
8817
9197
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
8818
9198
  */
8819
9199
  SpotterChatRename = "spotterChatRename",
9200
+ /**
9201
+ * Controls visibility and disable state of the Spotter conversation Share
9202
+ * button in the chat header. Only takes effect once sharing is enabled
9203
+ * (enableShareConversation on).
9204
+ * @example
9205
+ * ```js
9206
+ * disabledActions: [Action.SpotterShareConversationButtonHeader]
9207
+ * ```
9208
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
9209
+ */
9210
+ SpotterShareConversationButtonHeader = "spotterShareConversationButtonHeader",
9211
+ /**
9212
+ * Controls visibility and disable state of the Share item in the Spotter
9213
+ * conversation history (sidebar) edit menu. Independent of the header button
9214
+ * above, so a host can show Share in one entry point and hide it in the other.
9215
+ * @example
9216
+ * ```js
9217
+ * disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
9218
+ * ```
9219
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
9220
+ */
9221
+ SpotterShareConversationMenuItemSidebar = "spotterShareConversationMenuItemSidebar",
9222
+ /**
9223
+ * Controls visibility of the entire read-only shared-conversation data-access
9224
+ * banner shown when a recipient opens a shared view. Hide-only.
9225
+ * @example
9226
+ * ```js
9227
+ * hiddenActions: [Action.SpotterSharedConversationBanner]
9228
+ * ```
9229
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
9230
+ */
9231
+ SpotterSharedConversationBanner = "spotterSharedConversationBanner",
9232
+ /**
9233
+ * Controls visibility and disable state of the cross/close button on the
9234
+ * read-only shared-conversation data-access banner (keeps the banner itself).
9235
+ * @example
9236
+ * ```js
9237
+ * hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
9238
+ * ```
9239
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
9240
+ */
9241
+ SpotterSharedConversationBannerDismissButton = "spotterSharedConversationBannerDismissButton",
9242
+ /**
9243
+ * Controls visibility and disable state of the Exit button in the read-only
9244
+ * shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
9245
+ * host event.
9246
+ * @example
9247
+ * ```js
9248
+ * hiddenActions: [Action.SpotterSharedConversationExitButton]
9249
+ * ```
9250
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
9251
+ */
9252
+ SpotterSharedConversationExitButton = "spotterSharedConversationExitButton",
9253
+ /**
9254
+ * Controls visibility of the share-modal footer note ("Chat will be shared up
9255
+ * to the current moment…"). Hide-only.
9256
+ * @example
9257
+ * ```js
9258
+ * hiddenActions: [Action.SpotterShareUpToCurrentInfo]
9259
+ * ```
9260
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
9261
+ */
9262
+ SpotterShareUpToCurrentInfo = "spotterShareUpToCurrentInfo",
9263
+ /**
9264
+ * Controls visibility and disable state of the share-modal "include new
9265
+ * messages since last shared version" checkbox.
9266
+ * @example
9267
+ * ```js
9268
+ * disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
9269
+ * ```
9270
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
9271
+ */
9272
+ SpotterShareIncludeNewMessagesCheckbox = "spotterShareIncludeNewMessagesCheckbox",
9273
+ /**
9274
+ * Controls visibility and disable state of the cross on the share-modal
9275
+ * stale-snapshot info banner.
9276
+ * @example
9277
+ * ```js
9278
+ * hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
9279
+ * ```
9280
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
9281
+ */
9282
+ SpotterShareStaleInfoBannerDismissButton = "spotterShareStaleInfoBannerDismissButton",
8820
9283
  /**
8821
9284
  * Controls visibility and disable state of the delete action
8822
9285
  * in the Spotter conversation edit menu.
@@ -8827,6 +9290,16 @@ export declare enum Action {
8827
9290
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
8828
9291
  */
8829
9292
  SpotterChatDelete = "spotterChatDelete",
9293
+ /**
9294
+ * Controls visibility and disable state of the pin/unpin action
9295
+ * in the Spotter conversation edit menu.
9296
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
9297
+ * @example
9298
+ * ```js
9299
+ * disabledActions: [Action.SpotterChatPin]
9300
+ * ```
9301
+ */
9302
+ SpotterChatPin = "spotterChatPin",
8830
9303
  /**
8831
9304
  * Controls visibility and disable state of the documentation/best practices
8832
9305
  * link in the Spotter sidebar footer.
@@ -10027,6 +10500,11 @@ export interface LiveboardTab {
10027
10500
  name: string;
10028
10501
  [key: string]: any;
10029
10502
  }
10503
+ export interface LiveboardGroup {
10504
+ id: string;
10505
+ name: string;
10506
+ [key: string]: any;
10507
+ }
10030
10508
  declare enum ApplicabilityLevel {
10031
10509
  Liveboard = "LIVEBOARD",
10032
10510
  Tab = "TAB",
@@ -10072,6 +10550,7 @@ export declare enum UIPassthroughEvent {
10072
10550
  GetParameters = "getParameters",
10073
10551
  GetTML = "getTML",
10074
10552
  GetTabs = "getTabs",
10553
+ GetGroups = "getGroups",
10075
10554
  GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
10076
10555
  }
10077
10556
  export type UIPassthroughContractBase = {
@@ -10181,6 +10660,14 @@ export type UIPassthroughContractBase = {
10181
10660
  Tabs: LiveboardTab[];
10182
10661
  };
10183
10662
  };
10663
+ [UIPassthroughEvent.GetGroups]: {
10664
+ request: Record<string, never>;
10665
+ response: {
10666
+ orderedGroupIds: string[];
10667
+ numberOfGroups: number;
10668
+ Groups: LiveboardGroup[];
10669
+ };
10670
+ };
10184
10671
  [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
10185
10672
  request: Record<string, never>;
10186
10673
  response: {
@@ -10226,6 +10713,7 @@ export type EmbedApiHostEventMapping = {
10226
10713
  [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
10227
10714
  [HostEvent.GetTML]: UIPassthroughEvent.GetTML;
10228
10715
  [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
10716
+ [HostEvent.GetGroups]: UIPassthroughEvent.GetGroups;
10229
10717
  [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
10230
10718
  };
10231
10719
  export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
@@ -11331,6 +11819,37 @@ declare enum SpotterQueryMode {
11331
11819
  FAST_SEARCH = "fastSearch",
11332
11820
  RESEARCH = "research"
11333
11821
  }
11822
+ /**
11823
+ * Configuration for the pin/unpin conversation feature in the Spotter sidebar.
11824
+ * Grouped into one object because pin exposes several related settings
11825
+ * (enable + label overrides), unlike single-item actions like rename or
11826
+ * delete.
11827
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
11828
+ */
11829
+ export interface SpotterChatPinConfig {
11830
+ /**
11831
+ * Enables the pin/unpin conversation feature in embedded Spotter. Disabled
11832
+ * by default — hosts must opt in. When off, the Pin/Unpin menu entry and
11833
+ * the pin glyph are hidden and the PinSpotterConversation /
11834
+ * UnpinSpotterConversation host events are no-ops. Native (non-embedded)
11835
+ * Spotter is unaffected and ships pin enabled.
11836
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
11837
+ * @default false
11838
+ */
11839
+ enabled?: boolean;
11840
+ /**
11841
+ * Custom label text for the pin action in the conversation edit menu.
11842
+ * Defaults to translated "Pin" text.
11843
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
11844
+ */
11845
+ pinLabel?: string;
11846
+ /**
11847
+ * Custom label text for the unpin action in the conversation edit menu.
11848
+ * Defaults to translated "Unpin" text.
11849
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
11850
+ */
11851
+ unpinLabel?: string;
11852
+ }
11334
11853
  /**
11335
11854
  * Configuration for the Spotter sidebar.
11336
11855
  * Can be used in SpotterEmbed and AppEmbed.
@@ -11368,6 +11887,12 @@ export interface SpotterSidebarViewConfig {
11368
11887
  * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
11369
11888
  */
11370
11889
  spotterChatDeleteLabel?: string;
11890
+ /**
11891
+ * Pin/unpin conversation feature config (enable + label overrides).
11892
+ * Off by default in embed — hosts opt in via `enabled`.
11893
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
11894
+ */
11895
+ spotterChatPinConfig?: SpotterChatPinConfig;
11371
11896
  /**
11372
11897
  * Custom title text for the delete conversation confirmation modal.
11373
11898
  * Defaults to translated "Delete chat" text.
@@ -11418,6 +11943,84 @@ export interface SpotterSidebarViewConfig {
11418
11943
  */
11419
11944
  spotterAnalystsLabel?: string;
11420
11945
  }
11946
+ /**
11947
+ * Configuration for the Spotter conversation sharing feature.
11948
+ * Can be used in SpotterEmbed and AppEmbed.
11949
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11950
+ * @group Embed components
11951
+ */
11952
+ export interface SpotterShareConversationConfig {
11953
+ /**
11954
+ * Enables sharing of the conversation.
11955
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11956
+ * @default false
11957
+ */
11958
+ enableShareConversation?: boolean;
11959
+ /**
11960
+ * Header Share button + sidebar Share item label.
11961
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11962
+ * @default "Share"
11963
+ */
11964
+ spotterShareLabel?: string;
11965
+ /**
11966
+ * Share modal title.
11967
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11968
+ */
11969
+ spotterShareModalTitle?: string;
11970
+ /**
11971
+ * Modal confirm button label.
11972
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11973
+ * @default "Share"
11974
+ */
11975
+ spotterShareConfirmLabel?: string;
11976
+ /**
11977
+ * Modal cancel button label.
11978
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11979
+ * @default "Cancel"
11980
+ */
11981
+ spotterShareCancelLabel?: string;
11982
+ /**
11983
+ * "Add users or groups" label.
11984
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11985
+ */
11986
+ spotterShareAddUsersLabel?: string;
11987
+ /**
11988
+ * Empty-state title ("No users added yet").
11989
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11990
+ */
11991
+ spotterShareEmptyTitle?: string;
11992
+ /**
11993
+ * Empty-state subtitle ("Not shared with any user").
11994
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
11995
+ */
11996
+ spotterShareEmptySubtitle?: string;
11997
+ /**
11998
+ * "Include new messages since last shared version" checkbox label.
11999
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12000
+ */
12001
+ spotterShareIncludeNewMessagesLabel?: string;
12002
+ /**
12003
+ * Footer note when the snapshot is current ("…up to the current moment…").
12004
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12005
+ */
12006
+ spotterShareUpToCurrentLabel?: string;
12007
+ /**
12008
+ * Stale-snapshot info banner text ("All added users and groups will receive…").
12009
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12010
+ */
12011
+ spotterShareStaleInfoLabel?: string;
12012
+ /**
12013
+ * Read-only shared-view data-access banner message.
12014
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12015
+ */
12016
+ spotterSharedConversationBannerMessage?: string;
12017
+ /**
12018
+ * Read-only shared-view Exit button label.
12019
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12020
+ * @default "Exit"
12021
+ */
12022
+ spotterSharedConversationExitLabel?: string;
12023
+ }
11421
12024
  /**
11422
12025
  * Configuration for customizing Spotter chat UI branding.
11423
12026
  * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
@@ -11472,8 +12075,27 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
11472
12075
  /**
11473
12076
  * The ID of the data source object. For example, Model, View, or Table. Spotter uses
11474
12077
  * this object to query data and generate Answers.
12078
+ * This field is optional. If not provided, Spotter loads using the
12079
+ * previously selected user data source.
11475
12080
  */
11476
- worksheetId: string;
12081
+ worksheetId?: string;
12082
+ /**
12083
+ * The array of data source GUIDs to set on load. Spotter uses
12084
+ * these GUIDs to query data and generate Answers.
12085
+ * dataSources is preferred over worksheetId if both are provided.
12086
+ * The feature is currently behind a feature flag.
12087
+ *
12088
+ * Supported embed types: `SpotterEmbed`
12089
+ * @example
12090
+ * ```js
12091
+ * const embed = new SpotterEmbed('#tsEmbed', {
12092
+ * // ...other embed view config
12093
+ * dataSources: ['id-2345', 'id-2345'],
12094
+ * });
12095
+ * ```
12096
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12097
+ */
12098
+ dataSources?: string[];
11477
12099
  /**
11478
12100
  * Ability to pass a starting search query to the conversation.
11479
12101
  */
@@ -11633,6 +12255,21 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
11633
12255
  * ```
11634
12256
  */
11635
12257
  updatedSpotterChatPrompt?: boolean;
12258
+ /**
12259
+ * showSpotterRadiance : Controls the radiance on the Spotter page.
12260
+ *
12261
+ * Supported embed types: `SpotterEmbed`
12262
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12263
+ * @default false
12264
+ * @example
12265
+ * ```js
12266
+ * const embed = new SpotterEmbed('#tsEmbed', {
12267
+ * ... //other embed view config
12268
+ * showSpotterRadiance : true,
12269
+ * })
12270
+ * ```
12271
+ */
12272
+ showSpotterRadiance?: boolean;
11636
12273
  /**
11637
12274
  * Sets the default query mode when Spotter loads — Fast Search or
11638
12275
  * Research Mode. Applies fresh on every new session for this embed
@@ -11709,6 +12346,59 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
11709
12346
  * ```
11710
12347
  */
11711
12348
  spotterChatConfig?: SpotterChatViewConfig;
12349
+ /**
12350
+ * Configuration for the Spotter conversation sharing feature.
12351
+ *
12352
+ * Supported embed types: `SpotterEmbed`, `AppEmbed`
12353
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12354
+ * @example
12355
+ * ```js
12356
+ * const embed = new SpotterEmbed('#tsEmbed', {
12357
+ * ... //other embed view config
12358
+ * spotterShareConversationConfig: {
12359
+ * enableShareConversation: true,
12360
+ * },
12361
+ * })
12362
+ * ```
12363
+ */
12364
+ spotterShareConversationConfig?: SpotterShareConversationConfig;
12365
+ /**
12366
+ * The ID of a shared Spotter conversation to open directly in the read-only
12367
+ * reader view. Use this to land a share recipient in the shared conversation
12368
+ * when they open a host-configured `CONVERSATION_URL` share link: read the
12369
+ * `{conversation-id}` from your page URL and pass it here.
12370
+ *
12371
+ * Requires the Spotter conversation-sharing feature to be enabled
12372
+ * (`spotterShareConversationConfig.enableShareConversation`). The recipient
12373
+ * must be an authorized sharee — the server returns access-denied otherwise.
12374
+ *
12375
+ * Supported embed types: `SpotterEmbed`
12376
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12377
+ * @example
12378
+ * ```js
12379
+ * const convId = new URLSearchParams(window.location.search).get('conversation-id');
12380
+ * const embed = new SpotterEmbed('#tsEmbed', {
12381
+ * ... //other embed view config
12382
+ * sharedConversationId: convId,
12383
+ * })
12384
+ * ```
12385
+ */
12386
+ sharedConversationId?: string;
12387
+ /**
12388
+ * updatedSpotterExperience : Controls the updated Spotter experience.
12389
+ *
12390
+ * Supported embed types: `SpotterEmbed`
12391
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
12392
+ * @default false
12393
+ * @example
12394
+ * ```js
12395
+ * const embed = new SpotterEmbed('#tsEmbed', {
12396
+ * ... //other embed view config
12397
+ * updatedSpotterExperience : true,
12398
+ * })
12399
+ * ```
12400
+ */
12401
+ updatedSpotterExperience?: boolean;
11712
12402
  }
11713
12403
  /**
11714
12404
  * The configuration for the embedded spotterEmbed options.
@@ -11725,6 +12415,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
11725
12415
  export interface SpotterAppInitData extends DefaultAppInitData {
11726
12416
  embedParams?: {
11727
12417
  spotterSidebarConfig?: SpotterSidebarViewConfig;
12418
+ spotterShareConversationConfig?: SpotterShareConversationConfig;
11728
12419
  visualOverridesParams?: VisualizationOverrides | null;
11729
12420
  };
11730
12421
  }
@@ -11967,6 +12658,9 @@ declare enum HomePage {
11967
12658
  /**
11968
12659
  * Modular (v2) introduces the updated Modular Home Experience.
11969
12660
  * It serves as the foundational version of the home page.
12661
+ * Use {@link HomePage.ModularWithStylingChanges} (V3) or
12662
+ * {@link HomePage.Focused} (V4) instead.
12663
+ * @deprecated V1 and V2 home page experiences are deprecated.
11970
12664
  */
11971
12665
  Modular = "v2",
11972
12666
  /**
@@ -12036,13 +12730,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12036
12730
  showPrimaryNavbar?: boolean;
12037
12731
  /**
12038
12732
  * Control the visibility of the left navigation panel on the home page
12039
- * in the V2 and V3 navigation and home page experience.
12733
+ * in the V3 and V4 navigation and home page experience.
12040
12734
  * If `showPrimaryNavbar` is true, that is, if the Global and Homepage
12041
12735
  * navigation bars are visible, this flag will only hide the left navigation bar
12042
12736
  * on the home page.
12043
12737
  * The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
12044
12738
  *
12045
- * **Note**: This attribute is not supported in the classic (V1) experience.
12739
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
12740
+ * deprecated. This attribute applies to V3 and V4 home page experiences.
12046
12741
  *
12047
12742
  * Supported embed types: `AppEmbed`
12048
12743
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -12108,11 +12803,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12108
12803
  hideHamburger?: boolean;
12109
12804
  /**
12110
12805
  * Control the visibility of the object search
12111
- * on the top navigation bar in the
12112
- * V2 and V3 navigation experience.
12806
+ * on the top navigation bar in the V3 navigation experience.
12113
12807
  *
12114
- * **Note**: This attribute is not supported
12115
- * in the classic (V1) experience.
12808
+ * **Note**: The classic (V1) and V2 navigation experiences are
12809
+ * deprecated. This attribute applies to the V3 navigation experience.
12116
12810
  *
12117
12811
  * Supported embed types: `AppEmbed`
12118
12812
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
@@ -12130,8 +12824,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12130
12824
  * Control the visibility of the notification icon
12131
12825
  * on the top navigation bar in V3 navigation experience.
12132
12826
  *
12133
- * **Note**: This attribute is not supported
12134
- * in the classic (V1) and V2 experience modes.
12827
+ * **Note**: The classic (V1) and V2 experience modes are deprecated.
12828
+ * This attribute applies to the V3 experience.
12135
12829
  *
12136
12830
  * Supported embed types: `AppEmbed`
12137
12831
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
@@ -12146,14 +12840,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12146
12840
  */
12147
12841
  hideNotification?: boolean;
12148
12842
  /**
12149
- * Control the visibility of the application selection menu
12150
- * in the top navigation bar in the V2 experience.
12843
+ * Control the visibility of the application selection menu.
12151
12844
  * In the V3 experience, it shows or hides application selection
12152
12845
  * icons on the left navigation panel.
12153
12846
  * By default, the application selection menu and icons are
12154
12847
  * shown in the UI.
12155
12848
  *
12156
- * **Note**: This attribute is not supported in the classic (V1) experience.
12849
+ * **Note**: The classic (V1) and V2 experiences are deprecated.
12850
+ * This attribute applies to the V3 experience.
12157
12851
  *
12158
12852
  * Supported embed types: `AppEmbed`
12159
12853
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -12171,7 +12865,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12171
12865
  * Control the visibility of the Org switcher button on the nav-bar.
12172
12866
  * By default, the Org switcher button is shown.
12173
12867
  *
12174
- * **Note**: This attribute is not supported in the classic (V1) experience.
12868
+ * **Note**: The classic (V1) experience is deprecated. This attribute
12869
+ * applies to V2 (deprecated), V3 and V4 experiences.
12175
12870
  *
12176
12871
  * Supported embed types: `AppEmbed`
12177
12872
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -12330,6 +13025,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12330
13025
  * Supported embed types: `AppEmbed`
12331
13026
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
12332
13027
  * @default false
13028
+ * Use the discoveryExperience.homePage option with
13029
+ * {@link HomePage.ModularWithStylingChanges} (V3) or
13030
+ * {@link HomePage.Focused} (V4) instead.
13031
+ * @deprecated The V1 and V2 home page experiences are deprecated.
12333
13032
  * @example
12334
13033
  * ```js
12335
13034
  * const embed = new AppEmbed('#tsEmbed', {
@@ -12461,11 +13160,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12461
13160
  /**
12462
13161
  * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
12463
13162
  * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
12464
- * This feature is GA from version 26.5.0.cl. It is disabled by default in embed deployments.
13163
+ * This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
12465
13164
  *
12466
13165
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
12467
13166
  * @type {boolean}
12468
13167
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
13168
+ * @default true
12469
13169
  * @example
12470
13170
  * ```js
12471
13171
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -12478,10 +13178,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12478
13178
  isContinuousLiveboardPDFEnabled?: boolean;
12479
13179
  /**
12480
13180
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
13181
+ * This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
12481
13182
  *
12482
13183
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
12483
13184
  * @type {boolean}
12484
13185
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
13186
+ * @default true
12485
13187
  * @example
12486
13188
  * ```js
12487
13189
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -12494,10 +13196,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12494
13196
  isLiveboardXLSXCSVDownloadEnabled?: boolean;
12495
13197
  /**
12496
13198
  * This flag is used to enable/disable the granular XLSX/CSV schedules feature
13199
+ * This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
12497
13200
  *
12498
13201
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
12499
13202
  * @type {boolean}
12500
13203
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
13204
+ * @default true
12501
13205
  * @example
12502
13206
  * ```js
12503
13207
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -12573,6 +13277,21 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12573
13277
  * ```
12574
13278
  */
12575
13279
  updatedSpotterChatPrompt?: boolean;
13280
+ /**
13281
+ * showSpotterRadiance : Controls the radiance on the Spotter page.
13282
+ *
13283
+ * Supported embed types: `AppEmbed`
13284
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
13285
+ * @default false
13286
+ * @example
13287
+ * ```js
13288
+ * const embed = new AppEmbed('#tsEmbed', {
13289
+ * ... //other embed view config
13290
+ * showSpotterRadiance : true,
13291
+ * })
13292
+ * ```
13293
+ */
13294
+ showSpotterRadiance?: boolean;
12576
13295
  /**
12577
13296
  * Sets the default query mode when Spotter loads — Fast Search or
12578
13297
  * Research Mode. Applies fresh on every new session for this embed
@@ -12617,6 +13336,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12617
13336
  * spotterSidebarConfig: {
12618
13337
  * enablePastConversationsSidebar: true,
12619
13338
  * spotterSidebarTitle: 'My Conversations',
13339
+ * // Opt in to pin/unpin conversations in embedded Spotter
13340
+ * spotterChatPinConfig: {
13341
+ * enabled: true,
13342
+ * },
12620
13343
  * },
12621
13344
  * })
12622
13345
  * ```
@@ -12640,6 +13363,49 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12640
13363
  * ```
12641
13364
  */
12642
13365
  spotterChatConfig?: SpotterChatViewConfig;
13366
+ /**
13367
+ * Configuration for the Spotter conversation sharing feature.
13368
+ *
13369
+ * Supported embed types: `AppEmbed`
13370
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
13371
+ * @example
13372
+ * ```js
13373
+ * const embed = new AppEmbed('#tsEmbed', {
13374
+ * ... //other embed view config
13375
+ * spotterShareConversationConfig: {
13376
+ * enableShareConversation: true,
13377
+ * },
13378
+ * })
13379
+ * ```
13380
+ */
13381
+ spotterShareConversationConfig?: SpotterShareConversationConfig;
13382
+ /**
13383
+ * Sets the default data sources (Models) for the Spotter experience shown on
13384
+ * the home page of the full app embed. Accepts a list of Model GUIDs to
13385
+ * preselect the data sources available to Spotter, or the literal
13386
+ * `'auto_mode'` sentinel to load Spotter with the "Auto" model selected by
13387
+ * default. This is consistent with how `worksheetId: 'auto_mode'` enables
13388
+ * Auto mode in `SpotterEmbed`.
13389
+ *
13390
+ * **Note**: If `'auto_mode'` is included alongside one or more Model GUIDs,
13391
+ * `'auto_mode'` takes precedence and is selected by default.
13392
+ *
13393
+ * **Note**: `'auto_mode'` requires the Spotter 3 experience with data source
13394
+ * discovery enabled on your instance, and a Spotter-enabled home page (for
13395
+ * example, `discoveryExperience.homePage: HomePage.Focused`).
13396
+ *
13397
+ * Supported embed types: `AppEmbed`
13398
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.10.0.cl
13399
+ * @example
13400
+ * ```js
13401
+ * const embed = new AppEmbed('#tsEmbed', {
13402
+ * ... // other embed view config
13403
+ * discoveryExperience: { homePage: HomePage.Focused },
13404
+ * spotterDataSources: ['model-guid-1', 'model-guid-2'], // or ['auto_mode']
13405
+ * })
13406
+ * ```
13407
+ */
13408
+ spotterDataSources?: string[];
12643
13409
  /**
12644
13410
  * Configuration for the SpotterViz interface shown on the Liveboard.
12645
13411
  * Customize the brand name, description, chat input placeholder,
@@ -12735,6 +13501,21 @@ export interface AppViewConfig extends AllEmbedViewConfig {
12735
13501
  * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
12736
13502
  */
12737
13503
  visualOverrides?: VisualizationOverrides;
13504
+ /**
13505
+ * updatedSpotterExperience : Controls the updated Spotter experience.
13506
+ *
13507
+ * Supported embed types: `AppEmbed`
13508
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
13509
+ * @default false
13510
+ * @example
13511
+ * ```js
13512
+ * const embed = new AppEmbed('#tsEmbed', {
13513
+ * ... //other embed view config
13514
+ * updatedSpotterExperience : true,
13515
+ * })
13516
+ * ```
13517
+ */
13518
+ updatedSpotterExperience?: boolean;
12738
13519
  }
12739
13520
  /**
12740
13521
  * APP_INIT data shape for AppEmbed.
@@ -12744,6 +13525,7 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
12744
13525
  embedParams?: {
12745
13526
  spotterSidebarConfig?: SpotterSidebarViewConfig;
12746
13527
  spotterVizConfig?: SpotterVizConfig;
13528
+ spotterShareConversationConfig?: SpotterShareConversationConfig;
12747
13529
  };
12748
13530
  }
12749
13531
  declare class AppEmbed extends V1Embed {
@@ -12770,6 +13552,7 @@ declare class AppEmbed extends V1Embed {
12770
13552
  * embedded Liveboard or visualization.
12771
13553
  */
12772
13554
  protected getEmbedParams(): string;
13555
+ protected getEmbedParamsObject(): any;
12773
13556
  private sendFullHeightLazyLoadData;
12774
13557
  /**
12775
13558
  * This is a handler for the RequestVisibleEmbedCoordinates event.
@@ -13194,11 +13977,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
13194
13977
  /**
13195
13978
  * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
13196
13979
  * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
13197
- * This feature is GA from version 26.5.0.cl. It is disabled by default in embed deployments.
13980
+ * This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
13198
13981
  *
13199
13982
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
13200
13983
  * @type {boolean}
13201
13984
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
13985
+ * @default true
13202
13986
  * @example
13203
13987
  * ```js
13204
13988
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -13211,10 +13995,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
13211
13995
  isContinuousLiveboardPDFEnabled?: boolean;
13212
13996
  /**
13213
13997
  * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
13998
+ * This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.
13214
13999
  *
13215
14000
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
13216
14001
  * @type {boolean}
13217
14002
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
14003
+ * @default true
13218
14004
  * @example
13219
14005
  * ```js
13220
14006
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -13227,10 +14013,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
13227
14013
  isLiveboardXLSXCSVDownloadEnabled?: boolean;
13228
14014
  /**
13229
14015
  * This flag is used to enable/disable the granular XLSX/CSV schedules feature
14016
+ * This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.
13230
14017
  *
13231
14018
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
13232
14019
  * @type {boolean}
13233
14020
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
14021
+ * @default true
13234
14022
  * @example
13235
14023
  * ```js
13236
14024
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -13321,6 +14109,21 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
13321
14109
  * ```
13322
14110
  */
13323
14111
  updatedSpotterChatPrompt?: boolean;
14112
+ /**
14113
+ * showSpotterRadiance : Controls the radiance on the Spotter page.
14114
+ *
14115
+ * Supported embed types: `LiveboardEmbed`
14116
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
14117
+ * @default false
14118
+ * @example
14119
+ * ```js
14120
+ * const embed = new LiveboardEmbed('#tsEmbed', {
14121
+ * ... //other embed view config
14122
+ * showSpotterRadiance : true,
14123
+ * })
14124
+ * ```
14125
+ */
14126
+ showSpotterRadiance?: boolean;
13324
14127
  /**
13325
14128
  * Enables the stop answer generation button in the Spotter embed UI,
13326
14129
  * allowing users to interrupt an ongoing answer generation.
@@ -13396,6 +14199,21 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
13396
14199
  * ```
13397
14200
  */
13398
14201
  enableLiveboardDataCache?: boolean;
14202
+ /**
14203
+ * updatedSpotterExperience : Controls the updated Spotter experience.
14204
+ *
14205
+ * Supported embed types: `LiveboardEmbed`
14206
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
14207
+ * @default false
14208
+ * @example
14209
+ * ```js
14210
+ * const embed = new LiveboardEmbed('#tsEmbed', {
14211
+ * ... //other embed view config
14212
+ * updatedSpotterExperience : true,
14213
+ * })
14214
+ * ```
14215
+ */
14216
+ updatedSpotterExperience?: boolean;
13399
14217
  }
13400
14218
  declare class LiveboardEmbed extends V1Embed {
13401
14219
  protected viewConfig: LiveboardViewConfig;