@thoughtspot/visual-embed-sdk 1.11.0-auth.7 → 1.11.0

package/CHANGELOG.md

@@ -7,6 +7,28 @@ This project follows Semantic Versioning.
 
 ### New Features
 - Events for all actions on Search Embed
+
+## 1.10.4 (05-06-2022)
+### New Features
+- Config option `detectCookieAccessSlow` when doing Basic|AuthServer auth. [Ref doc](https://developers.thoughtspot.com/docs/typedoc/interfaces/EmbedConfig.html#detectCookieAccessSlow)
+
+## 1.10.3 (05-04-2022)
+### Fixed
+- `logout` method works consistently on multiple TS releases  
+
+## 1.10.2 (05-01-2022)
+### New features
+- Ability to configure `redirectPath` on the origin when using SSO auth. [Ref doc](https://developers.thoughtspot.com/docs/typedoc/interfaces/EmbedConfig.html#redirectPath)
+
+## 1.10.1 (05-01-2022)
+
+### New features
+- `logout` method exposed from the SDK. This can be used to log the user out. [Ref doc](https://developers.thoughtspot.com/docs/typedoc/modules.html#logout)
+
+### Updated
+- When login fails the user is presented with a `Not logged in` message, which is configurable using `loginFailedMessage` property on `init`. [Ref doc](https://developers.thoughtspot.com/docs/typedoc/interfaces/EmbedConfig.html#loginFailedMessage)
+- `init` now returns a event emitter which can be used to listen to Login `failures` and `success`. [Ref doc](https://developers.thoughtspot.com/docs/typedoc/modules.html#init)
+
 ## 1.10.0 (04-22-2022)
 
 - Release to support TS version 8.2.0.cl
@@ -26,12 +48,12 @@ This project follows Semantic Versioning.
 
 ## 1.9.3 (03-22-2022)
 
-### New Features 
+### New Features
 - `disableLoginRedirect` option in `EmbedConfig`
 
 ## 1.9.2 (03-17-2022)
 
-### New Features 
+### New Features
 - Ability to trigger events on React components
   - Added new `useEmbedRef` hook, check README for usage.
 

package/README.md

@@ -4,11 +4,22 @@
 
 <br/>
 
-# ThoughtSpot Visual Embed SDK <br/> [![Coverage Status](https://coveralls.io/repos/github/ts-blink/embed-sdk/badge.svg?branch=main)](https://coveralls.io/github/ts-blink/embed-sdk?branch=main) ![npm (scoped with tag)](https://img.shields.io/npm/v/@thoughtspot/visual-embed-sdk) [![](https://data.jsdelivr.com/v1/package/npm/@thoughtspot/visual-embed-sdk/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@thoughtspot/visual-embed-sdk) ![npm](https://img.shields.io/npm/dm/@thoughtspot/visual-embed-sdk?label=npm%20downloads&style=flat-square)
+# ThoughtSpot Visual Embed SDK <br/> [![Coverage Status](https://coveralls.io/repos/github/ts-blink/embed-sdk/badge.svg?branch=main)](https://coveralls.io/github/ts-blink/embed-sdk?branch=main) ![npm (scoped with tag)](https://img.shields.io/npm/v/@thoughtspot/visual-embed-sdk) [![](https://data.jsdelivr.com/v1/package/npm/@thoughtspot/visual-embed-sdk/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@thoughtspot/visual-embed-sdk) ![npm](https://img.shields.io/npm/dm/@thoughtspot/visual-embed-sdk?label=npm%20downloads&style=flat-square) [![Featured on Openbase](https://badges.openbase.com/js/featured/@thoughtspot/visual-embed-sdk.svg?token=IoqZUwE8aX7LYNedeuBLM2w5Wt52hu+Dh0eyKjlpC0E=)](https://openbase.com/js/@thoughtspot/visual-embed-sdk?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@thoughtspot/visual-embed-sdk?style=flat-square)
+
 
 SDK to embed ThoughtSpot into your web apps.
 
-<br/>
+   * [Usage](#usage)
+   * [Live Playground](#live-playground)
+   * [Full API Reference](#full-api-reference)
+   * [Quick Start](#quick-start)
+      * [Embedded Search](#embedded-search)
+      * [Embedded Liveboard &amp; Visualization](#embedded-liveboard--visualization)
+      * [Embedded Full App](#embedded-full-app)
+      * [Triggering and Listening to events](#triggering-and-listening-to-events)
+   * [React Components](#react-components)
+      * [Search Component](#search-component)
+      * [Triggering events on React components](#triggering-events-on-react-components--version-192)
 
 ## Usage
 
@@ -30,6 +41,7 @@ import { LiveboardEmbed } from '@thoughtspot/visual-embed-sdk';
 
 // NPM <script>
 <script src="https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.js"></script>;
+// Make the SDK available on global namespace window.tsembed
 
 // ES6 from web
 import {
@@ -52,6 +64,7 @@ Start a [free trial](https://www.thoughtspot.com/trial?tsref=trialtse) on your o
 
 -   Detailed [developer guide](https://try-everywhere.thoughtspot.cloud/v2/#/everywhere/documentation/en/?pageid=getting-started).
 -   Please visit our [API reference docs](https://developers.thoughtspot.com/docs/typedoc/modules.html).
+-   Comprehensive [CodeSandbox](https://codesandbox.io/s/big-tse-react-demo-i4g9xi?file=/src/App.tsx)
 
 <br/>
 

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
  */
@@ -32,6 +44,7 @@ export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>
 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

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';
+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<boolean>;
-export declare const getEmbedConfig: () => EmbedConfig;
-export declare const getAuthPromise: () => 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<boolean>;
+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/search.d.ts

@@ -44,6 +44,10 @@ export interface SearchViewConfig extends ViewConfig {
      * using raw answer data.
      */
     hideResults?: boolean;
+    /**
+     * If set to true, expands all the data sources panel.
+     */
+    expandAllDataSource?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
      */

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

@@ -86,11 +86,6 @@ export interface ViewConfig {
      * @version 1.9.4 or later
      */
     locale?: string;
-    /**
-     * This message is displayed on the embed view when the login fails.
-     * @version 1.10.1 | ThoughtSpot: *
-     */
-    loginFailedMessage?: string;
     /**
      * This is an object (key/val) of override flags which will be applied
      * to the internal embedded object. This can be used to add any

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
@@ -139,6 +153,14 @@ export interface EmbedConfig {
      * @default ''
      */
     customCssUrl?: string;
+    /**
+     * [AuthServer|Basic] Detect if 3rd party cookies are enabled by doing an additional call. This is slower
+     * and should be avoided. Listen to the NO_COOKIE_ACCESS event to handle the situation.
+     *
+     * This is slightly slower than letting the browser handle the cookie check, as it involves an extra network call.
+     * @version SDK: 1.10.4 | ThoughtSpot: *
+     */
+    detectCookieAccessSlow?: boolean;
 }
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -332,6 +354,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: {