@thoughtspot/visual-embed-sdk 1.6.0-alpha.2 → 1.6.0-alpha.3

package/dist/src/embed/app.d.ts

@@ -67,7 +67,7 @@ export interface AppViewConfig extends ViewConfig {
     pageId?: Page;
     /**
      * This puts a filter tag on the application. All metadata lists in the application, such as
-     * liveboards and answers, would be filtered by this tag.
+     * Liveboards and answers, would be filtered by this tag.
      */
     tag?: string;
     /**
@@ -84,7 +84,7 @@ export declare class AppEmbed extends V1Embed {
     constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
     /**
      * Constructs a map of parameters to be passed on to the
-     * embedded liveboard or visualization.
+     * embedded Liveboard or visualization.
      */
     private getEmbedParams;
     /**
@@ -103,6 +103,13 @@ export declare class AppEmbed extends V1Embed {
      * @returns The URL path that the embedded app understands.
      */
     private formatPath;
+    /**
+     * 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: string): void;
     /**
      * Renders the embedded application pages in the ThoughtSpot app.
      * @param renderOptions An object containing the page ID

package/dist/src/embed/liveboard.d.ts

@@ -1,7 +1,7 @@
 /**
  * Copyright (c) 2021
  *
- * Embed a ThoughtSpot liveboard 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
  *
@@ -11,21 +11,21 @@
 import { DOMSelector } from '../types';
 import { V1Embed, ViewConfig } from './ts-embed';
 /**
- * The configuration for the embedded liveboard or visualization page view.
+ * The configuration for the embedded Liveboard or visualization page view.
  * @Category Liveboards and Charts
  */
 export interface LiveboardViewConfig extends ViewConfig {
     /**
      * If set to true, the embedded object container dynamically resizes
-     * according to the height of the liveboard.
+     * according to the height of the Liveboard.
      */
     fullHeight?: boolean;
     /**
-     * This is the minimum height(in pixels) for a full height liveboard.
-     * Setting this height helps resolves issues with empty liveboards and
-     * other screens navigable from a liveboard.
+     * This is the minimum height(in pixels) for a full height Liveboard.
+     * Setting this height helps resolves issues with empty Liveboards and
+     * other screens navigable from a Liveboard.
+     * *_since 1.5.0_
      * @default 500
-     * * _since 1.5.0_
      */
     defaultHeight?: number;
     /**
@@ -33,7 +33,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     enableVizTransformations?: boolean;
     /**
-     * The liveboard to display in the embedded view.
+     * The Liveboard to display in the embedded view.
      * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
      */
     liveboardId?: string;
@@ -43,12 +43,12 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     pinboardId?: string;
     /**
-     * The visualization within the liveboard to display.
+     * The visualization within the Liveboard to display.
      */
     vizId?: string;
     /**
      * If set to true, all filter chips from a
-     * liveboard page will be read-only (no X buttons)
+     * Liveboard page will be read-only (no X buttons)
      */
     preventLiveboardFilterRemoval?: boolean;
     /**
@@ -58,7 +58,7 @@ export interface LiveboardViewConfig extends ViewConfig {
     preventPinboardFilterRemoval?: boolean;
 }
 /**
- * Embed a ThoughtSpot liveboard or visualization
+ * Embed a ThoughtSpot Liveboard or visualization
  * @Category Liveboards and Charts
  */
 export declare class LiveboardEmbed extends V1Embed {
@@ -67,16 +67,16 @@ export declare class LiveboardEmbed extends V1Embed {
     constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
     /**
      * Construct a map of params to be passed on to the
-     * embedded liveboard or visualization.
+     * embedded Liveboard or visualization.
      */
     private getEmbedParams;
     /**
-     * Construct the URL of the embedded ThoughtSpot liveboard or visualization
+     * Construct the URL of the embedded ThoughtSpot Liveboard or visualization
      * to be loaded within the iframe.
-     * @param liveboardId The GUID of the liveboard.
-     * @param vizId The optional GUID of a visualization within the liveboard.
+     * @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 liveboard or visualization on load.
+     * the Liveboard or visualization on load.
      */
     private getIFrameSrc;
     /**
@@ -86,10 +86,10 @@ export declare class LiveboardEmbed extends V1Embed {
      */
     private updateIFrameHeight;
     private embedIframeCenter;
-    private handleRouteChangeFullHeightLiveboard;
+    private setIframeHeightForNonEmbedLiveboard;
     /**
-     * Render an embedded ThoughtSpot liveboard or visualization
-     * @param renderOptions An object specifying the liveboard ID,
+     * Render an embedded ThoughtSpot Liveboard or visualization
+     * @param renderOptions An object specifying the Liveboard ID,
      * visualization ID and the runtime filters.
      */
     render(): LiveboardEmbed;

package/dist/src/embed/liveboard.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/embed/ts-embed.d.ts

@@ -64,7 +64,7 @@ export interface ViewConfig {
     visibleActions?: Action[];
     /**
      * The list of runtime filters to apply to a search answer,
-     * visualization, or liveboard.
+     * visualization, or Liveboard.
      */
     runtimeFilters?: RuntimeFilter[];
 }
@@ -162,7 +162,7 @@ export declare class TsEmbed {
     protected getBaseQueryParams(): {};
     /**
      * Constructs the base URL string to load v1 of the ThoughtSpot app.
-     * This is used for embedding liveboards, 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.
@@ -221,15 +221,6 @@ export declare class TsEmbed {
      * @param callback A callback function
      */
     on(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
-    /**
-     * 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 liveboard page,
-     * define the method as navigateToPage('liveboard/<liveboardId>').
-     */
-    navigateToPage(path: string): void;
     /**
      * Triggers an event on specific Port registered against
      * for the EmbedEvent

package/dist/src/types.d.ts

@@ -112,12 +112,13 @@ export interface EmbedConfig {
      * When there are multiple embeds, queue the render of embed to start
      *  after the previous embed's render is complete. This helps in the load performance
      *  by decreasing the load on the browser.
+     * * _Version 1.5.0 or later _
      * @default false
      */
     queueMultiRenders?: boolean;
     /**
      * Dynamic CSS Url to be injected in the loaded application.
-     * _Since: 1.6.0_
+     * * _Version 1.6.0 or later _
      * @default ''
      */
     customCssUrl?: string;
@@ -193,7 +194,7 @@ export declare enum RuntimeFilterOp {
     IN = "IN"
 }
 /**
- * A filter that can be applied to ThoughtSpot answers, liveboards, or
+ * A filter that can be applied to ThoughtSpot answers, Liveboards, or
  * visualizations at runtime.
  */
 export interface RuntimeFilter {
@@ -231,12 +232,12 @@ export declare enum EmbedEvent {
      */
     Load = "load",
     /**
-     * Data pertaining to answer or liveboard is received
-     * @return data - The answer or liveboard data
+     * Data pertaining to answer or Liveboard is received
+     * @return data - The answer or Liveboard data
      */
     Data = "data",
     /**
-     * Search/answer/liveboard filters have been applied/updated
+     * Search/answer/Liveboard filters have been applied/updated
      * @hidden
      */
     FiltersChanged = "filtersChanged",
@@ -259,13 +260,13 @@ export declare enum EmbedEvent {
     /**
      * A custom action has been triggered
      * @return actionId - The id of the custom action
-     * @return data - The answer or liveboard data
+     * @return data - The answer or Liveboard data
      */
     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 _
      */
     VizPointDoubleClick = "vizPointDoubleClick",
     /**
@@ -283,8 +284,8 @@ export declare enum EmbedEvent {
      */
     AuthExpire = "ThoughtspotAuthExpired",
     /**
-     * The height of the embedded liveboard or visualization has been computed.
-     * @return data - The height of the embedded liveboard or visualization
+     * The height of the embedded Liveboard or visualization has been computed.
+     * @return data - The height of the embedded Liveboard or visualization
      * @hidden
      */
     EmbedHeight = "EMBED_HEIGHT",
@@ -296,7 +297,6 @@ export declare enum EmbedEvent {
     EmbedIframeCenter = "EmbedIframeCenter",
     /**
      * Detects the route change.
-     * @hidden
      */
     RouteChange = "ROUTE_CHANGE",
     /**
@@ -319,12 +319,12 @@ export declare enum EmbedEvent {
     SAMLComplete = "samlComplete",
     /**
      * Emitted when any modal is opened in the app
-     * * _since: 1.6.0_
+     * * _Version 1.6.0 or later _
      */
     DialogOpen = "dialog-open",
     /**
      * Emitted when any modal is closed in the app
-     * * _since: 1.6.0_
+     * * _Version 1.6.0 or later _
      */
     DialogClose = "dialog-close"
 }
@@ -345,7 +345,7 @@ export declare enum 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 _
      */
     DrillDown = "triggerDrillDown",
     /**
@@ -359,10 +359,10 @@ export declare enum 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 _
      */
     SetVisibleVizs = "SetPinboardVisibleVizs"
 }
@@ -416,7 +416,7 @@ export declare enum Param {
 }
 /**
  * The list of actions that can be performed on visual ThoughtSpot
- * entities, such as answers and liveboards.
+ * entities, such as answers and Liveboards.
  */
 export declare enum Action {
     Save = "save",
@@ -426,11 +426,6 @@ export declare enum Action {
     MakeACopy = "makeACopy",
     EditACopy = "editACopy",
     CopyLink = "embedDocument",
-    /**
-     * @hidden
-     */
-    PinboardSnapshot = "pinboardSnapshot",
-    LiveboardSnapshot = "liveboardSnapshot",
     ResetLayout = "resetLayout",
     Schedule = "schedule",
     SchedulesList = "schedule-list",
@@ -467,7 +462,7 @@ export declare enum Action {
      * @hidden
      */
     PinboardInfo = "pinboardInfo",
-    LiveboardInfo = "liveboardInfo",
+    LiveboardInfo = "pinboardInfo",
     SendAnswerFeedback = "sendFeedback",
     /**
      * @deprecated Will be removed in next version

package/dist/tsembed.es.js

@@ -230,12 +230,12 @@ var EmbedEvent;
      */
     EmbedEvent["Load"] = "load";
     /**
-     * Data pertaining to answer or liveboard is received
-     * @return data - The answer or liveboard data
+     * Data pertaining to answer or Liveboard is received
+     * @return data - The answer or Liveboard data
      */
     EmbedEvent["Data"] = "data";
     /**
-     * Search/answer/liveboard 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 liveboard 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 liveboard or visualization has been computed.
-     * @return data - The height of the embedded liveboard 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";
     /**
@@ -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 = {}));
@@ -421,7 +420,7 @@ var Param;
 })(Param || (Param = {}));
 /**
  * The list of actions that can be performed on visual ThoughtSpot
- * entities, such as answers and liveboards.
+ * entities, such as answers and Liveboards.
  */
 // eslint-disable-next-line no-shadow
 var Action;
@@ -433,11 +432,6 @@ var Action;
     Action["MakeACopy"] = "makeACopy";
     Action["EditACopy"] = "editACopy";
     Action["CopyLink"] = "embedDocument";
-    /**
-     * @hidden
-     */
-    Action["PinboardSnapshot"] = "pinboardSnapshot";
-    Action["LiveboardSnapshot"] = "liveboardSnapshot";
     Action["ResetLayout"] = "resetLayout";
     Action["Schedule"] = "schedule";
     Action["SchedulesList"] = "schedule-list";
@@ -474,7 +468,7 @@ var Action;
      * @hidden
      */
     Action["PinboardInfo"] = "pinboardInfo";
-    Action["LiveboardInfo"] = "liveboardInfo";
+    Action["LiveboardInfo"] = "pinboardInfo";
     Action["SendAnswerFeedback"] = "sendFeedback";
     /**
      * @deprecated Will be removed in next version
@@ -8845,7 +8839,7 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
     }
 }
 
-var version="1.6.0-alpha.2";
+var version="1.6.0-alpha.3";
 
 /**
  * Copyright (c) 2021
@@ -9011,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;
         }
@@ -9031,7 +9025,7 @@ class TsEmbed {
     }
     /**
      * Constructs the base URL string to load v1 of the ThoughtSpot app.
-     * This is used for embedding liveboards, 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.
@@ -9209,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 liveboard page,
-     * define the method as navigateToPage('liveboard/<liveboardId>').
-     */
-    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
@@ -9349,7 +9323,7 @@ class AppEmbed extends V1Embed {
     }
     /**
      * Constructs a map of parameters to be passed on to the
-     * embedded liveboard or visualization.
+     * embedded Liveboard or visualization.
      */
     getEmbedParams() {
         const params = this.getBaseQueryParams();
@@ -9412,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
@@ -9430,7 +9421,7 @@ class AppEmbed extends V1Embed {
 /**
  * Copyright (c) 2021
  *
- * Embed a ThoughtSpot liveboard 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
  *
@@ -9438,7 +9429,7 @@ class AppEmbed extends V1Embed {
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 /**
- * Embed a ThoughtSpot liveboard or visualization
+ * Embed a ThoughtSpot Liveboard or visualization
  * @Category Liveboards and Charts
  */
 class LiveboardEmbed extends V1Embed {
@@ -9458,16 +9449,15 @@ class LiveboardEmbed extends V1Embed {
             const obj = this.getIframeCenter();
             responder({ type: EmbedEvent.EmbedIframeCenter, data: obj });
         };
-        this.handleRouteChangeFullHeightLiveboard = (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 liveboard or visualization.
+     * embedded Liveboard or visualization.
      */
     getEmbedParams() {
         const params = this.getBaseQueryParams();
@@ -9491,12 +9481,12 @@ class LiveboardEmbed extends V1Embed {
         return queryParams;
     }
     /**
-     * Construct the URL of the embedded ThoughtSpot liveboard or visualization
+     * Construct the URL of the embedded ThoughtSpot Liveboard or visualization
      * to be loaded within the iframe.
-     * @param liveboardId The GUID of the liveboard.
-     * @param vizId The optional GUID of a visualization within the liveboard.
+     * @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 liveboard or visualization on load.
+     * the Liveboard or visualization on load.
      */
     getIFrameSrc(liveboardId, vizId, runtimeFilters) {
         const filterQuery = getFilterQuery(runtimeFilters || []);
@@ -9511,8 +9501,8 @@ class LiveboardEmbed extends V1Embed {
         return url;
     }
     /**
-     * Render an embedded ThoughtSpot liveboard or visualization
-     * @param renderOptions An object specifying the liveboard ID,
+     * Render an embedded ThoughtSpot Liveboard or visualization
+     * @param renderOptions An object specifying the Liveboard ID,
      * visualization ID and the runtime filters.
      */
     render() {
@@ -9523,7 +9513,7 @@ class LiveboardEmbed extends V1Embed {
             this.handleError(ERROR_MESSAGE.LIVEBOARD_VIZ_ID_VALIDATION);
         }
         if (this.viewConfig.fullHeight === true) {
-            this.on(EmbedEvent.RouteChange, this.handleRouteChangeFullHeightLiveboard);
+            this.on(EmbedEvent.RouteChange, this.setIframeHeightForNonEmbedLiveboard);
             this.on(EmbedEvent.EmbedHeight, this.updateIFrameHeight);
             this.on(EmbedEvent.EmbedIframeCenter, this.embedIframeCenter);
         }