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

package/src/types.ts

@@ -21,6 +21,10 @@ export enum AuthType {
      * SSO using SAML
      */
     SSO = 'SSO_SAML',
+    /**
+     * SSO using OIDC
+     */
+    OIDC = 'SSO_OIDC',
     /**
      * Trusted authentication server
      */
@@ -124,14 +128,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 _
+     * @version 1.5.0 or later
      * @default false
      */
     queueMultiRenders?: boolean;
 
     /**
      * Dynamic CSS Url to be injected in the loaded application.
-     * * _Version 1.6.0 or later _
+     * @version 1.6.0 or later
      * @default ''
      */
     customCssUrl?: string;
@@ -287,7 +291,7 @@ export enum EmbedEvent {
     /**
      * A double click has been triggered on table/chart
      * @return ContextMenuInputPoints - data point that is double clicked
-     * * _Version 1.5.0 or later _
+     * @version 1.5.0 or later
      */
     VizPointDoubleClick = 'vizPointDoubleClick',
     /**
@@ -329,7 +333,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 +344,12 @@ export enum EmbedEvent {
     SAMLComplete = 'samlComplete',
     /**
      * Emitted when any modal is opened in the app
-     * * _Version 1.6.0 or later _
+     * @version 1.6.0 or later
      */
     DialogOpen = 'dialog-open',
     /**
      * Emitted when any modal is closed in the app
-     * * _Version 1.6.0 or later _
+     * @version 1.6.0 or later
      */
     DialogClose = 'dialog-close',
 }
@@ -368,7 +372,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. \
-     * * _Version 1.5.0 or later _
+     * @version 1.5.0 or later
      */
     DrillDown = 'triggerDrillDown',
     /**
@@ -385,7 +389,7 @@ export enum HostEvent {
      * Set the visible visualizations on a Liveboard.
      * @param - an array of ids of visualizations to show, the ids not passed
      *          will be hidden.
-     * * _Version 1.6.0 or later _
+     * @version 1.6.0 or later
      */
     SetVisibleVizs = 'SetPinboardVisibleVizs',
 }
@@ -418,6 +422,7 @@ export enum DataSourceVisualMode {
 export enum Param {
     DataSources = 'dataSources',
     DataSourceMode = 'dataSourceMode',
+    ExpandAllDataSource = 'expandAllDataSource',
     DisableActions = 'disableAction',
     DisableActionReason = 'disableHint',
     ForceTable = 'forceTable',

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

@@ -1,107 +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, } = 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;
-        }
-        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;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"}

package/lib/src/utils/fetchAnswers.d.ts

@@ -1,3 +0,0 @@
-import { SessionInterface } from '../types';
-declare function FetchAnswers(session: SessionInterface, query: string, operation: string, thoughtSpotHost: string): any;
-export default FetchAnswers;

package/lib/src/utils/fetchAnswers.js

@@ -1,49 +0,0 @@
-import { OperationType } from '../types';
-function FetchAnswers(session, query, operation, thoughtSpotHost) {
-    let variable;
-    const fetchQuery = async (variables) => {
-        try {
-            const response = await fetch(`${thoughtSpotHost}/prism/?op=${operation}`, {
-                method: 'POST',
-                headers: {
-                    'content-type': 'application/json;charset=UTF-8',
-                    'x-requested-by': 'ThoughtSpot',
-                    accept: '*/*',
-                    'accept-language': 'en-us',
-                },
-                body: JSON.stringify({
-                    operationName: operation,
-                    query,
-                    variables,
-                }),
-                credentials: 'include'
-            });
-            const result = await response.json();
-            return result.data;
-        }
-        catch (error) {
-            return error;
-        }
-    };
-    const getAnswer = (offset, batchSize) => {
-        if (operation === OperationType.GetChartWithData) {
-            variable = { batchSize, offset };
-        }
-        else {
-            variable = {
-                dataPaginationParams: {
-                    isClientPaginated: true,
-                    offset,
-                    size: batchSize,
-                },
-            };
-        }
-        return fetchQuery({
-            session,
-            ...variable,
-        });
-    };
-    return getAnswer;
-}
-export default FetchAnswers;
-//# sourceMappingURL=fetchAnswers.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"fetchAnswers.js","sourceRoot":"","sources":["../../../src/utils/fetchAnswers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,aAAa,EAAE,MAAM,UAAU,CAAC;AAE3D,SAAS,YAAY,CACjB,OAAyB,EACzB,KAAa,EACb,SAAiB,EACjB,eAAuB;IAEvB,IAAI,QAAa,CAAC;IAElB,MAAM,UAAU,GAAG,KAAK,EAAE,SAAc,EAAE,EAAE;QACxC,IAAI;YACA,MAAM,QAAQ,GAAG,MAAM,KAAK,CACxB,GAAG,eAAe,cAAc,SAAS,EAAE,EAC3C;gBACI,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACL,cAAc,EAAE,gCAAgC;oBAChD,gBAAgB,EAAE,aAAa;oBAC/B,MAAM,EAAE,KAAK;oBACb,iBAAiB,EAAE,OAAO;iBAC7B;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACjB,aAAa,EAAE,SAAS;oBACxB,KAAK;oBACL,SAAS;iBACZ,CAAC;gBACF,WAAW,EAAE,SAAS;aACzB,CACA,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACrC,OAAO,MAAM,CAAC,IAAI,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,KAAK,CAAC;SAChB;IACL,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,SAAiB,EAAE,EAAE;QACpD,IAAI,SAAS,KAAK,aAAa,CAAC,gBAAgB,EAAE;YAC9C,QAAQ,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;SACpC;aAAM;YACH,QAAQ,GAAG;gBACP,oBAAoB,EAAE;oBAClB,iBAAiB,EAAE,IAAI;oBACvB,MAAM;oBACN,IAAI,EAAE,SAAS;iBAClB;aACJ,CAAC;SACL;QACD,OAAO,UAAU,CAAC;YACd,OAAO;YACP,GAAG,QAAQ;SACd,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,eAAe,YAAY,CAAC"}