@thoughtspot/visual-embed-sdk 1.20.0-alpha.2 → 1.20.0-prerender.1

package/dist/src/auth.d.ts

@@ -12,12 +12,23 @@ export declare const EndPoints: {
     BASIC_LOGIN: string;
     LOGOUT: string;
 };
+/**
+ * Enum for auth failure types. This is the parameter passed to the listner
+ * of {@link AuthStatus.FAILURE}.
+ *
+ * @group Authentication / Init
+ */
 export declare enum AuthFailureType {
     SDK = "SDK",
     NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
     EXPIRY = "EXPIRY",
     OTHER = "OTHER"
 }
+/**
+ * Enum for auth status emitted by the emitter returned from {@link init}.
+ *
+ * @group Authentication / Init
+ */
 export declare enum AuthStatus {
     /**
      * Emits when the SDK fails to authenticate
@@ -39,40 +50,97 @@ export declare enum AuthStatus {
      * Emitted when inPopup: true in the SAMLRedirect flow.
      * And, we are waiting for popup to be triggered either programatically
      * or by the trigger button.
+     *
      * @version SDK: 1.19.0
      */
     WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
 }
+/**
+ * Event emitter returned from {@link init}.
+ *
+ * @group Authentication / Init
+ */
+export interface AuthEventEmitter {
+    /**
+     * Registed a listener on Auth failure.
+     *
+     * @param event
+     * @param listener
+     */
+    on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
+    on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+    on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
+    /**
+     * Trigger an event on the emitter returned from init.
+     *
+     * @param {@link AuthEvent}
+     */
+    emit(event: AuthEvent): void;
+}
+/**
+ * Events which can be triggered on the emitter returned from {@link init}.
+ *
+ * @group Authentication / Init
+ */
 export declare enum AuthEvent {
     /**
-     * Manually trigger the SSO popup.
+     * Manually trigger the SSO popup. This is useful with
+     * authStatus: SAMLRedirect/OIDCRedicre and inPopup: true
      */
     TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
 }
-export declare function getAuthEE(): EventEmitter;
-export declare function setAuthEE(eventEmitter: EventEmitter): void;
+/**
+ *
+ */
+export declare function getAuthEE(): EventEmitter<AuthStatus | AuthEvent>;
+/**
+ *
+ * @param eventEmitter
+ */
+export declare function setAuthEE(eventEmitter: EventEmitter<AuthStatus | AuthEvent>): void;
+/**
+ *
+ */
 export declare function notifyAuthSDKSuccess(): void;
+/**
+ *
+ */
 export declare function notifyAuthSuccess(): void;
+/**
+ *
+ * @param failureType
+ */
 export declare function notifyAuthFailure(failureType: AuthFailureType): void;
+/**
+ *
+ */
 export declare function notifyLogout(): void;
 /**
  * Return releaseVersion if available
  */
 export declare function getReleaseVersion(): string;
 /**
- * Return a promise that resolves with the session info when authentication is
- * successful. And info is available.
+ * Return a promise that resolves with the session information when
+ * authentication is successful. And info is available.
+ *
+ * @group Global methods
  */
 export declare function getSessionInfo(): Promise<any>;
+/**
+ *
+ * @param sessionDetails
+ */
 export declare function initSession(sessionDetails: any): void;
 export declare const getAuthenticaionToken: (embedConfig: EmbedConfig) => Promise<any>;
 /**
  * Perform token based authentication
+ *
  * @param embedConfig The embed configuration
  */
 export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
 /**
  * Validate embedConfig parameters required for cookielessTokenAuth
+ *
  * @param embedConfig The embed configuration
  */
 export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
@@ -82,6 +150,7 @@ export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promis
  *
  * Warning: This feature is primarily intended for developer testing. It is
  * strongly advised not to use this authentication method in production.
+ *
  * @param embedConfig The embed configuration
  */
 export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
@@ -90,6 +159,7 @@ 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<boolean>;

package/dist/src/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAyB,WAAW,EAAqB,MAAM,SAAS,CAAC;AAahF,eAAO,IAAI,cAAc,SAAQ,CAAC;AAElC,eAAO,IAAI,cAAc,EAAE,MAAa,CAAC;AAEzC,eAAO,IAAI,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAQ,CAAC;AAQvD,eAAO,MAAM,2BAA2B,yCACE,CAAC;AAE3C,eAAO,MAAM,SAAS;;qCAEe,MAAM;qCAEN,MAAM;;;;CAK1C,CAAC;AAEF,oBAAY,eAAe;IACvB,GAAG,QAAQ;IACX,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,KAAK,UAAU;CAClB;AAED,oBAAY,UAAU;IAClB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;OAKG;IACH,iBAAiB,sBAAsB;CAC1C;AAED,oBAAY,SAAS;IACjB;;OAEG;IACH,iBAAiB,sBAAsB;CAC1C;AAID,wBAAgB,SAAS,IAAI,YAAY,CAExC;AAED,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAE1D;AAED,wBAAgB,oBAAoB,IAAI,IAAI,CAM3C;AAED,wBAAgB,iBAAiB,IAAI,IAAI,CAMxC;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAMpE;AAED,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAmBD;;GAEG;AACH,wBAAgB,iBAAiB,WAEhC;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAE7C;AAED,wBAAgB,WAAW,CAAC,cAAc,EAAE,GAAG,QAI9C;AAoCD,eAAO,MAAM,qBAAqB,gBACjB,WAAW,KACzB,QAAQ,GAAG,CAWb,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,gBACP,WAAW,KACzB,QAAQ,OAAO,CAkCjB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,gBACjB,WAAW,KACzB,QAAQ,OAAO,CAQjB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,gBACP,WAAW,KACzB,QAAQ,OAAO,CAiBjB,CAAC;AAkFF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAmBxD,CAAC;AAEF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAoBxD,CAAC;AAEF,eAAO,MAAM,MAAM,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAKtE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,gBACR,WAAW,KACzB,QAAQ,OAAO,CAoBjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,QAAO,OAAyB,CAAC"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,EACoB,WAAW,EACrC,MAAM,SAAS,CAAC;AAajB,eAAO,IAAI,cAAc,SAAQ,CAAC;AAElC,eAAO,IAAI,cAAc,EAAE,MAAa,CAAC;AAEzC,eAAO,IAAI,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAQ,CAAC;AAQvD,eAAO,MAAM,2BAA2B,yCAAyC,CAAC;AAElF,eAAO,MAAM,SAAS;;qCAEe,MAAM;qCACN,MAAM;;;;CAI1C,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,eAAe;IACvB,GAAG,QAAQ;IACX,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,KAAK,UAAU;CAClB;AAED;;;;GAIG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;;OAMG;IACH,iBAAiB,sBAAsB;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACtF,EAAE,CACE,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAChF,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC1E;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;CAChC;AAED;;;;GAIG;AACH,oBAAY,SAAS;IACjB;;;OAGG;IACH,iBAAiB,sBAAsB;CAC1C;AAID;;GAEG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,CAEhE;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,IAAI,CAElF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAM3C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAMxC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAMpE;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAoBD;;GAEG;AACH,wBAAgB,iBAAiB,WAEhC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAE7C;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,GAAG,QAI9C;AAqCD,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,GAAG,CAWjF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAyB3E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAMrF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAa3E,CAAC;AA6EF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,MAAM,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAKtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAoB5E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,QAAO,OAAyB,CAAC"}

package/dist/src/config.d.ts

@@ -2,6 +2,7 @@ import { EmbedConfig } from './types';
 /**
  * Parse and construct the ThoughtSpot hostname or IP address
  * from the embed configuration object.
+ *
  * @param config
  */
 export declare const getThoughtSpotHost: (config: EmbedConfig) => string;

package/dist/src/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAqBtC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,WAAY,WAAW,KAAG,MAiBxD,CAAC;AAEF,eAAO,MAAM,aAAa,WAAY,WAAW,KAAG,MAenD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAC1C,eAAO,MAAM,oBAAoB,SAAS,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAqBtC;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,WAAY,WAAW,KAAG,MAiBxD,CAAC;AAEF,eAAO,MAAM,aAAa,WAAY,WAAW,KAAG,MAgBnD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAC1C,eAAO,MAAM,oBAAoB,SAAS,CAAC"}

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

@@ -45,7 +45,8 @@ export declare enum Page {
 }
 /**
  * The view configuration for full app embedding.
- * @Category App Embed
+ *
+ * @group Embed components
  */
 export interface AppViewConfig extends ViewConfig {
     /**
@@ -70,8 +71,9 @@ export interface AppViewConfig extends ViewConfig {
      */
     pageId?: Page;
     /**
-     * This puts a filter tag on the application. All metadata lists in the application, such as
-     * Liveboards and answers, would be filtered by this tag.
+     * This puts a filter tag on the application. All metadata lists in the
+     * application, such as Liveboards and answers, would be filtered by this
+     * tag.
      */
     tag?: string;
     /**
@@ -81,19 +83,22 @@ export interface AppViewConfig extends ViewConfig {
     /**
      * Render liveboards using the new v2 rendering mode
      * This is a transient flag which is primarily meant for internal use
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      * @hidden
      */
     liveboardV2?: 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
      */
     enableSearchAssist?: boolean;
 }
 /**
  * Embeds full ThoughtSpot experience in a host application.
- * @Category App Embed
+ *
+ * @group Embed components
  */
 export declare class AppEmbed extends V1Embed {
     protected viewConfig: AppViewConfig;
@@ -102,35 +107,42 @@ export declare class AppEmbed extends V1Embed {
      * Constructs a map of parameters to be passed on to the
      * embedded Liveboard or visualization.
      */
-    private getEmbedParams;
+    protected getEmbedParams(): string;
     /**
      * Constructs the URL of the ThoughtSpot app page to be rendered.
+     *
      * @param pageId The ID of the page to be embedded.
      */
     private getIFrameSrc;
     /**
      * Gets the ThoughtSpot route of the page for a particular page ID.
+     *
      * @param pageId The identifier for a page in the ThoughtSpot app.
      */
     private getPageRoute;
     /**
      * Formats the path provided by the user.
+     *
      * @param path The URL path.
      * @returns The URL path that the embedded app understands.
      */
     private formatPath;
     /**
      * Navigate to particular page for app embed. eg:answers/pinboards/home
-     * This is used for embedding answers, pinboards, visualizations and full application only.
+     * This is used for embedding answers, pinboards, visualizations and full application
+     * only.
+     *
      * @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.
+     * When used with `noReload` (default: true) this can also be a number
+     * like 1/-1 to go forward/back.
      * @param noReload boolean Trigger the navigation without reloading the page
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
      */
     navigateToPage(path: string | number, noReload?: boolean): void;
     /**
      * Renders the embedded application pages in the ThoughtSpot app.
+     *
      * @param renderOptions An object containing the page ID
      * to be embedded.
      */

package/dist/src/embed/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAGH,WAAW,EAEX,UAAU,EACb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;gBAGxB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAI/D;;;OAGG;IACH,OAAO,CAAC,cAAc;IAmBtB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;OAQG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAuBpE;;;;OAIG;IACI,MAAM,IAAI,QAAQ;CAU5B"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EACmB,WAAW,EAAa,UAAU,EAC3D,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;gBAGxB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAI/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAoCxB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAWpB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;;OAWG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;;OAKG;IACI,MAAM,IAAI,QAAQ;CAO5B"}

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

@@ -1,15 +1,13 @@
+import { EmbedConfig, PrefetchFeatures } from '../types';
+import { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, AuthEventEmitter } from '../auth';
+export declare let authPromise: Promise<boolean>;
 /**
- * Copyright (c) 2022
+ * Gets the configuration embed was initialized with.
  *
- * Base classes
- *
- * @summary Base classes
- * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+ * @returns {@link EmbedConfig} The configuration embed was initialized with.
+ * @version SDK: 1.19.0 | ThoughtSpot: *
+ * @group Global methods
  */
-import EventEmitter from 'eventemitter3';
-import { EmbedConfig, PrefetchFeatures } from '../types';
-import { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout } from '../auth';
-export declare let authPromise: Promise<boolean>;
 export declare const getEmbedConfig: () => EmbedConfig;
 export declare const getAuthPromise: () => Promise<boolean>;
 export { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, };
@@ -18,40 +16,62 @@ export { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogou
  */
 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.
+ * 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
+ * @group Global methods
  */
 export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[]) => void;
 /**
  * Initializes the Visual Embed SDK globally and perform
  * authentication if applicable.
+ *
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.
- * example: authStatus = init(config);
- * authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
- * @returns event emitter which emits events on authentication success, failure and logout. See {@link AuthStatus}
+ * @example
+ * ```js
+ *   const authStatus = init({
+ *     thoughtSpotHost: 'https://my.thoughtspot.cloud',
+ *     authType: AuthType.None,
+ *   });
+ *   authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
+ * ```
+ * @returns {@link AuthEventEmitter} 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
+ * @group Authentication / Init
+ */
+export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter;
+/**
+ *
  */
-export declare const init: (embedConfig: EmbedConfig) => EventEmitter;
 export declare function disableAutoLogin(): void;
 /**
- * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to prevent
- * the SDK from automatically logging in again.
+ * 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
- * second call it will be honored.
+ * 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: 8.2.0.cl, 8.4.1-sw
+ * @group Global methods
  */
 export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
 /**
- * Renders functions in a queue, resolves to next function only after the callback next is called
+ * 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) => Promise<any>) => Promise<any>;
+/**
+ *
+ */
 export declare function reset(): void;
 //# sourceMappingURL=base.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AACH,OAAO,YAAY,MAAM,eAAe,CAAC;AAGzC,OAAO,EAAY,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACnE,OAAO,EAKH,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEf,MAAM,SAAS,CAAC;AAUjB,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEzC,eAAO,MAAM,cAAc,QAAO,WAAqB,CAAC;AAExD,eAAO,MAAM,cAAc,QAAO,QAAQ,OAAO,CAAgB,CAAC;AAElE,OAAO,EACH,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,GACf,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,QAAO,QAAQ,OAAO,CAe5C,CAAC;AASF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,SACX,MAAM,qBACO,gBAAgB,EAAE,KACtC,IAqBF,CAAC;AAiCF;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,YAgC/C,CAAC;AAEF,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,MAAM,uCAAoC,QAAQ,OAAO,CAQrE,CAAC;AAIF;;;GAGG;AACH,eAAO,MAAM,aAAa,sBACH,GAAG,KAAK,IAAI,KAAK,QAAQ,GAAG,CAAC,KACjD,QAAQ,GAAG,CAQb,CAAC;AAGF,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AAYA,OAAO,EAAY,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACnE,OAAO,EAMH,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEZ,gBAAgB,EACnB,MAAM,SAAS,CAAC;AAUjB,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AACzC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,QAAO,WAAqB,CAAC;AAExD,eAAO,MAAM,cAAc,QAAO,QAAQ,OAAO,CAAgB,CAAC;AAElE,OAAO,EACH,iBAAiB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,YAAY,GAC3E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,QAAO,QAAQ,OAAO,CAe5C,CAAC;AASF;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,SAAU,MAAM,qBAAqB,gBAAgB,EAAE,KAAG,IAqB9E,CAAC;AAiCF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,gBA2B/C,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,MAAM,uCAAoC,QAAQ,OAAO,CAQrE,CAAC;AAIF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,sBAAuB,GAAG,KAAK,IAAI,KAAK,QAAQ,GAAG,CAAC,KAAG,QAAQ,GAAG,CAQ3F,CAAC;AAGF;;GAEG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}

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

@@ -12,12 +12,14 @@ import { DOMSelector, HostEvent, ViewConfig } from '../types';
 import { V1Embed } from './ts-embed';
 /**
  * The configuration for the embedded Liveboard or visualization page view.
- * @Category Liveboards and Charts
+ *
+ * @group Embed components
  */
 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;
@@ -25,6 +27,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      * This is the minimum height(in pixels) for a full height Liveboard.
      * Setting this height helps resolves issues with empty Liveboards and
      * other screens navigable from a Liveboard.
+     *
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @default 500
      */
@@ -36,11 +39,13 @@ export interface LiveboardViewConfig extends ViewConfig {
     /**
      * 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;
     /**
      * To support backward compatibility
+     *
      * @hidden
      */
     pinboardId?: string;
@@ -51,6 +56,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;
@@ -58,28 +64,33 @@ export interface LiveboardViewConfig extends ViewConfig {
      * Array of viz ids which should be visible when the liveboard
      * first renders. This can be changed by triggering the "SetVisibleVizs"
      * event.
+     *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     visibleVizs?: string[];
     /**
      * To support backward compatibilty
+     *
      * @hidden
      */
     preventPinboardFilterRemoval?: boolean;
     /**
      * Render embedded Liveboards and visualizations in the new Liveboard experience mode
+     *
      * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
      */
     liveboardV2?: boolean;
     /**
      * Tab Id of the Liveboard that is supposed to be active
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     activeTabId?: string;
 }
 /**
  * Embed a ThoughtSpot Liveboard or visualization
- * @Category Liveboards and Charts
+ *
+ * @group Embed components
  */
 export declare class LiveboardEmbed extends V1Embed {
     protected viewConfig: LiveboardViewConfig;
@@ -89,19 +100,17 @@ export declare class LiveboardEmbed extends V1Embed {
      * Construct a map of params to be passed on to the
      * embedded Liveboard or visualization.
      */
-    private getEmbedParams;
+    protected getEmbedParams(): string;
+    private getIframeSuffixSrc;
     /**
      * Construct the URL of the embedded ThoughtSpot Liveboard or visualization
      * to be loaded within the iframe.
-     * @param liveboardId The GUID of the Liveboard.
-     * @param vizId The optional GUID of a visualization within the Liveboard.
-     * @param runtimeFilters A list of runtime filters to be applied to
-     * the Liveboard 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;
@@ -109,16 +118,19 @@ export declare class LiveboardEmbed extends V1Embed {
     private setIframeHeightForNonEmbedLiveboard;
     /**
      * Triggers an event to the embedded app
+     *
      * @param messageType The event type
      * @param data The payload to send with the message
      */
     trigger(messageType: HostEvent, data?: any): Promise<any>;
     /**
      * Render an embedded ThoughtSpot Liveboard or visualization
+     *
      * @param renderOptions An object specifying the Liveboard ID,
      * visualization ID and the runtime filters.
      */
     render(): LiveboardEmbed;
+    navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
 }
 /**
  * @hidden

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

@@ -1 +1 @@
-{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,UAAU,EACb,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACnD;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IAIrE;;;OAGG;IACH,OAAO,CAAC,cAAc;IA6CtB;;;;;;;OAOG;IACH,OAAO,CAAC,YAAY;IA8BpB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAIzC;IAEF;;;;OAIG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAQpE;;;;OAIG;IACI,MAAM,IAAI,cAAc;CA8BlC;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAG"}
+{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,UAAU,EACb,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACnD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IASrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IA4CxB,OAAO,CAAC,kBAAkB;IAa1B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAcpB;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAIzC;IAEF;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAQpE;;;;;OAKG;IACI,MAAM,IAAI,cAAc;IASxB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAWvF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAG"}

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

@@ -1,15 +1,20 @@
 import { ViewConfig } from '../types';
 import { TsEmbed } from './ts-embed';
 import { SearchOptions } from './search';
+/**
+ * @group Embed components
+ */
 export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
     /**
      * The array of data source GUIDs to set on load.
      * Only a single dataSource supported currently.
+     *
      * @deprecated Use dataSource instead
      */
     dataSources?: string[];
     /**
      * The array of data source GUIDs to set on load.
+     *
      * @version: SDK: 1.19.0
      */
     dataSource?: string;
@@ -21,8 +26,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
 /**
  * Embed ThoughtSpot search bar
  *
- * @Category Search Embed
  * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+ * @group Embed components
  */
 export declare class SearchBarEmbed extends TsEmbed {
     /**
@@ -33,6 +38,7 @@ export declare class SearchBarEmbed extends TsEmbed {
     /**
      * Construct the URL of the embedded ThoughtSpot search to be
      * loaded in the iframe
+     *
      * @param dataSources A list of data source GUIDs
      */
     private getIFrameSrc;

package/dist/src/embed/search-bar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search-bar.d.ts","sourceRoot":"","sources":["search-bar.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA8B,UAAU,EAAE,MAAM,UAAU,CAAC;AAElE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,WAAW,mBACb,SAAQ,IAAI,CAAC,UAAU,EAAE,gBAAgB,GAAG,YAAY,CAAC;IACzD;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;gBAE9B,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB;IAKhE;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAqCpB;;OAEG;IACI,MAAM,IAAI,cAAc;CAOlC"}
+{"version":3,"file":"search-bar.d.ts","sourceRoot":"","sources":["search-bar.tsx"],"names":[],"mappings":"AAAA,OAAO,EACyB,UAAU,EACzC,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,UAAU,EAAE,gBAAgB,GAAG,YAAY,CAAC;IAC1F;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;gBAE9B,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB;IAKhE;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAmCpB;;OAEG;IACI,MAAM,IAAI,cAAc;CAOlC"}

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

@@ -19,14 +19,15 @@ export interface SearchOptions {
     /**
      * Boolean to determine if the search should be executed or not.
      * if it is executed, put the focus on the results.
-     * if it’s not executed, put the focus in the search bar - at the end of the tokens
+     * if it’s not executed, put the focus in the search bar - at the end of
+     * the tokens
      */
     executeSearch?: boolean;
 }
 /**
  * The configuration attributes for the embedded search view.
  *
- * @Category Search Embed
+ * @group Embed components
  */
 export interface SearchViewConfig extends ViewConfig {
     /**
@@ -46,6 +47,7 @@ export interface SearchViewConfig extends ViewConfig {
     hideResults?: 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
      */
     enableSearchAssist?: boolean;
@@ -57,16 +59,19 @@ export interface SearchViewConfig extends ViewConfig {
     /**
      * The array of data source GUIDs to set on load.
      * Only a single dataSource supported currently.
+     *
      * @deprecated Use dataSource instead
      */
     dataSources?: string[];
     /**
      * The array of data source GUIDs to set on load.
+     *
      * @version: SDK: 1.19.0
      */
     dataSource?: string;
     /**
      * The initial search query to load the answer with.
+     *
      * @deprecated Use {@link searchOptions} instead
      */
     searchQuery?: string;
@@ -81,6 +86,7 @@ export interface SearchViewConfig extends ViewConfig {
     /**
      * If set to true, search page will render without the Search Bar
      * The chart/table should still be visible.
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     hideSearchBar?: boolean;
@@ -89,7 +95,7 @@ export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
  * Embed ThoughtSpot search
  *
- * @Category Search Embed
+ * @group Embed components
  */
 export declare class SearchEmbed extends TsEmbed {
     /**
@@ -102,9 +108,11 @@ export declare class SearchEmbed extends TsEmbed {
      * ThoughtSpot search will be initialized with.
      */
     private getDataSourceMode;
+    protected getEmbedParams(): string;
     /**
      * Construct the URL of the embedded ThoughtSpot search to be
      * loaded in the iframe
+     *
      * @param answerId The GUID of a saved answer
      * @param dataSources A list of data source GUIDs
      */

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

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEH,WAAW,EAEX,MAAM,EACN,UAAU,EAEb,MAAM,UAAU,CAAC;AAMlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAMrC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,eAAO,MAAM,uCAAuC,UAMnD,CAAC;AAEF;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACpC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBAE3B,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB;IAKlE;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAYzB;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IA6DpB;;OAEG;IACI,MAAM,IAAI,WAAW;CAkB/B"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEH,WAAW,EAEX,MAAM,EACN,UAAU,EAEb,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAMrC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,eAAO,MAAM,uCAAuC,UAMnD,CAAC;AAEF;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACpC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBAE3B,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB;IAKlE;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAYzB,SAAS,CAAC,cAAc,IAAI,MAAM;IAyDlC;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACI,MAAM,IAAI,WAAW;CAkB/B"}