@thoughtspot/visual-embed-sdk 1.6.0-alpha.1 → 1.7.0-alpha.0

package/dist/tsembed.es.js

@@ -230,12 +230,12 @@ var EmbedEvent;
      */
     EmbedEvent["Load"] = "load";
     /**
-     * Data pertaining to answer or pinboard is received
-     * @return data - The answer or pinboard data
+     * Data pertaining to answer or Liveboard is received
+     * @return data - The answer or Liveboard data
      */
     EmbedEvent["Data"] = "data";
     /**
-     * Search/answer/pinboard filters have been applied/updated
+     * Search/answer/Liveboard filters have been applied/updated
      * @hidden
      */
     EmbedEvent["FiltersChanged"] = "filtersChanged";
@@ -258,13 +258,13 @@ var EmbedEvent;
     /**
      * A custom action has been triggered
      * @return actionId - The id of the custom action
-     * @return data - The answer or pinboard data
+     * @return data - The answer or Liveboard data
      */
     EmbedEvent["CustomAction"] = "customAction";
     /**
      * A double click has been triggered on table/chart
      * @return ContextMenuInputPoints - data point that is double clicked
-     * * _since: 1.5.0_
+     * @version 1.5.0 or later
      */
     EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
     /**
@@ -282,8 +282,8 @@ var EmbedEvent;
      */
     EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
     /**
-     * The height of the embedded pinboard or visualization has been computed.
-     * @return data - The height of the embedded pinboard or visualization
+     * The height of the embedded Liveboard or visualization has been computed.
+     * @return data - The height of the embedded Liveboard or visualization
      * @hidden
      */
     EmbedEvent["EmbedHeight"] = "EMBED_HEIGHT";
@@ -295,7 +295,6 @@ var EmbedEvent;
     EmbedEvent["EmbedIframeCenter"] = "EmbedIframeCenter";
     /**
      * Detects the route change.
-     * @hidden
      */
     EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
     /**
@@ -307,7 +306,7 @@ var EmbedEvent;
      * Emitted when the embed does not have cookie access. This
      * happens on Safari where third-party cookies are blocked by default.
      *
-     * @version 1.1.0
+     * @version 1.1.0 or later
      */
     EmbedEvent["NoCookieAccess"] = "noCookieAccess";
     /**
@@ -318,12 +317,12 @@ var EmbedEvent;
     EmbedEvent["SAMLComplete"] = "samlComplete";
     /**
      * Emitted when any modal is opened in the app
-     * * _since: 1.6.0_
+     * @version 1.6.0 or later
      */
     EmbedEvent["DialogOpen"] = "dialog-open";
     /**
      * Emitted when any modal is closed in the app
-     * * _since: 1.6.0_
+     * @version 1.6.0 or later
      */
     EmbedEvent["DialogClose"] = "dialog-close";
 })(EmbedEvent || (EmbedEvent = {}));
@@ -346,7 +345,7 @@ var HostEvent;
      *              eg. { selectedPoints: []}
      * @param columnGuid - a string guid of the column to drill by. This is optional,
      *                     if not provided it will auto drill by the configured column. \
-     * * _since: 1.5.0_
+     * @version 1.5.0 or later
      */
     HostEvent["DrillDown"] = "triggerDrillDown";
     /**
@@ -360,10 +359,10 @@ var HostEvent;
      */
     HostEvent["Reload"] = "reload";
     /**
-     * Set the visible Vizs on a pinboard/liveboard.
-     * @param - an array of ids of vizs to show, the ids not passed
+     * Set the visible visualizations on a Liveboard.
+     * @param - an array of ids of visualizations to show, the ids not passed
      *          will be hidden.
-     * _since: 1.6.0_
+     * @version 1.6.0 or later
      */
     HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
 })(HostEvent || (HostEvent = {}));
@@ -399,7 +398,7 @@ var Param;
     Param["DisableActions"] = "disableAction";
     Param["DisableActionReason"] = "disableHint";
     Param["ForceTable"] = "forceTable";
-    Param["preventPinboardFilterRemoval"] = "preventPinboardFilterRemoval";
+    Param["preventLiveboardFilterRemoval"] = "preventPinboardFilterRemoval";
     Param["SearchQuery"] = "searchQuery";
     Param["HideActions"] = "hideAction";
     Param["HideObjects"] = "hideObjects";
@@ -421,7 +420,7 @@ var Param;
 })(Param || (Param = {}));
 /**
  * The list of actions that can be performed on visual ThoughtSpot
- * entities, such as answers and pinboards.
+ * entities, such as answers and Liveboards.
  */
 // eslint-disable-next-line no-shadow
 var Action;
@@ -433,7 +432,6 @@ var Action;
     Action["MakeACopy"] = "makeACopy";
     Action["EditACopy"] = "editACopy";
     Action["CopyLink"] = "embedDocument";
-    Action["PinboardSnapshot"] = "pinboardSnapshot";
     Action["ResetLayout"] = "resetLayout";
     Action["Schedule"] = "schedule";
     Action["SchedulesList"] = "schedule-list";
@@ -466,7 +464,11 @@ var Action;
     Action["Describe"] = "describe";
     Action["Relate"] = "relate";
     Action["CustomizeHeadlines"] = "customizeHeadlines";
+    /**
+     * @hidden
+     */
     Action["PinboardInfo"] = "pinboardInfo";
+    Action["LiveboardInfo"] = "pinboardInfo";
     Action["SendAnswerFeedback"] = "sendFeedback";
     /**
      * @deprecated Will be removed in next version
@@ -496,7 +498,7 @@ var OperationType;
 
 const ERROR_MESSAGE = {
     INVALID_THOUGHTSPOT_HOST: 'Error parsing ThoughtSpot host. Please provide a valid URL.',
-    PINBOARD_VIZ_ID_VALIDATION: 'Please provide either pinboardId or both pinboardId and vizId',
+    LIVEBOARD_VIZ_ID_VALIDATION: 'Please provide either liveboardId or pinboardId',
 };
 
 /**
@@ -8837,7 +8839,7 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
     }
 }
 
-var version="1.6.0-alpha.1";
+var version="1.7.0-alpha.0";
 
 /**
  * Copyright (c) 2021
@@ -9003,7 +9005,7 @@ class TsEmbed {
             queryParams[Param.CustomCSSUrl] = this.embedConfig.customCssUrl;
         }
         const { disabledActions, disabledActionReason, hiddenActions, visibleActions, } = this.viewConfig;
-        if ((visibleActions === null || visibleActions === void 0 ? void 0 : visibleActions.length) && (hiddenActions === null || hiddenActions === void 0 ? void 0 : hiddenActions.length)) {
+        if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
             this.handleError('You cannot have both hidden actions and visible actions');
             return queryParams;
         }
@@ -9023,7 +9025,7 @@ class TsEmbed {
     }
     /**
      * Constructs the base URL string to load v1 of the ThoughtSpot app.
-     * This is used for embedding pinboards, visualizations, and full application.
+     * This is used for embedding Liveboards, visualizations, and full application.
      * @param queryString The query string to append to the URL.
      * @param isAppEmbed A Boolean parameter to specify if you are embedding
      * the full application.
@@ -9201,26 +9203,6 @@ class TsEmbed {
         this.eventHandlerMap.set(messageType, callbacks);
         return this;
     }
-    /**
-     * Navigates users to the specified application page.
-     * Use this method to navigate users from the embedded
-     * ThoughtSpot context to a specific page in your app.
-     * @param path The page path string.
-     * For example, to navigate users to a pinboard page,
-     * define the method as navigateToPage('pinboard/<pinboardId>').
-     */
-    navigateToPage(path) {
-        var _a;
-        const iframeSrc = (_a = this.iFrame) === null || _a === void 0 ? void 0 : _a.src;
-        if (iframeSrc) {
-            const embedPath = '#/embed';
-            const currentPath = iframeSrc.includes(embedPath) ? embedPath : '#';
-            this.iFrame.src = `${iframeSrc.split(currentPath)[0]}${currentPath}/${path.replace(/^\/?#?\//, '')}`;
-        }
-        else {
-            console.log('Please call render before invoking this method');
-        }
-    }
     /**
      * Triggers an event on specific Port registered against
      * for the EmbedEvent
@@ -9318,7 +9300,11 @@ var Page;
      */
     Page["Answers"] = "answers";
     /**
-     * Pinboards listing page
+     * Liveboards listing page
+     */
+    Page["Liveboards"] = "liveboards";
+    /**
+     * @hidden
      */
     Page["Pinboards"] = "pinboards";
     /**
@@ -9337,7 +9323,7 @@ class AppEmbed extends V1Embed {
     }
     /**
      * Constructs a map of parameters to be passed on to the
-     * embedded pinboard or visualization.
+     * embedded Liveboard or visualization.
      */
     getEmbedParams() {
         const params = this.getBaseQueryParams();
@@ -9374,6 +9360,8 @@ class AppEmbed extends V1Embed {
                 return 'answer';
             case Page.Answers:
                 return 'answers';
+            case Page.Liveboards:
+                return 'pinboards';
             case Page.Pinboards:
                 return 'pinboards';
             case Page.Data:
@@ -9398,6 +9386,23 @@ class AppEmbed extends V1Embed {
         }
         return path;
     }
+    /**
+     * Navigate to particular page for app embed. eg:answers/pinboards/home
+     * This is used for embedding answers, pinboards, visualizations and full application only.
+     * @param path The string, set to iframe src and navigate to new page
+     * eg: appEmbed.navigateToPage('pinboards')
+     */
+    navigateToPage(path) {
+        if (this.iFrame) {
+            const iframeSrc = this.iFrame.src;
+            const embedPath = '#/embed';
+            const currentPath = iframeSrc.includes(embedPath) ? embedPath : '#';
+            this.iFrame.src = `${iframeSrc.split(currentPath)[0]}${currentPath}/${path.replace(/^\/?#?\//, '')}`;
+        }
+        else {
+            console.log('Please call render before invoking this method');
+        }
+    }
     /**
      * Renders the embedded application pages in the ThoughtSpot app.
      * @param renderOptions An object containing the page ID
@@ -9416,18 +9421,18 @@ class AppEmbed extends V1Embed {
 /**
  * Copyright (c) 2021
  *
- * Embed a ThoughtSpot pinboard or visualization
+ * Embed a ThoughtSpot Liveboard or visualization
  * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
  * https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
  *
- * @summary Pinboard & visualization embed
+ * @summary Liveboard & visualization embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 /**
- * Embed a ThoughtSpot pinboard or visualization
- * @Category Pinboards and Charts
+ * Embed a ThoughtSpot Liveboard or visualization
+ * @Category Liveboards and Charts
  */
-class PinboardEmbed extends V1Embed {
+class LiveboardEmbed extends V1Embed {
     // eslint-disable-next-line no-useless-constructor
     constructor(domSelector, viewConfig) {
         super(domSelector, viewConfig);
@@ -9444,20 +9449,21 @@ class PinboardEmbed extends V1Embed {
             const obj = this.getIframeCenter();
             responder({ type: EmbedEvent.EmbedIframeCenter, data: obj });
         };
-        this.handleRouteChangeFullHeightPinboard = (data) => {
-            if (data.data.canvasState !== 'EMBED' &&
-                data.data.canvasState !== 'pinboard') {
+        this.setIframeHeightForNonEmbedLiveboard = (data) => {
+            if (!data.data.currentPath.startsWith('/embed/viz/')) {
                 this.setIFrameHeight(this.defaultHeight);
             }
         };
     }
     /**
      * Construct a map of params to be passed on to the
-     * embedded pinboard or visualization.
+     * embedded Liveboard or visualization.
      */
     getEmbedParams() {
         const params = this.getBaseQueryParams();
-        const { enableVizTransformations, fullHeight, preventPinboardFilterRemoval, defaultHeight, } = this.viewConfig;
+        const { enableVizTransformations, fullHeight, defaultHeight, } = this.viewConfig;
+        const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval ||
+            this.viewConfig.preventPinboardFilterRemoval;
         if (fullHeight === true) {
             params[Param.fullHeight] = true;
         }
@@ -9467,53 +9473,60 @@ class PinboardEmbed extends V1Embed {
         if (enableVizTransformations !== undefined) {
             params[Param.EnableVizTransformations] = enableVizTransformations.toString();
         }
-        if (preventPinboardFilterRemoval) {
-            params[Param.preventPinboardFilterRemoval] = true;
+        if (preventLiveboardFilterRemoval) {
+            params[Param.preventLiveboardFilterRemoval] = true;
         }
         params[Param.livedBoardEmbed] = true;
         const queryParams = getQueryParamString(params, true);
         return queryParams;
     }
     /**
-     * Construct the URL of the embedded ThoughtSpot pinboard or visualization
+     * Construct the URL of the embedded ThoughtSpot Liveboard or visualization
      * to be loaded within the iframe.
-     * @param pinboardId The GUID of the pinboard.
-     * @param vizId The optional GUID of a visualization within the pinboard.
+     * @param liveboardId The GUID of the Liveboard.
+     * @param vizId The optional GUID of a visualization within the Liveboard.
      * @param runtimeFilters A list of runtime filters to be applied to
-     * the pinboard or visualization on load.
+     * the Liveboard or visualization on load.
      */
-    getIFrameSrc(pinboardId, vizId, runtimeFilters) {
+    getIFrameSrc(liveboardId, vizId, runtimeFilters) {
         const filterQuery = getFilterQuery(runtimeFilters || []);
         const queryParams = this.getEmbedParams();
         const queryString = [filterQuery, queryParams]
             .filter(Boolean)
             .join('&');
-        let url = `${this.getV1EmbedBasePath(queryString, true, false, false)}/viz/${pinboardId}`;
+        let url = `${this.getV1EmbedBasePath(queryString, true, false, false)}/viz/${liveboardId}`;
         if (vizId) {
             url = `${url}/${vizId}`;
         }
         return url;
     }
     /**
-     * Render an embedded ThoughtSpot pinboard or visualization
-     * @param renderOptions An object specifying the pinboard ID,
+     * Render an embedded ThoughtSpot Liveboard or visualization
+     * @param renderOptions An object specifying the Liveboard ID,
      * visualization ID and the runtime filters.
      */
     render() {
-        const { pinboardId, vizId, runtimeFilters } = this.viewConfig;
-        if (!pinboardId && !vizId) {
-            this.handleError(ERROR_MESSAGE.PINBOARD_VIZ_ID_VALIDATION);
+        var _a;
+        const { vizId, runtimeFilters } = this.viewConfig;
+        const liveboardId = (_a = this.viewConfig.liveboardId) !== null && _a !== void 0 ? _a : this.viewConfig.pinboardId;
+        if (!liveboardId) {
+            this.handleError(ERROR_MESSAGE.LIVEBOARD_VIZ_ID_VALIDATION);
         }
         if (this.viewConfig.fullHeight === true) {
-            this.on(EmbedEvent.RouteChange, this.handleRouteChangeFullHeightPinboard);
+            this.on(EmbedEvent.RouteChange, this.setIframeHeightForNonEmbedLiveboard);
             this.on(EmbedEvent.EmbedHeight, this.updateIFrameHeight);
             this.on(EmbedEvent.EmbedIframeCenter, this.embedIframeCenter);
         }
         super.render();
-        const src = this.getIFrameSrc(pinboardId, vizId, runtimeFilters);
+        const src = this.getIFrameSrc(liveboardId, vizId, runtimeFilters);
         this.renderV1Embed(src);
         return this;
     }
+}
+/**
+ * @hidden
+ */
+class PinboardEmbed extends LiveboardEmbed {
 }
 
 /**
@@ -9597,4 +9610,4 @@ class SearchEmbed extends TsEmbed {
     }
 }
 
-export { Action, AppEmbed, AuthType, DataSourceVisualMode, EmbedEvent, HostEvent, Page, PinboardEmbed, RuntimeFilterOp, SearchEmbed, init, prefetch };
+export { Action, AppEmbed, AuthType, DataSourceVisualMode, EmbedEvent, HostEvent, LiveboardEmbed, Page, PinboardEmbed, RuntimeFilterOp, SearchEmbed, init, prefetch };