@thoughtspot/visual-embed-sdk 1.42.1-alpha.6 → 1.42.1

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

@@ -1201,7 +1201,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.
 	 */
@@ -1574,7 +1574,7 @@ export interface FrameParams {
 /**
  * The common configuration object for an embedded view.
  */
-export interface BaseViewConfig extends InterceptV2Flags {
+export interface BaseViewConfig {
 	/**
 	 * @hidden
 	 */
@@ -2632,7 +2632,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
@@ -3714,22 +3714,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
@@ -4017,7 +4002,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
@@ -4069,10 +4054,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",
@@ -4147,10 +4138,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
 	 */
@@ -4177,10 +4173,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",
@@ -4265,15 +4265,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
 	 */
@@ -4322,16 +4314,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
 	 */
@@ -4395,7 +4394,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:
@@ -4405,10 +4404,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
@@ -4426,9 +4429,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
@@ -4437,7 +4444,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:
@@ -4450,9 +4457,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
 	 */
@@ -4460,7 +4471,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:
@@ -4473,9 +4484,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
 	 */
@@ -4512,7 +4527,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"
 	 * })
@@ -4834,11 +4849,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
 	 */
@@ -4881,11 +4898,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
 	 */
@@ -4969,12 +4988,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
 	 */
@@ -5003,12 +5025,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
 	 */
@@ -6492,71 +6518,6 @@ export interface DefaultAppInitData {
 	hiddenListColumns: ListPageColumns[];
 	customActions: CustomAction[];
 }
-/**
- * Enum for the type of API intercepted
- */
-export 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;
-};
 /**
  * Enum for auth failure types. This is the parameter passed to the listner
  * of {@link AuthStatus.FAILURE}.
@@ -6665,8 +6626,7 @@ export declare enum UIPassthroughEvent {
 	GetDiscoverabilityStatus = "getDiscoverabilityStatus",
 	GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
 	GetAnswerConfig = "getAnswerPageConfig",
-	GetLiveboardConfig = "getPinboardPageConfig",
-	GetUnsavedAnswerTML = "getUnsavedAnswerTML"
+	GetLiveboardConfig = "getPinboardPageConfig"
 }
 export type UIPassthroughContractBase = {
 	[UIPassthroughEvent.PinAnswerToLiveboard]: {
@@ -6721,15 +6681,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"];
@@ -6755,9 +6706,9 @@ 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?: any): 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?: any): Promise<any>;
 	/**
 	 * Setter for the iframe element used for host events
 	 * @param {HTMLIFrameElement} iFrame - the iframe element to set
@@ -6766,7 +6717,7 @@ declare class HostEventClient {
 	triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
 	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
 	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>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT>>;
 }
 declare class TsEmbed {
 	/**
@@ -6885,7 +6836,6 @@ declare class TsEmbed {
 	 * work regardless of auth status
 	 */
 	private subscribeToNetworkEvents;
-	private messageEventListener;
 	/**
 	 * Subscribe to message events that depend on successful iframe setup
 	 */
@@ -6972,7 +6922,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
@@ -7079,7 +7028,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>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: any): Promise<TriggerResponse<PayloadT, HostEventT>>;
 	/**
 	 * Triggers an event to the embedded app, skipping the UI flow.
 	 * @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
@@ -8119,6 +8068,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
 	 *