@thoughtspot/visual-embed-sdk 1.51.2 → 1.52.0

package/dist/tsembed-react.es.js

@@ -1,4 +1,4 @@
-/* @thoughtspot/visual-embed-sdk version 1.51.2 */
+/* @thoughtspot/visual-embed-sdk version 1.52.0 */
 'use client';
 import * as React from 'react';
 import React__default, { useRef, useCallback } from 'react';
@@ -1910,7 +1910,32 @@ var EmbedEvent;
      */
     EmbedEvent["OrgSwitched"] = "orgSwitched";
     /**
-     * Emitted when the user intercepts a URL.
+     * Emitted before the embedded ThoughtSpot app sends a network request whose
+     * fully resolved URL matches one of the `interceptUrls` in the view config.
+     * The request is held until you call `responder`, which decides whether the
+     * real request goes out or a response you supply is used in its place.
+     *
+     * Setting `interceptUrls` is what enables this; there is no separate enable
+     * flag. If `responder` is not called within `interceptTimeout` (30000 ms by
+     * default) the request fails and `EmbedEvent.Error` is emitted.
+     *
+     * The payload is `{ input, init, urlType }`, where `input` is the request
+     * URL and `init` is the `fetch` init object, with `init.body` parsed into an
+     * object when it is valid JSON. `urlType` is the matching
+     * `InterceptedApiType`; it is `InterceptedApiType.ALL` for any URL outside
+     * the recognized API groups.
+     *
+     * Interception wraps the outermost layer of `fetch`, so `init` holds the
+     * request as the application composed it, before ThoughtSpot attaches its
+     * authentication headers. Those headers, and any token refresh and retry,
+     * are applied afterwards and only when you pass `execute: true`. Only
+     * requests made through `fetch` are intercepted.
+     *
+     * Pass `execute: true` to let the original request proceed untouched, in
+     * which case any `response` you supply alongside it is ignored. With
+     * `execute: false` the request is never sent, and your `response.body` is
+     * returned to the app as JSON, defaulting to status 200 and a
+     * `Content-Type: application/json` header.
      *
      * Supported on all embed types.
      *
@@ -2720,7 +2745,7 @@ var HostEvent;
      *
      * Unlike {@link HostEvent.OpenFilter}, which opens the panel of an
      * existing filter, this event starts the creation of a new filter.
-     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+     * @version SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.OpenAddFilterModal);
@@ -2736,7 +2761,7 @@ var HostEvent;
      * Hiding the *Add parameter* button with `hiddenActions:
      * [Action.AddParameter]` does not block this event, but disabling it
      * with `disabledActions` does.
-     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+     * @version SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.OpenAddParameterModal);
@@ -4614,7 +4639,13 @@ var HostEvent;
      */
     HostEvent["UpdateEmbedParams"] = "updateEmbedParams";
     /**
-     * Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
+     * Notifies the embedded ThoughtSpot app that the embed is being torn down, so that
+     * it can release any resources it holds before the iframe is removed from the DOM.
+     *
+     * This is triggered for you by `embed.destroy()`; you rarely need to trigger it
+     * directly. If `waitForCleanupOnDestroy` is set in the embed config, `destroy()`
+     * waits for the app to acknowledge this event (up to `cleanupTimeout`) before
+     * removing the iframe.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DestroyEmbed);
@@ -6732,7 +6763,7 @@ var Action;
      * ```js
      * hiddenActions: [Action.QuickSearchPill]
      * ```
-     * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
      */
     Action["QuickSearchPill"] = "quickSearchPill";
     /**
@@ -6747,7 +6778,7 @@ var Action;
      * ```js
      * hiddenActions: [Action.DeepAnalysisPill]
      * ```
-     * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
      */
     Action["DeepAnalysisPill"] = "deepAnalysisPill";
     /**
@@ -6762,7 +6793,7 @@ var Action;
      * ```js
      * hiddenActions: [Action.DataLiteracyPill]
      * ```
-     * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
      */
     Action["DataLiteracyPill"] = "dataLiteracyPill";
     /**
@@ -7235,6 +7266,36 @@ var EmbedErrorCodes;
     /** UpdateParameters payload is invalid - malformed applicability */
     EmbedErrorCodes["UPDATEPARAMETERS_INVALID_PAYLOAD"] = "UPDATEPARAMETERS_INVALID_PAYLOAD";
 })(EmbedErrorCodes || (EmbedErrorCodes = {}));
+/**
+ * How badly an error affects the embed, so the host can decide whether it is
+ * worth surfacing to the end user.
+ *
+ * Mirrors the severity that ThoughtSpot itself stamps on errors raised inside
+ * the embedded app, so a host can apply one rule to both sources.
+ *
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @group Error Handling
+ *
+ * @example
+ * Only surface errors that took the embed down
+ *
+ * ```js
+ * embed.on(EmbedEvent.Error, (error) => {
+ *   if (error.severity === EmbedErrorSeverity.SEV1) {
+ *     showBanner(error.message);
+ *   }
+ * });
+ * ```
+ */
+var EmbedErrorSeverity;
+(function (EmbedErrorSeverity) {
+    /** The embed cannot render. Nothing usable is on screen. */
+    EmbedErrorSeverity[EmbedErrorSeverity["SEV1"] = 1] = "SEV1";
+    /** Something is degraded but the embed still works. */
+    EmbedErrorSeverity[EmbedErrorSeverity["SEV2"] = 2] = "SEV2";
+    /** Everything else, including validation of the embedder's own input. */
+    EmbedErrorSeverity[EmbedErrorSeverity["SEV3"] = 3] = "SEV3";
+})(EmbedErrorSeverity || (EmbedErrorSeverity = {}));
 /**
  * Context types for specifying the page context when triggering host events.
  * Used as the third parameter in the `trigger` method to help ThoughtSpot
@@ -7275,20 +7336,27 @@ var ContextType;
     ContextType["Other"] = "other";
 })(ContextType || (ContextType = {}));
 /**
- * Enum for the type of API intercepted
+ * Named groups of ThoughtSpot APIs that can be intercepted, for use in
+ * `interceptUrls`. Each group expands to the underlying request URLs, so you do
+ * not have to list them individually.
  */
 var InterceptedApiType;
 (function (InterceptedApiType) {
     /**
-     * The apis that are use to get the data for the embed
+     * The APIs that fetch the data backing an Answer, including its chart,
+     * table, and headline data.
      */
     InterceptedApiType["AnswerData"] = "AnswerData";
     /**
-     * This will intercept all the apis
+     * Intercepts every `fetch` request the embedded application makes, not only
+     * the data APIs. This includes authentication, session, and metadata calls,
+     * so the handler must respond to requests it does not recognize by passing
+     * `execute: true`. Listing this alongside other entries in `interceptUrls`
+     * supersedes them.
      */
     InterceptedApiType["ALL"] = "ALL";
     /**
-     * The apis that are use to get the data for the liveboard
+     * The APIs that fetch the data backing a Liveboard.
      */
     InterceptedApiType["LiveboardData"] = "LiveboardData";
 })(InterceptedApiType || (InterceptedApiType = {}));
@@ -7412,7 +7480,7 @@ var TableContentDensity;
     TableContentDensity["Compact"] = "COMPACT";
 })(TableContentDensity || (TableContentDensity = {}));
 
-var version$1="1.51.2";var pkg = {version:version$1};
+var version$1="1.52.0";var pkg = {version:version$1};
 
 const { version } = pkg;
 
@@ -10009,7 +10077,7 @@ class AnswerService {
     async getTML() {
         const { object } = await this.executeQuery(getAnswerTML, {});
         const edoc = object[0].edoc;
-        const YAML = await import('./index-D8_Zs-Nr.js');
+        const YAML = await import('./index-BMppCU63.js');
         const parsedDoc = YAML.parse(edoc);
         return {
             answer: {
@@ -21203,6 +21271,7 @@ const handleInterceptEvent = async (params) => {
             errorType: ErrorDetailsTypes.API,
             message: ERROR_MESSAGE.ERROR_PARSING_API_INTERCEPT_BODY,
             code: EmbedErrorCodes.PARSING_API_INTERCEPT_BODY_ERROR,
+            severity: EmbedErrorSeverity.SEV3,
             error: ERROR_MESSAGE.ERROR_PARSING_API_INTERCEPT_BODY,
         };
         executeEvent(EmbedEvent.Error, errorDetails);
@@ -21547,6 +21616,7 @@ class TsEmbed {
             errorType: ErrorDetailsTypes.VALIDATION_ERROR,
             message: ERROR_MESSAGE.INIT_SDK_REQUIRED,
             code: EmbedErrorCodes.INIT_ERROR,
+            severity: EmbedErrorSeverity.SEV1,
             error: ERROR_MESSAGE.INIT_SDK_REQUIRED,
         });
     }
@@ -21557,7 +21627,10 @@ class TsEmbed {
      */
     handleError(errorDetails) {
         this.isError = true;
-        this.executeCallbacks(EmbedEvent.Error, errorDetails);
+        this.executeCallbacks(EmbedEvent.Error, {
+            severity: EmbedErrorSeverity.SEV3,
+            ...errorDetails,
+        });
         // Log error
         logger$3.error(errorDetails);
     }
@@ -21642,6 +21715,7 @@ class TsEmbed {
                 errorType: ErrorDetailsTypes.NETWORK,
                 message: ERROR_MESSAGE.OFFLINE_WARNING,
                 code: EmbedErrorCodes.NETWORK_ERROR,
+                severity: EmbedErrorSeverity.SEV2,
                 offlineWarning: ERROR_MESSAGE.OFFLINE_WARNING,
             };
             this.executeCallbacks(EmbedEvent.Error, errorDetails);
@@ -22014,9 +22088,10 @@ class TsEmbed {
         return iFrame;
     }
     /**
-     * Returns a merged {@link PreRenderConfig} object where each shared key
-     * prefers `preRenderConfig.key` over the top-level `viewConfig.key` for
-     * backward compatibility.
+     * Returns a merged {@link PreRenderConfig} object where each key prefers the
+     * value from `preRenderConfig` over its deprecated top-level `viewConfig`
+     * counterpart (`id`/`preRenderId`, `containerSelector`/`preRenderContainer`,
+     * `doNotTrackSize`/`doNotTrackPreRenderSize`) for backward compatibility.
      */
     getPreRenderConfig() {
         var _a, _b, _c, _d;
@@ -22024,16 +22099,16 @@ class TsEmbed {
         const preRenderCfg = (_a = viewCfg.preRenderConfig) !== null && _a !== void 0 ? _a : {};
         return {
             ...preRenderCfg,
-            preRenderId: (_b = preRenderCfg.preRenderId) !== null && _b !== void 0 ? _b : viewCfg.preRenderId,
-            preRenderContainer: (_c = preRenderCfg.preRenderContainer) !== null && _c !== void 0 ? _c : viewCfg.preRenderContainer,
-            doNotTrackPreRenderSize: (_d = preRenderCfg.doNotTrackPreRenderSize) !== null && _d !== void 0 ? _d : viewCfg.doNotTrackPreRenderSize,
+            id: (_b = preRenderCfg.id) !== null && _b !== void 0 ? _b : viewCfg.preRenderId,
+            containerSelector: (_c = preRenderCfg.containerSelector) !== null && _c !== void 0 ? _c : viewCfg.preRenderContainer,
+            doNotTrackSize: (_d = preRenderCfg.doNotTrackSize) !== null && _d !== void 0 ? _d : viewCfg.doNotTrackPreRenderSize,
         };
     }
     /**
      * Returns true if this embed instance is configured for pre-rendering.
      */
     isPreRenderEmbed() {
-        return !!this.getPreRenderConfig().preRenderId;
+        return !!this.getPreRenderConfig().id;
     }
     handleInsertionIntoDOM(child) {
         if (this.isPreRenderEmbed()) {
@@ -22129,6 +22204,7 @@ class TsEmbed {
                     errorType: ErrorDetailsTypes.API,
                     message: error.message || ERROR_MESSAGE.LOGIN_FAILED,
                     code: EmbedErrorCodes.LOGIN_FAILED,
+                    severity: EmbedErrorSeverity.SEV1,
                     error: error,
                 });
             });
@@ -22220,7 +22296,7 @@ class TsEmbed {
      */
     resolvePreRenderContainerTarget() {
         var _a;
-        const containerConfig = this.getPreRenderConfig().preRenderContainer;
+        const containerConfig = this.getPreRenderConfig().containerSelector;
         let container = null;
         if (typeof containerConfig === 'string') {
             try {
@@ -22245,7 +22321,7 @@ class TsEmbed {
             return;
         }
         const ownerContainer = (_a = preRenderedObject.preRenderContainerEl) !== null && _a !== void 0 ? _a : document.body;
-        if (this.getPreRenderConfig().preRenderContainer
+        if (this.getPreRenderConfig().containerSelector
             && this.resolvePreRenderContainerTarget() !== ownerContainer) {
             logger$3.warn('preRenderContainer is applied only by the component that creates the preRender; '
                 + 'the one passed here is ignored. Set it on the PreRender component instead.');
@@ -22742,7 +22818,7 @@ class TsEmbed {
             showPreRenderByDefault,
             replaceExistingPreRender,
         });
-        if (!this.getPreRenderConfig().preRenderId) {
+        if (!this.getPreRenderConfig().id) {
             logger$3.error(ERROR_MESSAGE.PRERENDER_ID_MISSING);
             return this;
         }
@@ -22918,12 +22994,12 @@ class TsEmbed {
     async showPreRender() {
         var _a, _b;
         uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_SHOW_PRE_RENDER, {
-            preRenderId: this.getPreRenderConfig().preRenderId,
+            preRenderId: this.getPreRenderConfig().id,
             embedComponentType: this.viewConfig.embedComponentType,
         });
         if (this.shouldWaitForRenderPromise)
             await this.isReadyForRenderPromise;
-        if (!this.getPreRenderConfig().preRenderId) {
+        if (!this.getPreRenderConfig().id) {
             logger$3.error(ERROR_MESSAGE.PRERENDER_ID_MISSING);
             return this;
         }
@@ -22959,7 +23035,7 @@ class TsEmbed {
                 this.containerScrollListener = () => this.syncPreRenderStyle();
                 customContainer.addEventListener('scroll', this.containerScrollListener);
             }
-            if (!this.getPreRenderConfig().doNotTrackPreRenderSize) {
+            if (!this.getPreRenderConfig().doNotTrackSize) {
                 const observeTarget = (_b = this.insertedDomEl) !== null && _b !== void 0 ? _b : this.hostElement;
                 this.resizeObserver = new ResizeObserver((entries) => {
                     entries.forEach((entry) => {
@@ -23027,7 +23103,7 @@ class TsEmbed {
      */
     hidePreRender() {
         uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_HIDE_PRE_RENDER, {
-            preRenderId: this.getPreRenderConfig().preRenderId,
+            preRenderId: this.getPreRenderConfig().id,
             embedComponentType: this.viewConfig.embedComponentType,
         });
         logger$3.debug('HidePreRender Called');
@@ -23065,7 +23141,7 @@ class TsEmbed {
      * @property {string} child - The HTML element ID for the PreRender child.
      */
     getPreRenderIds() {
-        const preRenderId = this.getPreRenderConfig().preRenderId;
+        const preRenderId = this.getPreRenderConfig().id;
         return {
             wrapper: `${PRERENDER_WRAPPER_ID_PREFIX}${preRenderId}`,
             child: `tsEmbed-pre-render-child-${preRenderId}`,
@@ -24546,6 +24622,7 @@ let LiveboardEmbed$1 = class LiveboardEmbed extends V1Embed {
                 errorType: ErrorDetailsTypes.VALIDATION_ERROR,
                 message: ERROR_MESSAGE.LIVEBOARD_VIZ_ID_VALIDATION,
                 code: EmbedErrorCodes.LIVEBOARD_ID_MISSING,
+                severity: EmbedErrorSeverity.SEV1,
                 error: ERROR_MESSAGE.LIVEBOARD_VIZ_ID_VALIDATION,
             });
         }
@@ -24697,7 +24774,7 @@ let LiveboardEmbed$1 = class LiveboardEmbed extends V1Embed {
         if (this.isRendered) {
             this.trigger(HostEvent.Navigate, path.substring(1));
         }
-        else if (this.getPreRenderConfig().preRenderId) {
+        else if (this.getPreRenderConfig().id) {
             this.preRender(true);
         }
         else {
@@ -25401,7 +25478,7 @@ isPreRenderedComponent = false) => {
         const ref = React__default.useRef(null);
         const { className, style, ...embedProps } = props;
         const { viewConfig, listeners } = getViewPropsAndListeners(embedProps);
-        const preRenderId = (_b = (_a = props.preRenderConfig) === null || _a === void 0 ? void 0 : _a.preRenderId) !== null && _b !== void 0 ? _b : props.preRenderId;
+        const preRenderId = (_b = (_a = props.preRenderConfig) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : props.preRenderId;
         const handleDestroy = (tsEmbed) => {
             // do not destroy if it is a preRender component
             if (isPreRenderedComponent)