@thoughtspot/visual-embed-sdk 1.8.0 → 1.9.0

package/src/react/index.spec.tsx

@@ -31,7 +31,7 @@ describe('React Components', () => {
             await waitFor(() => getIFrameEl(container));
 
             expect(getIFrameSrc(container)).toBe(
-                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22editACopy%22,%22saveAsView%22]&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`,
+                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`,
             );
         });
 

package/src/types.ts

@@ -140,6 +140,7 @@ export interface EmbedConfig {
 
     /**
      * Dynamic CSS Url to be injected in the loaded application.
+     * You would also need to set `style-src` in the CSP settings.
      * @version 1.6.0 or later
      * @default ''
      */
@@ -287,6 +288,12 @@ export enum EmbedEvent {
      * @return dataSourceIds - the list of data sources
      */
     DataSourceSelected = 'dataSourceSelected',
+    /**
+     * One or more data columns have been selected.
+     * @return columnIds - the list of columns
+     * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl
+     */
+    AddRemoveColumns = 'addRemoveColumns',
     /**
      * A custom action has been triggered
      * @return actionId - The id of the custom action
@@ -401,9 +408,10 @@ export enum HostEvent {
      */
     SetVisibleVizs = 'SetPinboardVisibleVizs',
     /**
-     * Update the runtime filters
+     * Update the runtime filters. The runtime filters passed here are extended
+     * on to the existing runtime filters if they exist.
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
-     * @version 1.8.0 or later
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
      */
     UpdateRuntimeFilters = 'UpdateRuntimeFilters',
 }
@@ -513,10 +521,6 @@ export enum Action {
     PinboardInfo = 'pinboardInfo',
     LiveboardInfo = 'pinboardInfo',
     SendAnswerFeedback = 'sendFeedback',
-    /**
-     * @deprecated Will be removed in next version
-     */
-    CustomAction = 'customAction',
     DownloadEmbraceQueries = 'downloadEmbraceQueries',
     Pin = 'pin',
     AnalysisInfo = 'analysisInfo',
@@ -532,6 +536,26 @@ export enum Action {
     DrillDown = 'DRILL',
     RequestAccess = 'requestAccess',
     QueryDetailsButtons = 'queryDetailsButtons',
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
+     */
+    Monitor = 'createMonitor',
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
+     */
+    AnswerDelete = 'onDeleteAnswer',
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
+     */
+    AnswerChartSwitcher = 'answerChartSwitcher',
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
+     */
+    AddToFavorites = 'addToFavorites',
+    /**
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
+     */
+    EditDetails = 'editDetails',
 }
 
 export interface SessionInterface {

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

@@ -1,91 +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;
-    /**
-     * An array of vizids which should be visible when this pinboard loads.
-     * The ids not in this array are hidden from the pinboard.
-     * _since: 1.6.0_
-     */
-    pinboardVisibleVizs?: string[];
-}
-/**
- * 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/dist/src/v1/api.d.ts

@@ -1,19 +0,0 @@
-/**
- * Copyright: ThoughtSpot Inc. 2012-2016
- * Author: Shashank Singh (sunny@thoughtspot.com)
- *
- * @fileoverview ThoughtSpot Javascript API for use of ThoughtSpot in external webpages.
- */
-import { AuthType } from '../types';
-export declare enum Events {
-    THOUGHTSPOT_AUTH_EXPIRED = "ThoughtspotAuthExpired",
-    EXPORT_VIZ_DATA_TO_PARENT = "exportVizDataToParent",
-    ALERT = "alert",
-    EXPORT_VIZ_DATA_TO_CHILD = "exportVizDataToChild",
-    GET_DATA = "getData"
-}
-declare type Callback = (...args: any[]) => void;
-declare function checkIfLoggedIn(tsHost: string, callback: Callback): void;
-declare function initialize(onInitialized: Callback, onAuthExpiration: Callback, _thoughtspotHost: string, authType: AuthType): void;
-declare function notifyOnAuthExpiration(): void;
-export { initialize, checkIfLoggedIn, notifyOnAuthExpiration };

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

@@ -1,91 +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;
-    /**
-     * An array of vizids which should be visible when this pinboard loads.
-     * The ids not in this array are hidden from the pinboard.
-     * _since: 1.6.0_
-     */
-    pinboardVisibleVizs?: string[];
-}
-/**
- * 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

@@ -1,110 +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 { ERROR_MESSAGE } from '../errors';
-import { EmbedEvent, Param, } from '../types';
-import { getFilterQuery, getQueryParamString } from '../utils';
-import { V1Embed } from './ts-embed';
-/**
- * Embed a ThoughtSpot pinboard or visualization
- * @Category Pinboards and Charts
- */
-export class PinboardEmbed extends V1Embed {
-    // eslint-disable-next-line no-useless-constructor
-    constructor(domSelector, viewConfig) {
-        super(domSelector, viewConfig);
-        this.defaultHeight = 500;
-        /**
-         * Set the iframe height as per the computed height received
-         * from the ThoughtSpot app.
-         * @param data The event payload
-         */
-        this.updateIFrameHeight = (data) => {
-            this.setIFrameHeight(Math.max(data.data, this.defaultHeight));
-        };
-        this.embedIframeCenter = (data, responder) => {
-            const obj = this.getIframeCenter();
-            responder({ type: EmbedEvent.EmbedIframeCenter, data: obj });
-        };
-        this.handleRouteChangeFullHeightPinboard = (data) => {
-            if (data.data.canvasState !== 'EMBED' &&
-                data.data.canvasState !== 'pinboard') {
-                this.setIFrameHeight(this.defaultHeight);
-            }
-        };
-    }
-    /**
-     * Construct a map of params to be passed on to the
-     * embedded pinboard or visualization.
-     */
-    getEmbedParams() {
-        const params = this.getBaseQueryParams();
-        const { enableVizTransformations, fullHeight, preventPinboardFilterRemoval, defaultHeight, pinboardVisibleVizs, } = this.viewConfig;
-        if (fullHeight === true) {
-            params[Param.fullHeight] = true;
-        }
-        if (defaultHeight) {
-            this.defaultHeight = defaultHeight;
-        }
-        if (enableVizTransformations !== undefined) {
-            params[Param.EnableVizTransformations] = enableVizTransformations.toString();
-        }
-        if (preventPinboardFilterRemoval) {
-            params[Param.preventPinboardFilterRemoval] = true;
-        }
-        if (pinboardVisibleVizs) {
-            params[Param.PinboardVisibleVizs] = pinboardVisibleVizs;
-        }
-        params[Param.livedBoardEmbed] = true;
-        const queryParams = getQueryParamString(params, true);
-        return queryParams;
-    }
-    /**
-     * 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.
-     */
-    getIFrameSrc(pinboardId, 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}`;
-        if (vizId) {
-            url = `${url}/${vizId}`;
-        }
-        return url;
-    }
-    /**
-     * Render an embedded ThoughtSpot pinboard or visualization
-     * @param renderOptions An object specifying the pinboard 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);
-        }
-        if (this.viewConfig.fullHeight === true) {
-            this.on(EmbedEvent.RouteChange, this.handleRouteChangeFullHeightPinboard);
-            this.on(EmbedEvent.EmbedHeight, this.updateIFrameHeight);
-            this.on(EmbedEvent.EmbedIframeCenter, this.embedIframeCenter);
-        }
-        super.render();
-        const src = this.getIFrameSrc(pinboardId, vizId, runtimeFilters);
-        this.renderV1Embed(src);
-        return this;
-    }
-}
-//# sourceMappingURL=pinboard.js.map

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;AA6CjD;;;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;QA2E5B;;;;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;IA3FF,CAAC;IAED;;;OAGG;IACK,cAAc;QAClB,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACzC,MAAM,EACF,wBAAwB,EACxB,UAAU,EACV,4BAA4B,EAC5B,aAAa,EACb,mBAAmB,GACtB,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,IAAI,mBAAmB,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC;SAC3D;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"}

package/lib/src/utils/plugin.js

@@ -1 +0,0 @@
-//# sourceMappingURL=plugin.js.map

package/lib/src/utils/plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../src/utils/plugin.ts"],"names":[],"mappings":""}