@thoughtspot/visual-embed-sdk 1.44.4 → 1.44.5

package/cjs/src/types.d.ts

@@ -347,7 +347,7 @@ export interface EmbedConfig {
     /**
      * [AuthServer] The trusted authentication endpoint to use to get the
      * authentication token. A `GET` request is made to the
-     * authentication API endpoint, which  returns the token
+     * authentication API endpoint, which returns the token
      * as a plaintext response. For trusted authentication,
      * the `authEndpoint` or `getAuthToken` attribute is required.
      */
@@ -457,12 +457,12 @@ export interface EmbedConfig {
      * When there are multiple objects embedded, queue the rendering of embedded objects
      * to start after the previous embed's render is complete. This helps improve
      * performance by decreasing the load on the browser.
-     *  @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
+     * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @default false
      */
     queueMultiRenders?: boolean;
     /**
-     * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
+     * [AuthServer|Basic] Detect if third-party cookies are enabled by doing an
      * additional call. This is slower and should be avoided. Listen to the
      * `NO_COOKIE_ACCESS` event to handle the situation.
      *
@@ -1241,21 +1241,26 @@ export interface SearchLiveboardCommonViewConfig {
     /**
      * Boolean to exclude runtimeFilters in the URL
      * By default it is true, this flag removes runtime filters from the URL
-     * when set to false, runtime filters will be included in the URL.
+     * (default behavior from SDK 1.45.0).
+     * when set to false, runtime filters will be included in the URL
+     * (default behavior before SDK 1.45.0).
      *
      * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
      * embedded view.
-     * @default false
+     * @default true
      * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
      */
     excludeRuntimeFiltersfromURL?: boolean;
     /**
      * Boolean to exclude runtimeParameters from the URL
-     * when set to true, this flag removes runtime parameters from the URL.
+     * when set to true, this flag removes runtime parameters from the URL
+     * (default behavior from SDK 1.45.0).
+     * when set to false, runtime parameters will be included in the URL
+     * (default behavior before SDK 1.45.0).
      *
      * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
      * embedded view.
-     * @default false
+     * @default true
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
      */
     excludeRuntimeParametersfromURL?: boolean;
@@ -1493,22 +1498,6 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     coverAndFilterOptionInPDF?: boolean;
-    /**
-     * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
-     * To enable this feature on your instance, contact ThoughtSpot Support.
-     *
-     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-     * @version SDK: 1.41.0 | ThoughtSpot: 26.3.0.cl
-     * @example
-     * ```js
-     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
-     * const embed = new <EmbedComponent>('#tsEmbed', {
-     *    ... // other embed view config
-     *    liveboardXLSXCSVDownload: true,
-     * })
-     * ```
-     */
-    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,
@@ -1744,7 +1733,11 @@ export declare enum HomepageModule {
  */
 export declare enum ListPageColumns {
     /**
-     * Favourite
+     * Favorites
+     */
+    Favorites = "FAVOURITE",
+    /**
+     * @deprecated Use {@link ListPageColumns.Favorites} instead.
      */
     Favourite = "FAVOURITE",
     /**
@@ -1762,7 +1755,11 @@ export declare enum ListPageColumns {
     /**
      * Share
      */
-    Share = "SHARE"
+    Share = "SHARE",
+    /**
+     * Verified badge/column
+     */
+    Verified = "VERIFIED"
 }
 /**
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
@@ -2012,7 +2009,7 @@ export declare enum EmbedEvent {
     /**
      * An error has occurred. This event is fired for the following error types:
      *
-     * `API` - API call failure error.
+     * `API` - API call failure.
      * `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
      * mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
      * filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
@@ -2743,20 +2740,20 @@ export declare enum EmbedEvent {
     /**
      *
      * This event can be emitted to intercept search execution initiated by
-     * the users and implement the logic to allow or restrict search execution.
-     * You can can also show custom error text if the search query must be
+     * users and implement logic to allow or restrict search execution.
+     * You can also show custom error text if the search query must be
      * restricted due to your application or business requirements.
 
      * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
      * for this embed event to get emitted.
-     * @param:payload The payload received from the embed related to the Data API call.
-     * @param:responder
-     * Contains elements that lets developers define whether ThoughtSpot
-     * should run the search, and if not, what error message
-     * should be shown to the user.
+     * @param - Includes the following event listener parameters:
+     * - `payload`: The payload received from the embed related to the Data API call.
+     * - `responder`: Contains elements that let developers define whether ThoughtSpot
+     *   should run the search, and if not, what error message
+     *   should be shown to the user.
      *
-     * `execute` - When execute returns `true`, the search will be run.
-     * When execute returns `false`, the search will not be executed.
+     * `execute` - When `execute` returns `true`, the search will be run.
+     * When `execute` returns `false`, the search will not be executed.
      *
      * `error` - Developers can customize the error message text when `execute`
      * is `false` using the `errorText` and `errorDescription` parameters in responder.
@@ -2928,7 +2925,7 @@ export declare enum EmbedEvent {
      *     console.log('payload', payload);
      * })
      * ```
-     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
      */
     DataModelInstructions = "DataModelInstructions",
     /**
@@ -3146,14 +3143,14 @@ export declare enum HostEvent {
      * the search query string.
      * Supported in `AppEmbed` and `SearchEmbed` deployments.
      * Includes the following properties:
-     * @param - `searchQuery` - query string with search tokens
-     * @param - `dataSources` - Data source GUID to Search on
-     *                        - Although an array, only a single source
-     *                          is supported.
-     * @param - `execute` - executes search and updates the existing query
+     * @param - Includes the following keys:
+     * - `searchQuery`: Query string with search tokens.
+     * - `dataSources`: Data source GUID to search on.
+     *   Although an array, only a single source is supported.
+     * - `execute`: Executes search and updates the existing query.
      * @example
      * ```js
-     * searchembed.trigger(HostEvent.Search, {
+     * searchEmbed.trigger(HostEvent.Search, {
          searchQuery: "[sales] by [item type]",
          dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
          execute: true
@@ -3164,16 +3161,15 @@ export declare enum HostEvent {
     /**
      * Triggers a drill on certain points of the specified column
      * Includes the following properties:
-     * @param - points - an object containing selectedPoints/clickedPoints
-     * to drill to. For example, { selectedPoints: []}
-     * @param - columnGuid - Optional. GUID of the column to drill
-     * by. If not provided it will auto drill by the configured
-     *   column.
-     * @param - autoDrillDown - Optional. If true, the drill down will be
-     * done automatically on the most popular column.
-     * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
-     * in case of a Liveboard.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - Includes the following keys:
+     * - `points`: An object containing `selectedPoints` and/or `clickedPoint`
+     *   to drill to. For example, `{ selectedPoints: [] }`.
+     * - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
+     *   it will auto drill by the configured column.
+     * - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
+     *   on the most popular column.
+     * - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
+     *   of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
      * @example
      * ```js
      * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -3266,14 +3262,12 @@ export declare enum HostEvent {
      * and `AppEmbed` only. In full application embedding, this event updates
      * the runtime filters applied on the Liveboard and saved Answer objects.
      *
-     * @param - Pass an array of {@link RuntimeFilter} with the following attributes:
-     * `columnName` - _String_. The name of the column to filter on.
-     *
-     * `operator` - {@link RuntimeFilterOp} to apply. For more information,
-     * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
-     *
-     * `values` - List of operands. Some operators such as EQ and LE allow a
-     * single value, whereas BW and IN accept multiple values.
+     * @param - Array of {@link RuntimeFilter} objects. Each item includes:
+     * - `columnName`: Name of the column to filter on.
+     * - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
+     *   link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
+     * - `values`: List of operands. Some operators such as EQ and LE allow a single
+     *   value, whereas BW and IN accept multiple values.
      *
      * **Note**: Updating runtime filters resets the ThoughtSpot
      * object to its original state and applies new filter conditions.
@@ -3296,7 +3290,7 @@ export declare enum HostEvent {
     /**
      * Navigate to a specific page in the embedded ThoughtSpot application.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`.
-     * @param - `path` - the path to navigate to to go forward or back. The path value can
+     * @param - `path` - the path to navigate to go forward or back. The path value can
      * be a number; for example, `1`, `-1`.
      * @example
      * ```js
@@ -3367,30 +3361,25 @@ export declare enum HostEvent {
      * for the Answer that the user is currently on
      * and a modal opens for Liveboard selection.
      * To add an Answer or visualization to a Liveboard programmatically without
-     * showing requiring additional user input via *Pin to Liveboard* modal, define
+     * requiring additional user input via the *Pin to Liveboard* modal, define
      * the following parameters:
      *
-     * @param
-     * `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
-     * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,
-     *  specify the `newLiveboardName` parameter to create a new Liveboard.
-     * @param
-     * `tabId` - GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
-     *  specified in the code.
-     * @param
-     * `newVizName` - Name string for the Answer or visualization. If defined,
-     *  this parameter adds a new visualization object or creates a copy of the
-     *  Answer or visualization specified in `vizId`.
-     *  Required attribute.
-     * @param
-     * `newLiveboardName` - Name string for the Liveboard.
-     *  Creates a new Liveboard object with the specified name.
-     * @param
-     * `newTabName` - Name of the tab. Adds a new tab Liveboard specified
-     *  in the code.
+     * @param - Includes the following keys:
+     * - `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.
+     * - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
+     *   specify the `newLiveboardName` parameter to create a new Liveboard.
+     * - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
+     *   specified in the code.
+     * - `newVizName`: Name string for the Answer or visualization. If defined,
+     *   this parameter adds a new visualization object or creates a copy of the
+     *   Answer or visualization specified in `vizId`.
+     *   Required.
+     * - `newLiveboardName`: Name string for the Liveboard.
+     *   Creates a new Liveboard object with the specified name.
+     * - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
+     *   in the code.
      *
      * @example
      * ```js
@@ -3630,9 +3619,9 @@ export declare enum HostEvent {
      * on a Liveboard.
      *
      * This event is not supported in visualization embed and search embed.
-     * @param - object - To trigger the action for a specific visualization
-     * in Liveboard embed, pass in `vizId` as a key.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - Object parameter. Includes the following keys:
+     * - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
+     *   pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
      *
      * @example
      * ```js
@@ -3999,10 +3988,9 @@ export declare enum HostEvent {
     GetFilters = "getFilters",
     /**
      * Update one or several filters applied on a Liveboard.
-     * @param - `filter`: a single filter object containing column name,
-     * filter operator, and values.
-     * @param - `filters`: multiple filter objects with column name, filter operator,
-     * and values for each.
+     * @param - Includes the following keys:
+     * - `filter`: A single filter object containing column name, filter operator, and values.
+     * - `filters`: Multiple filter objects with column name, filter operator, and values for each.
      *
      * Each filter object must include the following attributes:
      *
@@ -4128,8 +4116,9 @@ export declare enum HostEvent {
     SetHiddenTabs = "SetPinboardHiddenTabs",
     /**
      * Updates the search query string for Natural Language Search operations.
-     * @param - `queryString`: Text string in Natural Language format
-     * @param - `executeSearch`: Boolean to execute search and update search query
+     * @param - Includes the following keys:
+     * - `queryString`: Text string in Natural Language format.
+     * - `executeSearch`: Boolean to execute search and update search query.
      * @example
      * ```js
      * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -4208,11 +4197,10 @@ export declare enum HostEvent {
     /**
      * Triggers an action to update Parameter values on embedded
      * Answers, Liveboard, and Spotter answer in Edit mode.
-     * @param - `name` - Name of the Parameter
-     * @param - `value` - The value to set for the Parameter.
-     *
-     * Optionally, to control the visibility of the Parameter chip,
-     * use the `isVisibleToUser` attribute when applying an override.
+     * @param - Includes the following keys for each item:
+     * - `name`: Name of the parameter.
+     * - `value`: The value to set for the parameter.
+     * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
      *
      * @example
      * ```js
@@ -4270,11 +4258,10 @@ export declare enum HostEvent {
      * If no parameters are specified, the save action is
      * triggered with a modal to prompt users to
      * add a name and description for the Answer.
-     * @param - `vizId` refers to the Answer ID in Spotter embed
-     * and is required in Spotter embed.
-     * Optional attributes to set Answer properties include:
-     * @param - `name` - Name string for the Answer.
-     * @param - `description` - Description text for the Answer.
+     * @param - Includes the following keys:
+     * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
+     * - `name`: Optional. Name string for the Answer.
+     * - `description`: Optional. Description text for the Answer.
      * @example
      * ```js
      * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -4323,8 +4310,9 @@ export declare enum HostEvent {
     /**
      * Triggers a search operation with the search tokens specified in
      * the search query string in spotter embed.
-     * @param - `query`: Text string in Natural Language format
-     * @param - `executeSearch`: Boolean to execute search and update search query
+     * @param - Includes the following keys:
+     * - `query`: Text string in Natural Language format.
+     * - `executeSearch`: Boolean to execute search and update search query.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.SpotterSearch, {
@@ -4371,7 +4359,7 @@ export declare enum HostEvent {
      * ```js
      * spotterEmbed.trigger(HostEvent.DataModelInstructions);
      * ```
-     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
      */
     DataModelInstructions = "DataModelInstructions",
     /**
@@ -4456,7 +4444,7 @@ export declare enum HostEvent {
      */
     UpdateEmbedParams = "updateEmbedParams",
     /**
-     * Triggered when the embed is needed to be destroyed. This is used to clean up any embed related resources internally.
+     * Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DestroyEmbed);
@@ -4464,11 +4452,12 @@ export declare enum HostEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     DestroyEmbed = "EmbedDestroyed",
-    /** Triggers a create new conversation operation in spotter embed.
-     * @example
-     * ```js
+    /**
+     * Triggers a new conversation in Spotter embed.
+     *
      * This feature is available only when chat history is enabled on your ThoughtSpot instance.
      * Contact your admin or ThoughtSpot Support to enable chat history on your instance.
+     *
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
@@ -4617,8 +4606,9 @@ export declare enum Param {
     IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
     IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
     RootMarginForLazyLoad = "rootMarginForLazyLoad",
-    LiveboardXLSXCSVDownload = "isLiveboardXLSXCSVDownloadEnabled",
     isPNGInScheduledEmailsEnabled = "isPNGInScheduledEmailsEnabled",
+    isLiveboardXLSXCSVDownloadEnabled = "isLiveboardXLSXCSVDownloadEnabled",
+    isGranularXLSXCSVSchedulesEnabled = "isGranularXLSXCSVSchedulesEnabled",
     isCentralizedLiveboardFilterUXEnabled = "isCentralizedLiveboardFilterUXEnabled",
     isLinkParametersEnabled = "isLinkParametersEnabled",
     EnablePastConversationsSidebar = "enablePastConversationsSidebar",
@@ -4649,7 +4639,7 @@ export declare enum Param {
  *    hiddenActions: [Action.Edit, ActionAction.Explore],
  * })
  * ```
- * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
+ * See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
  */
 export declare enum Action {
     /**
@@ -4936,6 +4926,16 @@ export declare enum Action {
      * ```
      */
     DownloadAsXlsx = "downloadAsXLSX",
+    /**
+     * The **Download Liveboard** menu action on a Liveboard.
+     * Allows downloading the entire Liveboard.
+     * @example
+     * ```js
+     * disabledActions: [Action.DownloadLiveboard]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    DownloadLiveboard = "downloadLiveboard",
     /**
      * @hidden
      */
@@ -5275,28 +5275,28 @@ export declare enum Action {
     CrossFilter = "context-menu-item-cross-filter",
     /**
      * The **Sync to Slack** action on Liveboard visualizations.
-     * Allows sending data to third-party apps Slack
+     * Allows sending data to third-party apps like Slack.
      * @example
      * ```js
      * disabledActions: [Action.SyncToSlack]
      * ```
-     * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
      */
     SyncToSlack = "syncToSlack",
     /**
      * The **Sync to Teams** action on Liveboard visualizations.
-     * Allows sending data to third-party apps Team
+     * Allows sending data to third-party apps like Microsoft Teams.
      * @example
      * ```js
      * disabledActions: [Action.SyncToTeams]
      * ```
-     * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
      */
     SyncToTeams = "syncToTeams",
     /**
      * The **Remove** action that appears when cross filters are applied
      * on a Liveboard.
-     * Removes filters applied o a visualization.
+     * Removes filters applied to a visualization.
      * @example
      * ```js
      * disabledActions: [Action.RemoveCrossFilter]
@@ -5482,7 +5482,7 @@ export declare enum Action {
     AddTab = "addTab",
     /**
      *
-     *Initiates contextual change analysis on KPI charts.
+     * Initiates contextual change analysis on KPI charts.
      * @example
      * ```js
      * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -5492,7 +5492,7 @@ export declare enum Action {
     EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
     /**
      * Action ID to hide or disable Iterative Change Analysis option
-     * on contextual change analysis  Inisght charts context menu
+     * in the contextual change analysis Insight charts context menu.
      *
      * @example
      * ```js
@@ -5770,6 +5770,17 @@ export declare enum Action {
      *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
+    /**
+     * The **Data model instructions** button on the Spotter interface.
+     * Allows opening the data model instructions modal.
+     *
+     *  @example
+     * ```js
+     * hiddenAction: [Action.DataModelInstructions]
+     * ```
+     *  @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    DataModelInstructions = "DataModelInstructions",
     /**
      * The **Preview data** button on the Spotter interface.
      * Allows previewing the data used for Spotter queries.
@@ -5855,12 +5866,12 @@ export declare enum Action {
      */
     CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
     /**
-     * Action ID for hide or disable the
-     * Spotter in conversation training widget.
-     * The Add to Coaching feature is currently in beta
-     * and is disabled by default on embed deployments.
-     * To enable this feature on your instance,
-     * contact ThoughtSpot Support.
+     * Action ID to hide or disable the Spotter in the conversation training widget.
+     * When disabled, users cannot access **Add to Coaching**, which allows adding reference
+     * questions and business terms to improve Spotter’s responses.
+     * The **Add to Coaching** feature is generally available from version 26.2.0.cl and
+     * enabled by default on embed deployments.
+
      *  @example
      * ```js
      * hiddenAction: [Action.InConversationTraining]
@@ -6175,31 +6186,19 @@ export declare enum ErrorDetailsTypes {
     NETWORK = "NETWORK"
 }
 /**
- * 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.
+ * Error codes for identifying specific issues in embedded ThoughtSpot components.
  *
- * 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
+ * Use these codes for precise error handling and debugging. Each code maps to a
+ * distinct failure scenario, enabling targeted recovery strategies.
  *
  * @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
+ * Handle specific error codes in the error event handler
  *
  * embed.on(EmbedEvent.Error, (error) => {
  *   if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {