SCAL-255929 - Added cleanup event on destroy

Author: jbhanu-thoughtspot

src/embed/base.ts

@@ -41,6 +41,8 @@ const CONFIG_DEFAULTS: Partial<EmbedConfig> = {
     authTriggerText: 'Authorize',
     authType: AuthType.None,
     logLevel: LogLevel.ERROR,
+    waitForCleanupOnDestroy: false,
+    cleanupTimeout: 5000,
 };
 
 export interface executeTMLInput {

src/embed/ts-embed.ts

@@ -1328,8 +1328,20 @@ 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;
+                setTimeout(() => {
+                    this.trigger(HostEvent.DestroyEmbed).then(() => {
+                        this.insertedDomEl?.parentNode?.removeChild(this.insertedDomEl);
+                    }).catch((e) => {
+                        logger.log('Error destroying TS Embed', e);
+                    });
+                }, cleanupTimeout);
+            }
         } catch (e) {
             logger.log('Error destroying TS Embed', e);
         }

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 10000
+     */
+    cleanupTimeout?: number;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
@@ -4169,6 +4182,16 @@ export enum HostEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     AskSpotter = 'AskSpotter',
+
+    /**
+     * 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',
 }
 
 /**