@thoughtspot/visual-embed-sdk 1.46.5-beta.1 → 1.46.5

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

@@ -785,6 +785,42 @@ export interface CustomCssVariables {
 	 * Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar.
 	 */
 	"--ts-var-saved-chats-section-title-color"?: string;
+	/**
+	 * Text color of the styling panel in the Liveboard.
+	 */
+	"--ts-var-liveboard-styling-panel-text-color"?: string;
+	/**
+	 * Border color of the styling panel in the Liveboard.
+	 */
+	"--ts-var-liveboard-styling-panel-border-color"?: string;
+	/**
+	 * Background color of the styling button in the Liveboard.
+	 */
+	"--ts-var-liveboard-styling-button-background"?: string;
+	/**
+	 * Text color of the styling button in the Liveboard.
+	 */
+	"--ts-var-liveboard-styling-button-text-color"?: string;
+	/**
+	 * Background color of the styling button in the Liveboard on hover.
+	 */
+	"--ts-var-liveboard-styling-button-hover-background"?: string;
+	/**
+	 * Background color of the styling button in the Liveboard when active.
+	 */
+	"--ts-var-liveboard-styling-button-active-background"?: string;
+	/**
+	 * Text color of the styling button in the Liveboard on hover.
+	 */
+	"--ts-var-liveboard-styling-button-hover-text-color"?: string;
+	/**
+	 * Box shadow of the styling button in the Liveboard.
+	 */
+	"--ts-var-liveboard-styling-button-shadow"?: string;
+	/**
+	 * Background color of the color palette in the Liveboard styling panel.
+	 */
+	"--ts-var-liveboard-styling-color-palette-background"?: string;
 }
 export interface SessionInterface {
 	sessionId: string;
@@ -3573,6 +3609,17 @@ export declare enum EmbedEvent {
 	 * ```
 	 */
 	DownloadAsXlsx = "downloadAsXlsx",
+	/**
+	 * Emitted when the Download Liveboard as Continuous PDF action is triggered
+	 * on a Liveboard.
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+	 * @example
+	 * ```js
+	 * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
+	 *   console.log('download liveboard as continuous PDF', payload)})
+	 * ```
+	 */
+	DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
 	/**
 	 * Emitted when an Answer is deleted in the app
 	 *  Use start:true to subscribe to when delete is initiated, or end:true to subscribe
@@ -5100,6 +5147,18 @@ export declare enum HostEvent {
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
 	 */
 	DownloadAsPdf = "downloadAsPdf",
+	/**
+	 * Trigger the **Download Liveboard as Continuous PDF** action on an
+	 * embedded Liveboard.
+	 *
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
+	 * ```
+	 *
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+	 */
+	DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
 	/**
 	 * Trigger the **AI Highlights** action on an embedded Liveboard
 	 *
@@ -5326,6 +5385,20 @@ export declare enum HostEvent {
 	 *     vizId: '730496d6-6903-4601-937e-2c691821af3c'
 	 * }, ContextType.Liveboard);
 	 * ```
+	 * @example
+	 * ```js
+	 * // Copy link from liveboard context
+	 * import { ContextType } from '@thoughtspot/visual-embed-sdk';
+	 * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
+	 * ```
+	 * @example
+	 * ```js
+	 * // Copy link from liveboard visualization context
+	 * import { ContextType } from '@thoughtspot/visual-embed-sdk';
+	 * liveboardEmbed.trigger(HostEvent.CopyLink, {
+	 *     vizId: '730496d6-6903-4601-937e-2c691821af3c'
+	 * }, ContextType.Liveboard);
+	 * ```
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
 	 */
 	CopyLink = "embedDocument",
@@ -5357,6 +5430,20 @@ export declare enum HostEvent {
 	 * import { ContextType } from '@thoughtspot/visual-embed-sdk';
 	 * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
 	 * ```
+	 * @example
+	 * ```js
+	 * // Present from liveboard visualization context
+	 * import { ContextType } from '@thoughtspot/visual-embed-sdk';
+	 * liveboardEmbed.trigger(HostEvent.Present, {
+	 *     vizId: '730496d6-6903-4601-937e-2c691821af3c'
+	 * }, ContextType.Liveboard);
+	 * ```
+	 * @example
+	 * ```js
+	 * // Present from liveboard context
+	 * import { ContextType } from '@thoughtspot/visual-embed-sdk';
+	 * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
+	 * ```
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
 	 */
 	Present = "present",
@@ -6824,6 +6911,16 @@ export declare enum Action {
 	 * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
 	 */
 	DownloadLiveboard = "downloadLiveboard",
+	/**
+	 * The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
+	 * Allows downloading the entire Liveboard as a continuous PDF.
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+	 */
+	DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
 	/**
 	 * @hidden
 	 */
@@ -8039,6 +8136,39 @@ export declare enum Action {
 	 * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
 	 */
 	SpotterDocs = "spotterDocs",
+	/**
+	 * Controls visibility and disable state of the connector resources
+	 * section in the Spotter chat interface.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.SpotterChatConnectorResources]
+	 * disabledActions: [Action.SpotterChatConnectorResources]
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+	 */
+	SpotterChatConnectorResources = "spotterChatConnectorResources",
+	/**
+	 * Controls visibility and disable state of the connectors
+	 * in the Spotter chat interface.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.SpotterChatConnectors]
+	 * disabledActions: [Action.SpotterChatConnectors]
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+	 */
+	SpotterChatConnectors = "spotterChatConnectors",
+	/**
+	 * Controls visibility and disable state of the mode switcher
+	 * in the Spotter chat interface.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.SpotterChatModeSwitcher]
+	 * disabledActions: [Action.SpotterChatModeSwitcher]
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+	 */
+	SpotterChatModeSwitcher = "spotterChatModeSwitcher",
 	/**
 	 * The **Include current period** checkbox for date filters.
 	 * Controls the visibility and availability of the option to include
@@ -8283,7 +8413,13 @@ declare enum EmbedErrorCodes {
 	/** Failed to update embed parameters during pre-render */
 	UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
 	/** Invalid URL provided in configuration */
-	INVALID_URL = "INVALID_URL"
+	INVALID_URL = "INVALID_URL",
+	/** Host event payload validation failed */
+	HOST_EVENT_VALIDATION = "HOST_EVENT_VALIDATION",
+	/** UpdateFilters payload is invalid - missing or malformed filter/filters */
+	UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
+	/** DrillDown payload is invalid - missing or malformed points */
+	DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
 }
 /**
  * Error event object emitted when an error occurs in an embedded component.
@@ -8656,6 +8792,8 @@ declare enum UIPassthroughEvent {
 	GetAnswerConfig = "getAnswerPageConfig",
 	GetLiveboardConfig = "getPinboardPageConfig",
 	GetUnsavedAnswerTML = "getUnsavedAnswerTML",
+	UpdateFilters = "updateFilters",
+	Drilldown = "drillDown",
 	GetAnswerSession = "getAnswerSession",
 	GetFilters = "getFilters",
 	GetIframeUrl = "getIframeUrl",
@@ -8777,6 +8915,35 @@ export type UIPassthroughContractBase = {
 			v2Content: string;
 		};
 	};
+	[UIPassthroughEvent.UpdateFilters]: {
+		request: {
+			filter?: {
+				column: string;
+				oper: string;
+				values: string[];
+				type?: string;
+			};
+			filters?: {
+				column: string;
+				oper: string;
+				values: string[];
+				type?: string;
+			}[];
+		};
+		response: unknown;
+	};
+	[UIPassthroughEvent.Drilldown]: {
+		request: {
+			points: {
+				selectedPoints?: string[];
+				clickedPoint?: string;
+			};
+			columnGuid?: string;
+			autoDrillDown?: boolean;
+			vizId?: string;
+		};
+		response: unknown;
+	};
 };
 export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
 export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
@@ -8802,6 +8969,8 @@ export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT |
 export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
 declare class HostEventClient {
 	iFrame: HTMLIFrameElement;
+	/** Cached list of available UI passthrough keys from the embedded app */
+	private availablePassthroughKeysCache;
 	/** Host events with custom handlers
 	 * (setters or special logic) -
 	 * bound to instance for protected method access */
@@ -8827,9 +8996,25 @@ declare class HostEventClient {
 	 * @param {HTMLIFrameElement} iFrame - the iframe element to set
 	 */
 	setIframeElement(iFrame: HTMLIFrameElement): void;
+	/**
+	 * Fetches the list of available UI passthrough keys from the embedded app.
+	 * Result is cached for the session. Returns empty array on failure.
+	 */
+	private getAvailableUIPassthroughKeys;
 	triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
 	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
 	protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
+	protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
+	protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
+	/**
+	 * Dispatches a host event using the appropriate channel:
+	 * 1. If the embedded app supports UI passthrough for this event, use it (custom handler or getter).
+	 * 2. Otherwise fall back to the legacy host event channel.
+	 *
+	 * @param hostEvent - The host event to trigger
+	 * @param payload - Optional payload for the event
+	 * @param context - Optional context (e.g. vizId) for scoped operations
+	 */
 	triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
 }
 declare class TsEmbed {
@@ -10251,9 +10436,31 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
  */
 export interface ConversationViewConfig extends SpotterEmbedViewConfig {
 }
+/**
+ * APP_INIT data shape for SpotterEmbed.
+ * @internal
+ */
+export interface SpotterAppInitData extends DefaultAppInitData {
+	embedParams?: {
+		spotterSidebarConfig?: SpotterSidebarViewConfig;
+	};
+}
 declare class SpotterEmbed extends TsEmbed {
 	protected viewConfig: SpotterEmbedViewConfig;
 	constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
+	/**
+	 * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
+	 * so the conv-assist app can read sidebar configuration on initialisation.
+	 *
+	 * Precedence for `enablePastConversationsSidebar`:
+	 * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
+	 * deprecated top-level `enablePastConversationsSidebar` flag; if the former
+	 * is absent the latter is used as a fallback.
+	 *
+	 * An invalid `spotterDocumentationUrl` triggers a validation error and is
+	 * excluded from the payload rather than forwarded to the app.
+	 */
+	protected getAppInitData(): Promise<SpotterAppInitData>;
 	protected getEmbedParamsObject(): Record<any, any>;
 	getIframeSrc(): string;
 	render(): Promise<SpotterEmbed>;
@@ -10798,6 +11005,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * ```
 	 */
 	isPNGInScheduledEmailsEnabled?: boolean;
+	/**
+	 * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
+	 * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
+	 * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+	 * @type {boolean}
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    isContinuousLiveboardPDFEnabled: true,
+	 * })
+	 * ```
+	 */
+	isContinuousLiveboardPDFEnabled?: boolean;
 	/**
 	 * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
 	 *
@@ -10966,10 +11191,32 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	enableHomepageAnnouncement?: boolean;
 }
+/**
+ * APP_INIT data shape for AppEmbed.
+ * @internal
+ */
+export interface AppEmbedAppInitData extends DefaultAppInitData {
+	embedParams?: {
+		spotterSidebarConfig?: SpotterSidebarViewConfig;
+	};
+}
 declare class AppEmbed extends V1Embed {
 	protected viewConfig: AppViewConfig;
 	private defaultHeight;
 	constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
+	/**
+	 * Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
+	 * so the conv-assist app can read sidebar configuration on initialisation.
+	 *
+	 * Precedence for `enablePastConversationsSidebar`:
+	 * `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
+	 * deprecated top-level `enablePastConversationsSidebar` flag; if the former
+	 * is absent the latter is used as a fallback.
+	 *
+	 * An invalid `spotterDocumentationUrl` triggers a validation error and is
+	 * excluded from the payload rather than forwarded to the app.
+	 */
+	protected getAppInitData(): Promise<AppEmbedAppInitData>;
 	/**
 	 * Constructs a map of parameters to be passed on to the
 	 * embedded Liveboard or visualization.
@@ -10988,7 +11235,6 @@ declare class AppEmbed extends V1Embed {
 	 * @param pageId The ID of the page to be embedded.
 	 */
 	getIFrameSrc(): string;
-	private HEIGHT_CHANAGE_THRESHOLD;
 	/**
 	 * Set the iframe height as per the computed height received
 	 * from the ThoughtSpot app.
@@ -11388,6 +11634,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
 	 * ```
 	 */
 	isPNGInScheduledEmailsEnabled?: boolean;
+	/**
+	 * Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
+	 * following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
+	 * This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+	 * @type {boolean}
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    isContinuousLiveboardPDFEnabled: true,
+	 * })
+	 * ```
+	 */
+	isContinuousLiveboardPDFEnabled?: boolean;
 	/**
 	 * This flag is used to enable/disable the XLSX/CSV download option for Liveboards
 	 *
@@ -11533,7 +11797,6 @@ declare class LiveboardEmbed extends V1Embed {
 	 * to be loaded within the iFrame.
 	 */
 	private getIFrameSrc;
-	private HEIGHT_CHANAGE_THRESHOLD;
 	/**
 	 * Set the iframe height as per the computed height received
 	 * from the ThoughtSpot app.