@thoughtspot/visual-embed-sdk 1.44.0 → 1.44.1-test

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

@@ -1490,7 +1490,7 @@ export interface EmbedConfig {
 	 *     {
 	 *       name: 'customAction',
 	 *       id: 'customAction',
-	 *       target: CustomActionTarget.VISUALIZATION,
+	 *       target: CustomActionTarget.VIZ,
 	 *       position: CustomActionPosition.PRIMARY,
 	 *       }
 	 *     }
@@ -1881,8 +1881,12 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed`
 	 * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
 	 * @example
-	 * ```js
-	 * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
+	 * ```ts
+	 * import {
+	 *   CustomActionPayload,
+	 *   CustomActionPosition,
+	 *   CustomActionTarget,
+	 * } from '@thoughtspot/visual-embed-sdk';
 	 * // Use supported embed types such as AppEmbed or LiveboardEmbed
 	 * const embed = new LiveboardEmbed('#tsEmbed', {
 	 *   ... // other embed config options
@@ -1890,12 +1894,17 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	 *     {
 	 *       name: 'customAction',
 	 *       id: 'customAction',
-	 *       target: CustomActionTarget.VISUALIZATION,
+	 *       target: CustomActionTarget.VIZ,
 	 *       position: CustomActionPosition.PRIMARY,
 	 *       }
 	 *     }
 	 *   ]
 	 * })
+	 *
+	 * // to trigger a custom flow on custom action click listen to Custom action embed event
+	 * embed.on(EmbedEvent.CustomAction, (payload: CustomActionPayload) => {
+	 *   console.log('Custom Action event:', payload);
+	 * })
 	 * ```
 	 */
 	customActions?: CustomAction[];
@@ -2373,6 +2382,38 @@ export interface LiveboardAppEmbedViewConfig {
 	 * ```
 	 */
 	isEnhancedFilterInteractivityEnabled?: boolean;
+	/**
+	 * Show or hide masked filter chips
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+	 * @version SDK: 1.45.0 | Thoughtspot: 26.2.0.cl
+	 * @default false
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    showMaskedFilterChip: true,
+	 * })
+	 * ```
+	 */
+	showMaskedFilterChip?: boolean;
+	/**
+	 * Enable or disable Liveboard styling and grouping
+	 *
+	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+	 * @version SDK: 1.45.0 | Thoughtspot: 26.2.0.cl
+	 * @default false
+	 * @example
+	 * ```js
+	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+	 * const embed = new <EmbedComponent>('#tsEmbed', {
+	 *    ... // other embed view config
+	 *    isLiveboardMasterpiecesEnabled: true,
+	 * })
+	 * ```
+	 */
+	isLiveboardMasterpiecesEnabled?: boolean;
 }
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
 }
@@ -2784,6 +2825,7 @@ export declare enum EmbedEvent {
 	 * SearchEmbed.on(EmbedEvent.Error, (error) => {
 	 *   console.log(error);
 	 *  // { type: "Error", data: { errorType: "API", error: { message: '...', error: '...' } } }
+	 *  // { errorType: "API", message: '...', code: '...' } new format
 	 * });
 	 * ```
 	 * @example
@@ -2795,6 +2837,7 @@ export declare enum EmbedEvent {
 	 *   //   message: "Fullscreen API is not enabled",
 	 *   //   stack: "..."
 	 *   // } }}
+	 *   // { errorType: "FULLSCREEN", message: "Fullscreen API is not enabled", code: '...' } new format
 	 * })
 	 * ```
 	 */
@@ -2950,7 +2993,8 @@ export declare enum EmbedEvent {
 	 */
 	ALL = "*",
 	/**
-	 * Emitted when an Answer is saved in the app
+	 * Emitted when an Answer is saved in the app.
+	 * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
 	 * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
 	 * @example
 	 *```js
@@ -2985,6 +3029,7 @@ export declare enum EmbedEvent {
 	Download = "download",
 	/**
 	 * Emitted when the download action is triggered on an Answer.
+	 *  Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
 	 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
 	 * @example
 	 *```js
@@ -2999,6 +3044,7 @@ export declare enum EmbedEvent {
 	DownloadAsPng = "downloadAsPng",
 	/**
 	 * Emitted when the Download as PDF action is triggered on an Answer
+	 *  Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.
 	 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
 	 * @example
 	 *```js
@@ -3013,6 +3059,7 @@ export declare enum EmbedEvent {
 	DownloadAsPdf = "downloadAsPdf",
 	/**
 	 * Emitted when the Download as CSV action is triggered on an Answer.
+	 *  Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.
 	 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
 	 * @example
 	 *```js
@@ -3027,6 +3074,7 @@ export declare enum EmbedEvent {
 	DownloadAsCsv = "downloadAsCsv",
 	/**
 	 * Emitted when the Download as XLSX action is triggered on an Answer.
+	 *  Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.
 	 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
 	 * @example
 	 *```js
@@ -3041,6 +3089,7 @@ export declare enum EmbedEvent {
 	DownloadAsXlsx = "downloadAsXlsx",
 	/**
 	 * Emitted when an Answer is deleted in the app
+	 *  Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
 	 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
 	 * @example
 	 *```js
@@ -3067,6 +3116,7 @@ export declare enum EmbedEvent {
 	/**
 	 * Emitted when a user initiates the Pin action to
 	 *  add an Answer to a Liveboard.
+	 *  Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
 	 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
 	 * @example
 	 *```js
@@ -3180,6 +3230,7 @@ export declare enum EmbedEvent {
 	/**
 	 * Emitted when the **Export TML** action is triggered on an
 	 * an embedded object in the app
+	 *  Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
 	 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
 	 * @example
 	 *```js
@@ -3205,6 +3256,7 @@ export declare enum EmbedEvent {
 	SaveAsView = "saveAsView",
 	/**
 	 * Emitted when the user creates a copy of an Answer.
+	 *  Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.
 	 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
 	 * @example
 	 *```js
@@ -6509,7 +6561,47 @@ export declare enum Action {
 	 * ```
 	 * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
 	 */
-	LiveboardStylePanel = "liveboardStylePanel"
+	LiveboardStylePanel = "liveboardStylePanel",
+	/**
+	 * The **Move to Group** menu action on a Liveboard.
+	 * Allows moving a visualization to a different group.
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.MoveToGroup]
+	 * ```
+	 * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	MoveToGroup = "moveToGroup",
+	/**
+	 * The **Move out of Group** menu action on a Liveboard.
+	 * Allows moving a visualization out of a group.
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.MoveOutOfGroup]
+	 * ```
+	 * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	MoveOutOfGroup = "moveOutOfGroup",
+	/**
+	 * The **Create Group** menu action on a Liveboard.
+	 * Allows creating a new group.
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.CreateGroup]
+	 * ```
+	 * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	CreateGroup = "createGroup",
+	/**
+	 * The **Ungroup Liveboard Group** menu action on a Liveboard.
+	 * Allows ungrouping a liveboard group.
+	 * @example
+	 * ```js
+	 * disabledActions: [Action.UngroupLiveboardGroup]
+	 * ```
+	 * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
+	 */
+	UngroupLiveboardGroup = "ungroupLiveboardGroup"
 }
 export declare enum PrefetchFeatures {
 	FullApp = "FullApp",
@@ -6652,6 +6744,109 @@ declare enum LogLevel {
 	 */
 	TRACE = "TRACE"
 }
+declare enum ErrorDetailsTypes {
+	/** API call failure */
+	API = "API",
+	/** General validation error */
+	VALIDATION_ERROR = "VALIDATION_ERROR",
+	/** Network connectivity or request error */
+	NETWORK = "NETWORK"
+}
+declare enum EmbedErrorCodes {
+	/** Worksheet ID not found or does not exist */
+	WORKSHEET_ID_NOT_FOUND = "WORKSHEET_ID_NOT_FOUND",
+	/** Required Liveboard ID is missing from configuration */
+	LIVEBOARD_ID_MISSING = "LIVEBOARD_ID_MISSING",
+	/** Conflicting action configuration detected (e.g., both hiddenActions and visibleActions specified) */
+	CONFLICTING_ACTIONS_CONFIG = "CONFLICTING_ACTIONS_CONFIG",
+	/** Conflicting tab configuration detected (e.g., both hiddenTabs and visibleTabs specified) */
+	CONFLICTING_TABS_CONFIG = "CONFLICTING_TABS_CONFIG",
+	/** Error during component initialization */
+	INIT_ERROR = "INIT_ERROR",
+	/** Network connectivity or request error */
+	NETWORK_ERROR = "NETWORK_ERROR",
+	/** Custom action validation failed */
+	CUSTOM_ACTION_VALIDATION = "CUSTOM_ACTION_VALIDATION",
+	/** Authentication/login failed */
+	LOGIN_FAILED = "LOGIN_FAILED",
+	/** Render method was not called before attempting to use the component */
+	RENDER_NOT_CALLED = "RENDER_NOT_CALLED",
+	/** Host event type is undefined or invalid */
+	HOST_EVENT_TYPE_UNDEFINED = "HOST_EVENT_TYPE_UNDEFINED",
+	/** Error parsing api intercept body */
+	PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR"
+}
+/**
+ * Error event object emitted when an error occurs in an embedded component.
+ *
+ * This interface defines the structure of error objects returned by the {@link EmbedEvent.Error}
+ * event. It provides detailed information about what went wrong, including the error type,
+ * a human-readable message, and a machine-readable error code.
+ *
+ * ## Properties
+ *
+ * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
+ * - **message**: Human-readable error description (string or array of strings for multiple errors)
+ * - **code**: Machine-readable error identifier for programmatic handling
+ * - **[key: string]**: Additional context-specific for backward compatibility
+ *
+ * ## Usage
+ *
+ * Listen to the {@link EmbedEvent.Error} event to receive instances of this object
+ * and implement appropriate error handling logic based on the `errorType`.
+ *
+ * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
+ * @group Error Handling
+ * @see {@link ErrorDetailsTypes} - Available error type values
+ * @see {@link EmbedEvent.Error} - The event that emits this object
+ *
+ * @example
+ * Handle specific error types
+ *
+ * embed.on(EmbedEvent.Error, (error) => {
+ *   switch (error.code) {
+ *     case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
+ *       console.error('Worksheet ID not found:', error.message, error.code);
+ *       break;
+ *     default:
+ *       console.error('Unknown error:', error);
+ *   }
+ * });
+ *  *
+ * @example
+ * Handle multiple error messages
+ *
+ * embed.on(EmbedEvent.Error, (error) => {
+ *   const messages = Array.isArray(error.message)
+ *     ? error.message
+ *     : [error.message];
+ *
+ *   messages.forEach(msg => console.error(msg));
+ * });
+ *  *
+ * @example
+ * Access additional error context
+ *
+ * embed.on(EmbedEvent.Error, (error) => {
+ *   console.error('Error Details:', {
+ *     type: error.errorType,
+ *     message: error.message,
+ *     code: error.code,
+ *     // Additional context fields vary by error type
+ *     ...error
+ *   });
+ * });
+ *  */
+export interface EmbedErrorDetailsEvent {
+	/** The type of error that occurred */
+	errorType: ErrorDetailsTypes;
+	/** Human-readable error message(s) describing what went wrong */
+	message: string | string[];
+	/** Machine-readable error code for programmatic error handling */
+	code: EmbedErrorCodes;
+	/** Additional context-specific for backward compatibility */
+	[key: string]: any;
+}
 export interface DefaultAppInitData {
 	customisations: CustomisationsInterface;
 	authToken: string;
@@ -7017,8 +7212,9 @@ declare class TsEmbed {
 	/**
 	 * Handles errors within the SDK
 	 * @param error The error message or object
+	 * @param errorDetails The error details
 	 */
-	protected handleError(error: string | Record<string, unknown>): void;
+	protected handleError(errorDetails: EmbedErrorDetailsEvent): void;
 	/**
 	 * Extracts the type field from the event payload
 	 * @param event The window message event
@@ -8544,6 +8740,23 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
 	 */
 	updatedSpotterChatPrompt?: boolean;
+	/**
+	 * This is the minimum height (in pixels) for a full-height App.
+	 * Setting this height helps resolve issues with empty Apps and
+	 * other screens navigable from an App.
+	 *
+	 * @version SDK: 1.44.2 | ThoughtSpot: 26.0.2.cl
+	 * @default 500
+	 * @example
+	 * ```js
+	 * const embed = new AppEmbed('#embed', {
+	 *   ... // other app view config
+	 *   fullHeight: true,
+	 *   minimumHeight: 600,
+	 * });
+	 * ```
+	 */
+	minimumHeight?: number;
 }
 declare class AppEmbed extends V1Embed {
 	protected viewConfig: AppViewConfig;
@@ -8650,6 +8863,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
 	 * Supported embed types: `LiveboardEmbed`
 	 * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
 	 * @default 500
+	 * @deprecated Use `minimumHeight` instead.
 	 * @example
 	 * ```js
 	 * const embed = new LiveboardEmbed('#embed', {
@@ -8660,6 +8874,23 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
 	 * ```
 	 */
 	defaultHeight?: number;
+	/**
+	 * This is the minimum height (in pixels) for a full-height Liveboard.
+	 * Setting this height helps resolve issues with empty Liveboards and
+	 * other screens navigable from a Liveboard.
+	 *
+	 * @version SDK: 1.44.2 | ThoughtSpot: 26.0.2.cl
+	 * @default 500
+	 * @example
+	 * ```js
+	 * const embed = new LiveboardEmbed('#embed', {
+	 *   ... // other liveboard view config
+	 *   fullHeight: true,
+	 *   minimumHeight: 600,
+	 * });
+	 * ```
+	 */
+	minimumHeight?: number;
 	/**
 	 * @Deprecated If set to true, the context menu in visualizations will be enabled.
 	 * @example
@@ -9362,6 +9593,13 @@ export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter;
  * @group Global methods
  */
 export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
+/**
+ * Reloads the ThoughtSpot iframe.
+ * @param iFrame
+ * @group Global methods
+ * @version SDK: 1.43.1
+ */
+export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
 export type SessionInfo = {
 	releaseVersion: string;
 	userGUID: string;