@thoughtspot/visual-embed-sdk 1.46.5-beta.1 → 1.47.0

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

@@ -11,8 +11,6 @@ import {
     AppEmbed,
     LiveboardEmbed,
     AppViewConfig,
-    SageEmbed,
-    SageViewConfig,
     SearchViewConfig,
     AnswerService,
     SpotterEmbed,
@@ -2192,28 +2190,6 @@ describe('Unit test case for ts embed', () => {
                     `http://${thoughtSpotHost}/?embedApp=true${defaultParams}#/embed/viz/${liveboardId}`,
                 );
             });
-
-            const defaultConfig: SageViewConfig = {
-                disableWorksheetChange: false,
-                hideWorksheetSelector: false,
-                hideSageAnswerHeader: false,
-                hideAutocompleteSuggestions: false,
-                hideSampleQuestions: false,
-                isProductTour: false,
-                dataPanelV2: false,
-            };
-
-            const sageEmbed = new SageEmbed(getRootEl(), {
-                ...defaultConfig,
-            } as SageViewConfig);
-
-            sageEmbed.render();
-            await executeAfterWait(() => {
-                expectUrlMatch(
-                    getIFrameSrc(),
-                    `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
-                );
-            });
         });
 
         it('Should add contextMenuEnabledOnWhichClick flag to the iframe with left value', async () => {
@@ -2230,29 +2206,6 @@ describe('Unit test case for ts embed', () => {
                     `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&contextMenuEnabledOnWhichClick=left#/embed/viz/${liveboardId}`,
                 );
             });
-
-            const defaultConfig: SageViewConfig = {
-                disableWorksheetChange: false,
-                hideWorksheetSelector: false,
-                hideSageAnswerHeader: false,
-                hideAutocompleteSuggestions: false,
-                hideSampleQuestions: false,
-                isProductTour: false,
-                dataPanelV2: false,
-            };
-
-            const sageEmbed = new SageEmbed(getRootEl(), {
-                ...defaultConfig,
-                contextMenuTrigger: ContextMenuTriggerOptions.LEFT_CLICK,
-            } as SageViewConfig);
-
-            sageEmbed.render();
-            await executeAfterWait(() => {
-                expectUrlMatch(
-                    getIFrameSrc(),
-                    `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&contextMenuEnabledOnWhichClick=left&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
-                );
-            });
         });
 
         it('Should add contextMenuEnabledOnWhichClick flag to the iframe with right value', async () => {
@@ -2269,28 +2222,6 @@ describe('Unit test case for ts embed', () => {
                     `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&contextMenuEnabledOnWhichClick=right#/embed/viz/${liveboardId}`,
                 );
             });
-            const defaultConfig: SageViewConfig = {
-                disableWorksheetChange: false,
-                hideWorksheetSelector: false,
-                hideSageAnswerHeader: false,
-                hideAutocompleteSuggestions: false,
-                hideSampleQuestions: false,
-                isProductTour: false,
-                dataPanelV2: false,
-            };
-
-            const sageEmbed = new SageEmbed(getRootEl(), {
-                ...defaultConfig,
-                contextMenuTrigger: ContextMenuTriggerOptions.RIGHT_CLICK,
-            } as SageViewConfig);
-
-            sageEmbed.render();
-            await executeAfterWait(() => {
-                expectUrlMatch(
-                    getIFrameSrc(),
-                    `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&contextMenuEnabledOnWhichClick=right&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
-                );
-            });
         });
 
         it('Should add contextMenuEnabledOnWhichClick flag to the iframe with both value', async () => {
@@ -2307,28 +2238,6 @@ describe('Unit test case for ts embed', () => {
                     `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&contextMenuEnabledOnWhichClick=both#/embed/viz/${liveboardId}`,
                 );
             });
-            const defaultConfig: SageViewConfig = {
-                disableWorksheetChange: false,
-                hideWorksheetSelector: false,
-                hideSageAnswerHeader: false,
-                hideAutocompleteSuggestions: false,
-                hideSampleQuestions: false,
-                isProductTour: false,
-                dataPanelV2: false,
-            };
-
-            const sageEmbed = new SageEmbed(getRootEl(), {
-                ...defaultConfig,
-                contextMenuTrigger: ContextMenuTriggerOptions.BOTH_CLICKS,
-            } as SageViewConfig);
-
-            sageEmbed.render();
-            await executeAfterWait(() => {
-                expectUrlMatch(
-                    getIFrameSrc(),
-                    `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&contextMenuEnabledOnWhichClick=both&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`,
-                );
-            });
         });
     });
 
@@ -3558,6 +3467,45 @@ describe('Unit test case for ts embed', () => {
             expect(getRootEl().nextElementSibling.innerHTML).toBe('');
         });
 
+        it('should not call trigger or remove DOM if destroy is called before render', () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: { width: '100%', height: '100%' },
+            });
+
+            const triggerSpy = jest.spyOn(appEmbed, 'trigger');
+            const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild');
+
+            appEmbed.destroy();
+
+            expect(triggerSpy).not.toHaveBeenCalled();
+            expect(removeChildSpy).not.toHaveBeenCalled();
+        });
+
+        it('should still remove DOM element when trigger rejects (waitForCleanupOnDestroy: true)', async () => {
+            const originalEmbedConfig = embedConfig.getEmbedConfig();
+            embedConfig.setEmbedConfig({
+                ...originalEmbedConfig,
+                waitForCleanupOnDestroy: true,
+                cleanupTimeout: 1000,
+            });
+
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: { width: '100%', height: '100%' },
+            });
+            await appEmbed.render();
+
+            jest.spyOn(appEmbed, 'trigger').mockRejectedValue(new Error('trigger failed'));
+            const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+            appEmbed.destroy();
+
+            await new Promise(resolve => setTimeout(resolve, 50));
+
+            expect(removeChildSpy).toHaveBeenCalled();
+
+            embedConfig.setEmbedConfig(originalEmbedConfig);
+        });
+
         describe('with waitForCleanupOnDestroy configuration', () => {
             let originalEmbedConfig: any;
 
@@ -4220,9 +4168,9 @@ describe('PreRender replaceExistingPreRender scenarios', () => {
             preRenderId: 'no-replace-test',
             liveboardId: 'lb2',
         });
-        
+
         const result = await embed2.preRender(false, false);
-        
+
         expect(result).toBe(embed2);
         // The original iframe should still have lb1
         const iframe = getIFrameEl();
@@ -4247,17 +4195,17 @@ describe('Destroy error handling', () => {
             frameParams: { width: '100%', height: '100%' },
         });
         await appEmbed.render();
-        
+
         const logSpy = jest.spyOn(logger, 'log').mockImplementation(() => {});
-        
+
         jest.spyOn(Node.prototype, 'removeChild').mockImplementationOnce(() => {
             throw new Error('Remove failed');
         });
-        
+
         expect(() => {
             appEmbed.destroy();
         }).not.toThrow();
-        
+
         expect(logSpy).toHaveBeenCalledWith('Error destroying TS Embed', expect.any(Error));
         logSpy.mockReset();
     });
@@ -4282,25 +4230,25 @@ describe('Fullscreen change handler behavior', () => {
             liveboardId: 'test-lb',
         });
         await liveboardEmbed.render();
-        
+
         await executeAfterWait(() => {
             const iframe = getIFrameEl();
             expect(iframe).toBeTruthy();
         });
 
         mockProcessTrigger.mockResolvedValue({});
-        
+
         liveboardEmbed['setupFullscreenChangeHandler']();
-        
+
         Object.defineProperty(document, 'fullscreenElement', {
             value: null,
             writable: true,
             configurable: true,
         });
-        
+
         const event = new Event('fullscreenchange');
         document.dispatchEvent(event);
-        
+
         await executeAfterWait(() => {
             expect(mockProcessTrigger).toHaveBeenLastCalledWith(
                 expect.any(Object),
@@ -4318,7 +4266,7 @@ describe('Fullscreen change handler behavior', () => {
             liveboardId: 'test-lb-fullscreen',
         });
         await liveboardEmbed.render();
-        
+
         await executeAfterWait(() => {
             const iframe = getIFrameEl();
             expect(iframe).toBeTruthy();
@@ -4326,18 +4274,18 @@ describe('Fullscreen change handler behavior', () => {
 
         mockProcessTrigger.mockClear();
         mockProcessTrigger.mockResolvedValue({});
-        
+
         liveboardEmbed['setupFullscreenChangeHandler']();
-        
+
         Object.defineProperty(document, 'fullscreenElement', {
             value: getIFrameEl(),
             writable: true,
             configurable: true,
         });
-        
+
         const event = new Event('fullscreenchange');
         document.dispatchEvent(event);
-        
+
         await executeAfterWait(() => {
             expect(mockProcessTrigger).not.toHaveBeenCalledWith(
                 expect.any(Object),
@@ -4365,7 +4313,7 @@ describe('ShowPreRender with UpdateEmbedParams', () => {
             preRenderId,
             ...initialConfig,
         });
-        
+
         await embed1.preRender();
         await waitFor(() => !!getIFrameEl());
 

package/src/embed/ts-embed.ts

@@ -1446,7 +1446,21 @@ export class TsEmbed {
         }
 
         // send an empty object, this is needed for liveboard default handlers
-        return this.hostEventClient.triggerHostEvent(messageType, data, context);
+        return this.hostEventClient.triggerHostEvent(messageType, data, context).catch((err: Error & {
+            isValidationError?: boolean;
+            embedErrorDetails?: { errorType: ErrorDetailsTypes; message: string; code: EmbedErrorCodes; error: string };
+        }): Promise<null> => {
+            if (err?.isValidationError) {
+                const errorDetails = err.embedErrorDetails ?? {
+                    errorType: ErrorDetailsTypes.VALIDATION_ERROR,
+                    message: err.message || ERROR_MESSAGE.UPDATEFILTERS_INVALID_PAYLOAD,
+                    code: EmbedErrorCodes.UPDATEFILTERS_INVALID_PAYLOAD,
+                    error: err.message,
+                };
+                this.handleError(errorDetails);
+            }
+            throw err;
+        });
     }
 
     /**
@@ -1588,6 +1602,9 @@ export class TsEmbed {
         try {
             this.removeFullscreenChangeHandler();
             this.unsubscribeToEvents();
+            if (!this.isRendered) {
+                return;
+            }
             if (!getEmbedConfig().waitForCleanupOnDestroy) {
                 this.trigger(HostEvent.DestroyEmbed)
                 this.insertedDomEl?.parentNode?.removeChild(this.insertedDomEl);
@@ -1596,10 +1613,14 @@ export class TsEmbed {
                 Promise.race([
                     this.trigger(HostEvent.DestroyEmbed),
                     new Promise((resolve) => setTimeout(resolve, cleanupTimeout)),
-                ]).then(() => {
-                    this.insertedDomEl?.parentNode?.removeChild(this.insertedDomEl);
-                }).catch((e) => {
+                ]).catch((e) => {
                     logger.log('Error destroying TS Embed', e);
+                }).finally(() => {
+                    try {
+                        this.insertedDomEl?.parentNode?.removeChild(this.insertedDomEl);
+                    } catch (e) {
+                        logger.log('Error removing DOM element on destroy', e);
+                    }
                 });
             }
         } catch (e) {

package/src/errors.ts

@@ -4,7 +4,6 @@ export const ERROR_MESSAGE = {
     LIVEBOARD_VIZ_ID_VALIDATION: 'Please select a Liveboard to embed.',
     TRIGGER_TIMED_OUT: 'Trigger timed-out in getting a response',
     SEARCHEMBED_BETA_WRANING_MESSAGE: 'SearchEmbed is in Beta in this release.',
-    SAGE_EMBED_BETA_WARNING_MESSAGE: 'SageEmbed is in Beta in this release.',
     THIRD_PARTY_COOKIE_BLOCKED_ALERT: 'Third-party cookie access is blocked on this browser. Please allow third-party cookies for this to work properly. \nYou can use `suppressNoCookieAccessAlert` to suppress this message.',
     DUPLICATE_TOKEN_ERR: 'Duplicate token. Please issue a new token every time getAuthToken callback is called. See https://developers.thoughtspot.com/docs/?pageid=embed-auth#trusted-auth-embed for more details.',
     SDK_NOT_INITIALIZED: 'SDK not initialized',
@@ -30,6 +29,8 @@ export const ERROR_MESSAGE = {
     SSR_ENVIRONMENT_ERROR: 'SSR environment detected. This function cannot be called in SSR environment.',
     UPDATE_PARAMS_FAILED: 'Failed to update embed parameters',
     INVALID_SPOTTER_DOCUMENTATION_URL: 'Invalid spotterDocumentationUrl. Please provide a valid http or https URL.',
+    UPDATEFILTERS_INVALID_PAYLOAD: 'UpdateFilters requires a valid filter or filters array. Expected: { filter: { column, oper, values } } or { filters: [{ column, oper, values }, ...] }',
+    DRILLDOWN_INVALID_PAYLOAD: 'DrillDown requires a valid points object. Expected: { points: { clickedPoint?, selectedPoints? }, autoDrillDown?, vizId? }',
 };
 
 export const CUSTOM_ACTIONS_ERROR_MESSAGE = {

package/src/index.ts

@@ -67,13 +67,12 @@ import {
     CustomActionTarget,
     InterceptedApiType,
     EmbedErrorCodes,
-    EmbedErrorDetailsEvent, 
+    EmbedErrorDetailsEvent,
     ErrorDetailsTypes,
     ContextType,
     AutoMCPFrameRendererViewConfig,
 } from './types';
 import { CustomCssVariables } from './css-variables';
-import { SageEmbed, SageViewConfig } from './embed/sage';
 import { AnswerService, SessionInterface, UnderlyingDataPoint } from './utils/graphql/answerService/answerService';
 import { getEmbedConfig } from './embed/embedConfig';
 import { uploadMixpanelEvent, MIXPANEL_EVENT } from './mixpanel-service';
@@ -100,7 +99,6 @@ export {
     SearchBarEmbed,
     PinboardEmbed,
     LiveboardEmbed,
-    SageEmbed,
     AppEmbed,
     SpotterAgentEmbed,
     SpotterAgentEmbedViewConfig,
@@ -134,7 +132,6 @@ export {
     SearchViewConfig,
     SearchBarViewConfig,
     LiveboardViewConfig,
-    SageViewConfig,
     AppViewConfig,
     PrefetchFeatures,
     FrameParams,
@@ -171,4 +168,4 @@ export {
 };
 
 export { resetCachedAuthToken } from './authToken';
-export { startAutoMCPFrameRenderer } from './embed/auto-frame-renderer';
+export { startAutoMCPFrameRenderer } from './embed/auto-frame-renderer';

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

@@ -7,8 +7,6 @@ export {
     PreRenderedSearchBarEmbed,
     AppEmbed,
     PreRenderedAppEmbed,
-    SageEmbed,
-    PreRenderedSageEmbed,
     SpotterEmbed,
     ConversationEmbed,
     PreRenderedConversationEmbed,
@@ -44,7 +42,6 @@ export {
     SearchViewConfig,
     SearchBarViewConfig,
     LiveboardViewConfig,
-    SageViewConfig,
     AppViewConfig,
     PrefetchFeatures,
     FrameParams,

package/src/react/index.tsx

@@ -5,7 +5,6 @@ import useDeepCompareEffect from 'use-deep-compare-effect';
 import { AuthEventEmitter } from '../auth';
 import { deepMerge } from '../utils';
 import { SearchBarEmbed as _SearchBarEmbed, SearchBarViewConfig } from '../embed/search-bar';
-import { SageEmbed as _SageEmbed, SageViewConfig } from '../embed/sage';
 import { SearchEmbed as _SearchEmbed, SearchViewConfig } from '../embed/search';
 import { AppEmbed as _AppEmbed, AppViewConfig } from '../embed/app';
 import { LiveboardEmbed as _LiveboardEmbed, LiveboardViewConfig } from '../embed/liveboard';
@@ -299,48 +298,6 @@ export const PreRenderedSearchBarEmbed = componentFactory<
     SearchBarViewConfig
 >(_SearchBarEmbed, true);
 
-interface SageEmbedProps extends EmbedProps, SageViewConfig { }
-
-/**
- * React component for LLM based search Sage embed.
- * @example
- * ```tsx
- * function Sage() {
- *  return <SageEmbed
- *      showObjectResults={true}
- *      ... other view config props or event listeners.
- *  />
- * }
- * ```
- */
-export const SageEmbed = componentFactory<typeof _SageEmbed, SageEmbedProps, SageViewConfig>(
-    _SageEmbed,
-);
-
-/**
- * React component for PreRendered Sage embed.
- *
- * PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
- * default.
- *
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
- * @example
- * ```tsx
- * function LandingPageComponent() {
- *  return <PreRenderedSageEmbed preRenderId="someId" showObjectResults={true} />
- * }
- * ```
- * function MyComponent() {
- *  return <SageEmbed preRenderId="someId" showObjectResults={true} />
- * }
- * ```
- */
-export const PreRenderedSageEmbed = componentFactory<
-    typeof _SageEmbed,
-    SageEmbedProps & PreRenderProps,
-    SageViewConfig
->(_SageEmbed, true);
-
 interface SpotterEmbedProps extends EmbedProps, SpotterEmbedViewConfig { }
 interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig { }
 
@@ -409,24 +366,24 @@ type SpotterMessageProps = {
 
 /**
  * React component for displaying individual conversation messages from SpotterAgent.
- * 
+ *
  * This component renders a single message response from your ThoughtSpot conversation,
  * showing charts, visualizations, or text responses based on the user's query.
- * 
+ *
  * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
  * @example
  * ```tsx
  * const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
  * const result = await sendMessage('show me sales by region');
- * 
+ *
  * if (!result.error) {
  *   // Simple usage - just pass the message data
  *   <SpotterMessage message={result.message} />
- *   
+ *
  *   // With optional query for context
- *   <SpotterMessage 
- *     message={result.message} 
- *     query={result.query} 
+ *   <SpotterMessage
+ *     message={result.message}
+ *     query={result.query}
  *   />
  * }
  * ```
@@ -436,7 +393,7 @@ export const SpotterMessage = React.forwardRef<
     SpotterMessageProps
 >((props, ref) => {
     const { message, query: _, ...otherProps } = props;
-    
+
     return (
         <ConversationMessage
             ref={ref}
@@ -475,7 +432,6 @@ type EmbedComponent = typeof SearchEmbed
     | typeof AppEmbed
     | typeof LiveboardEmbed
     | typeof SearchBarEmbed
-    | typeof SageEmbed
     | typeof ConversationMessage
     | typeof SpotterMessage
     | typeof SpotterEmbed
@@ -527,20 +483,20 @@ export function useInit(config: EmbedConfig) {
 
 /**
  * React hook for interacting with SpotterAgent AI conversations.
- * 
+ *
  * This hook provides a sendMessage function that allows you to send natural language
  * queries to your data and get back AI-generated responses with visualizations.
- * 
+ *
  * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
  * @param config - Configuration object containing worksheetId and other options
  * @returns Object with sendMessage function that returns conversation results
  * @example
  * ```tsx
  * const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
- * 
+ *
  * const handleQuery = async () => {
  *   const result = await sendMessage('show me sales by region');
- *   
+ *
  *   if (!result.error) {
  *     // Display the message response
  *     <SpotterMessage message={result.message} />
@@ -552,14 +508,14 @@ export function useInit(config: EmbedConfig) {
  */
 export function useSpotterAgent(config: SpotterAgentEmbedViewConfig) {
     const serviceRef = useRef<_SpotterAgentEmbed | null>(null);
-    
+
     useDeepCompareEffect(() => {
         if (serviceRef.current) {
             serviceRef.current = null;
         }
-        
+
         serviceRef.current = new _SpotterAgentEmbed(config);
-        
+
         return () => {
             serviceRef.current = null;
         };