@thoughtspot/visual-embed-sdk 1.45.1 → 1.45.3

package/src/types.ts

@@ -1120,6 +1120,47 @@ export interface BaseViewConfig extends ApiInterceptFlags {
      * ```
      */
     customActions?: CustomAction[];
+
+
+    /**
+     * Refresh the auth token when the token is near expiry.
+     * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    refreshAuthTokenOnNearExpiry: true,
+     * })
+     * ```
+     */
+    refreshAuthTokenOnNearExpiry?: boolean;
+    /**
+     * This flag skips payload validation so events can be processed even if the payload is old, incomplete, or from a trusted system.
+     * @default false
+     * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    shouldBypassPayloadValidation:true,
+     * })
+     * ```
+     */
+    shouldBypassPayloadValidation?: boolean;
+
+    /**
+     * Flag to use host events v2. This is used to enable the new host events v2 API.
+     * @default false
+     * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    useHostEventsV2:true,
+     * })
+     * ```
+     */
+    useHostEventsV2?: boolean;
 }
 
 /**
@@ -1558,7 +1599,7 @@ export interface LiveboardAppEmbedViewConfig {
      * To enable this feature on your instance, contact ThoughtSpot Support.
      *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-     * @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -3162,6 +3203,55 @@ export enum EmbedEvent {
      * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
      */
     ApiIntercept = 'ApiIntercept',
+    /**
+     * Emitted when a Spotter conversation is renamed.
+     * @example
+     * ```js
+     * spotterEmbed.on(EmbedEvent.SpotterConversationRenamed, (payload) => {
+     *     console.log('Conversation renamed', payload);
+     *     // payload: { convId: string, oldTitle: string, newTitle: string }
+     * })
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    SpotterConversationRenamed = 'spotterConversationRenamed',
+    /**
+     * Emitted when a Spotter conversation is deleted.
+     * @example
+     * ```js
+     * spotterEmbed.on(EmbedEvent.SpotterConversationDeleted, (payload) => {
+     *     console.log('Conversation deleted', payload);
+     *     // payload: { convId: string, title: string }
+     * })
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    SpotterConversationDeleted = 'spotterConversationDeleted',
+    /**
+     * Emitted when a Spotter conversation is selected/clicked.
+     * @example
+     * ```js
+     * spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => {
+     *     console.log('Conversation selected', payload);
+     *     // payload: { convId: string, title: string, worksheetId: string }
+     * })
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    SpotterConversationSelected = 'spotterConversationSelected',
+    
+    /**
+     * @hidden
+     * Emitted when the auth token is about to get expired and needs to be refreshed.
+     * @example
+     * ```js
+     * embed.on(EmbedEvent.RefreshAuthToken, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     * ```
+     * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+     */
+    RefreshAuthToken = 'RefreshAuthToken',
 }
 
 /**
@@ -4547,6 +4637,18 @@ export enum HostEvent {
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     StartNewSpotterConversation = 'StartNewSpotterConversation',
+
+    /**
+     * @hidden
+     * Get the current context of the embedded page.
+     * 
+     * @example
+     * ```js
+     * const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
+     * ```
+     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     */
+    GetPageContext = 'GetPageContext',
 }
 
 /**
@@ -4705,7 +4807,19 @@ export enum Param {
     isLinkParametersEnabled = 'isLinkParametersEnabled',
     EnablePastConversationsSidebar = 'enablePastConversationsSidebar',
     UpdatedSpotterChatPrompt = 'updatedSpotterChatPrompt',
+    SpotterSidebarTitle = 'spotterSidebarTitle',
+    SpotterSidebarDefaultExpanded = 'spotterSidebarDefaultExpanded',
+    SpotterChatRenameLabel = 'spotterChatRenameLabel',
+    SpotterChatDeleteLabel = 'spotterChatDeleteLabel',
+    SpotterDeleteConversationModalTitle = 'spotterDeleteConversationModalTitle',
+    SpotterPastConversationAlertMessage = 'spotterPastConversationAlertMessage',
+    SpotterDocumentationUrl = 'spotterDocumentationUrl',
+    SpotterBestPracticesLabel = 'spotterBestPracticesLabel',
+    SpotterConversationsBatchSize = 'spotterConversationsBatchSize',
+    SpotterNewChatButtonTitle = 'spotterNewChatButtonTitle',
     IsThisPeriodInDateFiltersEnabled = 'isThisPeriodInDateFiltersEnabled',
+    HideToolResponseCardBranding = 'hideToolResponseCardBranding',
+    ToolResponseCardBrandingLabel = 'toolResponseCardBrandingLabel',
 }
 
 /**
@@ -6150,6 +6264,96 @@ export enum Action {
      * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
      */
     UngroupLiveboardGroup = 'ungroupLiveboardGroup',
+    /**
+     * Controls visibility of the sidebar header (title and toggle button)
+     * in the Spotter past conversations sidebar.
+     * @example
+     * ```js
+     * hiddenActions: [Action.SpotterSidebarHeader]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterSidebarHeader = 'spotterSidebarHeader',
+    /**
+     * Controls visibility of the sidebar footer (documentation link)
+     * in the Spotter past conversations sidebar.
+     * @example
+     * ```js
+     * hiddenActions: [Action.SpotterSidebarFooter]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterSidebarFooter = 'spotterSidebarFooter',
+    /**
+     * Controls visibility and disable state of the sidebar toggle/expand button
+     * in the Spotter past conversations sidebar.
+     * @example
+     * ```js
+     * disabledActions: [Action.SpotterSidebarToggle]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterSidebarToggle = 'spotterSidebarToggle',
+    /**
+     * Controls visibility and disable state of the "New Chat" button
+     * in the Spotter past conversations sidebar.
+     * @example
+     * ```js
+     * disabledActions: [Action.SpotterNewChat]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterNewChat = 'spotterNewChat',
+    /**
+     * Controls visibility of the past conversation banner alert
+     * in the Spotter interface.
+     * @example
+     * ```js
+     * hiddenActions: [Action.SpotterPastChatBanner]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterPastChatBanner = 'spotterPastChatBanner',
+    /**
+     * Controls visibility and disable state of the conversation edit menu
+     * (three-dot menu) in the Spotter past conversations sidebar.
+     * @example
+     * ```js
+     * disabledActions: [Action.SpotterChatMenu]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterChatMenu = 'spotterChatMenu',
+    /**
+     * Controls visibility and disable state of the rename action
+     * in the Spotter conversation edit menu.
+     * @example
+     * ```js
+     * disabledActions: [Action.SpotterChatRename]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterChatRename = 'spotterChatRename',
+    /**
+     * Controls visibility and disable state of the delete action
+     * in the Spotter conversation edit menu.
+     * @example
+     * ```js
+     * disabledActions: [Action.SpotterChatDelete]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterChatDelete = 'spotterChatDelete',
+    /**
+     * Controls visibility and disable state of the documentation/best practices
+     * link in the Spotter sidebar footer.
+     * @example
+     * ```js
+     * disabledActions: [Action.SpotterDocs]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    SpotterDocs = 'spotterDocs',
     /**
      * The **Include current period** checkbox for date filters.
      * Controls the visibility and availability of the option to include
@@ -6360,13 +6564,30 @@ export enum LogLevel {
  * Error types emitted by embedded components.
  *
  * These enum values categorize different types of errors that can occur during
- * the lifecycle of an embedded ThoughtSpot component. Use these values to implement
- * specific error handling logic based on the error category.
- *
- * @see {@link EmbedErrorDetailsEvent} - The error event object structure
- * @see {@link EmbedEvent.Error} - The event that emits these errors
+ * the lifecycle of an embedded ThoughtSpot component. 
+ * Use {@link EmbedErrorDetailsEvent} and {@link EmbedErrorCodes} to handle specific errors.
  * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
  * @group Error Handling
+ * 
+ * @example
+ * Handle specific error types
+ * ```js
+ * embed.on(EmbedEvent.Error, (error) => {
+ *   switch (error.errorType) {
+ *     case ErrorDetailsTypes.API:
+ *       console.error('API error:', error.message);
+ *       break;
+ *     case ErrorDetailsTypes.VALIDATION_ERROR:
+ *       console.error('Validation error:', error.message);
+ *       break;
+ *     case ErrorDetailsTypes.NETWORK:
+ *       console.error('Network error:', error.message);
+ *       break;
+ *     default:
+ *       console.error('Unknown error:', error);
+ *   }
+ * });
+ * ```
  */
 export enum ErrorDetailsTypes {
     /** API call failure */
@@ -6378,26 +6599,34 @@ export enum ErrorDetailsTypes {
 }
 
 /**
- * Error codes for identifying specific issues in embedded ThoughtSpot components.
- *
- * Use these codes for precise error handling and debugging. Each code maps to a
- * distinct failure scenario, enabling targeted recovery strategies.
+ * Error codes for identifying specific issues in embedded ThoughtSpot components. Use {@link EmbedErrorDetailsEvent}  and  {@link ErrorDetailsTypes} codes for precise error handling and debugging.
  *
  * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
  * @group Error Handling
- *
- * @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
- * @see {@link ErrorDetailsTypes} - General error type categories
- *
+
  * @example
  * Handle specific error codes in the error event handler
- *
+ * ```js
  * embed.on(EmbedEvent.Error, (error) => {
- *   if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {
- *     console.error('Worksheet ID not found:', error.message);
+ *   switch (error.code) {
+ *     case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
+ *       console.error('Worksheet ID not found:', error.message);
+ *       break;
+ *     case EmbedErrorCodes.LIVEBOARD_ID_MISSING:
+ *       console.error('Liveboard ID is missing:', error.message);
+ *       break;
+ *     case EmbedErrorCodes.CONFLICTING_ACTIONS_CONFIG:
+ *       console.error('Conflicting actions configuration:', error.message);
+ *       break;
+ *     case EmbedErrorCodes.CONFLICTING_TABS_CONFIG:
+ *       console.error('Conflicting tabs configuration:', error.message);
+ *       break;
+ *     default:
+ *       console.error('Unknown error:', error);
  *   }
  * });
- *  */
+ * ```
+ * */
 export enum EmbedErrorCodes {
     /** Worksheet ID not found or does not exist */
     WORKSHEET_ID_NOT_FOUND = 'WORKSHEET_ID_NOT_FOUND',
@@ -6405,10 +6634,10 @@ export enum EmbedErrorCodes {
     /** Required Liveboard ID is missing from configuration */
     LIVEBOARD_ID_MISSING = 'LIVEBOARD_ID_MISSING',
 
-    /** Conflicting action configuration detected (e.g., both hiddenActions and visibleActions specified) */
+    /** Conflicting action configuration detected */
     CONFLICTING_ACTIONS_CONFIG = 'CONFLICTING_ACTIONS_CONFIG',
 
-    /** Conflicting tab configuration detected (e.g., both hiddenTabs and visibleTabs specified) */
+    /** Conflicting tab configuration detected  */
     CONFLICTING_TABS_CONFIG = 'CONFLICTING_TABS_CONFIG',
 
     /** Error during component initialization */
@@ -6434,6 +6663,9 @@ export enum EmbedErrorCodes {
 
     /** Failed to update embed parameters during pre-render */
     UPDATE_PARAMS_FAILED = 'UPDATE_PARAMS_FAILED',
+
+    /** Invalid URL provided in configuration */
+    INVALID_URL = 'INVALID_URL',
 }
 
 /**
@@ -6447,7 +6679,7 @@ export enum EmbedErrorCodes {
  *
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
  * - **message**: Human-readable error description (string or array of strings for multiple errors)
- * - **code**: Machine-readable error identifier for programmatic handling
+ * - **code**: Machine-readable error identifier {@link EmbedErrorCodes} values
  * - **[key: string]**: Additional context-specific for backward compatibility
  *
  * ## Usage
@@ -6457,12 +6689,11 @@ export enum EmbedErrorCodes {
  *
  * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
  * @group Error Handling
- * @see {@link ErrorDetailsTypes} - Available error type values
- * @see {@link EmbedEvent.Error} - The event that emits this object
  *
  * @example
  * Handle specific error types
- *
+ * 
+ * ```js
  * embed.on(EmbedEvent.Error, (error) => {
  *   switch (error.code) {
  *     case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
@@ -6472,30 +6703,18 @@ export enum EmbedErrorCodes {
  *       console.error('Unknown error:', error);
  *   }
  * });
- *  *
+ * ```
  * @example
  * Handle multiple error messages
- *
+ * 
+ * ```js
  * embed.on(EmbedEvent.Error, (error) => {
  *   const messages = Array.isArray(error.message)
  *     ? error.message
  *     : [error.message];
- *
  *   messages.forEach(msg => console.error(msg));
  * });
- *  *
- * @example
- * Access additional error context
- *
- * embed.on(EmbedEvent.Error, (error) => {
- *   console.error('Error Details:', {
- *     type: error.errorType,
- *     message: error.message,
- *     code: error.code,
- *     // Additional context fields vary by error type
- *     ...error
- *   });
- * });
+ * ```
  *  */
 export interface EmbedErrorDetailsEvent {
     /** The type of error that occurred */
@@ -6507,6 +6726,26 @@ export interface EmbedErrorDetailsEvent {
     /** Additional context-specific for backward compatibility */
     [key: string]: any;
 }
+
+export enum ContextType {
+    /**
+     * Search answer context for search page or edit viz dialog on liveboard page.
+     */
+    Search = 'search-answer',
+    /**
+     * Liveboard context for liveboard page.
+     */
+    Liveboard = 'liveboard',
+    /**
+     * Answer context for explore modal/page on liveboard page.
+     */
+    Answer = 'answer',
+    /**
+     * Spotter context for spotter modal/page.
+     */
+    Spotter = 'spotter',
+}
+
 export interface DefaultAppInitData {
     customisations: CustomisationsInterface;
     authToken: string;
@@ -6584,3 +6823,88 @@ export type ApiInterceptFlags = {
      */
     interceptTimeout?: number;
 };
+
+/**
+ * Object IDs for the embedded component.
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+ */
+export interface ObjectIds {
+    /**
+     * Liveboard ID.
+     */
+    liveboardId?: string;
+    /**
+     * Answer ID.
+     */
+    answerId?: string;
+    /**
+     * Viz IDs.
+     */
+    vizIds?: string[];
+    /**
+     * Data model IDs.
+     */
+    dataModelIds?: string[];
+    /**
+     * Modal title.
+     */
+    modalTitle?: string;
+}
+
+/**
+ * Context object for the embedded component.
+ * @example
+ * ```js
+ * const context = await embed.getCurrentContext();
+ * console.log(context);
+ * {
+ *   stack: [
+ *     {
+ *       name: 'Liveboard',
+ *       type: ContextType.Liveboard,
+ *       objectIds: {
+ *         liveboardId: '123',
+ *       },
+ *     },
+ *   ],
+ *   currentContext: {
+ *     name: 'Liveboard',
+ *     type: ContextType.Liveboard,
+ *     objectIds: {
+ *       liveboardId: '123',
+ *     },
+ *   },
+ * }
+ * ```
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
+ */
+export interface ContextObject {
+    /**
+     * Stack of context objects.
+     */
+   stack: Array<{
+    /**
+     * Name of the context object.
+     */
+    name: string;
+    /**
+     * Type of the context object.
+     */
+    type: ContextType;
+    /**
+     * Object IDs of the context object.
+     */
+    objectIds: ObjectIds;
+   }>
+   /**
+    * Current context object.
+    */
+   currentContext: {
+    /**
+     * Name of the current context object.
+     */
+    name: string;
+    type: ContextType;
+    objectIds: ObjectIds;
+   }
+}

package/src/utils/graphql/answerService/answer-queries.ts

@@ -176,6 +176,29 @@ export const getSQLQuery = `
     }
 `;
 
+export const updateDisplayMode = `
+   mutation UpdateDisplayMode(
+    $session: BachSessionIdInput!
+    $displayMode: DisplayMode
+) {
+    Answer__updateProperties(session: $session, displayMode: $displayMode) {
+        id {
+            sessionId
+            genNo
+            acSession {
+                sessionId
+                genNo
+            }
+        }
+        answer {
+            id
+            displayMode
+            suggestedDisplayMode
+        }
+    }
+}
+`;
+
 export const getAnswerTML = `
 mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies: Boolean, $formatType:  EDocFormatType, $exportPermissions: Boolean, $exportFqn: Boolean) {
   UnsavedAnswer_getTML(

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

@@ -473,6 +473,93 @@ describe('Answer service tests', () => {
         expect(sql).toBe('SELECT * FROM table');
     });
 
+    test('Get SQL query with all columns should update display mode', async () => {
+        fetchMock.mockResponses(
+            JSON.stringify({
+                data: {
+                    Answer__updateProperties: {
+                        id: {
+                            ...defaultSession,
+                        },
+                        answer: {
+                            id: 'answer1',
+                            displayMode: 'TABLE_MODE',
+                            suggestedDisplayMode: 'CHART_MODE',
+                        },
+                    },
+                },
+            }),
+            JSON.stringify({
+                data: {
+                    Answer__getQuery: {
+                        sql: 'SELECT * FROM table',
+                    },
+                },
+            }),
+        );
+        const answerService = createAnswerService();
+        const sql = await answerService.getSQLQuery(true);
+        expect(fetchMock).toHaveBeenCalledWith(
+            'https://tshost/prism/?op=UpdateDisplayMode',
+            expect.objectContaining({
+                body: JSON.stringify({
+                    operationName: 'UpdateDisplayMode',
+                    query: queries.updateDisplayMode,
+                    variables: {
+                        session: defaultSession,
+                        displayMode: 'TABLE_MODE',
+                    },
+                }),
+            }),
+        );
+        expect(fetchMock).toHaveBeenCalledWith(
+            'https://tshost/prism/?op=GetSQLQuery',
+            expect.objectContaining({
+                body: JSON.stringify({
+                    operationName: 'GetSQLQuery',
+                    query: getSQLQuery,
+                    variables: {
+                        session: defaultSession,
+                    },
+                }),
+            }),
+        );
+        expect(sql).toBe('SELECT * FROM table');
+    });
+
+    test('Update display mode should call the right API', async () => {
+        fetchMock.mockResponseOnce(JSON.stringify({
+            data: {
+                Answer__updateProperties: {
+                    id: {
+                        ...defaultSession,
+                    },
+                    answer: {
+                        id: 'answer1',
+                        displayMode: 'CHART_MODE',
+                        suggestedDisplayMode: 'TABLE_MODE',
+                    },
+                },
+            },
+        }));
+        const answerService = createAnswerService();
+        const response = await answerService.updateDisplayMode('CHART_MODE');
+        expect(fetchMock).toHaveBeenCalledWith(
+            'https://tshost/prism/?op=UpdateDisplayMode',
+            expect.objectContaining({
+                body: JSON.stringify({
+                    operationName: 'UpdateDisplayMode',
+                    query: queries.updateDisplayMode,
+                    variables: {
+                        session: defaultSession,
+                        displayMode: 'CHART_MODE',
+                    },
+                }),
+            }),
+        );
+        expect(response.answer.displayMode).toBe('CHART_MODE');
+    });
+
     test('Add displayed Viz should call the right API', async () => {
         fetchMock.mockResponseOnce(JSON.stringify({
             data: {

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

@@ -190,7 +190,19 @@ export class AnswerService {
         );
     }
 
-    public async getSQLQuery(): Promise<string> {
+    public async updateDisplayMode(displayMode = "TABLE_MODE") {
+        return this.executeQuery(
+            queries.updateDisplayMode,
+            {
+                displayMode,
+            },
+        );
+    }
+
+    public async getSQLQuery(fetchSQLWithAllColumns = false): Promise<string> {
+        if (fetchSQLWithAllColumns) {
+            await this.updateDisplayMode("TABLE_MODE");
+        }
         const { sql } = await this.executeQuery(
             queries.getSQLQuery,
             {},