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

package/README.md

@@ -31,7 +31,7 @@ import * as TsEmbedSDK from '@thoughtspot/visual-embed-sdk';
 <script src='https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.js'></script>
 
 // ES6 from web
-import { PinboardEmbed, AuthType, init } from 'https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.es.js';
+import { LiveboardEmbed, AuthType, init } from 'https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.es.js';
 ```
 <br/>
 
@@ -51,7 +51,7 @@ Visit our [code playground](https://try-everywhere.thoughtspot.cloud/v2/#/everyw
 ## Quick Start
 
 The ThoughtSpot Embed SDK allows you to embed the ThoughtSpot search experience,
-pinboards, visualizations or the even full app version.
+liveboards, visualizations or the even full app version.
 
 ### Embedded Search
 
@@ -76,32 +76,32 @@ const searchEmbed = new SearchEmbed(document.getElementById('ts-embed'), {
 searchEmbed.render();
 ```
 
-### Embedded Pinboard & Visualization
+### Embedded Liveboard & Visualization
 
 ```js
 // NPM
-import { PinboardEmbed, AuthType, init } from '@thoughtspot/visual-embed-sdk';
+import { LiveboardEmbed, AuthType, init } from '@thoughtspot/visual-embed-sdk';
 // or ES6
-// import { PinboardEmbed, AuthType, init } from 'https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.es.js';
+// import { LiveboardEmbed, AuthType, init } from 'https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.es.js';
 
 init({
     thoughtSpotHost: '<%=tshost%>',
     authType: AuthType.None,
 });
 
-const pinboardEmbed = new PinboardEmbed(
+const liveboardEmbed = new LiveboardEmbed(
     document.getElementById('ts-embed'),
     {
         frameParams: {
             width: '100%',
             height: '100%',
         },
-        pinboardId: '<%=pinboardGUID%>',
+        liveboardId: '<%=liveboardGUID%>',
         vizId: '<%=vizGUID%>',
     },
 });
 
-pinboardEmbed.render();
+liveboardEmbed.render();
 ```
 
 ### Embedded Full App

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

@@ -27,7 +27,11 @@ export declare enum Page {
      */
     Answers = "answers",
     /**
-     * Pinboards listing page
+     * Liveboards listing page
+     */
+    Liveboards = "liveboards",
+    /**
+     * @hidden
      */
     Pinboards = "pinboards",
     /**
@@ -63,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
-     * pinboards and answers, would be filtered by this tag.
+     * Liveboards and answers, would be filtered by this tag.
      */
     tag?: string;
     /**
@@ -80,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 pinboard or visualization.
+     * embedded Liveboard or visualization.
      */
     private getEmbedParams;
     /**
@@ -99,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

@@ -0,0 +1,101 @@
+/**
+ * Copyright (c) 2021
+ *
+ * Embed a ThoughtSpot Liveboard or visualization
+ * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
+ * https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
+ *
+ * @summary Liveboard & visualization embed
+ * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+ */
+import { DOMSelector } from '../types';
+import { V1Embed, ViewConfig } from './ts-embed';
+/**
+ * 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.
+     */
+    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.
+     * *_since 1.5.0_
+     * @default 500
+     */
+    defaultHeight?: number;
+    /**
+     * If set to true, the context menu in visualizations will be enabled.
+     */
+    enableVizTransformations?: boolean;
+    /**
+     * The Liveboard to display in the embedded view.
+     * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
+     */
+    liveboardId?: string;
+    /**
+     * To support backward compatibilty
+     * @hidden
+     */
+    pinboardId?: string;
+    /**
+     * 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)
+     */
+    preventLiveboardFilterRemoval?: boolean;
+    /**
+     * To support backward compatibilty
+     * @hidden
+     */
+    preventPinboardFilterRemoval?: boolean;
+}
+/**
+ * Embed a ThoughtSpot Liveboard or visualization
+ * @Category Liveboards and Charts
+ */
+export declare class LiveboardEmbed extends V1Embed {
+    protected viewConfig: LiveboardViewConfig;
+    private defaultHeight;
+    constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
+    /**
+     * Construct a map of params to be passed on to the
+     * embedded Liveboard or visualization.
+     */
+    private getEmbedParams;
+    /**
+     * 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 runtimeFilters A list of runtime filters to be applied to
+     * the Liveboard or visualization on load.
+     */
+    private getIFrameSrc;
+    /**
+     * Set the iframe height as per the computed height received
+     * from the ThoughtSpot app.
+     * @param data The event payload
+     */
+    private updateIFrameHeight;
+    private embedIframeCenter;
+    private setIframeHeightForNonEmbedLiveboard;
+    /**
+     * Render an embedded ThoughtSpot Liveboard or visualization
+     * @param renderOptions An object specifying the Liveboard ID,
+     * visualization ID and the runtime filters.
+     */
+    render(): LiveboardEmbed;
+}
+/**
+ * @hidden
+ */
+export declare class PinboardEmbed extends 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 pinboard.
+     * 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 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.
@@ -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 pinboard page,
-     * define the method as navigateToPage('pinboard/<pinboardId>').
-     */
-    navigateToPage(path: string): void;
     /**
      * Triggers an event on specific Port registered against
      * for the EmbedEvent

package/dist/src/errors.d.ts

@@ -1,4 +1,4 @@
 export declare const ERROR_MESSAGE: {
     INVALID_THOUGHTSPOT_HOST: string;
-    PINBOARD_VIZ_ID_VALIDATION: string;
+    LIVEBOARD_VIZ_ID_VALIDATION: string;
 };

package/dist/src/index.d.ts

@@ -9,7 +9,7 @@
  */
 import { AppEmbed, Page, AppViewConfig } from './embed/app';
 import { init, prefetch } from './embed/base';
-import { PinboardEmbed, PinboardViewConfig } from './embed/pinboard';
+import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from './embed/liveboard';
 import { SearchEmbed, SearchViewConfig } from './embed/search';
 import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig } from './types';
-export { init, prefetch, SearchEmbed, PinboardEmbed, AppEmbed, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, SearchViewConfig, PinboardViewConfig, AppViewConfig, };
+export { init, prefetch, SearchEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, SearchViewConfig, LiveboardViewConfig, AppViewConfig, };

package/dist/src/react/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { SearchViewConfig } from '../embed/search';
 import { AppViewConfig } from '../embed/app';
-import { PinboardViewConfig } from '../embed/pinboard';
+import { LiveboardViewConfig } from '../embed/liveboard';
 import { EmbedProps } from './util';
 interface SearchProps extends EmbedProps, SearchViewConfig {
 }
@@ -9,7 +9,8 @@ export declare const SearchEmbed: (props: SearchProps) => JSX.Element;
 interface AppProps extends EmbedProps, AppViewConfig {
 }
 export declare const AppEmbed: (props: AppProps) => JSX.Element;
-interface PinboardProps extends EmbedProps, PinboardViewConfig {
+interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
 }
-export declare const PinboardEmbed: (props: PinboardProps) => JSX.Element;
+export declare const LiveboardEmbed: (props: LiveboardProps) => JSX.Element;
+export declare const PinboardEmbed: (props: LiveboardProps) => JSX.Element;
 export {};

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, pinboards, 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 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
      */
     Data = "data",
     /**
-     * Search/answer/pinboard 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 pinboard 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 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
      */
     EmbedHeight = "EMBED_HEIGHT",
@@ -296,7 +297,6 @@ export declare enum EmbedEvent {
     EmbedIframeCenter = "EmbedIframeCenter",
     /**
      * Detects the route change.
-     * @hidden
      */
     RouteChange = "ROUTE_CHANGE",
     /**
@@ -308,7 +308,7 @@ export declare enum 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
      */
     NoCookieAccess = "noCookieAccess",
     /**
@@ -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"
 }
@@ -394,7 +394,7 @@ export declare enum Param {
     DisableActions = "disableAction",
     DisableActionReason = "disableHint",
     ForceTable = "forceTable",
-    preventPinboardFilterRemoval = "preventPinboardFilterRemoval",
+    preventLiveboardFilterRemoval = "preventPinboardFilterRemoval",
     SearchQuery = "searchQuery",
     HideActions = "hideAction",
     HideObjects = "hideObjects",
@@ -416,7 +416,7 @@ export declare enum Param {
 }
 /**
  * The list of actions that can be performed on visual ThoughtSpot
- * entities, such as answers and pinboards.
+ * entities, such as answers and Liveboards.
  */
 export declare enum Action {
     Save = "save",
@@ -426,7 +426,6 @@ export declare enum Action {
     MakeACopy = "makeACopy",
     EditACopy = "editACopy",
     CopyLink = "embedDocument",
-    PinboardSnapshot = "pinboardSnapshot",
     ResetLayout = "resetLayout",
     Schedule = "schedule",
     SchedulesList = "schedule-list",
@@ -459,7 +458,11 @@ export declare enum Action {
     Describe = "describe",
     Relate = "relate",
     CustomizeHeadlines = "customizeHeadlines",
+    /**
+     * @hidden
+     */
     PinboardInfo = "pinboardInfo",
+    LiveboardInfo = "pinboardInfo",
     SendAnswerFeedback = "sendFeedback",
     /**
      * @deprecated Will be removed in next version