@thoughtspot/visual-embed-sdk 1.36.9 → 1.37.0-temp-nav

package/src/types.ts

@@ -204,7 +204,19 @@ export enum HomeLeftNavItem {
     /**
      * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
      */
-    LiveboardSchedules = 'liveboard-schedules'
+    LiveboardSchedules = 'liveboard-schedules',
+    /**
+     * Create new options in the insights left navigation,
+     * available when new navigation V3 is enabled.
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    Create = 'create',
+    /**
+     * Spotter option in the insights left navigation,
+     * available when new navigation V3 is enabled.
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    Spotter = 'spotter',
 }
 export type DOMSelector = string | HTMLElement;
 
@@ -712,6 +724,19 @@ export interface ViewConfig {
      * ```
      */
     disabledActions?: Action[];
+    /**
+     * The primary action to display on top of the viz for Liveboard and App Embed.
+     * Use this to set the primary action.
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   primaryAction: Action.Download
+     * });
+     * ```
+     */
+    primaryAction?: Action | string;
     /**
      * The tooltip to display for disabled actions.
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
@@ -1138,8 +1163,8 @@ export interface ViewConfig {
      * Hide list page columns
      * For example: hiddenListColumns = [ListPageColumns.Author]
      *
-     * **Note**: This option is appplicable only in full app embedding.
-     * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
+     * **Note**: This option is available only in full app embedding.
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
@@ -1311,8 +1336,8 @@ export enum HomepageModule {
 
 /**
  * List page columns that can be hidden.
- * **Note**: This option is applicable only in full app embedding.
- * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
+ * **Note**: This option is applicable to full app embedding only.
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
  */
 // eslint-disable-next-line no-shadow
 export enum ListPageColumns {
@@ -2401,7 +2426,7 @@ export enum EmbedEvent {
      *      searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
      * })
      * ```
-     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
      TableVizRendered = 'TableVizRendered',
      /**
@@ -2414,12 +2439,12 @@ export enum EmbedEvent {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
+     * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
      */
     CreateLiveboard = 'createLiveboard',
     /**
      * Emitted when a user creates a Model.
-     * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
+     * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
      */
      CreateModel = 'createModel',
 }
@@ -2863,7 +2888,7 @@ export enum HostEvent {
      * ```js
      * liveboardEmbed.trigger(HostEvent.Remove)
      * ```
-     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
      */
     Remove = 'delete',
     /**
@@ -3324,8 +3349,17 @@ export enum HostEvent {
     /**
      * Get the Answer session for a Search or
      * Liveboard visualization.
+     * 
+     * Note: This event is not typically used directly. Instead, use the 
+     * `getAnswerService()` method on the embed instance to get an AnswerService 
+     * object that provides a more convenient interface for working with answers.
+     * 
      * @example
      * ```js
+     * // Preferred way to get an AnswerService
+     * const service = await embed.getAnswerService();
+     * 
+     * // Alternative direct usage (not recommended)
      * const {session} = await embed.trigger(
      *  HostEvent.GetAnswerSession, {
      *      vizId: '123', // For Liveboard Visualization.
@@ -3333,6 +3367,10 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
+     * // Preferred way to get an AnswerService
+     * const service = await embed.getAnswerService();
+     * 
+     * // Alternative direct usage (not recommended)
      * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
      * ```
      * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
@@ -3458,7 +3496,7 @@ export enum HostEvent {
      *      searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
      * })
      * ```
-     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
     TransformTableVizData = 'TransformTableVizData',
 }
@@ -3541,6 +3579,10 @@ export enum Param {
     ShowInsertToSlide = 'insertInToSlide',
     PrimaryNavHidden = 'primaryNavHidden',
     HideProfleAndHelp = 'profileAndHelpInNavBarHidden',
+    NavigationVersion = 'navigationVersion',
+    HideHamburger = 'hideHamburger',
+    HideObjectSearch = 'hideObjectSearch',
+    HideNotification = 'hideNotification',
     HideApplicationSwitcher = 'applicationSwitcherHidden',
     HideOrgSwitcher = 'orgSwitcherHidden',
     IsSageEmbed = 'isSageEmbed',
@@ -3597,6 +3639,7 @@ export enum Param {
     preAuthCache = 'preAuthCache',
     ShowSpotterLimitations = 'showSpotterLimitations',
     CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
+    PrimaryAction = 'primaryAction',
 }
 
 /**
@@ -4822,7 +4865,7 @@ export enum Action {
      * ```js
      * hiddenAction: [Action.ColumnRename]
      * ```
-     *  @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
+     *  @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
      */
     ColumnRename = 'columnRename',
     /**
@@ -4832,7 +4875,7 @@ export enum Action {
      * ```js
      * hiddenAction: [Action.CoverAndFilterOptionInPDF]
      * ```
-     *  @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
+     *  @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
      */
     CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
 }

package/src/utils/graphql/answerService/answerService.ts

@@ -26,29 +26,49 @@ export interface UnderlyingDataPoint {
 }
 
 /**
- * Class representing the answer service provided with the
- * custom action payload. This service could be used to run
- * graphql queries in the context of the answer on which the
- * custom action was triggered.
+ * AnswerService provides a simple way to work with ThoughtSpot Answers.
+ * 
+ * This service allows you to interact with ThoughtSpot Answers programmatically,
+ * making it easy to customize visualizations, filter data, and extract insights
+ * directly from your application.
+ * 
+ * You can use this service to:
+ * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`)
+ * - Apply filters to Answers (`addFilter`)
+ * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`)
+ * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`)
+ * - Run custom queries (`executeQuery`)
+ * - Add visualizations to liveboards (`addDisplayedVizToLiveboard`)
+ * 
  * @example
  * ```js
- *  embed.on(EmbedEvent.CustomAction, e => {
- *     const underlying = await e.answerService.getUnderlyingDataForPoint([
- *       'col name 1'
- *     ]);
- *     const data = await underlying.fetchData(0, 100);
- *  })
+ * // Get the answer service
+ * embed.on(EmbedEvent.Data, async (e) => {
+ *     const service = await embed.getAnswerService();
+ *     
+ *     // Add columns to the answer
+ *     await service.addColumnsByName(["Sales", "Region"]);
+ *     
+ *     // Get the data
+ *     const data = await service.fetchData();
+ *     console.log(data);
+ * });
  * ```
+ * 
  * @example
  * ```js
- * embed.on(EmbedEvent.Data, async (e) => {
- *     const service = await embed.getAnswerService();
- *     await service.addColumns([
- *         "<column guid>"
+ * // Get data for a point in a visualization
+ * embed.on(EmbedEvent.CustomAction, async (e) => {
+ *     const underlying = await e.answerService.getUnderlyingDataForPoint([
+ *       'Product Name',
+ *       'Sales Amount'
  *     ]);
- *     console.log(await service.fetchData());
+ *     
+ *     const data = await underlying.fetchData(0, 100);
+ *     console.log(data);
  * });
  * ```
+ * 
  * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
  * @group Events
  */

package/src/utils/processData.ts

@@ -80,15 +80,15 @@ export function processAuthFailure(e: any, containerEl: Element) {
     const {
         loginFailedMessage, authType, disableLoginFailurePage, autoLogin,
     } = getEmbedConfig();
-    if (
-        autoLogin
-        && (authType === AuthType.TrustedAuthToken
-            || authType === AuthType.TrustedAuthTokenCookieless)
-    ) {
+    
+    const isEmbeddedSSO = authType === AuthType.EmbeddedSSO;
+    const isTrustedAuth = authType === AuthType.TrustedAuthToken || authType === AuthType.TrustedAuthTokenCookieless;
+    const isEmbeddedSSOInfoFailure = isEmbeddedSSO && e?.data?.type === AuthFailureType.UNAUTHENTICATED_FAILURE;
+    if (autoLogin && isTrustedAuth) {
         // eslint-disable-next-line no-param-reassign
         containerEl.innerHTML = loginFailedMessage;
         notifyAuthFailure(AuthFailureType.IDLE_SESSION_TIMEOUT);
-    } else if (authType !== AuthType.None && !disableLoginFailurePage) {
+    } else if (authType !== AuthType.None && !disableLoginFailurePage && !isEmbeddedSSOInfoFailure) {
         // eslint-disable-next-line no-param-reassign
         containerEl.innerHTML = loginFailedMessage;
         notifyAuthFailure(AuthFailureType.OTHER);