@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.3

package/package.json

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

package/src/auth.spec.ts

@@ -283,7 +283,7 @@ describe('Unit test for auth', () => {
             text: () => Promise.resolve('abc'),
         } as any));
         jest.spyOn(authService, 'fetchAuthPostService').mockImplementation(() =>
-            // eslint-disable-next-line prefer-promise-reject-errors, implicit-arrow-linebreak
+             
             Promise.reject({
                 status: 500,
             }));

package/src/auth.ts

@@ -19,11 +19,11 @@ import { getSessionInfo, getPreauthInfo } from './utils/sessionInfoService';
 import { ERROR_MESSAGE } from './errors';
 import { resetAllCachedServices } from './utils/resetServices';
 
-// eslint-disable-next-line import/no-mutable-exports
+ 
 export let loggedInStatus = false;
-// eslint-disable-next-line import/no-mutable-exports
+ 
 export let samlAuthWindow: Window = null;
-// eslint-disable-next-line import/no-mutable-exports
+ 
 export let samlCompletionPromise: Promise<void> = null;
 
 let releaseVersion = '';
@@ -83,20 +83,45 @@ export enum AuthFailureType {
  */
 export enum AuthStatus {
     /**
-     * Emits when the SDK fails to authenticate
+     * Emits when the SDK fails to authenticate.
      */
     FAILURE = 'FAILURE',
     /**
-     * Emits when the SDK authenticates successfully
+     * Emits when the SDK authentication step completes
+     * successfully (e.g., token exchange, cookie set).
+     * This fires before any iframe is rendered. Use
+     * this to know that auth passed and it is safe to
+     * proceed with rendering. The callback receives no
+     * arguments.
+     * @example
+     * ```js
+     * const authEE = init({ ... });
+     * authEE.on(AuthStatus.SDK_SUCCESS, () => {
+     *     // Auth done, iframe not loaded yet
+     * });
+     * ```
      */
     SDK_SUCCESS = 'SDK_SUCCESS',
     /**
      * @hidden
-     * Emits when iframe is loaded and session info is available
+     * Emits when iframe is loaded and session
+     * information is available.
      */
     SESSION_INFO_SUCCESS = 'SESSION_INFO_SUCCESS',
     /**
-     * Emits when the app sends an authentication success message
+     * Emits when the ThoughtSpot app inside the
+     * embedded iframe confirms its session is active.
+     * This fires after the iframe loads and sends back an `AuthInit` event.
+     * @param sessionInfo Information about the user session, with details like `userGUID`.
+     * @see EmbedEvent.AuthInit
+     * @example
+     * ```js
+     * const authEE = init({ ... });
+     * authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
+     *     // App is loaded and authenticated
+     *     console.log(sessionInfo.userGUID);
+     * });
+     * ```
      */
     SUCCESS = 'SUCCESS',
     /**

package/src/authToken.spec.ts

@@ -129,7 +129,8 @@ describe('AuthToken Unit tests', () => {
             expect(token).toBe(newToken);
             // Should not validate cached token (condition at line 23 is false)
             expect(validateAuthTokenSpy).not.toHaveBeenCalledWith(config, cachedToken, true);
-            // But should validate new token (though it returns early when disableTokenVerification is true)
+            // But should validate new token (though it returns early when
+            // disableTokenVerification is true)
             expect(validateAuthTokenSpy).toHaveBeenCalledWith(config, newToken);
             expect(getAuthTokenMock).toHaveBeenCalled();
 

package/src/authToken.ts

@@ -83,7 +83,7 @@ export const validateAuthToken = async (
 
     if (cachedAuthToken && cachedAuthToken === authToken) {
         if (!embedConfig.suppressErrorAlerts && !suppressAlert) {
-            // eslint-disable-next-line no-alert
+             
             alert(ERROR_MESSAGE.DUPLICATE_TOKEN_ERR);
         }
         throw new Error(ERROR_MESSAGE.DUPLICATE_TOKEN_ERR);

package/src/css-variables.ts

@@ -517,42 +517,42 @@ export interface CustomCssVariables {
     /**
      * Padding of the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-padding'?: string;
 
     /**
      * Font size of the title of the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-title-font-size'?: string;
 
     /**
      * Font weight of the title of the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-title-font-weight'?: string;
 
     /**
      * Font size of the title of the tiles inside the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-tile-title-font-size'?: string;
 
     /**
      * Font weight of the title of the tiles inside the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-tile-title-font-weight'?: string;
 
     /**
      * Padding of the group tiles in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-tile-padding'?: string;
 
@@ -564,14 +564,14 @@ export interface CustomCssVariables {
     /**
      * Background color of the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-background'?: string;
 
     /**
      * Border color of the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-border-color'?: string;
 
@@ -588,63 +588,63 @@ export interface CustomCssVariables {
     /**
      * Font color of the title of the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-title-font-color'?: string;
 
     /**
      * Font color of the description of the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-description-font-color'?: string;
 
     /**
      * Font color of the title of the tiles inside the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-tile-title-font-color'?: string;
 
     /**
      * Font color of the description of the tiles inside the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-tile-description-font-color'?: string;
 
     /**
      * Background color of the tiles inside the groups in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-group-tile-background'?: string;
 
     /**
      * Background color of the filter chips in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-chip-background'?: string;
 
     /**
      * Font color of the filter chips in the Liveboard.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-chip-color'?: string;
 
     /**
      * Background color of the filter chips in the Liveboard on hover.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-chip--hover-background'?: string;
 
     /**
      * Background color of the filter chips in the Liveboard on active.
      * 
-     * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
+     * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
      */
     '--ts-var-liveboard-chip--active-background'?: string;
 

package/src/embed/app.spec.ts

@@ -397,7 +397,7 @@ describe('App embed tests', () => {
         });
     });
 
-    test('should set isLiveboardStylingAndGroupingEnabled to true in url', async () => {
+    test('should set isLiveboardStylingAndGroupingEnabled to true in url (deprecated, use isLiveboardMasterpiecesEnabled)', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
             isLiveboardStylingAndGroupingEnabled: true,
@@ -425,6 +425,20 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set enableHomepageAnnouncement to true in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            enableHomepageAnnouncement: true,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enableHomepageAnnouncement=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should set isPNGInScheduledEmailsEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -509,6 +523,37 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set deprecated standalone enablePastConversationsSidebar in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            enablePastConversationsSidebar: true,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enablePastConversationsSidebar=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('should prefer spotterSidebarConfig.enablePastConversationsSidebar over deprecated standalone flag in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            enablePastConversationsSidebar: false,
+            spotterSidebarConfig: {
+                enablePastConversationsSidebar: true,
+            },
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enablePastConversationsSidebar=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should set hideToolResponseCardBranding to true in url via spotterChatConfig', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,