@thoughtspot/visual-embed-sdk 1.37.1 → 1.38.0

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

@@ -1,5 +1,5 @@
 import 'jest-fetch-mock';
-import { BodylessConversation, BodylessConversationViewConfig } from './bodyless-conversation';
+import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig } from './bodyless-conversation';
 import * as authInstance from '../auth';
 import { init } from '../index';
 import { Action, AuthType, RuntimeFilterOp } from '../types';
@@ -14,7 +14,7 @@ import {
     expectUrlToHaveParamsWithValues,
 } from '../test/test-utils';
 
-describe('BodylessConversation', () => {
+describe('SpotterAgentEmbed', () => {
     const thoughtSpotHost = 'tshost';
 
     beforeAll(() => {
@@ -31,7 +31,7 @@ describe('BodylessConversation', () => {
         fetchMock.resetMocks();
     });
 
-    test('should render the bodyless conversation embed', async () => {
+    test('should render the SpotterAgent embed', async () => {
         fetchMock.mockResponses(
             JSON.stringify({
                 data: {
@@ -117,12 +117,12 @@ describe('BodylessConversation', () => {
                 },
             }),
         );
-        const viewConfig: BodylessConversationViewConfig = {
+        const viewConfig: SpotterAgentEmbedViewConfig = {
             worksheetId: 'worksheetId',
         };
 
-        const conversationEmbed = new BodylessConversation(viewConfig);
-        const result = await conversationEmbed.sendMessage('userMessage');
+        const spotterEmbed = new SpotterAgentEmbed(viewConfig);
+        const result = await spotterEmbed.sendMessage('userMessage');
         const iframeSrc = getIFrameSrc(result.container);
         expectUrlToHaveParamsWithValues(iframeSrc, {
             sessionId: 'sessionId',
@@ -134,7 +134,314 @@ describe('BodylessConversation', () => {
         fetchMock.mockRejectOnce(
             new Error('error'),
         );
-        const errorResult = await conversationEmbed.sendMessage('userMessage');
+        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

@@ -8,14 +8,28 @@ import { getQueryParamString } from '../utils';
  * Configuration for bodyless conversation options.
  * @group Embed components
  */
-export interface BodylessConversationViewConfig extends ViewConfig {
+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;
 }
 
-interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
+/**
+ * Configuration for conversation options.
+ * @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
+export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {}
+
+interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
     sessionId: string;
     genNo: number;
     acSessionId: string;
@@ -23,7 +37,7 @@ interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
 }
 
 class ConversationMessage extends TsEmbed {
-    constructor(container: HTMLElement, protected viewConfig: ConversationMessageViewConfig) {
+    constructor(container: HTMLElement, protected viewConfig: SpotterAgentMessageViewConfig) {
         viewConfig.embedComponentType = 'bodyless-conversation';
         super(container, viewConfig);
     }
@@ -39,6 +53,7 @@ class ConversationMessage extends TsEmbed {
         const queryParams = this.getBaseQueryParams();
 
         queryParams[Param.HideActions] = [...(queryParams[Param.HideActions] ?? [])];
+        queryParams[Param.isSpotterAgentEmbed] = true;
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {
@@ -68,9 +83,9 @@ class ConversationMessage extends TsEmbed {
  * chatbots or other conversational interfaces.
  * @example
  * ```js
- * import { BodylessConversation } from '@thoughtspot/visual-embed-sdk';
+ * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
  *
- * const conversation = new BodylessConversation({
+ * const conversation = new SpotterAgentEmbed({
  *  worksheetId: 'worksheetId',
  * });
  *
@@ -80,12 +95,12 @@ class ConversationMessage extends TsEmbed {
  * document.body.appendChild(container); // or to any other element
  * ```
  * @group Embed components
- * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
  */
-export class BodylessConversation {
+export class SpotterAgentEmbed {
     private conversationService: ConversationService;
 
-    constructor(private viewConfig: BodylessConversationViewConfig) {
+    constructor(private viewConfig: SpotterAgentEmbedViewConfig) {
         const embedConfig = getEmbedConfig();
 
         this.conversationService = new ConversationService(
@@ -101,6 +116,10 @@ export class BodylessConversation {
         }
 
         const container = document.createElement('div');
+        if (this.viewConfig.containerClassName) {
+            container.className = this.viewConfig.containerClassName;
+        }
+
         const embed = new ConversationMessage(container, {
             ...this.viewConfig,
             sessionId: data.sessionId,
@@ -112,3 +131,29 @@ export class BodylessConversation {
         return { container, viz: embed };
     }
 }
+
+/**
+ * Create a conversation embed, which can be integrated inside
+ * chatbots or other conversational interfaces.
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+ * Use {@link SpotterAgentEmbed} instead
+ * @example
+ * ```js
+ * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
+ *
+ * const conversation = new SpotterAgentEmbed({
+ *  worksheetId: 'worksheetId',
+ * });
+ *
+ * const { container, error } = await conversation.sendMessage('show me sales by region');
+ *
+ * // append the container to the DOM
+ * document.body.appendChild(container); // or to any other element
+ * ```
+ * @group Embed components
+ */
+export class BodylessConversation extends SpotterAgentEmbed {
+    constructor(viewConfig: BodylessConversationViewConfig) {
+        super(viewConfig);
+    }
+}

package/src/embed/conversation.spec.ts

@@ -1,6 +1,6 @@
 import {
-    ConversationEmbed,
-    ConversationViewConfig,
+    SpotterEmbed,
+    SpotterEmbedViewConfig,
 } from './conversation';
 import * as authInstance from '../auth';
 import { init } from '../index';
@@ -28,14 +28,14 @@ beforeAll(() => {
 
 describe('ConversationEmbed', () => {
     it('should render the conversation embed', async () => {
-        const viewConfig: ConversationViewConfig = {
+        const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
             searchOptions: {
                 searchQuery: 'searchQuery',
             },
         };
 
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
         await conversationEmbed.render();
         expectUrlMatchesWithParams(
             getIFrameSrc(),
@@ -44,7 +44,7 @@ describe('ConversationEmbed', () => {
     });
 
     it('should render the conversation embed with worksheets disabled', async () => {
-        const viewConfig: ConversationViewConfig = {
+        const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
             searchOptions: {
                 searchQuery: 'searchQuery',
@@ -52,7 +52,7 @@ describe('ConversationEmbed', () => {
             disableSourceSelection: true,
         };
 
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
         await conversationEmbed.render();
         expectUrlMatchesWithParams(
             getIFrameSrc(),
@@ -61,7 +61,7 @@ describe('ConversationEmbed', () => {
     });
 
     it('should render the conversation embed with spotter limitations text if flag is set', async () => {
-        const viewConfig: ConversationViewConfig = {
+        const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
             searchOptions: {
                 searchQuery: 'searchQuery',
@@ -69,7 +69,7 @@ describe('ConversationEmbed', () => {
             showSpotterLimitations: true,
         };
 
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
         await conversationEmbed.render();
         expectUrlMatchesWithParams(
             getIFrameSrc(),
@@ -78,7 +78,7 @@ describe('ConversationEmbed', () => {
     });
 
     it('should render the conversation embed with sample questions hidden', async () => {
-        const viewConfig: ConversationViewConfig = {
+        const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
             searchOptions: {
                 searchQuery: 'searchQuery',
@@ -86,7 +86,7 @@ describe('ConversationEmbed', () => {
             hideSampleQuestions: true,
         };
 
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
         await conversationEmbed.render();
         expectUrlMatchesWithParams(
             getIFrameSrc(),
@@ -95,7 +95,7 @@ describe('ConversationEmbed', () => {
     });
 
     it('should render the conversation embed with worksheets hidden', async () => {
-        const viewConfig: ConversationViewConfig = {
+        const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
             searchOptions: {
                 searchQuery: 'searchQuery',
@@ -103,7 +103,7 @@ describe('ConversationEmbed', () => {
             hideSourceSelection: true,
         };
 
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
         await conversationEmbed.render();
         expectUrlMatchesWithParams(
             getIFrameSrc(),
@@ -112,13 +112,13 @@ describe('ConversationEmbed', () => {
     });
 
     it('should handle error when worksheetId is not provided', async () => {
-        const viewConfig: ConversationViewConfig = {
+        const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: '',
             searchOptions: {
                 searchQuery: 'searchQuery',
             },
         };
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
         (conversationEmbed as any).handleError = jest.fn();
         await conversationEmbed.render();
         expect((conversationEmbed as any).handleError).toHaveBeenCalledWith(
@@ -127,7 +127,7 @@ describe('ConversationEmbed', () => {
     });
 
     it('should render the conversation embed if data panel v2 flag is true', async () => {
-        const viewConfig: ConversationViewConfig = {
+        const viewConfig: SpotterEmbedViewConfig = {
             worksheetId: 'worksheetId',
             searchOptions: {
                 searchQuery: 'searchQuery',
@@ -135,7 +135,7 @@ describe('ConversationEmbed', () => {
             dataPanelV2: true,
         };
 
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
+        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
         await conversationEmbed.render();
         expectUrlMatchesWithParams(
             getIFrameSrc(),