@thoughtspot/visual-embed-sdk 1.24.0-alpha.1 → 1.24.0-alpha.3

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

@@ -21,7 +21,7 @@ interface SearchProps extends EmbedProps, SearchViewConfig {
     * }
     * ```
     */
-export const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<TsEmbed>>;
+export const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<_SearchEmbed>>;
 interface AppProps extends EmbedProps, AppViewConfig {
 }
 /**
@@ -38,7 +38,7 @@ interface AppProps extends EmbedProps, AppViewConfig {
     * }
     * ```
     */
-export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<TsEmbed>>;
+export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<_AppEmbed>>;
 interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
 }
 /**
@@ -56,8 +56,8 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
     * }
     * ```
     */
-export const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
-export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
+export const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
+export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
 interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
 }
 /**
@@ -73,7 +73,7 @@ interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
     * }
     * ```
     */
-export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<TsEmbed>>;
+export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<_SearchBarEmbed>>;
 interface SageEmbedProps extends EmbedProps, SageViewConfig {
 }
 /**
@@ -89,7 +89,8 @@ interface SageEmbedProps extends EmbedProps, SageViewConfig {
     * }
     * ```
     */
-export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<TsEmbed>>;
+export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<_SageEmbed>>;
+type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
 /**
     * Get a reference to the embed component to trigger events on the component.
     *
@@ -105,9 +106,9 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
     * return <LiveboardEmbed ref={ref} liveboardId={<id>} />
     * }
     * ```
-    * @returns {React.MutableRefObject<TsEmbed>} ref
+    * @returns {React.MutableRefObject<T extends TsEmbed>} ref
     */
-export const useEmbedRef: () => React.MutableRefObject<TsEmbed>;
+export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<React.ComponentRef<T>>;
 
 /**
   * Copyright (c) 2023
@@ -449,12 +450,24 @@ export interface AppViewConfig extends ViewConfig {
         /**
             * A URL path within the app that is to be embedded.
             * If both path and pageId attributes are defined, the path definition
-            * takes precedence.
+            * takes precedence. This is the path post the `#/` in the URL of the standalone
+            * ThoughtSpot app. Use this to open the embedded view to a specific path.
+            *
+            * For eg, if you want the component to open to a specific liveboard
+            * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
+            *
+            * @example
+            * ```
+            * <AppEmbed path="pinboard/1234/tab/7464" />
+            * ```
             */
         path?: string;
         /**
             * The application page to set as the start page
             * in the embedded view.
+            *
+            * 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.
             */
         pageId?: Page;
         /**
@@ -496,6 +509,13 @@ export interface AppViewConfig extends ViewConfig {
             * @hidden
             */
         dataPanelV2?: boolean;
+        /**
+            * Flag to control new Modular Home experience
+            *
+            * @default false
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        modularHomeExperience?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -677,233 +697,6 @@ export declare class LiveboardEmbed extends V1Embed {
 export declare class PinboardEmbed extends LiveboardEmbed {
 }
 
-/**
-    * Copyright (c) 2022
-    *
-    * Base classes
-    *
-    * @summary Base classes
-    * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
-    */
-/**
-    * Global prefix for all Thoughtspot postHash Params.
-    */
-export declare const THOUGHTSPOT_PARAM_PREFIX = "ts-";
-/**
-    * 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 {
-        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;
-        constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
-        /**
-            * Handles errors within the SDK
-            *
-            * @param error The error message or object
-            */
-        protected handleError(error: string | Record<string, unknown>): void;
-        /**
-            * 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;
-        /**
-            * Renders the embedded ThoughtSpot app in an iframe and sets up
-            * event listeners.
-            *
-            * @param url
-            * @param frameOptions
-            */
-        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 | 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
-            * @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): 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 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;
-        /**
-            * 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>;
-}
-/**
-    * Base class for embedding v1 experience
-    * Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
-    * which is currently under migration to v2
-    *
-    * @inheritdoc
-    */
-export declare class V1Embed extends TsEmbed {
-        protected viewConfig: ViewConfig;
-        constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
-        /**
-            * Render the app in an iframe and set up event handlers
-            *
-            * @param iframeSrc
-            */
-        protected renderV1Embed(iframeSrc: string): any;
-        protected getRootIframeSrc(): string;
-        /**
-            * @inheritdoc
-            * @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): typeof TsEmbed.prototype;
-}
-
 export type EmbedEventHandlers = {
     [key in keyof typeof EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
 };
@@ -3300,7 +3093,8 @@ export declare enum Param {
         HideTabPanel = "hideTabPanel",
         HideSampleQuestions = "hideSampleQuestions",
         WorksheetId = "worksheet",
-        Query = "query"
+        Query = "query",
+        ModularHomeExperienceEnabled = "modularHomeExperience"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -4441,3 +4235,232 @@ export interface CustomCssVariables {
         '--ts-var-dialog-footer-background'?: string;
 }
 
+/**
+    * Copyright (c) 2022
+    *
+    * Base classes
+    *
+    * @summary Base classes
+    * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+    */
+/**
+    * Global prefix for all Thoughtspot postHash Params.
+    */
+export declare const THOUGHTSPOT_PARAM_PREFIX = "ts-";
+/**
+    * 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 {
+        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;
+        constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
+        /**
+            * Handles errors within the SDK
+            *
+            * @param error The error message or object
+            */
+        protected handleError(error: string | Record<string, unknown>): void;
+        /**
+            * 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;
+        /**
+            * Renders the embedded ThoughtSpot app in an iframe and sets up
+            * event listeners.
+            *
+            * @param url
+            * @param frameOptions
+            */
+        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 | 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 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;
+        /**
+            * 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>;
+}
+/**
+    * Base class for embedding v1 experience
+    * Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
+    * which is currently under migration to v2
+    *
+    * @inheritdoc
+    */
+export declare class V1Embed extends TsEmbed {
+        protected viewConfig: ViewConfig;
+        constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
+        /**
+            * Render the app in an iframe and set up event handlers
+            *
+            * @param iframeSrc
+            */
+        protected renderV1Embed(iframeSrc: string): any;
+        protected getRootIframeSrc(): string;
+        /**
+            * @inheritdoc
+            * @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): typeof TsEmbed.prototype;
+}
+