@thoughtspot/visual-embed-sdk 1.15.0 → 1.17.0-alpha.0

package/CHANGELOG.md

@@ -6,14 +6,14 @@ This project follows Semantic Versioning.
 ## Unreleased
 
 ### New Features
-- Set of new Host events to drive interactions on the embed programatically
+- Set of new Host events to drive interactions on the embed programatically 
 
 ## 1.14.1 (08-31-2022)
 - Fixed "not logged in" message showing up on "SearchEmbed" with AuthType.None.
 
 ## 1.14.0 (08-29-2022)
 - [AuthType.AuthServer] Now uses `POST` call to log the user in using the bearer token.
-- `liveboardV2` flag on `LiveboardEmbed` to try out the LiveboardV2 experience.
+- `liveboardV2` flag on `LiveboardEmbed` to try out the LiveboardV2 experience. 
 
 ## 1.13.0 (07-19-2022)
 - Release to support TS version 8.5.0.cl
@@ -29,10 +29,6 @@ This project follows Semantic Versioning.
 ### Fixed
 - Typescript build that was affecting some Angular project configurations
 
-## 1.11.2 (06-10-2022)
-### Fixed
-- Typescript build that was affecting some Angular project configurations
-
 ## 1.11.1 (05-30-2022)
 ### Fixed
 - Whitelabeling - new [action](https://developers.thoughtspot.com/docs/typedoc/enums/Action.html#ReportError) for the ability to turn off TS specific error reporting by end users.
@@ -81,12 +77,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

@@ -7,7 +7,7 @@
 # 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. You need to have a ThoughtSpot account to use the SDK, [click here](https://www.thoughtspot.com/trial?tsref=trialtse) to start a trial. 
+SDK to embed ThoughtSpot into your web apps. You need a ThoughtSpot account to use the SDK, [click here](https://www.thoughtspot.com/trial?tsref=trialtse) to start a trial. 
 
    * [Installation](#installation)
    * [Live Playground](#live-playground)

package/dist/src/auth.d.ts

@@ -23,15 +23,15 @@ export declare enum AuthStatus {
      */
     FAILURE = "FAILURE",
     /**
-     * Emits when the SDK succeeds to authenticate
+     * Emits when the SDK authenticates successfully
      */
     SDK_SUCCESS = "SDK_SUCCESS",
     /**
-     * Emits when the App sends a auth success
+     * Emits when the app sends an authentication success message
      */
     SUCCESS = "SUCCESS",
     /**
-     * Emits when there is a logout
+     * Emits when a user logs out
      */
     LOGOUT = "LOGOUT"
 }

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

@@ -7,7 +7,7 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 import EventEmitter from 'eventemitter3';
-import { EmbedConfig } from '../types';
+import { EmbedConfig, PrefetchFeatures } from '../types';
 import { AuthFailureType } from '../auth';
 export declare let authPromise: Promise<boolean>;
 export declare const getEmbedConfig: () => EmbedConfig;
@@ -23,23 +23,24 @@ 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
+ * @param prefetchFeatures Specify features which needs to be prefetched.
+ * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
  */
-export declare const prefetch: (url?: string) => void;
+export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[]) => void;
 /**
- * Initialize the ThoughtSpot embed SDK globally and perform
+ * Initializes the Visual Embed SDK globally and perform
  * authentication if applicable.
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.
- *
- * eg: authStatus = init(config);
+ * example: 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}
+ * @returns event emitter which emits events on authentication success, failure and logout. See {@link AuthStatus}
+ * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
  */
 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
+ * Logs out 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

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

@@ -18,6 +18,7 @@ export interface LiveboardViewConfig extends ViewConfig {
     /**
      * If set to true, the embedded object container dynamically resizes
      * according to the height of the Liveboard.
+     * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
      */
     fullHeight?: boolean;
     /**
@@ -29,12 +30,13 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     defaultHeight?: number;
     /**
-     * If set to true, the context menu in visualizations will be enabled.
+     * @Deprecated If set to true, the context menu in visualizations will be enabled.
      */
     enableVizTransformations?: boolean;
     /**
      * The Liveboard to display in the embedded view.
      * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
+     * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
      */
     liveboardId?: string;
     /**
@@ -49,6 +51,7 @@ export interface LiveboardViewConfig extends ViewConfig {
     /**
      * If set to true, all filter chips from a
      * Liveboard page will be read-only (no X buttons)
+     * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
      */
     preventLiveboardFilterRemoval?: boolean;
     /**

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

@@ -0,0 +1,39 @@
+import { TsEmbed, ViewConfig } from './ts-embed';
+import { SearchOptions } from './search';
+export interface SearchBarViewConfig extends ViewConfig {
+    /**
+     * If set to true, hides the data sources panel.
+     */
+    hideDataSources?: boolean;
+    /**
+     * The array of data source GUIDs to set on load.
+     */
+    dataSources?: string[];
+    /**
+     * Configuration for search options
+     */
+    searchOptions?: SearchOptions;
+}
+/**
+ * Embed ThoughtSpot search bar
+ *
+ * @Category Search Embed
+ * @version: SDK: 1.17.0 | ThoughtSpot: 8.10.0
+ */
+export declare class SearchBarEmbed extends TsEmbed {
+    /**
+     * The view configuration for the embedded ThoughtSpot search bar.
+     */
+    protected viewConfig: SearchBarViewConfig;
+    constructor(domSelector: string, viewConfig: SearchBarViewConfig);
+    /**
+     * Construct the URL of the embedded ThoughtSpot search to be
+     * loaded in the iframe
+     * @param dataSources A list of data source GUIDs
+     */
+    private getIFrameSrc;
+    /**
+     * Render the embedded ThoughtSpot search
+     */
+    render(): SearchBarEmbed;
+}

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

@@ -11,7 +11,7 @@ import { ViewConfig, TsEmbed } from './ts-embed';
 /**
  * Configuration for search options
  */
-interface SearchOptions {
+export interface SearchOptions {
     /**
      * The tml string to load the answer
      */
@@ -44,10 +44,6 @@ 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.
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
@@ -105,4 +101,3 @@ export declare class SearchEmbed extends TsEmbed {
      */
     render(): SearchEmbed;
 }
-export {};

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

@@ -286,6 +286,7 @@ export declare class TsEmbed {
      * Get the Post Url Params for THOUGHTSPOT from the current
      * host app URL.
      * THOUGHTSPOT URL params starts with a prefix "ts-"
+     * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
      */
     getThoughtSpotPostUrlParams(): string;
 }

package/dist/src/index.d.ts

@@ -11,6 +11,7 @@ import { AppEmbed, Page, AppViewConfig } from './embed/app';
 import { init, prefetch, logout } from './embed/base';
 import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from './embed/liveboard';
 import { SearchEmbed, SearchViewConfig } from './embed/search';
+import { SearchBarEmbed, SearchBarViewConfig } from './embed/search-bar';
 import { AuthFailureType, AuthStatus } from './auth';
-import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig } from './types';
-export { init, logout, prefetch, SearchEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, SearchViewConfig, LiveboardViewConfig, AppViewConfig, };
+import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures } from './types';
+export { init, logout, prefetch, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, };

package/dist/src/react/index.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
+import { SearchBarViewConfig } from '../embed/search-bar';
 import { SearchViewConfig } from '../embed/search';
 import { AppViewConfig } from '../embed/app';
 import { LiveboardViewConfig } from '../embed/liveboard';
@@ -14,5 +15,8 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
 }
 export declare const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
 export declare const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
+interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
+}
+export declare const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<TsEmbed>>;
 export declare const useEmbedRef: () => React.MutableRefObject<TsEmbed>;
 export {};

package/dist/src/types.d.ts

@@ -15,10 +15,6 @@ export declare enum AuthType {
      * No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
      */
     None = "None",
-    /**
-     * No authentication on the SDK. Passthrough to the embedded App.
-     */
-    Passthrough = "None",
     /**
      * SSO using SAML
      * @deprecated Use {@link SAML} instead
@@ -777,7 +773,12 @@ export declare enum HostEvent {
      * vizEmbed.trigger((HostEvent.Present)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
-    Present = "present"
+    Present = "present",
+    /**
+     * Get TML for the current search.
+     * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
+     */
+    GetTML = "getTML"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -994,4 +995,10 @@ export declare enum OperationType {
 export interface AnswerServiceType {
     getAnswer?: (offset: number, batchSize: number) => any;
 }
+export declare enum PrefetchFeatures {
+    FullApp = "FullApp",
+    SearchEmbed = "SearchEmbed",
+    LiveboardEmbed = "LiveboardEmbed",
+    VizEmbed = "VizEmbed"
+}
 export {};

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