@thoughtspot/visual-embed-sdk 1.17.0-alpha.1 → 1.17.0-alpha.2

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

@@ -55,5 +55,5 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
  * Renders functions in a queue, resolves to next function only after the callback next is called
  * @param fn The function being registered
  */
-export declare const renderInQueue: (fn: (next?: (val?: any) => void) => void) => void;
+export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
 export declare function reset(): void;

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

@@ -0,0 +1,91 @@
+/**
+ * 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/embed/ts-embed.d.ts

@@ -144,12 +144,6 @@ export declare class TsEmbed {
     private shouldEncodeUrlQueryParams;
     private defaultHiddenActions;
     constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
-    /**
-     * Gets a reference to the root DOM node where
-     * the embedded content will appear.
-     * @param domSelector
-     */
-    private getDOMNode;
     /**
      * Throws error encountered during initialization.
      */
@@ -214,7 +208,7 @@ export declare class TsEmbed {
      * @param url
      * @param frameOptions
      */
-    protected renderIFrame(url: string, frameOptions?: FrameParams): void;
+    protected renderIFrame(url: string, frameOptions?: FrameParams): Promise<any>;
     /**
      * Sets the height of the iframe
      * @param height The height in pixels
@@ -302,6 +296,6 @@ export declare class V1Embed extends TsEmbed {
      * Render the app in an iframe and set up event handlers
      * @param iframeSrc
      */
-    protected renderV1Embed(iframeSrc: string): void;
+    protected renderV1Embed(iframeSrc: string): any;
     on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
 }

package/dist/src/test/test-utils.d.ts

@@ -1,3 +1,6 @@
+export declare const defaultParamsWithoutHiddenActions: string;
+export declare const defaultParams: string;
+export declare const defaultParamsForPinboardEmbed: string;
 export declare const getDocumentBody: () => string;
 declare type DOMElement = HTMLElement | Document;
 export declare const getRootEl: () => HTMLElement;
@@ -5,6 +8,7 @@ export declare const getRootEl2: () => HTMLElement;
 export declare const getIFrameEl: (container?: DOMElement) => HTMLIFrameElement;
 export declare const getAllIframeEl: () => NodeListOf<HTMLIFrameElement>;
 export declare const getIFrameSrc: (container?: DOMElement) => string;
+export declare const waitFor: (fn: () => boolean) => Promise<void>;
 /**
  * jsdom does not set event source, therefore we do it
  * programmatically and use dispatchEvent instead of the

package/dist/src/types.d.ts

@@ -15,23 +15,52 @@ export declare enum AuthType {
      * No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
      */
     None = "None",
+    /**
+     * Passthrough SSO to the embedded App within the iframe. Requires least configuration, but may not
+     * be supported by all IDPs. This will behave like `None` if SSO is not configured on ThoughtSpot.
+     * @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
+     */
+    EmbeddedSSO = "EmbeddedSSO",
     /**
      * SSO using SAML
-     * @deprecated Use {@link SAML} instead
+     * @deprecated Use {@link SAMLRedirect} instead
+     * @hidden
      */
     SSO = "SSO_SAML",
     /**
      * SSO using SAML
+     * @deprecated Use {@link SAMLRedirect} instead
+     * @hidden
      */
     SAML = "SSO_SAML",
+    /**
+     * SSO using SAML
+     * Will make the host application redirect to the SAML Idp.
+     */
+    SAMLRedirect = "SSO_SAML",
     /**
      * SSO using OIDC
+     * @hidden
+     * @deprecated Use {@link OIDCRedirect} instead
      */
     OIDC = "SSO_OIDC",
+    /**
+     * SSO using OIDC
+     * Will make the host application redirect to the OIDC Idp.
+     */
+    OIDCRedirect = "SSO_OIDC",
     /**
      * Trusted authentication server
+     * @hidden
+     * @deprecated Use {@link TrustedAuth} instead
      */
     AuthServer = "AuthServer",
+    /**
+     * Trusted authentication server, Use you own authentication server
+     * which returns a bearer token, generated using the secret_key obtained from
+     * ThoughtSpot.
+     */
+    TrustedAuthToken = "AuthServer",
     /**
      * Use the ThoughtSpot login API to authenticate to the cluster directly.
      *
@@ -198,6 +227,20 @@ export interface EmbedConfig {
      * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
      */
     customisations?: CustomisationsInterface;
+    /**
+     * For noRedirect SSO Auth, we need a button which the user
+     * click to trigger the flow. This is the containing element
+     * for that button.
+     *
+     * @version SDK: 1.17.0 | ThoughtSpot: *
+     */
+    authTriggerContainer?: string | HTMLElement;
+    /**
+     * Text to show in the button which triggers the popup auth flow.
+     * Default: "Authorize".
+     * @version SDK: 1.17.0 | ThoughtSpot: *
+     */
+    authTriggerText?: string;
 }
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -624,16 +667,25 @@ export declare enum EmbedEvent {
 export declare enum HostEvent {
     /**
      * Trigger a search
-     * @param dataSourceIds - The list of data source GUIDs
-     * @param searchQuery - The search query
+     * @param - dataSourceIds - The list of data source GUIDs
+     * @param - searchQuery - The search query
+     * @example
+     * searchEmbed.trigger(HostEvent.Search, {
+     * searchQuery: "[sales] by [item type],
+     * "dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
+     * })
      */
     Search = "search",
     /**
      * Trigger a drill on certain points by certain column
-     * @param points - an object containing selectedPoints/clickedPoints
+     * @param - points - an object containing selectedPoints/clickedPoints
      *              eg. { selectedPoints: []}
-     * @param columnGuid - a string guid of the column to drill by. This is optional,
+     * @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.
+     * @example searchEmbed.trigger(HostEvent.DrillDown, {
+     * points: clickedPointData,
+     * autoDrillDown: true,
+     * })
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      */
     DrillDown = "triggerDrillDown",
@@ -651,6 +703,8 @@ export declare 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.
+     * @example
+     * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['730496d6-6903-4601-937e-2c691821af3c', 'd547ec54-2a37-4516-a222-2b06719af726'])
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     SetVisibleVizs = "SetPinboardVisibleVizs",
@@ -658,18 +712,25 @@ export declare enum HostEvent {
      * 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.
+     * @example
+     * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
+     * {columnName: "state",operator: "EQ",values: ["michigan"]},
+     * {columnName: "item type",operator: "EQ",values: ["Jackets"]}
+     * ])
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     UpdateRuntimeFilters = "UpdateRuntimeFilters",
     /**
      * Navigate to a specific page in App embed without any reload.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`
-     * @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
+     * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
+     * @example appEmbed.navigateToPage(-1)
      * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
      */
     Navigate = "Navigate",
     /**
      * Gets the current pinboard content.
+     * @example liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
      */
     getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
@@ -677,70 +738,82 @@ export declare enum HostEvent {
      * Triggers the Pin action on an embedded object
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
+     * @example liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Pin = "pin",
     /**
      * Triggers the Show Liveboard details action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.LiveboardInfo)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     LiveboardInfo = "pinboardInfo",
     /**
      * Triggers the Schedule action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.Schedule)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Schedule = "subscription",
     /**
      * Triggers the Manage schedule action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.ScheduleList)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     SchedulesList = "schedule-list",
     /**
      * Triggers the Export TML action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.ExportTML)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     ExportTML = "exportTSL",
     /**
      * Triggers the Edit TML action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.EditTML)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EditTML = "editTSL",
     /**
      * Triggers the Update TML action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.UpdateTML)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     UpdateTML = "updateTSL",
     /**
      * Triggers the Download PDF action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     DownloadAsPdf = "downloadAsPdf",
     /**
      * Triggers the Make a copy action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.MakeACopy)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     MakeACopy = "makeACopy",
     /**
      * Triggers the Delete action on a Liveboard
+     * @example appEmbed.trigger(HostEvent.Remove)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Remove = "delete",
     /**
      * Triggers the Explore action on a visualization
      * @param - an object with vizId as a key
-     * eg: {vizId: '730496d6-6903-4601-937e-2c691821af3c'}
+     * @example liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Explore = "explore",
     /**
      * Triggers the Create alert action on a visualization
      * @param - an object with vizId as a key
+     * @example liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     CreateMonitor = "createMonitor",
     /**
      * Triggers the Manage alert action on a visualization
      * @param - an object with vizId as a key
+     * @example liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     ManageMonitor = "manageMonitor",
@@ -776,9 +849,26 @@ export declare enum HostEvent {
     Present = "present",
     /**
      * Get TML for the current search.
+     * @example searchEmbed.trigger(HostEvent.GetTML)
      * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
      */
-    GetTML = "getTML"
+    GetTML = "getTML",
+    /**
+     * Triggers the Share action on a liveboard or answer
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Share)
+     * searchEmbed.trigger(HostEvent.Share)
+     * @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
+     */
+    Share = "share",
+    /**
+     * Trigger the Save action on a liveboard or answer
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Save)
+     * searchEmbed.trigger(HostEvent.Save)
+     * @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
+     */
+    Save = "save"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -834,7 +924,9 @@ export declare enum Param {
     LiveboardV2Enabled = "isPinboardV2Enabled",
     ShowAlerts = "showAlerts",
     Locale = "locale",
-    CustomStyle = "customStyle"
+    CustomStyle = "customStyle",
+    ForceSAMLAutoRedirect = "forceSAMLAutoRedirect",
+    AuthType = "authType"
 }
 /**
  * The list of actions that can be performed on visual ThoughtSpot

package/dist/src/utils.d.ts

@@ -6,7 +6,7 @@
  * @summary Utils
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { EmbedConfig, QueryParams, RuntimeFilter, CustomisationsInterface } from './types';
+import { EmbedConfig, QueryParams, RuntimeFilter, CustomisationsInterface, DOMSelector } from './types';
 /**
  * Construct a runtime filters query string from the given filters.
  * Refer to the following docs for more details on runtime filter syntax:
@@ -44,3 +44,9 @@ export declare const setAttributes: (element: HTMLElement, attributes: {
 }) => void;
 export declare const checkReleaseVersionInBeta: (releaseVersion: string, suppressBetaWarning: boolean) => boolean;
 export declare const getCustomisations: (embedConfig: EmbedConfig) => CustomisationsInterface;
+/**
+ * Gets a reference to the DOM node given
+ * a selector.
+ * @param domSelector
+ */
+export declare function getDOMNode(domSelector: DOMSelector): HTMLElement;

package/dist/src/v1/api.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 };