@thoughtspot/visual-embed-sdk 1.50.0 → 1.50.1

package/package.json

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

package/src/css-variables.ts

@@ -499,6 +499,16 @@ export interface CustomCssVariables {
      */
     '--ts-var-liveboard-tile-background'?: string;
 
+    /**
+     * Font color of the insight tiles in the Liveboard.
+     */
+    '--ts-var-liveboard-insight-tile-font-color'?: string;
+
+    /**
+     * Background color of the insight tiles in the Liveboard.
+     */
+    '--ts-var-liveboard-insight-tile-background'?: string;
+
     /**
      * Border radius of the tiles in the Liveboard.
      */
@@ -1166,6 +1176,11 @@ export interface CustomCssVariables {
      */
     '--ts-var-spotterviz-border-color'?: string;
 
+    /**
+     * Expanded user chat message bubble border color in SpotterViz.
+     */
+    '--ts-var-spotterviz-expanded-border-color'?: string;
+
     /**
      * Background color of the reference-mode toggle button in the SpotterViz
      * chat input when it is unselected and the user hovers over it.
@@ -1185,4 +1200,62 @@ export interface CustomCssVariables {
      * on each referenced-entity chip in the chat input.
      */
     '--ts-var-spotterviz-reference-icon-selected-background'?: string;
+
+    /**
+     * Background color of the shared conversation header (recipient's read-only view).
+     */
+    '--ts-var-shared-conv-header-background'?: string;
+
+    /**
+     * Border color of the shared conversation header.
+     */
+    '--ts-var-shared-conv-header-border-color'?: string;
+
+    /**
+     * Font color of the title text in the shared conversation header.
+     */
+    '--ts-var-shared-conv-title-color'?: string;
+
+    /**
+     * Background gradient color-stop of the share chat header's outer container
+     * (sender's pre-share header). Defaults to transparent.
+     */
+    '--ts-var-share-chat-header-container-background'?: string;
+
+    /**
+     * Background color of the share chat header's inner title/actions row.
+     * Defaults to transparent.
+     */
+    '--ts-var-share-chat-header-background'?: string;
+
+    /**
+     * Font color of the title text in the share chat header.
+     */
+    '--ts-var-share-chat-header-title-color'?: string;
+
+    /**
+     * Font color of the title input field in the share chat header.
+     */
+    '--ts-var-share-chat-header-input-text-color'?: string;
+
+    /**
+     * Background color of the title input field in the share chat header.
+     */
+    '--ts-var-share-chat-header-input-background'?: string;
+
+    /**
+     * Border color of the title input field in the share chat header.
+     */
+    '--ts-var-share-chat-header-input-border-color'?: string;
+
+    /**
+     * Background color of the shimmer loading effect. Also affects the
+     * saved chats sidebar's new-chat shimmer, which shares the same style.
+     */
+    '--ts-var-shimmer-background'?: string;
+
+    /**
+     * Background color of the shimmer sweep animation's gradient mid-stop.
+     */
+    '--ts-var-shimmer-sweep-background'?: string;
 }

package/src/embed/app.spec.ts

@@ -8,6 +8,7 @@ import {
     HomePage,
     ListPage,
 } from './app';
+import { SpotterQueryMode } from './conversation';
 import { init } from '../index';
 import { Action, AuthType, EmbedEvent, HostEvent, RuntimeFilterOp } from '../types';
 import {
@@ -210,6 +211,7 @@ describe('App embed tests', () => {
             [Page.Home]: 'home',
             [Page.SpotIQ]: 'insights/results',
             [Page.Monitor]: 'insights/monitor-alerts',
+            [Page.Collections]: 'collections',
         };
 
         const pageIds = Object.keys(pageRouteMap);
@@ -243,6 +245,7 @@ describe('App embed tests', () => {
             [Page.Home]: 'home',
             [Page.SpotIQ]: 'home/spotiq-analysis',
             [Page.Monitor]: 'home/monitor-alerts',
+            [Page.Collections]: 'collections',
         };
 
         const pageIdsForModularHomes = Object.keys(pageRouteMapForModularHome);
@@ -589,6 +592,33 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set defaultQueryMode to research in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            defaultQueryMode: SpotterQueryMode.RESEARCH,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&defaultQueryMode=research${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('should not set defaultQueryMode in url when unset', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should set hideToolResponseCardBranding to true in url via spotterChatConfig', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -1736,6 +1766,116 @@ describe('App embed tests', () => {
                 'Please call render before invoking this method',
             );
         });
+
+        describe('overrideHistoryState flag', () => {
+            test('navigateToPage with overrideHistoryState=true should trigger HostEvent.Navigate', async () => {
+                mockMessageChannel();
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                    overrideHistoryState: true,
+                });
+                await appEmbed.render();
+
+                const iframe = getIFrameEl();
+                iframe.contentWindow.postMessage = jest.fn();
+                appEmbed.navigateToPage(path, false);
+
+                expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                    expect.objectContaining({
+                        type: HostEvent.Navigate,
+                        data: path,
+                    }),
+                    `http://${thoughtSpotHost}`,
+                    expect.anything(),
+                );
+            });
+
+            test('navigateToPage with overrideHistoryState=true and path as number should trigger HostEvent.Navigate', async () => {
+                mockMessageChannel();
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                    overrideHistoryState: true,
+                });
+                await appEmbed.render();
+
+                const iframe = getIFrameEl();
+                iframe.contentWindow.postMessage = jest.fn();
+                appEmbed.navigateToPage(-1, false);
+
+                expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                    expect.objectContaining({
+                        type: HostEvent.Navigate,
+                        data: -1,
+                    }),
+                    `http://${thoughtSpotHost}`,
+                    expect.anything(),
+                );
+            });
+
+            test('navigateToPage with overrideHistoryState=false and noReload=false should update iframe src', async () => {
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                    overrideHistoryState: false,
+                });
+                await appEmbed.render();
+                appEmbed.navigateToPage(path, false);
+
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}${defaultParamsPost}#/${path}`,
+                );
+            });
+
+            test('navigateToPage with overrideHistoryState=undefined and noReload=false should update iframe src', async () => {
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+                appEmbed.navigateToPage(path, false);
+
+                expectUrlMatchesWithParams(
+                    getIFrameSrc(),
+                    `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}${defaultParamsPost}#/${path}`,
+                );
+            });
+
+            test('navigateToPage respects noReload priority over overrideHistoryState', async () => {
+                mockMessageChannel();
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                    overrideHistoryState: false,
+                });
+                await appEmbed.render();
+
+                const iframe = getIFrameEl();
+                iframe.contentWindow.postMessage = jest.fn();
+                appEmbed.navigateToPage(path, true);
+
+                expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(
+                    expect.objectContaining({
+                        type: HostEvent.Navigate,
+                        data: path,
+                    }),
+                    `http://${thoughtSpotHost}`,
+                    expect.anything(),
+                );
+            });
+        });
     });
 
     describe('LazyLoadingForFullHeight functionality', () => {

package/src/embed/app.ts

@@ -22,7 +22,7 @@ import {
     SpotterFileUploadFileTypes,
 } from '../types';
 import { V1Embed } from './ts-embed';
-import { SpotterChatViewConfig, SpotterSidebarViewConfig } from './conversation';
+import { SpotterChatViewConfig, SpotterSidebarViewConfig, SpotterQueryMode } from './conversation';
 import { buildSpotterSidebarAppInitData } from './spotter-utils';
 import { SpotterVizConfig, buildSpotterVizAppInitData } from './spotter-viz-utils';
 
@@ -63,6 +63,10 @@ export enum Page {
      *  Monitor Alerts Page
      */
     Monitor = 'monitor',
+    /**
+     * Collections listing page
+     */
+    Collections = 'collections',
 }
 
 /**
@@ -733,6 +737,25 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      * ```
      */
     updatedSpotterChatPrompt?: boolean;
+    /**
+     * Sets the default query mode when Spotter loads — Fast Search or
+     * Research Mode. Applies fresh on every new session for this embed
+     * instance only; it does not persist as a user preference and does
+     * not affect other embeds or native ThoughtSpot usage.
+     * Only applicable when navigating to Spotter within the app.
+     *
+     * Supported embed types: `AppEmbed`
+     * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     * @default SpotterQueryMode.FAST_SEARCH
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... //other embed view config
+     *    defaultQueryMode: SpotterQueryMode.RESEARCH,
+     * })
+     * ```
+     */
+    defaultQueryMode?: SpotterQueryMode;
     /**
      * Controls the visibility of the past conversations sidebar.
      *
@@ -805,6 +828,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      *            { label: 'Tip', text: 'try asking about revenue by region' },
      *            { label: 'Tip', text: 'use natural language' },
      *        ],
+     *        // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     *        liveboardBrandName: 'Reports',
+     *        spotterBrandName: 'Analyst',
+     *        insightTileBrandName: 'Insight card',
+     *        insightTileViewPlanLabel: 'View plan',
+     *        insightTileLoaderText: 'Generating insight',
      *    },
      * })
      * ```
@@ -986,6 +1015,7 @@ export class AppEmbed extends V1Embed {
             isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
             updatedSpotterChatPrompt,
+            defaultQueryMode,
             enableStopAnswerGenerationEmbed,
             spotterChatConfig,
             minimumHeight,
@@ -1025,6 +1055,9 @@ export class AppEmbed extends V1Embed {
         if (!isUndefined(updatedSpotterChatPrompt)) {
             params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
         }
+        if (!isUndefined(defaultQueryMode)) {
+            params[Param.DefaultQueryMode] = defaultQueryMode;
+        }
         if (!isUndefined(enableStopAnswerGenerationEmbed)) {
             params[Param.EnableStopAnswerGenerationEmbed] = !!enableStopAnswerGenerationEmbed;
         }
@@ -1332,6 +1365,8 @@ export class AppEmbed extends V1Embed {
                 return modularHomeExperience ? 'home/spotiq-analysis' : 'insights/results';
             case Page.Monitor:
                 return modularHomeExperience ? 'home/monitor-alerts' : 'insights/monitor-alerts';
+            case Page.Collections:
+                return 'collections';
             case Page.Home:
             default:
                 return 'home';
@@ -1372,7 +1407,8 @@ export class AppEmbed extends V1Embed {
             logger.log('Please call render before invoking this method');
             return;
         }
-        if (noReload) {
+        const overrideHistoryState = this.viewConfig?.overrideHistoryState;
+        if (noReload || overrideHistoryState) {
             this.trigger(HostEvent.Navigate, path);
         } else {
             if (typeof path !== 'string') {

package/src/embed/conversation.spec.ts

@@ -1,4 +1,4 @@
-import { SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed } from './conversation';
+import { SpotterEmbed, SpotterEmbedViewConfig, SpotterQueryMode, ConversationEmbed } from './conversation';
 import { TsEmbed } from './ts-embed';
 import * as authInstance from '../auth';
 import { Action, init } from '../index';
@@ -460,6 +460,37 @@ describe('ConversationEmbed', () => {
         );
     });
 
+    it('should render the conversation embed with default query mode set to research', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            defaultQueryMode: SpotterQueryMode.RESEARCH,
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&defaultQueryMode=research#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed without a default query mode param when unset', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
     describe('spotter chat hiddenActions', () => {
         it.each([
             ['SpotterChatConnectorResources', Action.SpotterChatConnectorResources],

package/src/embed/conversation.ts

@@ -15,6 +15,15 @@ export interface SearchOptions {
     searchQuery: string;
 }
 
+/**
+ * The query mode Spotter uses when answering a question.
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ */
+export enum SpotterQueryMode {
+    FAST_SEARCH = 'fastSearch',
+    RESEARCH = 'research',
+}
+
 /**
  * Configuration for the Spotter sidebar.
  * Can be used in SpotterEmbed and AppEmbed.
@@ -319,6 +328,24 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * ```
      */
     updatedSpotterChatPrompt?: boolean;
+    /**
+     * Sets the default query mode when Spotter loads — Fast Search or
+     * Research Mode. Applies fresh on every new session for this embed
+     * instance only; it does not persist as a user preference and does
+     * not affect other embeds or native ThoughtSpot usage.
+     *
+     * Supported embed types: `SpotterEmbed`, `AppEmbed`
+     * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     * @default SpotterQueryMode.FAST_SEARCH
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    ... //other embed view config
+     *    defaultQueryMode: SpotterQueryMode.RESEARCH,
+     * })
+     * ```
+     */
+    defaultQueryMode?: SpotterQueryMode;
     /**
      * Enables the stop answer generation button in the Spotter embed UI,
      * allowing users to interrupt an ongoing answer generation.
@@ -456,6 +483,7 @@ export class SpotterEmbed extends TsEmbed {
             runtimeParameters,
             excludeRuntimeParametersfromURL,
             updatedSpotterChatPrompt,
+            defaultQueryMode,
             enableStopAnswerGenerationEmbed,
             spotterChatConfig,
         } = this.viewConfig;
@@ -478,6 +506,7 @@ export class SpotterEmbed extends TsEmbed {
         setParamIfDefined(queryParams, Param.ShowSpotterLimitations, showSpotterLimitations, true);
         setParamIfDefined(queryParams, Param.HideSampleQuestions, hideSampleQuestions, true);
         setParamIfDefined(queryParams, Param.UpdatedSpotterChatPrompt, updatedSpotterChatPrompt, true);
+        setParamIfDefined(queryParams, Param.DefaultQueryMode, defaultQueryMode);
         setParamIfDefined(queryParams, Param.EnableStopAnswerGenerationEmbed, enableStopAnswerGenerationEmbed, true);
 
         // Handle spotterChatConfig params