@thoughtspot/visual-embed-sdk 1.50.0 → 1.50.1

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

@@ -413,6 +413,14 @@ export interface CustomCssVariables {
 	 * Background color of the tiles in the Liveboard.
 	 */
 	"--ts-var-liveboard-tile-background"?: string;
+	/**
+	 * Font color of the insight tiles in the Liveboard.
+	 */
+	"--ts-var-liveboard-insight-tile-font-color"?: string;
+	/**
+	 * Background color of the insight tiles in the Liveboard.
+	 */
+	"--ts-var-liveboard-insight-tile-background"?: string;
 	/**
 	 * Border radius of the tiles in the Liveboard.
 	 */
@@ -961,6 +969,10 @@ export interface CustomCssVariables {
 	 * header underline, left panel border, thinking step connector and dots.
 	 */
 	"--ts-var-spotterviz-border-color"?: string;
+	/**
+	 * Expanded user chat message bubble border color in SpotterViz.
+	 */
+	"--ts-var-spotterviz-expanded-border-color"?: string;
 	/**
 	 * Background color of the reference-mode toggle button in the SpotterViz
 	 * chat input when it is unselected and the user hovers over it.
@@ -978,6 +990,53 @@ export interface CustomCssVariables {
 	 * on each referenced-entity chip in the chat input.
 	 */
 	"--ts-var-spotterviz-reference-icon-selected-background"?: string;
+	/**
+	 * Background color of the shared conversation header (recipient's read-only view).
+	 */
+	"--ts-var-shared-conv-header-background"?: string;
+	/**
+	 * Border color of the shared conversation header.
+	 */
+	"--ts-var-shared-conv-header-border-color"?: string;
+	/**
+	 * Font color of the title text in the shared conversation header.
+	 */
+	"--ts-var-shared-conv-title-color"?: string;
+	/**
+	 * Background gradient color-stop of the share chat header's outer container
+	 * (sender's pre-share header). Defaults to transparent.
+	 */
+	"--ts-var-share-chat-header-container-background"?: string;
+	/**
+	 * Background color of the share chat header's inner title/actions row.
+	 * Defaults to transparent.
+	 */
+	"--ts-var-share-chat-header-background"?: string;
+	/**
+	 * Font color of the title text in the share chat header.
+	 */
+	"--ts-var-share-chat-header-title-color"?: string;
+	/**
+	 * Font color of the title input field in the share chat header.
+	 */
+	"--ts-var-share-chat-header-input-text-color"?: string;
+	/**
+	 * Background color of the title input field in the share chat header.
+	 */
+	"--ts-var-share-chat-header-input-background"?: string;
+	/**
+	 * Border color of the title input field in the share chat header.
+	 */
+	"--ts-var-share-chat-header-input-border-color"?: string;
+	/**
+	 * Background color of the shimmer loading effect. Also affects the
+	 * saved chats sidebar's new-chat shimmer, which shares the same style.
+	 */
+	"--ts-var-shimmer-background"?: string;
+	/**
+	 * Background color of the shimmer sweep animation's gradient mid-stop.
+	 */
+	"--ts-var-shimmer-sweep-background"?: string;
 }
 export interface SessionInterface {
 	sessionId: string;
@@ -1351,7 +1410,14 @@ export declare enum HomeLeftNavItem {
 	 * Available in the V3 navigation experience.
 	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
 	 */
-	Favorites = "favorites"
+	Favorites = "favorites",
+	/**
+	 * The *Collections* menu option in
+	 * the *Insights* left navigation panel.
+	 * Shown when collections are enabled on the cluster.
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 */
+	Collections = "collections"
 }
 export type DOMSelector = string | HTMLElement;
 /**
@@ -2298,6 +2364,26 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	 * ```
 	 */
 	overrideOrgId?: number;
+	/**
+	 * Overrides the browser history behavior for embedding application users.
+	 * This parameter changes standard history navigation (pushState) into a
+	 * state replacement (replaceState), preventing users from getting trapped in
+	 * back-button loops inside the embedded iframe environment.
+	 * The overrideHistoryState setting is honored only if the
+	 * application is running within an embedded context.
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *     // ... other embed view config
+	 *     overrideHistoryState: true,
+	 * });
+	 * ```
+	 */
+	overrideHistoryState?: boolean;
 	/**
 	 * Flag to override the *Open Link in New Tab* context
 	 * menu option.
@@ -4743,6 +4829,30 @@ export declare enum EmbedEvent {
 	 * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
 	 */
 	SpotterConversationSelected = "spotterConversationSelected",
+	/**
+	 * Emitted when the Spotter agent finishes streaming/rendering a response.
+	 * Includes the conversation and message identifiers so the host app can
+	 * fetch the full conversation history via the REST API if needed.
+	 *
+	 * The payload data has the shape `{ convId: string, messageId: string }`.
+	 *
+	 * Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
+	 * inside the full application).
+	 * @example
+	 * ```js
+	 * spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
+	 *     console.log('Spotter response complete', payload);
+	 * })
+	 * ```
+	 * @example
+	 * ```js
+	 * appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
+	 *     console.log('Spotter response complete', payload);
+	 * })
+	 * ```
+	 * @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 */
+	SpotterResponseComplete = "spotterResponseComplete",
 	/**
 	 * @hidden
 	 * Emitted when the auth token is about to get expired and needs to be refreshed.
@@ -6306,6 +6416,14 @@ export declare enum HostEvent {
 	/**
 	 * Get details of filters applied on the Liveboard.
 	 * Returns arrays containing Liveboard filter and runtime filter elements.
+	 * Each Liveboard filter may include an `applicability` attribute
+	 * indicating the scope of the filter. It contains a `level`
+	 * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
+	 * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
+	 * level there is no `targetId`, since the filter applies to the
+	 * whole Liveboard.
+	 * The `applicability` attribute is available from SDK: 1.51.0 |
+	 * ThoughtSpot: 26.10.0.cl.
 	 * @example
 	 * ```js
 	 * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -6345,6 +6463,16 @@ export declare enum HostEvent {
 	 *
 	 * `type`  - To update filters for date time, specify the date format type.
 	 * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
+	 *
+	 * `applicability` - Optional. Scopes the filter to a specific target,
+	 * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
+	 * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
+	 *
+	 *  - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
+	 *  - `targetId`: The GUID of the target, for example, the tab GUID.
+	 *    Required when `level` is `TAB` or `GROUP`. Do not pass it when
+	 *    `level` is `LIVEBOARD`, since the filter applies to the whole
+	 *    Liveboard.
 	 * @example
 	 * ```js
 	 *
@@ -6421,6 +6549,21 @@ export declare enum HostEvent {
 	 *     }
 	 * }, ContextType.Liveboard);
 	 * ```
+	 * @example
+	 * ```js
+	 * // Scope the filter to a specific Liveboard tab
+	 * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
+	 *     filter: {
+	 *         column: "item type",
+	 *         oper: "IN",
+	 *         values: ["bags", "shirts"],
+	 *         applicability: {
+	 *             level: "TAB",
+	 *             targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
+	 *         }
+	 *     }
+	 * });
+	 * ```
 	 * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
 	 */
 	UpdateFilters = "updateFilters",
@@ -6572,6 +6715,15 @@ export declare enum HostEvent {
 	 * - `name`: Name of the parameter.
 	 * - `value`: The value to set for the parameter.
 	 * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
+	 * - `applicability`: Optional. Scopes the parameter to a specific target,
+	 * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
+	 * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
+	 *
+	 *    - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
+	 *    - `targetId`: The GUID of the target, for example, the tab GUID.
+	 *      Required when `level` is `TAB` or `GROUP`. Do not pass it when
+	 *      `level` is `LIVEBOARD`, since the parameter applies to the whole
+	 *      Liveboard.
 	 *
 	 * @example
 	 * ```js
@@ -6583,6 +6735,18 @@ export declare enum HostEvent {
 	 * ```
 	 * @example
 	 * ```js
+	 * // Scope the parameter to a specific Liveboard tab
+	 * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
+	 *   name: "Integer Range Param",
+	 *   value: 10,
+	 *   applicability: {
+	 *     level: "TAB",
+	 *     targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
+	 *   }
+	 * }])
+	 * ```
+	 * @example
+	 * ```js
 	 * // Update parameters from liveboard context
 	 * import { ContextType } from '@thoughtspot/visual-embed-sdk';
 	 * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -6596,6 +6760,14 @@ export declare enum HostEvent {
 	UpdateParameters = "UpdateParameters",
 	/**
 	 * Triggers GetParameters to fetch the runtime Parameters.
+	 * Each parameter may include an `applicability` attribute
+	 * indicating the scope of the parameter. It contains a `level`
+	 * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
+	 * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
+	 * level there is no `targetId`, since the parameter applies to the
+	 * whole Liveboard.
+	 * The `applicability` attribute is available from SDK: 1.51.0 |
+	 * ThoughtSpot: 26.10.0.cl.
 	 * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
@@ -9079,7 +9251,9 @@ declare enum EmbedErrorCodes {
 	/** 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"
+	DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD",
+	/** UpdateParameters payload is invalid - malformed applicability */
+	UPDATEPARAMETERS_INVALID_PAYLOAD = "UPDATEPARAMETERS_INVALID_PAYLOAD"
 }
 /**
  * Error event object emitted when an error occurs in an embedded component.
@@ -9826,6 +10000,35 @@ export interface LiveboardTab {
 	name: string;
 	[key: string]: any;
 }
+declare enum ApplicabilityLevel {
+	Liveboard = "LIVEBOARD",
+	Tab = "TAB",
+	Group = "GROUP"
+}
+/**
+ * Scopes a filter or parameter to a specific target.
+ * At `LIVEBOARD` level the filter applies to the whole Liveboard, so `targetId`
+ * is not required.
+ */
+export interface Applicability {
+	level: ApplicabilityLevel;
+	targetId?: string;
+}
+export interface FilterUpdate {
+	column: string;
+	oper: string;
+	values: string[];
+	type?: string;
+	applicability?: Applicability;
+}
+export interface LiveboardFilter {
+	applicability?: Applicability;
+	[key: string]: any;
+}
+export interface LiveboardParameter {
+	applicability?: Applicability;
+	[key: string]: any;
+}
 declare enum UIPassthroughEvent {
 	PinAnswerToLiveboard = "addVizToPinboard",
 	SaveAnswer = "saveAnswer",
@@ -9920,7 +10123,7 @@ export type UIPassthroughContractBase = {
 			vizId?: string;
 		};
 		response: {
-			liveboardFilters: Record<string, any>[];
+			liveboardFilters: LiveboardFilter[];
 			runtimeFilters: RuntimeFilter[];
 		};
 	};
@@ -9933,7 +10136,7 @@ export type UIPassthroughContractBase = {
 	[UIPassthroughEvent.GetParameters]: {
 		request: Record<string, never>;
 		response: {
-			parameters: Record<string, any>[];
+			parameters: LiveboardParameter[];
 		};
 	};
 	[UIPassthroughEvent.GetTML]: {
@@ -9962,18 +10165,8 @@ export type UIPassthroughContractBase = {
 	};
 	[UIPassthroughEvent.UpdateFilters]: {
 		request: {
-			filter?: {
-				column: string;
-				oper: string;
-				values: string[];
-				type?: string;
-			};
-			filters?: {
-				column: string;
-				oper: string;
-				values: string[];
-				type?: string;
-			}[];
+			filter?: FilterUpdate;
+			filters?: FilterUpdate[];
 		};
 		response: unknown;
 	};
@@ -10050,6 +10243,7 @@ declare class HostEventClient {
 	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 handleUpdateParametersEvent(payload: HostEventRequest<HostEvent.UpdateParameters>, context?: ContextType): Promise<any>;
 	protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
 	/**
 	 * Dispatches a host event using the appropriate channel:
@@ -11106,6 +11300,10 @@ interface SearchOptions$1 {
 	 */
 	searchQuery: string;
 }
+declare enum SpotterQueryMode {
+	FAST_SEARCH = "fastSearch",
+	RESEARCH = "research"
+}
 /**
  * Configuration for the Spotter sidebar.
  * Can be used in SpotterEmbed and AppEmbed.
@@ -11408,6 +11606,24 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
 	 * ```
 	 */
 	updatedSpotterChatPrompt?: boolean;
+	/**
+	 * Sets the default query mode when Spotter loads — Fast Search or
+	 * Research Mode. Applies fresh on every new session for this embed
+	 * instance only; it does not persist as a user preference and does
+	 * not affect other embeds or native ThoughtSpot usage.
+	 *
+	 * Supported embed types: `SpotterEmbed`, `AppEmbed`
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @default SpotterQueryMode.FAST_SEARCH
+	 * @example
+	 * ```js
+	 * const embed = new SpotterEmbed('#tsEmbed', {
+	 *    ... //other embed view config
+	 *    defaultQueryMode: SpotterQueryMode.RESEARCH,
+	 * })
+	 * ```
+	 */
+	defaultQueryMode?: SpotterQueryMode;
 	/**
 	 * Enables the stop answer generation button in the Spotter embed UI,
 	 * allowing users to interrupt an ongoing answer generation.
@@ -11546,6 +11762,12 @@ export interface SpotterVizStarterPrompt {
  *            { label: 'Tip', text: 'try asking about revenue by region' },
  *            { label: 'Tip', text: 'use natural language' },
  *        ],
+ *        // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ *        liveboardBrandName: 'Reports',
+ *        spotterBrandName: 'Analyst',
+ *        insightTileBrandName: 'Insight card',
+ *        insightTileViewPlanLabel: 'View plan',
+ *        insightTileLoaderText: 'Generating insight',
  *    },
  * })
  * ```
@@ -11602,6 +11824,34 @@ export interface SpotterVizConfig {
 	 * @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
 	 */
 	loaderTips?: SpotterVizLoaderTip[];
+	/**
+	 * Custom term used to replace "Liveboard" in the agent's responses.
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @default ''
+	 */
+	liveboardBrandName?: string;
+	/**
+	 * Custom term used to replace "Spotter" in the agent's responses.
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @default ''
+	 */
+	spotterBrandName?: string;
+	/**
+	 * Custom term used to replace "Insight tile" in the UI and in the agent's responses.
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @default ''
+	 */
+	insightTileBrandName?: string;
+	/**
+	 * Custom term used to replace "View plan" in the insight tile menu.
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 */
+	insightTileViewPlanLabel?: string;
+	/**
+	 * Custom loader text shown on the insight tile.
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 */
+	insightTileLoaderText?: string;
 }
 /**
  * A single tip shown in the SpotterViz loading state.
@@ -11649,7 +11899,11 @@ export declare enum Page {
 	/**
 	 *  Monitor Alerts Page
 	 */
-	Monitor = "monitor"
+	Monitor = "monitor",
+	/**
+	 * Collections listing page
+	 */
+	Collections = "collections"
 }
 declare enum DataPanelCustomColumnGroupsAccordionState$1 {
 	/**
@@ -12288,6 +12542,25 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * ```
 	 */
 	updatedSpotterChatPrompt?: boolean;
+	/**
+	 * Sets the default query mode when Spotter loads — Fast Search or
+	 * Research Mode. Applies fresh on every new session for this embed
+	 * instance only; it does not persist as a user preference and does
+	 * not affect other embeds or native ThoughtSpot usage.
+	 * Only applicable when navigating to Spotter within the app.
+	 *
+	 * Supported embed types: `AppEmbed`
+	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @default SpotterQueryMode.FAST_SEARCH
+	 * @example
+	 * ```js
+	 * const embed = new AppEmbed('#tsEmbed', {
+	 *    ... //other embed view config
+	 *    defaultQueryMode: SpotterQueryMode.RESEARCH,
+	 * })
+	 * ```
+	 */
+	defaultQueryMode?: SpotterQueryMode;
 	/**
 	 * Controls the visibility of the past conversations sidebar.
 	 *
@@ -12360,6 +12633,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 *            { label: 'Tip', text: 'try asking about revenue by region' },
 	 *            { label: 'Tip', text: 'use natural language' },
 	 *        ],
+	 *        // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 *        liveboardBrandName: 'Reports',
+	 *        spotterBrandName: 'Analyst',
+	 *        insightTileBrandName: 'Insight card',
+	 *        insightTileViewPlanLabel: 'View plan',
+	 *        insightTileLoaderText: 'Generating insight',
 	 *    },
 	 * })
 	 * ```
@@ -13062,6 +13341,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
 	 *            { label: 'Tip', text: 'try asking about revenue by region' },
 	 *            { label: 'Tip', text: 'use natural language' },
 	 *        ],
+	 *        // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 *        liveboardBrandName: 'Reports',
+	 *        spotterBrandName: 'Analyst',
+	 *        insightTileBrandName: 'Insight card',
+	 *        insightTileViewPlanLabel: 'View plan',
+	 *        insightTileLoaderText: 'Generating insight',
 	 *    },
 	 * })
 	 * ```