@thoughtspot/visual-embed-sdk 1.15.0 → 1.16.0

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/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
      */
@@ -105,4 +105,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

@@ -994,4 +994,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 {};