@thoughtspot/visual-embed-sdk 1.10.0-alpha.3 → 1.10.1

package/CHANGELOG.md

@@ -22,12 +22,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,7 +4,7 @@
 
 <br/>
 
-# ThoughtSpot Visual Embed SDK [![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)
+# 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)
 
 SDK to embed ThoughtSpot into your web apps.
 
@@ -25,6 +25,8 @@ The SDK is written in TypeScript and is also provided both as ES Module (ESM) an
 ```js
 // ESM via NPM
 import * as TsEmbedSDK from '@thoughtspot/visual-embed-sdk';
+// OR
+import { LiveboardEmbed } from '@thoughtspot/visual-embed-sdk';
 
 // NPM <script>
 <script src="https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.js"></script>;
@@ -41,7 +43,8 @@ import {
 
 ## Live Playground
 
-Visit our [code playground](https://try-everywhere.thoughtspot.cloud/v2/#/everywhere).
+Visit our [code playground](https://try-everywhere.thoughtspot.cloud/v2/#/everywhere). <br/><br/>
+Start a [free trial](https://www.thoughtspot.com/trial?tsref=trialtse) on your own data.
 
 <br/>
 
@@ -132,10 +135,26 @@ const appEmbed = new AppEmbed(document.getElementById('ts-embed'), {
 appEmbed.render();
 ```
 
+### Triggering and Listening to events
+```js
+// NPM
+import { LiveboardEmbed, Page, AuthType, init, EmbedEvent, HostEvent } from '@thoughtspot/visual-embed-sdk';
+
+// .. Do init and create a liveboardEmbed object as above.
+
+liveboardEmbed.render();
+
+liveboardEmbed.on(EmbedEvent.LiveboardRendered, () => {
+    liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
+});
+```
+
 ## React Components
 
 All the above flavors of embedding are also provided as React components for your convenience.
 The constructor options are passed as props and the event listeners can be attached using `on<EventName>` convention.
+<br/><br/>
+Checkout a comprehensive working demo [here](https://codesandbox.io/s/github/ashubham/big-react-demo)
 
 ### Search Component
 
@@ -166,7 +185,7 @@ const MyComponent = ({ dataSources }) => {
 };
 ```
 
-### Triggering events on React components
+### Triggering events on React components (> version 1.9.2)
 
 ```jsx
 import { HostEvent } from '@thoughtspot/visual-embed-sdk';

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/app.d.ts

@@ -118,10 +118,12 @@ export declare class AppEmbed extends V1Embed {
     /**
      * Navigate to particular page for app embed. eg:answers/pinboards/home
      * This is used for embedding answers, pinboards, visualizations and full application only.
-     * @param path The string, set to iframe src and navigate to new page
+     * @param path string | number The string, set to iframe src and navigate to new page
      * eg: appEmbed.navigateToPage('pinboards')
+     * When used with `noReload` this can also be a number like 1/-1 to go forward/back.
+     * @param noReload boolean Trigger the navigation without reloading the page (version: 1.12.0 | 8.4.0.cl)
      */
-    navigateToPage(path: string): void;
+    navigateToPage(path: string | number, noReload?: boolean): void;
     /**
      * Renders the embedded application pages in the ThoughtSpot app.
      * @param renderOptions An object containing the page ID

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
@@ -19,9 +32,12 @@ export declare const prefetch: (url?: string) => void;
  *
  * @returns authPromise Promise which resolves when authentication is complete.
  */
-export declare const init: (embedConfig: EmbedConfig) => Promise<void>;
+export declare const init: (embedConfig: EmbedConfig) => EventEmitter;
+export declare function disableAutoLogin(): 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/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

@@ -293,5 +293,5 @@ export declare class V1Embed extends TsEmbed {
      * @param iframeSrc
      */
     protected renderV1Embed(iframeSrc: string): void;
-    on(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
+    on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
 }

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

@@ -119,6 +119,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 +337,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
@@ -383,6 +398,12 @@ export declare enum EmbedEvent {
      * @version 1.9.1 or later
      */
     LiveboardRendered = "PinboardRendered",
+    /**
+     * This can be used to register an event listener which
+     * is triggered on all events.
+     * @version SDK: 1.10.0 | ThoughtSpot: any
+     */
+    ALL = "*",
     /**
      * Emitted when answer is saved in the app
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
@@ -525,7 +546,14 @@ export declare enum HostEvent {
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
      */
-    UpdateRuntimeFilters = "UpdateRuntimeFilters"
+    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)
+     * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl
+     */
+    Navigate = "Navigate"
 }
 /**
  * The different visual modes that the data sources panel within

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;