@thoughtspot/visual-embed-sdk 1.39.1 → 1.39.2-alpha.1

package/src/embed/conversation.ts

@@ -1,10 +1,10 @@
 import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
-import { Param, BaseViewConfig } from '../types';
+import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter } from '../types';
 import { TsEmbed } from './ts-embed';
-import { getQueryParamString } from '../utils';
+import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils';
 
-/** 
+/**
  * Configuration for search options
  */
 export interface SearchOptions {
@@ -20,7 +20,8 @@ export interface SearchOptions {
  */
 export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
     /**
-     * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
+     * The ID of the data source object. For example, Model, View, or Table. Spotter uses
+     * this object to query data and generate Answers.
      */
     worksheetId: string;
     /**
@@ -30,7 +31,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     /**
      * disableSourceSelection : Disables data source selection
      * but still display the selected data source.
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -44,7 +45,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     disableSourceSelection?: boolean;
     /**
      * hideSourceSelection : Hide data source selection
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -58,7 +59,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     hideSourceSelection?: boolean;
     /**
      * Flag to control Data panel experience
-     * 
+     *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default false
      * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
@@ -76,7 +77,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * showSpotterLimitations : show limitation text
      * of the spotter underneath the chat input.
      * default is false.
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -91,7 +92,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     /**
      * hideSampleQuestions : Hide sample questions on
      * the initial screen of the conversation.
-     * 
+     *
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -103,6 +104,63 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     hideSampleQuestions?: boolean;
+    /**
+     * The list of runtime filters to apply to a search Answer,
+     * visualization, or Liveboard.
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    runtimeFilters: [
+     *           {
+     *             columnName: 'value',
+     *             operator: RuntimeFilterOp.EQ,
+     *             values: ['string' | 123 | true],
+     *           },
+     *       ],
+     * })
+     * ```
+     */
+    runtimeFilters?: RuntimeFilter[];
+    /**
+     * Flag to control whether runtime filters should be included in the URL.
+     * If true, filters will be passed via app initialization payload instead.
+     * If false/undefined, filters will be added to URL (default behavior).
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @default false
+     */
+    excludeRuntimeFiltersfromURL?: boolean;
+    /**
+     * The list of runtime parameters to apply to the conversation.
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    runtimeParameters: [
+     *           {
+     *             name: 'Parameter Name',
+     *             value: 'Parameter Value',
+     *           },
+     *       ],
+     * })
+     * ```
+     */
+    runtimeParameters?: RuntimeParameter[];
+    /**
+     * Flag to control whether runtime parameters should be included in the URL.
+     * If true, parameters will be passed via app initialization payload instead.
+     * If false/undefined, parameters will be added to URL (default behavior).
+     *
+     * Supported embed types: `SpotterEmbed`
+     * @default false
+     *
+     */
+    excludeRuntimeParametersfromURL?: boolean;
 }
 
 /**
@@ -144,6 +202,10 @@ export class SpotterEmbed extends TsEmbed {
             dataPanelV2,
             showSpotterLimitations,
             hideSampleQuestions,
+            runtimeFilters,
+            excludeRuntimeFiltersfromURL,
+            runtimeParameters,
+            excludeRuntimeParametersfromURL,
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         if (!worksheetId) {
@@ -175,11 +237,21 @@ export class SpotterEmbed extends TsEmbed {
         if (queryParamsString) {
             query = `?${queryParamsString}`;
         }
+
+        const filterQuery = getFilterQuery(runtimeFilters || []);
+        if (filterQuery && !excludeRuntimeFiltersfromURL) {
+            query += `&${filterQuery}`;
+        }
+
+        const parameterQuery = getRuntimeParameters(runtimeParameters || []);
+        if (parameterQuery && !excludeRuntimeParametersfromURL) {
+            query += `&${parameterQuery}`;
+        }
+
         const tsPostHashParams = this.getThoughtSpotPostUrlParams({
             worksheet: worksheetId,
             query: searchOptions?.searchQuery || '',
         });
-
         return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
     }
 

package/src/embed/embedConfig.ts

@@ -10,13 +10,14 @@ const configKey = 'embedConfig';
  *
  * @example
  * ```js
+ * import { getInitConfig } from '@thoughtspot/visual-embed-sdk';
+ * // Call the getInitConfig method to retrieve the embed configuration
  * const config = getInitConfig();
+ * // Log the configuration settings
  * console.log(config);
  * ```
- * @example
- *
- * Returns the `EmbedConfig` object, which
- * contains the configuration settings used to
+ * Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig]
+ * object, which contains the configuration settings used to
  * initialize the SDK, including the following:
  *
  *  - `thoughtSpotHost` - ThoughtSpot host URL
@@ -24,10 +25,11 @@ const configKey = 'embedConfig';
  * `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].
  *
+ * The following JSON output shows the embed configuration
+ * settings returned from the code in the previous example:
+ *
+ * @example
  * ```json
  * {
  *   "thoughtSpotHost": "https://{ThoughtSpot-Host}",
@@ -49,7 +51,7 @@ const configKey = 'embedConfig';
  *   "authTriggerContainer": "#your-own-div"
  *  }
  * ```
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.cl, and later
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later
  * @group Global methods
  */
 export const getEmbedConfig = (): EmbedConfig => getValueFromWindow(configKey) || ({} as any);

package/src/embed/liveboard.spec.ts

@@ -347,7 +347,7 @@ describe('Liveboard/viz embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&coverAndFilterOptionInPDF=true${prefixParams}#/embed/viz/${liveboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&arePdfCoverFilterPageCheckboxesEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
             );
         });
     });
@@ -362,7 +362,7 @@ describe('Liveboard/viz embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&coverAndFilterOptionInPDF=false&${prefixParams}#/embed/viz/${liveboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&arePdfCoverFilterPageCheckboxesEnabled=false&${prefixParams}#/embed/viz/${liveboardId}`,
             );
         });
     });
@@ -770,8 +770,9 @@ describe('Liveboard/viz embed tests', () => {
             });
 
             let resizeObserverCb: any;
-            (window as any).ResizeObserver = window.ResizeObserver
-                || jest.fn().mockImplementation((resizeObserverCbParam: any) => {
+            (window as any).ResizeObserver =
+                window.ResizeObserver ||
+                jest.fn().mockImplementation((resizeObserverCbParam: any) => {
                     resizeObserverCb = resizeObserverCbParam;
                     return {
                         disconnect: jest.fn(),

package/src/embed/liveboard.ts

@@ -269,24 +269,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
      * })
      */
     dataSourceId?: string;
-
-    /**
-     * This flag is for show/hide checkboxes for include or exclude
-     * cover page and filters in the Liveboard PDF.
-     * 
-     * Supported embed types: `LiveboardEmbed`
-     * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
-     * @default true
-     * Supported embed types: `LiveboardEmbed`
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#tsEmbed', {
-     *    ... //other embed view config
-     *    coverAndFilterOptionInPDF: false,
-     * })
-     * ```
-     */
-    coverAndFilterOptionInPDF?: boolean;
     /**
      * The list of tab IDs to hide from the embedded.
      * This Tabs will be hidden from their respective LBs.
@@ -411,7 +393,7 @@ export class LiveboardEmbed extends V1Embed {
             oAuthPollingInterval,
             isForceRedirect,
             dataSourceId,
-            coverAndFilterOptionInPDF,
+            coverAndFilterOptionInPDF = false,
             isLiveboardStylingAndGroupingEnabled,
         } = this.viewConfig;
 
@@ -471,9 +453,6 @@ export class LiveboardEmbed extends V1Embed {
             params[Param.DataSourceId] = dataSourceId;
         }
 
-        if (coverAndFilterOptionInPDF !== undefined) {
-            params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
-        }
 
         if (isLiveboardStylingAndGroupingEnabled !== undefined) {
             params[Param.IsLiveboardStylingAndGroupingEnabled] = isLiveboardStylingAndGroupingEnabled;
@@ -486,6 +465,7 @@ export class LiveboardEmbed extends V1Embed {
         params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
+        params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
         const queryParams = getQueryParamString(params, true);
 
         return queryParams;

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