@thoughtspot/visual-embed-sdk 1.47.1 → 1.47.3

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

@@ -2906,6 +2906,22 @@ export interface LiveboardAppEmbedViewConfig {
 	 * ```
 	 */
 	isLiveboardMasterpiecesEnabled?: boolean;
+	/**
+	 * Enable or disable Muze chart phase 1 GA
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+	 * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
+	 * @default false
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    newChartsLibrary: true,
+	 * })
+	 * ```
+	 */
+	newChartsLibrary?: boolean;
 }
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
 }
@@ -4506,7 +4522,54 @@ export declare enum EmbedEvent {
 	 * ```
 	 * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
 	 */
-	RefreshAuthToken = "RefreshAuthToken"
+	RefreshAuthToken = "RefreshAuthToken",
+	/**
+	 * Triggered whenever the page context changes, returning the current context along with the navigation stack.
+	 * @example
+	 * ```js
+	 * embed.on(EmbedEvent.EmbedPageContextChanged, (payload) => {
+	 *     console.log('payload', payload);
+	 * })
+	 * ```
+	 * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
+	 */
+	EmbedPageContextChanged = "EmbedPageContextChanged",
+	/**
+	 * Represents a special embed event that is triggered whenever any host event is subscribed.
+	 *
+	 * You can listen to this event when you need to dispatch a host event during load or render,
+	 * particularly in situations where timing issues may occur.
+	 *
+	 * @example
+	 * ```js
+	 * embed.on(`${HostEvent.Save} Subscribed`, () => {
+	 *     // make action
+	 * });
+	 * ```
+	 *
+	 * @example
+	 * ```js
+	 * embed.on(subscribedEvent(HostEvent.Save), () => {
+	 *     // make action
+	 * });
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.4.0.cl
+	 */
+	Subscribed = "Subscribed",
+	/**
+	 * Emitted when a user clicks the **Send Test Email** button in the
+	 * Liveboard schedule modal. Requires `isSendNowLiveboardSchedulingEnabled`
+	 * to be enabled.
+	 * @example
+	 * ```js
+	 * liveboardEmbed.on(EmbedEvent.SendTestScheduleEmail, (payload) => {
+	 *     console.log('Send test email', payload);
+	 *     // payload: { liveboardId: string, sendToSelf: boolean }
+	 * })
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+	 */
+	SendTestScheduleEmail = "sendTestScheduleEmail"
 }
 /**
  * Event types that can be triggered by the host application
@@ -6204,7 +6267,8 @@ export declare enum HostEvent {
 	 * ```js
 	 * // Get parameters from liveboard context
 	 * import { ContextType } from '@thoughtspot/visual-embed-sdk';
-	 * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
+	 * liveboardEmbed.trigger(HostEvent.GetParameters, {},
+	 * ContextType.Liveboard).then((parameters) => {
 	 *     console.log('parameters', parameters);
 	 * });
 	 * ```
@@ -6555,7 +6619,27 @@ export declare enum HostEvent {
 	 * ```
 	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
 	 */
-	GetPageContext = "GetPageContext"
+	GetPageContext = "GetPageContext",
+	/**
+	 * Trigger the **Send Test Email** action in the Liveboard schedule modal.
+	 * Sends a test schedule email to self or all recipients.
+	 * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
+	 *     sendToSelf: true,
+	 * })
+	 * ```
+	 * @example
+	 * ```js
+	 * // Send to all recipients
+	 * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
+	 *     sendToSelf: false,
+	 * })
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+	 */
+	SendTestScheduleEmail = "sendTestScheduleEmail"
 }
 /**
  * ThoughtSpot application pages include actions and menu commands
@@ -6876,7 +6960,7 @@ export declare enum Action {
 	 * ```js
 	 * disabledActions: [Action.DownloadLiveboard]
 	 * ```
-	 * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
 	 */
 	DownloadLiveboard = "downloadLiveboard",
 	/**
@@ -6889,6 +6973,26 @@ export declare enum Action {
 	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
 	 */
 	DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
+	/**
+	 * The **Download Liveboard as XLSX** menu action on a Liveboard.
+	 * Allows downloading the entire Liveboard as an XLSX file.
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.DownloadLiveboardAsXlsx]
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+	 */
+	DownloadLiveboardAsXlsx = "downloadLiveboardAsXlsx",
+	/**
+	 * The **Download Liveboard as CSV** menu action on a Liveboard.
+	 * Allows downloading the entire Liveboard as a CSV file.
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.DownloadLiveboardAsCsv]
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+	 */
+	DownloadLiveboardAsCsv = "downloadLiveboardAsCsv",
 	/**
 	 * @hidden
 	 */
@@ -8148,7 +8252,19 @@ export declare enum Action {
 	 * ```
 	 * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
 	 */
-	IncludeCurrentPeriod = "includeCurrentPeriod"
+	IncludeCurrentPeriod = "includeCurrentPeriod",
+	/**
+	 * The **Send Test Email** button in the Liveboard schedule modal.
+	 * Allows sending a test schedule email to self or all recipients.
+	 * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.SendTestScheduleEmail]
+	 * hiddenActions: [Action.SendTestScheduleEmail]
+	 * ```
+	 * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+	 */
+	SendTestScheduleEmail = "sendTestScheduleEmail"
 }
 declare enum ContextMenuTriggerOptions {
 	LEFT_CLICK = "left-click",
@@ -8599,6 +8715,385 @@ export interface ContextObject {
 		objectIds: ObjectIds;
 	};
 }
+export interface FontProperties {
+	color?: string;
+	bold?: boolean;
+	italic?: boolean;
+	strikeThrough?: boolean;
+	underline?: boolean;
+}
+export interface SolidBackgroundAttrs {
+	color?: string;
+}
+export interface GradientBackgroundAttrs {
+	backgroundFormatMidpoint?: number;
+	colors?: string[];
+	backgroundFormatRange?: number[];
+	isAutoScaled?: boolean;
+}
+declare enum DataLabelFilterOperator {
+	/** Greater than */
+	GreaterThan = "GREATER_THAN",
+	/** Less than */
+	LessThan = "LESS_THAN",
+	/** Greater than or equal to */
+	GreaterThanOrEqualTo = "GREATER_THAN_OR_EQUAL_TO",
+	/** Less than or equal to */
+	LessThanOrEqualTo = "LESS_THAN_OR_EQUAL_TO",
+	/** Equal to */
+	EqualTo = "EQUAL_TO",
+	/** Not equal to */
+	NotEqualTo = "NOT_EQUAL_TO"
+}
+declare enum ConditionalFormattingOperator {
+	/** Is equal to */
+	Is = "IS",
+	/** Is not equal to */
+	IsNot = "IS_NOT",
+	/** Contains */
+	Contains = "CONTAINS",
+	/** Does not contain */
+	DoesNotContain = "DOES_NOT_CONTAIN",
+	/** Starts with */
+	StartsWith = "STARTS_WITH",
+	/** Ends with */
+	EndsWith = "ENDS_WITH",
+	/** Greater than */
+	GreaterThan = "GREATER_THAN",
+	/** Less than */
+	LessThan = "LESS_THAN",
+	/** Greater than or equal to */
+	GreaterThanEqualTo = "GREATER_THAN_EQUAL_TO",
+	/** Less than or equal to */
+	LessThanEqualTo = "LESS_THAN_EQUAL_TO",
+	/** Equal to */
+	EqualTo = "EQUAL_TO",
+	/** Not equal to */
+	NotEqualTo = "NOT_EQUAL_TO",
+	/** Is between */
+	IsBetween = "IS_BETWEEN",
+	/** Is null */
+	IsNull = "IS_NULL",
+	/** Is not null */
+	IsNotNull = "IS_NOT_NULL"
+}
+declare enum BackgroundFormatType {
+	/** Solid color background */
+	Solid = "SOLID",
+	/** Gradient background */
+	Gradient = "GRADIENT"
+}
+declare enum ConditionalFormattingComparisonType {
+	/** Value-based comparison */
+	ValueBased = "VALUE_BASED",
+	/** Column-based comparison */
+	ColumnBased = "COLUMN_BASED",
+	/** Parameter-based comparison */
+	ParameterBased = "PARAMETER_BASED"
+}
+/**
+ * A single conditional formatting rule row
+ * @group Visual Overrides
+ */
+export interface ConditionalFormattingRow {
+	/** Comparison operator */
+	operator: ConditionalFormattingOperator | string;
+	/** Value to compare against */
+	value?: string;
+	/** Range values for range-based comparisons */
+	rangeValues?: {
+		min: number;
+		max: number;
+	};
+	/** Plot the formatting as a band/area */
+	plotAsBand?: boolean;
+	/** Highlight this row if the condition is met */
+	isHighlightRow?: boolean;
+	/** Type of comparison: value-based, column-based, or parameter-based */
+	comparisonType?: ConditionalFormattingComparisonType | string;
+	/** Column ID to apply the formatting to (left-hand side) */
+	lhsColumnId?: string;
+	/** Column name to compare against (right-hand side) */
+	columnToCompare?: string;
+	/** Parameter ID to compare against */
+	comparisonParameterId?: string;
+	/** Font properties to apply (color, bold, italic, etc.) */
+	fontProperties?: FontProperties;
+	/** Background format type: solid color or gradient */
+	backgroundFormatType?: BackgroundFormatType | string;
+	/** Solid background color attributes */
+	solidBackgroundAttrs?: SolidBackgroundAttrs;
+	/** Gradient background attributes */
+	gradientBackgroundAttrs?: GradientBackgroundAttrs;
+}
+/**
+ * Conditional formatting configuration
+ * @group Visual Overrides
+ */
+export interface ConditionalFormatting {
+	/** Array of conditional formatting rules */
+	rows?: ConditionalFormattingRow[];
+}
+/**
+ * Color palette for charts
+ * @group Visual Overrides
+ */
+export interface ColorPalette {
+	/** Array of color values (hex codes or color names) */
+	colors?: string[];
+}
+declare enum LegendPosition {
+	/** Position legend at the top */
+	Top = "top",
+	/** Position legend at the bottom */
+	Bottom = "bottom",
+	/** Position legend on the left */
+	Left = "left",
+	/** Position legend on the right */
+	Right = "right"
+}
+declare enum TableTheme {
+	/** Outline theme */
+	Outline = "OUTLINE",
+	/** Row theme */
+	Row = "ROW",
+	/** Zebra theme */
+	Zebra = "ZEBRA"
+}
+declare enum TableContentDensity {
+	/** Regular density */
+	Regular = "REGULAR",
+	/** Compact density */
+	Compact = "COMPACT"
+}
+/**
+ * Chart legend configuration
+ * @group Visual Overrides
+ */
+export interface ChartLegend {
+	/** Show or hide the legend */
+	show?: boolean;
+	/** Position of the legend */
+	position?: LegendPosition | string;
+	/** Color palette to use for legend colors */
+	colorPalette?: ColorPalette;
+}
+/**
+ * Filter for data labels
+ * @group Visual Overrides
+ */
+export interface DataLabelFilter {
+	/** Filter threshold value */
+	value?: number;
+	/** Filter operator */
+	operator?: DataLabelFilterOperator | string;
+}
+/**
+ * Data label configuration for a specific column
+ * @group Visual Overrides
+ */
+export interface ColumnDataLabel {
+	/** Column name to apply data label overrides to */
+	name: string;
+	/** Show or hide data labels for this column */
+	visible?: boolean;
+	/** Filter to apply to data labels */
+	filter?: DataLabelFilter | null;
+}
+/**
+ * Chart data label configuration
+ * @group Visual Overrides
+ */
+export interface ChartDataLabel {
+	/** Show labels for all data points */
+	allLabels?: boolean;
+	/** Show labels for stacked values */
+	stackLabels?: boolean;
+	/** Per-column data label configurations */
+	columnDataLabel?: ColumnDataLabel[];
+}
+/**
+ * Chart summaries and totals configuration
+ * @group Visual Overrides
+ */
+export interface ChartSummaries {
+	/** Show row totals */
+	showRowTotals?: boolean;
+	/** Show column totals */
+	showColumnTotals?: boolean;
+	/** Show row grand totals */
+	showRowGrandTotals?: boolean;
+	/** Show column grand totals */
+	showColumnGrandTotals?: boolean;
+}
+/**
+ * Gridline configuration
+ * @group Visual Overrides
+ */
+export interface GridLine {
+	/** Show vertical gridlines */
+	x?: boolean;
+	/** Show horizontal gridlines */
+	y?: boolean;
+}
+/**
+ * Chart display configuration
+ * @group Visual Overrides
+ */
+export interface ChartDisplay {
+	/** Summary and totals configuration */
+	summaries?: ChartSummaries;
+	/** Show regression line on chart */
+	regressionLine?: boolean;
+	/** Gridline visibility configuration */
+	gridLine?: GridLine;
+}
+/**
+ * Y-axis range configuration
+ * @group Visual Overrides
+ */
+export interface YAxisRange {
+	/** Minimum value for Y-axis */
+	min?: number;
+	/** Maximum value for Y-axis */
+	max?: number;
+}
+/**
+ * Chart axis configuration
+ * @group Visual Overrides
+ */
+export interface ChartAxis {
+	/** Column names to link to this axis */
+	linkedColumns?: string[];
+	/** Show the axis name */
+	showName?: boolean;
+	/** Show the axis label values */
+	showLabelValue?: boolean;
+	/** Y-axis range configuration */
+	yAxisRange?: YAxisRange;
+}
+/**
+ * Chart column override configuration
+ * @group Visual Overrides
+ */
+export interface ChartColumn {
+	/** Column name to apply overrides to */
+	name: string;
+	/** Color for the column (hex code) */
+	color?: string;
+	/** Conditional formatting rules to apply to the column */
+	conditionalFormatting?: ConditionalFormatting;
+}
+/**
+ * Chart visualization overrides
+ * @group Visual Overrides
+ */
+export interface ChartOverrides {
+	/** Legend configuration */
+	legend?: ChartLegend;
+	/** Data label configuration */
+	dataLabel?: ChartDataLabel;
+	/** Display properties (summaries, regression line, gridlines) */
+	display?: ChartDisplay;
+	/** Per-axis configurations */
+	axis?: ChartAxis[];
+	/** Per-column configurations */
+	columns?: ChartColumn[];
+	/** Update mask paths for partial updates */
+	updateMaskPaths?: string[];
+}
+/**
+ * Table column override configuration
+ * @group Visual Overrides
+ */
+export interface TableColumn {
+	/**
+	 * Name of the column to apply overrides to
+	 */
+	name: string;
+	/**
+	 * Enable or disable text wrapping for the column
+	 */
+	wrapText?: boolean;
+	/**
+	 * Show or hide the column
+	 */
+	show?: boolean;
+	/**
+	 * Conditional formatting rules to apply to the column
+	 */
+	conditionalFormatting?: ConditionalFormatting;
+}
+/**
+ * Table display configuration
+ * @group Visual Overrides
+ */
+export interface TableDisplay {
+	/** Table theme */
+	tableTheme?: TableTheme | string;
+	/** Table content density */
+	tableContentDensity?: TableContentDensity | string;
+}
+/**
+ * Column summary visibility configuration
+ * @group Visual Overrides
+ */
+export interface ColumnSummaryVisibility {
+	/** Column ID to control summary visibility for */
+	columnId: string;
+	/** Show or hide summary for this column */
+	visible: boolean;
+}
+/**
+ * Display summary configuration
+ * @group Visual Overrides
+ */
+export interface DisplaySummaryConfig {
+	/** Show all column summaries by default */
+	showAllSummaries?: boolean;
+	/** Per-column summary visibility overrides */
+	columnVisibility?: ColumnSummaryVisibility[];
+}
+/**
+ * Table visualization overrides
+ * @group Visual Overrides
+ */
+export interface TableOverrides {
+	/** Per-column configurations (properties, conditional formatting) */
+	columns?: TableColumn[];
+	/** Table display properties (theme, density) */
+	display?: TableDisplay;
+	/** Summary/headline column visibility configuration */
+	displaySummaryConfig?: DisplaySummaryConfig;
+	/** Update mask paths for partial updates */
+	updateMaskPaths?: string[];
+}
+/**
+ * Visualization overrides to customize chart and table rendering
+ * within embedded ThoughtSpot components.
+ *
+ * @group Visual Overrides
+ * @example
+ * ```js
+ * const embed = new AppEmbed('#tsEmbed', {
+ *   visualOverrides: {
+ *     chart: {
+ *       legend: { show: true, position: 'bottom' },
+ *       columns: [{ name: 'Revenue', color: '#1f77b4' }],
+ *     },
+ *     table: {
+ *       display: { tableTheme: 'ZEBRA', tableContentDensity: 'COMPACT' },
+ *     },
+ *   },
+ * });
+ * ```
+ */
+export interface VisualizationOverrides {
+	/** Chart visualization overrides */
+	chart?: ChartOverrides;
+	/** Table visualization overrides */
+	table?: TableOverrides;
+}
 declare enum AuthFailureType {
 	/**
 	 * Authentication failed in the SDK authentication flow.
@@ -8880,7 +9375,10 @@ export type UIPassthroughContractBase = {
 	[UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
 		request: Record<string, never>;
 		response: {
-			v2Content: string;
+			data: {
+				v2Content: string;
+			};
+			type: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
 		};
 	};
 	[UIPassthroughEvent.UpdateFilters]: {
@@ -9214,6 +9712,7 @@ declare class TsEmbed {
 	 * @returns
 	 */
 	protected createEmbedEventResponder: (eventPort: MessagePort | void, eventType: EmbedEvent) => (payload: any) => void;
+	private shouldSkipEvent;
 	/**
 	 * Executes all registered event handlers for a particular event type
 	 * @param eventType The event type
@@ -9383,6 +9882,18 @@ declare class TsEmbed {
 	 * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
 	 */
 	getCurrentContext(): Promise<ContextObject>;
+	/**
+	 * Generates the event name for a "Subscribed" embed event.
+	 *
+	 * This helper appends the "Subscribed" suffix to a given host or action event,
+	 * allowing you to listen for subscription lifecycle events in a consistent format.
+	 *
+	 * @param eventName - The host or action event to generate the subscribed event name for.
+	 * @returns The formatted event name (e.g., "Save Subscribed").
+	 *
+	 * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
+	 */
+	subscribedEvent(eventName: HostEvent | Action): string;
 	/**
 	 * Creates the preRender shell
 	 * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -9776,9 +10287,32 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
 	 * ```
 	 */
 	focusSearchBarOnRender?: boolean;
+	/**
+	 * Enable or disable Muze chart phase 1 GA
+	 *
+	 * Supported embed types: `SearchEmbed`
+	 * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
+	 * @default false
+	 * @example
+	 * ```js
+	 * const embed = new SearchEmbed('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    newChartsLibrary: true,
+	 * })
+	 * ```
+	 */
+	newChartsLibrary?: boolean;
+	/**
+	 * Visual overrides to customize the chart or table properties.
+	 * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
+	 */
+	visualOverrides?: VisualizationOverrides;
 }
 export interface SearchAppInitData extends DefaultAppInitData {
 	searchOptions?: SearchOptions;
+	embedParams?: {
+		visualOverridesParams?: VisualizationOverrides | null;
+	};
 }
 declare class SearchEmbed extends TsEmbed {
 	/**
@@ -10276,6 +10810,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
 export interface SpotterAppInitData extends DefaultAppInitData {
 	embedParams?: {
 		spotterSidebarConfig?: SpotterSidebarViewConfig;
+		visualOverridesParams?: VisualizationOverrides | null;
 	};
 }
 declare class SpotterEmbed extends TsEmbed {
@@ -11032,6 +11567,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
 	 */
 	enableHomepageAnnouncement?: boolean;
+	/**
+	 * If set to true, enables visualization data caching on the Liveboard.
+	 * @type {boolean}
+	 * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
+	 * @example
+	 * ```js
+	 * const embed = new AppEmbed('#tsEmbed', {
+	 *    ... // other options
+	 *    enableLiveboardDataCache: true,
+	 * })
+	 * ```
+	 */
+	enableLiveboardDataCache?: boolean;
+	/**
+	 * Visual overrides to customize the chart or table properties.
+	 * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
+	 */
+	visualOverrides?: VisualizationOverrides;
 }
 /**
  * APP_INIT data shape for AppEmbed.
@@ -11623,6 +12176,19 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
 	 * ```
 	 */
 	spotterChatConfig?: SpotterChatViewConfig;
+	/**
+	 * If set to true, enables visualization data caching on the Liveboard.
+	 * @type {boolean}
+	 * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
+	 * @example
+	 * ```js
+	 * const embed = new LiveboardEmbed('#embed-container', {
+	 *    ... // other options
+	 *    enableLiveboardDataCache: true,
+	 * })
+	 * ```
+	 */
+	enableLiveboardDataCache?: boolean;
 }
 declare class LiveboardEmbed extends V1Embed {
 	protected viewConfig: LiveboardViewConfig;