@thoughtspot/visual-embed-sdk 1.52.2-beta.2 → 1.53.1

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

@@ -121,6 +121,33 @@ export interface CustomCssVariables {
 	 * Background color of the search suggestion block on hover.
 	 */
 	"--ts-var-search-bar-auto-complete-hover-background"?: string;
+	/**
+	 * Background color of the submit (*Go*) button in the search box.
+	 */
+	"--ts-var-search-submit-button-background"?: string;
+	/**
+	 * Color of the label and icon on the submit (*Go*) button in the search box.
+	 */
+	"--ts-var-search-submit-button-color"?: string;
+	/**
+	 * Background color of the submit (*Go*) button in the search box on hover.
+	 * Defaults to the background color set for the non-hover state.
+	 */
+	"--ts-var-search-submit-button--hover-background"?: string;
+	/**
+	 * Border radius of the submit (*Go*) button in the search box. Default: `40px`.
+	 */
+	"--ts-var-search-submit-button-border-radius"?: string;
+	/**
+	 * Border width of the submit (*Go*) button in the search box. Default: `0`.
+	 * The button has a fixed size, so a border reduces its inner area.
+	 */
+	"--ts-var-search-submit-button-border-width"?: string;
+	/**
+	 * Border color of the submit (*Go*) button in the search box.
+	 * Visible only when `--ts-var-search-submit-button-border-width` is set.
+	 */
+	"--ts-var-search-submit-button-border-color"?: string;
 	/**
 	 * Font color of the text in the search suggestion panel.
 	 */
@@ -224,6 +251,194 @@ export interface CustomCssVariables {
 	 * Backgroud color of the tertiary buttons when active.
 	 */
 	"--ts-var-button--tertiary--active-background"?: string;
+	/**
+	 * Font family specification for the text on the tertiary buttons.
+	 * Defaults to the inherited font.
+	 */
+	"--ts-var-button--tertiary--font-family"?: string;
+	/**
+	 * Padding of buttons with text, for example, `6px 16px`. Applies to all button
+	 * sizes and variants.
+	 */
+	"--ts-var-button-padding"?: string;
+	/**
+	 * Minimum width of buttons with text. Applies to all button sizes and variants.
+	 */
+	"--ts-var-button-min-width"?: string;
+	/**
+	 * Space between the icon and the label in a button. Default: `8px`.
+	 */
+	"--ts-var-button-gap"?: string;
+	/**
+	 * Height of buttons. Icon-only buttons remain square when this is set.
+	 */
+	"--ts-var-button-height"?: string;
+	/**
+	 * Font size of the button label. The line height scales proportionally.
+	 */
+	"--ts-var-button-font-size"?: string;
+	/**
+	 * Font weight of the button label. Default: `400`.
+	 */
+	"--ts-var-button-font-weight"?: string;
+	/**
+	 * Border width of buttons. Default: `0`. To show a border on a button variant,
+	 * also set its border color, for example, `--ts-var-button--primary-border-color`.
+	 */
+	"--ts-var-button-border-width"?: string;
+	/**
+	 * Padding of the primary buttons with text.
+	 * Overrides `--ts-var-button-padding` for primary buttons.
+	 */
+	"--ts-var-button--primary-padding"?: string;
+	/**
+	 * Minimum width of the primary buttons with text.
+	 * Overrides `--ts-var-button-min-width` for primary buttons.
+	 */
+	"--ts-var-button--primary-min-width"?: string;
+	/**
+	 * Space between the icon and the label in the primary buttons.
+	 * Overrides `--ts-var-button-gap` for primary buttons.
+	 */
+	"--ts-var-button--primary-gap"?: string;
+	/**
+	 * Font weight of the text on the primary buttons.
+	 * Overrides `--ts-var-button-font-weight` for primary buttons.
+	 */
+	"--ts-var-button--primary-font-weight"?: string;
+	/**
+	 * Border color of the primary buttons.
+	 * Visible only when `--ts-var-button-border-width` is set.
+	 */
+	"--ts-var-button--primary-border-color"?: string;
+	/**
+	 * Padding of the secondary buttons with text.
+	 * Overrides `--ts-var-button-padding` for secondary buttons.
+	 */
+	"--ts-var-button--secondary-padding"?: string;
+	/**
+	 * Minimum width of the secondary buttons with text.
+	 * Overrides `--ts-var-button-min-width` for secondary buttons.
+	 */
+	"--ts-var-button--secondary-min-width"?: string;
+	/**
+	 * Space between the icon and the label in the secondary buttons.
+	 * Overrides `--ts-var-button-gap` for secondary buttons.
+	 */
+	"--ts-var-button--secondary-gap"?: string;
+	/**
+	 * Font weight of the text on the secondary buttons.
+	 * Overrides `--ts-var-button-font-weight` for secondary buttons.
+	 */
+	"--ts-var-button--secondary-font-weight"?: string;
+	/**
+	 * Border color of the secondary buttons.
+	 * Visible only when `--ts-var-button-border-width` is set.
+	 */
+	"--ts-var-button--secondary-border-color"?: string;
+	/**
+	 * Padding of the tertiary buttons with text.
+	 * Overrides `--ts-var-button-padding` for tertiary buttons.
+	 */
+	"--ts-var-button--tertiary-padding"?: string;
+	/**
+	 * Minimum width of the tertiary buttons with text.
+	 * Overrides `--ts-var-button-min-width` for tertiary buttons.
+	 */
+	"--ts-var-button--tertiary-min-width"?: string;
+	/**
+	 * Space between the icon and the label in the tertiary buttons.
+	 * Overrides `--ts-var-button-gap` for tertiary buttons.
+	 */
+	"--ts-var-button--tertiary-gap"?: string;
+	/**
+	 * Font weight of the text on the tertiary buttons.
+	 * Overrides `--ts-var-button-font-weight` for tertiary buttons.
+	 */
+	"--ts-var-button--tertiary-font-weight"?: string;
+	/**
+	 * Border color of the tertiary buttons.
+	 * Visible only when `--ts-var-button-border-width` is set.
+	 */
+	"--ts-var-button--tertiary-border-color"?: string;
+	/**
+	 * Font color of the tab labels.
+	 */
+	"--ts-var-tab-color"?: string;
+	/**
+	 * Background color of the tabs.
+	 */
+	"--ts-var-tab-background"?: string;
+	/**
+	 * Font family specification for the tab labels.
+	 */
+	"--ts-var-tab-font-family"?: string;
+	/**
+	 * Font size of the tab labels.
+	 */
+	"--ts-var-tab-font-size"?: string;
+	/**
+	 * Font weight of the tab labels.
+	 */
+	"--ts-var-tab-font-weight"?: string;
+	/**
+	 * Padding of the tab items.
+	 */
+	"--ts-var-tab-padding"?: string;
+	/**
+	 * Height of the tab items.
+	 */
+	"--ts-var-tab-height"?: string;
+	/**
+	 * Border radius of the tab items.
+	 */
+	"--ts-var-tab-border-radius"?: string;
+	/**
+	 * Font color of the tab labels on hover.
+	 */
+	"--ts-var-tab--hover-color"?: string;
+	/**
+	 * Background color of the tab items on hover.
+	 */
+	"--ts-var-tab--hover-background"?: string;
+	/**
+	 * Font color of the selected tab label.
+	 */
+	"--ts-var-tab--selected-color"?: string;
+	/**
+	 * Background color of the selected tab item.
+	 */
+	"--ts-var-tab--selected-background"?: string;
+	/**
+	 * Font weight of the selected tab label.
+	 */
+	"--ts-var-tab--selected-font-weight"?: string;
+	/**
+	 * Color of the underline indicator on the selected tab, in the horizontal tab layout.
+	 */
+	"--ts-var-tab--selected-indicator-color"?: string;
+	/**
+	 * Thickness of the underline indicator on the selected tab, in the horizontal tab
+	 * layout.
+	 */
+	"--ts-var-tab--selected-indicator-height"?: string;
+	/**
+	 * Border color of the divider below the horizontal tab strip.
+	 */
+	"--ts-var-tab-list-border-color"?: string;
+	/**
+	 * Color of the side rail indicator on the selected tab, in the vertical tab layout.
+	 */
+	"--ts-var-tab--vertical--selected-indicator-color"?: string;
+	/**
+	 * Thickness of the side rail indicator on the selected tab, in the vertical tab
+	 * layout.
+	 */
+	"--ts-var-tab--vertical--selected-indicator-width"?: string;
+	/**
+	 * Border color of the divider beside the vertical tab strip.
+	 */
+	"--ts-var-tab--vertical-list-border-color"?: string;
 	/**
 	 * Font color of the title text of a visualization or Answer.
 	 */
@@ -311,6 +526,104 @@ export interface CustomCssVariables {
 	 * Font family specification for the text on filter chips.
 	 */
 	"--ts-var-chip-title-font-family"?: string;
+	/**
+	 * Background color of attribute chips, such as attribute tokens in the search bar
+	 * and attribute columns in the data panel.
+	 * In chip components, `--ts-var-chip-background` takes precedence when set.
+	 */
+	"--ts-var-chip--attribute-background"?: string;
+	/**
+	 * Background color of attribute chips on hover.
+	 */
+	"--ts-var-chip--attribute--hover-background"?: string;
+	/**
+	 * Border color of attribute chips.
+	 * Defaults to `--ts-var-chip--attribute-background`.
+	 */
+	"--ts-var-chip--attribute-border-color"?: string;
+	/**
+	 * Border color of attribute chips on hover.
+	 * Defaults to `--ts-var-chip--attribute--hover-background`.
+	 */
+	"--ts-var-chip--attribute--hover-border-color"?: string;
+	/**
+	 * Background color of measure chips, such as measure tokens in the search bar
+	 * and measure columns in the data panel.
+	 * In chip components, `--ts-var-chip-background` takes precedence when set.
+	 */
+	"--ts-var-chip--measure-background"?: string;
+	/**
+	 * Background color of measure chips on hover.
+	 */
+	"--ts-var-chip--measure--hover-background"?: string;
+	/**
+	 * Border color of measure chips.
+	 * Defaults to `--ts-var-chip--measure-background`.
+	 */
+	"--ts-var-chip--measure-border-color"?: string;
+	/**
+	 * Border color of measure chips on hover.
+	 * Defaults to `--ts-var-chip--measure--hover-background`.
+	 */
+	"--ts-var-chip--measure--hover-border-color"?: string;
+	/**
+	 * Background color of date chips, such as date tokens in the search bar
+	 * and date columns in the data panel.
+	 * In chip components, `--ts-var-chip-background` takes precedence when set.
+	 */
+	"--ts-var-chip--date-background"?: string;
+	/**
+	 * Background color of date chips on hover.
+	 */
+	"--ts-var-chip--date--hover-background"?: string;
+	/**
+	 * Border color of date chips.
+	 * Defaults to `--ts-var-chip--date-background`.
+	 */
+	"--ts-var-chip--date-border-color"?: string;
+	/**
+	 * Border color of date chips on hover.
+	 * Defaults to `--ts-var-chip--date--hover-background`.
+	 */
+	"--ts-var-chip--date--hover-border-color"?: string;
+	/**
+	 * Background color of filter chips, such as filter tokens in the search bar.
+	 * Also applies to neutral column chips, such as formula and set columns.
+	 * In chip components, `--ts-var-chip-background` takes precedence when set.
+	 */
+	"--ts-var-chip--filter-background"?: string;
+	/**
+	 * Background color of filter chips on hover.
+	 */
+	"--ts-var-chip--filter--hover-background"?: string;
+	/**
+	 * Border color of filter chips.
+	 * Defaults to `--ts-var-chip--filter-background`.
+	 */
+	"--ts-var-chip--filter-border-color"?: string;
+	/**
+	 * Border color of filter chips on hover.
+	 * Defaults to `--ts-var-chip--filter--hover-background`.
+	 */
+	"--ts-var-chip--filter--hover-border-color"?: string;
+	/**
+	 * Background color of unrecognized tokens in the search bar.
+	 */
+	"--ts-var-chip--unrecognized-background"?: string;
+	/**
+	 * Background color of unrecognized tokens in the search bar on hover.
+	 */
+	"--ts-var-chip--unrecognized--hover-background"?: string;
+	/**
+	 * Border color of unrecognized tokens in the search bar.
+	 * Defaults to `--ts-var-chip--unrecognized-background`.
+	 */
+	"--ts-var-chip--unrecognized-border-color"?: string;
+	/**
+	 * Border color of unrecognized tokens in the search bar on hover.
+	 * Defaults to `--ts-var-chip--unrecognized--hover-background`.
+	 */
+	"--ts-var-chip--unrecognized--hover-border-color"?: string;
 	/**
 	 * Font color of axis title on charts.
 	 */
@@ -662,6 +975,54 @@ export interface CustomCssVariables {
 	 * Font color of the hover tab in the Liveboard.
 	 */
 	"--ts-var-liveboard-tab-hover-color"?: string;
+	/**
+	 * Font color of the tab labels in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-color"?: string;
+	/**
+	 * Background color of the tab items in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-background"?: string;
+	/**
+	 * Font family specification for the tab labels in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-font-family"?: string;
+	/**
+	 * Font size of the tab labels in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-font-size"?: string;
+	/**
+	 * Font weight of the tab labels in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-font-weight"?: string;
+	/**
+	 * Border radius of the tab items in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-border-radius"?: string;
+	/**
+	 * Background color of the tab items in the Liveboard on hover.
+	 */
+	"--ts-var-liveboard-tab-hover-background"?: string;
+	/**
+	 * Font color of the selected tab label in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-selected-color"?: string;
+	/**
+	 * Background color of the selected tab item in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-selected-background"?: string;
+	/**
+	 * Font weight of the selected tab label in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-selected-font-weight"?: string;
+	/**
+	 * Thickness of the underline indicator on the selected tab in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-selected-indicator-height"?: string;
+	/**
+	 * Border color of the divider above the tab strip in the Liveboard.
+	 */
+	"--ts-var-liveboard-tab-list-border-color"?: string;
 	/**
 	 * Font size of the title of the tiles in the Liveboard.
 	 */
@@ -1027,7 +1388,8 @@ export interface CustomCssVariables {
 	"--ts-var-spotterviz-footer-text-color"?: string;
 	/**
 	 * Shared border color used throughout SpotterViz: input box, user message,
-	 * header underline, left panel border, thinking step connector and dots.
+	 * header underline, left panel border, thinking step connector and dots,
+	 * and the attached-file upload card.
 	 */
 	"--ts-var-spotterviz-border-color"?: string;
 	/**
@@ -1041,16 +1403,22 @@ export interface CustomCssVariables {
 	"--ts-var-spotterviz-reference-icon-hover-background"?: string;
 	/**
 	 * Icon color for the reference-mode selected state — applies to
-	 * both the toggle button when active and the icon badge on each
-	 * referenced-entity chip in the chat input.
+	 * the toggle button when active and the icon badge on each
+	 * referenced-entity chip and the attached-file chip in the chat input.
 	 */
 	"--ts-var-spotterviz-reference-icon-selected-color"?: string;
 	/**
 	 * Background color for the reference-mode selected state — applies to
-	 * both the reference mode toggle button when active and the icon badge
-	 * on each referenced-entity chip in the chat input.
+	 * the reference mode toggle button when active and the icon badge on
+	 * each referenced-entity chip and the attached-file chip in the chat
+	 * input.
 	 */
 	"--ts-var-spotterviz-reference-icon-selected-background"?: string;
+	/**
+	 * Background color of the file-type thumbnail on the attached-file card
+	 * in the SpotterViz chat input.
+	 */
+	"--ts-var-spotterviz-upload-card-thumbnail-background"?: string;
 	/**
 	 * Background color of the shared conversation header (recipient's read-only view).
 	 */
@@ -1111,6 +1479,21 @@ export interface UnderlyingDataPoint {
 	columnId: string;
 	dataValue: any;
 }
+/**
+ * Describes how to sort a column when fetching data. Pass an array of these to
+ * sort by multiple columns, in priority order.
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.12.0.cl
+ */
+export interface SortOptions {
+	/**
+	 * Name of the column to sort by. The column must exist in the data source.
+	 */
+	columnName: string;
+	/**
+	 * Sort direction. `true` sorts ascending, `false` sorts descending.
+	 */
+	ascending: boolean;
+}
 /**
  * AnswerService provides a simple way to work with ThoughtSpot Answers.
  *
@@ -1218,6 +1601,12 @@ export declare class AnswerService {
 	 * @returns
 	 */
 	addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter["values"]): Promise<any>;
+	/**
+	 * Adapt the sort options into the `updateSort` payload and send it.
+	 * @param sortOptions Columns to sort by, each with a direction.
+	 * @param sourceDetail
+	 */
+	private adaptSorting;
 	updateDisplayMode(displayMode?: string): Promise<any>;
 	getSQLQuery(fetchSQLWithAllColumns?: boolean): Promise<string>;
 	/**
@@ -1270,18 +1659,21 @@ export declare class AnswerService {
 	 * automatically passed.
 	 * @param outputColumnNames
 	 * @param selectedPoints
+	 * @param sortOptions Optional columns to sort the underlying data by.
 	 * @example
 	 * ```js
 	 *  embed.on(EmbedEvent.CustomAction, e => {
-	 *     const underlying = await e.answerService.getUnderlyingDataForPoint([
-	 *       'col name 1' // The column should exist in the data source.
-	 *     ]);
+	 *     const underlying = await e.answerService.getUnderlyingDataForPoint(
+	 *       ['col name 1'], // The column should exist in the data source.
+	 *       undefined,
+	 *       [{ columnName: 'col name 1', ascending: true }],
+	 *     );
 	 *     const data = await underlying.fetchData(0, 100);
 	 *  })
 	 * ```
 	 * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
 	 */
-	getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
+	getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[], sortOptions?: SortOptions[]): Promise<AnswerService>;
 	/**
 	 * Execute a custom graphql query in the context of the answer.
 	 * @param query graphql query
@@ -2094,6 +2486,27 @@ export interface EmbedConfig {
 	 * @default true
 	 */
 	blockNonEmbedFullAppAccess?: boolean;
+	/**
+	 * Render the embedded application in dark appearance when `true`, and in
+	 * its default appearance when `false` or unset.
+	 *
+	 * The host application owns the appearance of an embed, so this overrides
+	 * the appearance preference of the signed-in user and the color scheme of
+	 * their operating system. If your application has light and dark themes,
+	 * pass `true` while it shows the dark theme and `false` while it shows
+	 * the light theme.
+	 * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+	 * @example
+	 * ```js
+	 * // Your application's current theme, 'light' or 'dark'
+	 * const appTheme = 'dark';
+	 * init({
+	 *   ...embedConfig,
+	 *   isDarkMode: appTheme === 'dark',
+	 * });
+	 * ```
+	 */
+	isDarkMode?: boolean;
 	/**
 	 * Host config in case embedded app is inside TS app itself
 	 * @hidden
@@ -2666,6 +3079,31 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	 * @default ''
 	 */
 	customizations?: CustomisationsInterface;
+	/**
+	 * Render this embed in dark appearance when `true`, and in its default
+	 * appearance when `false`, overriding the `isDarkMode` value passed to
+	 * `init`.
+	 *
+	 * The host application owns the appearance of an embed, so this overrides
+	 * the appearance preference of the signed-in user and the color scheme of
+	 * their operating system. If your application has light and dark themes,
+	 * pass `true` while it shows the dark theme and `false` while it shows
+	 * the light theme. Leave it unset to inherit the `init` value.
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
+	 * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+	 * @example
+	 * ```js
+	 * // Your application's current theme, 'light' or 'dark'
+	 * const appTheme = 'dark';
+	 * // Replace AppEmbed with a specific embed component like SearchEmbed or LiveboardEmbed
+	 * const embed = new AppEmbed('#tsEmbed', {
+	 *   ... // other embed view config
+	 *   isDarkMode: appTheme === 'dark',
+	 * });
+	 * ```
+	 */
+	isDarkMode?: boolean;
 	/**
 	 * Insert as a sibling of the target container, instead of appending to a
 	 * child inside it.
@@ -3209,7 +3647,32 @@ export interface BaseViewConfig extends ApiInterceptFlags {
  * - `enableV2Shell_experimental` — the renderer always uses the v2 URL format;
  *   this flag has no effect.
  */
-export type AutoMCPFrameRendererViewConfig = Omit<BaseViewConfig, "preRenderId" | "usePrerenderedIfAvailable" | "doNotTrackPreRenderSize" | "insertAsSibling" | "primaryAction" | "enableV2Shell_experimental">;
+export type AutoMCPFrameRendererViewConfig = Omit<BaseViewConfig, "preRenderId" | "usePrerenderedIfAvailable" | "doNotTrackPreRenderSize" | "insertAsSibling" | "primaryAction" | "enableV2Shell_experimental"> & {
+	/**
+	 * Suppress the notice shown on answers re-resolved from a stored
+	 * conversation. Those answers are re-run against current data, so by
+	 * default the renderer marks them with a tooltip explaining that the
+	 * numbers may differ from what the user originally saw. Set this to
+	 * `true` to render them without any notice.
+	 *
+	 * Only affects frames carrying {@link Param.TsmcpConversationId}; frames
+	 * that already contain their own session parameters are never marked.
+	 * @default false
+	 * @version SDK: 1.51.3
+	 * @example
+	 * ```js
+	 * startAutoMCPFrameRenderer({ suppressStaleAnswerNotice: true });
+	 * ```
+	 */
+	suppressStaleAnswerNotice?: boolean;
+	/**
+	 * Text of the notice described in {@link suppressStaleAnswerNotice}.
+	 * Override it to translate the message or match your own product voice.
+	 * @default 'This data may have changed since the last time you had a chat.'
+	 * @version SDK: 1.51.3
+	 */
+	staleAnswerNoticeText?: string;
+};
 /**
  * The configuration object for Home page embeds configs.
  */
@@ -4817,6 +5280,36 @@ export declare enum EmbedEvent {
 	 * ```
 	 */
 	Edit = "edit",
+	/**
+	 * Emitted when a user clicks **Edit** on a Liveboard.
+	 *
+	 * Fired alongside {@link EmbedEvent.Edit} for backward compatibility;
+	 * listen to this instead of `Edit` to target the Liveboard surface only.
+	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @example
+	 * ```js
+	 * liveboardEmbed.on(EmbedEvent.EditLiveboard, payload => {
+	 *    console.log('Liveboard edit', payload);
+	 * })
+	 * ```
+	 */
+	EditLiveboard = "editLiveboard",
+	/**
+	 * Emitted when a user clicks **Edit** on a visualization inside a
+	 * Liveboard.
+	 *
+	 * Fired alongside {@link EmbedEvent.Edit} for backward compatibility;
+	 * listen to this instead of `Edit` to target the visualization surface
+	 * only.
+	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @example
+	 * ```js
+	 * liveboardEmbed.on(EmbedEvent.EditVisualization, payload => {
+	 *    console.log('visualization edit', payload);
+	 * })
+	 * ```
+	 */
+	EditVisualization = "editVisualization",
 	/**
 	 * Emitted when a user clicks *Make a copy* on a Liveboard
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
@@ -6787,6 +7280,46 @@ export declare enum HostEvent {
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
 	 */
 	Edit = "edit",
+	/**
+	 * Trigger the **Edit** action on a Liveboard only — does not affect a
+	 * visualization's edit surface.
+	 *
+	 * Behaves like {@link HostEvent.Edit} restricted to the Liveboard
+	 * surface. Use {@link HostEvent.EditVisualization} to target a
+	 * visualization instead, or `HostEvent.Edit` to control whichever
+	 * surface applies contextually (unchanged, existing behavior).
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.EditLiveboard)
+	 * ```
+	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 */
+	EditLiveboard = "editLiveboard",
+	/**
+	 * Trigger the **Edit** action on a specific visualization inside a
+	 * Liveboard only — does not affect the Liveboard-level edit surface.
+	 * @param - Object parameter. Includes the following keys:
+	 * - `vizId`: **Required.** The visualization to edit.
+	 *
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.EditVisualization, {vizId:
+	 * '730496d6-6903-4601-937e-2c691821af3c'})
+	 * ```
+	 * @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}.
@@ -8320,7 +8853,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
@@ -8799,12 +9365,43 @@ export declare enum Action {
 	 * The *Edit* action on the Liveboard page and in the
 	 * visualization menu.
 	 * Opens a Liveboard or visualization in edit mode.
+	 *
+	 * Controls both surfaces together. To target one surface only, use
+	 * {@link Action.EditLiveboard} or {@link Action.EditVisualization}.
 	 * @example
 	 * ```js
 	 * disabledActions: [Action.Edit]
 	 * ```
 	 */
 	Edit = "edit",
+	/**
+	 * The *Edit* action on the Liveboard page only.
+	 * Opens a Liveboard in edit mode.
+	 *
+	 * Does not affect the *Edit* action in the visualization menu; use
+	 * {@link Action.EditVisualization} for that, or {@link Action.Edit} to
+	 * control both surfaces together.
+	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.EditLiveboard]
+	 * ```
+	 */
+	EditLiveboard = "editLiveboard",
+	/**
+	 * The *Edit* action in the visualization `...` menu only.
+	 * Opens a visualization in the editor.
+	 *
+	 * Does not affect the *Edit* action on the Liveboard page; use
+	 * {@link Action.EditLiveboard} for that, or {@link Action.Edit} to
+	 * control both surfaces together.
+	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.EditVisualization]
+	 * ```
+	 */
+	EditVisualization = "editVisualization",
 	/**
 	 * The text edit option for Liveboard and visualization titles.
 	 * @example
@@ -10577,7 +11174,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",
@@ -12053,6 +12673,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).
@@ -12143,6 +12772,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
@@ -12285,6 +12915,7 @@ declare class TsEmbed {
 	protected embedNodeKey: string;
 	protected embedContainerLoadedKey: string;
 	protected isAppInitialized: boolean;
+	private initDataParams;
 	/**
 	 * A reference to the iframe within which the ThoughtSpot app
 	 * will be rendered.
@@ -12410,6 +13041,7 @@ declare class TsEmbed {
 	protected getAuthTokenForCookielessInit(): Promise<string>;
 	protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
 	protected getAppInitData(): Promise<DefaultAppInitData>;
+	private withInitDataParams;
 	/**
 	 * Send Custom style as part of payload of APP_INIT
 	 * @param _
@@ -12482,6 +13114,7 @@ declare class TsEmbed {
 			[key: string]: string | number | boolean;
 		};
 		customizations?: CustomisationsInterface;
+		isDarkMode?: boolean;
 		insertAsSibling?: boolean;
 		usePrerenderedIfAvailable?: boolean;
 		preRenderId?: string;
@@ -12549,6 +13182,7 @@ declare class TsEmbed {
 	protected getV1EmbedBasePath(queryString: string): string;
 	protected getEmbedParams(): string;
 	protected getEmbedParamsObject(): Record<any, any>;
+	protected getUrlQueryParamsObject(): Record<any, any>;
 	protected getRootIframeSrc(): string;
 	protected createIframeEl(frameSrc: string): HTMLIFrameElement;
 	/**
@@ -12590,26 +13224,12 @@ declare class TsEmbed {
 	 */
 	private createPreRenderPlaceholder;
 	/**
-	 * Resolves the configured preRenderContainer to a live element. 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.
-	 *
-	 * With nothing configured the frame goes into the host element's nearest
-	 * scrolling ancestor, falling back to `document.body`.
-	 *
-	 * The wrapper is absolutely positioned, so it follows the page for free —
-	 * but only while it sits inside whatever scrolls. `document.body` is right
-	 * only when the document itself is the scroller; an app that scrolls an
-	 * inner element instead left the frame pinned to the viewport while the page
-	 * moved under it (SCAL-338563). Being inside the scroller also lets wheel
-	 * events chain out of the frame into it, which they cannot do from
-	 * `document.body`.
-	 *
-	 * A scrolling ancestor is layout chrome rather than route content, so it
-	 * outlives the embed in practice; and if it does go, the host element goes
-	 * with it and this instance is remounting anyway.
-	 * `reconcilePreRenderContainer` re-runs this on a detached container.
+	 * 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;
@@ -12870,6 +13490,8 @@ declare class TsEmbed {
 	 */
 	prerenderGeneric(): Promise<any>;
 	protected preRenderParamsApplied: Promise<void>;
+	protected isConfigExcludedFromUrl(): boolean;
+	protected triggerUpdateEmbedParams(): Promise<void>;
 	protected beforePrerenderVisible(): void;
 	/**
 	 * Displays the pre-rendered component inside the host element.
@@ -12955,6 +13577,17 @@ declare class V1Embed extends TsEmbed {
 	 */
 	test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
 }
+/**
+ * The Spotter experience version to load in the embedded view.
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl
+ * @group Embed components
+ */
+export declare enum SpotterExperienceVersion {
+	/**
+	 * The Spotter experience version introduced in ThoughtSpot 26.11.
+	 */
+	SPOTTER_2026_11 = "spotter_2026_11"
+}
 /**
  * Configuration for search options
  */
@@ -13095,6 +13728,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.
@@ -13378,6 +14024,20 @@ export interface SpotterAnalystConfig {
  * @group Embed components
  */
 export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
+	/**
+	 * The Spotter experience version to load. When set to
+	 * `SpotterExperienceVersion.SPOTTER_2026_11`, the embed loads the updated Spotter
+	 * surface instead of the default conversation surface.
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @example
+	 * ```js
+	 * const embed = new SpotterEmbed('#tsEmbed', {
+	 *    ... // other options
+	 *    spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
+	 * });
+	 * ```
+	 */
+	spotterExperienceVersion?: SpotterExperienceVersion;
 	/**
 	 * The ID of the data source object. For example, Model, View, or Table. Spotter uses
 	 * this object to query data and generate Answers.
@@ -13741,6 +14401,7 @@ export interface SpotterAppInitData extends DefaultAppInitData {
 		visualOverridesParams?: VisualizationOverrides | null;
 		starterPrompts?: StarterPromptsConfig;
 		spotterAnalystConfig?: SpotterAnalystConfig;
+		enableSpotterInstructionAndMoreSettings?: boolean;
 	};
 }
 /**
@@ -13925,6 +14586,21 @@ export interface SpotterVizConfig {
 	 * @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
 	 */
 	insightTileLoaderText?: string;
+	/**
+	 * Set to `false` to hide the file upload feature in the SpotterViz chat
+	 * input on a cluster where the feature is available.
+	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @default true
+	 */
+	fileUploadEnabled?: boolean;
+	/**
+	 * Restricts the allowed file types for SpotterViz file upload to a
+	 * subset of the types SpotterViz supports, e.g. `['csv', 'pdf']`.
+	 * Entries are file extensions (with or without the leading dot); types
+	 * SpotterViz does not support are ignored, as are empty lists.
+	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 */
+	fileUploadFileTypes?: string[];
 }
 /**
  * A single tip shown in the SpotterViz loading state.
@@ -14811,6 +15487,19 @@ export interface AppViewConfig extends AllEmbedViewConfig, FullHeightViewConfig
 	 * ```
 	 */
 	hideAnswerEditPanel?: boolean;
+	/**
+	 * The Spotter experience version to load for the Spotter surface shown within
+	 * this embed.
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @example
+	 * ```js
+	 * const embed = new AppEmbed('#tsEmbed', {
+	 *    ... // other options
+	 *    spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
+	 * });
+	 * ```
+	 */
+	spotterExperienceVersion?: SpotterExperienceVersion;
 }
 /**
  * APP_INIT data shape for AppEmbed.
@@ -14822,6 +15511,7 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
 		spotterVizConfig?: SpotterVizConfig;
 		spotterShareConversationConfig?: SpotterShareConversationConfig;
 		starterPrompts?: StarterPromptsConfig;
+		enableSpotterInstructionAndMoreSettings?: boolean;
 	};
 }
 /**
@@ -15176,6 +15866,56 @@ export declare const exportTML: (data: exportTMLInput) => Promise<any>;
  * @group Global methods
  */
 export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
+/**
+ * A filter to apply to a Liveboard when it loads.
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+ * @group Embed components
+ */
+export interface LiveboardFilterQuery {
+	/** Name of the Liveboard tab the filter applies to. */
+	tabName?: string;
+	/** Name of the group within the tab that the filter applies to. */
+	groupName?: string;
+	/**
+	 * The filter condition, in search sentence form. For example, `color = red`.
+	 */
+	filterQueryToken: string;
+}
+/**
+ * A Parameter value to apply to a Liveboard when it loads.
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+ * @group Embed components
+ */
+export interface LiveboardParameterQuery {
+	/** Name of the Liveboard tab the Parameter applies to. */
+	tabName?: string;
+	/** Name of the group within the tab that the Parameter applies to. */
+	groupName?: string;
+	/** The Parameter assignment. */
+	parameterQueryToken: string;
+}
+/**
+ * Filter and Parameter overrides for one data source on the Liveboard.
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+ * @group Embed components
+ */
+export interface LiveboardDataSourceOverride {
+	/** The data source (Model) the overrides apply to. */
+	dataSourceIdentifier?: string;
+	/** Filters to apply for this data source. */
+	filterQuery?: LiveboardFilterQuery[];
+	/** Parameter values to apply for this data source. */
+	parameterQuery?: LiveboardParameterQuery[];
+}
+/**
+ * Filter and Parameter overrides applied to a Liveboard when it loads.
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+ * @group Embed components
+ */
+export interface LiveboardOverride {
+	/** One entry per data source to override. */
+	dataSourceOverride: LiveboardDataSourceOverride[];
+}
 /**
  * APP_INIT data shape for LiveboardEmbed.
  * @internal
@@ -15184,6 +15924,7 @@ export interface LiveboardEmbedAppInitData extends DefaultAppInitData {
 	embedParams?: {
 		spotterVizConfig?: SpotterVizConfig;
 		starterPrompts?: StarterPromptsConfig;
+		liveboardOverride?: LiveboardOverride;
 	};
 }
 /**
@@ -15670,6 +16411,46 @@ export interface LiveboardViewConfig extends BaseViewConfig, FullHeightViewConfi
 	 * ```
 	 */
 	updatedSpotterExperience?: boolean;
+	/**
+	 * Filters and Parameters to apply to the Liveboard when it loads.
+	 *
+	 * In an embedded Liveboard, this is the only way to set these overrides.
+	 * The `filter` and `parameter` URL query params are ignored.
+	 * Clauses without a query token are dropped.
+	 *
+	 * Supported embed types: `LiveboardEmbed`
+	 * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @example
+	 * ```js
+	 * const embed = new LiveboardEmbed('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    liveboardOverride: {
+	 *        dataSourceOverride: [{
+	 *            dataSourceIdentifier: '<model-guid>',
+	 *            filterQuery: [{
+	 *                tabName: 'Sales',
+	 *                groupName: 'Region',
+	 *                filterQueryToken: 'color = red',
+	 *            }],
+	 *        }],
+	 *    },
+	 * })
+	 * ```
+	 */
+	liveboardOverride?: LiveboardOverride;
+	/**
+	 * The Spotter experience version to load for the Spotter surface shown within
+	 * this embed.
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl
+	 * @example
+	 * ```js
+	 * const embed = new LiveboardEmbed('#tsEmbed', {
+	 *    ... // other options
+	 *    spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
+	 * });
+	 * ```
+	 */
+	spotterExperienceVersion?: SpotterExperienceVersion;
 }
 export declare class LiveboardEmbed extends V1Embed {
 	protected viewConfig: LiveboardViewConfig;
@@ -15702,20 +16483,8 @@ export declare class LiveboardEmbed extends V1Embed {
 		personalizedViewId: string;
 	};
 	protected beforePrerenderVisible(): void;
-	/**
-	 * Whether `previous` was showing what this instance is about to show.
-	 *
-	 * Undefined-valued keys are dropped before comparing. `navigateToLiveboard`
-	 * assigns `vizId`, `activeTabId` and `personalizedViewId` unconditionally,
-	 * so an instance that has been shown once carries those keys as `undefined`
-	 * while a freshly constructed one does not have them at all. `isEqual`
-	 * counts own keys, so without this the comparison can never be true after
-	 * the first show — which is the whole case this exists for.
-	 *
-	 * Callbacks compare as equal: React passes a fresh closure per render.
-	 */
 	private isSameEmbedConfig;
-	private isShowingLiveboardRoute;
+	private isAlreadyOnSameRoute;
 	protected handleRenderForPrerender(): Promise<TsEmbed>;
 	/**
 	 * Triggers an event to the embedded app
@@ -16418,6 +17187,7 @@ declare const getEmbedConfig: () => EmbedConfig;
 export declare const MIXPANEL_EVENT: {
 	VISUAL_SDK_RENDER_START: string;
 	VISUAL_SDK_CALLED_INIT: string;
+	VISUAL_SDK_INIT_ACTIONS: string;
 	VISUAL_SDK_RENDER_COMPLETE: string;
 	VISUAL_SDK_RENDER_FAILED: string;
 	VISUAL_SDK_TRIGGER: string;