@thoughtspot/visual-embed-sdk 1.47.0 → 1.47.2

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 (89) hide show
  1. package/cjs/package.json +3 -3
  2. package/cjs/src/embed/app.d.ts +37 -0
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +10 -1
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/app.spec.js +59 -0
  7. package/cjs/src/embed/app.spec.js.map +1 -1
  8. package/cjs/src/embed/conversation.d.ts +9 -0
  9. package/cjs/src/embed/conversation.d.ts.map +1 -1
  10. package/cjs/src/embed/conversation.js +2 -1
  11. package/cjs/src/embed/conversation.js.map +1 -1
  12. package/cjs/src/embed/hostEventClient/contracts.d.ts +4 -1
  13. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  14. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +2 -2
  15. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  16. package/cjs/src/embed/liveboard.d.ts +22 -0
  17. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  18. package/cjs/src/embed/liveboard.js +7 -1
  19. package/cjs/src/embed/liveboard.js.map +1 -1
  20. package/cjs/src/embed/liveboard.spec.js +32 -0
  21. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  22. package/cjs/src/embed/ts-embed.d.ts +13 -1
  23. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  24. package/cjs/src/embed/ts-embed.js +14 -0
  25. package/cjs/src/embed/ts-embed.js.map +1 -1
  26. package/cjs/src/types.d.ts +110 -6
  27. package/cjs/src/types.d.ts.map +1 -1
  28. package/cjs/src/types.js +106 -2
  29. package/cjs/src/types.js.map +1 -1
  30. package/dist/{index-Bm2Hck8q.js → index-CFZ7RDZ9.js} +1 -1
  31. package/dist/src/embed/app.d.ts +37 -0
  32. package/dist/src/embed/app.d.ts.map +1 -1
  33. package/dist/src/embed/conversation.d.ts +9 -0
  34. package/dist/src/embed/conversation.d.ts.map +1 -1
  35. package/dist/src/embed/hostEventClient/contracts.d.ts +4 -1
  36. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  37. package/dist/src/embed/liveboard.d.ts +22 -0
  38. package/dist/src/embed/liveboard.d.ts.map +1 -1
  39. package/dist/src/embed/ts-embed.d.ts +13 -1
  40. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  41. package/dist/src/types.d.ts +110 -6
  42. package/dist/src/types.d.ts.map +1 -1
  43. package/dist/tsembed-react.es.js +144 -10
  44. package/dist/tsembed-react.js +143 -9
  45. package/dist/tsembed.es.js +144 -10
  46. package/dist/tsembed.js +143 -9
  47. package/dist/visual-embed-sdk-react-full.d.ts +189 -6
  48. package/dist/visual-embed-sdk-react.d.ts +189 -6
  49. package/dist/visual-embed-sdk.d.ts +189 -6
  50. package/lib/package.json +3 -3
  51. package/lib/src/embed/app.d.ts +37 -0
  52. package/lib/src/embed/app.d.ts.map +1 -1
  53. package/lib/src/embed/app.js +10 -1
  54. package/lib/src/embed/app.js.map +1 -1
  55. package/lib/src/embed/app.spec.js +59 -0
  56. package/lib/src/embed/app.spec.js.map +1 -1
  57. package/lib/src/embed/conversation.d.ts +9 -0
  58. package/lib/src/embed/conversation.d.ts.map +1 -1
  59. package/lib/src/embed/conversation.js +2 -1
  60. package/lib/src/embed/conversation.js.map +1 -1
  61. package/lib/src/embed/hostEventClient/contracts.d.ts +4 -1
  62. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  63. package/lib/src/embed/hostEventClient/host-event-client.spec.js +2 -2
  64. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  65. package/lib/src/embed/liveboard.d.ts +22 -0
  66. package/lib/src/embed/liveboard.d.ts.map +1 -1
  67. package/lib/src/embed/liveboard.js +7 -1
  68. package/lib/src/embed/liveboard.js.map +1 -1
  69. package/lib/src/embed/liveboard.spec.js +32 -0
  70. package/lib/src/embed/liveboard.spec.js.map +1 -1
  71. package/lib/src/embed/ts-embed.d.ts +13 -1
  72. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  73. package/lib/src/embed/ts-embed.js +14 -0
  74. package/lib/src/embed/ts-embed.js.map +1 -1
  75. package/lib/src/types.d.ts +110 -6
  76. package/lib/src/types.d.ts.map +1 -1
  77. package/lib/src/types.js +106 -2
  78. package/lib/src/types.js.map +1 -1
  79. package/lib/src/visual-embed-sdk.d.ts +189 -6
  80. package/package.json +3 -3
  81. package/src/embed/app.spec.ts +84 -1
  82. package/src/embed/app.ts +51 -0
  83. package/src/embed/conversation.ts +11 -0
  84. package/src/embed/hostEventClient/contracts.ts +2 -1
  85. package/src/embed/hostEventClient/host-event-client.spec.ts +2 -2
  86. package/src/embed/liveboard.spec.ts +41 -0
  87. package/src/embed/liveboard.ts +31 -0
  88. package/src/embed/ts-embed.ts +15 -0
  89. package/src/types.ts +109 -2
package/dist/tsembed.js CHANGED
@@ -1,4 +1,4 @@
1
- /* @thoughtspot/visual-embed-sdk version 1.47.0 */
1
+ /* @thoughtspot/visual-embed-sdk version 1.47.2 */
2
2
  'use client';
3
3
  (function (global, factory) {
4
4
  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
@@ -1801,6 +1801,53 @@
1801
1801
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
1802
1802
  */
1803
1803
  EmbedEvent["RefreshAuthToken"] = "RefreshAuthToken";
1804
+ /**
1805
+ * Triggered whenever the page context changes, returning the current context along with the navigation stack.
1806
+ * @example
1807
+ * ```js
1808
+ * embed.on(EmbedEvent.EmbedPageContextChanged, (payload) => {
1809
+ * console.log('payload', payload);
1810
+ * })
1811
+ * ```
1812
+ * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
1813
+ */
1814
+ EmbedEvent["EmbedPageContextChanged"] = "EmbedPageContextChanged";
1815
+ /**
1816
+ * Represents a special embed event that is triggered whenever any host event is subscribed.
1817
+ *
1818
+ * You can listen to this event when you need to dispatch a host event during load or render,
1819
+ * particularly in situations where timing issues may occur.
1820
+ *
1821
+ * @example
1822
+ * ```js
1823
+ * embed.on(`${HostEvent.Save} Subscribed`, () => {
1824
+ * // make action
1825
+ * });
1826
+ * ```
1827
+ *
1828
+ * @example
1829
+ * ```js
1830
+ * embed.on(subscribedEvent(HostEvent.Save), () => {
1831
+ * // make action
1832
+ * });
1833
+ * ```
1834
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.4.0.cl
1835
+ */
1836
+ EmbedEvent["Subscribed"] = "Subscribed";
1837
+ /**
1838
+ * Emitted when a user clicks the **Send Test Email** button in the
1839
+ * Liveboard schedule modal. Requires `isSendNowLiveboardSchedulingEnabled`
1840
+ * to be enabled.
1841
+ * @example
1842
+ * ```js
1843
+ * liveboardEmbed.on(EmbedEvent.SendTestScheduleEmail, (payload) => {
1844
+ * console.log('Send test email', payload);
1845
+ * // payload: { liveboardId: string, sendToSelf: boolean }
1846
+ * })
1847
+ * ```
1848
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
1849
+ */
1850
+ EmbedEvent["SendTestScheduleEmail"] = "sendTestScheduleEmail";
1804
1851
  })(exports.EmbedEvent || (exports.EmbedEvent = {}));
1805
1852
  /**
1806
1853
  * Event types that can be triggered by the host application
@@ -3500,7 +3547,8 @@
3500
3547
  * ```js
3501
3548
  * // Get parameters from liveboard context
3502
3549
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3503
- * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
3550
+ * liveboardEmbed.trigger(HostEvent.GetParameters, {},
3551
+ * ContextType.Liveboard).then((parameters) => {
3504
3552
  * console.log('parameters', parameters);
3505
3553
  * });
3506
3554
  * ```
@@ -3852,6 +3900,26 @@
3852
3900
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3853
3901
  */
3854
3902
  HostEvent["GetPageContext"] = "GetPageContext";
3903
+ /**
3904
+ * Trigger the **Send Test Email** action in the Liveboard schedule modal.
3905
+ * Sends a test schedule email to self or all recipients.
3906
+ * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
3907
+ * @example
3908
+ * ```js
3909
+ * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
3910
+ * sendToSelf: true,
3911
+ * })
3912
+ * ```
3913
+ * @example
3914
+ * ```js
3915
+ * // Send to all recipients
3916
+ * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
3917
+ * sendToSelf: false,
3918
+ * })
3919
+ * ```
3920
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
3921
+ */
3922
+ HostEvent["SendTestScheduleEmail"] = "sendTestScheduleEmail";
3855
3923
  })(exports.HostEvent || (exports.HostEvent = {}));
3856
3924
  /**
3857
3925
  * The different visual modes that the data sources panel within
@@ -3989,6 +4057,7 @@
3989
4057
  Param["HideIrrelevantFiltersInTab"] = "hideIrrelevantFiltersAtTabLevel";
3990
4058
  Param["IsEnhancedFilterInteractivityEnabled"] = "isLiveboardPermissionV2Enabled";
3991
4059
  Param["SpotterEnabled"] = "isSpotterExperienceEnabled";
4060
+ Param["IsUnifiedSearchExperienceEnabled"] = "isUnifiedSearchExperienceEnabled";
3992
4061
  Param["OverrideOrgId"] = "orgId";
3993
4062
  Param["OauthPollingInterval"] = "oAuthPollingInterval";
3994
4063
  Param["IsForceRedirect"] = "isForceRedirect";
@@ -4005,10 +4074,12 @@
4005
4074
  Param["IsWYSIWYGLiveboardPDFEnabled"] = "isWYSIWYGLiveboardPDFEnabled";
4006
4075
  Param["isLiveboardXLSXCSVDownloadEnabled"] = "isLiveboardXLSXCSVDownloadEnabled";
4007
4076
  Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
4077
+ Param["isSendNowLiveboardSchedulingEnabled"] = "isSendNowLiveboardSchedulingEnabled";
4008
4078
  Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
4009
4079
  Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
4010
4080
  Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
4011
4081
  Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
4082
+ Param["EnableStopAnswerGenerationEmbed"] = "enableStopAnswerGenerationEmbed";
4012
4083
  Param["SpotterSidebarTitle"] = "spotterSidebarTitle";
4013
4084
  Param["SpotterSidebarDefaultExpanded"] = "spotterSidebarDefaultExpanded";
4014
4085
  Param["SpotterChatRenameLabel"] = "spotterChatRenameLabel";
@@ -4023,6 +4094,7 @@
4023
4094
  Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
4024
4095
  Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
4025
4096
  Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
4097
+ Param["EnableLiveboardDataCache"] = "enableLiveboardDataCache";
4026
4098
  })(Param || (Param = {}));
4027
4099
  /**
4028
4100
  * ThoughtSpot application pages include actions and menu commands
@@ -4344,7 +4416,7 @@
4344
4416
  * ```js
4345
4417
  * disabledActions: [Action.DownloadLiveboard]
4346
4418
  * ```
4347
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
4419
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4348
4420
  */
4349
4421
  Action["DownloadLiveboard"] = "downloadLiveboard";
4350
4422
  /**
@@ -4357,6 +4429,26 @@
4357
4429
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4358
4430
  */
4359
4431
  Action["DownloadLiveboardAsContinuousPDF"] = "downloadLiveboardAsContinuousPDF";
4432
+ /**
4433
+ * The **Download Liveboard as XLSX** menu action on a Liveboard.
4434
+ * Allows downloading the entire Liveboard as an XLSX file.
4435
+ * @example
4436
+ * ```js
4437
+ * disabledActions: [Action.DownloadLiveboardAsXlsx]
4438
+ * ```
4439
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4440
+ */
4441
+ Action["DownloadLiveboardAsXlsx"] = "downloadLiveboardAsXlsx";
4442
+ /**
4443
+ * The **Download Liveboard as CSV** menu action on a Liveboard.
4444
+ * Allows downloading the entire Liveboard as a CSV file.
4445
+ * @example
4446
+ * ```js
4447
+ * disabledActions: [Action.DownloadLiveboardAsCsv]
4448
+ * ```
4449
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4450
+ */
4451
+ Action["DownloadLiveboardAsCsv"] = "downloadLiveboardAsCsv";
4360
4452
  /**
4361
4453
  * @hidden
4362
4454
  */
@@ -5619,6 +5711,18 @@
5619
5711
  * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
5620
5712
  */
5621
5713
  Action["IncludeCurrentPeriod"] = "includeCurrentPeriod";
5714
+ /**
5715
+ * The **Send Test Email** button in the Liveboard schedule modal.
5716
+ * Allows sending a test schedule email to self or all recipients.
5717
+ * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
5718
+ * @example
5719
+ * ```js
5720
+ * disabledActions: [Action.SendTestScheduleEmail]
5721
+ * hiddenActions: [Action.SendTestScheduleEmail]
5722
+ * ```
5723
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
5724
+ */
5725
+ Action["SendTestScheduleEmail"] = "sendTestScheduleEmail";
5622
5726
  })(exports.Action || (exports.Action = {}));
5623
5727
  exports.PrefetchFeatures = void 0;
5624
5728
  (function (PrefetchFeatures) {
@@ -7566,7 +7670,7 @@
7566
7670
  * @name has
7567
7671
  * @memberOf SetCache
7568
7672
  * @param {*} value The value to search for.
7569
- * @returns {number} Returns `true` if `value` is found, else `false`.
7673
+ * @returns {boolean} Returns `true` if `value` is found, else `false`.
7570
7674
  */
7571
7675
  function setCacheHas(value) {
7572
7676
  return this.__data__.has(value);
@@ -10935,7 +11039,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
10935
11039
  if (isArray_1(iteratee)) {
10936
11040
  return function(value) {
10937
11041
  return _baseGet(value, iteratee.length === 1 ? iteratee[0] : iteratee);
10938
- }
11042
+ };
10939
11043
  }
10940
11044
  return iteratee;
10941
11045
  });
@@ -19335,7 +19439,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
19335
19439
  return eventData;
19336
19440
  }
19337
19441
 
19338
- var version$1="1.47.0";var pkgInfo = {version:version$1};
19442
+ var version$1="1.47.2";var pkgInfo = {version:version$1};
19339
19443
 
19340
19444
  function isValidUpdateFiltersPayload(payload) {
19341
19445
  if (!payload)
@@ -20981,6 +21085,20 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
20981
21085
  });
20982
21086
  });
20983
21087
  }
21088
+ /**
21089
+ * Generates the event name for a "Subscribed" embed event.
21090
+ *
21091
+ * This helper appends the "Subscribed" suffix to a given host or action event,
21092
+ * allowing you to listen for subscription lifecycle events in a consistent format.
21093
+ *
21094
+ * @param eventName - The host or action event to generate the subscribed event name for.
21095
+ * @returns The formatted event name (e.g., "Save Subscribed").
21096
+ *
21097
+ * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
21098
+ */
21099
+ subscribedEvent(eventName) {
21100
+ return `${eventName} ${exports.EmbedEvent.Subscribed}`;
21101
+ }
20984
21102
  /**
20985
21103
  * Creates the preRender shell
20986
21104
  * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -21570,7 +21688,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
21570
21688
  * embedded Liveboard or visualization.
21571
21689
  */
21572
21690
  getEmbedParams() {
21573
- const { tag, hideTagFilterChips, hideObjects, liveboardV2, showPrimaryNavbar, disableProfileAndHelp, hideHamburger, hideObjectSearch, hideNotification, hideApplicationSwitcher, hideOrgSwitcher, enableSearchAssist, fullHeight, dataPanelV2 = true, hideLiveboardHeader = false, showLiveboardTitle = true, showLiveboardDescription = true, showMaskedFilterChip = false, isLiveboardMasterpiecesEnabled = false, hideHomepageLeftNav = false, modularHomeExperience = false, isLiveboardHeaderSticky = true, enableAskSage, collapseSearchBarInitially = false, enable2ColumnLayout, enableCustomColumnGroups = false, dataPanelCustomGroupsAccordionInitialState = exports.DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, isEnhancedFilterInteractivityEnabled = false, homePageSearchBarMode, enablePendoHelp = true, discoveryExperience, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, isPNGInScheduledEmailsEnabled = false, isLiveboardXLSXCSVDownloadEnabled = false, isGranularXLSXCSVSchedulesEnabled = false, isCentralizedLiveboardFilterUXEnabled = false, isLinkParametersEnabled, updatedSpotterChatPrompt, spotterChatConfig, minimumHeight, isThisPeriodInDateFiltersEnabled, enableHomepageAnnouncement = false, isContinuousLiveboardPDFEnabled, } = this.viewConfig;
21691
+ const { tag, hideTagFilterChips, hideObjects, liveboardV2, showPrimaryNavbar, disableProfileAndHelp, hideHamburger, hideObjectSearch, hideNotification, hideApplicationSwitcher, hideOrgSwitcher, enableSearchAssist, fullHeight, dataPanelV2 = true, hideLiveboardHeader = false, showLiveboardTitle = true, showLiveboardDescription = true, showMaskedFilterChip = false, isLiveboardMasterpiecesEnabled = false, hideHomepageLeftNav = false, modularHomeExperience = false, isLiveboardHeaderSticky = true, enableAskSage, collapseSearchBarInitially = false, enable2ColumnLayout, enableCustomColumnGroups = false, dataPanelCustomGroupsAccordionInitialState = exports.DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, isEnhancedFilterInteractivityEnabled = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, enablePendoHelp = true, discoveryExperience, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, isPNGInScheduledEmailsEnabled = false, isLiveboardXLSXCSVDownloadEnabled = false, isGranularXLSXCSVSchedulesEnabled = false, isCentralizedLiveboardFilterUXEnabled = false, isLinkParametersEnabled, updatedSpotterChatPrompt, enableStopAnswerGenerationEmbed, spotterChatConfig, minimumHeight, isThisPeriodInDateFiltersEnabled, enableHomepageAnnouncement = false, isContinuousLiveboardPDFEnabled, enableLiveboardDataCache, } = this.viewConfig;
21574
21692
  let params = {};
21575
21693
  params[Param.PrimaryNavHidden] = !showPrimaryNavbar;
21576
21694
  params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
@@ -21588,11 +21706,17 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
21588
21706
  params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;
21589
21707
  params[Param.ShowLiveboardReverifyBanner] = showLiveboardReverifyBanner;
21590
21708
  params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
21709
+ if (isUnifiedSearchExperienceEnabled !== undefined) {
21710
+ params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
21711
+ }
21591
21712
  params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
21592
21713
  params = this.getBaseQueryParams(params);
21593
21714
  if (!isUndefined(updatedSpotterChatPrompt)) {
21594
21715
  params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
21595
21716
  }
21717
+ if (!isUndefined(enableStopAnswerGenerationEmbed)) {
21718
+ params[Param.EnableStopAnswerGenerationEmbed] = !!enableStopAnswerGenerationEmbed;
21719
+ }
21596
21720
  // Handle spotterChatConfig params
21597
21721
  if (spotterChatConfig) {
21598
21722
  const { hideToolResponseCardBranding, toolResponseCardBrandingLabel, } = spotterChatConfig;
@@ -21672,6 +21796,9 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
21672
21796
  params[Param.IsWYSIWYGLiveboardPDFEnabled] = isContinuousLiveboardPDFEnabled;
21673
21797
  }
21674
21798
  this.defaultHeight = minimumHeight || this.defaultHeight;
21799
+ if (enableLiveboardDataCache !== undefined) {
21800
+ params[Param.EnableLiveboardDataCache] = enableLiveboardDataCache;
21801
+ }
21675
21802
  params[Param.DataPanelV2Enabled] = dataPanelV2;
21676
21803
  params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
21677
21804
  params[Param.ModularHomeExperienceEnabled] = modularHomeExperience;
@@ -22029,7 +22156,7 @@ query GetEurekaVizSnapshots(
22029
22156
  getEmbedParamsObject() {
22030
22157
  let params = {};
22031
22158
  params = this.getBaseQueryParams(params);
22032
- const { enableVizTransformations, fullHeight, defaultHeight, minimumHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, isLiveboardHeaderSticky = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, showMaskedFilterChip = false, isLiveboardMasterpiecesEnabled = false, isEnhancedFilterInteractivityEnabled = false, enableAskSage, enable2ColumnLayout, dataPanelV2 = true, enableCustomColumnGroups = false, oAuthPollingInterval, isForceRedirect, dataSourceId, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, isPNGInScheduledEmailsEnabled = false, isLiveboardXLSXCSVDownloadEnabled = false, isGranularXLSXCSVSchedulesEnabled = false, showSpotterLimitations, isCentralizedLiveboardFilterUXEnabled = false, isLinkParametersEnabled, updatedSpotterChatPrompt, spotterChatConfig, isThisPeriodInDateFiltersEnabled, isContinuousLiveboardPDFEnabled, } = this.viewConfig;
22159
+ const { enableVizTransformations, fullHeight, defaultHeight, minimumHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, isLiveboardHeaderSticky = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, showMaskedFilterChip = false, isLiveboardMasterpiecesEnabled = false, isEnhancedFilterInteractivityEnabled = false, enableAskSage, enable2ColumnLayout, dataPanelV2 = true, enableCustomColumnGroups = false, oAuthPollingInterval, isForceRedirect, dataSourceId, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, isPNGInScheduledEmailsEnabled = false, isLiveboardXLSXCSVDownloadEnabled = false, isGranularXLSXCSVSchedulesEnabled = false, showSpotterLimitations, isCentralizedLiveboardFilterUXEnabled = false, isLinkParametersEnabled, updatedSpotterChatPrompt, enableStopAnswerGenerationEmbed, spotterChatConfig, isThisPeriodInDateFiltersEnabled, isContinuousLiveboardPDFEnabled, enableLiveboardDataCache, } = this.viewConfig;
22033
22160
  const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
22034
22161
  || this.viewConfig.preventPinboardFilterRemoval;
22035
22162
  if (fullHeight === true) {
@@ -22051,6 +22178,9 @@ query GetEurekaVizSnapshots(
22051
22178
  if (!isUndefined(updatedSpotterChatPrompt)) {
22052
22179
  params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
22053
22180
  }
22181
+ if (!isUndefined(enableStopAnswerGenerationEmbed)) {
22182
+ params[Param.EnableStopAnswerGenerationEmbed] = !!enableStopAnswerGenerationEmbed;
22183
+ }
22054
22184
  if (visibleVizs) {
22055
22185
  params[Param.visibleVizs] = visibleVizs;
22056
22186
  }
@@ -22121,6 +22251,9 @@ query GetEurekaVizSnapshots(
22121
22251
  if (isContinuousLiveboardPDFEnabled !== undefined) {
22122
22252
  params[Param.IsWYSIWYGLiveboardPDFEnabled] = isContinuousLiveboardPDFEnabled;
22123
22253
  }
22254
+ if (enableLiveboardDataCache !== undefined) {
22255
+ params[Param.EnableLiveboardDataCache] = enableLiveboardDataCache;
22256
+ }
22124
22257
  params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
22125
22258
  params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
22126
22259
  params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;
@@ -23154,7 +23287,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
23154
23287
  return buildSpotterSidebarAppInitData(defaultAppInitData, this.viewConfig, this.handleError.bind(this));
23155
23288
  }
23156
23289
  getEmbedParamsObject() {
23157
- const { worksheetId, searchOptions, disableSourceSelection, hideSourceSelection, dataPanelV2, showSpotterLimitations, hideSampleQuestions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, updatedSpotterChatPrompt, spotterChatConfig, } = this.viewConfig;
23290
+ const { worksheetId, searchOptions, disableSourceSelection, hideSourceSelection, dataPanelV2, showSpotterLimitations, hideSampleQuestions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, updatedSpotterChatPrompt, enableStopAnswerGenerationEmbed, spotterChatConfig, } = this.viewConfig;
23158
23291
  if (!worksheetId) {
23159
23292
  this.handleError({
23160
23293
  errorType: exports.ErrorDetailsTypes.VALIDATION_ERROR,
@@ -23172,6 +23305,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
23172
23305
  setParamIfDefined(queryParams, Param.ShowSpotterLimitations, showSpotterLimitations, true);
23173
23306
  setParamIfDefined(queryParams, Param.HideSampleQuestions, hideSampleQuestions, true);
23174
23307
  setParamIfDefined(queryParams, Param.UpdatedSpotterChatPrompt, updatedSpotterChatPrompt, true);
23308
+ setParamIfDefined(queryParams, Param.EnableStopAnswerGenerationEmbed, enableStopAnswerGenerationEmbed, true);
23175
23309
  // Handle spotterChatConfig params
23176
23310
  if (spotterChatConfig) {
23177
23311
  const { hideToolResponseCardBranding, toolResponseCardBrandingLabel, } = spotterChatConfig;
@@ -4493,7 +4493,54 @@ export declare enum EmbedEvent {
4493
4493
  * ```
4494
4494
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
4495
4495
  */
4496
- RefreshAuthToken = "RefreshAuthToken"
4496
+ RefreshAuthToken = "RefreshAuthToken",
4497
+ /**
4498
+ * Triggered whenever the page context changes, returning the current context along with the navigation stack.
4499
+ * @example
4500
+ * ```js
4501
+ * embed.on(EmbedEvent.EmbedPageContextChanged, (payload) => {
4502
+ * console.log('payload', payload);
4503
+ * })
4504
+ * ```
4505
+ * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
4506
+ */
4507
+ EmbedPageContextChanged = "EmbedPageContextChanged",
4508
+ /**
4509
+ * Represents a special embed event that is triggered whenever any host event is subscribed.
4510
+ *
4511
+ * You can listen to this event when you need to dispatch a host event during load or render,
4512
+ * particularly in situations where timing issues may occur.
4513
+ *
4514
+ * @example
4515
+ * ```js
4516
+ * embed.on(`${HostEvent.Save} Subscribed`, () => {
4517
+ * // make action
4518
+ * });
4519
+ * ```
4520
+ *
4521
+ * @example
4522
+ * ```js
4523
+ * embed.on(subscribedEvent(HostEvent.Save), () => {
4524
+ * // make action
4525
+ * });
4526
+ * ```
4527
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.4.0.cl
4528
+ */
4529
+ Subscribed = "Subscribed",
4530
+ /**
4531
+ * Emitted when a user clicks the **Send Test Email** button in the
4532
+ * Liveboard schedule modal. Requires `isSendNowLiveboardSchedulingEnabled`
4533
+ * to be enabled.
4534
+ * @example
4535
+ * ```js
4536
+ * liveboardEmbed.on(EmbedEvent.SendTestScheduleEmail, (payload) => {
4537
+ * console.log('Send test email', payload);
4538
+ * // payload: { liveboardId: string, sendToSelf: boolean }
4539
+ * })
4540
+ * ```
4541
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
4542
+ */
4543
+ SendTestScheduleEmail = "sendTestScheduleEmail"
4497
4544
  }
4498
4545
  /**
4499
4546
  * Event types that can be triggered by the host application
@@ -6191,7 +6238,8 @@ export declare enum HostEvent {
6191
6238
  * ```js
6192
6239
  * // Get parameters from liveboard context
6193
6240
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6194
- * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
6241
+ * liveboardEmbed.trigger(HostEvent.GetParameters, {},
6242
+ * ContextType.Liveboard).then((parameters) => {
6195
6243
  * console.log('parameters', parameters);
6196
6244
  * });
6197
6245
  * ```
@@ -6542,7 +6590,27 @@ export declare enum HostEvent {
6542
6590
  * ```
6543
6591
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
6544
6592
  */
6545
- GetPageContext = "GetPageContext"
6593
+ GetPageContext = "GetPageContext",
6594
+ /**
6595
+ * Trigger the **Send Test Email** action in the Liveboard schedule modal.
6596
+ * Sends a test schedule email to self or all recipients.
6597
+ * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
6598
+ * @example
6599
+ * ```js
6600
+ * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
6601
+ * sendToSelf: true,
6602
+ * })
6603
+ * ```
6604
+ * @example
6605
+ * ```js
6606
+ * // Send to all recipients
6607
+ * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
6608
+ * sendToSelf: false,
6609
+ * })
6610
+ * ```
6611
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
6612
+ */
6613
+ SendTestScheduleEmail = "sendTestScheduleEmail"
6546
6614
  }
6547
6615
  /**
6548
6616
  * The different visual modes that the data sources panel within
@@ -6881,7 +6949,7 @@ export declare enum Action {
6881
6949
  * ```js
6882
6950
  * disabledActions: [Action.DownloadLiveboard]
6883
6951
  * ```
6884
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
6952
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6885
6953
  */
6886
6954
  DownloadLiveboard = "downloadLiveboard",
6887
6955
  /**
@@ -6894,6 +6962,26 @@ export declare enum Action {
6894
6962
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6895
6963
  */
6896
6964
  DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
6965
+ /**
6966
+ * The **Download Liveboard as XLSX** menu action on a Liveboard.
6967
+ * Allows downloading the entire Liveboard as an XLSX file.
6968
+ * @example
6969
+ * ```js
6970
+ * disabledActions: [Action.DownloadLiveboardAsXlsx]
6971
+ * ```
6972
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6973
+ */
6974
+ DownloadLiveboardAsXlsx = "downloadLiveboardAsXlsx",
6975
+ /**
6976
+ * The **Download Liveboard as CSV** menu action on a Liveboard.
6977
+ * Allows downloading the entire Liveboard as a CSV file.
6978
+ * @example
6979
+ * ```js
6980
+ * disabledActions: [Action.DownloadLiveboardAsCsv]
6981
+ * ```
6982
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6983
+ */
6984
+ DownloadLiveboardAsCsv = "downloadLiveboardAsCsv",
6897
6985
  /**
6898
6986
  * @hidden
6899
6987
  */
@@ -8153,7 +8241,19 @@ export declare enum Action {
8153
8241
  * ```
8154
8242
  * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
8155
8243
  */
8156
- IncludeCurrentPeriod = "includeCurrentPeriod"
8244
+ IncludeCurrentPeriod = "includeCurrentPeriod",
8245
+ /**
8246
+ * The **Send Test Email** button in the Liveboard schedule modal.
8247
+ * Allows sending a test schedule email to self or all recipients.
8248
+ * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
8249
+ * @example
8250
+ * ```js
8251
+ * disabledActions: [Action.SendTestScheduleEmail]
8252
+ * hiddenActions: [Action.SendTestScheduleEmail]
8253
+ * ```
8254
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8255
+ */
8256
+ SendTestScheduleEmail = "sendTestScheduleEmail"
8157
8257
  }
8158
8258
  export declare enum PrefetchFeatures {
8159
8259
  FullApp = "FullApp",
@@ -8907,7 +9007,10 @@ export type UIPassthroughContractBase = {
8907
9007
  [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
8908
9008
  request: Record<string, never>;
8909
9009
  response: {
8910
- v2Content: string;
9010
+ data: {
9011
+ v2Content: string;
9012
+ };
9013
+ type: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
8911
9014
  };
8912
9015
  };
8913
9016
  [UIPassthroughEvent.UpdateFilters]: {
@@ -9410,6 +9513,18 @@ declare class TsEmbed {
9410
9513
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
9411
9514
  */
9412
9515
  getCurrentContext(): Promise<ContextObject>;
9516
+ /**
9517
+ * Generates the event name for a "Subscribed" embed event.
9518
+ *
9519
+ * This helper appends the "Subscribed" suffix to a given host or action event,
9520
+ * allowing you to listen for subscription lifecycle events in a consistent format.
9521
+ *
9522
+ * @param eventName - The host or action event to generate the subscribed event name for.
9523
+ * @returns The formatted event name (e.g., "Save Subscribed").
9524
+ *
9525
+ * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
9526
+ */
9527
+ subscribedEvent(eventName: HostEvent | Action): string;
9413
9528
  /**
9414
9529
  * Creates the preRender shell
9415
9530
  * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -10229,6 +10344,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
10229
10344
  * ```
10230
10345
  */
10231
10346
  updatedSpotterChatPrompt?: boolean;
10347
+ /**
10348
+ * Enables the stop answer generation button in the Spotter embed UI,
10349
+ * allowing users to interrupt an ongoing answer generation.
10350
+ *
10351
+ * Supported embed types: `SpotterEmbed`
10352
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
10353
+ * @default false
10354
+ */
10355
+ enableStopAnswerGenerationEmbed?: boolean;
10232
10356
  /**
10233
10357
  * Controls the visibility of the past conversations sidebar.
10234
10358
  *
@@ -10811,6 +10935,21 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10811
10935
  * @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
10812
10936
  */
10813
10937
  homePageSearchBarMode?: HomePageSearchBarMode;
10938
+ /**
10939
+ * This flag is used to enable unified search experience for full app embed.
10940
+ *
10941
+ * Supported embed types: `AppEmbed`
10942
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
10943
+ * @default true
10944
+ * @example
10945
+ * ```js
10946
+ * const embed = new AppEmbed('#tsEmbed', {
10947
+ * ... // other embed view config
10948
+ * isUnifiedSearchExperienceEnabled: true,
10949
+ * })
10950
+ * ```
10951
+ */
10952
+ isUnifiedSearchExperienceEnabled?: boolean;
10814
10953
  /**
10815
10954
  * This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
10816
10955
  * @deprecated This flag is deprecated.
@@ -10997,6 +11136,15 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10997
11136
  * ```
10998
11137
  */
10999
11138
  spotterChatConfig?: SpotterChatViewConfig;
11139
+ /**
11140
+ * Enables the stop answer generation button in the Spotter embed UI,
11141
+ * allowing users to interrupt an ongoing answer generation.
11142
+ *
11143
+ * Supported embed types: `AppEmbed`
11144
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11145
+ * @default false
11146
+ */
11147
+ enableStopAnswerGenerationEmbed?: boolean;
11000
11148
  /**
11001
11149
  * This is the minimum height (in pixels) for a full-height App.
11002
11150
  * Setting this height helps resolve issues with empty Apps and
@@ -11030,6 +11178,19 @@ export interface AppViewConfig extends AllEmbedViewConfig {
11030
11178
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11031
11179
  */
11032
11180
  enableHomepageAnnouncement?: boolean;
11181
+ /**
11182
+ * If set to true, enables visualization data caching on the Liveboard.
11183
+ * @type {boolean}
11184
+ * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
11185
+ * @example
11186
+ * ```js
11187
+ * const embed = new AppEmbed('#tsEmbed', {
11188
+ * ... // other options
11189
+ * enableLiveboardDataCache: true,
11190
+ * })
11191
+ * ```
11192
+ */
11193
+ enableLiveboardDataCache?: boolean;
11033
11194
  }
11034
11195
  /**
11035
11196
  * APP_INIT data shape for AppEmbed.
@@ -11594,6 +11755,15 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
11594
11755
  * ```
11595
11756
  */
11596
11757
  updatedSpotterChatPrompt?: boolean;
11758
+ /**
11759
+ * Enables the stop answer generation button in the Spotter embed UI,
11760
+ * allowing users to interrupt an ongoing answer generation.
11761
+ *
11762
+ * Supported embed types: `LiveboardEmbed`
11763
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
11764
+ * @default false
11765
+ */
11766
+ enableStopAnswerGenerationEmbed?: boolean;
11597
11767
  /**
11598
11768
  * Configuration for customizing Spotter chat UI
11599
11769
  * branding in tool response cards.
@@ -11612,6 +11782,19 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
11612
11782
  * ```
11613
11783
  */
11614
11784
  spotterChatConfig?: SpotterChatViewConfig;
11785
+ /**
11786
+ * If set to true, enables visualization data caching on the Liveboard.
11787
+ * @type {boolean}
11788
+ * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
11789
+ * @example
11790
+ * ```js
11791
+ * const embed = new LiveboardEmbed('#embed-container', {
11792
+ * ... // other options
11793
+ * enableLiveboardDataCache: true,
11794
+ * })
11795
+ * ```
11796
+ */
11797
+ enableLiveboardDataCache?: boolean;
11615
11798
  }
11616
11799
  declare class LiveboardEmbed extends V1Embed {
11617
11800
  protected viewConfig: LiveboardViewConfig;