@thoughtspot/visual-embed-sdk 1.39.2-alpha.1 → 1.39.2-spotter-agent

package/src/embed/bodyless-conversation.ts

@@ -13,11 +13,6 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
      * The ID of the worksheet to use for the conversation.
      */
     worksheetId: string;
-    
-    /**
-     * Optional CSS class name to add to the container div.
-     */
-    containerClassName?: string;
 }
 
 /**
@@ -29,14 +24,14 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {}
 
-interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
+export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
     sessionId: string;
     genNo: number;
     acSessionId: string;
     acGenNo: number;
 }
 
-class ConversationMessage extends TsEmbed {
+export class ConversationMessage extends TsEmbed {
     constructor(container: HTMLElement, protected viewConfig: SpotterAgentMessageViewConfig) {
         viewConfig.embedComponentType = 'bodyless-conversation';
         super(container, viewConfig);
@@ -116,9 +111,6 @@ export class SpotterAgentEmbed {
         }
 
         const container = document.createElement('div');
-        if (this.viewConfig.containerClassName) {
-            container.className = this.viewConfig.containerClassName;
-        }
 
         const embed = new ConversationMessage(container, {
             ...this.viewConfig,
@@ -130,6 +122,28 @@ export class SpotterAgentEmbed {
         await embed.render();
         return { container, viz: embed };
     }
+
+    /**
+     * Send a message to the conversation service and return only the data.
+     * @param userMessage - The message to send to the conversation service.
+     * @returns The data from the conversation service.
+     */
+    public async sendMessageData(userMessage: string) {
+        try {
+            const { data, error } = await this.conversationService.sendMessage(userMessage);
+            if (error) {
+                return { error };
+            }
+            return { data: {
+                sessionId: data.sessionId,
+                genNo: data.genNo,
+                acSessionId: data.stateKey.transactionId,
+                acGenNo: data.stateKey.generationNumber,
+            } };
+        } catch (error) {
+            return { error: error as Error };
+        }
+    }
 }
 
 /**

package/src/embed/conversation.spec.ts

@@ -1,8 +1,10 @@
-import { SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed } from './conversation';
-import { TsEmbed } from './ts-embed';
+import {
+    SpotterEmbed,
+    SpotterEmbedViewConfig,
+} from './conversation';
 import * as authInstance from '../auth';
 import { Action, init } from '../index';
-import { AuthType, Param, RuntimeFilterOp } from '../types';
+import { AuthType, Param } from '../types';
 import {
     getDocumentBody,
     getIFrameSrc,
@@ -178,132 +180,4 @@ describe('ConversationEmbed', () => {
             `http://${thoughtSpotHost}/v2/?${defaultParams}&${Param.DisableActions}=[%22${Action.InConversationTraining}%22]&${Param.DisableActionReason}=${disabledReason}&isSpotterExperienceEnabled=true&enableDataPanelV2=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
         );
     });
-
-    it('should render the conversation embed with runtime filters', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeFilters: [
-                {
-                    columnName: 'revenue',
-                    operator: RuntimeFilterOp.EQ,
-                    values: [1000],
-                },
-            ],
-        };
-
-        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&col1=revenue&op1=EQ&val1=1000#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
-
-    it('should render the conversation embed with runtime parameters', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeParameters: [
-                {
-                    name: 'Date Range',
-                    value: '30',
-                },
-            ],
-        };
-
-        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&param1=Date%20Range&paramVal1=30#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
-
-    it('should render the conversation embed with runtime parameters excluded from URL', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeParameters: [
-                {
-                    name: 'Date Range',
-                    value: '30',
-                },
-                {
-                    name: 'Region',
-                    value: 'North America',
-                },
-            ],
-            excludeRuntimeParametersfromURL: true,
-        };
-
-        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`,
-        );
-    });
-
-    it('should render the conversation embed with both runtime filters and parameters', async () => {
-        const viewConfig: SpotterEmbedViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeParameters: [
-                {
-                    name: 'Date Range',
-                    value: '30',
-                },
-            ],
-            runtimeFilters: [
-                {
-                    columnName: 'revenue',
-                    operator: RuntimeFilterOp.EQ,
-                    values: [1000],
-                },
-            ],
-            excludeRuntimeParametersfromURL: false,
-            excludeRuntimeFiltersfromURL: false,
-        };
-
-        const conversationEmbed = new SpotterEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&col1=revenue&op1=EQ&val1=1000&param1=Date%20Range&paramVal1=30#/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',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-            runtimeParameters: [
-                {
-                    name: 'Date Range',
-                    value: '30',
-                },
-            ],
-        };
-
-        // Test with deprecated class
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-
-        // Verify it generates the same URL structure as SpotterEmbed
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&param1=Date%20Range&paramVal1=30#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
 });

package/src/embed/conversation.ts

@@ -1,10 +1,10 @@
 import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
-import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter } from '../types';
+import { Param, BaseViewConfig } from '../types';
 import { TsEmbed } from './ts-embed';
-import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils';
+import { getQueryParamString } from '../utils';
 
-/**
+/** 
  * Configuration for search options
  */
 export interface SearchOptions {
@@ -20,8 +20,7 @@ export interface SearchOptions {
  */
 export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
     /**
-     * The ID of the data source object. For example, Model, View, or Table. Spotter uses
-     * this object to query data and generate Answers.
+     * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
      */
     worksheetId: string;
     /**
@@ -31,7 +30,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     /**
      * disableSourceSelection : Disables data source selection
      * but still display the selected data source.
-     *
+     * 
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -45,7 +44,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     disableSourceSelection?: boolean;
     /**
      * hideSourceSelection : Hide data source selection
-     *
+     * 
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -59,7 +58,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     hideSourceSelection?: boolean;
     /**
      * Flag to control Data panel experience
-     *
+     * 
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default false
      * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
@@ -77,7 +76,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * showSpotterLimitations : show limitation text
      * of the spotter underneath the chat input.
      * default is false.
-     *
+     * 
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -92,7 +91,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
     /**
      * hideSampleQuestions : Hide sample questions on
      * the initial screen of the conversation.
-     *
+     * 
      * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
@@ -104,63 +103,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     hideSampleQuestions?: boolean;
-    /**
-     * The list of runtime filters to apply to a search Answer,
-     * visualization, or Liveboard.
-     *
-     * Supported embed types: `SpotterEmbed`
-     * @example
-     * ```js
-     * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... // other embed view config
-     *    runtimeFilters: [
-     *           {
-     *             columnName: 'value',
-     *             operator: RuntimeFilterOp.EQ,
-     *             values: ['string' | 123 | true],
-     *           },
-     *       ],
-     * })
-     * ```
-     */
-    runtimeFilters?: RuntimeFilter[];
-    /**
-     * Flag to control whether runtime filters should be included in the URL.
-     * If true, filters will be passed via app initialization payload instead.
-     * If false/undefined, filters will be added to URL (default behavior).
-     *
-     * Supported embed types: `SpotterEmbed`
-     * @default false
-     */
-    excludeRuntimeFiltersfromURL?: boolean;
-    /**
-     * The list of runtime parameters to apply to the conversation.
-     *
-     * Supported embed types: `SpotterEmbed`
-     * @example
-     * ```js
-     * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... // other embed view config
-     *    runtimeParameters: [
-     *           {
-     *             name: 'Parameter Name',
-     *             value: 'Parameter Value',
-     *           },
-     *       ],
-     * })
-     * ```
-     */
-    runtimeParameters?: RuntimeParameter[];
-    /**
-     * Flag to control whether runtime parameters should be included in the URL.
-     * If true, parameters will be passed via app initialization payload instead.
-     * If false/undefined, parameters will be added to URL (default behavior).
-     *
-     * Supported embed types: `SpotterEmbed`
-     * @default false
-     *
-     */
-    excludeRuntimeParametersfromURL?: boolean;
 }
 
 /**
@@ -202,10 +144,6 @@ export class SpotterEmbed extends TsEmbed {
             dataPanelV2,
             showSpotterLimitations,
             hideSampleQuestions,
-            runtimeFilters,
-            excludeRuntimeFiltersfromURL,
-            runtimeParameters,
-            excludeRuntimeParametersfromURL,
         } = this.viewConfig;
         const path = 'insights/conv-assist';
         if (!worksheetId) {
@@ -237,21 +175,11 @@ export class SpotterEmbed extends TsEmbed {
         if (queryParamsString) {
             query = `?${queryParamsString}`;
         }
-
-        const filterQuery = getFilterQuery(runtimeFilters || []);
-        if (filterQuery && !excludeRuntimeFiltersfromURL) {
-            query += `&${filterQuery}`;
-        }
-
-        const parameterQuery = getRuntimeParameters(runtimeParameters || []);
-        if (parameterQuery && !excludeRuntimeParametersfromURL) {
-            query += `&${parameterQuery}`;
-        }
-
         const tsPostHashParams = this.getThoughtSpotPostUrlParams({
             worksheet: worksheetId,
             query: searchOptions?.searchQuery || '',
         });
+
         return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
     }
 

package/src/errors.ts

@@ -17,4 +17,5 @@ export const ERROR_MESSAGE = {
     CSP_FRAME_HOST_VIOLATION_LOG_MESSAGE: 'Please set up CSP correctly for the application to start working. For more information, see https://developers.thoughtspot.com/docs/security-settings#csp-viz-embed-hosts. \n If the issue persists, refer to https://developers.thoughtspot.com/docs/security-settings#csp-viz-embed-hosts',
     MISSING_REPORTING_OBSERVER: 'ReportingObserver not supported',
     RENDER_CALLED_BEFORE_INIT: 'Looks like render was called before calling init, the render won\'t start until init is called.\nFor more info check\n1. https://developers.thoughtspot.com/docs/Function_init#_init\n2.https://developers.thoughtspot.com/docs/getting-started#initSdk',
+    SPOTTER_AGENT_NOT_INITIALIZED: 'SpotterAgent not initialized',
 };

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

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