@thoughtspot/visual-embed-sdk 1.52.2-beta.2 → 1.53.0

package/src/embed/liveboard.spec.ts

@@ -1,4 +1,5 @@
 import { LiveboardViewConfig, LiveboardEmbed } from './liveboard';
+import { SpotterExperienceVersion } from './spotter-utils';
 import { init, UIPassthroughEvent } from '../index';
 import {
     Action,
@@ -174,6 +175,37 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set EditLiveboard and EditVisualization independently of each other and of Edit', async () => {
+        expect(Action.Edit).toBe('edit');
+        expect(Action.EditLiveboard).toBe('editLiveboard');
+        expect(Action.EditVisualization).toBe('editVisualization');
+
+        const liveboardEmbed1 = new LiveboardEmbed(getRootEl(), {
+            hiddenActions: [Action.EditVisualization],
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed1.render();
+        await executeAfterWait(() => {
+            expectUrlToHaveParamsWithValues(getIFrameSrc(), {
+                hideAction: JSON.stringify([Action.ReportError, Action.EditVisualization]),
+            });
+        });
+
+        document.body.innerHTML = getDocumentBody();
+        const liveboardEmbed2 = new LiveboardEmbed(getRootEl(), {
+            hiddenActions: [Action.EditLiveboard],
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed2.render();
+        await executeAfterWait(() => {
+            expectUrlToHaveParamsWithValues(getIFrameSrc(), {
+                hideAction: JSON.stringify([Action.ReportError, Action.EditLiveboard]),
+            });
+        });
+    });
+
     test('should set visible actions', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             visibleActions: [Action.DownloadAsCsv, Action.DownloadAsPdf, Action.DownloadAsXlsx],
@@ -1621,6 +1653,58 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    describe('liveboardOverride in APP_INIT embedParams', () => {
+        const liveboardOverride = {
+            dataSourceOverride: [{
+                dataSourceIdentifier: 'model-guid',
+                filterQuery: [{ tabName: 'Sales', groupName: 'Region', filterQueryToken: 'color = red' }],
+            }],
+        };
+
+        const getAppInitResponse = async (viewConfig: Partial<LiveboardViewConfig>) => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                ...viewConfig,
+            } as LiveboardViewConfig);
+
+            mockMessageChannel();
+            await liveboardEmbed.render();
+
+            const mockPort: any = { postMessage: jest.fn() };
+            await executeAfterWait(() => {
+                postMessageToParent(getIFrameEl().contentWindow, { type: EmbedEvent.APP_INIT, data: {} }, mockPort);
+            });
+            let data: any;
+            await executeAfterWait(() => {
+                data = mockPort.postMessage.mock.calls[0][0].data;
+            });
+            return data;
+        };
+
+        test('should include liveboardOverride when provided', async () => {
+            const data = await getAppInitResponse({ liveboardOverride });
+            expect(data.embedParams.liveboardOverride).toEqual(liveboardOverride);
+        });
+
+        test('should not include liveboardOverride when not provided', async () => {
+            const data = await getAppInitResponse({});
+            expect(data.embedParams?.liveboardOverride).toBeUndefined();
+        });
+
+        test('should not include liveboardOverride when dataSourceOverride is empty', async () => {
+            const data = await getAppInitResponse({ liveboardOverride: { dataSourceOverride: [] } });
+            expect(data.embedParams?.liveboardOverride).toBeUndefined();
+        });
+
+        test('should send liveboardOverride alongside spotterVizConfig', async () => {
+            const spotterViz = { brandName: 'MyBrand' };
+            const data = await getAppInitResponse({ liveboardOverride, spotterViz });
+            expect(data.embedParams.liveboardOverride).toEqual(liveboardOverride);
+            expect(data.embedParams.spotterVizConfig).toEqual(spotterViz);
+        });
+    });
+
     test('should include starterPrompts in APP_INIT embedParams', async () => {
         const starterPrompts = {
             enable: true,
@@ -2748,98 +2832,6 @@ describe('Liveboard/viz embed tests', () => {
             expect(navigateToLiveboardSpy).toHaveBeenCalled();
         });
 
-        test('should not route via home when a new instance shows an equal config', async () => {
-            const viewConfig = {
-                liveboardId,
-                vizId,
-                activeTabId,
-                ...defaultViewConfig,
-            };
-            const previous = new LiveboardEmbed(getRootEl(), { ...viewConfig, beforeRender: () => {} } as any);
-            const liveboardEmbed = new LiveboardEmbed(getRootEl(), { ...viewConfig, beforeRender: () => {} } as any);
-
-            // React constructs a new embed on every mount.
-            jest.spyOn(liveboardEmbed as any, 'getPreRenderObj').mockReturnValue(previous);
-            const triggerSpy = jest
-                .spyOn(liveboardEmbed, 'trigger')
-                .mockImplementation(() => Promise.resolve(undefined as any));
-            const navigateToLiveboardSpy = jest
-                .spyOn(liveboardEmbed, 'navigateToLiveboard')
-                .mockImplementation(() => Promise.resolve(undefined));
-
-            liveboardEmbed.isEmbedContainerLoaded = false;
-            liveboardEmbed['beforePrerenderVisible']();
-            liveboardEmbed.isEmbedContainerLoaded = true;
-            liveboardEmbed['executeEmbedContainerReadyCallbacks']();
-            await waitForPreRenderNavigate();
-
-            expect(triggerSpy).not.toHaveBeenCalledWith(HostEvent.Navigate, 'home');
-            expect(navigateToLiveboardSpy).toHaveBeenCalled();
-        });
-
-        test('should not route via home when the previous instance has been shown once', async () => {
-            // navigateToLiveboard assigns vizId/activeTabId/personalizedViewId
-            // unconditionally, so a shown instance carries them as undefined
-            // while a fresh one lacks the keys entirely. Comparing raw objects
-            // counts own keys, so it never matches again.
-            const viewConfig = { liveboardId, ...defaultViewConfig };
-            const previous = new LiveboardEmbed(getRootEl(), { ...viewConfig } as any);
-            (previous as any).viewConfig.vizId = undefined;
-            (previous as any).viewConfig.activeTabId = undefined;
-            (previous as any).viewConfig.personalizedViewId = undefined;
-
-            const liveboardEmbed = new LiveboardEmbed(getRootEl(), { ...viewConfig } as any);
-
-            jest.spyOn(liveboardEmbed as any, 'getPreRenderObj').mockReturnValue(previous);
-            const triggerSpy = jest
-                .spyOn(liveboardEmbed, 'trigger')
-                .mockImplementation(() => Promise.resolve(undefined as any));
-            jest
-                .spyOn(liveboardEmbed, 'navigateToLiveboard')
-                .mockImplementation(() => Promise.resolve(undefined));
-
-            liveboardEmbed.isEmbedContainerLoaded = false;
-            liveboardEmbed['beforePrerenderVisible']();
-            liveboardEmbed.isEmbedContainerLoaded = true;
-            liveboardEmbed['executeEmbedContainerReadyCallbacks']();
-            await waitForPreRenderNavigate();
-
-            expect(triggerSpy).not.toHaveBeenCalledWith(HostEvent.Navigate, 'home');
-        });
-
-        test('should route via home when a new instance shows the same route with other filters', async () => {
-            const viewConfig = {
-                liveboardId,
-                vizId,
-                activeTabId,
-                ...defaultViewConfig,
-            };
-            const previous = new LiveboardEmbed(getRootEl(), {
-                ...viewConfig,
-                runtimeFilters: [{ columnName: 'region', operator: RuntimeFilterOp.EQ, values: ['east'] }],
-            });
-            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
-                ...viewConfig,
-                runtimeFilters: [{ columnName: 'region', operator: RuntimeFilterOp.EQ, values: ['west'] }],
-            });
-
-            jest.spyOn(liveboardEmbed as any, 'getPreRenderObj').mockReturnValue(previous);
-            const triggerSpy = jest
-                .spyOn(liveboardEmbed, 'trigger')
-                .mockImplementation(() => Promise.resolve(undefined as any));
-            jest
-                .spyOn(liveboardEmbed, 'navigateToLiveboard')
-                .mockImplementation(() => Promise.resolve(undefined));
-
-            liveboardEmbed.isEmbedContainerLoaded = false;
-            liveboardEmbed['beforePrerenderVisible']();
-            liveboardEmbed.isEmbedContainerLoaded = true;
-            liveboardEmbed['executeEmbedContainerReadyCallbacks']();
-            await waitForHomeHopNavigate();
-
-            expect(triggerSpy).toHaveBeenCalledWith(HostEvent.Navigate, 'home');
-        });
-
         test('should not route via home when the pre-render is on another liveboard', async () => {
             const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
                 liveboardId,
@@ -3179,3 +3171,38 @@ describe('LiveboardEmbed updatedSpotterExperience tests', () => {
         });
     });
 });
+
+describe('LiveboardEmbed spotterExperienceVersion tests', () => {
+    beforeEach(() => {
+        document.body.innerHTML = getDocumentBody();
+    });
+
+    const renderWithConfig = async (config: Partial<LiveboardViewConfig>) => {
+        document.body.innerHTML = getDocumentBody();
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            ...config,
+        } as LiveboardViewConfig);
+        await liveboardEmbed.render();
+        let src = '';
+        await executeAfterWait(() => {
+            src = getIFrameSrc();
+        });
+        return src;
+    };
+
+    test('should add the spotterExperienceVersion param when spotterExperienceVersion is set', async () => {
+        const src = await renderWithConfig({
+            spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
+        });
+        expect(src).toContain(
+            `spotterExperienceVersion=${SpotterExperienceVersion.SPOTTER_2026_11}`,
+        );
+    });
+
+    test('should not add the spotterExperienceVersion param when spotterExperienceVersion is not set', async () => {
+        const src = await renderWithConfig({});
+        expect(src).not.toContain('spotterExperienceVersion=');
+    });
+});

package/src/embed/liveboard.ts

@@ -8,7 +8,6 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 
-import isEqualWith from 'lodash/isEqualWith';
 import { getPreview } from '../utils/graphql/preview-service';
 import { ERROR_MESSAGE } from '../errors';
 import {
@@ -35,8 +34,9 @@ import { addPreviewStylesIfNotPresent } from '../utils/global-styles';
 import { HostEventRequest, TriggerData, TriggerResponse } from '../contracts/host-event-contracts';
 import { logger } from '../utils/logger';
 import { SpotterChatViewConfig, StarterPromptsConfig } from './conversation';
-import { buildStarterPromptsAppInitData } from './spotter-utils';
+import { buildStarterPromptsAppInitData, SpotterExperienceVersion } from './spotter-utils';
 import { SpotterVizConfig, buildSpotterVizAppInitData } from './spotter-viz-utils';
+import { LiveboardOverride, buildLiveboardOverrideAppInitData } from './liveboard-override-utils';
 
 // Home unmounts the liveboard container, which is how its state gets cleared.
 // The settle window gives the container time to do it before we ask for the
@@ -52,6 +52,7 @@ export interface LiveboardEmbedAppInitData extends DefaultAppInitData {
     embedParams?: {
         spotterVizConfig?: SpotterVizConfig;
         starterPrompts?: StarterPromptsConfig;
+        liveboardOverride?: LiveboardOverride;
     };
 }
 
@@ -61,7 +62,8 @@ export interface LiveboardEmbedAppInitData extends DefaultAppInitData {
  * @group Embed components
  */
 export interface LiveboardViewConfig
-    extends BaseViewConfig,
+    extends
+        BaseViewConfig,
         FullHeightViewConfig,
         LiveboardOtherViewConfig,
         LiveboardAppEmbedViewConfig {
@@ -546,6 +548,46 @@ export interface LiveboardViewConfig
      * ```
      */
     updatedSpotterExperience?: boolean;
+    /**
+     * Filters and Parameters to apply to the Liveboard when it loads.
+     *
+     * In an embedded Liveboard, this is the only way to set these overrides.
+     * The `filter` and `parameter` URL query params are ignored.
+     * Clauses without a query token are dropped.
+     *
+     * Supported embed types: `LiveboardEmbed`
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    liveboardOverride: {
+     *        dataSourceOverride: [{
+     *            dataSourceIdentifier: '<model-guid>',
+     *            filterQuery: [{
+     *                tabName: 'Sales',
+     *                groupName: 'Region',
+     *                filterQueryToken: 'color = red',
+     *            }],
+     *        }],
+     *    },
+     * })
+     * ```
+     */
+    liveboardOverride?: LiveboardOverride;
+    /**
+     * The Spotter experience version to load for the Spotter surface shown within
+     * this embed.
+     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... // other options
+     *    spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
+     * });
+     * ```
+     */
+    spotterExperienceVersion?: SpotterExperienceVersion;
 }
 
 /**
@@ -563,14 +605,6 @@ export interface LiveboardViewConfig
  * })
  * ```
  */
-/**
- * A shallow copy without the keys whose value is `undefined`, so a key that was
- * assigned `undefined` compares equal to one that was never set.
- */
-const definedEntries = (config: Record<string, any> = {}): Record<string, any> => Object.fromEntries(
-    Object.entries(config).filter(([, value]) => value !== undefined),
-);
-
 export class LiveboardEmbed extends V1Embed {
     protected viewConfig: LiveboardViewConfig;
 
@@ -600,7 +634,8 @@ export class LiveboardEmbed extends V1Embed {
     protected async getAppInitData(): Promise<LiveboardEmbedAppInitData> {
         const defaultAppInitData = await super.getAppInitData();
         const vizInitData = buildSpotterVizAppInitData(defaultAppInitData, this.viewConfig);
-        return buildStarterPromptsAppInitData(vizInitData, this.viewConfig);
+        const starterPromptsInitData = buildStarterPromptsAppInitData(vizInitData, this.viewConfig);
+        return buildLiveboardOverrideAppInitData(starterPromptsInitData, this.viewConfig);
     }
 
     /**
@@ -608,7 +643,7 @@ export class LiveboardEmbed extends V1Embed {
      * embedded Liveboard or visualization.
      */
     protected getEmbedParams() {
-        const params = this.getEmbedParamsObject();
+        const params = this.getUrlQueryParamsObject();
         const queryParams = getQueryParamString(params, true);
         return queryParams;
     }
@@ -661,6 +696,7 @@ export class LiveboardEmbed extends V1Embed {
             isThisPeriodInDateFiltersEnabled,
             isContinuousLiveboardPDFEnabled,
             enableLiveboardDataCache,
+            spotterExperienceVersion,
         } = this.viewConfig;
 
         const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
@@ -730,6 +766,10 @@ export class LiveboardEmbed extends V1Embed {
             params[Param.IsLiveboardStylingAndGroupingEnabled] = isLiveboardStylingAndGroupingEnabled;
         }
 
+        if (spotterExperienceVersion !== undefined) {
+            params[Param.SpotterExperienceVersion] = spotterExperienceVersion;
+        }
+
         if (liveboardGutter !== undefined) {
             params[Param.LiveboardGutter] = liveboardGutter;
         }
@@ -964,12 +1004,10 @@ export class LiveboardEmbed extends V1Embed {
         super.beforePrerenderVisible();
 
         // Captured before showPreRender() hands the wrapper over to this
-        // instance. React builds a new instance per mount, so an equal config
-        // is a hide/show, not a hand-over: there is nothing stale to clear.
+        // instance. Itself means a hide/show, not a hand-over, so there is
+        // nothing stale to clear.
         const previous = this.getPreRenderObj<LiveboardEmbed>();
-        const showing = this.isSameEmbedConfig(previous)
-            ? undefined
-            : previous?.currentLiveboardState;
+        const showing = previous === this ? undefined : previous?.currentLiveboardState;
 
         this.executeAfterEmbedContainerLoaded(async () => {
             // Without this the params callback suspends on its await and
@@ -1003,28 +1041,6 @@ export class LiveboardEmbed extends V1Embed {
         });
     }
 
-    /**
-     * Whether `previous` was showing what this instance is about to show.
-     *
-     * Undefined-valued keys are dropped before comparing. `navigateToLiveboard`
-     * assigns `vizId`, `activeTabId` and `personalizedViewId` unconditionally,
-     * so an instance that has been shown once carries those keys as `undefined`
-     * while a freshly constructed one does not have them at all. `isEqual`
-     * counts own keys, so without this the comparison can never be true after
-     * the first show — which is the whole case this exists for.
-     *
-     * Callbacks compare as equal: React passes a fresh closure per render.
-     */
-    private isSameEmbedConfig(previous?: LiveboardEmbed): boolean {
-        if (!previous) return false;
-        if (previous === this) return true;
-        return isEqualWith(
-            definedEntries(previous.viewConfig),
-            definedEntries(this.viewConfig),
-            (a, b) => (typeof a === 'function' && typeof b === 'function' ? true : undefined),
-        );
-    }
-
     // The whole route, not just the liveboard id: the path is built from the
     // viz, tab and view too, so a same-liveboard show onto another tab is a
     // real navigation.

package/src/embed/search-bar.tsx

@@ -163,7 +163,7 @@ export class SearchBarEmbed extends TsEmbed {
      * @param dataSources A list of data source GUIDs
      */
     private getIFrameSrc() {
-        const queryParams = this.getEmbedParamsObject();
+        const queryParams = this.getUrlQueryParamsObject();
         const path = 'search-bar-embed';
        
         let query = '';

package/src/embed/search.spec.ts

@@ -854,6 +854,29 @@ test('should pass forceTable parameter when forceTable is true', async () => {
 });
 
 describe('SearchBarEmbed tests', () => {
+    test('should keep view config off the URL when excludeConfigFromURL is set', async () => {
+        const searchBarEmbed = new SearchBarEmbed(getRootEl() as any, {
+            ...defaultViewConfig,
+            dataSources: ['source-1', 'source-2'],
+            additionalFlags: { excludeConfigFromURL: true },
+        } as any);
+        searchBarEmbed.render();
+        await executeAfterWait(() => {
+            const iframeSrc = getIFrameSrc();
+
+            // Bootstrap params stay: the handshake, the embed marker that
+            // picks the app shell, and the data sources it boots against.
+            expect(iframeSrc).toContain('hostAppUrl=');
+            expect(iframeSrc).toContain('isSearchEmbed=true');
+            expect(iframeSrc).toContain('dataSources');
+
+            // The rest of the view config goes over
+            // HostEvent.UpdateEmbedParams.
+            expect(iframeSrc).not.toContain('hideAction');
+            expect(iframeSrc).not.toContain('useLastSelectedDataSource');
+        });
+    });
+
     test('should pass dataSources parameter when dataSources array is provided', async () => {
         const searchBarEmbed = new SearchBarEmbed(getRootEl() as any, {
             ...defaultViewConfig,

package/src/embed/search.ts

@@ -546,7 +546,7 @@ export class SearchEmbed extends TsEmbed {
             excludeRuntimeParametersfromURL,
             excludeRuntimeFiltersfromURL,
         } = this.viewConfig;
-        const queryParams = this.getEmbedParamsObject();
+        const queryParams = this.getUrlQueryParamsObject();
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {

package/src/embed/spotter-utils.ts

@@ -130,3 +130,15 @@ export function buildSpotterAnalystAppInitData<T extends DefaultAppInitData>(
         },
     };
 }
+
+/**
+ * The Spotter experience version to load in the embedded view.
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl
+ * @group Embed components
+ */
+export enum SpotterExperienceVersion {
+    /**
+     * The Spotter experience version introduced in ThoughtSpot 26.11.
+     */
+    SPOTTER_2026_11 = 'spotter_2026_11',
+}

package/src/embed/spotter-viz-utils.spec.ts

@@ -37,6 +37,17 @@ describe('buildSpotterVizAppInitData', () => {
         expect(result.embedParams?.spotterVizConfig?.insightTileLoaderText).toBe('Generating insight');
     });
 
+    it('passes fileUploadEnabled and fileUploadFileTypes through spotterVizConfig', () => {
+        const spotterViz = {
+            brandName: 'MyBrand',
+            fileUploadEnabled: false,
+            fileUploadFileTypes: ['csv', '.pdf'],
+        };
+        const result = buildSpotterVizAppInitData(base, { spotterViz });
+        expect(result.embedParams?.spotterVizConfig?.fileUploadEnabled).toBe(false);
+        expect(result.embedParams?.spotterVizConfig?.fileUploadFileTypes).toEqual(['csv', '.pdf']);
+    });
+
     it('preserves existing embedParams when adding spotterVizConfig', () => {
         const existing = { ...base, embedParams: { spotterSidebarConfig: { enablePastConversationsSidebar: true } } };
         const spotterViz = { brandName: 'MyBrand' };

package/src/embed/spotter-viz-utils.ts

@@ -127,6 +127,21 @@ export interface SpotterVizConfig {
      * @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
      */
     insightTileLoaderText?: string;
+    /**
+     * Set to `false` to hide the file upload feature in the SpotterViz chat
+     * input on a cluster where the feature is available.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @default true
+     */
+    fileUploadEnabled?: boolean;
+    /**
+     * Restricts the allowed file types for SpotterViz file upload to a
+     * subset of the types SpotterViz supports, e.g. `['csv', 'pdf']`.
+     * Entries are file extensions (with or without the leading dot); types
+     * SpotterViz does not support are ignored, as are empty lists.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     */
+    fileUploadFileTypes?: string[];
 }
 
 /**