@thoughtspot/visual-embed-sdk 1.52.2-beta → 1.52.2-beta.0

package/cjs/src/embed/ts-embed.js

@@ -43,6 +43,9 @@ const TS_EMBED_ID = '_thoughtspot-embed';
  */
 const PRERENDER_CONTAINER_ORIGINAL_POSITION_KEY = 'tsEmbedOriginalPosition';
 const PRERENDER_WRAPPER_ID_PREFIX = 'tsEmbed-pre-render-wrapper-';
+const PRERENDER_PARKED_TRANSFORM = 'translateY(-100%)';
+/** The height createPreRenderWrapper() seeds before anything is measured. */
+const UNMEASURED_WRAPPER_HEIGHT = '100vh';
 // The container applies UpdateEmbedParams through React state, so a delivered
 // post is not the same as the params being in effect.
 const UPDATE_EMBED_PARAMS_SETTLE_MS = 200;
@@ -50,56 +53,6 @@ const UPDATE_EMBED_PARAMS_SETTLE_MS = 200;
 // truthy, so null or '' leaves the previous embed's values in place. '&' is
 // truthy and parses to {}.
 const NO_RUNTIME_PARAMS = '&';
-/**
- * Query parameters that stay on the iframe `src` while config is excluded from
- * the URL, which is the default unless the embed sets the
- * `excludeConfigFromURL` additional flag to `false`. These are the parameters the
- * application shell needs before it can receive a postMessage at all: the
- * embed marker, the host application URL used to validate the message origin,
- * the SDK version, the flags that pick the authentication flow, and the
- * boot-time settings that would otherwise be applied a frame late (viewport,
- * log level, locale, formatting and org). Everything else is delivered over
- * `HostEvent.UpdateEmbedParams`.
- * @internal
- */
-const BOOTSTRAP_URL_PARAMS = new Set([
-    types_1.Param.EmbedApp,
-    types_1.Param.HostAppUrl,
-    types_1.Param.Version,
-    types_1.Param.AuthType,
-    types_1.Param.AutoLogin,
-    types_1.Param.DisableLoginRedirect,
-    types_1.Param.ForceSAMLAutoRedirect,
-    types_1.Param.cookieless,
-    types_1.Param.preAuthCache,
-    types_1.Param.blockNonEmbedFullAppAccess,
-    types_1.Param.OverrideOrgId,
-    types_1.Param.ViewPortHeight,
-    types_1.Param.ViewPortWidth,
-    types_1.Param.ClientLogLevel,
-    types_1.Param.OverrideNativeConsole,
-    types_1.Param.PendoTrackingKey,
-    types_1.Param.NumberFormatLocale,
-    types_1.Param.DateFormatLocale,
-    types_1.Param.CurrencyFormat,
-    types_1.Param.Locale,
-    types_1.Param.searchEmbed,
-    types_1.Param.livedBoardEmbed,
-    types_1.Param.isSpotterAgentEmbed,
-    types_1.Param.SpotterEnabled,
-    types_1.Param.IsFullAppEmbed,
-    types_1.Param.IsOnBeforeGetVizDataInterceptEnabled,
-    types_1.Param.LinkOverride,
-    types_1.Param.EnableLinkOverridesV2,
-    types_1.Param.DisableRedirectionLinksInNewTab,
-    types_1.Param.OverrideHistoryState,
-    types_1.Param.ForceTable,
-    types_1.Param.StringIDsUrl,
-    types_1.Param.DataSources,
-    types_1.Param.ExposeTranslationIDs,
-    types_1.Param.IconSpriteUrl,
-    types_1.Param.Tag,
-]);
 /**
  * The event id map from v2 event names to v1 event id
  * v1 events are the classic embed events implemented in Blink v1
@@ -137,7 +90,6 @@ class TsEmbed {
         this.shouldEncodeUrlQueryParams = false;
         this.defaultHiddenActions = [types_1.Action.ReportError];
         this.preRenderContainerEl = document.body;
-        this.containerScrollListener = null;
         /**
          * Handler for fullscreen change events
          */
@@ -302,9 +254,6 @@ class TsEmbed {
             }
             else if (source === types_1.EmbedEvent.EmbedListenerReady) {
                 processEmbedContainerReady();
-                if (this.isConfigExcludedFromUrl()) {
-                    this.triggerUpdateEmbedParams();
-                }
             }
         };
         // Subclasses that navigate the pre-render on show must await this before
@@ -809,20 +758,13 @@ class TsEmbed {
         return path;
     }
     getEmbedParams() {
-        const queryParams = this.getUrlQueryParamsObject();
+        const queryParams = this.getEmbedParamsObject();
         return (0, utils_1.getQueryParamString)(queryParams);
     }
     getEmbedParamsObject() {
         const params = this.getBaseQueryParams();
         return params;
     }
-    getUrlQueryParamsObject() {
-        const queryParams = this.getEmbedParamsObject();
-        if (!this.isConfigExcludedFromUrl()) {
-            return queryParams;
-        }
-        return Object.fromEntries(Object.entries(queryParams).filter(([key]) => BOOTSTRAP_URL_PARAMS.has(key)));
-    }
     getRootIframeSrc() {
         const query = this.getEmbedParams();
         return this.getEmbedBasePath(query);
@@ -995,7 +937,7 @@ class TsEmbed {
             top: '0',
             left: '0',
             width: '100vw',
-            height: '100vh',
+            height: UNMEASURED_WRAPPER_HEIGHT,
         };
         (0, utils_1.setStyleProperties)(preRenderWrapper, initialPreRenderWrapperStyle);
         return preRenderWrapper;
@@ -1063,10 +1005,26 @@ class TsEmbed {
         return placeholder;
     }
     /**
-     * Resolves the configured preRenderContainer to a live element, falling
-     * back to `document.body`. A string selector is re-queried on every call so
-     * a remounted container (E.g.: React replacing the node) resolves to the
-     * fresh element; an element passed directly cannot be re-resolved.
+     * Resolves the configured preRenderContainer to a live element. A string
+     * selector is re-queried on every call so a remounted container (E.g.: React
+     * replacing the node) resolves to the fresh element; an element passed
+     * directly cannot be re-resolved.
+     *
+     * With nothing configured the frame goes into the host element's nearest
+     * scrolling ancestor, falling back to `document.body`.
+     *
+     * The wrapper is absolutely positioned, so it follows the page for free —
+     * but only while it sits inside whatever scrolls. `document.body` is right
+     * only when the document itself is the scroller; an app that scrolls an
+     * inner element instead left the frame pinned to the viewport while the page
+     * moved under it (SCAL-338563). Being inside the scroller also lets wheel
+     * events chain out of the frame into it, which they cannot do from
+     * `document.body`.
+     *
+     * A scrolling ancestor is layout chrome rather than route content, so it
+     * outlives the embed in practice; and if it does go, the host element goes
+     * with it and this instance is remounting anyway.
+     * `reconcilePreRenderContainer` re-runs this on a detached container.
      */
     resolvePreRenderContainerTarget() {
         var _a;
@@ -1086,7 +1044,13 @@ class TsEmbed {
         else if (containerConfig) {
             container = containerConfig;
         }
-        return (_a = container) !== null && _a !== void 0 ? _a : document.body;
+        if (container) {
+            return container;
+        }
+        if (!this.hostElement) {
+            return document.body;
+        }
+        return (_a = (0, utils_1.getScrollableAncestors)(this.hostElement)[0]) !== null && _a !== void 0 ? _a : document.body;
     }
     inheritPreRenderContainer() {
         var _a;
@@ -1131,8 +1095,9 @@ class TsEmbed {
      * Re-attaches the wrapper to a live container when the previously resolved
      * one has been detached or no longer holds the wrapper — e.g. the host app
      * remounted a custom preRenderContainer, which would otherwise leave a stale
-     * reference and collapse the wrapper. Only string selectors can be
-     * re-resolved; a container passed as an element is left untouched.
+     * reference and collapse the wrapper. Selectors and the auto-resolved
+     * scrolling ancestor are both re-resolved; a container passed as an element
+     * is left untouched, as there is nothing to re-query.
      */
     reconcilePreRenderContainer() {
         const wrapper = this.preRenderWrapper;
@@ -1151,14 +1116,6 @@ class TsEmbed {
         if (resolved === stored && stored.contains(wrapper)) {
             return;
         }
-        if (this.containerScrollListener && stored !== resolved) {
-            if (stored !== document.body) {
-                stored.removeEventListener('scroll', this.containerScrollListener);
-            }
-            if (resolved !== document.body) {
-                resolved.addEventListener('scroll', this.containerScrollListener);
-            }
-        }
         this.preRenderContainerEl = resolved;
         this.applyPreRenderContainerPositioning();
         if (wrapper.parentNode !== resolved) {
@@ -1220,11 +1177,12 @@ class TsEmbed {
      */
     setIFrameHeight(height) {
         if (this.isPreRendered) {
+            const next = (0, utils_1.getCssDimension)(height);
             if (this.insertedDomEl) {
-                this.insertedDomEl.style.height = (0, utils_1.getCssDimension)(height);
+                this.insertedDomEl.style.height = next;
             }
             else if (this.preRenderWrapper) {
-                this.preRenderWrapper.style.height = (0, utils_1.getCssDimension)(height);
+                this.preRenderWrapper.style.height = next;
             }
         }
         else {
@@ -1659,34 +1617,47 @@ class TsEmbed {
         delete container.dataset[PRERENDER_CONTAINER_ORIGINAL_POSITION_KEY];
     }
     /**
-     * Detaches and clears the container scroll listener, if one is attached.
+     * Re-sizes the wrapper when its placeholder changes size.
+     *
+     * Position deliberately has no equivalent. An absolutely positioned wrapper
+     * follows its containing block for free, so a correctly placed frame is the
+     * browser's job and costs nothing; repositioning it on scroll would mean a
+     * layout read and a style write per frame to compensate for placing it in
+     * the wrong box. Size is the one thing the browser will not do for us: the
+     * placeholder grows when the embedded app reports a new height, and the
+     * wrapper has to be told.
      */
-    removeContainerScrollListener() {
-        if (!this.containerScrollListener) {
+    observePreRenderSize() {
+        var _a;
+        if (this.getPreRenderConfig().doNotTrackSize || typeof ResizeObserver === 'undefined') {
+            return;
+        }
+        const placeholder = this.getPreRenderPlaceHolderElement();
+        if (!placeholder) {
             return;
         }
-        const customContainer = this.getCustomPreRenderContainer();
-        customContainer === null || customContainer === void 0 ? void 0 : customContainer.removeEventListener('scroll', this.containerScrollListener);
-        this.containerScrollListener = null;
+        (_a = this.resizeObserver) === null || _a === void 0 ? void 0 : _a.disconnect();
+        this.resizeObserver = new ResizeObserver(() => this.syncPreRenderStyle());
+        this.resizeObserver.observe(placeholder);
     }
     /**
      * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
      * @version SDK: 1.19.1 | ThoughtSpot: *
      */
     destroy() {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         try {
             this.removeFullscreenChangeHandler();
-            this.removeContainerScrollListener();
+            (_a = this.resizeObserver) === null || _a === void 0 ? void 0 : _a.disconnect();
             this.unsubscribeToEvents();
-            (_a = this.preRenderWrapper) === null || _a === void 0 ? void 0 : _a.remove();
+            (_b = this.preRenderWrapper) === null || _b === void 0 ? void 0 : _b.remove();
             this.restorePreRenderContainerPosition();
             if (!this.isRendered) {
                 return;
             }
             if (!(0, embedConfig_1.getEmbedConfig)().waitForCleanupOnDestroy) {
                 this.trigger(types_1.HostEvent.DestroyEmbed);
-                (_c = (_b = this.insertedDomEl) === null || _b === void 0 ? void 0 : _b.parentNode) === null || _c === void 0 ? void 0 : _c.removeChild(this.insertedDomEl);
+                (_d = (_c = this.insertedDomEl) === null || _c === void 0 ? void 0 : _c.parentNode) === null || _d === void 0 ? void 0 : _d.removeChild(this.insertedDomEl);
             }
             else {
                 const cleanupTimeout = (0, embedConfig_1.getEmbedConfig)().cleanupTimeout;
@@ -1732,27 +1703,6 @@ class TsEmbed {
         this.isRendered = true;
         return this.renderIFrame(prerenderFrameSrc);
     }
-    isConfigExcludedFromUrl() {
-        var _a, _b, _c;
-        const flag = (_b = (_a = this.viewConfig.additionalFlags) === null || _a === void 0 ? void 0 : _a.excludeConfigFromURL) !== null && _b !== void 0 ? _b : (_c = this.embedConfig.additionalFlags) === null || _c === void 0 ? void 0 : _c.excludeConfigFromURL;
-        // Enabled by default; only an explicit false opts out.
-        return flag !== false && flag !== 'false';
-    }
-    async triggerUpdateEmbedParams() {
-        try {
-            const params = await this.getUpdateEmbedParamsObject();
-            this.trigger(types_1.HostEvent.UpdateEmbedParams, params);
-        }
-        catch (error) {
-            logger_1.logger.error(errors_1.ERROR_MESSAGE.UPDATE_PARAMS_FAILED, error);
-            this.handleError({
-                errorType: types_1.ErrorDetailsTypes.API,
-                message: (error === null || error === void 0 ? void 0 : error.message) || errors_1.ERROR_MESSAGE.UPDATE_PARAMS_FAILED,
-                code: types_1.EmbedErrorCodes.UPDATE_PARAMS_FAILED,
-                error: (error === null || error === void 0 ? void 0 : error.message) || error,
-            });
-        }
-    }
     beforePrerenderVisible() {
         // We can ignore this as its a bit expensive and the newer customers
         // have moved on to UpdateEmbedParams supported clusters
@@ -1763,7 +1713,17 @@ class TsEmbed {
         this.preRenderParamsApplied = new Promise((resolve) => {
             this.executeAfterEmbedContainerLoaded(async () => {
                 try {
-                    await this.triggerUpdateEmbedParams();
+                    const params = await this.getUpdateEmbedParamsObject();
+                    this.trigger(types_1.HostEvent.UpdateEmbedParams, params);
+                }
+                catch (error) {
+                    logger_1.logger.error(errors_1.ERROR_MESSAGE.UPDATE_PARAMS_FAILED, error);
+                    this.handleError({
+                        errorType: types_1.ErrorDetailsTypes.API,
+                        message: (error === null || error === void 0 ? void 0 : error.message) || errors_1.ERROR_MESSAGE.UPDATE_PARAMS_FAILED,
+                        code: types_1.EmbedErrorCodes.UPDATE_PARAMS_FAILED,
+                        error: (error === null || error === void 0 ? void 0 : error.message) || error,
+                    });
                 }
                 finally {
                     setTimeout(resolve, UPDATE_EMBED_PARAMS_SETTLE_MS);
@@ -1778,7 +1738,7 @@ class TsEmbed {
      * wrapper to overlay it.
      */
     async showPreRender() {
-        var _a, _b;
+        var _a;
         (0, mixpanel_service_1.uploadMixpanelEvent)(mixpanel_service_1.MIXPANEL_EVENT.VISUAL_SDK_SHOW_PRE_RENDER, {
             preRenderId: this.getPreRenderConfig().id,
             embedComponentType: this.viewConfig.embedComponentType,
@@ -1797,14 +1757,16 @@ class TsEmbed {
         this.beforePrerenderVisible();
         if (this.hostElement) {
             this.insertedDomEl = this.createPreRenderPlaceholder();
-            if (this.viewConfig.fullHeight) {
-                // If fullHeight has already sized the wrapper, seed the
-                // placeholder with the same height so syncPreRenderStyle gets
-                // an accurate rect.
-                const existingHeight = this.preRenderWrapper.style.height;
-                if (existingHeight) {
-                    this.insertedDomEl.style.height = existingHeight;
-                }
+            // Carry a height fullHeight has already measured onto the fresh
+            // placeholder, so a re-show does not flash at frameParams height.
+            // UNMEASURED_WRAPPER_HEIGHT is what createPreRenderWrapper() seeds
+            // before anything has been measured; treating that as a measurement
+            // is what made a first reveal overshoot to a full viewport.
+            const wrapperHeight = this.preRenderWrapper.style.height;
+            if (this.viewConfig.fullHeight
+                && wrapperHeight
+                && wrapperHeight !== UNMEASURED_WRAPPER_HEIGHT) {
+                this.insertedDomEl.style.height = wrapperHeight;
             }
             const placeHolderId = this.getPreRenderIds().placeHolder;
             // Remove any stale placeholder from a previous cycle. It is located
@@ -1818,29 +1780,19 @@ class TsEmbed {
             (_a = this.hostElement.querySelector(`#${placeHolderId}`)) === null || _a === void 0 ? void 0 : _a.remove();
             this.hostElement.appendChild(this.insertedDomEl);
             this.syncPreRenderStyle();
-            const customContainer = this.getCustomPreRenderContainer();
-            if (customContainer && !this.containerScrollListener) {
-                this.containerScrollListener = () => this.syncPreRenderStyle();
-                customContainer.addEventListener('scroll', this.containerScrollListener);
-            }
-            if (!this.getPreRenderConfig().doNotTrackSize) {
-                const observeTarget = (_b = this.insertedDomEl) !== null && _b !== void 0 ? _b : this.hostElement;
-                this.resizeObserver = new ResizeObserver((entries) => {
-                    entries.forEach((entry) => {
-                        if (entry.target === observeTarget) {
-                            this.syncPreRenderStyle();
-                        }
-                    });
-                });
-                this.resizeObserver.observe(observeTarget);
-            }
+            this.observePreRenderSize();
         }
         (0, utils_1.removeStyleProperties)(this.preRenderWrapper, [
             'z-index',
             'opacity',
-            'pointer-events',
             'overflow',
+            'transform',
         ]);
+        // Set rather than removed: a container that carries `pointer-events:
+        // none` — the usual styling for a parking root that must not swallow
+        // clicks — passes it down, and dropping the property here would leave
+        // the inherited `none` in force and the frame dead to input.
+        (0, utils_1.setStyleProperties)(this.preRenderWrapper, { pointerEvents: 'auto' });
         this.subscribeToEvents();
         // Setup fullscreen change handler for prerendered components
         if (this.iFrame) {
@@ -1893,6 +1845,7 @@ class TsEmbed {
      * If the component is not preRendered, it issues a warning.
      */
     hidePreRender() {
+        var _a;
         (0, mixpanel_service_1.uploadMixpanelEvent)(mixpanel_service_1.MIXPANEL_EVENT.VISUAL_SDK_HIDE_PRE_RENDER, {
             preRenderId: this.getPreRenderConfig().id,
             embedComponentType: this.viewConfig.embedComponentType,
@@ -1912,12 +1865,15 @@ class TsEmbed {
             top: '0',
             left: '0',
             overflow: 'hidden',
+            // Keeps the measured size — so the next show needs no resize, which
+            // is the point of pre-rendering — while lifting the box out of
+            // the container's scrollable area. Overflow only extends
+            // downwards, so a hidden frame parked above the top edge adds
+            // none, where one left at full height shows as blank scroll space.
+            transform: PRERENDER_PARKED_TRANSFORM,
         };
         (0, utils_1.setStyleProperties)(this.preRenderWrapper, preRenderHideStyles);
-        this.removeContainerScrollListener();
-        if (this.resizeObserver) {
-            this.resizeObserver.disconnect();
-        }
+        (_a = this.resizeObserver) === null || _a === void 0 ? void 0 : _a.disconnect();
         const placeHolderEle = this.getPreRenderPlaceHolderElement();
         if (placeHolderEle) {
             placeHolderEle.parentElement.removeChild(placeHolderEle);