@thoughtspot/visual-embed-sdk 1.53.0 → 1.53.1

package/dist/visual-embed-sdk-react-full.d.ts

@@ -7198,6 +7198,17 @@ export declare enum HostEvent {
 	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
 	 */
 	EditVisualization = "editVisualization",
+	/**
+	 * Exits Liveboard edit mode , equivalent to clicking the
+	 * *Cancel* button in the Liveboard edit header. The Liveboard returns to
+	 * view mode and the embedded app emits the {@link EmbedEvent.Cancel} event.
+	 * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.ExitEditMode);
+	 * ```
+	 */
+	ExitEditMode = "exitEditMode",
 	/**
 	 * Trigger the **Copy link** action on a Liveboard or visualization
 	 * Payload: {@link VizScopedRequest}.
@@ -8731,7 +8742,40 @@ export declare enum HostEvent {
 	 * ```
 	 * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
 	 */
-	RefreshLiveboardBrowserCache = "refreshLiveboardBrowserCache"
+	RefreshLiveboardBrowserCache = "refreshLiveboardBrowserCache",
+	/**
+	 * Switch the embed between dark appearance and its default appearance
+	 * while it is open, without reloading it.
+	 * Payload: {@link UpdateThemeRequest}.
+	 *
+	 * Use it to keep the embed in step with a theme switch in your
+	 * application; the appearance the embed loads with is set by `isDarkMode`.
+	 * The event resolves with the applied value, such as `{ isDarkMode: true }`.
+	 * When dark appearance is not available in the embed, the embed does not
+	 * change and the event rejects with an error message instead.
+	 * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+	 * @param - `isDarkMode` - `true` for dark appearance, `false` for the
+	 * default appearance.
+	 * @example
+	 * ```js
+	 * appEmbed.trigger(HostEvent.UpdateTheme, { isDarkMode: true });
+	 * ```
+	 * @example
+	 * ```js
+	 * // Follow a theme switch in your application
+	 * const themeSwitch = document.querySelector('#theme-switch');
+	 * themeSwitch.addEventListener('change', async (event) => {
+	 *   try {
+	 *     await appEmbed.trigger(HostEvent.UpdateTheme, {
+	 *       isDarkMode: event.target.checked,
+	 *     });
+	 *   } catch (error) {
+	 *     console.warn(error);
+	 *   }
+	 * });
+	 * ```
+	 */
+	UpdateTheme = "UpdateTheme"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -11019,7 +11063,30 @@ export declare enum Action {
 	 * }
 	 * ```
 	 */
-	CustomizeHomepage = "customizeHomepage"
+	CustomizeHomepage = "customizeHomepage",
+	/**
+	 * Controls the visibility and disabled state of the *Cancel* button in the
+	 * Liveboard edit header, the button that discards the changes made in edit
+	 * mode and returns the Liveboard to view mode. The button is shown only
+	 * while the Liveboard is in edit mode.
+	 * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+	 * @example
+	 * ```js
+	 * const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
+	 *     ... // other embed view config
+	 *     hiddenActions: [Action.Cancel],
+	 * });
+	 * ```
+	 * @example
+	 * ```js
+	 * const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
+	 *     ... // other embed view config
+	 *     disabledActions: [Action.Cancel],
+	 *     disabledActionReason: 'Save your changes to leave edit mode',
+	 * });
+	 * ```
+	 */
+	Cancel = "cancel"
 }
 export declare enum PrefetchFeatures {
 	FullApp = "FullApp",
@@ -12542,6 +12609,15 @@ export interface SetActiveTabRequest {
 	 */
 	tabId: string;
 }
+/**
+ * Request payload for {@link HostEvent.UpdateTheme}.
+ */
+export interface UpdateThemeRequest {
+	/**
+	 * `true` for dark appearance, `false` for the default appearance.
+	 */
+	isDarkMode: boolean;
+}
 /**
  * Typed request payloads for host events that do not go through the UI
  * passthrough pipeline (`HostEvent` member → request type; `void` = no payload).
@@ -12632,6 +12708,7 @@ export interface HostEventRequestMap {
 	[HostEvent.InitSpotterVizConversation]: void;
 	[HostEvent.OpenSpotterVizPanel]: void;
 	[HostEvent.CloseSpotterVizPanel]: void;
+	[HostEvent.UpdateTheme]: UpdateThemeRequest;
 }
 /**
  * Per-context request shapes for events whose payload varies by
@@ -12824,7 +12901,7 @@ declare class TsEmbed {
 	private defaultHiddenActions;
 	private resizeObserver;
 	private preRenderContainerEl;
-	private containerScrollListener;
+	/** Last height the embedded app reported, once fullHeight has measured one. */
 	protected hostEventClient: HostEventClient;
 	protected isReadyForRenderPromise: Promise<void>;
 	protected shouldWaitForRenderPromise: boolean;
@@ -13004,12 +13081,6 @@ declare class TsEmbed {
 		isThisPeriodInDateFiltersEnabled?: boolean;
 		hideLiveboardHeader?: boolean;
 		showLiveboardTitle?: boolean;
-		/**
-		 * Get the Post Url Params for THOUGHTSPOT from the current
-		 * host app URL.
-		 * THOUGHTSPOT URL params starts with a prefix "ts-"
-		 * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
-		 */
 		showLiveboardDescription?: boolean;
 		isLiveboardHeaderSticky?: boolean;
 		enable2ColumnLayout?: boolean;
@@ -13089,10 +13160,12 @@ declare class TsEmbed {
 	 */
 	private createPreRenderPlaceholder;
 	/**
-	 * Resolves the configured preRenderContainer to a live element, falling
-	 * back to `document.body`. A string selector is re-queried on every call so
-	 * a remounted container (E.g.: React replacing the node) resolves to the
-	 * fresh element; an element passed directly cannot be re-resolved.
+	 * Resolves the configured preRenderContainer, or defaults to the host's
+	 * nearest scrolling ancestor (document.body if none). The absolutely
+	 * positioned wrapper only follows the page while it sits inside what
+	 * scrolls, so body is right only when the document itself scrolls — an inner
+	 * scroller left the frame pinned to the viewport (SCAL-338563). A string
+	 * selector is re-queried each call so a remounted container resolves fresh.
 	 */
 	private resolvePreRenderContainerTarget;
 	private inheritPreRenderContainer;
@@ -13109,8 +13182,9 @@ declare class TsEmbed {
 	 * Re-attaches the wrapper to a live container when the previously resolved
 	 * one has been detached or no longer holds the wrapper — e.g. the host app
 	 * remounted a custom preRenderContainer, which would otherwise leave a stale
-	 * reference and collapse the wrapper. Only string selectors can be
-	 * re-resolved; a container passed as an element is left untouched.
+	 * reference and collapse the wrapper. Selectors and the auto-resolved
+	 * scrolling ancestor are both re-resolved; a container passed as an element
+	 * is left untouched, as there is nothing to re-query.
 	 */
 	private reconcilePreRenderContainer;
 	protected insertIntoDOMForPreRender(child: string | Node): void;
@@ -13326,9 +13400,17 @@ declare class TsEmbed {
 	 */
 	private restorePreRenderContainerPosition;
 	/**
-	 * Detaches and clears the container scroll listener, if one is attached.
+	 * Re-sizes the wrapper when its placeholder changes size.
+	 *
+	 * Position deliberately has no equivalent. An absolutely positioned wrapper
+	 * follows its containing block for free, so a correctly placed frame is the
+	 * browser's job and costs nothing; repositioning it on scroll would mean a
+	 * layout read and a style write per frame to compensate for placing it in
+	 * the wrong box. Size is the one thing the browser will not do for us: the
+	 * placeholder grows when the embedded app reports a new height, and the
+	 * wrapper has to be told.
 	 */
-	private removeContainerScrollListener;
+	private observePreRenderSize;
 	/**
 	 * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
 	 * @version SDK: 1.19.1 | ThoughtSpot: *
@@ -14046,6 +14128,19 @@ export interface SpotterSidebarViewConfig {
 	 * @default Analysts
 	 */
 	spotterAnalystsLabel?: string;
+	/**
+	 * Shows the connector marketplace option in the settings menu of the
+	 * Spotter sidebar footer. When not set, the cluster setting applies.
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 */
+	enableConnectorMarketplace?: boolean;
+	/**
+	 * Shows the Spotter instructions and more settings options in the
+	 * settings menu of the Spotter sidebar footer.
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 * @default false
+	 */
+	enableSpotterInstructionAndMoreSettings?: boolean;
 }
 /**
  * Configuration for the Spotter conversation sharing feature.
@@ -14706,6 +14801,7 @@ export interface SpotterAppInitData extends DefaultAppInitData {
 		visualOverridesParams?: VisualizationOverrides | null;
 		starterPrompts?: StarterPromptsConfig;
 		spotterAnalystConfig?: SpotterAnalystConfig;
+		enableSpotterInstructionAndMoreSettings?: boolean;
 	};
 }
 declare class SpotterEmbed extends TsEmbed {
@@ -15771,6 +15867,7 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
 		spotterVizConfig?: SpotterVizConfig;
 		spotterShareConversationConfig?: SpotterShareConversationConfig;
 		starterPrompts?: StarterPromptsConfig;
+		enableSpotterInstructionAndMoreSettings?: boolean;
 	};
 }
 declare class AppEmbed extends V1Embed {
@@ -16455,7 +16552,8 @@ declare class LiveboardEmbed extends V1Embed {
 		personalizedViewId: string;
 	};
 	protected beforePrerenderVisible(): void;
-	private isShowingLiveboardRoute;
+	private isSameEmbedConfig;
+	private isAlreadyOnSameRoute;
 	protected handleRenderForPrerender(): Promise<TsEmbed>;
 	/**
 	 * Triggers an event to the embedded app

package/dist/visual-embed-sdk-react.d.ts

@@ -7212,6 +7212,17 @@ export declare enum HostEvent {
 	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
 	 */
 	EditVisualization = "editVisualization",
+	/**
+	 * Exits Liveboard edit mode , equivalent to clicking the
+	 * *Cancel* button in the Liveboard edit header. The Liveboard returns to
+	 * view mode and the embedded app emits the {@link EmbedEvent.Cancel} event.
+	 * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.ExitEditMode);
+	 * ```
+	 */
+	ExitEditMode = "exitEditMode",
 	/**
 	 * Trigger the **Copy link** action on a Liveboard or visualization
 	 * Payload: {@link VizScopedRequest}.
@@ -8745,7 +8756,40 @@ export declare enum HostEvent {
 	 * ```
 	 * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
 	 */
-	RefreshLiveboardBrowserCache = "refreshLiveboardBrowserCache"
+	RefreshLiveboardBrowserCache = "refreshLiveboardBrowserCache",
+	/**
+	 * Switch the embed between dark appearance and its default appearance
+	 * while it is open, without reloading it.
+	 * Payload: {@link UpdateThemeRequest}.
+	 *
+	 * Use it to keep the embed in step with a theme switch in your
+	 * application; the appearance the embed loads with is set by `isDarkMode`.
+	 * The event resolves with the applied value, such as `{ isDarkMode: true }`.
+	 * When dark appearance is not available in the embed, the embed does not
+	 * change and the event rejects with an error message instead.
+	 * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+	 * @param - `isDarkMode` - `true` for dark appearance, `false` for the
+	 * default appearance.
+	 * @example
+	 * ```js
+	 * appEmbed.trigger(HostEvent.UpdateTheme, { isDarkMode: true });
+	 * ```
+	 * @example
+	 * ```js
+	 * // Follow a theme switch in your application
+	 * const themeSwitch = document.querySelector('#theme-switch');
+	 * themeSwitch.addEventListener('change', async (event) => {
+	 *   try {
+	 *     await appEmbed.trigger(HostEvent.UpdateTheme, {
+	 *       isDarkMode: event.target.checked,
+	 *     });
+	 *   } catch (error) {
+	 *     console.warn(error);
+	 *   }
+	 * });
+	 * ```
+	 */
+	UpdateTheme = "UpdateTheme"
 }
 /**
  * Configuration for allowed file types in Spotter file upload.
@@ -11015,7 +11059,30 @@ export declare enum Action {
 	 * }
 	 * ```
 	 */
-	CustomizeHomepage = "customizeHomepage"
+	CustomizeHomepage = "customizeHomepage",
+	/**
+	 * Controls the visibility and disabled state of the *Cancel* button in the
+	 * Liveboard edit header, the button that discards the changes made in edit
+	 * mode and returns the Liveboard to view mode. The button is shown only
+	 * while the Liveboard is in edit mode.
+	 * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+	 * @example
+	 * ```js
+	 * const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
+	 *     ... // other embed view config
+	 *     hiddenActions: [Action.Cancel],
+	 * });
+	 * ```
+	 * @example
+	 * ```js
+	 * const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
+	 *     ... // other embed view config
+	 *     disabledActions: [Action.Cancel],
+	 *     disabledActionReason: 'Save your changes to leave edit mode',
+	 * });
+	 * ```
+	 */
+	Cancel = "cancel"
 }
 declare enum ContextMenuTriggerOptions {
 	LEFT_CLICK = "left-click",
@@ -12443,6 +12510,15 @@ export interface SetActiveTabRequest {
 	 */
 	tabId: string;
 }
+/**
+ * Request payload for {@link HostEvent.UpdateTheme}.
+ */
+export interface UpdateThemeRequest {
+	/**
+	 * `true` for dark appearance, `false` for the default appearance.
+	 */
+	isDarkMode: boolean;
+}
 /**
  * Typed request payloads for host events that do not go through the UI
  * passthrough pipeline (`HostEvent` member → request type; `void` = no payload).
@@ -12533,6 +12609,7 @@ export interface HostEventRequestMap {
 	[HostEvent.InitSpotterVizConversation]: void;
 	[HostEvent.OpenSpotterVizPanel]: void;
 	[HostEvent.CloseSpotterVizPanel]: void;
+	[HostEvent.UpdateTheme]: UpdateThemeRequest;
 }
 /**
  * Per-context request shapes for events whose payload varies by
@@ -12725,7 +12802,7 @@ declare class TsEmbed {
 	private defaultHiddenActions;
 	private resizeObserver;
 	private preRenderContainerEl;
-	private containerScrollListener;
+	/** Last height the embedded app reported, once fullHeight has measured one. */
 	protected hostEventClient: HostEventClient;
 	protected isReadyForRenderPromise: Promise<void>;
 	protected shouldWaitForRenderPromise: boolean;
@@ -12905,12 +12982,6 @@ declare class TsEmbed {
 		isThisPeriodInDateFiltersEnabled?: boolean;
 		hideLiveboardHeader?: boolean;
 		showLiveboardTitle?: boolean;
-		/**
-		 * Get the Post Url Params for THOUGHTSPOT from the current
-		 * host app URL.
-		 * THOUGHTSPOT URL params starts with a prefix "ts-"
-		 * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
-		 */
 		showLiveboardDescription?: boolean;
 		isLiveboardHeaderSticky?: boolean;
 		enable2ColumnLayout?: boolean;
@@ -12990,10 +13061,12 @@ declare class TsEmbed {
 	 */
 	private createPreRenderPlaceholder;
 	/**
-	 * Resolves the configured preRenderContainer to a live element, falling
-	 * back to `document.body`. A string selector is re-queried on every call so
-	 * a remounted container (E.g.: React replacing the node) resolves to the
-	 * fresh element; an element passed directly cannot be re-resolved.
+	 * Resolves the configured preRenderContainer, or defaults to the host's
+	 * nearest scrolling ancestor (document.body if none). The absolutely
+	 * positioned wrapper only follows the page while it sits inside what
+	 * scrolls, so body is right only when the document itself scrolls — an inner
+	 * scroller left the frame pinned to the viewport (SCAL-338563). A string
+	 * selector is re-queried each call so a remounted container resolves fresh.
 	 */
 	private resolvePreRenderContainerTarget;
 	private inheritPreRenderContainer;
@@ -13010,8 +13083,9 @@ declare class TsEmbed {
 	 * Re-attaches the wrapper to a live container when the previously resolved
 	 * one has been detached or no longer holds the wrapper — e.g. the host app
 	 * remounted a custom preRenderContainer, which would otherwise leave a stale
-	 * reference and collapse the wrapper. Only string selectors can be
-	 * re-resolved; a container passed as an element is left untouched.
+	 * reference and collapse the wrapper. Selectors and the auto-resolved
+	 * scrolling ancestor are both re-resolved; a container passed as an element
+	 * is left untouched, as there is nothing to re-query.
 	 */
 	private reconcilePreRenderContainer;
 	protected insertIntoDOMForPreRender(child: string | Node): void;
@@ -13227,9 +13301,17 @@ declare class TsEmbed {
 	 */
 	private restorePreRenderContainerPosition;
 	/**
-	 * Detaches and clears the container scroll listener, if one is attached.
+	 * Re-sizes the wrapper when its placeholder changes size.
+	 *
+	 * Position deliberately has no equivalent. An absolutely positioned wrapper
+	 * follows its containing block for free, so a correctly placed frame is the
+	 * browser's job and costs nothing; repositioning it on scroll would mean a
+	 * layout read and a style write per frame to compensate for placing it in
+	 * the wrong box. Size is the one thing the browser will not do for us: the
+	 * placeholder grows when the embedded app reports a new height, and the
+	 * wrapper has to be told.
 	 */
-	private removeContainerScrollListener;
+	private observePreRenderSize;
 	/**
 	 * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
 	 * @version SDK: 1.19.1 | ThoughtSpot: *
@@ -13942,6 +14024,19 @@ export interface SpotterSidebarViewConfig {
 	 * @default Analysts
 	 */
 	spotterAnalystsLabel?: string;
+	/**
+	 * Shows the connector marketplace option in the settings menu of the
+	 * Spotter sidebar footer. When not set, the cluster setting applies.
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 */
+	enableConnectorMarketplace?: boolean;
+	/**
+	 * Shows the Spotter instructions and more settings options in the
+	 * settings menu of the Spotter sidebar footer.
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 * @default false
+	 */
+	enableSpotterInstructionAndMoreSettings?: boolean;
 }
 /**
  * Configuration for the Spotter conversation sharing feature.
@@ -14602,6 +14697,7 @@ export interface SpotterAppInitData extends DefaultAppInitData {
 		visualOverridesParams?: VisualizationOverrides | null;
 		starterPrompts?: StarterPromptsConfig;
 		spotterAnalystConfig?: SpotterAnalystConfig;
+		enableSpotterInstructionAndMoreSettings?: boolean;
 	};
 }
 declare class SpotterEmbed extends TsEmbed {
@@ -15663,6 +15759,7 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
 		spotterVizConfig?: SpotterVizConfig;
 		spotterShareConversationConfig?: SpotterShareConversationConfig;
 		starterPrompts?: StarterPromptsConfig;
+		enableSpotterInstructionAndMoreSettings?: boolean;
 	};
 }
 declare class AppEmbed extends V1Embed {
@@ -16347,7 +16444,8 @@ declare class LiveboardEmbed extends V1Embed {
 		personalizedViewId: string;
 	};
 	protected beforePrerenderVisible(): void;
-	private isShowingLiveboardRoute;
+	private isSameEmbedConfig;
+	private isAlreadyOnSameRoute;
 	protected handleRenderForPrerender(): Promise<TsEmbed>;
 	/**
 	 * Triggers an event to the embedded app