@thoughtspot/visual-embed-sdk 1.24.0-dev → 1.24.0-preRender.1

package/dist/visual-embed-sdk.d.ts

@@ -13,7 +13,7 @@ import EventEmitter from 'eventemitter3';
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
 
 /**
     * Copyright (c) 2022
@@ -172,6 +172,7 @@ export interface AppViewConfig extends ViewConfig {
     */
 export class AppEmbed extends V1Embed {
         protected viewConfig: AppViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
         /**
             * Constructs a map of parameters to be passed on to the
@@ -203,8 +204,10 @@ export class AppEmbed extends V1Embed {
             *
             * @param renderOptions An object containing the page ID
             * to be embedded.
+            * @param showPreRenderByDefault
             */
-        render(): AppEmbed;
+        render(showPreRenderByDefault?: boolean): AppEmbed;
+        preRender(showPreRenderByDefault?: boolean): AppEmbed;
 }
 
 export interface executeTMLInput {
@@ -298,6 +301,7 @@ export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) =
     *
     * @param data
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    * @group Global methods
     */
 export const executeTML: (data: executeTMLInput) => Promise<any>;
 /**
@@ -306,6 +310,7 @@ export const executeTML: (data: executeTMLInput) => Promise<any>;
     *
     * @param data
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    * @group Global methods
     */
 export const exportTML: (data: exportTMLInput) => Promise<any>;
 /**
@@ -427,6 +432,7 @@ export interface LiveboardViewConfig extends ViewConfig {
     */
 export class LiveboardEmbed extends V1Embed {
         protected viewConfig: LiveboardViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
         /**
             * Construct a map of params to be passed on to the
@@ -446,8 +452,8 @@ export class LiveboardEmbed extends V1Embed {
             * @param renderOptions An object specifying the Liveboard ID,
             * visualization ID and the runtime filters.
             */
-        render(): LiveboardEmbed;
-        preRender(): LiveboardEmbed;
+        render(showPreRenderByDefault?: boolean): LiveboardEmbed;
+        preRender(showPreRenderByDefault?: boolean): LiveboardEmbed;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
 }
 /**
@@ -575,12 +581,16 @@ export class SearchEmbed extends TsEmbed {
             * The view configuration for the embedded ThoughtSpot search.
             */
         protected viewConfig: SearchViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
         protected getEmbedParams(): string;
         /**
             * Render the embedded ThoughtSpot search
+            *
+            * @param showPreRenderByDefault
             */
-        render(): SearchEmbed;
+        render(showPreRenderByDefault?: boolean): SearchEmbed;
+        preRender(showPreRenderByDefault?: boolean): SearchEmbed;
 }
 
 /**
@@ -622,6 +632,7 @@ export class SearchBarEmbed extends TsEmbed {
             * The view configuration for the embedded ThoughtSpot search bar.
             */
         protected viewConfig: SearchBarViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: string, viewConfig: SearchBarViewConfig);
         /**
             * Render the embedded ThoughtSpot search
@@ -1543,6 +1554,13 @@ export interface ViewConfig {
             * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
             */
         hiddenHomepageModules?: HomepageModule[];
+        /**
+            * reordering the home page modules
+            * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
+            *
+            * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
+            */
+        reorderedHomepageModules?: HomepageModule[];
         /**
             * The list of tab IDs to show in the embedded.
             * Only this Tabs will be shown in their respective LBs.
@@ -1572,7 +1590,19 @@ export interface ViewConfig {
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
         /**
-            * TBD
+            * PreRender id to be used for PreRendering the embed.
+            * Use PreRender to render the embed in the background and then
+            * show or hide the rendered embed using showPreRender or hidePreRender respectively.
+            *
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   ... // other liveboard view config
+            *   preRenderId: "preRenderId-123"
+            * });
+            * embed.showPreRender();
+            * ```
+            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         preRenderId?: string;
 }
@@ -1693,27 +1723,27 @@ export enum HomepageModule {
         /**
             * Search bar
             */
-        Search = "search",
+        Search = "SEARCH",
         /**
             * kPI watchlist module
             */
-        Watchlist = "watchlist",
+        Watchlist = "WATCHLIST",
         /**
             * favorite objects
             */
-        Favorite = "favorite",
+        Favorite = "FAVORITE",
         /**
             * List of answers and liveboards
             */
-        MyLibrary = "mylibrary",
+        MyLibrary = "MY_LIBRARY",
         /**
             * Trending list
             */
-        Trending = "trending",
+        Trending = "TRENDING",
         /**
             * Learning videos
             */
-        Learning = "learning"
+        Learning = "LEARNING"
 }
 /**
     * A filter that can be applied to ThoughtSpot answers, Liveboards, or
@@ -3884,18 +3914,6 @@ export enum Action {
             */
         PersonalisedViewsDropdown = "personalisedViewsDropdown"
 }
-export interface SessionInterface {
-        sessionId: string;
-        genNo: number;
-        acSession: {
-                sessionId: string;
-                genNo: number;
-        };
-}
-export enum OperationType {
-        GetChartWithData = "GetChartWithData",
-        GetTableWithHeadlineData = "GetTableWithHeadlineData"
-}
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
 }
@@ -3912,6 +3930,39 @@ export enum ContextMenuTriggerOptions {
         LEFT_CLICK = "left-click",
         RIGHT_CLICK = "right-click"
 }
+export interface ColumnValue {
+        column: {
+                id: string;
+                name: string;
+                dataType: string;
+                [key: string]: any;
+        };
+        value: string | number | boolean;
+}
+export interface VizPoint {
+        selectedAttributes: ColumnValue[];
+        selectedMeasures: ColumnValue[];
+}
+export interface CustomActionPayload {
+        contextMenuPoints?: {
+                clickedPoint: VizPoint;
+                selectedPoints: VizPoint[];
+        };
+        embedAnswerData: {
+                name: string;
+                id: string;
+                sources: {
+                        header: {
+                                guid: string;
+                        };
+                };
+                columns: any[];
+                data: any[];
+                [key: string]: any;
+        };
+        session: SessionInterface;
+        vizId?: string;
+}
 
 /**
     * The list of customization css variables. These
@@ -4337,6 +4388,7 @@ export class SageEmbed extends V1Embed {
             *
             */
         protected viewConfig: SageViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
         /**
             * Constructs a map of parameters to be passed on to the
@@ -4348,10 +4400,68 @@ export class SageEmbed extends V1Embed {
         /**
             * Render the embedded ThoughtSpot Sage
             *
+            * @param showPreRenderByDefault
             * @returns {SageEmbed} Eureka/Sage embed
             */
-        render(): SageEmbed;
+        render(showPreRenderByDefault?: boolean): SageEmbed;
+        preRender(showPreRenderByDefault?: boolean): SageEmbed;
+}
+
+export interface SessionInterface {
+        sessionId: string;
+        genNo: number;
+        acSession: {
+                sessionId: string;
+                genNo: number;
+        };
 }
+export enum OperationType {
+        GetChartWithData = "GetChartWithData",
+        GetTableWithHeadlineData = "GetTableWithHeadlineData"
+}
+interface UnderlyingDataPoint {
+        columnId: string;
+        dataValue: any;
+}
+/**
+    * Class representing the answer service provided with the
+    * custom action payload. This service could be used to run
+    * graphql queries in the context of the answer on which the
+    * custom action was triggered.
+    *
+    * @example
+    * ```js
+    *  embed.on(EmbedEvent.CustomAction, e => {
+    *     const underlying = await e.answerService.getUnderlyingDataForPoint([
+    *       'col name 1'
+    *     ]);
+    *     const data = await underlying.fetchData(0, 100);
+    *  })
+    * ```
+    * @version
+    * ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
+    */
+export class AnswerService {
+        constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]);
+        getSourceDetail(): Promise<any>;
+        removeColumns(columnIds: string[]): Promise<any>;
+        addColumns(columnIds: string[]): Promise<any>;
+        fetchData(offset?: number, size?: number): Promise<{
+                columns: any;
+                data: any;
+        }>;
+        /**
+            *
+            * @param userLocale
+            * @param omitInfo Omit the download Info on top of the CSV
+            * @returns Response
+            */
+        fetchCSVBlob(userLocale?: string, omitInfo?: boolean): Promise<Response>;
+        getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
+        executeQuery(query: string, variables: any): Promise<any>;
+        getSession(): SessionInterface;
+}
+export {};
 
 /**
     * Copyright (c) 2022
@@ -4384,6 +4494,7 @@ export class TsEmbed {
             */
         protected thoughtSpotHost: string;
         protected thoughtSpotV2Base: string;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
         /**
             * Handles errors within the SDK
@@ -4416,14 +4527,15 @@ export class TsEmbed {
         protected getEmbedParams(): string;
         protected getRootIframeSrc(): string;
         protected createIframeEl(frameSrc: string): HTMLIFrameElement;
+        protected handleInsertionIntoDOM(child: string | Node, showPreRenderByDefault?: boolean): void;
         /**
             * Renders the embedded ThoughtSpot app in an iframe and sets up
             * event listeners.
             *
-            * @param url
-            * @param frameOptions
+            * @param url - The URL of the embedded ThoughtSpot app.
+            * @param showPreRenderByDefault - The flag to show the preRender by default.
             */
-        protected renderIFrame(url: string): Promise<any>;
+        protected renderIFrame(url: string, showPreRenderByDefault?: boolean): Promise<any>;
         getPreRenderIds(): {
                 wrapper: string;
                 shield: string;
@@ -4431,10 +4543,10 @@ export class TsEmbed {
         };
         protected createPreRenderWrapper(child: HTMLElement): HTMLDivElement;
         protected preRenderWrapper: HTMLElement;
-        protected preRenderShield: HTMLElement;
         protected preRenderChild: HTMLElement;
+        protected connectPreRendered(): boolean;
         protected isPreRenderAvailable(): boolean;
-        protected insertIntoDOMForPreRender(child: string | HTMLElement): void;
+        protected insertIntoDOMForPreRender(child: string | HTMLElement, showPreRenderByDefault?: boolean): void;
         hidePreRender(): void;
         showPreRender(): void;
         syncPreRenderStyle(): void;
@@ -4536,8 +4648,10 @@ export class TsEmbed {
         render(): TsEmbed;
         /**
             * Creates the preRender shell
+            *
+            * @param showPreRenderByDefault
             */
-        preRender(): TsEmbed;
+        preRender(showPreRenderByDefault?: boolean): TsEmbed;
         /**
             * Get the Post Url Params for THOUGHTSPOT from the current
             * host app URL.
@@ -4577,8 +4691,9 @@ export class V1Embed extends TsEmbed {
             * Render the app in an iframe and set up event handlers
             *
             * @param iframeSrc
+            * @param showPreRenderByDefault - if true the preRender will be shown by default
             */
-        protected renderV1Embed(iframeSrc: string): any;
+        protected renderV1Embed(iframeSrc: string, showPreRenderByDefault?: boolean): any;
         protected getRootIframeSrc(): string;
         /**
             * @inheritdoc

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.24.0-dev",
+    "version": "1.24.0-preRender.1",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -139,11 +139,10 @@
         "identity-obj-proxy": "^3.0.0",
         "istanbul-merge": "^1.1.1",
         "jest": "^26.6.3",
-        "jest-puppeteer": "^4.4.0",
+        "jest-fetch-mock": "^3.0.3",
         "jsdom": "^17.0.0",
         "node-sass": "^8.0.0",
         "prettier": "2.1.2",
-        "puppeteer": "^7.0.1",
         "react": "^16.14.0",
         "react-dom": "^16.14.0",
         "react-resizable": "^1.11.0",

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

@@ -0,0 +1,302 @@
+import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig } from '../types';
+/**
+ * Base class for embedding v2 experience
+ * Note: the v2 version of ThoughtSpot Blink is built on the new stack:
+ * React+GraphQL
+ */
+export declare class TsEmbed {
+    /**
+     * The DOM node which was inserted by the SDK to either
+     * render the iframe or display an error message.
+     * This is useful for removing the DOM node when the
+     * embed instance is destroyed.
+     */
+    private insertedDomEl;
+    /**
+     * 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.
+     */
+    protected iFrame: HTMLIFrameElement;
+    protected viewConfig: ViewConfig;
+    protected embedConfig: EmbedConfig;
+    /**
+     * The ThoughtSpot hostname or IP address
+     */
+    protected thoughtSpotHost: string;
+    protected thoughtSpotV2Base: string;
+    protected embedComponentType: string;
+    /**
+     * A map of event handlers for particular message types triggered
+     * by the embedded app; multiple event handlers can be registered
+     * against a particular message type.
+     */
+    private eventHandlerMap;
+    /**
+     * A flag that is set to true post render.
+     */
+    private isRendered;
+    /**
+     * A flag to mark if an error has occurred.
+     */
+    private isError;
+    /**
+     * 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;
+    private defaultHiddenActions;
+    constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
+    /**
+     * Throws error encountered during initialization.
+     */
+    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
+     */
+    private getEventPort;
+    /**
+     * fix for ts7.sep.cl
+     * will be removed for ts7.oct.cl
+     *
+     * @param event
+     * @param eventType
+     * @hidden
+     */
+    private formatEventData;
+    private subscribedListeners;
+    /**
+     * Adds a global event listener to window for "message" events.
+     * ThoughtSpot detects if a particular event is targeted to this
+     * embed instance through an identifier contained in the payload,
+     * and executes the registered callbacks accordingly.
+     */
+    private subscribeToEvents;
+    private unsubscribeToEvents;
+    /**
+     * 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;
+    /**
+     * Register APP_INIT event and sendback init payload
+     */
+    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(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): string;
+    protected getEmbedParams(): string;
+    protected getRootIframeSrc(): string;
+    protected createIframeEl(frameSrc: string): HTMLIFrameElement;
+    protected handleInsertionIntoDOM(child: string | Node, showPreRenderByDefault?: boolean): void;
+    /**
+     * Renders the embedded ThoughtSpot app in an iframe and sets up
+     * event listeners.
+     *
+     * @param url - The URL of the embedded ThoughtSpot app.
+     * @param showPreRenderByDefault - The flag to show the preRender by default.
+     */
+    protected renderIFrame(url: string, showPreRenderByDefault?: boolean): Promise<any>;
+    getPreRenderIds(): {
+        wrapper: string;
+        shield: string;
+        child: string;
+    };
+    protected createPreRenderWrapper(child: HTMLElement): HTMLDivElement;
+    protected preRenderWrapper: HTMLElement;
+    protected preRenderChild: HTMLElement;
+    protected connectPreRendered(): boolean;
+    protected isPreRenderAvailable(): boolean;
+    protected insertIntoDOMForPreRender(child: string | HTMLElement, showPreRenderByDefault?: boolean): void;
+    hidePreRender(): void;
+    showPreRender(): void;
+    syncPreRenderStyle(): void;
+    protected insertIntoDOM(child: string | Node): void;
+    /**
+     * Sets the height of the iframe
+     *
+     * @param height The height in pixels
+     */
+    protected setIFrameHeight(height: number | string): 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
+     */
+    protected executeCallbacks(eventType: EmbedEvent, data: any, eventPort?: MessagePort | void): void;
+    /**
+     * Returns the ThoughtSpot hostname or IP address.
+     */
+    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
+     */
+    protected getCompatibleEventType(eventType: EmbedEvent): EmbedEvent;
+    /**
+     * 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.
+     */
+    protected getIframeCenter(): {
+        iframeCenter: number;
+        iframeScrolled: number;
+        iframeHeight: number;
+        viewPortHeight: number;
+        iframeVisibleViewPort: number;
+    };
+    /**
+     * Registers an event listener to trigger an alert when the ThoughtSpot app
+     * sends an event of a particular message type to the host application.
+     *
+     * @param messageType The message type
+     * @param callback A callback as a function
+     * @param options The message options
+     * @param isSelf
+     * @param isRegisteredBySDK
+     * @example
+     * ```js
+     * tsEmbed.on(EmbedEvent.Error, (data) => {
+     *   console.error(data);
+     * });
+     * ```
+     * @example
+     * ```js
+     * tsEmbed.on(EmbedEvent.Save, (data) => {
+     *   console.log("Answer save clicked", data);
+     * }, {
+     *   start: true // This will trigger the callback on start of save
+     * });
+     * ```
+     */
+    on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): 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
+     */
+    trigger(messageType: HostEvent, data?: any): Promise<any>;
+    /**
+     * 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;
+    private isPreRendered;
+    /**
+     * Creates the preRender shell
+     *
+     * @param showPreRenderByDefault
+     */
+    preRender(showPreRenderByDefault?: boolean): 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.22.0
+     * @returns
+     */
+    prerenderGeneric(): Promise<any>;
+}
+//# sourceMappingURL=TsEmbed.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TsEmbed.d.ts","sourceRoot":"","sources":["../../../src/embed/TsEmbed.ts"],"names":[],"mappings":"AAkBA,OAAO,EAEL,WAAW,EACX,SAAS,EACT,UAAU,EACV,eAAe,EAGf,WAAW,EACX,cAAc,EACd,UAAU,EACX,MAAM,UAAU,CAAC;AAclB;;;;GAIG;AAEH,qBAAa,OAAO;IAClB;;;;;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,SAAS,CAAC,kBAAkB,SAAa;IAEzC;;;;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;IAoB7D;;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,OAAO,CAAC,mBAAmB,CAAM;IAEjC;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAqCzB,OAAO,CAAC,mBAAmB;IAM3B;;;;;OAKG;IACH,OAAO,CAAC,SAAS,CAsBf;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;IA8G7C;;;;;;;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;IAkC7D,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,sBAAsB,UAAQ,GAAG,IAAI;IAU5F;;;;;;OAMG;cACa,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,sBAAsB,UAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAwEhF,eAAe;;;;;IAQtB,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAE,WAAW,GAAG,cAAc;IA8BpE,SAAS,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAGxC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC;IAEtC,SAAS,CAAC,kBAAkB,IAAI,OAAO;IAiBvC,SAAS,CAAC,oBAAoB,IAAI,OAAO;IAIzC,SAAS,CAAC,yBAAyB,CACjC,KAAK,EAAE,MAAM,GAAG,WAAW,EAC3B,sBAAsB,UAAQ,GAC7B,IAAI;IAqBA,aAAa,IAAI,IAAI;IAgCrB,aAAa,IAAI,IAAI;IAqBrB,kBAAkB,IAAI,IAAI;IAWjC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAwBnD;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAIxD;;;;;;OAMG;IACH,SAAS,CAAC,gBAAgB,CACxB,SAAS,EAAE,UAAU,EACrB,IAAI,EAAE,GAAG,EACT,SAAS,CAAC,EAAE,WAAW,GAAG,IAAI,GAC7B,IAAI;IAoBP;;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;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,EAAE,CACP,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,EAC1C,iBAAiB,UAAQ,GACxB,OAAO,OAAO,CAAC,SAAS;IAa3B;;;;;;;;;;;OAWG;IACI,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,eAAe,GAAG,OAAO,OAAO,CAAC,SAAS;IASxF;;;;;;;;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,OAAO,CAAC,aAAa,CAAU;IAE/B;;;;OAIG;IACI,SAAS,CAAC,sBAAsB,UAAQ,GAAG,OAAO;IAKzD;;;;;;OAMG;IACI,2BAA2B,IAAI,MAAM;IAuB5C;;;;OAIG;IACI,OAAO,IAAI,IAAI;IASf,yBAAyB,IAAI,iBAAiB;IAIrD;;;;;;;OAOG;IACU,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;CAI9C"}