@thoughtspot/visual-embed-sdk 1.28.0-preRender → 1.28.0

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

@@ -8,7 +8,7 @@
  * @module
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { DOMSelector, ViewConfig, MessagePayload } from '../types';
+import { DOMSelector, MessagePayload, ViewConfig } from '../types';
 import { V1Embed } from './ts-embed';
 /**
  * Pages within the ThoughtSpot app that can be embedded.
@@ -53,6 +53,16 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * If true, the top navigation bar within the ThoughtSpot app
      * is displayed. By default, the navigation bar is hidden.
      * This flag also controls the homepage left navigation bar.
+     *
+     * @default true
+     * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showPrimaryNavbar:true,
+     * })
+     * ```
      */
     showPrimaryNavbar?: boolean;
     /**
@@ -61,23 +71,78 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * nav-bars are visible, this flag will only hide the homepage left nav-bar.
      * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
      *
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
      * @default false
-     * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideHomepageLeftNav : true,
+     * })
+     * ```
      */
     hideHomepageLeftNav?: boolean;
     /**
      * Control the visibility of the help (?) and profile buttons on the
      * Global nav-bar. By default, these buttons are visible on the nav-bar.
+     *
+     * @default false
+     * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    disableProfileAndHelp: true,
+     * })
+     * ```
      */
     disableProfileAndHelp?: boolean;
     /**
      * Control the visibility of the application switcher button on the nav-bar.
      * By default, the application switcher is shown.
+     *
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @default false
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideApplicationSwitcher : true,
+     * })
+     * ```
      */
     hideApplicationSwitcher?: boolean;
     /**
      * Control the visibility of the Org switcher button on the nav-bar.
      * By default, the Org switcher button is shown.
+     *
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @default true
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideOrgSwitcher : true,
+     * })
+     * ```
      */
     hideOrgSwitcher?: boolean;
     /**
@@ -89,9 +154,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * For eg, if you want the component to open to a specific Liveboard
      * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
      *
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
      * @example
-     * ```
-     * <AppEmbed path="pinboard/1234/tab/7464" />
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    path:"pinboard/1234/tab/7464"
+     * })
      * ```
      */
     path?: string;
@@ -101,16 +170,46 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * Use this to open to particular page in the app. To open to a specific
      * path within the app, use the `path` attribute which is more flexible.
+     *
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    pageId : Page.Answers | Page.Data
+     * })
+     * ```
      */
     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.
+     *
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    tag:'value',
+     * })
+     * ```
      */
     tag?: string;
     /**
      * The array of GUIDs to be hidden
+     *
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideObjects: [
+     *       '430496d6-6903-4601-937e-2c691821af3c',
+     *       'f547ec54-2a37-4516-a222-2b06719af726'
+     *     ]
+     * })
+     * ```
      */
     hideObjects?: string[];
     /**
@@ -124,7 +223,15 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
     /**
      * If set to true, the Search Assist feature is enabled.
      *
+     * @default true
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    enableSearchAssist: true,
+     * })
+     * ```
      */
     enableSearchAssist?: boolean;
     /**
@@ -132,6 +239,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * according to the height of the pages which support fullHeight mode.
      *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    fullHeight: true,
+     * })
+     * ```
      */
     fullHeight?: boolean;
     /**
@@ -147,6 +261,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideLiveboardHeader : true,
+     * })
+     * ```
      */
     hideLiveboardHeader?: boolean;
     /**
@@ -154,6 +275,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showLiveboardTitle:true,
+     * })
+     * ```
      */
     showLiveboardTitle?: boolean;
     /**
@@ -161,13 +289,28 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showLiveboardDescription:true,
+     * })
+     * ```
      */
     showLiveboardDescription?: boolean;
     /**
-     * Flag to control new Modular Home experience
+     * Flag to control new Modular Home experience.
      *
      * @default false
-     * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    modularHomeExperience : true,
+     * })
+     * ```
      */
     modularHomeExperience?: boolean;
     /**
@@ -253,6 +396,6 @@ export declare class AppEmbed extends V1Embed {
      * @param renderOptions An object containing the page ID
      * to be embedded.
      */
-    render(): AppEmbed;
+    render(): Promise<AppEmbed>;
 }
 //# sourceMappingURL=app.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,EACI,WAAW,EAAa,UAAU,EAAc,cAAc,EACxE,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,aAAa;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;OAMG;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;IAC7B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAU;gBAGnB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAU/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAgExB;;;;OAIG;IACI,YAAY,IAAI,MAAM;IAa7B;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAKzC;IAEF;;;;;OAKG;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"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EACH,WAAW,EAAyB,cAAc,EAAS,UAAU,EACxE,MAAM,UAAU,CAAC;AAGlB,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,aAAa;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAU;gBAGnB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAU/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAgExB;;;;OAIG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAKzC;IAEF;;;;;OAKG;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;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAO3C"}

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

@@ -1,5 +1,5 @@
+import { AuthEventEmitter, notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout } from '../auth';
 import { EmbedConfig, PrefetchFeatures } from '../types';
-import { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, AuthEventEmitter } from '../auth';
 export interface executeTMLInput {
     metadata_tmls: string[];
     import_policy?: 'PARTIAL' | 'ALL_OR_NONE' | 'VALIDATE_ONLY';

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

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AAgBA,OAAO,EACO,WAAW,EAAY,gBAAgB,EACpD,MAAM,UAAU,CAAC;AAClB,OAAO,EAMH,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEZ,gBAAgB,EACnB,MAAM,SAAS,CAAC;AAWjB,MAAM,WAAW,eAAe;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,eAAe,CAAC;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE;QACN,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,YAAY,CAAC;KAClE,EAAE,CAAC;IACJ,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACjC;AAED,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEzC,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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,gBA+B/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;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,SAAgB,eAAe,KAAG,QAAQ,GAAG,CAmCnE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,SAAS,SAAgB,cAAc,KAAG,QAAQ,GAAG,CAoCjE,CAAC;AAGF;;GAEG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AAYA,OAAO,EAEH,gBAAgB,EAKhB,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEf,MAAM,SAAS,CAAC;AAIjB,OAAO,EACO,WAAW,EAAY,gBAAgB,EACpD,MAAM,UAAU,CAAC;AAYlB,MAAM,WAAW,eAAe;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,eAAe,CAAC;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE;QACN,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,YAAY,CAAC;KAClE,EAAE,CAAC;IACJ,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACjC;AAED,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEzC,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;AA6BF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,gBA+B/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;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,SAAgB,eAAe,KAAG,QAAQ,GAAG,CAmCnE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,SAAS,SAAgB,cAAc,KAAG,QAAQ,GAAG,CAoCjE,CAAC;AAGF;;GAEG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}

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

@@ -19,8 +19,21 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
     /**
      * If set to true, the embedded object container dynamically resizes
      * according to the height of the Liveboard.
+     * **Note**:  Using fullHeight loads all visualizations on the
+     * Liveboard simultaneously, which results in multiple warehouse
+     * queries and potentially a longer wait for the topmost
+     * visualizations to display on the screen.
+     * Setting `fullHeight` to `false` fetches visualizations
+     * incrementally as users scroll the page to view the charts and tables.
      *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *  fullHeight: true,
+     * });
+     * ```
      */
     fullHeight?: boolean;
     /**
@@ -30,10 +43,26 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
      *
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @default 500
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   fullHeight: true,
+     *   defaultHeight: 600,
+     * });
+     * ```
      */
     defaultHeight?: number;
     /**
      * @Deprecated If set to true, the context menu in visualizations will be enabled.
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... // other options
+     *    enableVizTransformations:true,
+     * })
+     * ```
+     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
      */
     enableVizTransformations?: boolean;
     /**
@@ -41,6 +70,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
      * Use either liveboardId or pinboardId to reference the Liveboard to embed.
      *
      * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    liveboardId:id of liveboard,
+     * })
      */
     liveboardId?: string;
     /**
@@ -51,6 +86,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
     pinboardId?: string;
     /**
      * The visualization within the Liveboard to display.
+     *
+     * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    vizId:'430496d6-6903-4601-937e-2c691821af3c',
+     * })
+     * ```
      */
     vizId?: string;
     /**
@@ -58,6 +102,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
      * Liveboard page will be read-only (no X buttons)
      *
      * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    preventLiveboardFilterRemoval:true,
+     * })
+     * ```
      */
     preventLiveboardFilterRemoval?: boolean;
     /**
@@ -66,6 +117,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
      * event.
      *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    visibleVizs: [
+     *       '430496d6-6903-4601-937e-2c691821af3c',
+     *       'f547ec54-2a37-4516-a222-2b06719af726'
+     *     ]
+     * })
      */
     visibleVizs?: string[];
     /**
@@ -79,12 +139,26 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
      * new Liveboard experience mode.
      *
      * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    liveboardV2:true,
+     * })
+     * ```
      */
     liveboardV2?: boolean;
     /**
      * Set a Liveboard tab as an active tab.
      * Specify the tab ID.
      *
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... // other options
+     *    activeTabId:'id-1234',
+     * })
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     activeTabId?: string;
@@ -92,6 +166,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
      * Show or hide the tab panel of the embedded Liveboard.
      *
      * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    hideTabPanel:true,
+     * })
+     * ```
      */
     hideTabPanel?: boolean;
     /**
@@ -99,20 +180,41 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
      *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
      * @default false
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   hideLiveboardHeader:true,
+     * });
+     * ```
      */
     hideLiveboardHeader?: boolean;
     /**
      * Show or hide the Liveboard title.
      *
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
      * @default false
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    showLiveboardTitle:true,
+     * })
+     * ```
      */
     showLiveboardTitle?: boolean;
     /**
      * Show or hide the Liveboard description.
      *
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
      * @default false
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    showLiveboardDescription:true,
+     * })
+     * ```
      */
     showLiveboardDescription?: boolean;
     /**
@@ -133,8 +235,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
     /**
      * enable or disable ask sage
      *
-     * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
      * @default false
+     * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    enableAskSage:true,
+     * })
+     * ```
      */
     enableAskSage?: boolean;
 }
@@ -194,7 +303,7 @@ export declare class LiveboardEmbed extends V1Embed {
      * @param renderOptions An object specifying the Liveboard ID,
      * visualization ID and the runtime filters.
      */
-    render(): LiveboardEmbed;
+    render(): Promise<LiveboardEmbed>;
     navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
 }
 /**

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;AAGlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,UAAU,EAAE,uBAAuB,GAAG,wBAAwB,GAAG,0BAA0B,CAAC;IAC1I;;;;;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;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;GAeG;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;IAUrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAoExB,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,OAAO,CAAC,YAAY;IAQpB,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAcxC,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAQ1C;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpE;;;;;OAKG;IACI,MAAM,IAAI,cAAc;IASxB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAavF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAI"}
+{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EACH,WAAW,EAAc,SAAS,EAAyB,UAAU,EACxE,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,0BAA0B,CAClF;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;GAeG;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;IAUrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAoExB,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,OAAO,CAAC,YAAY;IAQpB,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAcxC,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAQ1C;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpE;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;IASvC,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAavF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAG"}

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

@@ -159,6 +159,6 @@ export declare class SageEmbed extends V1Embed {
      *
      * @returns {SageEmbed} Eureka/Sage embed
      */
-    render(): SageEmbed;
+    render(): Promise<SageEmbed>;
 }
 //# sourceMappingURL=sage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"sage.d.ts","sourceRoot":"","sources":["sage.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACH,MAAM,EAAE,WAAW,EAAS,UAAU,EACzC,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,YAAY,GAAG,aAAa,GAAG,0BAA0B,CACjH;IACD;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AACD,eAAO,MAAM,qCAAqC,UASjD,CAAC;AACF;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,OAAO;IAClC;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;gBAGzB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc;IAKhE;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM;IAkClC;;;;;OAKG;IACI,YAAY,IAAI,MAAM;IAqB7B;;;;OAIG;IACI,MAAM,IAAI,SAAS;CAQ7B"}
+{"version":3,"file":"sage.d.ts","sourceRoot":"","sources":["sage.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACH,MAAM,EAAE,WAAW,EAAS,UAAU,EACzC,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,YAAY,GAAG,aAAa,GAAG,0BAA0B,CACjH;IACD;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AACD,eAAO,MAAM,qCAAqC,UASjD,CAAC;AACF;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,OAAO;IAClC;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;gBAGzB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc;IAKhE;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM;IAkClC;;;;;OAKG;IACI,YAAY,IAAI,MAAM;IAqB7B;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;CAQ5C"}

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

@@ -10,18 +10,44 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
      * Only a single data source is supported currently.
      *
      * @deprecated Use `dataSource` instead
+     *
+     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
+     *
+     * @example
+     * ```js
+     * const embed = new SearchBarEmbed('#tsEmbed', {
+     *    ... // other options
+     *    dataSources:['id-2345','id-2345'],
+     * })
+     * ```
      */
     dataSources?: string[];
     /**
-     * The array of data source GUIDs to set on load.
+     * Pass the ID of the source to be selected.
      *
      * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
+     *
+     * @example
+     * ```js
+     * const embed = new SearchBarEmbed('#tsEmbed', {
+     *    ... // other options
+     *    dataSource:'id-2345',
+     * })
+     * ```
      */
     dataSource?: string;
     /**
      * Boolean to define if the last selected data source should be used
      *
      * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
+     *
+     * @example
+     * ```js
+     * const embed = new SearchBarEmbed('#tsEmbed', {
+     *    ... // other options
+     *    useLastSelectedSources:false,
+     * })
+     * ```
      */
     useLastSelectedSources?: boolean;
     /**
@@ -35,12 +61,17 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
      * If it’s not executed, the focus is placed at the end of
      * the token string in the search bar.
      *
+     * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
+     *
      * @example
      * ```js
-     * searchOptions: {
-     *    searchTokenString: '[quantity purchased] [region]',
-     *    executeSearch: true,
-     * }
+     * const embed = new SearchBarEmbed('#tsEmbed', {
+     *    ... // other options
+     *    searchOptions: {
+     *        searchTokenString: '[quantity purchased] [region]',
+     *        executeSearch: true,
+     *    }
+     * })
      * ```
      */
     searchOptions?: SearchOptions;
@@ -68,6 +99,6 @@ export declare class SearchBarEmbed extends TsEmbed {
     /**
      * Render the embedded ThoughtSpot search
      */
-    render(): SearchBarEmbed;
+    render(): Promise<SearchBarEmbed>;
 }
 //# sourceMappingURL=search-bar.d.ts.map

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,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAE7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACR,gBAAgB,GAChB,YAAY,GACZ,aAAa,GACb,uBAAuB,GACvB,wBAAwB,GACxB,YAAY,GACZ,aAAa,GACb,0BAA0B,CAC/B;IACD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,SAAS,CAAC,kBAAkB,SAAoB;gBAEpC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB;IAKhE;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IA2CpB;;OAEG;IACI,MAAM,IAAI,cAAc;CAOlC"}
+{"version":3,"file":"search-bar.d.ts","sourceRoot":"","sources":["search-bar.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAE7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACR,gBAAgB,GAChB,YAAY,GACZ,aAAa,GACb,uBAAuB,GACvB,wBAAwB,GACxB,YAAY,GACZ,aAAa,GACb,0BAA0B,CAC/B;IACD;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,SAAS,CAAC,kBAAkB,SAAoB;gBAEpC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB;IAKhE;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IA2CpB;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;CAOjD"}