@thoughtspot/visual-embed-sdk 1.46.5 → 1.47.0

package/src/embed/hostEventClient/utils.spec.ts

@@ -10,6 +10,10 @@ import { EmbedEvent } from '../../types';
 import { embedEventStatus } from '../../utils';
 
 describe('hostEventClient utils', () => {
+
+    // =========================
+    // UpdateFilters Validation
+    // =========================
     describe('isValidUpdateFiltersPayload', () => {
         it('returns false for undefined', () => {
             expect(isValidUpdateFiltersPayload(undefined)).toBe(false);
@@ -19,12 +23,24 @@ describe('hostEventClient utils', () => {
             expect(isValidUpdateFiltersPayload({})).toBe(false);
         });
 
-        it('returns true for valid filter', () => {
+        it('returns true for valid filter with column', () => {
             expect(isValidUpdateFiltersPayload({
                 filter: { column: 'region', oper: 'EQ', values: ['North'] },
             } as any)).toBe(true);
         });
 
+        it('returns true for valid filter with columnName', () => {
+            expect(isValidUpdateFiltersPayload({
+                filter: { columnName: 'region', oper: 'EQ', values: ['North'] },
+            } as any)).toBe(true);
+        });
+
+        it('returns true for filter with operator instead of oper', () => {
+            expect(isValidUpdateFiltersPayload({
+                filter: { column: 'region', operator: 'EQ', values: ['North'] },
+            } as any)).toBe(true);
+        });
+
         it('returns true for valid filters array', () => {
             expect(isValidUpdateFiltersPayload({
                 filters: [
@@ -34,13 +50,31 @@ describe('hostEventClient utils', () => {
             } as any)).toBe(true);
         });
 
-        it('returns false for filter with missing column', () => {
+        it('returns true for valid filters array with columnName', () => {
+            expect(isValidUpdateFiltersPayload({
+                filters: [
+                    { columnName: 'x', oper: 'IN', values: ['a', 'b'] },
+                    { columnName: 'y', oper: 'EQ', values: ['c'] },
+                ],
+            } as any)).toBe(true);
+        });
+
+        it('returns false if one filter in filters array is invalid', () => {
+            expect(isValidUpdateFiltersPayload({
+                filters: [
+                    { column: 'x', oper: 'EQ', values: ['a'] },
+                    { column: 'y', values: ['b'] }, // invalid
+                ],
+            } as any)).toBe(false);
+        });
+
+        it('returns false for filter with missing column/columnName', () => {
             expect(isValidUpdateFiltersPayload({
                 filter: { oper: 'EQ', values: ['a'] },
             } as any)).toBe(false);
         });
 
-        it('returns false for filter with missing oper', () => {
+        it('returns false for filter with missing operator', () => {
             expect(isValidUpdateFiltersPayload({
                 filter: { column: 'x', values: ['a'] },
             } as any)).toBe(false);
@@ -52,11 +86,39 @@ describe('hostEventClient utils', () => {
             } as any)).toBe(false);
         });
 
+        it('returns false for filter with non-string type', () => {
+            expect(isValidUpdateFiltersPayload({
+                filter: { column: 'x', oper: 'EQ', values: ['a'], type: 123 },
+            } as any)).toBe(false);
+        });
+
+        it('returns true for filter with valid string type', () => {
+            expect(isValidUpdateFiltersPayload({
+                filter: { column: 'x', oper: 'EQ', values: ['a'], type: 'STRING' },
+            } as any)).toBe(true);
+        });
+
         it('returns false for empty filters array', () => {
             expect(isValidUpdateFiltersPayload({ filters: [] } as any)).toBe(false);
         });
+
+        it('returns false if filters is not an array', () => {
+            expect(isValidUpdateFiltersPayload({
+                filters: 'invalid',
+            } as any)).toBe(false);
+        });
+
+        it('returns true if filter is valid even when filters is invalid', () => {
+            expect(isValidUpdateFiltersPayload({
+                filter: { column: 'x', oper: 'EQ', values: ['a'] },
+                filters: [{ column: 'y' }], // invalid
+            } as any)).toBe(true);
+        });
     });
 
+    // =========================
+    // DrillDown Validation
+    // =========================
     describe('isValidDrillDownPayload', () => {
         it('returns false for undefined', () => {
             expect(isValidDrillDownPayload(undefined)).toBe(false);
@@ -66,7 +128,7 @@ describe('hostEventClient utils', () => {
             expect(isValidDrillDownPayload({})).toBe(false);
         });
 
-        it('returns false for empty points', () => {
+        it('returns false for empty points object', () => {
             expect(isValidDrillDownPayload({ points: {} } as any)).toBe(false);
         });
 
@@ -97,16 +159,42 @@ describe('hostEventClient utils', () => {
                 points: { selectedPoints: [] },
             } as any)).toBe(false);
         });
+
+        it('returns false if clickedPoint is null', () => {
+            expect(isValidDrillDownPayload({
+                points: { clickedPoint: null },
+            } as any)).toBe(false);
+        });
+
+        it('returns false if selectedPoints is not an array', () => {
+            expect(isValidDrillDownPayload({
+                points: { selectedPoints: 'invalid' },
+            } as any)).toBe(false);
+        });
+
+        it('returns false if both clickedPoint and selectedPoints are invalid', () => {
+            expect(isValidDrillDownPayload({
+                points: { clickedPoint: null, selectedPoints: [] },
+            } as any)).toBe(false);
+        });
     });
 
+    // =========================
+    // Error Handling
+    // =========================
     describe('createValidationError', () => {
-        it('throws with message and embedErrorDetails', () => {
+        it('throws with message', () => {
             expect(() => createValidationError('test error')).toThrow('test error');
+        });
 
+        it('throws Error instance with metadata', () => {
             try {
                 createValidationError('custom msg');
             } catch (err: any) {
+                expect(err).toBeInstanceOf(Error);
                 expect(err.isValidationError).toBe(true);
+                expect(err.embedErrorDetails).toBeDefined();
+
                 expect(err.embedErrorDetails).toMatchObject({
                     type: EmbedEvent.Error,
                     data: {
@@ -134,4 +222,4 @@ describe('hostEventClient utils', () => {
                 .toThrow(ERROR_MESSAGE.DRILLDOWN_INVALID_PAYLOAD);
         });
     });
-});
+});

package/src/embed/hostEventClient/utils.ts

@@ -8,8 +8,21 @@ export function isValidUpdateFiltersPayload(
 ): boolean {
   if (!payload) return false;
 
-  const isValidFilter = (f: { column?: string; oper?: string; values?: unknown[] }) =>
-    !!f && typeof f.column === 'string' && typeof f.oper === 'string' && Array.isArray(f.values);
+  const isValidFilter = (f: { 
+    column?: string; 
+    oper?: string; 
+    values?: unknown[]; 
+    type?: string; 
+    columnName?: string; 
+    operator?: string 
+  }) => {
+    const hasColumn = typeof f.column === 'string' || typeof f.columnName === 'string';
+    const hasOperator = typeof f.oper === 'string' || typeof f.operator === 'string';
+    const hasValues = Array.isArray(f.values);
+    const validType = !f.type || typeof f.type === 'string';
+  
+    return hasColumn && hasOperator && hasValues && validType;
+  };
 
   const hasValidFilter = payload.filter && isValidFilter(payload.filter);
   const hasValidFilters = Array.isArray(payload.filters) && payload.filters.length > 0 && payload.filters.every(isValidFilter);

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

@@ -1602,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);
@@ -1610,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',

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,