@thoughtspot/visual-embed-sdk 1.45.3 → 1.46.0

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

@@ -2210,7 +2210,7 @@ export interface SearchLiveboardCommonViewConfig {
 	 *
 	 * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
 	 * @default true
-	 * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
+	 * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
 	 * @example
 	 * ```js
 	 * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -3653,65 +3653,69 @@ export declare enum EmbedEvent {
 	Rename = "rename",
 	/**
 	 *
-	 * This event can be emitted to intercept search execution initiated by
-	 * 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 - Includes the following event listener parameters:
+	 * This event allows developers to intercept search execution
+	 * and implement logic that decides whether Search Data should return
+	 * data or block the search operation.
+	 *
+	 * **Prerequisite**: Set`isOnBeforeGetVizDataInterceptEnabled` to `true`
+	 * to ensure that `EmbedEvent.OnBeforeGetVizDataIntercept` is emitted
+	 * when the embedding application user tries to run a search query.
+	 *
+	 * This framework applies only to `AppEmbed` and `SearchEmbed`.
+	 * @param - Includes the following 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.
+	 *   will run or block the search operation, and if blocked, which error message to provide.
 	 *
-	 * `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 is run.
+	 * When `execute` returns `false`, the search is not executed.
 	 *
-	 * `error` - Developers can customize the error message text when `execute`
-	 * is `false` using the `errorText` and `errorDescription` parameters in responder.
-	 *
-	 * `errorText` - The error message text to be shown to the user.
-	 * `errorDescription (ThoughtSpot: 10.15.0.cl and above)` - The error description to be shown to the user.
+	 * `error` - Developers can customize the user-facing error message when `execute`
+	 * is `false` by using the `error` parameters in `responder`.
+	 * `errorText` - The error message text shown to the user.
 	 * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
 	 * @example
-	 *```js
-	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
-	 * (payload, responder) => {
-	 *  responder({
-	 *      data: {
-	 *          execute:false,
-	 *          error: {
-	 *          //Provide a custom error message to explain to your end user
-	 *          //why their search did not run
-	 *          errorText: "This search query cannot be run.
-	 *          Please contact your administrator for more details."
-	 *          }
-	 *  }})
-	 * })
+	 *
+	 * This example blocks search operation and returns a custom error message:
+	 * ```js
+	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept, (payload, responder) => {
+	 *   responder({
+	 *     data: {
+	 *       execute: false,
+	 *       error: {
+	 *         // Provide a custom error message to explain why the search did not run.
+	 *         errorText: 'This search query cannot be run. Please contact your administrator for more details.',
+	 *       },
+	 *     },
+	 *   });
+	 * });
 	 * ```
+	 * @example
 	 *
-	 *```js
-	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
-	 * (payload, responder) => {
-	 * const query = payload.data.data.answer.search_query
-	 * responder({
-	 *  data: {
-	 *      // returns true as long as the query does not include
-	 *      // both the 'sales' AND the 'county' column
-	 *      execute: !(query.includes("sales")&&query.includes("county")),
-	 *      error: {
-	 *      //Provide a custom error message to explain to your end user
-	 *      // why their search did not run, and which searches are accepted by your custom logic.
-	 *      errorText: "Error Occurred",
-	 *      errorDescription: "You can't use this query :" + query + ".
-	 *      The 'sales' measures can never be used at the 'county' level.
-	 *      Please try another measure, or remove 'county' from your search."
-	 *      }
-	 *  }})
-	 * })
-	 *```
+	 * This example allows the search operation to run
+	 * unless the query contains both `sales` and `county`,
+	 * and returns a custom error message if the query is rejected:
+	 * ```js
+	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept, (payload, responder) => {
+	 *   // Record the search query submitted by the end user.
+	 *   const query = payload.data.data.answer.search_query;
+	 *
+	 *   responder({
+	 *     data: {
+	 *       // Returns true as long as the query does not include both `sales` and `county`.
+	 *       execute: !(query.includes('sales') && query.includes('county')),
+	 *       error: {
+	 *         // Provide a custom error message when the query is blocked by your logic.
+	 *         errorText:
+	 *           "You can't use this query: "
+	 *           + query
+	 *           + ". The 'sales' measure can never be used at the 'county' level. "
+	 *           + "Please try another measure or remove 'county' from your search.",
+	 *       },
+	 *     },
+	 *   });
+	 * });
+	 * ```
 	 */
 	OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
 	/**
@@ -7395,16 +7399,49 @@ export interface ContextObject {
 	};
 }
 /**
- * Enum for auth failure types. This is the parameter passed to the listner
- * of {@link AuthStatus.FAILURE}.
+ * Enum for auth failure types.
+ * This value is passed to the listener for {@link AuthStatus.FAILURE}.
  * @group Authentication / Init
  */
 export declare enum AuthFailureType {
+	/**
+	 * Authentication failed in the SDK authentication flow.
+	 *
+	 * Emitted when `init()` or auto-authentication cannot establish a logged-in session.
+	 * For example, this can happen because of an invalid token, an auth request failure,
+	 * or an auth promise rejection.
+	 */
 	SDK = "SDK",
+	/**
+	 * Browser cookie access is blocked for the embedded app.
+	 *
+	 * Emitted when the iframe reports that required cookies
+	 * cannot be read or sent, commonly due to third-party cookie restrictions.
+	 */
 	NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
+	/**
+	 * The current authentication token or session has expired.
+	 *
+	 * Emitted when the embed receives an auth-expiry signal and starts auth refresh handling.
+	 */
 	EXPIRY = "EXPIRY",
+	/**
+	 * A generic authentication failure that does not match a more specific type.
+	 *
+	 * Emitted as a fallback for app-reported auth failures in standard auth flows.
+	 */
 	OTHER = "OTHER",
+	/**
+	 * The user session timed out due to inactivity.
+	 *
+	 * Emitted when the app reports an idle-session timeout.
+	 */
 	IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT",
+	/**
+	 * The app reports that the user is unauthenticated.
+	 *
+	 * Used primarily to classify unauthenticated failures in Embedded SSO flows.
+	 */
 	UNAUTHENTICATED_FAILURE = "UNAUTHENTICATED_FAILURE"
 }
 /**
@@ -8805,7 +8842,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
 	 *
 	 * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
 	 * @default true
-	 * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
+	 * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
 	 * @example
 	 * ```js
 	 * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed

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

@@ -2210,7 +2210,7 @@ export interface SearchLiveboardCommonViewConfig {
 	 *
 	 * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
 	 * @default true
-	 * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
+	 * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
 	 * @example
 	 * ```js
 	 * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -3666,65 +3666,69 @@ export declare enum EmbedEvent {
 	Rename = "rename",
 	/**
 	 *
-	 * This event can be emitted to intercept search execution initiated by
-	 * 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 - Includes the following event listener parameters:
+	 * This event allows developers to intercept search execution
+	 * and implement logic that decides whether Search Data should return
+	 * data or block the search operation.
+	 *
+	 * **Prerequisite**: Set`isOnBeforeGetVizDataInterceptEnabled` to `true`
+	 * to ensure that `EmbedEvent.OnBeforeGetVizDataIntercept` is emitted
+	 * when the embedding application user tries to run a search query.
+	 *
+	 * This framework applies only to `AppEmbed` and `SearchEmbed`.
+	 * @param - Includes the following 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.
+	 *   will run or block the search operation, and if blocked, which error message to provide.
 	 *
-	 * `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 is run.
+	 * When `execute` returns `false`, the search is not executed.
 	 *
-	 * `error` - Developers can customize the error message text when `execute`
-	 * is `false` using the `errorText` and `errorDescription` parameters in responder.
-	 *
-	 * `errorText` - The error message text to be shown to the user.
-	 * `errorDescription (ThoughtSpot: 10.15.0.cl and above)` - The error description to be shown to the user.
+	 * `error` - Developers can customize the user-facing error message when `execute`
+	 * is `false` by using the `error` parameters in `responder`.
+	 * `errorText` - The error message text shown to the user.
 	 * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
 	 * @example
-	 *```js
-	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
-	 * (payload, responder) => {
-	 *  responder({
-	 *      data: {
-	 *          execute:false,
-	 *          error: {
-	 *          //Provide a custom error message to explain to your end user
-	 *          //why their search did not run
-	 *          errorText: "This search query cannot be run.
-	 *          Please contact your administrator for more details."
-	 *          }
-	 *  }})
-	 * })
+	 *
+	 * This example blocks search operation and returns a custom error message:
+	 * ```js
+	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept, (payload, responder) => {
+	 *   responder({
+	 *     data: {
+	 *       execute: false,
+	 *       error: {
+	 *         // Provide a custom error message to explain why the search did not run.
+	 *         errorText: 'This search query cannot be run. Please contact your administrator for more details.',
+	 *       },
+	 *     },
+	 *   });
+	 * });
 	 * ```
+	 * @example
 	 *
-	 *```js
-	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
-	 * (payload, responder) => {
-	 * const query = payload.data.data.answer.search_query
-	 * responder({
-	 *  data: {
-	 *      // returns true as long as the query does not include
-	 *      // both the 'sales' AND the 'county' column
-	 *      execute: !(query.includes("sales")&&query.includes("county")),
-	 *      error: {
-	 *      //Provide a custom error message to explain to your end user
-	 *      // why their search did not run, and which searches are accepted by your custom logic.
-	 *      errorText: "Error Occurred",
-	 *      errorDescription: "You can't use this query :" + query + ".
-	 *      The 'sales' measures can never be used at the 'county' level.
-	 *      Please try another measure, or remove 'county' from your search."
-	 *      }
-	 *  }})
-	 * })
-	 *```
+	 * This example allows the search operation to run
+	 * unless the query contains both `sales` and `county`,
+	 * and returns a custom error message if the query is rejected:
+	 * ```js
+	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept, (payload, responder) => {
+	 *   // Record the search query submitted by the end user.
+	 *   const query = payload.data.data.answer.search_query;
+	 *
+	 *   responder({
+	 *     data: {
+	 *       // Returns true as long as the query does not include both `sales` and `county`.
+	 *       execute: !(query.includes('sales') && query.includes('county')),
+	 *       error: {
+	 *         // Provide a custom error message when the query is blocked by your logic.
+	 *         errorText:
+	 *           "You can't use this query: "
+	 *           + query
+	 *           + ". The 'sales' measure can never be used at the 'county' level. "
+	 *           + "Please try another measure or remove 'county' from your search.",
+	 *       },
+	 *     },
+	 *   });
+	 * });
+	 * ```
 	 */
 	OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
 	/**
@@ -7384,11 +7388,44 @@ export interface ContextObject {
 	};
 }
 declare enum AuthFailureType {
+	/**
+	 * Authentication failed in the SDK authentication flow.
+	 *
+	 * Emitted when `init()` or auto-authentication cannot establish a logged-in session.
+	 * For example, this can happen because of an invalid token, an auth request failure,
+	 * or an auth promise rejection.
+	 */
 	SDK = "SDK",
+	/**
+	 * Browser cookie access is blocked for the embedded app.
+	 *
+	 * Emitted when the iframe reports that required cookies
+	 * cannot be read or sent, commonly due to third-party cookie restrictions.
+	 */
 	NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
+	/**
+	 * The current authentication token or session has expired.
+	 *
+	 * Emitted when the embed receives an auth-expiry signal and starts auth refresh handling.
+	 */
 	EXPIRY = "EXPIRY",
+	/**
+	 * A generic authentication failure that does not match a more specific type.
+	 *
+	 * Emitted as a fallback for app-reported auth failures in standard auth flows.
+	 */
 	OTHER = "OTHER",
+	/**
+	 * The user session timed out due to inactivity.
+	 *
+	 * Emitted when the app reports an idle-session timeout.
+	 */
 	IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT",
+	/**
+	 * The app reports that the user is unauthenticated.
+	 *
+	 * Used primarily to classify unauthenticated failures in Embedded SSO flows.
+	 */
 	UNAUTHENTICATED_FAILURE = "UNAUTHENTICATED_FAILURE"
 }
 declare enum AuthStatus {
@@ -8781,7 +8818,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
 	 *
 	 * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
 	 * @default true
-	 * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
+	 * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
 	 * @example
 	 * ```js
 	 * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed

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

@@ -2261,7 +2261,7 @@ export interface SearchLiveboardCommonViewConfig {
 	 *
 	 * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
 	 * @default true
-	 * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
+	 * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
 	 * @example
 	 * ```js
 	 * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -3717,65 +3717,69 @@ export declare enum EmbedEvent {
 	Rename = "rename",
 	/**
 	 *
-	 * This event can be emitted to intercept search execution initiated by
-	 * 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 - Includes the following event listener parameters:
+	 * This event allows developers to intercept search execution
+	 * and implement logic that decides whether Search Data should return
+	 * data or block the search operation.
+	 *
+	 * **Prerequisite**: Set`isOnBeforeGetVizDataInterceptEnabled` to `true`
+	 * to ensure that `EmbedEvent.OnBeforeGetVizDataIntercept` is emitted
+	 * when the embedding application user tries to run a search query.
+	 *
+	 * This framework applies only to `AppEmbed` and `SearchEmbed`.
+	 * @param - Includes the following 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.
+	 *   will run or block the search operation, and if blocked, which error message to provide.
 	 *
-	 * `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 is run.
+	 * When `execute` returns `false`, the search is not executed.
 	 *
-	 * `error` - Developers can customize the error message text when `execute`
-	 * is `false` using the `errorText` and `errorDescription` parameters in responder.
-	 *
-	 * `errorText` - The error message text to be shown to the user.
-	 * `errorDescription (ThoughtSpot: 10.15.0.cl and above)` - The error description to be shown to the user.
+	 * `error` - Developers can customize the user-facing error message when `execute`
+	 * is `false` by using the `error` parameters in `responder`.
+	 * `errorText` - The error message text shown to the user.
 	 * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
 	 * @example
-	 *```js
-	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
-	 * (payload, responder) => {
-	 *  responder({
-	 *      data: {
-	 *          execute:false,
-	 *          error: {
-	 *          //Provide a custom error message to explain to your end user
-	 *          //why their search did not run
-	 *          errorText: "This search query cannot be run.
-	 *          Please contact your administrator for more details."
-	 *          }
-	 *  }})
-	 * })
+	 *
+	 * This example blocks search operation and returns a custom error message:
+	 * ```js
+	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept, (payload, responder) => {
+	 *   responder({
+	 *     data: {
+	 *       execute: false,
+	 *       error: {
+	 *         // Provide a custom error message to explain why the search did not run.
+	 *         errorText: 'This search query cannot be run. Please contact your administrator for more details.',
+	 *       },
+	 *     },
+	 *   });
+	 * });
 	 * ```
+	 * @example
 	 *
-	 *```js
-	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
-	 * (payload, responder) => {
-	 * const query = payload.data.data.answer.search_query
-	 * responder({
-	 *  data: {
-	 *      // returns true as long as the query does not include
-	 *      // both the 'sales' AND the 'county' column
-	 *      execute: !(query.includes("sales")&&query.includes("county")),
-	 *      error: {
-	 *      //Provide a custom error message to explain to your end user
-	 *      // why their search did not run, and which searches are accepted by your custom logic.
-	 *      errorText: "Error Occurred",
-	 *      errorDescription: "You can't use this query :" + query + ".
-	 *      The 'sales' measures can never be used at the 'county' level.
-	 *      Please try another measure, or remove 'county' from your search."
-	 *      }
-	 *  }})
-	 * })
-	 *```
+	 * This example allows the search operation to run
+	 * unless the query contains both `sales` and `county`,
+	 * and returns a custom error message if the query is rejected:
+	 * ```js
+	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept, (payload, responder) => {
+	 *   // Record the search query submitted by the end user.
+	 *   const query = payload.data.data.answer.search_query;
+	 *
+	 *   responder({
+	 *     data: {
+	 *       // Returns true as long as the query does not include both `sales` and `county`.
+	 *       execute: !(query.includes('sales') && query.includes('county')),
+	 *       error: {
+	 *         // Provide a custom error message when the query is blocked by your logic.
+	 *         errorText:
+	 *           "You can't use this query: "
+	 *           + query
+	 *           + ". The 'sales' measure can never be used at the 'county' level. "
+	 *           + "Please try another measure or remove 'county' from your search.",
+	 *       },
+	 *     },
+	 *   });
+	 * });
+	 * ```
 	 */
 	OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
 	/**
@@ -8284,7 +8288,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
 	 *
 	 * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
 	 * @default true
-	 * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
+	 * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
 	 * @example
 	 * ```js
 	 * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -9258,16 +9262,49 @@ export declare class AppEmbed extends V1Embed {
 	render(): Promise<AppEmbed>;
 }
 /**
- * Enum for auth failure types. This is the parameter passed to the listner
- * of {@link AuthStatus.FAILURE}.
+ * Enum for auth failure types.
+ * This value is passed to the listener for {@link AuthStatus.FAILURE}.
  * @group Authentication / Init
  */
 export declare enum AuthFailureType {
+	/**
+	 * Authentication failed in the SDK authentication flow.
+	 *
+	 * Emitted when `init()` or auto-authentication cannot establish a logged-in session.
+	 * For example, this can happen because of an invalid token, an auth request failure,
+	 * or an auth promise rejection.
+	 */
 	SDK = "SDK",
+	/**
+	 * Browser cookie access is blocked for the embedded app.
+	 *
+	 * Emitted when the iframe reports that required cookies
+	 * cannot be read or sent, commonly due to third-party cookie restrictions.
+	 */
 	NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
+	/**
+	 * The current authentication token or session has expired.
+	 *
+	 * Emitted when the embed receives an auth-expiry signal and starts auth refresh handling.
+	 */
 	EXPIRY = "EXPIRY",
+	/**
+	 * A generic authentication failure that does not match a more specific type.
+	 *
+	 * Emitted as a fallback for app-reported auth failures in standard auth flows.
+	 */
 	OTHER = "OTHER",
+	/**
+	 * The user session timed out due to inactivity.
+	 *
+	 * Emitted when the app reports an idle-session timeout.
+	 */
 	IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT",
+	/**
+	 * The app reports that the user is unauthenticated.
+	 *
+	 * Used primarily to classify unauthenticated failures in Embedded SSO flows.
+	 */
 	UNAUTHENTICATED_FAILURE = "UNAUTHENTICATED_FAILURE"
 }
 /**

package/lib/package.json

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

package/lib/src/auth.d.ts

@@ -5,16 +5,49 @@ export declare let samlAuthWindow: Window;
 export declare let samlCompletionPromise: Promise<void>;
 export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
 /**
- * Enum for auth failure types. This is the parameter passed to the listner
- * of {@link AuthStatus.FAILURE}.
+ * Enum for auth failure types.
+ * This value is passed to the listener for {@link AuthStatus.FAILURE}.
  * @group Authentication / Init
  */
 export declare enum AuthFailureType {
+    /**
+     * Authentication failed in the SDK authentication flow.
+     *
+     * Emitted when `init()` or auto-authentication cannot establish a logged-in session.
+     * For example, this can happen because of an invalid token, an auth request failure,
+     * or an auth promise rejection.
+     */
     SDK = "SDK",
+    /**
+     * Browser cookie access is blocked for the embedded app.
+     *
+     * Emitted when the iframe reports that required cookies
+     * cannot be read or sent, commonly due to third-party cookie restrictions.
+     */
     NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
+    /**
+     * The current authentication token or session has expired.
+     *
+     * Emitted when the embed receives an auth-expiry signal and starts auth refresh handling.
+     */
     EXPIRY = "EXPIRY",
+    /**
+     * A generic authentication failure that does not match a more specific type.
+     *
+     * Emitted as a fallback for app-reported auth failures in standard auth flows.
+     */
     OTHER = "OTHER",
+    /**
+     * The user session timed out due to inactivity.
+     *
+     * Emitted when the app reports an idle-session timeout.
+     */
     IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT",
+    /**
+     * The app reports that the user is unauthenticated.
+     *
+     * Used primarily to classify unauthenticated failures in Embedded SSO flows.
+     */
     UNAUTHENTICATED_FAILURE = "UNAUTHENTICATED_FAILURE"
 }
 /**

package/lib/src/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAIzC,OAAO,EACoB,WAAW,EACrC,MAAM,SAAS,CAAC;AAgBjB,eAAO,IAAI,cAAc,SAAQ,CAAC;AAElC,eAAO,IAAI,cAAc,EAAE,MAAa,CAAC;AAEzC,eAAO,IAAI,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAQ,CAAC;AAIvD,eAAO,MAAM,2BAA2B,yCAAyC,CAAC;AAElF;;;;GAIG;AACH,oBAAY,eAAe;IACvB,GAAG,QAAQ;IACX,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,oBAAoB,yBAAyB;IAC7C,uBAAuB,4BAA4B;CACtD;AAED;;;GAGG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;;OAGG;IACH,oBAAoB,yBAAyB;IAC7C;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;OAKG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,yBAAyB,8BAA8B;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;OAIG;IACH,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACtF;;;;OAIG;IACH,EAAE,CACE,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,GAAG,UAAU,CAAC,yBAAyB,EACvH,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC1E,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACxF,IAAI,CACA,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,GAAG,UAAU,CAAC,yBAAyB,EACvH,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC5E;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAChD;;;;;;OAMG;IACH,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9F;;;OAGG;IACH,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;CAC/C;AAED;;;GAGG;AACH,oBAAY,SAAS;IACjB;;;OAGG;IACH,iBAAiB,sBAAsB;CAC1C;AAID;;GAEG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,CAEhE;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,IAAI,CAElF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAM3C;AAED;;GAEG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAYvD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAMpE;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAeD;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAYtD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,WAEhC;AAyBD;;;GAGG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAgC3E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAgBrF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAa3E,CAAC;AA2FF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAkBxD,CAAC;AAEF,eAAO,MAAM,MAAM,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAYtE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAoB5E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,QAAO,OAAyB,CAAC"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAIzC,OAAO,EACoB,WAAW,EACrC,MAAM,SAAS,CAAC;AAgBjB,eAAO,IAAI,cAAc,SAAQ,CAAC;AAElC,eAAO,IAAI,cAAc,EAAE,MAAa,CAAC;AAEzC,eAAO,IAAI,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAQ,CAAC;AAIvD,eAAO,MAAM,2BAA2B,yCAAyC,CAAC;AAElF;;;;GAIG;AACH,oBAAY,eAAe;IACvB;;;;;;OAMG;IACH,GAAG,QAAQ;IACX;;;;;OAKG;IACH,gBAAgB,qBAAqB;IACrC;;;;OAIG;IACH,MAAM,WAAW;IACjB;;;;OAIG;IACH,KAAK,UAAU;IACf;;;;OAIG;IACH,oBAAoB,yBAAyB;IAC7C;;;;OAIG;IACH,uBAAuB,4BAA4B;CACtD;AAED;;;GAGG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;;OAGG;IACH,oBAAoB,yBAAyB;IAC7C;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;OAKG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,yBAAyB,8BAA8B;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;OAIG;IACH,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACtF;;;;OAIG;IACH,EAAE,CACE,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,GAAG,UAAU,CAAC,yBAAyB,EACvH,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC1E,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACxF,IAAI,CACA,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,GAAG,UAAU,CAAC,yBAAyB,EACvH,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC5E;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAChD;;;;;;OAMG;IACH,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9F;;;OAGG;IACH,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;CAC/C;AAED;;;GAGG;AACH,oBAAY,SAAS;IACjB;;;OAGG;IACH,iBAAiB,sBAAsB;CAC1C;AAID;;GAEG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,CAEhE;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,IAAI,CAElF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAM3C;AAED;;GAEG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAYvD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAMpE;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAeD;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAYtD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,WAEhC;AAyBD;;;GAGG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAgC3E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAgBrF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAa3E,CAAC;AA2FF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAkBxD,CAAC;AAEF,eAAO,MAAM,MAAM,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAYtE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAoB5E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,QAAO,OAAyB,CAAC"}