@thoughtspot/visual-embed-sdk 1.10.0 → 1.10.3

package/dist/src/auth.d.ts

@@ -10,7 +10,19 @@ export declare const EndPoints: {
     OIDC_LOGIN_TEMPLATE: (targetUrl: string) => string;
     TOKEN_LOGIN: string;
     BASIC_LOGIN: string;
+    LOGOUT: string;
 };
+export declare enum AuthFailureType {
+    SDK = "SDK",
+    NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
+    EXPIRY = "EXPIRY",
+    OTHER = "OTHER"
+}
+export declare enum AuthStatus {
+    FAILURE = "FAILURE",
+    SUCCESS = "SUCCESS",
+    LOGOUT = "LOGOUT"
+}
 /**
  * Return sessionInfo if available else make a loggedIn check to fetch the sessionInfo
  */
@@ -20,7 +32,7 @@ export declare function initSession(sessionDetails: any): void;
  * Perform token based authentication
  * @param embedConfig The embed configuration
  */
-export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<void>;
+export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
 /**
  * Perform basic authentication to the ThoughtSpot cluster using the cluster
  * credentials.
@@ -29,14 +41,15 @@ export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<void>;
  * strongly advised not to use this authentication method in production.
  * @param embedConfig The embed configuration
  */
-export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<void>;
-export declare const doSamlAuth: (embedConfig: EmbedConfig) => Promise<void>;
-export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<void>;
+export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
+export declare const doSamlAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
+export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
+export declare const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
 /**
  * Perform authentication on the ThoughtSpot cluster
  * @param embedConfig The embed configuration
  */
-export declare const authenticate: (embedConfig: EmbedConfig) => Promise<void>;
+export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
 /**
  * Check if we are authenticated to the ThoughtSpot cluster
  */

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

@@ -1,11 +1,24 @@
+/**
+ * Copyright (c) 2022
+ *
+ * Base classes
+ *
+ * @summary Base classes
+ * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+ */
+import EventEmitter from 'eventemitter3';
 import { EmbedConfig } from '../types';
-export declare let authPromise: Promise<void>;
+import { AuthFailureType } from '../auth';
+export declare let authPromise: Promise<boolean>;
+export declare const getEmbedConfig: () => EmbedConfig;
+export declare const getAuthPromise: () => Promise<boolean>;
+export declare function notifyAuthSuccess(): void;
+export declare function notifyAuthFailure(failureType: AuthFailureType): void;
+export declare function notifyLogout(): void;
 /**
  * Perform authentication on the ThoughtSpot app as applicable.
  */
-export declare const handleAuth: () => Promise<void>;
-export declare const getEmbedConfig: () => EmbedConfig;
-export declare const getAuthPromise: () => Promise<void>;
+export declare const handleAuth: () => Promise<boolean>;
 /**
  * Prefetches static resources from the specified URL. Web browsers can then cache the prefetched resources and serve them from the user's local disk to provide faster access to your app.
  * @param url The URL provided for prefetch
@@ -17,11 +30,28 @@ export declare const prefetch: (url?: string) => void;
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.
  *
- * @returns authPromise Promise which resolves when authentication is complete.
+ * eg: authStatus = init(config);
+ * authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
+ *
+ * @returns event emitter which emits events on authentication success, failure and logout. {@link AuthStatus}
+ */
+export declare const init: (embedConfig: EmbedConfig) => EventEmitter;
+export declare function disableAutoLogin(): void;
+/**
+ * Logout from ThoughtSpot. This also sets the autoLogin flag to false, to prevent
+ * the SDK from automatically logging in again.
+ *
+ * You can call the `init` method again to re login, if autoLogin is set to true in this
+ * second call it will be honored.
+ *
+ * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
+ * @returns Promise which resolves when logout completes.
+ * @version SDK: 1.10.1 | ThoughtSpot: *
  */
-export declare const init: (embedConfig: EmbedConfig) => Promise<void>;
+export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
 /**
  * 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 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/index.d.ts

@@ -8,8 +8,9 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 import { AppEmbed, Page, AppViewConfig } from './embed/app';
-import { init, prefetch } from './embed/base';
+import { init, prefetch, logout } from './embed/base';
 import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from './embed/liveboard';
 import { SearchEmbed, SearchViewConfig } from './embed/search';
+import { AuthFailureType, AuthStatus } from './auth';
 import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig } from './types';
-export { init, prefetch, SearchEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, SearchViewConfig, LiveboardViewConfig, AppViewConfig, };
+export { init, logout, prefetch, SearchEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, SearchViewConfig, LiveboardViewConfig, AppViewConfig, };

package/dist/src/types.d.ts

@@ -90,6 +90,15 @@ export interface EmbedConfig {
      * @default false
      */
     noRedirect?: boolean;
+    /**
+     * [SSO] For SSO Authentication, one can supply an optional path param,
+     * this will be the path on the host origin where the SAML flow will be
+     * terminated.
+     *
+     * Eg: "/dashboard", "#/foo" [Do not include the host]
+     * @version SDK: 1.10.2 | ThoughtSpot: *
+     */
+    redirectPath?: string;
     /** @internal */
     basepath?: string;
     /**
@@ -119,6 +128,11 @@ export interface EmbedConfig {
      * @default false
      */
     disableLoginRedirect?: boolean;
+    /**
+     * This message is displayed on the embed view when the login fails.
+     * @version 1.10.1 | ThoughtSpot: *
+     */
+    loginFailedMessage?: string;
     /**
      * Calls the prefetch method internally when set to true
      * @default false
@@ -332,6 +346,16 @@ export declare enum EmbedEvent {
      * The ThoughtSpot auth session has expired.
      */
     AuthExpire = "ThoughtspotAuthExpired",
+    /**
+     * ThoughtSpot failed to validate the auth session.
+     * @hidden
+     */
+    AuthFailure = "ThoughtspotAuthFailure",
+    /**
+     * ThoughtSpot failed to validate the auth session.
+     * @hidden
+     */
+    AuthLogout = "ThoughtspotAuthLogout",
     /**
      * The height of the embedded Liveboard or visualization has been computed.
      * @return data - The height of the embedded Liveboard or visualization

package/dist/src/utils/authService.d.ts

@@ -2,3 +2,4 @@ export declare function fetchSessionInfoService(authVerificationUrl: string): Pr
 export declare function fetchAuthTokenService(authEndpoint: string): Promise<any>;
 export declare function fetchAuthService(thoughtSpotHost: string, username: string, authToken: string): Promise<any>;
 export declare function fetchBasicAuthService(thoughtSpotHost: string, username: string, password: string): Promise<any>;
+export declare function fetchLogoutService(thoughtSpotHost: string): Promise<any>;

package/dist/src/utils/processData.d.ts

@@ -1,3 +1,3 @@
 import { EmbedEvent } from '../types';
 export declare function processCustomAction(e: any, thoughtSpotHost: string): any;
-export declare function getProcessData(type: EmbedEvent, e: any, thoughtSpotHost: string): any;
+export declare function processEventData(type: EmbedEvent, e: any, thoughtSpotHost: string, containerEl: Element): any;

package/dist/src/utils.d.ts

@@ -32,6 +32,7 @@ export declare const getCssDimension: (value: number | string) => string;
  * @param stringToAppend The string to append to the URL hash
  */
 export declare const appendToUrlHash: (url: string, stringToAppend: string) => string;
+export declare function getRedirectUrl(url: string, stringToAppend: string, path?: string): string;
 export declare const getEncodedQueryParamsString: (queryString: string) => string;
 export declare const getOffsetTop: (element: any) => any;
 export declare const embedEventStatus: {

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 };