@thoughtspot/visual-embed-sdk 1.49.2 → 1.50.0

package/src/embed/app.spec.ts

@@ -522,7 +522,7 @@ describe('App embed tests', () => {
         });
     });
 
-    test('Should add homepageVersion=v4 when homePage is Focused to the iframe src', async () => {
+    test('Should add homepageVersion=v4 and updatedSpotterChatPrompt=true when homePage is Focused to the iframe src', async () => {
         await testUrlParams(
             {
                 ...defaultViewConfig,
@@ -530,7 +530,20 @@ describe('App embed tests', () => {
                     homePage: HomePage.Focused,
                 },
             } as AppViewConfig,
-            `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&navigationVersion=v2&homepageVersion=v4${defaultParams}${defaultParamsPost}#/home`,
+            `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&navigationVersion=v2&homepageVersion=v4&updatedSpotterChatPrompt=true${defaultParams}${defaultParamsPost}#/home`,
+        );
+    });
+
+    test('Should respect explicit updatedSpotterChatPrompt=false even when homePage is Focused', async () => {
+        await testUrlParams(
+            {
+                ...defaultViewConfig,
+                discoveryExperience: {
+                    homePage: HomePage.Focused,
+                },
+                updatedSpotterChatPrompt: false,
+            } as AppViewConfig,
+            `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&navigationVersion=v2&homepageVersion=v4&updatedSpotterChatPrompt=false${defaultParams}${defaultParamsPost}#/home`,
         );
     });
 

package/src/embed/app.ts

@@ -798,7 +798,13 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      *        description: 'Ask questions about your data',
      *        inputChatPlaceholder: 'Ask a question...',
      *        hideStarterPrompts: false,
-     *        customStarterPrompts: [{ id: '1', displayText: 'Top products', fullPrompt: 'What are the top products by revenue?' }]
+     *        customStarterPrompts: [{ id: '1', displayText: 'Top products', fullPrompt: 'What are the top products by revenue?' }],
+     *        // loaderHeadline and loaderTips require SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
+     *        loaderHeadline: 'Crunching the numbers...',
+     *        loaderTips: [
+     *            { label: 'Tip', text: 'try asking about revenue by region' },
+     *            { label: 'Tip', text: 'use natural language' },
+     *        ],
      *    },
      * })
      * ```
@@ -1212,6 +1218,12 @@ export class AppEmbed extends V1Embed {
 
             if (discoveryExperience.homePage === HomePage.Focused) {
                 params[Param.HomepageVersion] = HomePage.Focused;
+                // The Focused (V4) homepage experience requires the updated
+                // Spotter chat prompt. Enable it automatically unless the
+                // developer has explicitly set updatedSpotterChatPrompt.
+                if (isUndefined(updatedSpotterChatPrompt)) {
+                    params[Param.UpdatedSpotterChatPrompt] = true;
+                }
             }
         }
 

package/src/embed/conversation.spec.ts

@@ -465,6 +465,12 @@ describe('ConversationEmbed', () => {
             ['SpotterChatConnectorResources', Action.SpotterChatConnectorResources],
             ['SpotterChatConnectors', Action.SpotterChatConnectors],
             ['SpotterChatModeSwitcher', Action.SpotterChatModeSwitcher],
+            ['SpotterAnalystShare', Action.SpotterAnalystShare],
+            ['SpotterAnalystEdit', Action.SpotterAnalystEdit],
+            ['SpotterAnalystCreate', Action.SpotterAnalystCreate],
+            ['SpotterAnalystDelete', Action.SpotterAnalystDelete],
+            ['SpotterAnalystMakeACopy', Action.SpotterAnalystMakeACopy],
+            ['SpotterAnalystSidebar', Action.SpotterAnalystSidebar],
         ])('should render with hiddenActions for %s', async (_, action) => {
             const viewConfig: SpotterEmbedViewConfig = {
                 worksheetId: 'worksheetId',
@@ -503,6 +509,12 @@ describe('ConversationEmbed', () => {
             ['SpotterChatConnectorResources', Action.SpotterChatConnectorResources],
             ['SpotterChatConnectors', Action.SpotterChatConnectors],
             ['SpotterChatModeSwitcher', Action.SpotterChatModeSwitcher],
+            ['SpotterAnalystShare', Action.SpotterAnalystShare],
+            ['SpotterAnalystEdit', Action.SpotterAnalystEdit],
+            ['SpotterAnalystCreate', Action.SpotterAnalystCreate],
+            ['SpotterAnalystDelete', Action.SpotterAnalystDelete],
+            ['SpotterAnalystMakeACopy', Action.SpotterAnalystMakeACopy],
+            ['SpotterAnalystSidebar', Action.SpotterAnalystSidebar],
         ])('should render with disabledActions for %s', async (_, action) => {
             const disabledReason = 'testing disabled reason';
             const viewConfig: SpotterEmbedViewConfig = {
@@ -612,6 +624,26 @@ describe('SpotterEmbed APP_INIT embedParams', () => {
         expect(response.data.embedParams).toBeUndefined();
     });
 
+    it('should include spotterAnalystLabel in embedParams.spotterSidebarConfig when set', async () => {
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterSidebarConfig: {
+                spotterAnalystLabel: 'My Analyst',
+            },
+        });
+        expect(response.data.embedParams.spotterSidebarConfig.spotterAnalystLabel).toBe('My Analyst');
+    });
+
+    it('should include spotterAnalystsLabel in embedParams.spotterSidebarConfig when set', async () => {
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterSidebarConfig: {
+                spotterAnalystsLabel: 'My Analysts',
+            },
+        });
+        expect(response.data.embedParams.spotterSidebarConfig.spotterAnalystsLabel).toBe('My Analysts');
+    });
+
     it('should call handleError and exclude spotterDocumentationUrl from embedParams when URL is invalid', async () => {
         const embed = new SpotterEmbed(getRootEl(), {
             worksheetId: 'ws1',

package/src/embed/conversation.ts

@@ -89,6 +89,18 @@ export interface SpotterSidebarViewConfig {
      * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
      */
     spotterNewChatButtonTitle?: string;
+    /**
+     * Custom label text for the Spotter Analyst section in the sidebar.
+     * @version SDK: 1.51.0 | ThoughtSpot: 26.8.0.cl
+     * @default Analyst
+     */
+    spotterAnalystLabel?: string;
+    /**
+     * Custom label text for the Spotter Analysts section in the sidebar.
+     * @version SDK: 1.51.0 | ThoughtSpot: 26.8.0.cl
+     * @default Analysts
+     */
+    spotterAnalystsLabel?: string;
 }
 
 /**

package/src/embed/embedConfig.spec.ts

@@ -0,0 +1,79 @@
+import { getEmbedConfig, setEmbedConfig } from './embedConfig';
+import { storeValueInWindow, resetValueFromWindow } from '../utils';
+
+describe('embedConfig', () => {
+    beforeEach(() => {
+        // Ensure the SDK window namespace exists before resetting individual keys
+        storeValueInWindow('embedConfig', undefined);
+        resetValueFromWindow('embedConfig');
+    });
+
+    describe('getEmbedConfig', () => {
+        test('returns empty object when no config has been set', () => {
+            expect(getEmbedConfig()).toEqual({});
+        });
+
+        test('returns the config that was previously set', () => {
+            const config: any = {
+                thoughtSpotHost: 'https://myhost.thoughtspot.com',
+                authType: 'None' as any,
+            };
+            setEmbedConfig(config);
+            expect(getEmbedConfig()).toEqual(config);
+        });
+
+        test('returns the full config object including nested properties', () => {
+            const config: any = {
+                thoughtSpotHost: 'https://myhost.thoughtspot.com',
+                authType: 'None' as any,
+                customizations: {
+                    style: {
+                        customCSS: {
+                            variables: { '--ts-var-root-background': '#fff' },
+                        },
+                    },
+                },
+            };
+            setEmbedConfig(config);
+            expect(getEmbedConfig()).toEqual(config);
+        });
+    });
+
+    describe('setEmbedConfig', () => {
+        test('stores the config and returns it', () => {
+            const config: any = {
+                thoughtSpotHost: 'https://myhost.thoughtspot.com',
+                authType: 'None' as any,
+            };
+            const result = setEmbedConfig(config);
+            expect(result).toEqual(config);
+        });
+
+        test('getEmbedConfig reflects the config after setEmbedConfig', () => {
+            const config: any = {
+                thoughtSpotHost: 'https://updated.thoughtspot.com',
+                authType: 'TrustedAuthToken' as any,
+            };
+            setEmbedConfig(config);
+            expect(getEmbedConfig()).toEqual(config);
+        });
+
+        test('overwrites a previously stored config', () => {
+            const first: any = { thoughtSpotHost: 'https://first.com', authType: 'None' as any };
+            const second: any = { thoughtSpotHost: 'https://second.com', authType: 'TrustedAuthToken' as any };
+            setEmbedConfig(first);
+            setEmbedConfig(second);
+            expect(getEmbedConfig()).toEqual(second);
+        });
+
+        test('handles config with disableFullscreenPresentation flag', () => {
+            const config: any = {
+                thoughtSpotHost: 'https://myhost.thoughtspot.com',
+                authType: 'None' as any,
+                disableFullscreenPresentation: true,
+            };
+            setEmbedConfig(config);
+            expect(getEmbedConfig().disableFullscreenPresentation).toBe(true);
+        });
+    });
+});