@thoughtspot/visual-embed-sdk 1.26.2 → 1.26.4

package/src/types.ts

@@ -541,7 +541,7 @@ export interface EmbedConfig {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface LayoutConfig {}
+export interface LayoutConfig { }
 
 /**
  * Embedded iFrame configuration
@@ -817,6 +817,12 @@ export interface ViewConfig {
      * const myComponent = new MyComponent(config);
      */
     doNotTrackPreRenderSize?: boolean;
+    /**
+     * For internal tracking of the embed component type.
+     *
+     * @hidden
+     */
+    embedComponentType?: string;
 }
 
 /**
@@ -3225,15 +3231,15 @@ export interface ColumnValue {
         [key: string]: any;
     };
     value:
-        | string
-        | number
-        | boolean
-        | {
-              v: {
-                  s: number;
-                  e: number;
-              };
-          };
+    | string
+    | number
+    | boolean
+    | {
+        v: {
+            s: number;
+            e: number;
+        };
+    };
 }
 
 export interface VizPoint {

package/src/utils/graphql/answerService/answerService.spec.ts

@@ -74,6 +74,8 @@ describe('Answer service tests', () => {
                     id: {},
                     answer: {
                         visualizations: [{
+                            id: 'vizId',
+                        }, {
                             columns: [{
                                 column: {
                                     id: 'id1',

package/src/utils/graphql/answerService/answerService.ts

@@ -89,7 +89,9 @@ export class AnswerService {
                 },
             },
         );
-        const { columns, data } = answer.visualizations[0];
+        const { columns, data } = answer.visualizations.find(
+            (viz: any) => !!viz.data,
+        ) || {};
         return {
             columns,
             data,

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

@@ -1,302 +0,0 @@
-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/cjs/src/embed/TsEmbed.d.ts.map

@@ -1 +0,0 @@
-{"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"}