@thoughtspot/visual-embed-sdk 1.45.2 → 1.45.3

package/src/types.ts

@@ -1599,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
@@ -3203,6 +3203,42 @@ 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
@@ -4771,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',
 }
 
 /**
@@ -6216,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
@@ -6426,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 */
@@ -6444,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',
@@ -6471,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 */
@@ -6500,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',
 }
 
 /**
@@ -6513,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
@@ -6523,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:
@@ -6538,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 */

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,
             {},

package/src/utils.spec.ts

@@ -21,6 +21,8 @@ import {
     formatTemplate,
     isValidCssMargin,
     resetValueFromWindow,
+    validateHttpUrl,
+    setParamIfDefined,
 } from './utils';
 import { RuntimeFilterOp } from './types';
 import { logger } from './utils/logger';
@@ -824,4 +826,58 @@ describe('getValueFromWindow and storeValueInWindow', () => {
             expect(getValueFromWindow('key2')).toBe('value2');
         });
     });
+
+    describe('validateHttpUrl', () => {
+        test.each([
+            ['http URL', 'http://example.com'],
+            ['https URL', 'https://example.com'],
+            ['https URL with path', 'https://docs.example.com/spotter'],
+            ['https URL with query params', 'https://example.com/path?foo=bar'],
+        ])('should return [true, null] for valid %s', (_, url) => {
+            const [isValid, error] = validateHttpUrl(url);
+            expect(isValid).toBe(true);
+            expect(error).toBeNull();
+        });
+
+        test.each([
+            ['ftp protocol', 'ftp://example.com', 'ftp:'],
+            ['file protocol', 'file:///path/to/file', 'file:'],
+            ['javascript protocol', 'javascript:alert(1)', 'javascript:'],
+        ])('should return [false, Error] for %s', (_, url, protocol) => {
+            const [isValid, error] = validateHttpUrl(url);
+            expect(isValid).toBe(false);
+            expect(error).toBeInstanceOf(Error);
+            expect(error?.message).toContain('Invalid protocol');
+            expect(error?.message).toContain(protocol);
+        });
+
+        test.each([
+            ['invalid URL format', 'not-a-valid-url'],
+            ['empty string', ''],
+            ['URL without protocol', 'example.com'],
+        ])('should return [false, Error] for %s', (_, url) => {
+            const [isValid, error] = validateHttpUrl(url);
+            expect(isValid).toBe(false);
+            expect(error).toBeInstanceOf(Error);
+        });
+    });
+
+    describe('setParamIfDefined', () => {
+        test.each([
+            ['string value', 'testParam', 'testValue', false, 'testValue'],
+            ['number value', 'numParam', 42, false, 42],
+            ['truthy value as boolean', 'boolParam', 'truthy', true, true],
+            ['falsy value as boolean', 'boolParam', 0, true, false],
+        ])('should set %s correctly', (_, param, value, asBoolean, expected) => {
+            const queryParams: Record<string, unknown> = {};
+            setParamIfDefined(queryParams, param, value, asBoolean);
+            expect(queryParams[param]).toBe(expected);
+        });
+
+        test('should not set param when value is undefined', () => {
+            const queryParams: Record<string, unknown> = {};
+            setParamIfDefined(queryParams, 'testParam', undefined);
+            expect(queryParams.testParam).toBeUndefined();
+        });
+    });
 });

package/src/utils.ts

@@ -581,3 +581,39 @@ export const isWindowUndefined = (): boolean => {
     }
     return false;
 }
+
+/**
+ * Validates that a URL uses only http: or https: protocols.
+ * Returns a tuple of [isValid, error] so the caller can handle validation errors.
+ * @param url - The URL string to validate
+ * @returns [true, null] if valid, [false, Error] if invalid
+ */
+export const validateHttpUrl = (url: string): [boolean, Error | null] => {
+    try {
+        const parsedUrl = new URL(url);
+        if (parsedUrl.protocol !== 'http:' && parsedUrl.protocol !== 'https:') {
+            return [false, new Error(`Invalid protocol: ${parsedUrl.protocol}. Only http: and https: are allowed.`)];
+        }
+        return [true, null];
+    } catch (error) {
+        return [false, error instanceof Error ? error : new Error(String(error))];
+    }
+};
+
+/**
+ * Sets a query parameter if the value is defined.
+ * @param queryParams - The query params object to modify
+ * @param param - The parameter key
+ * @param value - The value to set
+ * @param asBoolean - If true, coerces value to boolean
+ */
+export const setParamIfDefined = <T>(
+    queryParams: Record<string, unknown>,
+    param: string,
+    value: T | undefined,
+    asBoolean = false,
+): void => {
+    if (value !== undefined) {
+        queryParams[param] = asBoolean ? !!value : value;
+    }
+};