@thoughtspot/visual-embed-sdk 1.39.0 → 1.39.2

package/src/embed/embedConfig.ts

@@ -4,9 +4,52 @@ import { EmbedConfig } from '../types';
 const configKey = 'embedConfig';
 
 /**
- * Gets the configuration embed was initialized with.
- * @returns {@link EmbedConfig} The configuration embed was initialized with.
- * @version SDK: 1.19.0 | ThoughtSpot: *
+ * Gets the embed configuration settings that were used to
+ * initialize the SDK.
+ * @returns {@link EmbedConfig}
+ *
+ * @example
+ * ```js
+ * const config = getInitConfig();
+ * console.log(config);
+ * ```
+ * @example
+ *
+ * Returns the `EmbedConfig` object, which
+ * contains the configuration settings used to
+ * initialize the SDK, including the following:
+ *
+ *  - `thoughtSpotHost` - ThoughtSpot host URL
+ *  - `authType`: The authentication method used. For example,
+ * `AuthServerCookieless` for  `AuthType.TrustedAuthTokenCookieless`
+ *  - `customizations` - Style, text, and icon customization settings
+ *  that were applied during the SDK initialization.
+ * 
+ * For a comprehensive list of embed configuration settings,
+ * see link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[Developer Documentation].
+ *
+ * ```json
+ * {
+ *   "thoughtSpotHost": "https://{ThoughtSpot-Host}",
+ *   "authType": "AuthServerCookieless",
+ *   "customizations": {
+ *    "style": {
+ *        "customCSS": {
+ *        "variables": {
+ *            "--ts-var-button--secondary-background": "#7492d5",
+ *            "--ts-var-button--secondary--hovers-background": "#aac2f8",
+ *            "--ts-var-root-background": "#f1f4f8"
+ *          }
+ *        }
+ *      }
+ *    },
+ *   "loginFailedMessage": "Login failed, please try again",
+ *   "authTriggerText": "Authorize",
+ *   "disableTokenVerification": true,
+ *   "authTriggerContainer": "#your-own-div"
+ *  }
+ * ```
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.cl, and later
  * @group Global methods
  */
 export const getEmbedConfig = (): EmbedConfig => getValueFromWindow(configKey) || ({} as any);
@@ -15,10 +58,10 @@ export const getEmbedConfig = (): EmbedConfig => getValueFromWindow(configKey) |
  * Sets the configuration embed was initialized with.
  * And returns the new configuration.
  * @param newConfig The configuration to set.
- * @version SDK: 1.27.0 | ThoughtSpot: *
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.1.sw, and later
  * @group Global methods
  */
 export const setEmbedConfig = (newConfig: EmbedConfig) => {
     storeValueInWindow(configKey, newConfig);
     return getValueFromWindow(configKey);
-};
+};

package/src/embed/liveboard.ts

@@ -192,7 +192,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
      * Show or hide the tab panel of the embedded Liveboard.
      * 
      * Supported embed types: `LiveboardEmbed`
-     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
+     * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -674,7 +674,7 @@ export class LiveboardEmbed extends V1Embed {
 
     /**
      * Returns the full url of the Liveboard/visualization which can be used to open
-     * this Liveboard inside the full Thoughtspot application in a new tab.
+     * this Liveboard inside the full ThoughtSpot application in a new tab.
      * @returns url string
      */
     public getLiveboardUrl(): string {

package/src/embed/sage.ts

@@ -48,39 +48,39 @@ export interface SageViewConfig
     showObjectResults?: boolean;
     /**
      * flag used by the TS product tour page to show the blue search bar
-     * even after the search is completed. This is different from Thoughtspot Embedded
+     * even after the search is completed. This is different from ThoughtSpot Embedded
      * Sage Embed experience where it mimics closer to the non-embed case.
      * The Sample questions container is collapsed when this value is set after
      * does a search.
-     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
      * @hidden
      */
     isProductTour?: boolean;
     /**
      * Show or hide the search bar title.
-     * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
-     * @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
+     * @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
+     * @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
      */
     hideSearchBarTitle?: boolean;
     /**
      * Show or hide the Answer header, that is, the `AI Answer` title
      * at the top of the Answer page.
-     * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl
      */
     hideSageAnswerHeader?: boolean;
     /**
      * Disable the worksheet selection option.
-     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     disableWorksheetChange?: boolean;
     /**
      * Hide the worksheet selection panel.
-     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     hideWorksheetSelector?: boolean;
     /**
      * Show or hide autocomplete suggestions for the search query string.
-     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     hideAutocompleteSuggestions?: boolean;
     /**
@@ -96,7 +96,7 @@ export interface SageViewConfig
      * selected for the search operation.
      * 
      * Supported embed types: `SageEmbed`
-     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      * @example
      * ```js
      * const embed = new SageEmbed('#tsEmbed', {
@@ -129,7 +129,7 @@ export interface SageViewConfig
      *    executeSearch: true,
      * }
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     searchOptions?: SearchOptions;
 }

package/src/embed/search.ts

@@ -272,7 +272,7 @@ export interface SearchViewConfig
     /**
      * To set the initial state of the search bar in case of saved-answers.
      * @default false
-     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
      * @deprecated Use {@link collapseSearchBar} instead
      */
     collapseSearchBarInitially?: boolean;
@@ -280,7 +280,7 @@ export interface SearchViewConfig
      * Flag to enable onBeforeSearchExecute Embed Event
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+     * @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
      */
     isOnBeforeGetVizDataInterceptEnabled?: boolean;
     /**
@@ -292,7 +292,7 @@ export interface SearchViewConfig
      * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
      * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
      * @example
      * ```js
@@ -309,7 +309,7 @@ export interface SearchViewConfig
      * lands on search embed page.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.3.0.cl
      * @default true
      * @example
      * ```js

package/src/embed/ts-embed.spec.ts

@@ -1360,6 +1360,231 @@ describe('Unit test case for ts embed', () => {
         });
     });
 
+    describe('Preauth Cache for FullAppEmbed with PrimaryNavBar', () => {
+        beforeAll(() => {
+            jest.clearAllMocks();
+            init({
+                thoughtSpotHost,
+                authType: AuthType.None,
+            });
+        });
+        afterEach(() => {
+            jest.clearAllMocks();
+        });
+        
+        afterAll(() => {
+            jest.clearAllMocks();
+        });
+
+        const setupPreauthTest = async (
+            embedType: 'AppEmbed' | 'SearchEmbed',
+            showPrimaryNavbar?: boolean,
+            overrideOrgId?: number,
+            disablePreauthCache?: boolean
+        ) => {
+            jest.spyOn(window, 'addEventListener').mockImplementationOnce(
+                (event, handler, options) => {
+                    handler({
+                        data: { type: 'xyz' },
+                        ports: [3000],
+                        source: null,
+                    });
+                },
+            );
+            mockProcessTrigger.mockResolvedValueOnce({ session: 'test' });
+            jest.spyOn(baseInstance, 'getAuthPromise').mockResolvedValueOnce(true);
+
+            let mockGetPreauthInfo = null;
+            
+            // Determine if preauth cache should be enabled
+            const isAppEmbedWithPrimaryNavbar = embedType === 'AppEmbed' && showPrimaryNavbar === true;
+            const shouldDisableCache = overrideOrgId || disablePreauthCache || isAppEmbedWithPrimaryNavbar;
+            
+            if (shouldDisableCache) {
+                mockGetPreauthInfo = jest.spyOn(sessionInfoService, 'getPreauthInfo')
+                    .mockImplementation(jest.fn());
+            } else {
+                mockGetPreauthInfo = jest.spyOn(sessionInfoService, 'getPreauthInfo')
+                    .mockResolvedValue({ info: { test: 'data' } });
+            }
+
+            const mockPreauthInfoFetch = jest.spyOn(authService, 'fetchPreauthInfoService')
+                .mockResolvedValueOnce({
+                    ok: true,
+                    headers: new Headers({ 'content-type': 'application/json' }),
+                    json: async () => ({
+                        info: { test: 'data' },
+                    }),
+                } as any);
+
+            const viewConfig: any = {
+                frameParams: { width: 1280, height: 720 },
+            };
+
+            if (showPrimaryNavbar !== undefined) {
+                viewConfig.showPrimaryNavbar = showPrimaryNavbar;
+            }
+            if (overrideOrgId !== undefined) {
+                viewConfig.overrideOrgId = overrideOrgId;
+            }
+
+            // Mock getEmbedConfig for disablePreauthCache
+            if (disablePreauthCache !== undefined) {
+                jest.spyOn(embedConfig, 'getEmbedConfig').mockReturnValueOnce({
+                    thoughtSpotHost,
+                    authType: AuthType.None,
+                    disablePreauthCache,
+                });
+            }
+
+            let embed;
+            if (embedType === 'AppEmbed') {
+                embed = new AppEmbed(getRootEl(), viewConfig);
+            } else {
+                embed = new SearchEmbed(getRootEl(), viewConfig);
+            }
+
+            const iFrame: any = document.createElement('div');
+            iFrame.contentWindow = {
+                postMessage: jest.fn(),
+            };
+            jest.spyOn(iFrame, 'addEventListener').mockImplementationOnce(
+                (event, handler, options) => {
+                    handler({});
+                },
+            );
+            jest.spyOn(document, 'createElement').mockReturnValueOnce(iFrame);
+
+            await embed.render();
+
+            return {
+                embed,
+                mockGetPreauthInfo,
+                mockPreauthInfoFetch,
+                iFrame,
+            };
+        };
+
+        test('should disable preauth cache for FullAppEmbed with showPrimaryNavbar = true (default)', async () => {
+            const { mockGetPreauthInfo } = await setupPreauthTest('AppEmbed', true);
+            
+            // Wait for any async operations
+            await executeAfterWait(() => {
+                expect(mockGetPreauthInfo).toHaveBeenCalledTimes(0);
+            });
+        });
+
+        test('should enable preauth cache for FullAppEmbed with showPrimaryNavbar = undefined (no longer defaults to true)', async () => {
+            const { mockGetPreauthInfo } = await setupPreauthTest('AppEmbed', undefined);
+            
+            await executeAfterWait(() => {
+                expect(mockGetPreauthInfo).toHaveBeenCalledTimes(1);
+                expect(mockProcessTrigger).toHaveBeenCalledWith(
+                    expect.any(Object),
+                    HostEvent.InfoSuccess,
+                    'http://tshost',
+                    expect.objectContaining({ info: expect.any(Object) }),
+                );
+            });
+        });
+
+        test('should enable preauth cache for FullAppEmbed with showPrimaryNavbar = false', async () => {
+            const { mockGetPreauthInfo } = await setupPreauthTest('AppEmbed', false);
+            
+            await executeAfterWait(() => {
+                expect(mockGetPreauthInfo).toHaveBeenCalledTimes(1);
+                expect(mockProcessTrigger).toHaveBeenCalledWith(
+                    expect.any(Object),
+                    HostEvent.InfoSuccess,
+                    'http://tshost',
+                    expect.objectContaining({ info: expect.any(Object) }),
+                );
+            });
+        });
+
+        test('should enable preauth cache for SearchEmbed regardless of showPrimaryNavbar', async () => {
+            const { mockGetPreauthInfo } = await setupPreauthTest('SearchEmbed', true);
+            
+            await executeAfterWait(() => {
+                expect(mockGetPreauthInfo).toHaveBeenCalledTimes(1);
+                expect(mockProcessTrigger).toHaveBeenCalledWith(
+                    expect.any(Object),
+                    HostEvent.InfoSuccess,
+                    'http://tshost',
+                    expect.objectContaining({ info: expect.any(Object) }),
+                );
+            });
+        });
+
+        test('should enable preauth cache for SearchEmbed (verifies fix for embed type regression)', async () => {
+            const { mockGetPreauthInfo } = await setupPreauthTest('SearchEmbed', false);
+            
+            await executeAfterWait(() => {
+                expect(mockGetPreauthInfo).toHaveBeenCalledTimes(1);
+                expect(mockProcessTrigger).toHaveBeenCalledWith(
+                    expect.any(Object),
+                    HostEvent.InfoSuccess,
+                    'http://tshost',
+                    expect.objectContaining({ info: expect.any(Object) }),
+                );
+            });
+        });
+
+        test('should disable preauth cache for FullAppEmbed with overrideOrgId (combined condition)', async () => {
+            const { mockGetPreauthInfo } = await setupPreauthTest('AppEmbed', false, 123);
+            
+            await executeAfterWait(() => {
+                expect(mockGetPreauthInfo).toHaveBeenCalledTimes(0);
+            });
+        });
+
+        test('should disable preauth cache for FullAppEmbed with disablePreauthCache = true', async () => {
+            const { mockGetPreauthInfo } = await setupPreauthTest('AppEmbed', false, undefined, true);
+            
+            await executeAfterWait(() => {
+                expect(mockGetPreauthInfo).toHaveBeenCalledTimes(0);
+            });
+        });
+    });
+
+    describe('isFullAppEmbedWithVisiblePrimaryNavbar helper method', () => {
+        beforeAll(() => {
+            init({
+                thoughtSpotHost,
+                authType: AuthType.None,
+            });
+        });
+
+        afterEach(() => {
+            jest.clearAllMocks();
+        });
+
+        test('should return true for AppEmbed with showPrimaryNavbar = true', () => {
+            const appEmbed = new AppEmbed(getRootEl(), { showPrimaryNavbar: true });
+            expect(appEmbed['isFullAppEmbedWithVisiblePrimaryNavbar']()).toBe(true);
+        });
+
+        test('should return false for AppEmbed with showPrimaryNavbar = undefined (no longer defaults to true)', () => {
+            const appEmbed = new AppEmbed(getRootEl(), {});
+            expect(appEmbed['isFullAppEmbedWithVisiblePrimaryNavbar']()).toBe(false);
+        });
+
+        test('should return false for AppEmbed with showPrimaryNavbar = false', () => {
+            const appEmbed = new AppEmbed(getRootEl(), { showPrimaryNavbar: false });
+            expect(appEmbed['isFullAppEmbedWithVisiblePrimaryNavbar']()).toBe(false);
+        });
+
+        test('should return false for SearchEmbed (not FullAppEmbed)', () => {
+            const searchEmbed = new SearchEmbed(getRootEl(), {});
+            expect(searchEmbed['isFullAppEmbedWithVisiblePrimaryNavbar']()).toBe(false);
+        });
+
+        test('should return false for LiveboardEmbed (not FullAppEmbed)', () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), { liveboardId: 'test-id' });
+            expect(liveboardEmbed['isFullAppEmbedWithVisiblePrimaryNavbar']()).toBe(false);
+        });
+    });
+
     describe('when thoughtSpotHost have value and authPromise return error', () => {
         beforeAll(() => {
             init({

package/src/embed/ts-embed.ts

@@ -264,13 +264,32 @@ export class TsEmbed {
         //    - cached auth info would be for wrong org
         //    - info call response changes for each different overrideOrgId
         // 2. disablePreauthCache is explicitly set to true
+        // 3. FullAppEmbed has primary navbar visible since:
+        //    - primary navbar requires fresh auth state for navigation
+        //    - cached auth may not reflect current user permissions
         const isDisabled = (
             this.viewConfig.overrideOrgId !== undefined
             || this.embedConfig.disablePreauthCache === true
+            || this.isFullAppEmbedWithVisiblePrimaryNavbar()
         );
         return !isDisabled;
     }
 
+    /**
+     * Checks if current embed is FullAppEmbed with visible primary navbar
+     * @returns boolean
+     */
+    private isFullAppEmbedWithVisiblePrimaryNavbar(): boolean {
+        const appViewConfig = this.viewConfig as any;
+        
+        // Check if this is a FullAppEmbed (AppEmbed)
+        // showPrimaryNavbar defaults to true if not explicitly set to false
+        return (
+            appViewConfig.embedComponentType === 'AppEmbed' 
+            && appViewConfig.showPrimaryNavbar === true
+        );
+    }
+
     /**
      * fix for ts7.sep.cl
      * will be removed for ts7.oct.cl

package/src/types.ts

@@ -275,7 +275,7 @@ export interface CustomStyles {
  * Configuration to define the customization on the Embedded
  * ThoughtSpot components.
  * You can customize styles, text strings, and icons.
- * For more information, see https://developers.thoughtspot.com/docs/custom-css.
+ * For more information, see link:https://developers.thoughtspot.com/docs/custom-css[CSS customization framework].
  * @example
  * ```js
  *  init({
@@ -2554,7 +2554,7 @@ export enum EmbedEvent {
      *
      * error: Developers can customize the error message text when `execute`
      * returns `false` using the error parameter in responder.
-     * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
+     * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
      * @example
      *```js
      * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -2601,7 +2601,7 @@ export enum EmbedEvent {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
+     * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
      */
     ParameterChanged = 'parameterChanged',
     /**
@@ -2657,18 +2657,18 @@ export enum EmbedEvent {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK : 1.37.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.37.0 | ThoughtSpot : 10.8.0.cl
+     * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
      CreateModel = 'createModel',
     /**
      * @hidden
      * Emitted when a user exits present mode.
-     * @version SDK : 1.40.0 | ThoughtSpot : 10.11.0.cl
+     * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     ExitPresentMode = 'exitPresentMode',
 }
@@ -3925,6 +3925,7 @@ export enum Param {
  *    hiddenActions: [Action.Edit, ActionAction.Explore],
  * })
  * ```
+ * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
  */
 // eslint-disable-next-line no-shadow
 export enum Action {