@thoughtspot/visual-embed-sdk 1.20.1 → 1.21.0-alpha.0

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

@@ -6,7 +6,7 @@
  * @summary Base classes
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig, FrameParams } from '../types';
+import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig } from '../types';
 /**
  * Global prefix for all Thoughtspot postHash Params.
  */
@@ -28,6 +28,7 @@ export declare class TsEmbed {
      * The DOM node where the ThoughtSpot app is to be embedded.
      */
     private el;
+    protected isAppInitialized: boolean;
     /**
      * A reference to the iframe within which the ThoughtSpot app
      * will be rendered.
@@ -58,6 +59,7 @@ export declare class TsEmbed {
      * Should we encode URL Query Params using base64 encoding which thoughtspot
      * will generate for embedding. This provides additional security to
      * thoughtspot clusters against Cross site scripting attacks.
+     *
      * @default false
      */
     private shouldEncodeUrlQueryParams;
@@ -69,16 +71,19 @@ export declare class TsEmbed {
     private throwInitError;
     /**
      * Handles errors within the SDK
+     *
      * @param error The error message or object
      */
     protected handleError(error: string | Record<string, unknown>): void;
     /**
      * Extracts the type field from the event payload
+     *
      * @param event The window message event
      */
     private getEventType;
     /**
      * Extracts the port field from the event payload
+     *
      * @param event  The window message event
      * @returns
      */
@@ -86,6 +91,9 @@ export declare class TsEmbed {
     /**
      * fix for ts7.sep.cl
      * will be removed for ts7.oct.cl
+     *
+     * @param event
+     * @param eventType
      * @hidden
      */
     private formatEventData;
@@ -98,10 +106,16 @@ export declare class TsEmbed {
     private subscribeToEvents;
     /**
      * Send Custom style as part of payload of APP_INIT
+     *
+     * @param _
+     * @param responder
      */
     private appInitCb;
     /**
      * Sends updated auth token to the iFrame to avoid user logout
+     *
+     * @param _
+     * @param responder
      */
     private updateAuthToken;
     /**
@@ -110,36 +124,47 @@ export declare class TsEmbed {
     private registerAppInit;
     /**
      * Constructs the base URL string to load the ThoughtSpot app.
+     *
+     * @param query
      */
     protected getEmbedBasePath(query: string): string;
     /**
      * Common query params set for all the embed modes.
+     *
+     * @param queryParams
      * @returns queryParams
      */
-    protected getBaseQueryParams(): {};
+    protected getBaseQueryParams(queryParams?: {}): {};
     /**
      * Constructs the base URL string to load v1 of the ThoughtSpot app.
      * This is used for embedding Liveboards, visualizations, and full application.
+     *
      * @param queryString The query string to append to the URL.
      * @param isAppEmbed A Boolean parameter to specify if you are embedding
      * the full application.
      */
-    protected getV1EmbedBasePath(queryString: string, showPrimaryNavbar?: boolean, disableProfileAndHelp?: boolean, isAppEmbed?: boolean, enableSearchAssist?: boolean): string;
+    protected getV1EmbedBasePath(queryString: string): string;
+    protected getEmbedParams(): string;
+    protected getRootIframeSrc(): string;
+    protected createIframeEl(frameSrc: string): HTMLIFrameElement;
     /**
      * Renders the embedded ThoughtSpot app in an iframe and sets up
      * event listeners.
+     *
      * @param url
      * @param frameOptions
      */
-    protected renderIFrame(url: string, frameOptions?: FrameParams): Promise<any>;
+    protected renderIFrame(url: string): Promise<any>;
     protected insertIntoDOM(child: string | Node): void;
     /**
      * Sets the height of the iframe
+     *
      * @param height The height in pixels
      */
     protected setIFrameHeight(height: number): void;
     /**
      * Executes all registered event handlers for a particular event type
+     *
      * @param eventType The event type
      * @param data The payload invoked with the event handler
      * @param eventPort The event Port for a specific MessageChannel
@@ -151,6 +176,7 @@ export declare class TsEmbed {
     protected getThoughtSpotHost(): string;
     /**
      * Gets the v1 event type (if applicable) for the EmbedEvent type
+     *
      * @param eventType The v2 event type
      * @returns The corresponding v1 event type if one exists
      * or else the v2 event type itself
@@ -160,6 +186,7 @@ export declare class TsEmbed {
      * Calculates the iframe center for the current visible viewPort
      * of iframe using Scroll position of Host App, offsetTop for iframe
      * in Host app. ViewPort height of the tab.
+     *
      * @returns iframe Center in visible viewport,
      *  Iframe height,
      *  View port height.
@@ -194,15 +221,32 @@ export declare class TsEmbed {
      * ```
      */
     on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
+    /**
+     * Removes an event listener for a particular event type.
+     *
+     * @param messageType The message type
+     * @param callback The callback to remove
+     * @example
+     * ```js
+     * const errorHandler = (data) => { console.error(data); };
+     * tsEmbed.on(EmbedEvent.Error, errorHandler);
+     * tsEmbed.off(EmbedEvent.Error, errorHandler);
+     * ```
+     */
+    off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
     /**
      * Triggers an event on specific Port registered against
      * for the EmbedEvent
+     *
      * @param eventType The message type
      * @param data The payload to send
+     * @param eventPort
+     * @param payload
      */
     private triggerEventOnPort;
     /**
      * Triggers an event to the embedded app
+     *
      * @param messageType The event type
      * @param data The payload to send with the message
      */
@@ -211,6 +255,7 @@ export declare class TsEmbed {
      * Marks the ThoughtSpot object to have been rendered
      * Needs to be overridden by subclasses to do the actual
      * rendering of the iframe.
+     *
      * @param args
      */
     render(): TsEmbed;
@@ -218,14 +263,26 @@ 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;
     /**
      * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
+     *
      * @version SDK: 1.19.1 | ThoughtSpot: *
      */
     destroy(): void;
+    getUnderlyingFrameElement(): HTMLIFrameElement;
+    /**
+     * Prerenders a generic instance of the TS component.
+     * This means without the path but with the flags already applied.
+     * This is useful for prerendering the component in the background.
+     *
+     * @version SDK: 1.21.0 | ThoughtSpot: * / Search: 9.3.0.cl
+     * @returns
+     */
+    prerenderGeneric(): Promise<any>;
 }
 /**
  * Base class for embedding v1 experience
@@ -239,12 +296,13 @@ export declare class V1Embed extends TsEmbed {
     constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
     /**
      * Render the ap    p in an iframe and set up event handlers
+     *
      * @param iframeSrc
      */
     protected renderV1Embed(iframeSrc: string): any;
+    protected getRootIframeSrc(): string;
     /**
-     * @inheritdoc TsEmbed.on
-     *
+     * @inheritdoc
      * @example
      * ```js
      * tsEmbed.on(EmbedEvent.Error, (data) => {

package/lib/src/embed/ts-embed.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ts-embed.d.ts","sourceRoot":"","sources":["../../../src/embed/ts-embed.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAkBH,OAAO,EAEH,WAAW,EACX,SAAS,EACT,UAAU,EACV,eAAe,EAGf,WAAW,EACX,cAAc,EAGd,UAAU,EACV,WAAW,EAEd,MAAM,UAAU,CAAC;AAgBlB;;GAEG;AACH,eAAO,MAAM,wBAAwB,QAAQ,CAAC;AAW9C;;;;GAIG;AACH,qBAAa,OAAO;IAChB;;;;;OAKG;IACH,OAAO,CAAC,aAAa,CAAO;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAU;IAEpB;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEpC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;IAEjC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAKlC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAAoC;IAE3D;;OAEG;IACH,OAAO,CAAC,UAAU,CAAU;IAE5B;;OAEG;IACH,OAAO,CAAC,OAAO,CAAU;IAEzB;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B,CAAS;IAE3C,OAAO,CAAC,oBAAoB,CAAwB;gBAExC,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,UAAU;IAa7D;;OAEG;IACH,OAAO,CAAC,cAAc;IAItB;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAS7D;;;OAGG;IACH,OAAO,CAAC,YAAY;IAKpB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAOpB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAWvB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAoBzB;;OAEG;IACH,OAAO,CAAC,SAAS,CAef;IAEF;;OAEG;IACH,OAAO,CAAC,eAAe,CAYrB;IAEF;;OAEG;IACH,OAAO,CAAC,eAAe,CAGrB;IAEF;;OAEG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAkBjD;;;OAGG;IACH,SAAS,CAAC,kBAAkB;IA+G5B;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CACxB,WAAW,EAAE,MAAM,EACnB,iBAAiB,UAAQ,EACzB,qBAAqB,UAAQ,EAC7B,UAAU,UAAQ,EAClB,kBAAkB,UAAQ,GAC3B,MAAM;IAsBT;;;;;OAKG;cACa,YAAY,CACxB,GAAG,EAAE,MAAM,EACX,YAAY,GAAE,WAAgB,GAC/B,OAAO,CAAC,GAAG,CAAC;IA8Gf,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAwBnD;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI/C;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CACtB,SAAS,EAAE,UAAU,EACrB,IAAI,EAAE,GAAG,EACT,SAAS,CAAC,EAAE,WAAW,GAAG,IAAI,GAC/B,IAAI;IAmBP;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,MAAM;IAItC;;;;;OAKG;IACH,SAAS,CAAC,sBAAsB,CAAC,SAAS,EAAE,UAAU,GAAG,UAAU;IAInE;;;;;;;OAOG;IACH,SAAS,CAAC,eAAe;;;;;;;IAkCzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,EAAE,CACL,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,GAC3C,OAAO,OAAO,CAAC,SAAS;IAY3B;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;;;OAIG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpE;;;;;OAKG;IACI,MAAM,IAAI,OAAO;IAMxB;;;;;OAKG;IACI,2BAA2B,IAAI,MAAM;IAuB5C;;;OAGG;IACI,OAAO,IAAI,IAAI;CAOzB;AAED;;;;;;GAMG;AACH,qBAAa,OAAQ,SAAQ,OAAO;IAChC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;gBAErB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU;IAK5D;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG;IAI/C;;;;;;;;;;;;;;;;;OAiBG;IACI,EAAE,CACL,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,GAC3C,OAAO,OAAO,CAAC,SAAS;CAK9B"}
+{"version":3,"file":"ts-embed.d.ts","sourceRoot":"","sources":["../../../src/embed/ts-embed.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAoBH,OAAO,EAEH,WAAW,EACX,SAAS,EACT,UAAU,EACV,eAAe,EAGf,WAAW,EACX,cAAc,EAGd,UAAU,EAIb,MAAM,UAAU,CAAC;AAgBlB;;GAEG;AACH,eAAO,MAAM,wBAAwB,QAAQ,CAAC;AAY9C;;;;GAIG;AACH,qBAAa,OAAO;IAChB;;;;;OAKG;IACH,OAAO,CAAC,aAAa,CAAO;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAU;IAEpB,SAAS,CAAC,gBAAgB,UAAS;IAEnC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEpC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;IAEjC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAKlC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAAoC;IAE3D;;OAEG;IACH,OAAO,CAAC,UAAU,CAAU;IAE5B;;OAEG;IACH,OAAO,CAAC,OAAO,CAAU;IAEzB;;;;;;OAMG;IACH,OAAO,CAAC,0BAA0B,CAAS;IAE3C,OAAO,CAAC,oBAAoB,CAAwB;gBAExC,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,UAAU;IAa7D;;OAEG;IACH,OAAO,CAAC,cAAc;IAItB;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAS7D;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAKpB;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAOpB;;;;;;;OAOG;IACH,OAAO,CAAC,eAAe;IAWvB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAezB;;;;;OAKG;IACH,OAAO,CAAC,SAAS,CAaf;IAEF;;;;;OAKG;IACH,OAAO,CAAC,eAAe,CAYrB;IAEF;;OAEG;IACH,OAAO,CAAC,eAAe,CAGrB;IAEF;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAcjD;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,CAAC,WAAW,KAAK;IA8F7C;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAQzD,SAAS,CAAC,cAAc;IAKxB,SAAS,CAAC,gBAAgB;IAK1B,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB;IAmC7D;;;;;;OAMG;cACa,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmEvD,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAwBnD;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI/C;;;;;;OAMG;IACH,SAAS,CAAC,gBAAgB,CACtB,SAAS,EAAE,UAAU,EACrB,IAAI,EAAE,GAAG,EACT,SAAS,CAAC,EAAE,WAAW,GAAG,IAAI,GAC/B,IAAI;IAqBP;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,MAAM;IAItC;;;;;;OAMG;IACH,SAAS,CAAC,sBAAsB,CAAC,SAAS,EAAE,UAAU,GAAG,UAAU;IAInE;;;;;;;;OAQG;IACH,SAAS,CAAC,eAAe;;;;;;;IA2BzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,EAAE,CACL,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,GAC3C,OAAO,OAAO,CAAC,SAAS;IAU3B;;;;;;;;;;;OAWG;IACI,GAAG,CACN,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,GAC1B,OAAO,OAAO,CAAC,SAAS;IAS3B;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAKpE;;;;;;OAMG;IACI,MAAM,IAAI,OAAO;IAMxB;;;;;;OAMG;IACI,2BAA2B,IAAI,MAAM;IAuB5C;;;;OAIG;IACI,OAAO,IAAI,IAAI;IAQf,yBAAyB,IAAI,iBAAiB;IAIrD;;;;;;;OAOG;IACU,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;CAIhD;AAED;;;;;;GAMG;AACH,qBAAa,OAAQ,SAAQ,OAAO;IAChC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;gBAErB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU;IAK5D;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG;IAI/C,SAAS,CAAC,gBAAgB,IAAI,MAAM;IAQpC;;;;;;;;;;;;;;;;OAgBG;IACI,EAAE,CACL,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,GAC3C,OAAO,OAAO,CAAC,SAAS;CAK9B"}