@thoughtspot/visual-embed-sdk 1.42.0 → 1.42.1-HE2.0

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

@@ -2359,6 +2359,21 @@ export interface LiveboardAppEmbedViewConfig {
 	 * ```
 	 */
 	liveboardXLSXCSVDownload?: boolean;
+	/**
+	 * This flag is used to enable or disable the link parameters in liveboard.
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+	 * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    isLinkParametersEnabled: true,
+	 * })
+	 * ```
+	 */
+	isLinkParametersEnabled?: boolean;
 }
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
 }
@@ -2632,7 +2647,7 @@ export declare enum EmbedEvent {
 	 */
 	Load = "load",
 	/**
-	 * Data pertaining to an Answer or Liveboard is received.
+	 * Data pertaining to an Answer, Liveboard or Spotter visualization is received.
 	 * The event payload includes the raw data of the object.
 	 * @return data -  Answer of Liveboard data
 	 * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
@@ -4002,7 +4017,7 @@ export declare enum HostEvent {
 	 * the following parameters:
 	 *
 	 * @param
-	 * `vizId`-  GUID of the saved Answer or visualization to pin to a Liveboard.
+	 * `vizId`-  GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
 	 *  Optional when pinning a new chart or table generated from a Search query.
 	 *  **Required** in Spotter Embed.
 	 * @param
@@ -4054,10 +4069,16 @@ export declare enum HostEvent {
 	 * ```
 	 * @example
 	 * ```js
-	 * const pinResponse = await spotterEmbed.trigger(HostEvent.Pin, {
-	 *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-	 *  });
-	 * ```
+
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
+	* ```
+	 *
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
 	 */
 	Pin = "pin",
@@ -4132,10 +4153,15 @@ export declare enum HostEvent {
 	 * ```
 	 * @example
 	 * ```js
-	 * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
-	 *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-	 *  });
-	 * ```
+
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
+	* ```
 	 *
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
 	 */
@@ -4162,10 +4188,14 @@ export declare enum HostEvent {
 	 * ```
 	 * @example
 	 * ```js
-	 * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
-	 *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-	 *  });
-	 * ```
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
+	* ```
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
 	 */
 	MakeACopy = "makeACopy",
@@ -4250,15 +4280,7 @@ export declare enum HostEvent {
 	 * ```
 	 * @example
 	 * ```js
-	 * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {
-	 *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-	 *  });
-	 * ```
-	 * @example
-	 * ```js
-	 * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
-	 *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-	 *  });
+	 * spotterEmbed.trigger(HostEvent.Edit);
 	 * ```
 	 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
 	 */
@@ -4307,16 +4329,23 @@ export declare enum HostEvent {
 	 *   );
 	 * })
 	 * ```
-	 * @example
+	 * * @example
 	 * ```js
-	 * spotterEmbed.trigger(HostEvent.GetTML, {
-	 *   vizId: '730496d6-6903-4601-937e-2c691821af3c'
+
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.GetTML, {
+	 *   vizId: latestSpotterVizId
 	 * }).then((tml) => {
 	 *   console.log(
 	 *      tml.answer.search_query // TML representation of the search query
 	 *   );
 	 * })
-	 * ```
+	* ```
 	 * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
 	 * @important
 	 */
@@ -4380,7 +4409,7 @@ export declare enum HostEvent {
 	/**
 	 * Trigger the **Download** action on charts in
 	 * the embedded view.
-	 * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+	 * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
 	 * @example
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -4390,10 +4419,14 @@ export declare enum HostEvent {
 	 * embed.trigger(HostEvent.Download)
 	 * ```
 	 * ```js
-	 * spotterEmbed.trigger(HostEvent.Download, {
-	 *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-	 *  });
-	 * ```
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
+	* ```
 	 * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
 	 * Use {@link DownloadAsPng}
 	 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -4411,9 +4444,13 @@ export declare enum HostEvent {
 	 *
 	 * searchEmbed.trigger(HostEvent.DownloadAsPng)
 	 *
-	 * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
-	 *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-	 * })
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
 	 * ```
 	 *
 	 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
@@ -4422,7 +4459,7 @@ export declare enum HostEvent {
 	/**
 	 * Trigger the **Download** > **CSV**  action on tables in
 	 * the embedded view.
-	 * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+	 * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
 	 * @example
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -4435,9 +4472,13 @@ export declare enum HostEvent {
 	 * searchEmbed.trigger(HostEvent.DownloadAsCsv)
 	 * ```
 	 * ```js
-	 * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
-	 *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-	 * })
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
 	 * ```
 	 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
 	 */
@@ -4445,7 +4486,7 @@ export declare enum HostEvent {
 	/**
 	 * Trigger the **Download** > **XLSX**  action on tables
 	 * in the embedded view.
-	 * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+	 * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
 	 * @example
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -4458,9 +4499,13 @@ export declare enum HostEvent {
 	 * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
 	 * ```
 	 * ```js
-	 * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
-	 *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-	 * })
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
 	 * ```
 	 * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
 	 */
@@ -4497,7 +4542,7 @@ export declare enum HostEvent {
 	 * ```
 	 *
 	 * ```js
-	 * // Save an Answer in Spotter (requires vizId)
+	 * // Save a Visualization in Spotter (requires vizId)
 	 * spotterEmbed.trigger(HostEvent.Save, {
 	 *   vizId: "730496d6-6903-4601-937e-2c691821af3c"
 	 * })
@@ -4819,11 +4864,13 @@ export declare enum HostEvent {
 	 * });
 	 *```
 	 *```js
-	 * spotterEmbed.trigger(HostEvent.GetParameters, {
-	 *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
-	 * }).then((parameter) => {
-	 *  console.log('parameters', parameter);
-	 * });
+	* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
+	* let latestSpotterVizId = '';
+	* spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	*   latestSpotterVizId = payload.data.id;
+	* });
+	*
+	* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
 	 *```
 	 * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
 	 */
@@ -4866,11 +4913,13 @@ export declare enum HostEvent {
 	 * ```
 	 * @example
 	 * ```js
-	 * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
-	 *      vizId: '730496d6-6903-4601-937e-2c691821af3c',
-	 *      name: "Sales by states",
-	 *      description: "Total sales by states in MidWest"
+	 * // You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event.
+	 * let latestSpotterVizId = '';
+	 * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	 *   latestSpotterVizId = payload.data.id;
 	 * });
+	*
+	* spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
 	 * ```
 	 * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
 	 */
@@ -4954,12 +5003,15 @@ export declare enum HostEvent {
 	DeleteLastPrompt = "DeleteLastPrompt",
 	/**
 	 * Toggle the visualization to chart or table view.
-	 * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
+	 * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
 	 * @example
 	 * ```js
-	 * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
-	 *          vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
+	 * let latestSpotterVizId = '';
+	 * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	 *   latestSpotterVizId = payload.data.id;
 	 * });
+	*
+	* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
 	 *```
 	 * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
 	 */
@@ -4988,12 +5040,16 @@ export declare enum HostEvent {
 	 */
 	VisibleEmbedCoordinates = "visibleEmbedCoordinates",
 	/**
-	 * Trigger the *Ask Spotter* action for visualizations
-	 * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+	 * Trigger the *Spotter* action for visualizations present on the liveboard's vizzes.
+	 * @param - `vizId` refers to the Visualization ID in Spotter embed and is required.
 	 * @example
 	 * ```js
-	 * spotterEmbed.trigger(HostEvent.AskSpotter,
-	 * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+	 * let latestSpotterVizId = '';
+	 * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+	 *   latestSpotterVizId = payload.data.id;
+	 * });
+	*
+	* spotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId });
 	 * ```
 	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
 	 */
@@ -6626,9 +6682,16 @@ export type EmbedApiHostEventMapping = {
 	[HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
 };
 export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
-export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
+export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
 export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
-export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
+export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
+declare enum ContextType {
+	Search = "search",
+	Liveboard = "liveboard",
+	Answer = "answer",
+	Spotter = "spotter",
+	None = ""
+}
 declare class HostEventClient {
 	iFrame: HTMLIFrameElement;
 	constructor(iFrame?: HTMLIFrameElement);
@@ -6638,18 +6701,18 @@ declare class HostEventClient {
 	 * @param {any} data Data to send with the host event
 	 * @returns {Promise<any>} - the response from the process trigger
 	 */
-	protected processTrigger(message: HostEvent, data: any): Promise<any>;
+	protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
 	handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
-	hostEventFallback(hostEvent: HostEvent, data: any): Promise<any>;
+	hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
 	/**
 	 * Setter for the iframe element used for host events
 	 * @param {HTMLIFrameElement} iFrame - the iframe element to set
 	 */
 	setIframeElement(iFrame: HTMLIFrameElement): void;
 	triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
-	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
+	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
 	protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>): Promise<any>;
-	triggerHostEvent<HostEventT extends HostEvent, PayloadT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
 }
 declare class TsEmbed {
 	/**
@@ -6764,12 +6827,25 @@ declare class TsEmbed {
 	private formatEventData;
 	private subscribedListeners;
 	/**
+	 * Subscribe to network events (online/offline) that should
+	 * work regardless of auth status
+	 */
+	private subscribeToNetworkEvents;
+	/**
+	 * Subscribe to message events that depend on successful iframe setup
+	 */
+	private subscribeToMessageEvents;
+	/**
+	 * Adds event listeners for both network and message events.
+	 * This maintains backward compatibility with the existing method.
 	 * Adds a global event listener to window for "message" events.
 	 * ThoughtSpot detects if a particular event is targeted to this
 	 * embed instance through an identifier contained in the payload,
 	 * and executes the registered callbacks accordingly.
 	 */
 	private subscribeToEvents;
+	private unsubscribeToNetworkEvents;
+	private unsubscribeToMessageEvents;
 	private unsubscribeToEvents;
 	protected getAuthTokenForCookielessInit(): Promise<string>;
 	protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
@@ -6947,7 +7023,7 @@ declare class TsEmbed {
 	 * @param {any} data The payload to send with the message
 	 * @returns A promise that resolves with the response from the embedded app
 	 */
-	trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
 	/**
 	 * Triggers an event to the embedded app, skipping the UI flow.
 	 * @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
@@ -7983,6 +8059,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
 	 *
@@ -8695,7 +8791,7 @@ declare class LiveboardEmbed extends V1Embed {
 	 * @param {any} data The payload to send with the message
 	 * @returns A promise that resolves with the response from the embedded app
 	 */
-	trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
 	/**
 	 * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
 	 * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl