@thoughtspot/visual-embed-sdk 1.42.2 → 1.43.0

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

@@ -2428,50 +2428,6 @@ describe('Unit test case for ts embed', () => {
         });
     });
 
-    describe('When destroyed', () => {
-        it('should remove the iframe', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                frameParams: {
-                    width: '100%',
-                    height: '100%',
-                },
-            });
-            await appEmbed.render();
-            expect(getIFrameEl()).toBeTruthy();
-            appEmbed.destroy();
-            expect(getIFrameEl()).toBeFalsy();
-        });
-
-        it('should remove the iframe when insertAsSibling is true', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                frameParams: {
-                    width: '100%',
-                    height: '100%',
-                },
-                insertAsSibling: true,
-            });
-            await appEmbed.render();
-            expect(getIFrameEl()).toBeTruthy();
-            appEmbed.destroy();
-            expect(getIFrameEl()).toBeFalsy();
-        });
-
-        it("Should remove the error message on destroy if it's present", async () => {
-            jest.spyOn(baseInstance, 'getAuthPromise').mockResolvedValueOnce(false);
-            const appEmbed = new AppEmbed(getRootEl(), {
-                frameParams: {
-                    width: '100%',
-                    height: '100%',
-                },
-                insertAsSibling: true,
-            });
-            await appEmbed.render();
-            expect(getRootEl().nextElementSibling.innerHTML).toContain('Not logged in');
-            appEmbed.destroy();
-            expect(getRootEl().nextElementSibling.innerHTML).toBe('');
-        });
-    });
-
     describe('validate getThoughtSpotPostUrlParams', () => {
         const { location } = window;
 
@@ -3456,4 +3412,172 @@ describe('Unit test case for ts embed', () => {
             triggerSpy.mockReset();
         });
     });
+
+    describe('When destroyed', () => {
+        it('should remove the iframe', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+            });
+            await appEmbed.render();
+            expect(getIFrameEl()).toBeTruthy();
+            appEmbed.destroy();
+            expect(getIFrameEl()).toBeFalsy();
+        });
+
+        it('should remove the iframe when insertAsSibling is true', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+                insertAsSibling: true,
+            });
+            await appEmbed.render();
+            expect(getIFrameEl()).toBeTruthy();
+            appEmbed.destroy();
+            expect(getIFrameEl()).toBeFalsy();
+        });
+
+        it("Should remove the error message on destroy if it's present", async () => {
+            jest.spyOn(baseInstance, 'getAuthPromise').mockResolvedValueOnce(false);
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+                insertAsSibling: true,
+            });
+            await appEmbed.render();
+            expect(getRootEl().nextElementSibling.innerHTML).toContain('Not logged in');
+            appEmbed.destroy();
+            expect(getRootEl().nextElementSibling.innerHTML).toBe('');
+        });
+
+        describe('with waitForCleanupOnDestroy configuration', () => {
+            let originalEmbedConfig: any;
+
+            beforeEach(() => {
+                originalEmbedConfig = embedConfig.getEmbedConfig();
+            });
+
+            afterEach(() => {
+                embedConfig.setEmbedConfig(originalEmbedConfig);
+            });
+
+            it('should trigger DestroyEmbed event immediately when waitForCleanupOnDestroy is false', async () => {
+                embedConfig.setEmbedConfig({
+                    ...originalEmbedConfig,
+                    waitForCleanupOnDestroy: false,
+                });
+
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+
+                const triggerSpy = jest.spyOn(appEmbed, 'trigger').mockResolvedValue(null);
+                const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+                appEmbed.destroy();
+
+                expect(triggerSpy).toHaveBeenCalledWith(HostEvent.DestroyEmbed);
+                expect(removeChildSpy).toHaveBeenCalled();
+            });
+
+            it('should trigger DestroyEmbed event and wait for cleanup when waitForCleanupOnDestroy is true', async () => {
+                embedConfig.setEmbedConfig({
+                    ...originalEmbedConfig,
+                    waitForCleanupOnDestroy: true,
+                    cleanupTimeout: 1000,
+                });
+
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+
+                const triggerSpy = jest.spyOn(appEmbed, 'trigger').mockResolvedValue(null);
+                const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+                appEmbed.destroy();
+
+                // Should be called immediately when waitForCleanupOnDestroy is true
+                expect(triggerSpy).toHaveBeenCalledWith(HostEvent.DestroyEmbed);
+                
+                // Wait for the timeout to complete
+                await new Promise(resolve => setTimeout(resolve, 1100));
+
+                expect(removeChildSpy).toHaveBeenCalled();
+            });
+
+            it('should handle Promise.race with successful cleanup completion', async () => {
+                embedConfig.setEmbedConfig({
+                    ...originalEmbedConfig,
+                    waitForCleanupOnDestroy: true,
+                    cleanupTimeout: 2000,
+                });
+
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+
+                // Mock trigger to resolve quickly (before timeout)
+                const triggerSpy = jest.spyOn(appEmbed, 'trigger').mockImplementation(() => 
+                    new Promise(resolve => setTimeout(() => resolve(null), 100))
+                );
+                const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+                appEmbed.destroy();
+
+                // Wait for the trigger to complete
+                await new Promise(resolve => setTimeout(resolve, 200));
+
+                expect(triggerSpy).toHaveBeenCalledWith(HostEvent.DestroyEmbed);
+                expect(removeChildSpy).toHaveBeenCalled();
+            });
+
+            it('should handle Promise.race with timeout when cleanup takes too long', async () => {
+                embedConfig.setEmbedConfig({
+                    ...originalEmbedConfig,
+                    waitForCleanupOnDestroy: true,
+                    cleanupTimeout: 100,
+                });
+
+                const appEmbed = new AppEmbed(getRootEl(), {
+                    frameParams: {
+                        width: '100%',
+                        height: '100%',
+                    },
+                });
+                await appEmbed.render();
+
+                // Mock trigger to take longer than timeout
+                const triggerSpy = jest.spyOn(appEmbed, 'trigger').mockImplementation(() => 
+                    new Promise(resolve => setTimeout(() => resolve(null), 500))
+                );
+                const removeChildSpy = jest.spyOn(Node.prototype, 'removeChild').mockImplementation(() => getRootEl());
+
+                appEmbed.destroy();
+
+                // Wait for the timeout to complete
+                await new Promise(resolve => setTimeout(resolve, 200));
+
+                expect(triggerSpy).toHaveBeenCalledWith(HostEvent.DestroyEmbed);
+                expect(removeChildSpy).toHaveBeenCalled();
+            });
+        });
+    });
 });

package/src/embed/ts-embed.ts

@@ -1396,8 +1396,21 @@ export class TsEmbed {
     public destroy(): void {
         try {
             this.removeFullscreenChangeHandler();
-            this.insertedDomEl?.parentNode.removeChild(this.insertedDomEl);
             this.unsubscribeToEvents();
+            if (!getEmbedConfig().waitForCleanupOnDestroy) {
+                this.trigger(HostEvent.DestroyEmbed)
+                this.insertedDomEl?.parentNode?.removeChild(this.insertedDomEl);
+            } else {
+                const cleanupTimeout = getEmbedConfig().cleanupTimeout;
+                Promise.race([
+                    this.trigger(HostEvent.DestroyEmbed),
+                    new Promise((resolve) => setTimeout(resolve, cleanupTimeout)),
+                ]).then(() => {
+                    this.insertedDomEl?.parentNode?.removeChild(this.insertedDomEl);
+                }).catch((e) => {
+                    logger.log('Error destroying TS Embed', e);
+                });
+            }
         } catch (e) {
             logger.log('Error destroying TS Embed', e);
         }

package/src/types.ts

@@ -692,6 +692,19 @@ export interface EmbedConfig {
      * ```
      */
     customActions?: CustomAction[];
+
+    /**
+     * Wait for the cleanup to be completed before destroying the embed.
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     * @default false
+     */
+    waitForCleanupOnDestroy?: boolean;
+    /**
+     * The timeout for the cleanup to be completed before destroying the embed.
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     * @default 5000
+     */
+    cleanupTimeout?: number;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
@@ -1868,7 +1881,7 @@ export enum EmbedEvent {
      */
     Load = 'load',
     /**
-     * Data pertaining to an Answer or Liveboard is received.
+     * Data pertaining to an Answer, Liveboard or Spotter visualization is received.
      * The event payload includes the raw data of the object.
      * @return data -  Answer of Liveboard data
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
@@ -2289,6 +2302,17 @@ export enum EmbedEvent {
      *```
      */
     AnswerDelete = 'answerDelete',
+    /**
+     * Emitted when the AI Highlights action is triggered on a Liveboard
+     * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
+     * @example
+     *```js
+     * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
+     *   console.log('AI Highlights', payload);
+     * })
+     *```
+     */
+    AIHighlights = 'AIHighlights',
     /**
      * Emitted when a user initiates the Pin action to
      *  add an Answer to a Liveboard.
@@ -3240,7 +3264,7 @@ export enum HostEvent {
      * the following parameters:
      *
      * @param
-     * `vizId`-  GUID of the saved Answer or visualization to pin to a Liveboard.
+     * `vizId`-  GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
      *  Optional when pinning a new chart or table generated from a Search query.
      *  **Required** in Spotter Embed.
      * @param
@@ -3292,10 +3316,16 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const pinResponse = await spotterEmbed.trigger(HostEvent.Pin, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
+    * ```
+     * 
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     Pin = 'pin',
@@ -3370,14 +3400,29 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
+    * ```
      * 
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     DownloadAsPdf = 'downloadAsPdf',
+    /**
+     * Trigger the **AI Highlights** action on an embedded Liveboard
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.AIHighlights)
+     * ```
+     * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
+     */
+    AIHighlights = 'AIHighlights',
     /**
      * Trigger the **Make a copy** action on a Liveboard,
      * visualization, or Answer page.
@@ -3400,10 +3445,14 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
+    * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     MakeACopy = 'makeACopy',
@@ -3488,15 +3537,7 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
-     * @example
-     * ```js
-     * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
+     * spotterEmbed.trigger(HostEvent.Edit);
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
@@ -3545,16 +3586,23 @@ export enum HostEvent {
      *   );
      * })
      * ```
-     * @example
+     * * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.GetTML, {
-     *   vizId: '730496d6-6903-4601-937e-2c691821af3c'
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.GetTML, {
+     *   vizId: latestSpotterVizId
      * }).then((tml) => {
      *   console.log(
      *      tml.answer.search_query // TML representation of the search query
      *   );
      * })
-     * ```
+    * ```
      * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
      * @important
      */
@@ -3618,7 +3666,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** action on charts in
      * the embedded view.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -3628,10 +3676,14 @@ export enum HostEvent {
      * embed.trigger(HostEvent.Download)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.Download, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
+    * ```
      * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
      * Use {@link DownloadAsPng}
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -3649,9 +3701,13 @@ export enum HostEvent {
      *
      * searchEmbed.trigger(HostEvent.DownloadAsPng)
      * 
-     * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
      * ```
      * 
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
@@ -3660,7 +3716,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** > **CSV**  action on tables in
      * the embedded view.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -3673,9 +3729,13 @@ export enum HostEvent {
      * searchEmbed.trigger(HostEvent.DownloadAsCsv)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
@@ -3683,7 +3743,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** > **XLSX**  action on tables
      * in the embedded view.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -3696,9 +3756,13 @@ export enum HostEvent {
      * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
@@ -3735,7 +3799,7 @@ export enum HostEvent {
    * ```
    *
    * ```js
-   * // Save an Answer in Spotter (requires vizId)
+   * // Save a Visualization in Spotter (requires vizId)
    * spotterEmbed.trigger(HostEvent.Save, {
    *   vizId: "730496d6-6903-4601-937e-2c691821af3c"
    * })
@@ -4036,15 +4100,21 @@ export enum HostEvent {
     ResetLiveboardPersonalisedView = 'ResetLiveboardPersonalisedView',
     /**
      * Triggers an action to update Parameter values on embedded
-     * Answers, Liveboard and Spotter answer in Edit mode.
+     * Answers, Liveboard, and Spotter answer in Edit mode.
+     * @param - `name` - Name of the Parameter
+     * @param - `value` - The value to set for the Parameter.
+     *
+     * Optionally, to control the visibility of the Parameter chip,
+     * use the `isVisibleToUser` attribute when applying an override.
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
-     * name: "Color",
-     * value: "almond"
+     *   name: "Integer Range Param",
+     *   value: 10,
+     *   isVisibleToUser: false
      * }])
-     *
+     * ```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
     UpdateParameters = 'UpdateParameters',
@@ -4057,11 +4127,13 @@ export enum HostEvent {
      * });
      *```
      *```js
-     * spotterEmbed.trigger(HostEvent.GetParameters, {
-     *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
-     * }).then((parameter) => {
-     *  console.log('parameters', parameter);
-     * });
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
      *```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
@@ -4091,10 +4163,11 @@ export enum HostEvent {
      * If no parameters are specified, the save action is
      * triggered with a modal to prompt users to
      * add a name and description for the Answer.
-     * @param - optional attributes to set Answer properties.
-     *  `name` - Name string for the Answer.
-     *  `description` - Description text for the Answer.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - `vizId` refers to the Answer ID in Spotter embed
+     * and is required in Spotter embed.
+     * Optional attributes to set Answer properties include:
+     * @param - `name` - Name string for the Answer.
+     * @param - `description` - Description text for the Answer.
      * @example
      * ```js
      * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -4104,11 +4177,13 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
-     *      vizId: '730496d6-6903-4601-937e-2c691821af3c',
-     *      name: "Sales by states",
-     *      description: "Total sales by states in MidWest"
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
      * });
+    *
+    * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
@@ -4192,12 +4267,15 @@ export enum HostEvent {
     DeleteLastPrompt = 'DeleteLastPrompt',
     /**
      * Toggle the visualization to chart or table view.
-     * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
+     * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
-     *          vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
      * });
+    *
+    * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
      *```
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
@@ -4226,12 +4304,16 @@ export enum HostEvent {
      */
     VisibleEmbedCoordinates = 'visibleEmbedCoordinates',
     /**
-     * Trigger the *Ask Spotter* action for visualizations
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * Trigger the *Spotter* action for visualizations present on the liveboard's vizzes.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required.
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.AskSpotter,
-     * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+    *
+    * spotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
@@ -4247,6 +4329,15 @@ export enum HostEvent {
      * ```
      */
     UpdateEmbedParams = 'updateEmbedParams',
+    /**
+     * Triggered when the embed is needed to be destroyed. This is used to clean up any embed related resources internally.
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.DestroyEmbed);
+     * ```
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     */
+    DestroyEmbed = 'EmbedDestroyed',
 }
 
 /**