@thoughtspot/visual-embed-sdk 1.42.1-alpha.7 → 1.42.3

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

@@ -393,30 +393,14 @@ export interface CustomCssVariables {
 	 * Background color of checkbox.
 	 */
 	"--ts-var-checkbox-background-color"?: string;
-	/**
-	 * Height of the tiles in the Liveboard.
-	 */
-	"--ts-var-viz-tile-height"?: string;
 	/**
 	 * Background color of the layout in the Liveboard.
 	 */
 	"--ts-var-liveboard-layout-background"?: string;
-	/**
-	 * Font color of the title of the layout in the Liveboard.
-	 */
-	"--ts-var-liveboard-layout-title-color"?: string;
-	/**
-	 * Font size of the title of the layout in the Liveboard.
-	 */
-	"--ts-var-liveboard-layout-title-fontsize"?: string;
 	/**
 	 * Background color of the header in the Liveboard.
 	 */
 	"--ts-var-liveboard-header-background"?: string;
-	/**
-	 * Font size of the header in the Liveboard.
-	 */
-	"--ts-var-liveboard-header-fontsize"?: string;
 	/**
 	 * Font color of the header in the Liveboard.
 	 */
@@ -447,12 +431,6 @@ export interface CustomCssVariables {
 	 * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
 	 */
 	"--ts-var-liveboard-group-padding"?: string;
-	/**
-	 * Padding of the title of the groups in the Liveboard.
-	 *
-	 * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
-	 */
-	"--ts-var-liveboard-group-title-padding"?: string;
 	/**
 	 * Font size of the title of the groups in the Liveboard.
 	 *
@@ -477,24 +455,6 @@ export interface CustomCssVariables {
 	 * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
 	 */
 	"--ts-var-liveboard-group-tile-title-font-weight"?: string;
-	/**
-	 * Font size of the description of the groups in the Liveboard.
-	 *
-	 * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
-	 */
-	"--ts-var-liveboard-group-description-font-size"?: string;
-	/**
-	 * Font weight of the description of the groups in the Liveboard.
-	 *
-	 * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
-	 */
-	"--ts-var-liveboard-group-description-font-weight"?: string;
-	/**
-	 * Border of the group tiles in the Liveboard.
-	 *
-	 * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
-	 */
-	"--ts-var-liveboard-group-tile-border"?: string;
 	/**
 	 * Padding of the group tiles in the Liveboard.
 	 *
@@ -615,14 +575,6 @@ export interface CustomCssVariables {
 	 * Font weight of the title of the tiles in the Liveboard.
 	 */
 	"--ts-var-liveboard-tile-title-fontweight"?: string;
-	/**
-	 * Font weight of the description of the tiles in the Liveboard.
-	 */
-	"--ts-var-liveboard-tile-description-font-weight"?: string;
-	/**
-	 * Opacity of the description of the tiles in the Liveboard.
-	 */
-	"--ts-var-liveboard-tile-description-opacity"?: string;
 	/**
 	 * Background color of the parameter chips in the Liveboard.
 	 */
@@ -1204,7 +1156,7 @@ export interface CustomisationsInterface {
  * if a trusted authentication server is used.
  * @group Authentication / Init
  */
-export interface EmbedConfig extends InterceptV2Flags {
+export interface EmbedConfig {
 	/**
 	 * The ThoughtSpot cluster hostname or IP address.
 	 */
@@ -1546,6 +1498,18 @@ export interface EmbedConfig extends InterceptV2Flags {
 	 * ```
 	 */
 	customActions?: CustomAction[];
+	/**
+	 * Wait for the cleanup to be completed before destroying the embed.
+	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+	 * @default false
+	 */
+	waitForCleanupOnDestroy?: boolean;
+	/**
+	 * The timeout for the cleanup to be completed before destroying the embed.
+	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+	 * @default 5000
+	 */
+	cleanupTimeout?: number;
 }
 export interface LayoutConfig {
 }
@@ -1577,7 +1541,7 @@ export interface FrameParams {
 /**
  * The common configuration object for an embedded view.
  */
-export interface BaseViewConfig extends InterceptV2Flags {
+export interface BaseViewConfig {
 	/**
 	 * @hidden
 	 */
@@ -2359,6 +2323,24 @@ export interface LiveboardAppEmbedViewConfig {
 	 * ```
 	 */
 	liveboardXLSXCSVDownload?: boolean;
+	/**
+	 * This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
+	 * When enabled, a unified modal is used to manage and update multiple filters at once,
+	 * replacing the older individual filter interactions.
+	 * To enable this feature on your instance, contact ThoughtSpot Support.
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+	 * @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    isCentralizedLiveboardFilterUXEnabled: true,
+	 * })
+	 * ```
+	 */
+	isCentralizedLiveboardFilterUXEnabled?: boolean;
 	/**
 	 * This flag is used to enable or disable the link parameters in liveboard.
 	 *
@@ -2374,6 +2356,21 @@ export interface LiveboardAppEmbedViewConfig {
 	 * ```
 	 */
 	isLinkParametersEnabled?: boolean;
+	/**
+	 * This flag is used to enable or disable the enhanced filter interactivity in liveboard.
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+	 * @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    isEnhancedFilterInteractivityEnabled: true,
+	 * })
+	 * ```
+	 */
+	isEnhancedFilterInteractivityEnabled?: boolean;
 }
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
 }
@@ -3584,7 +3581,7 @@ export declare enum EmbedEvent {
 	 * the table visualization.
 	 *
 	 * If the Row-Level Security (RLS) rules are applied on the
-	 * Worksheet or Model, exercise caution when changing column
+	 * Model, exercise caution when changing column
 	 * or table cell values to maintain data security.
 	 *
 	 * @example
@@ -3642,7 +3639,7 @@ export declare enum EmbedEvent {
 	 */
 	SpotterData = "SpotterData",
 	/**
-	 * Emitted when user opens up the worksheet preview modal in Spotter embed.
+	 * Emitted when user opens up the data source preview modal in Spotter embed.
 	 * @example
 	 * ```js
 	 * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
@@ -3729,22 +3726,7 @@ export declare enum EmbedEvent {
 	 * ```
 	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
 	 */
-	OrgSwitched = "orgSwitched",
-	/**
-	 * Emitted when the user intercepts a URL.
-	 *
-	 * Supported on all embed types.
-	 *
-	 * @example
-	 * ```js
-	 * embed.on(EmbedEvent.ApiIntercept, (payload) => {
-	 *     console.log('payload', payload);
-	 * })
-	 * ```
-	 *
-	 * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
-	 */
-	ApiIntercept = "ApiIntercept"
+	OrgSwitched = "orgSwitched"
 }
 /**
  * Event types that can be triggered by the host application
@@ -3882,9 +3864,7 @@ export declare enum HostEvent {
 	 */
 	Reload = "reload",
 	/**
-	 * Get iframe URL for the current embed view on the playground.
-	 * Developers can use this URL to embed a ThoughtSpot object
-	 * in apps like Salesforce or Sharepoint.
+	 * Get iframe URL for the current embed view.
 	 * @example
 	 * ```js
 	 * const url = embed.trigger(HostEvent.GetIframeUrl);
@@ -4956,7 +4936,7 @@ export declare enum HostEvent {
 	 */
 	EditLastPrompt = "EditLastPrompt",
 	/**
-	 * Opens the Worksheet preview modal in Spotter Embed.
+	 * Opens the data source preview modal in Spotter Embed.
 	 * @example
 	 * ```js
 	 * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
@@ -5037,7 +5017,16 @@ export declare enum HostEvent {
 	 * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
 	 * ```
 	 */
-	UpdateEmbedParams = "updateEmbedParams"
+	UpdateEmbedParams = "updateEmbedParams",
+	/**
+	 * Triggered when the embed is needed to be destroyed. This is used to clean up any embed related resources internally.
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.DestroyEmbed);
+	 * ```
+	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+	 */
+	DestroyEmbed = "EmbedDestroyed"
 }
 /**
  * ThoughtSpot application pages include actions and menu commands
@@ -5149,7 +5138,7 @@ export declare enum Action {
 	 */
 	SchedulesList = "schedule-list",
 	/**
-	 * The **Share** action on a Liveboard, Answer, or Worksheet.
+	 * The **Share** action on a Liveboard, Answer, or Model.
 	 * Allows users to share an object with other users and groups.
 	 * @example
 	 * ```js
@@ -5607,7 +5596,7 @@ export declare enum Action {
 	AnswerChartSwitcher = "answerChartSwitcher",
 	/**
 	 * The Favorites icon (*) for Answers,
-	 * Liveboard, and data objects like Worksheet, Model,
+	 * Liveboard, and data objects like Model,
 	 * Tables and Views.
 	 * Allows adding an object to the user's favorites list.
 	 * @example
@@ -6340,7 +6329,17 @@ export declare enum Action {
 	 * ```
 	 *  @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
 	 */
-	RemoveAttachment = "removeAttachment"
+	RemoveAttachment = "removeAttachment",
+	/**
+	 * The **Style panel** on a Liveboard.
+	 * Controls the visibility of the Liveboard style panel.
+	 * @example
+	 * ```js
+	 * hiddenActions: [Action.LiveboardStylePanel]
+	 * ```
+	 * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
+	 */
+	LiveboardStylePanel = "liveboardStylePanel"
 }
 declare enum ContextMenuTriggerOptions {
 	LEFT_CLICK = "left-click",
@@ -6493,68 +6492,6 @@ export interface DefaultAppInitData {
 	hiddenListColumns: ListPageColumns[];
 	customActions: CustomAction[];
 }
-declare enum InterceptedApiType {
-	/**
-	 * The apis that are use to get the metadata for the embed
-	 */
-	METADATA = "METADATA",
-	/**
-	 * The apis that are use to get the data for the embed
-	 */
-	ANSWER_DATA = "ANSWER_DATA",
-	/**
-	 * This will intercept all the apis
-	 */
-	ALL = "ALL",
-	/**
-	 * The apis that are use to get the data for the liveboard
-	 */
-	LIVEBOARD_DATA = "LIVEBOARD_DATA"
-}
-export type InterceptV2Flags = {
-	/**
-	 * Enable intercepting the apis
-	 *
-	 * @example
-	 * ```js
-	 * const embed = new LiveboardEmbed('#embed', {
-	 *   ...viewConfig,
-	 *   enableApiIntercept: true,
-	 *   interceptUrls: [InterceptedApiType.DATA],
-	 * })
-	 * ```
-	 *
-	 */
-	enableApiIntercept?: boolean;
-	/**
-	 * The apis to intercept
-	 *
-	 * @example
-	 * ```js
-	 * const embed = new LiveboardEmbed('#embed', {
-	 *   ...viewConfig,
-	 *   enableApiIntercept: true,
-	 *   interceptUrls: [InterceptedApiType.DATA],
-	 * })
-	 * ```
-	 */
-	interceptUrls?: (string | InterceptedApiType)[];
-	/**
-	 * The timeout for the intercept, default is 30000ms
-	 * the api will error out if the timeout is reached
-	 *
-	 * @example
-	 * ```js
-	 * const embed = new LiveboardEmbed('#embed', {
-	 *   ...viewConfig,
-	 *   enableApiIntercept: true,
-	 *   interceptUrls: [InterceptedApiType.ALL],
-	 *   interceptTimeout: 1000,
-	 * })
-	 * ```
-	 */
-	interceptTimeout?: number;
-};
 declare enum AuthFailureType {
 	SDK = "SDK",
 	NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
@@ -6650,8 +6587,7 @@ declare enum UIPassthroughEvent {
 	GetDiscoverabilityStatus = "getDiscoverabilityStatus",
 	GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
 	GetAnswerConfig = "getAnswerPageConfig",
-	GetLiveboardConfig = "getPinboardPageConfig",
-	GetUnsavedAnswerTML = "getUnsavedAnswerTML"
+	GetLiveboardConfig = "getPinboardPageConfig"
 }
 export type UIPassthroughContractBase = {
 	[UIPassthroughEvent.PinAnswerToLiveboard]: {
@@ -6706,15 +6642,6 @@ export type UIPassthroughContractBase = {
 		request: any;
 		response: any;
 	};
-	[UIPassthroughEvent.GetUnsavedAnswerTML]: {
-		request: {
-			sessionId?: string;
-			vizId?: string;
-		};
-		response: {
-			tml: string;
-		};
-	};
 };
 export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
 export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
@@ -6870,7 +6797,6 @@ declare class TsEmbed {
 	 * work regardless of auth status
 	 */
 	private subscribeToNetworkEvents;
-	private messageEventListener;
 	/**
 	 * Subscribe to message events that depend on successful iframe setup
 	 */
@@ -6957,7 +6883,6 @@ declare class TsEmbed {
 	 * @param height The height in pixels
 	 */
 	protected setIFrameHeight(height: number | string): void;
-	protected createEmbedEventResponder: (eventPort: MessagePort | void, eventType: EmbedEvent) => (payload: any) => void;
 	/**
 	 * Executes all registered event handlers for a particular event type
 	 * @param eventType The event type
@@ -7687,12 +7612,12 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
 	 */
 	hideSageAnswerHeader?: boolean;
 	/**
-	 * Disable the worksheet selection option.
+	 * Disable the data source selection option.
 	 * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
 	 */
 	disableWorksheetChange?: boolean;
 	/**
-	 * Hide the worksheet selection panel.
+	 * Hide the data source selection panel.
 	 * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
 	 */
 	hideWorksheetSelector?: boolean;
@@ -7710,7 +7635,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
 	showObjectSuggestions?: boolean;
 	/**
 	 * Show or hide sample questions.
-	 * The sample questions are autogenerated based on the worksheet
+	 * The sample questions are autogenerated based on the data Model.
 	 * selected for the search operation.
 	 *
 	 * Supported embed types: `SageEmbed`
@@ -7725,7 +7650,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
 	 */
 	hideSampleQuestions?: boolean;
 	/**
-	 * The data source GUID (Worksheet GUID) to set on load.
+	 * The data source GUID (Model GUID) to set on load.
 	 */
 	dataSource?: string;
 	/**
@@ -8100,6 +8025,26 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * ```
 	 */
 	tag?: string;
+	/**
+	 * Hide tag filter chips that appear when content is filtered by tags.
+	 * When enabled, this automatically:
+	 * - Hides tag filter indicators/chips from the UI
+	 *
+	 * This provides a clean interface without tag-related UI elements.
+	 *
+	 * Supported embed types: `AppEmbed`
+	 * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
+	 * @example
+	 * ```js
+	 * // Simple usage - automatically hides all tag-related UI
+	 * const embed = new AppEmbed('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    tag: 'Some Tag',
+	 *    hideTagFilterChips: true, // This is all you need!
+	 * });
+	 * ```
+	 */
+	hideTagFilterChips?: boolean;
 	/**
 	 * The array of GUIDs to be hidden
 	 *
@@ -8841,7 +8786,7 @@ declare class LiveboardEmbed extends V1Embed {
  */
 export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
 	/**
-	 * The ID of the worksheet to use for the conversation.
+	 * The ID of the Model to use for the conversation.
 	 */
 	worksheetId: string;
 }
@@ -9025,6 +8970,22 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
 	 * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
 	 */
 	excludeRuntimeParametersfromURL?: boolean;
+	/**
+	 * enablePastConversationsSidebar : Controls the visibility of the past conversations
+	 * sidebar.
+	 *
+	 * Supported embed types: `SpotterEmbed`
+	 * @default false
+	 * @example
+	 * ```js
+	 * const embed = new SpotterEmbed('#tsEmbed', {
+	 *    ... //other embed view config
+	 *    enablePastConversationsSidebar : true,
+	 * })
+	 * ```
+	 * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+	 */
+	enablePastConversationsSidebar?: boolean;
 }
 /**
  * The configuration for the embedded spotterEmbed options.