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

package/src/embed/ts-embed.ts

@@ -105,7 +105,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[];
 }
@@ -327,7 +327,7 @@ export class TsEmbed {
             visibleActions,
         } = this.viewConfig;
 
-        if (visibleActions?.length && hiddenActions?.length) {
+        if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
             this.handleError(
                 'You cannot have both hidden actions and visible actions',
             );
@@ -351,7 +351,7 @@ export 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.
@@ -587,27 +587,6 @@ export class TsEmbed {
         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>').
-     */
-    public navigateToPage(path: string): void {
-        const iframeSrc = this.iFrame?.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

package/src/errors.ts

@@ -1,6 +1,6 @@
 export 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',
 };

package/src/index.ts

@@ -10,7 +10,11 @@
 
 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,
@@ -28,6 +32,7 @@ export {
     prefetch,
     SearchEmbed,
     PinboardEmbed,
+    LiveboardEmbed,
     AppEmbed,
     // types
     Page,
@@ -40,6 +45,6 @@ export {
     Action,
     EmbedConfig,
     SearchViewConfig,
-    PinboardViewConfig,
+    LiveboardViewConfig,
     AppViewConfig,
 };

package/src/react/index.tsx

@@ -2,9 +2,9 @@ import React from 'react';
 import { SearchEmbed as _SearchEmbed, SearchViewConfig } from '../embed/search';
 import { AppEmbed as _AppEmbed, AppViewConfig } from '../embed/app';
 import {
-    PinboardEmbed as _PinboardEmbed,
-    PinboardViewConfig,
-} from '../embed/pinboard';
+    LiveboardEmbed as _LiveboardEmbed,
+    LiveboardViewConfig,
+} from '../embed/liveboard';
 import { TsEmbed, ViewConfig } from '../embed/ts-embed';
 
 import { EmbedEvent, MessageCallback } from '../types';
@@ -55,10 +55,16 @@ export const AppEmbed = componentFactory<
     AppViewConfig
 >(_AppEmbed);
 
-interface PinboardProps extends EmbedProps, PinboardViewConfig {}
+interface LiveboardProps extends EmbedProps, LiveboardViewConfig {}
+
+export const LiveboardEmbed = componentFactory<
+    typeof _LiveboardEmbed,
+    LiveboardProps,
+    LiveboardViewConfig
+>(_LiveboardEmbed);
 
 export const PinboardEmbed = componentFactory<
-    typeof _PinboardEmbed,
-    PinboardProps,
-    PinboardViewConfig
->(_PinboardEmbed);
+    typeof _LiveboardEmbed,
+    LiveboardProps,
+    LiveboardViewConfig
+>(_LiveboardEmbed);

package/src/types.ts

@@ -124,13 +124,14 @@ 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;
@@ -212,7 +213,7 @@ export enum RuntimeFilterOp {
 }
 
 /**
- * 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 {
@@ -252,12 +253,12 @@ export 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',
@@ -280,13 +281,13 @@ export 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',
     /**
@@ -304,8 +305,8 @@ export 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',
@@ -317,7 +318,6 @@ export enum EmbedEvent {
     EmbedIframeCenter = 'EmbedIframeCenter',
     /**
      * Detects the route change.
-     * @hidden
      */
     RouteChange = 'ROUTE_CHANGE',
     /**
@@ -329,7 +329,7 @@ export 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',
     /**
@@ -340,12 +340,12 @@ export 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',
 }
@@ -368,7 +368,7 @@ export 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',
     /**
@@ -382,10 +382,10 @@ export 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',
 }
@@ -421,7 +421,7 @@ export enum Param {
     DisableActions = 'disableAction',
     DisableActionReason = 'disableHint',
     ForceTable = 'forceTable',
-    preventPinboardFilterRemoval = 'preventPinboardFilterRemoval',
+    preventLiveboardFilterRemoval = 'preventPinboardFilterRemoval', // update-TSCB
     SearchQuery = 'searchQuery',
     HideActions = 'hideAction',
     HideObjects = 'hideObjects',
@@ -444,7 +444,7 @@ export 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.
  */
 // eslint-disable-next-line no-shadow
 export enum Action {
@@ -455,7 +455,6 @@ export enum Action {
     MakeACopy = 'makeACopy',
     EditACopy = 'editACopy',
     CopyLink = 'embedDocument',
-    PinboardSnapshot = 'pinboardSnapshot',
     ResetLayout = 'resetLayout',
     Schedule = 'schedule',
     SchedulesList = 'schedule-list',
@@ -488,7 +487,11 @@ export enum Action {
     Describe = 'describe',
     Relate = 'relate',
     CustomizeHeadlines = 'customizeHeadlines',
+    /**
+     * @hidden
+     */
     PinboardInfo = 'pinboardInfo',
+    LiveboardInfo = 'pinboardInfo',
     SendAnswerFeedback = 'sendFeedback',
     /**
      * @deprecated Will be removed in next version

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

@@ -1,85 +0,0 @@
-/**
- * Copyright (c) 2021
- *
- * Embed a ThoughtSpot pinboard or visualization
- * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
- * https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
- *
- * @summary Pinboard & visualization embed
- * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
- */
-import { DOMSelector } from '../types';
-import { V1Embed, ViewConfig } from './ts-embed';
-/**
- * The configuration for the embedded pinboard or visualization page view.
- * @Category Pinboards and Charts
- */
-export interface PinboardViewConfig extends ViewConfig {
-    /**
-     * If set to true, the embedded object container dynamically resizes
-     * according to the height of the pinboard.
-     */
-    fullHeight?: boolean;
-    /**
-     * This is the minimum height(in pixels) for a full height pinboard.
-     * Setting this height helps resolves issues with empty pinboards and
-     * other screens navigable from a pinboard.
-     * @default 500
-     * * _since 1.5.0_
-     */
-    defaultHeight?: number;
-    /**
-     * If set to true, the context menu in visualizations will be enabled.
-     */
-    enableVizTransformations?: boolean;
-    /**
-     * The pinboard to display in the embedded view.
-     */
-    pinboardId: string;
-    /**
-     * The visualization within the pinboard to display.
-     */
-    vizId?: string;
-    /**
-     * If set to true, all filter chips from a
-     * pinboard page will be read-only (no X buttons)
-     */
-    preventPinboardFilterRemoval?: boolean;
-}
-/**
- * Embed a ThoughtSpot pinboard or visualization
- * @Category Pinboards and Charts
- */
-export declare class PinboardEmbed extends V1Embed {
-    protected viewConfig: PinboardViewConfig;
-    private defaultHeight;
-    constructor(domSelector: DOMSelector, viewConfig: PinboardViewConfig);
-    /**
-     * Construct a map of params to be passed on to the
-     * embedded pinboard or visualization.
-     */
-    private getEmbedParams;
-    /**
-     * Construct the URL of the embedded ThoughtSpot pinboard 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 runtimeFilters A list of runtime filters to be applied to
-     * the pinboard 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 handleRouteChangeFullHeightPinboard;
-    /**
-     * Render an embedded ThoughtSpot pinboard or visualization
-     * @param renderOptions An object specifying the pinboard ID,
-     * visualization ID and the runtime filters.
-     */
-    render(): PinboardEmbed;
-}

package/lib/src/embed/pinboard.d.ts

@@ -1,85 +0,0 @@
-/**
- * Copyright (c) 2021
- *
- * Embed a ThoughtSpot pinboard or visualization
- * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
- * https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
- *
- * @summary Pinboard & visualization embed
- * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
- */
-import { DOMSelector } from '../types';
-import { V1Embed, ViewConfig } from './ts-embed';
-/**
- * The configuration for the embedded pinboard or visualization page view.
- * @Category Pinboards and Charts
- */
-export interface PinboardViewConfig extends ViewConfig {
-    /**
-     * If set to true, the embedded object container dynamically resizes
-     * according to the height of the pinboard.
-     */
-    fullHeight?: boolean;
-    /**
-     * This is the minimum height(in pixels) for a full height pinboard.
-     * Setting this height helps resolves issues with empty pinboards and
-     * other screens navigable from a pinboard.
-     * @default 500
-     * * _since 1.5.0_
-     */
-    defaultHeight?: number;
-    /**
-     * If set to true, the context menu in visualizations will be enabled.
-     */
-    enableVizTransformations?: boolean;
-    /**
-     * The pinboard to display in the embedded view.
-     */
-    pinboardId: string;
-    /**
-     * The visualization within the pinboard to display.
-     */
-    vizId?: string;
-    /**
-     * If set to true, all filter chips from a
-     * pinboard page will be read-only (no X buttons)
-     */
-    preventPinboardFilterRemoval?: boolean;
-}
-/**
- * Embed a ThoughtSpot pinboard or visualization
- * @Category Pinboards and Charts
- */
-export declare class PinboardEmbed extends V1Embed {
-    protected viewConfig: PinboardViewConfig;
-    private defaultHeight;
-    constructor(domSelector: DOMSelector, viewConfig: PinboardViewConfig);
-    /**
-     * Construct a map of params to be passed on to the
-     * embedded pinboard or visualization.
-     */
-    private getEmbedParams;
-    /**
-     * Construct the URL of the embedded ThoughtSpot pinboard 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 runtimeFilters A list of runtime filters to be applied to
-     * the pinboard 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 handleRouteChangeFullHeightPinboard;
-    /**
-     * Render an embedded ThoughtSpot pinboard or visualization
-     * @param renderOptions An object specifying the pinboard ID,
-     * visualization ID and the runtime filters.
-     */
-    render(): PinboardEmbed;
-}

package/lib/src/embed/pinboard.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pinboard.js","sourceRoot":"","sources":["../../../src/embed/pinboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EACH,UAAU,EAEV,KAAK,GAIR,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAc,MAAM,YAAY,CAAC;AAuCjD;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,OAAO;IAKtC,kDAAkD;IAClD,YAAY,WAAwB,EAAE,UAA8B;QAChE,KAAK,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAJ3B,kBAAa,GAAG,GAAG,CAAC;QAuE5B;;;;WAIG;QACK,uBAAkB,GAAG,CAAC,IAAoB,EAAE,EAAE;YAClD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QAClE,CAAC,CAAC;QAEM,sBAAiB,GAAG,CAAC,IAAoB,EAAE,SAAc,EAAE,EAAE;YACjE,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YACnC,SAAS,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,iBAAiB,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;QACjE,CAAC,CAAC;QAEM,wCAAmC,GAAG,CAAC,IAAoB,EAAE,EAAE;YACnE,IACI,IAAI,CAAC,IAAI,CAAC,WAAW,KAAK,OAAO;gBACjC,IAAI,CAAC,IAAI,CAAC,WAAW,KAAK,UAAU,EACtC;gBACE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aAC5C;QACL,CAAC,CAAC;IAvFF,CAAC;IAED;;;OAGG;IACK,cAAc;QAClB,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACzC,MAAM,EACF,wBAAwB,EACxB,UAAU,EACV,4BAA4B,EAC5B,aAAa,GAChB,GAAG,IAAI,CAAC,UAAU,CAAC;QAEpB,IAAI,UAAU,KAAK,IAAI,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;SACnC;QACD,IAAI,aAAa,EAAE;YACf,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;SACtC;QACD,IAAI,wBAAwB,KAAK,SAAS,EAAE;YACxC,MAAM,CACF,KAAK,CAAC,wBAAwB,CACjC,GAAG,wBAAwB,CAAC,QAAQ,EAAE,CAAC;SAC3C;QACD,IAAI,4BAA4B,EAAE;YAC9B,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,GAAG,IAAI,CAAC;SACrD;QACD,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;QACrC,MAAM,WAAW,GAAG,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAEtD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACK,YAAY,CAChB,UAAkB,EAClB,KAAc,EACd,cAAgC;QAEhC,MAAM,WAAW,GAAG,cAAc,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC;aACzC,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;QACf,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAChC,WAAW,EACX,IAAI,EACJ,KAAK,EACL,KAAK,CACR,QAAQ,UAAU,EAAE,CAAC;QACtB,IAAI,KAAK,EAAE;YACP,GAAG,GAAG,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;SAC3B;QAED,OAAO,GAAG,CAAC;IACf,CAAC;IAyBD;;;;OAIG;IACI,MAAM;QACT,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;QAE9D,IAAI,CAAC,UAAU,IAAI,CAAC,KAAK,EAAE;YACvB,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC;SAC9D;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,KAAK,IAAI,EAAE;YACrC,IAAI,CAAC,EAAE,CACH,UAAU,CAAC,WAAW,EACtB,IAAI,CAAC,mCAAmC,CAC3C,CAAC;YACF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACzD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;SACjE;QAED,KAAK,CAAC,MAAM,EAAE,CAAC;QAEf,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QACjE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAExB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}