@thoughtspot/visual-embed-sdk 1.44.3 → 1.44.4

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

@@ -1056,56 +1056,70 @@ export declare enum AuthType {
 }
 /**
  *
- * This option does not apply to the classic homepage experience.
- * To access the updated modular homepage,
- * set `modularHomeExperience` to `true`
- * (available as Early Access feature in 9.12.5.cl).
+ * **Note**:  This attribute is not supported in the classic (V1) homepage experience.
  *
  */
 export declare enum HomeLeftNavItem {
 	/**
+	 * The *Search data* option in
+	 * the *Insights* left navigation panel.
 	 * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
 	 */
 	SearchData = "search-data",
 	/**
+	 * The *Home* menu option in
+	 * the *Insights* left navigation panel.
 	 * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
 	 */
 	Home = "insights-home",
 	/**
+	 * The *Liveboards* menu option in
+	 * the *Insights* left navigation panel.
 	 * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
 	 */
 	Liveboards = "liveboards",
 	/**
+	 * The *Answers* menu option in
+	 * the *Insights* left navigation panel.
 	 * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
 	 */
 	Answers = "answers",
 	/**
+	 * The *Monitor subscriptions* menu option in
+	 * the *Insights* left navigation panel.
 	 * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
 	 */
 	MonitorSubscription = "monitor-alerts",
 	/**
+	 * The *SpotIQ analysis* menu option in
+	 * the *Insights* left navigation panel.
 	 * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
 	 */
 	SpotIQAnalysis = "spotiq-analysis",
 	/**
+	 * The *Liveboard schedules* menu option in
+	 * the *Insights* left navigation panel.
 	 * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
 	 */
 	LiveboardSchedules = "liveboard-schedules",
 	/**
-	 * Create new options in the insights left navigation,
-	 * available when new navigation V3 is enabled.
+	 * The create option in the *Insights*
+	 * left navigation panel.
+	 * Available in the V3 navigation experience.
 	 * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
 	 */
 	Create = "create",
 	/**
-	 * Spotter option in the insights left navigation,
-	 * available when new navigation V3 is enabled.
+	 * The *Spotter* menu option in the *Insights*
+	 * left navigation panel.
+	 * Available in the V3 navigation experience.
 	 * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
 	 */
 	Spotter = "spotter",
 	/**
-	 * Favorites option in the insights left navigation,
-	 * available when new navigation V3 is enabled.
+	 * The *Favorites* section in the *Insights*
+	 * left navigation panel.
+	 * Available in the V3 navigation experience.
 	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
 	 */
 	Favorites = "favorites"
@@ -1968,11 +1982,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
  */
 export interface HomePageConfig {
 	/**
-	 * Hide list page columns
-	 * For example: hiddenListColumns = [ListPageColumns.Author]
+	 * Hide columns on list pages such as
+	 * *Liveboards* and *Answers*.
+	 * For example: `hiddenListColumns = [ListPageColumns.Author]`
 	 *
-	 * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
-	 * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page.
+	 * **Note**: This option is available only in full app embedding and requires importing the `ListPageColumns` enum.
+	 * Starting with version 10.14.0.cl, you can use this attribute to
+	 * hide the columns on all list pages in the *Insights* section.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
@@ -1988,13 +2004,11 @@ export interface HomePageConfig {
 	 */
 	hiddenListColumns?: ListPageColumns[];
 	/**
-	 * Hide the home page modules
-	 * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
+	 * Control the visibility of home page modules.
+	 * To specify the modules, import the `HomepageModule` enum.
+	 * For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
 	 *
-	 * **Note**: This option does not apply to the classic homepage.
-	 * To access the updated modular homepage, set
-	 * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
-	 * To use it, you need to import `HomepageModule` enum.
+	 * **Note**: This attribute is not supported in the classic (v1) experience.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -2003,20 +2017,18 @@ export interface HomePageConfig {
 	 * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
 	 *
 	 * const embed = new AppEmbed('#tsEmbed', {
-	 *    ... //other embed view config
+	 *    ... // V2/V3 navigation and home page experience attributes
 	 *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
+	 *    //...other embed view configuration attributes
 	 * })
 	 * ```
 	 */
 	hiddenHomepageModules?: HomepageModule[];
 	/**
-	 * reordering the home page modules
-	 * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
-	 *
-	 * **Note**: This option does not apply to the classic homepage.
-	 * To access the updated modular homepage, set
-	 * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
-	 * To use it, you need to import `HomepageModule` enum.
+	 * Reorder home page modules.
+	 * To specify the modules, import the `HomepageModule` enum.
+	 * For example: `reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]`
+	 * **Note**: This attribute is not supported in the classic (v1) homepage.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -2025,16 +2037,19 @@ export interface HomePageConfig {
 	 * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
 	 *
 	 * const embed = new AppEmbed('#tsEmbed', {
-	 *    ... //other embed view config
+	 *    ...//V2/V3 navigation and home page experience attributes
 	 *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
+	 *    //... other embed view configuration attributes
 	 * })
 	 * ```
 	 */
 	reorderedHomepageModules?: HomepageModule[];
 	/**
-	 * homepageLeftNavItems : Show or hide the left navigation bar items.
-	 * There are 8 eight home navigation list items.
-	 * To hide these items, specify the string in the array.
+	 * Controls the visibility of the menu items
+	 * on the home page left navigation panel.
+	 * To specify the menu items, import the `HomeLeftNavItem` enum.
+	 *
+	 * **Note**: This attribute is not supported in the classic (v1) homepage.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @example
@@ -2042,15 +2057,11 @@ export interface HomePageConfig {
 	 * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
 	 *
 	 * const embed = new AppEmbed('#tsEmbed', {
-	 *    ... //other embed view config
+	 *    //... V2/V3 experience attributes
 	 *    hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
+	 *    ... //other embed view configuration attributes
 	 * })
 	 * ```
-	 *
-	 * **Note**: This option does not apply to the classic homepage.
-	 * To access the updated modular homepage, set
-	 * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
-	 * To use it, you need to import `HomeLeftNavItem` enum.
 	 * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
 	 */
 	hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -2568,10 +2579,11 @@ export declare enum RuntimeFilterOp {
 	NOT_IN = "NOT_IN"
 }
 /**
- * Home page module that can be hidden.
- * **Note**: This option does not apply to the classic homepage.
- * To access the updated modular homepage, set
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+ * Home page modules that can be hidden
+ * via `hiddenHomepageModules` and reordered via
+ * `reorderedHomepageModules`.
+ *
+ * **Note**: This option is not supported in the classic (v1) experience.
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
  */
 export declare enum HomepageModule {
@@ -2584,7 +2596,7 @@ export declare enum HomepageModule {
 	 */
 	Watchlist = "WATCHLIST",
 	/**
-	 * favorite objects
+	 * Favorite module
 	 */
 	Favorite = "FAVORITE",
 	/**
@@ -3772,6 +3784,28 @@ export declare enum EmbedEvent {
 	 * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
 	 */
 	PreviewSpotterData = "PreviewSpotterData",
+	/**
+	 * Emitted when user opens up the Add to Coaching modal on any visualization in Spotter Embed.
+	 * @example
+	 * ```js
+	 * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
+	 *     console.log('payload', payload);
+	 * })
+	 *```
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+	 */
+	AddToCoaching = "addToCoaching",
+	/**
+	 * Emitted when user opens up the data model instructions modal in Spotter embed.
+	 * @example
+	 * ```js
+	 * spotterEmbed.on(EmbedEvent.DataModelInstructions, (payload) => {
+	 *     console.log('payload', payload);
+	 * })
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+	 */
+	DataModelInstructions = "DataModelInstructions",
 	/**
 	 * Emitted when the Spotter query is triggered in Spotter embed.
 	 * @example
@@ -5195,6 +5229,26 @@ export declare enum HostEvent {
 	 * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
 	 */
 	PreviewSpotterData = "PreviewSpotterData",
+	/**
+	 * Opens the Add to Coaching modal from a visualization in Spotter Embed.
+	 * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
+	 * @example
+	 * ```js
+	 * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
+	 *
+	 *```
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+	 */
+	AddToCoaching = "addToCoaching",
+	/**
+	 * Opens the data model instructions modal in Spotter Embed.
+	 * @example
+	 * ```js
+	 * spotterEmbed.trigger(HostEvent.DataModelInstructions);
+	 * ```
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+	 */
+	DataModelInstructions = "DataModelInstructions",
 	/**
 	 * Resets the Spotter Embed Conversation.
 	 * @example
@@ -6843,7 +6897,19 @@ export declare enum LogLevel {
 	 */
 	TRACE = "TRACE"
 }
-declare enum ErrorDetailsTypes {
+/**
+ * Error types emitted by embedded components.
+ *
+ * These enum values categorize different types of errors that can occur during
+ * the lifecycle of an embedded ThoughtSpot component. Use these values to implement
+ * specific error handling logic based on the error category.
+ *
+ * @see {@link EmbedErrorDetailsEvent} - The error event object structure
+ * @see {@link EmbedEvent.Error} - The event that emits these errors
+ * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
+ * @group Error Handling
+ */
+export declare enum ErrorDetailsTypes {
 	/** API call failure */
 	API = "API",
 	/** General validation error */
@@ -6851,7 +6917,40 @@ declare enum ErrorDetailsTypes {
 	/** Network connectivity or request error */
 	NETWORK = "NETWORK"
 }
-declare enum EmbedErrorCodes {
+/**
+ * Specific error codes for embedded component errors.
+ *
+ * These codes provide granular identification of errors that occur in embedded components.
+ * They are returned in the {@link EmbedErrorDetailsEvent.code} property and allow for
+ * precise error handling and debugging.
+ *
+ * The codes are organized into categories:
+ * - **Worksheet ID not found or does not exist**: Errors related to applying or updating filters
+ * - **Liveboard ID missing**: Errors related to missing liveboard ID
+ * - **Conflicting actions configuration**: Errors related to conflicting actions configuration
+ * - **Conflicting tabs configuration**: Errors related to conflicting tabs configuration
+ * - **Initialization error**: Errors related to initialization error
+ * - **Network error**: Errors related to network error
+ * - **Custom action validation**: Errors related to custom action validation
+ * - **Login failed**: Errors related to login failed
+ * - **Render not called**: Errors related to render not called
+ * - **Host event type undefined or invalid**: Errors related to host event type undefined or invalid
+ *
+ * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
+ * @group Error Handling
+ * @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
+ * @see {@link ErrorDetailsTypes} - General error type categories
+ *
+ * @example
+ * Handle specific error codes
+ *
+ * embed.on(EmbedEvent.Error, (error) => {
+ *   if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {
+ *     console.error('Worksheet ID not found:', error.message);
+ *   }
+ * });
+ *  */
+export 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 */
@@ -6873,7 +6972,9 @@ declare enum EmbedErrorCodes {
 	/** 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"
+	PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
+	/** Failed to update embed parameters during pre-render */
+	UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
 }
 /**
  * Error event object emitted when an error occurs in an embedded component.
@@ -7296,7 +7397,7 @@ declare class TsEmbed {
 	 * @param query
 	 */
 	protected getEmbedBasePath(query: string): string;
-	protected getUpdateEmbedParamsObject(): Record<any, any>;
+	protected getUpdateEmbedParamsObject(): Promise<Record<any, any>>;
 	/**
 	 * Common query params set for all the embed modes.
 	 * @param queryParams
@@ -7724,14 +7825,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	showPrimaryNavbar?: boolean;
 	/**
-	 * Control the visibility of the left navigation bar on the Homepage.
-	 * If showPrimaryNavbar is true, that is, if the Global and Homepage
-	 * nav-bars are visible, this flag will only hide the homepage left nav-bar.
-	 * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
+	 * Control the visibility of the left navigation panel on the home page
+	 * in the V2 and V3 navigation and home page experience.
+	 * If `showPrimaryNavbar` is true, that is, if the Global and Homepage
+	 * navigation bars are visible, this flag will only hide the left navigation bar
+	 * on the home page.
+	 * The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
 	 *
-	 * **Note**: This option does not apply to the classic homepage.
-	 * To access the updated modular homepage, set
-	 * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+	 * **Note**: This attribute is not supported in the classic (V1) experience.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @default false
@@ -7746,8 +7847,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	hideHomepageLeftNav?: boolean;
 	/**
-	 * Control the visibility of the help (?) and profile buttons on the
-	 * Global nav-bar. By default, these buttons are visible on the nav-bar.
+	 * Control the visibility of the help (?) and profile
+	 * buttons on the top navigation bar.
+	 * These buttons are visible if the
+	 * navigation bar is not hidden via `showPrimaryNavbar`.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @default false
@@ -7764,7 +7867,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	/**
 	 * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
 	 * @default true
-	 * Whether the help menu in the top nav bar should be served
+	 * Whether the help menu in the top navigation bar should be served
 	 * from Pendo or ThoughtSpot's internal help items.
 	 *
 	 * Supported embed types: `AppEmbed`
@@ -7778,8 +7881,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	enablePendoHelp?: boolean;
 	/**
-	 * Control the visibility of the hamburger icon on the top nav bar
-	 * available when new navigation V3 is enabled.
+	 * Control the visibility of the hamburger icon on
+	 * the top navigation bar in the V3 navigation experience.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @default false
@@ -7794,8 +7897,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	hideHamburger?: boolean;
 	/**
-	 * Control the visibility of the Eureka search on the top nav bar
-	 * this will control for both new V2 and new navigation V3.
+	 * Control the visibility of the object search
+	 * on the top navigation bar in the
+	 * V2 and V3 navigation experience.
+	 *
+	 * **Note**: This attribute is not supported
+	 * in the classic (V1) experience.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @default true
@@ -7810,8 +7917,11 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	hideObjectSearch?: boolean;
 	/**
-	 * Control the visibility of the notification on the top nav bar V3,
-	 * available when new navigation V3 is enabled.
+	 * Control the visibility of the notification icon
+	 * on the top navigation bar in V3 navigation experience.
+	 *
+	 * **Note**: This attribute is not supported
+	 * in the classic (V1) and V2 experience modes.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @default true
@@ -7826,12 +7936,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	hideNotification?: boolean;
 	/**
-	 * Control the visibility of the application switcher button on the nav-bar.
-	 * By default, the application switcher is shown.
+	 * Control the visibility of the application selection menu
+	 * in the top navigation bar in the V2 experience.
+	 * In the V3 experience, it shows or hides application selection
+	 * icons on the left navigation panel.
+	 * By default, the application selection menu and icons are
+	 * shown in the UI
 	 *
-	 * **Note**: This option does not apply to the classic homepage.
-	 * To access the updated modular homepage, set
-	 * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+	 * **Note**: This attribute is not supported in the classic (V1) experience.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -7849,9 +7961,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * Control the visibility of the Org switcher button on the nav-bar.
 	 * By default, the Org switcher button is shown.
 	 *
-	 * **Note**: This option does not apply to the classic homepage.
-	 * To access the updated modular homepage, set
-	 * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+	 * **Note**: This attribute is not supported in the classic (V1) experience.
 	 *
 	 * Supported embed types: `AppEmbed`
 	 * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -8004,8 +8114,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	fullHeight?: boolean;
 	/**
-	 * Flag to control new Modular Home experience.
-	 *
+	 * Enables the V2 navigation and modular home page experience.
+	 * For more information,
+	 * see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
 	 * Supported embed types: `AppEmbed`
 	 * @default false
 	 * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -8019,18 +8130,20 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 */
 	modularHomeExperience?: boolean;
 	/**
-	 * To configure the top-left navigation and home page experience
-	 *
+	 * Configures the V3 navigation and home page experience.
+	 * For more information, see
+	 * link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
 	 * Supported embed types: `AppEmbed`
 	 * @default false
 	 * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
 	 * @example
 	 * ```js
 	 * const embed = new AppEmbed('#tsEmbed', {
-	 *    ... // other embed view config
+	 *    // Enable V3 navigation and home page experience
 	 *    discoveryExperience : {
-	 *      primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
-	 *      homePage: HomePage.Modular,
+	 *      primaryNavbarVersion: PrimaryNavbarVersion.Sliding, // Enable V3 navigation
+	 *      homePage: HomePage.ModularWithStylingChanges, // Enable V3 modular home page
+	 *      ... // other embed view config
 	 *    },
 	 * })
 	 * ```
@@ -8178,7 +8291,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * 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
+	 * @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
 	 * @default 500
 	 * @example
 	 * ```js
@@ -8540,7 +8653,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
 	 * 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
+	 * @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
 	 * @default 500
 	 * @example
 	 * ```js

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.44.3",
+    "version": "1.44.4",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",