@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0

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';
@@ -45,6 +45,40 @@ describe('ConversationEmbed', () => {
         );
     });
 
+    it('should deep-link to the shared-conversation reader view when sharedConversationId is set', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            sharedConversationId: 'conv-123',
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist/s/conv-123?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should URL-encode the sharedConversationId in the reader-view path', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            sharedConversationId: 'conv/1',
+        };
+
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist/s/conv%2F1?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
     it('should render the conversation embed with worksheets disabled', async () => {
         const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
@@ -113,26 +147,6 @@ describe('ConversationEmbed', () => {
         );
     });
 
-    it('should handle error when worksheetId is not provided', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: '',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-        };
-        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
-        (conversationEmbed as any).handleError = jest.fn();
-        await conversationEmbed.render();
-        expect((conversationEmbed as any).handleError).toHaveBeenCalledWith(
-            {
-                errorType: ErrorDetailsTypes.VALIDATION_ERROR,
-                message: ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND,
-                code: EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND,
-                error: ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND,
-            },
-        );
-    });
-
     it('should render the conversation embed if data panel v2 flag is true', async () => {
         const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
@@ -460,6 +474,69 @@ describe('ConversationEmbed', () => {
         );
     });
 
+    it('should render the conversation embed with spotter radiance', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            showSpotterRadiance: true,
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&showSpotterRadiance=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed with spotter radiance disabled', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            showSpotterRadiance: false,
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&showSpotterRadiance=false#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    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],
@@ -584,6 +661,24 @@ describe('SpotterEmbed APP_INIT embedParams', () => {
         });
     });
 
+    it('should forward spotterChatPinConfig nested in spotterSidebarConfig', async () => {
+        const spotterChatPinConfig = {
+            enabled: true,
+            pinLabel: 'Pin to top',
+            unpinLabel: 'Unpin',
+        };
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterSidebarConfig: {
+                enablePastConversationsSidebar: true,
+                spotterChatPinConfig,
+            },
+        });
+        expect(
+            response.data.embedParams.spotterSidebarConfig.spotterChatPinConfig,
+        ).toEqual(spotterChatPinConfig);
+    });
+
     it('should populate enablePastConversationsSidebar from deprecated standalone flag', async () => {
         const response = await getAppInitResponse({
             worksheetId: 'ws1',
@@ -666,5 +761,164 @@ describe('SpotterEmbed APP_INIT embedParams', () => {
         expect(mockPort.postMessage.mock.calls[0]?.[0].data.embedParams?.spotterSidebarConfig?.spotterDocumentationUrl).toBeUndefined();
     });
 
+    it('should include spotterShareConversationConfig in embedParams when provided', async () => {
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterShareConversationConfig: { enableShareConversation: true },
+        });
+        expect(response.data.embedParams.spotterShareConversationConfig).toEqual({
+            enableShareConversation: true,
+        });
+    });
+
+    it('should pass spotterShareConversationConfig label overrides through embedParams', async () => {
+        const spotterShareConversationConfig = {
+            enableShareConversation: true,
+            spotterShareLabel: 'Share',
+            spotterShareModalTitle: 'Share conversation',
+        };
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterShareConversationConfig,
+        });
+        expect(response.data.embedParams.spotterShareConversationConfig).toEqual(spotterShareConversationConfig);
+    });
+
+    it('should include spotterShareConversationConfig alongside spotterSidebarConfig', async () => {
+        const response = await getAppInitResponse({
+            worksheetId: 'ws1',
+            spotterSidebarConfig: { enablePastConversationsSidebar: true },
+            spotterShareConversationConfig: { enableShareConversation: true },
+        });
+        expect(response.data.embedParams.spotterSidebarConfig.enablePastConversationsSidebar).toBe(true);
+        expect(response.data.embedParams.spotterShareConversationConfig.enableShareConversation).toBe(true);
+    });
+
+    it('should not handle error when neither worksheetId nor dataSources is provided', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        (conversationEmbed as any).handleError = jest.fn();
+        await conversationEmbed.render();
+        expect((conversationEmbed as any).handleError).not.toHaveBeenCalled();
+    });
+
+    it('should not handle error when dataSources is an empty array and worksheetId is not provided', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            dataSources: [],
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        (conversationEmbed as any).handleError = jest.fn();
+        await conversationEmbed.render();
+        expect((conversationEmbed as any).handleError).not.toHaveBeenCalled();
+    });
+
+    it('should render without worksheet and dataSources params when neither is provided', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {};
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        const src = getIFrameSrc();
+        expect(src).not.toContain('worksheet=');
+        expect(src).not.toContain('dataSources=');
+    });
+
+    it('should not append dataSources to the URL when it is an empty array', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            dataSources: [],
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expect(getIFrameSrc()).not.toContain('dataSources=');
+    });
+
+    it('should not handle error when dataSources is provided but worksheetId is not', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: '',
+            dataSources: ['ds-1', 'ds-2'],
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        (conversationEmbed as any).handleError = jest.fn();
+        await conversationEmbed.render();
+        expect((conversationEmbed as any).handleError).not.toHaveBeenCalled();
+    });
+
+    it('should render the conversation embed with dataSources and no worksheetId in the hash params', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: '',
+            dataSources: ['ds-1', 'ds-2'],
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist?dataSources=${encodeURIComponent(JSON.stringify(['ds-1', 'ds-2']))}`,
+        );
+    });
+
+    it('should prefer dataSources over worksheetId when both are provided', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            dataSources: ['ds-1', 'ds-2'],
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist?query=searchQuery&dataSources=${encodeURIComponent(JSON.stringify(['ds-1', 'ds-2']))}`,
+        );
+    });
+
+    it('should render the conversation embed without searchOptions and worksheetId when neither is set', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: '',
+            dataSources: ['ds-1'],
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        const src = getIFrameSrc();
+        expect(src).not.toContain('worksheet=');
+        expect(src).not.toContain('query=');
+    });
 });
 
+
+describe('SpotterEmbed updatedSpotterExperience', () => {
+    it('should render the conversation embed with updated spotter experience', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            updatedSpotterExperience: true,
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&updatedSpotterExperience=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+
+    it('should render the conversation embed with updated spotter experience disabled', async () => {
+        const viewConfig: SpotterEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            searchOptions: {
+                searchQuery: 'searchQuery',
+            },
+            updatedSpotterExperience: false,
+        };
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
+        await conversationEmbed.render();
+        expectUrlMatchesWithParams(
+            getIFrameSrc(),
+            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&updatedSpotterExperience=false#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
+        );
+    });
+});