@thoughtspot/visual-embed-sdk 1.37.1-spotter-embed → 1.38.0

package/src/embed/bodyless-conversation.spec.ts

@@ -31,7 +31,7 @@ describe('SpotterAgentEmbed', () => {
         fetchMock.resetMocks();
     });
 
-    test('should render the bodyless conversation embed', async () => {
+    test('should render the SpotterAgent embed', async () => {
         fetchMock.mockResponses(
             JSON.stringify({
                 data: {
@@ -137,4 +137,311 @@ describe('SpotterAgentEmbed', () => {
         const errorResult = await spotterEmbed.sendMessage('userMessage');
         expect(errorResult.error instanceof Error).toBeTruthy();
     });
+
+    test('should apply containerClassName to the container element', async () => {
+        fetchMock.mockResponses(
+            JSON.stringify({
+                data: {
+                    ConvAssist__createConversation: {
+                        convId: 'conversationId',
+                        initialCtx: {
+                            type: 'TS_ANSWER',
+                            tsAnsCtx: {
+                                sessionId: 'sessionId',
+                                genNo: 1,
+                                stateKey: {
+                                    transactionId: 'transactionId',
+                                    generationNumber: 1,
+                                },
+                                worksheet: {
+                                    worksheetId: 'worksheetId',
+                                    worksheetName: 'GTM',
+                                },
+                            },
+                        },
+                    },
+                },
+            }),
+            JSON.stringify({
+                data: {
+                    ConvAssist__sendMessage: {
+                        responses: [
+                            {
+                                msgId: 'msgId',
+                                data: {
+                                    asstRespData: {
+                                        tool: 'TS_NLS',
+                                        asstRespText: '',
+                                        nlsAnsData: {
+                                            sageQuerySuggestions: [
+                                                {
+                                                    llmReasoning: {
+                                                        assumptions: 'You want the total [COL|sales] for [COL|item_type] [VAL|jackets] for [VAL|this year].',
+                                                        clarifications: '',
+                                                        interpretation: '',
+                                                        __typename: 'eureka_SageQuerySuggestion_LLMReasoning',
+                                                    },
+                                                    tokens: [
+                                                        'sum sales',
+                                                        "item type = 'jackets'",
+                                                        "date = 'this year'",
+                                                    ],
+                                                    tmlTokens: [
+                                                        'sum [sales]',
+                                                        "[date] = [date].'this year'",
+                                                        "[item type] = [item type].'jackets'",
+                                                    ],
+                                                    worksheetId: 'worksheetId',
+                                                    description: '',
+                                                    title: '',
+                                                    cached: false,
+                                                    sqlQuery: "SELECT SUM(sales) FROM __Sample_Retail_Apparel WHERE item_type = 'jackets' AND date = _this_year();",
+                                                    sessionId: 'sessionId',
+                                                    genNo: 2,
+                                                    formulaInfo: [],
+                                                    tmlPhrases: [],
+                                                    stateKey: {
+                                                        transactionId: 'transactionId',
+                                                        generationNumber: 1,
+                                                        __typename: 'sage_auto_complete_v2_ACStateKey',
+                                                    },
+                                                    __typename: 'eureka_SageQuerySuggestion',
+                                                },
+                                            ],
+                                            responseType: 'ANSWER',
+                                            __typename: 'convassist_nls_tool_NLSToolAsstRespData',
+                                        },
+                                        __typename: 'convassist_AsstResponseData',
+                                    },
+                                    __typename: 'convassist_MessageData',
+                                },
+                                type: 'ASST_RESPONSE',
+                                __typename: 'convassist_MessagePayload',
+                            },
+                        ],
+                        __typename: 'convassist_SendMessageResponse',
+                    },
+                },
+            }),
+        );
+
+        const viewConfig: SpotterAgentEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            containerClassName: 'custom-conversation-container',
+        };
+
+        const spotterAgentEmbed = new SpotterAgentEmbed(viewConfig);
+        const result = await spotterAgentEmbed.sendMessage('userMessage');
+        
+        // Verify that the container has the custom class name
+        expect(result.container.className).toBe('custom-conversation-container');
+        
+        // Also verify the iframe src is correct
+        const iframeSrc = getIFrameSrc(result.container);
+        expectUrlToHaveParamsWithValues(iframeSrc, {
+            sessionId: 'sessionId',
+            genNo: 2,
+            acSessionId: 'transactionId',
+            acGenNo: 1,
+        });
+    });
+
+    test('should not set className when containerClassName is not provided', async () => {
+        fetchMock.mockResponses(
+            JSON.stringify({
+                data: {
+                    ConvAssist__createConversation: {
+                        convId: 'conversationId',
+                        initialCtx: {
+                            type: 'TS_ANSWER',
+                            tsAnsCtx: {
+                                sessionId: 'sessionId',
+                                genNo: 1,
+                                stateKey: {
+                                    transactionId: 'transactionId',
+                                    generationNumber: 1,
+                                },
+                                worksheet: {
+                                    worksheetId: 'worksheetId',
+                                    worksheetName: 'GTM',
+                                },
+                            },
+                        },
+                    },
+                },
+            }),
+            JSON.stringify({
+                data: {
+                    ConvAssist__sendMessage: {
+                        responses: [
+                            {
+                                msgId: 'msgId',
+                                data: {
+                                    asstRespData: {
+                                        tool: 'TS_NLS',
+                                        asstRespText: '',
+                                        nlsAnsData: {
+                                            sageQuerySuggestions: [
+                                                {
+                                                    llmReasoning: {
+                                                        assumptions: 'You want the total [COL|sales] for [COL|item_type] [VAL|jackets] for [VAL|this year].',
+                                                        clarifications: '',
+                                                        interpretation: '',
+                                                        __typename: 'eureka_SageQuerySuggestion_LLMReasoning',
+                                                    },
+                                                    tokens: [
+                                                        'sum sales',
+                                                        "item type = 'jackets'",
+                                                        "date = 'this year'",
+                                                    ],
+                                                    tmlTokens: [
+                                                        'sum [sales]',
+                                                        "[date] = [date].'this year'",
+                                                        "[item type] = [item type].'jackets'",
+                                                    ],
+                                                    worksheetId: 'worksheetId',
+                                                    description: '',
+                                                    title: '',
+                                                    cached: false,
+                                                    sqlQuery: "SELECT SUM(sales) FROM __Sample_Retail_Apparel WHERE item_type = 'jackets' AND date = _this_year();",
+                                                    sessionId: 'sessionId',
+                                                    genNo: 2,
+                                                    formulaInfo: [],
+                                                    tmlPhrases: [],
+                                                    stateKey: {
+                                                        transactionId: 'transactionId',
+                                                        generationNumber: 1,
+                                                        __typename: 'sage_auto_complete_v2_ACStateKey',
+                                                    },
+                                                    __typename: 'eureka_SageQuerySuggestion',
+                                                },
+                                            ],
+                                            responseType: 'ANSWER',
+                                            __typename: 'convassist_nls_tool_NLSToolAsstRespData',
+                                        },
+                                        __typename: 'convassist_AsstResponseData',
+                                    },
+                                    __typename: 'convassist_MessageData',
+                                },
+                                type: 'ASST_RESPONSE',
+                                __typename: 'convassist_MessagePayload',
+                            },
+                        ],
+                        __typename: 'convassist_SendMessageResponse',
+                    },
+                },
+            }),
+        );
+
+        const viewConfig: SpotterAgentEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            // No containerClassName provided
+        };
+
+        const spotterAgentEmbed = new SpotterAgentEmbed(viewConfig);
+        const result = await spotterAgentEmbed.sendMessage('userMessage');
+        
+        // Verify that the container has no class name (empty string)
+        expect(result.container.className).toBe('');
+    });
+
+    test('should handle hideActions parameter correctly', async () => {
+        fetchMock.mockResponses(
+            JSON.stringify({
+                data: {
+                    ConvAssist__createConversation: {
+                        convId: 'conversationId',
+                        initialCtx: {
+                            type: 'TS_ANSWER',
+                            tsAnsCtx: {
+                                sessionId: 'sessionId',
+                                genNo: 1,
+                                stateKey: {
+                                    transactionId: 'transactionId',
+                                    generationNumber: 1,
+                                },
+                                worksheet: {
+                                    worksheetId: 'worksheetId',
+                                    worksheetName: 'GTM',
+                                },
+                            },
+                        },
+                    },
+                },
+            }),
+            JSON.stringify({
+                data: {
+                    ConvAssist__sendMessage: {
+                        responses: [
+                            {
+                                msgId: 'msgId',
+                                data: {
+                                    asstRespData: {
+                                        tool: 'TS_NLS',
+                                        asstRespText: '',
+                                        nlsAnsData: {
+                                            sageQuerySuggestions: [
+                                                {
+                                                    llmReasoning: {
+                                                        assumptions: 'You want the total [COL|sales] for [COL|item_type] [VAL|jackets] for [VAL|this year].',
+                                                        clarifications: '',
+                                                        interpretation: '',
+                                                        __typename: 'eureka_SageQuerySuggestion_LLMReasoning',
+                                                    },
+                                                    tokens: [
+                                                        'sum sales',
+                                                        "item type = 'jackets'",
+                                                        "date = 'this year'",
+                                                    ],
+                                                    tmlTokens: [
+                                                        'sum [sales]',
+                                                        "[date] = [date].'this year'",
+                                                        "[item type] = [item type].'jackets'",
+                                                    ],
+                                                    worksheetId: 'worksheetId',
+                                                    description: '',
+                                                    title: '',
+                                                    cached: false,
+                                                    sqlQuery: "SELECT SUM(sales) FROM __Sample_Retail_Apparel WHERE item_type = 'jackets' AND date = _this_year();",
+                                                    sessionId: 'sessionId',
+                                                    genNo: 2,
+                                                    formulaInfo: [],
+                                                    tmlPhrases: [],
+                                                    stateKey: {
+                                                        transactionId: 'transactionId',
+                                                        generationNumber: 1,
+                                                        __typename: 'sage_auto_complete_v2_ACStateKey',
+                                                    },
+                                                    __typename: 'eureka_SageQuerySuggestion',
+                                                },
+                                            ],
+                                            responseType: 'ANSWER',
+                                            __typename: 'convassist_nls_tool_NLSToolAsstRespData',
+                                        },
+                                        __typename: 'convassist_AsstResponseData',
+                                    },
+                                    __typename: 'convassist_MessageData',
+                                },
+                                type: 'ASST_RESPONSE',
+                                __typename: 'convassist_MessagePayload',
+                            },
+                        ],
+                        __typename: 'convassist_SendMessageResponse',
+                    },
+                },
+            }),
+        );
+
+        const viewConfig: SpotterAgentEmbedViewConfig = {
+            worksheetId: 'worksheetId',
+            hiddenActions: [Action.Download, Action.Save], // This should trigger the HideActions branch
+        };
+
+        const spotterAgentEmbed = new SpotterAgentEmbed(viewConfig);
+        const result = await spotterAgentEmbed.sendMessage('userMessage');
+        
+        // Verify the iframe src contains the hideActions parameter
+        const iframeSrc = getIFrameSrc(result.container);
+        expect(iframeSrc).toContain('hideAction');
+    });
 });

package/src/embed/bodyless-conversation.ts

@@ -13,11 +13,17 @@ export interface SpotterAgentEmbedViewConfig extends ViewConfig {
      * The ID of the worksheet to use for the conversation.
      */
     worksheetId: string;
+    
+    /**
+     * Optional CSS class name to add to the container div.
+     */
+    containerClassName?: string;
 }
 
 /**
  * Configuration for conversation options.
- * @deprecated Renamed to SpotterAgentEmbedViewConfig
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+ * Use {@link SpotterAgentEmbedViewConfig} instead
  * @group Embed components
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
@@ -110,6 +116,10 @@ export class SpotterAgentEmbed {
         }
 
         const container = document.createElement('div');
+        if (this.viewConfig.containerClassName) {
+            container.className = this.viewConfig.containerClassName;
+        }
+
         const embed = new ConversationMessage(container, {
             ...this.viewConfig,
             sessionId: data.sessionId,
@@ -125,7 +135,8 @@ export class SpotterAgentEmbed {
 /**
  * Create a conversation embed, which can be integrated inside
  * chatbots or other conversational interfaces.
- * @deprecated Renamed to SpotterAgentEmbed
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+ * Use {@link SpotterAgentEmbed} instead
  * @example
  * ```js
  * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
@@ -140,7 +151,6 @@ export class SpotterAgentEmbed {
  * document.body.appendChild(container); // or to any other element
  * ```
  * @group Embed components
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
  */
 export class BodylessConversation extends SpotterAgentEmbed {
     constructor(viewConfig: BodylessConversationViewConfig) {

package/src/embed/conversation.ts

@@ -96,7 +96,8 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
 
 /**
  * The configuration for the embedded spotterEmbed options.
- * @deprecated Renamed to SpotterEmbedViewConfig
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+ * Use {@link SpotterEmbedViewConfig} instead
  * @group Embed components
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
@@ -115,7 +116,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {}
  * });
  * conversation.render();
  * ```
- * @version SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
  */
 export class SpotterEmbed extends TsEmbed {
     constructor(container: HTMLElement, protected viewConfig: SpotterEmbedViewConfig) {
@@ -182,7 +183,8 @@ export class SpotterEmbed extends TsEmbed {
 
 /**
  * Embed ThoughtSpot AI Conversation.
- * @deprecated Renamed to SpotterEmbed
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+ * Use {@link SpotterEmbed} instead
  * @group Embed components
  * @example
  * ```js

package/src/embed/ts-embed.spec.ts

@@ -58,6 +58,7 @@ import { HiddenActionItemByDefaultForSearchEmbed } from './search';
 import { processTrigger } from '../utils/processTrigger';
 import { UIPassthroughEvent } from './hostEventClient/contracts';
 import * as sessionInfoService from '../utils/sessionInfoService';
+import * as authToken from '../authToken';
 
 jest.mock('../utils/processTrigger');
 
@@ -2576,4 +2577,133 @@ describe('Unit test case for ts embed', () => {
             expect(iframeAfterInit).not.toBe(null);
         });
     });
+
+    describe('AutoLogin behavior in updateAuthToken', () => {
+      const mockPort = { postMessage: jest.fn() };
+      const mockEmbedEventPayload = { type: EmbedEvent.AuthExpire, data: {} };
+      
+      beforeEach(() => {
+        jest.clearAllMocks();
+        document.body.innerHTML = getDocumentBody();
+        mockPort.postMessage.mockClear();
+        jest.spyOn(authToken, 'getAuthenticationToken').mockResolvedValue('test-token');
+        
+        jest.spyOn(baseInstance, 'handleAuth').mockImplementation(() => Promise.resolve(true));
+        jest.spyOn(baseInstance, 'notifyAuthFailure').mockImplementation(() => {});
+      });
+
+      const renderAndTriggerAuthExpire = async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+        await searchEmbed.render();
+        await executeAfterWait(() => {
+          const iframe = getIFrameEl();
+          postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+        });
+      };
+
+      test('Cookieless with autoLogin undefined should default to true', async () => {
+        init({
+          thoughtSpotHost: 'tshost',
+          authType: AuthType.TrustedAuthTokenCookieless,
+          // autoLogin undefined
+        });
+
+        await renderAndTriggerAuthExpire();
+
+        await executeAfterWait(() => {
+          expect(authToken.getAuthenticationToken).toHaveBeenCalled();
+          expect(baseInstance.handleAuth).toHaveBeenCalledTimes(1);
+          expect(mockPort.postMessage).toHaveBeenCalledWith({
+            type: EmbedEvent.AuthExpire,
+            data: { authToken: 'test-token' },
+          });
+        });
+      });
+
+      test('Cookieless with autoLogin false should not get auth token', async () => {
+        init({
+          thoughtSpotHost: 'tshost',
+          authType: AuthType.TrustedAuthTokenCookieless,
+          autoLogin: false,
+        });
+
+        await renderAndTriggerAuthExpire();
+
+        await executeAfterWait(() => {
+          expect(authToken.getAuthenticationToken).not.toHaveBeenCalled();
+          expect(baseInstance.handleAuth).toHaveBeenCalledTimes(1);
+          expect(mockPort.postMessage).not.toHaveBeenCalled();
+        });
+      });
+
+      test('Cookieless with autoLogin true should get auth token', async () => {
+        init({
+          thoughtSpotHost: 'tshost',
+          authType: AuthType.TrustedAuthTokenCookieless,
+          autoLogin: true,
+        });
+
+        await renderAndTriggerAuthExpire();
+
+        await executeAfterWait(() => {
+          expect(authToken.getAuthenticationToken).toHaveBeenCalled();
+          expect(baseInstance.handleAuth).toHaveBeenCalledTimes(1);
+          expect(mockPort.postMessage).toHaveBeenCalledWith({
+            type: EmbedEvent.AuthExpire,
+            data: { authToken: 'test-token' },
+          });
+        });
+      });
+
+      test('Other authType with autoLogin undefined should default to false', async () => {
+        init({
+          thoughtSpotHost: 'tshost',
+          authType: AuthType.None,
+          // autoLogin undefined
+        });
+
+        await renderAndTriggerAuthExpire();
+
+        await executeAfterWait(() => {
+          expect(authToken.getAuthenticationToken).not.toHaveBeenCalled();
+          expect(baseInstance.handleAuth).toHaveBeenCalledTimes(1);
+        });
+      });
+
+      test('Other authType with autoLogin true should call handleAuth', async () => {
+        init({
+          thoughtSpotHost: 'tshost',
+          authType: AuthType.None,
+          autoLogin: true,
+        });
+
+        await renderAndTriggerAuthExpire();
+
+        await executeAfterWait(() => {
+          expect(authToken.getAuthenticationToken).not.toHaveBeenCalled();
+          expect(baseInstance.handleAuth).toHaveBeenCalledTimes(2);
+        });
+      });
+
+      test('Other authType with autoLogin false should not call handleAuth', async () => {
+        init({
+          thoughtSpotHost: 'tshost',
+          authType: AuthType.None,
+          autoLogin: false,
+        });
+
+        await renderAndTriggerAuthExpire();
+
+        await executeAfterWait(() => {
+          expect(authToken.getAuthenticationToken).not.toHaveBeenCalled();
+          expect(baseInstance.handleAuth).toHaveBeenCalledTimes(1);
+        });
+      });
+
+      afterEach(() => {
+        expect(baseInstance.notifyAuthFailure).toHaveBeenCalledWith(
+          authInstance.AuthFailureType.EXPIRY
+        );
+      });
+    });
 });

package/src/embed/ts-embed.ts

@@ -409,11 +409,13 @@ export class TsEmbed {
      * @param responder
      */
     private updateAuthToken = async (_: any, responder: any) => {
-        const { autoLogin = false, authType } = this.embedConfig; // Set autoLogin default to false
-        if (authType === AuthType.TrustedAuthTokenCookieless) {
-            let authToken = '';
+        const { authType } = this.embedConfig;
+        let { autoLogin } = this.embedConfig;
+        // Default autoLogin: true for cookieless if undefined/null, otherwise false
+        autoLogin = autoLogin ?? (authType === AuthType.TrustedAuthTokenCookieless);
+        if (autoLogin && authType === AuthType.TrustedAuthTokenCookieless) {
             try {
-                authToken = await getAuthenticationToken(this.embedConfig);
+                const authToken = await getAuthenticationToken(this.embedConfig);
                 responder({
                     type: EmbedEvent.AuthExpire,
                     data: { authToken },

package/src/index.ts

@@ -9,7 +9,12 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 import {
-    AppEmbed, Page, AppViewConfig, HomePageSearchBarMode,
+    AppEmbed,
+    Page,
+    AppViewConfig,
+    HomePageSearchBarMode,
+    PrimaryNavbarVersion,
+    HomePage,
 } from './embed/app';
 import {
     init,
@@ -23,8 +28,8 @@ import {
 import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from './embed/liveboard';
 import { SearchEmbed, SearchViewConfig } from './embed/search';
 import { SearchBarEmbed, SearchBarViewConfig } from './embed/search-bar';
-import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig,  SpotterAgentEmbed as BodylessConversation, SpotterAgentEmbedViewConfig as BodylessConversationViewConfig} from './embed/bodyless-conversation';
-import { SpotterEmbed, SpotterEmbedViewConfig, SpotterEmbed as ConversationEmbed, SpotterEmbedViewConfig as ConversationViewConfig } from './embed/conversation';
+import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversation, BodylessConversationViewConfig} from './embed/bodyless-conversation';
+import { SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed, ConversationViewConfig } from './embed/conversation';
 import {
     AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter,
 } from './auth';
@@ -133,6 +138,8 @@ export {
     uploadMixpanelEvent,
     MIXPANEL_EVENT,
     HomePageSearchBarMode,
+    PrimaryNavbarVersion,
+    HomePage,
     VizPoint,
     CustomActionPayload,
     UIPassthroughEvent,

package/src/react/all-types-export.ts

@@ -12,6 +12,7 @@ export {
     SpotterEmbed,
     ConversationEmbed,
     PreRenderedConversationEmbed,
+    SpotterAgentEmbed,
     useEmbedRef,
     useInit,
 } from './index';