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

package/src/embed/conversation.ts

@@ -15,10 +15,10 @@ export interface SearchOptions {
 }
 
 /**
- * The configuration for the embedded conversationEmbed options.
+ * The configuration for the embedded spotterEmbed options.
  * @group Embed components
  */
-export interface ConversationViewConfig extends ViewConfig {
+export interface SpotterEmbedViewConfig extends ViewConfig {
     /**
      * The ID of the worksheet to use for the conversation.
      */
@@ -32,7 +32,7 @@ export interface ConversationViewConfig extends ViewConfig {
      * but still display the selected data source.
      * @example
      * ```js
-     * const embed = new ConversationEmbed('#tsEmbed', {
+     * const embed = new SpotterEmbed('#tsEmbed', {
      *    ... // other options
      *    disableSourceSelection : true,
      * })
@@ -44,7 +44,7 @@ export interface ConversationViewConfig extends ViewConfig {
      * hideSourceSelection : Hide data source selection
      * @example
      * ```js
-     * const embed = new ConversationEmbed('#tsEmbed', {
+     * const embed = new SpotterEmbed('#tsEmbed', {
      *    ... // other options
      *    hideSourceSelection : true,
      * })
@@ -71,7 +71,7 @@ export interface ConversationViewConfig extends ViewConfig {
      * default is false.
      * @example
      * ```js
-     * const embed = new ConversationEmbed('#tsEmbed', {
+     * const embed = new SpotterEmbed('#tsEmbed', {
      *    ... // other options
      *    showSpotterLimitations : true,
      * })
@@ -84,7 +84,7 @@ export interface ConversationViewConfig extends ViewConfig {
      * the initial screen of the conversation.
      * @example
      * ```js
-     * const embed = new ConversationEmbed('#tsEmbed', {
+     * const embed = new SpotterEmbed('#tsEmbed', {
      *    ... // other options
      *    hideSampleQuestions : true,
      * })
@@ -94,12 +94,20 @@ export interface ConversationViewConfig extends ViewConfig {
     hideSampleQuestions?: boolean;
 }
 
+/**
+ * The configuration for the embedded spotterEmbed options.
+ * @deprecated Renamed to SpotterEmbedViewConfig
+ * @group Embed components
+ */
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface ConversationViewConfig extends SpotterEmbedViewConfig {}
+
 /**
  * Embed ThoughtSpot AI Conversation.
  * @group Embed components
  * @example
  * ```js
- * const conversation = new ConversationEmbed('#tsEmbed', {
+ * const conversation = new SpotterEmbed('#tsEmbed', {
  *   worksheetId: 'worksheetId',
  *   searchOptions: {
  *     searchQuery: 'searchQuery',
@@ -107,10 +115,10 @@ export interface ConversationViewConfig extends ViewConfig {
  * });
  * conversation.render();
  * ```
- * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
  */
-export class ConversationEmbed extends TsEmbed {
-    constructor(container: HTMLElement, protected viewConfig: ConversationViewConfig) {
+export class SpotterEmbed extends TsEmbed {
+    constructor(container: HTMLElement, protected viewConfig: SpotterEmbedViewConfig) {
         viewConfig.embedComponentType = 'conversation';
         super(container, viewConfig);
     }
@@ -163,7 +171,7 @@ export class ConversationEmbed extends TsEmbed {
         return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
     }
 
-    public async render(): Promise<ConversationEmbed> {
+    public async render(): Promise<SpotterEmbed> {
         await super.render();
 
         const src = this.getIframeSrc();
@@ -171,3 +179,26 @@ export class ConversationEmbed extends TsEmbed {
         return this;
     }
 }
+
+/**
+ * Embed ThoughtSpot AI Conversation.
+ * @deprecated Renamed to SpotterEmbed
+ * @group Embed components
+ * @example
+ * ```js
+ * const conversation = new SpotterEmbed('#tsEmbed', {
+ *   worksheetId: 'worksheetId',
+ *   searchOptions: {
+ *     searchQuery: 'searchQuery',
+ *   },
+ * });
+ * conversation.render();
+ * ```
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+ */
+export class ConversationEmbed extends SpotterEmbed {
+    constructor(container: HTMLElement, protected viewConfig: ConversationViewConfig) {
+        viewConfig.embedComponentType = 'conversation';
+        super(container, viewConfig);
+    }
+}

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

@@ -14,8 +14,6 @@ import {
     AppViewConfig,
     SageEmbed,
     SageViewConfig,
-    ConversationViewConfig,
-    ConversationEmbed,
     SearchViewConfig,
     AnswerService,
 } from '../index';

package/src/embed/ts-embed.ts

@@ -540,6 +540,7 @@ export class TsEmbed {
             disableRedirectionLinksInNewTab,
             overrideOrgId,
             exposeTranslationIDs,
+            primaryAction,
         } = this.viewConfig;
 
         const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
@@ -558,6 +559,9 @@ export class TsEmbed {
             this.handleError('You cannot have both hidden Tabs and visible Tabs');
             return queryParams;
         }
+        if (primaryAction) {
+            queryParams[Param.PrimaryAction] = primaryAction;
+        }
 
         if (disabledActions?.length) {
             queryParams[Param.DisableActions] = disabledActions;

package/src/index.ts

@@ -23,8 +23,8 @@ import {
 import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from './embed/liveboard';
 import { SearchEmbed, SearchViewConfig } from './embed/search';
 import { SearchBarEmbed, SearchBarViewConfig } from './embed/search-bar';
-import { BodylessConversation, BodylessConversationViewConfig } from './embed/bodyless-conversation';
-import { ConversationEmbed, ConversationViewConfig } from './embed/conversation';
+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 {
     AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter,
 } from './auth';
@@ -85,10 +85,14 @@ export {
     LiveboardEmbed,
     SageEmbed,
     AppEmbed,
-    BodylessConversation,
+    SpotterAgentEmbed,
+    SpotterAgentEmbedViewConfig,
     BodylessConversationViewConfig,
-    ConversationEmbed,
+    BodylessConversation,
+    SpotterEmbed,
+    SpotterEmbedViewConfig,
     ConversationViewConfig,
+    ConversationEmbed,
     AuthFailureType,
     AuthStatus,
     AuthEvent,

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

@@ -9,6 +9,7 @@ export {
     PreRenderedAppEmbed,
     SageEmbed,
     PreRenderedSageEmbed,
+    SpotterEmbed,
     ConversationEmbed,
     PreRenderedConversationEmbed,
     useEmbedRef,

package/src/react/index.tsx

@@ -13,7 +13,7 @@ import { TsEmbed } from '../embed/ts-embed';
 
 import { EmbedConfig, EmbedEvent, ViewConfig } from '../types';
 import { EmbedProps, getViewPropsAndListeners } from './util';
-import { ConversationEmbed as _ConversationEmbed, ConversationViewConfig } from '../embed/conversation';
+import { SpotterEmbed as _SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed as _ConversationEmbed, ConversationViewConfig as ConversationViewConfig } from '../embed/conversation';
 import { init } from '../embed/base';
 
 const componentFactory = <T extends typeof TsEmbed, U extends EmbedProps, V extends ViewConfig>(
@@ -334,6 +334,7 @@ export const PreRenderedSageEmbed = componentFactory<
     SageViewConfig
 >(_SageEmbed, true);
 
+interface SpotterEmbedProps extends EmbedProps, SpotterEmbedViewConfig { }
 interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig { }
 
 /**
@@ -341,6 +342,29 @@ interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig { }
  * @example
  * ```tsx
  * function Sage() {
+ *  return <SpotterEmbed
+ *      worksheetId="<worksheet-id-here>"
+ *      searchOptions={{
+ *          searchQuery: "<search query to start with>"
+ *      }}
+ *      ... other view config props or event listeners.
+ *  />
+ * }
+ * ```
+ */
+export const SpotterEmbed = componentFactory<
+    typeof _SpotterEmbed,
+    SpotterEmbedProps,
+    SpotterEmbedViewConfig
+>(_SpotterEmbed);
+
+
+/**
+ * React component for LLM based conversation BI.
+ * @deprecated This component is renamed to SpotterEmbed. Use {@link SpotterEmbed} instead.
+ * @example
+ * ```tsx
+ * function Sage() {
  *  return <ConversationEmbed
  *      worksheetId="<worksheet-id-here>"
  *      searchOptions={{
@@ -352,14 +376,15 @@ interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig { }
  * ```
  */
 export const ConversationEmbed = componentFactory<
-    typeof _ConversationEmbed, ConversationEmbedProps, ConversationViewConfig>(
-        _ConversationEmbed,
-    );
+    typeof _ConversationEmbed,
+    ConversationEmbedProps,
+    ConversationViewConfig
+>(_ConversationEmbed);
 
 /**
  * React component for PreRendered Conversation embed.
  *
- * PreRenderedConversationEmbed will preRender the ConversationEmbed and will be hidden by
+ * PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
  * default.
  *
  * SageEmbed with preRenderId passed will call showPreRender on the embed.
@@ -370,21 +395,22 @@ export const ConversationEmbed = componentFactory<
  * }
  * ```
  * function MyComponent() {
- *  return <ConversationEmbed preRenderId="someId" worksheetId="id" />
+ *  return <SpotterEmbed preRenderId="someId" worksheetId="id" />
  * }
  * ```
  */
 export const PreRenderedConversationEmbed = componentFactory<
-    typeof _ConversationEmbed,
-    SageEmbedProps & PreRenderProps,
-    ConversationViewConfig
->(_ConversationEmbed, true);
+    typeof _SpotterEmbed,
+    SpotterEmbedProps & PreRenderProps,
+    SpotterEmbedViewConfig
+>(_SpotterEmbed, true);
 
 type EmbedComponent = typeof SearchEmbed
     | typeof AppEmbed
     | typeof LiveboardEmbed
     | typeof SearchBarEmbed
     | typeof SageEmbed
+    | typeof SpotterEmbed
     | typeof ConversationEmbed;
 
 /**

package/src/types.ts

@@ -204,7 +204,19 @@ export enum HomeLeftNavItem {
     /**
      * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
      */
-    LiveboardSchedules = 'liveboard-schedules'
+    LiveboardSchedules = 'liveboard-schedules',
+    /**
+     * Create new options in the insights left navigation,
+     * available when new navigation V3 is enabled.
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    Create = 'create',
+    /**
+     * Spotter option in the insights left navigation,
+     * available when new navigation V3 is enabled.
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    Spotter = 'spotter',
 }
 export type DOMSelector = string | HTMLElement;
 
@@ -712,6 +724,19 @@ export interface ViewConfig {
      * ```
      */
     disabledActions?: Action[];
+    /**
+     * The primary action to display on top of the viz for Liveboard and App Embed.
+     * Use this to set the primary action.
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   primaryAction: Action.Download
+     * });
+     * ```
+     */
+    primaryAction?: Action | string;
     /**
      * The tooltip to display for disabled actions.
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
@@ -3324,8 +3349,17 @@ export enum HostEvent {
     /**
      * Get the Answer session for a Search or
      * Liveboard visualization.
+     * 
+     * Note: This event is not typically used directly. Instead, use the 
+     * `getAnswerService()` method on the embed instance to get an AnswerService 
+     * object that provides a more convenient interface for working with answers.
+     * 
      * @example
      * ```js
+     * // Preferred way to get an AnswerService
+     * const service = await embed.getAnswerService();
+     * 
+     * // Alternative direct usage (not recommended)
      * const {session} = await embed.trigger(
      *  HostEvent.GetAnswerSession, {
      *      vizId: '123', // For Liveboard Visualization.
@@ -3333,6 +3367,10 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
+     * // Preferred way to get an AnswerService
+     * const service = await embed.getAnswerService();
+     * 
+     * // Alternative direct usage (not recommended)
      * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
      * ```
      * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
@@ -3461,6 +3499,60 @@ export enum HostEvent {
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
     TransformTableVizData = 'TransformTableVizData',
+
+    /**
+     * Triggers the table visualization re-render with the updated data.
+     * Includes the following properties:
+     * @param - `columnDataLite` - an array of object containing the
+     * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
+     * payload.For example, { columnDataLite: []}`.
+     */
+    SpotterSearch = 'SpotterSearch',
+
+    /**
+     * Triggers the table visualization re-render with the updated data.
+     * Includes the following properties:
+     * @param - `columnDataLite` - an array of object containing the
+     * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
+     * payload.For example, { columnDataLite: []}`.
+     */
+    EditLastPrompt = 'EditLastPrompt',
+
+    /**
+     * Triggers the table visualization re-render with the updated data.
+     * Includes the following properties:
+     * @param - `columnDataLite` - an array of object containing the
+     * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
+     * payload.For example, { columnDataLite: []}`.
+     */
+    PreviewSpotterData = 'PreviewSpotterData',
+
+    /**
+     * Triggers the table visualization re-render with the updated data.
+     * Includes the following properties:
+     * @param - `columnDataLite` - an array of object containing the
+     * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
+     * payload.For example, { columnDataLite: []}`.
+     */
+    ResetSpotterConversation = 'ResetSpotterConversation',
+
+    /**
+     * Triggers the table visualization re-render with the updated data.
+     * Includes the following properties:
+     * @param - `columnDataLite` - an array of object containing the
+     * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
+     * payload.For example, { columnDataLite: []}`.
+     */
+    DeleteLastPrompt = 'DeleteLastPrompt',
+
+    /**
+     * Triggers the table visualization re-render with the updated data.
+     * Includes the following properties:
+     * @param - `columnDataLite` - an array of object containing the
+     * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
+     * payload.For example, { columnDataLite: []}`.
+     */
+    AnswerChartSwitcher = 'answerChartSwitcher',
 }
 
 /**
@@ -3541,6 +3633,10 @@ export enum Param {
     ShowInsertToSlide = 'insertInToSlide',
     PrimaryNavHidden = 'primaryNavHidden',
     HideProfleAndHelp = 'profileAndHelpInNavBarHidden',
+    NavigationVersion = 'navigationVersion',
+    HideHamburger = 'hideHamburger',
+    HideObjectSearch = 'hideObjectSearch',
+    HideNotification = 'hideNotification',
     HideApplicationSwitcher = 'applicationSwitcherHidden',
     HideOrgSwitcher = 'orgSwitcherHidden',
     IsSageEmbed = 'isSageEmbed',
@@ -3597,6 +3693,8 @@ export enum Param {
     preAuthCache = 'preAuthCache',
     ShowSpotterLimitations = 'showSpotterLimitations',
     CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
+    PrimaryAction = 'primaryAction',
+    isSpotterAgentEmbed = 'isSpotterAgentEmbed',
 }
 
 /**

package/src/utils/graphql/answerService/answerService.ts

@@ -26,29 +26,49 @@ export interface UnderlyingDataPoint {
 }
 
 /**
- * Class representing the answer service provided with the
- * custom action payload. This service could be used to run
- * graphql queries in the context of the answer on which the
- * custom action was triggered.
+ * AnswerService provides a simple way to work with ThoughtSpot Answers.
+ * 
+ * This service allows you to interact with ThoughtSpot Answers programmatically,
+ * making it easy to customize visualizations, filter data, and extract insights
+ * directly from your application.
+ * 
+ * You can use this service to:
+ * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`)
+ * - Apply filters to Answers (`addFilter`)
+ * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`)
+ * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`)
+ * - Run custom queries (`executeQuery`)
+ * - Add visualizations to liveboards (`addDisplayedVizToLiveboard`)
+ * 
  * @example
  * ```js
- *  embed.on(EmbedEvent.CustomAction, e => {
- *     const underlying = await e.answerService.getUnderlyingDataForPoint([
- *       'col name 1'
- *     ]);
- *     const data = await underlying.fetchData(0, 100);
- *  })
+ * // Get the answer service
+ * embed.on(EmbedEvent.Data, async (e) => {
+ *     const service = await embed.getAnswerService();
+ *     
+ *     // Add columns to the answer
+ *     await service.addColumnsByName(["Sales", "Region"]);
+ *     
+ *     // Get the data
+ *     const data = await service.fetchData();
+ *     console.log(data);
+ * });
  * ```
+ * 
  * @example
  * ```js
- * embed.on(EmbedEvent.Data, async (e) => {
- *     const service = await embed.getAnswerService();
- *     await service.addColumns([
- *         "<column guid>"
+ * // Get data for a point in a visualization
+ * embed.on(EmbedEvent.CustomAction, async (e) => {
+ *     const underlying = await e.answerService.getUnderlyingDataForPoint([
+ *       'Product Name',
+ *       'Sales Amount'
  *     ]);
- *     console.log(await service.fetchData());
+ *     
+ *     const data = await underlying.fetchData(0, 100);
+ *     console.log(data);
  * });
  * ```
+ * 
  * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
  * @group Events
  */

package/src/utils/processData.ts

@@ -80,15 +80,15 @@ export function processAuthFailure(e: any, containerEl: Element) {
     const {
         loginFailedMessage, authType, disableLoginFailurePage, autoLogin,
     } = getEmbedConfig();
-    if (
-        autoLogin
-        && (authType === AuthType.TrustedAuthToken
-            || authType === AuthType.TrustedAuthTokenCookieless)
-    ) {
+    
+    const isEmbeddedSSO = authType === AuthType.EmbeddedSSO;
+    const isTrustedAuth = authType === AuthType.TrustedAuthToken || authType === AuthType.TrustedAuthTokenCookieless;
+    const isEmbeddedSSOInfoFailure = isEmbeddedSSO && e?.data?.type === AuthFailureType.UNAUTHENTICATED_FAILURE;
+    if (autoLogin && isTrustedAuth) {
         // eslint-disable-next-line no-param-reassign
         containerEl.innerHTML = loginFailedMessage;
         notifyAuthFailure(AuthFailureType.IDLE_SESSION_TIMEOUT);
-    } else if (authType !== AuthType.None && !disableLoginFailurePage) {
+    } else if (authType !== AuthType.None && !disableLoginFailurePage && !isEmbeddedSSOInfoFailure) {
         // eslint-disable-next-line no-param-reassign
         containerEl.innerHTML = loginFailedMessage;
         notifyAuthFailure(AuthFailureType.OTHER);