@thoughtspot/visual-embed-sdk 1.45.2 → 1.45.3

package/src/embed/conversation.spec.ts

@@ -295,7 +295,9 @@ describe('ConversationEmbed', () => {
             searchOptions: {
                 searchQuery: 'searchQuery',
             },
-            enablePastConversationsSidebar: true,
+            spotterSidebarConfig: {
+                enablePastConversationsSidebar: true,
+            },
         };
 
         const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
@@ -312,7 +314,9 @@ describe('ConversationEmbed', () => {
             searchOptions: {
                 searchQuery: 'searchQuery',
             },
-            enablePastConversationsSidebar: false,
+            spotterSidebarConfig: {
+                enablePastConversationsSidebar: false,
+            },
         };
 
         const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
@@ -334,7 +338,9 @@ describe('ConversationEmbed', () => {
             dataPanelV2: true,
             showSpotterLimitations: true,
             hideSampleQuestions: true,
-            enablePastConversationsSidebar: true,
+            spotterSidebarConfig: {
+                enablePastConversationsSidebar: true,
+            },
         };
 
         const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
@@ -345,6 +351,44 @@ describe('ConversationEmbed', () => {
         );
     });
 
+    it('should render the conversation embed with tool response card branding hidden', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            spotterChatConfig: {
+                hideToolResponseCardBranding: true,
+            },
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&hideToolResponseCardBranding=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed with custom tool response card branding label', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            spotterChatConfig: {
+                toolResponseCardBrandingLabel: 'MyBrand',
+            },
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&toolResponseCardBrandingLabel=MyBrand#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
     it('should ensure deprecated ConversationEmbed class maintains same functionality as SpotterEmbed', async () => {
         const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
@@ -402,4 +446,74 @@ describe('ConversationEmbed', () => {
             `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&updatedSpotterChatPrompt=false#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
         );
     });
+
+    describe('spotter sidebar config params', () => {
+        it.each([
+            ['enablePastConversationsSidebar', true, 'enablePastConversationsSidebar=true'],
+            ['spotterSidebarTitle', 'My Conversations', 'spotterSidebarTitle=My%20Conversations'],
+            ['spotterSidebarDefaultExpanded', true, 'spotterSidebarDefaultExpanded=true'],
+            ['spotterChatRenameLabel', 'Edit Name', 'spotterChatRenameLabel=Edit%20Name'],
+            ['spotterChatDeleteLabel', 'Remove', 'spotterChatDeleteLabel=Remove'],
+            ['spotterDeleteConversationModalTitle', 'Remove Conversation', 'spotterDeleteConversationModalTitle=Remove%20Conversation'],
+            ['spotterPastConversationAlertMessage', 'Viewing past conversation', 'spotterPastConversationAlertMessage=Viewing%20past%20conversation'],
+            ['spotterBestPracticesLabel', 'Help Tips', 'spotterBestPracticesLabel=Help%20Tips'],
+            ['spotterConversationsBatchSize', 50, 'spotterConversationsBatchSize=50'],
+            ['spotterNewChatButtonTitle', 'Start New Conversation', 'spotterNewChatButtonTitle=Start%20New%20Conversation'],
+            ['spotterDocumentationUrl', 'https://docs.example.com/spotter', 'spotterDocumentationUrl=https%3A%2F%2Fdocs.example.com%2Fspotter'],
+        ])('should render with spotterSidebarConfig.%s', async (configKey, configValue, expectedParam) => {
+            const viewConfig: SpotterEmbedViewConfig = {
+                worksheetId: 'worksheetId',
+                spotterSidebarConfig: {
+                    [configKey]: configValue,
+                },
+            };
+            const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+            await conversationEmbed.render();
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&${expectedParam}#/embed/insights/conv-assist?worksheet=worksheetId&query=`,
+            );
+        });
+
+        it.each([
+            ['invalid URL format', 'invalid-url'],
+            ['invalid protocol (ftp)', 'ftp://docs.example.com/spotter'],
+        ])('should handle error for spotterSidebarConfig.spotterDocumentationUrl with %s', async (_, invalidUrl) => {
+            const viewConfig: SpotterEmbedViewConfig = {
+                worksheetId: 'worksheetId',
+                spotterSidebarConfig: {
+                    spotterDocumentationUrl: invalidUrl,
+                },
+            };
+            const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+            (conversationEmbed as any).handleError = jest.fn();
+            await conversationEmbed.render();
+            expect((conversationEmbed as any).handleError).toHaveBeenCalledWith(
+                expect.objectContaining({
+                    errorType: ErrorDetailsTypes.VALIDATION_ERROR,
+                    message: ERROR_MESSAGE.INVALID_SPOTTER_DOCUMENTATION_URL,
+                    code: EmbedErrorCodes.INVALID_URL,
+                }),
+            );
+        });
+
+        it('should render with multiple spotterSidebarConfig options', async () => {
+            const viewConfig: SpotterEmbedViewConfig = {
+                worksheetId: 'worksheetId',
+                spotterSidebarConfig: {
+                    enablePastConversationsSidebar: true,
+                    spotterSidebarTitle: 'Chats',
+                    spotterSidebarDefaultExpanded: true,
+                    spotterNewChatButtonTitle: 'New',
+                    spotterConversationsBatchSize: 25,
+                },
+            };
+            const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+            await conversationEmbed.render();
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&enablePastConversationsSidebar=true&spotterSidebarDefaultExpanded=true&spotterSidebarTitle=Chats&spotterConversationsBatchSize=25&spotterNewChatButtonTitle=New#/embed/insights/conv-assist?worksheet=worksheetId&query=`,
+            );
+        });
+    });
 });

package/src/embed/conversation.ts

@@ -2,7 +2,7 @@ import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
 import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter, ErrorDetailsTypes, EmbedErrorCodes } from '../types';
 import { TsEmbed } from './ts-embed';
-import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils';
+import { getQueryParamString, getFilterQuery, getRuntimeParameters, validateHttpUrl, setParamIfDefined } from '../utils';
 
 /**
  * Configuration for search options
@@ -14,6 +14,106 @@ export interface SearchOptions {
     searchQuery: string;
 }
 
+/**
+ * Configuration for the Spotter sidebar.
+ * Can be used in SpotterEmbed and AppEmbed.
+ * @group Embed components
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+ */
+export interface SpotterSidebarViewConfig {
+    /**
+     * Controls the visibility of the past conversations sidebar.
+     * @default false
+     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     */
+    enablePastConversationsSidebar?: boolean;
+    /**
+     * Custom title text for the sidebar header.
+     * Defaults to translated "Spotter" text.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterSidebarTitle?: string;
+    /**
+     * Boolean to set the default expanded state of the sidebar.
+     * @default false
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterSidebarDefaultExpanded?: boolean;
+    /**
+     * Custom label text for the rename action in the conversation edit menu.
+     * Defaults to translated "Rename" text.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterChatRenameLabel?: string;
+    /**
+     * Custom label text for the delete action in the conversation edit menu.
+     * Defaults to translated "DELETE" text.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterChatDeleteLabel?: string;
+    /**
+     * Custom title text for the delete conversation confirmation modal.
+     * Defaults to translated "Delete chat" text.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterDeleteConversationModalTitle?: string;
+    /**
+     * Custom message text for the past conversation banner alert.
+     * Defaults to translated alert message.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterPastConversationAlertMessage?: string;
+    /**
+     * Custom URL for the documentation/best practices link.
+     * Defaults to ThoughtSpot docs URL based on release version.
+     * Note: URL must include the protocol (e.g., `https://www.example.com`).
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterDocumentationUrl?: string;
+    /**
+     * Custom label text for the best practices button in the footer.
+     * Defaults to translated "Best Practices" text.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterBestPracticesLabel?: string;
+    /**
+     * Number of conversations to fetch per batch when loading conversation history.
+     * @default 30
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterConversationsBatchSize?: number;
+    /**
+     * Custom title text for the "New Chat" button in the sidebar.
+     * Defaults to translated "New Chat" text.
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterNewChatButtonTitle?: string;
+}
+
+/**
+ * Configuration for customizing Spotter chat UI branding.
+ * @group Embed components
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
+ */
+export interface SpotterChatViewConfig {
+    /**
+     * Hides the ThoughtSpot logo/icon in tool response
+     * cards. The branding label prefix is controlled
+     * separately via `toolResponseCardBrandingLabel`.
+     * External MCP tool branding is not affected.
+     * @default false
+     */
+    hideToolResponseCardBranding?: boolean;
+    /**
+     * Custom label to replace the "ThoughtSpot" prefix
+     * in tool response cards. Set to an empty string
+     * `''` to hide the prefix entirely. Works
+     * independently of `hideToolResponseCardBranding`.
+     * External MCP tool branding is not affected.
+     */
+    toolResponseCardBrandingLabel?: string;
+}
+
 /**
  * The configuration for the embedded spotterEmbed options.
  * @group Embed components
@@ -169,8 +269,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      */
     excludeRuntimeParametersfromURL?: boolean;
     /**
-     * enablePastConversationsSidebar : Controls the visibility of the past conversations
-     * sidebar.
+     * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
      *
      * Supported embed types: `SpotterEmbed`
      * @default false
@@ -178,28 +277,48 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
      *    ... //other embed view config
-     *    enablePastConversationsSidebar : true,
+     *    updatedSpotterChatPrompt : true,
      * })
      * ```
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
-    enablePastConversationsSidebar?: boolean;
-
+    updatedSpotterChatPrompt?: boolean;
     /**
-     * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
+     * Configuration for the Spotter sidebar UI customization.
+     *
+     * Supported embed types: `SpotterEmbed`, `AppEmbed`
+     * @example
+     * ```js
+     * const embed = new SpotterEmbed('#tsEmbed', {
+     *    ... //other embed view config
+     *    spotterSidebarConfig: {
+     *        enablePastConversationsSidebar: true,
+     *        spotterSidebarTitle: 'My Conversations',
+     *        spotterSidebarDefaultExpanded: true,
+     *    },
+     * })
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    spotterSidebarConfig?: SpotterSidebarViewConfig;
+    /**
+     * Configuration for customizing Spotter chat UI
+     * branding in tool response cards.
      *
      * Supported embed types: `SpotterEmbed`
-     * @default false
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
      *    ... //other embed view config
-     *    updatedSpotterChatPrompt : true,
+     *    spotterChatConfig: {
+     *        hideToolResponseCardBranding: true,
+     *        toolResponseCardBrandingLabel: 'MyBrand',
+     *    },
      * })
      * ```
-     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
      */
-    updatedSpotterChatPrompt?: boolean;
+    spotterChatConfig?: SpotterChatViewConfig;
 }
 
 /**
@@ -246,14 +365,30 @@ export class SpotterEmbed extends TsEmbed {
             dataPanelV2,
             showSpotterLimitations,
             hideSampleQuestions,
-            enablePastConversationsSidebar,
             runtimeFilters,
             excludeRuntimeFiltersfromURL,
             runtimeParameters,
             excludeRuntimeParametersfromURL,
             updatedSpotterChatPrompt,
+            spotterSidebarConfig,
+            spotterChatConfig,
         } = this.viewConfig;
 
+        // Extract sidebar config properties
+        const {
+            enablePastConversationsSidebar,
+            spotterSidebarTitle,
+            spotterSidebarDefaultExpanded,
+            spotterChatRenameLabel,
+            spotterChatDeleteLabel,
+            spotterDeleteConversationModalTitle,
+            spotterPastConversationAlertMessage,
+            spotterDocumentationUrl,
+            spotterBestPracticesLabel,
+            spotterConversationsBatchSize,
+            spotterNewChatButtonTitle,
+        } = spotterSidebarConfig || {};
+
         if (!worksheetId) {
             this.handleError({
                 errorType: ErrorDetailsTypes.VALIDATION_ERROR,
@@ -264,27 +399,50 @@ export class SpotterEmbed extends TsEmbed {
         }
         const queryParams = this.getBaseQueryParams();
         queryParams[Param.SpotterEnabled] = true;
-        if (!isUndefined(disableSourceSelection)) {
-            queryParams[Param.DisableSourceSelection] = !!disableSourceSelection;
-        }
-        if (!isUndefined(hideSourceSelection)) {
-            queryParams[Param.HideSourceSelection] = !!hideSourceSelection;
-        }
 
-        if (!isUndefined(dataPanelV2)) {
-            queryParams[Param.DataPanelV2Enabled] = !!dataPanelV2;
-        }
+        // Boolean params
+        setParamIfDefined(queryParams, Param.DisableSourceSelection, disableSourceSelection, true);
+        setParamIfDefined(queryParams, Param.HideSourceSelection, hideSourceSelection, true);
+        setParamIfDefined(queryParams, Param.DataPanelV2Enabled, dataPanelV2, true);
+        setParamIfDefined(queryParams, Param.ShowSpotterLimitations, showSpotterLimitations, true);
+        setParamIfDefined(queryParams, Param.HideSampleQuestions, hideSampleQuestions, true);
+        setParamIfDefined(queryParams, Param.UpdatedSpotterChatPrompt, updatedSpotterChatPrompt, true);
+        setParamIfDefined(queryParams, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
 
-        if (!isUndefined(showSpotterLimitations)) {
-            queryParams[Param.ShowSpotterLimitations] = !!showSpotterLimitations;
-        }
+        // String params
+        setParamIfDefined(queryParams, Param.SpotterSidebarTitle, spotterSidebarTitle);
+        setParamIfDefined(queryParams, Param.SpotterChatRenameLabel, spotterChatRenameLabel);
+        setParamIfDefined(queryParams, Param.SpotterChatDeleteLabel, spotterChatDeleteLabel);
+        setParamIfDefined(queryParams, Param.SpotterDeleteConversationModalTitle, spotterDeleteConversationModalTitle);
+        setParamIfDefined(queryParams, Param.SpotterPastConversationAlertMessage, spotterPastConversationAlertMessage);
+        setParamIfDefined(queryParams, Param.SpotterBestPracticesLabel, spotterBestPracticesLabel);
+        setParamIfDefined(queryParams, Param.SpotterConversationsBatchSize, spotterConversationsBatchSize);
+        setParamIfDefined(queryParams, Param.SpotterNewChatButtonTitle, spotterNewChatButtonTitle);
 
-        if (!isUndefined(hideSampleQuestions)) {
-            queryParams[Param.HideSampleQuestions] = !!hideSampleQuestions;
+        // URL param with validation
+        if (spotterDocumentationUrl !== undefined) {
+            const [isValid, validationError] = validateHttpUrl(spotterDocumentationUrl);
+            if (isValid) {
+                queryParams[Param.SpotterDocumentationUrl] = spotterDocumentationUrl;
+            } else {
+                this.handleError({
+                    errorType: ErrorDetailsTypes.VALIDATION_ERROR,
+                    message: ERROR_MESSAGE.INVALID_SPOTTER_DOCUMENTATION_URL,
+                    code: EmbedErrorCodes.INVALID_URL,
+                    error: validationError?.message || ERROR_MESSAGE.INVALID_SPOTTER_DOCUMENTATION_URL,
+                });
+            }
         }
 
-        if (!isUndefined(updatedSpotterChatPrompt)) {
-            queryParams[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
+        // Handle spotterChatConfig params
+        if (spotterChatConfig) {
+            const {
+                hideToolResponseCardBranding,
+                toolResponseCardBrandingLabel,
+            } = spotterChatConfig;
+
+            setParamIfDefined(queryParams, Param.HideToolResponseCardBranding, hideToolResponseCardBranding, true);
+            setParamIfDefined(queryParams, Param.ToolResponseCardBrandingLabel, toolResponseCardBrandingLabel);
         }
 
         return queryParams;
@@ -298,11 +456,12 @@ export class SpotterEmbed extends TsEmbed {
             excludeRuntimeFiltersfromURL,
             runtimeParameters,
             excludeRuntimeParametersfromURL,
-            enablePastConversationsSidebar,
+            spotterSidebarConfig,
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         const queryParams = this.getEmbedParamsObject();
 
+        const enablePastConversationsSidebar = spotterSidebarConfig?.enablePastConversationsSidebar;
         if (!isUndefined(enablePastConversationsSidebar)) {
             queryParams[Param.EnablePastConversationsSidebar] = !!enablePastConversationsSidebar;
         }