@thoughtspot/visual-embed-sdk 1.35.2 → 1.35.4

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

@@ -259,7 +259,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, };
 
 /**
     * @group Embed components
@@ -1170,7 +1170,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+            * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
             * @type {boolean}
             * @default false
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -1484,7 +1484,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         enableAskSage?: boolean;
         /**
-            * This flag is used to enable the 2 column layout in liveboard
+            * This flag is used to enable the 2 column layout on a Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -1519,7 +1519,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showPreviewLoader?: boolean;
         /**
-            * This flag is used to enable the compact header in liveboard
+            * This flag is used to enable the compact header on a Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -1533,7 +1533,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         isLiveboardCompactHeaderEnabled?: boolean;
         /**
-            * This flag is used to show/hide verified Icon in liveboard compact header
+            * This flag is used to show/hide verified icon in the Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1547,7 +1547,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * This flag is used to show/hide the re-verify banner
+            * in Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1561,7 +1562,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showLiveboardReverifyBanner?: boolean;
         /**
-            * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+            * This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
             * @type {boolean}
             * @default false
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -1641,7 +1642,7 @@ export declare class LiveboardEmbed extends V1Embed {
             * @param messageType The event type
             * @param data The payload to send with the message
             */
-        trigger(messageType: HostEvent, data?: any): Promise<any>;
+        trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
         /**
             * Render an embedded ThoughtSpot Liveboard or visualization
             * @param renderOptions An object specifying the Liveboard ID,
@@ -1650,8 +1651,8 @@ export declare class LiveboardEmbed extends V1Embed {
         render(): Promise<LiveboardEmbed>;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
         /**
-            * Returns the full url of the liveboard/viz which can be used to open
-            * this liveboard inside the full Thoughtspot application in a new tab.
+            * Returns the full url of the Liveboard/visualization which can be used to open
+            * this Liveboard inside the full Thoughtspot application in a new tab.
             * @returns url string
             */
         getLiveboardUrl(): string;
@@ -1783,7 +1784,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
 /**
     * Initializes the Visual Embed SDK globally and perform
     * authentication if applicable. This function needs to be called before any ThoughtSpot
-    * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+    * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
     * to actually embed. That is handled internally.
     * @param embedConfig The configuration object containing ThoughtSpot host,
     * authentication mechanism and so on.
@@ -3212,8 +3213,12 @@ export interface ViewConfig {
             */
         enableCustomColumnGroups?: boolean;
         /**
-            * View content for another org directly without having to use the org switcher
-            * This flag is honoured if orgPerUrl feature is enabled for the ThoughtSpot cluster
+            * Overrides an Org context for embedding application users.
+            * This parameter allows a user authenticated to one Org to view the
+            * objects from another Org.
+            * The `overrideOrgId` setting is honoured only if the
+            * Per Org URL feature is enabled on your ThoughtSpot instance.
+            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -3821,8 +3826,8 @@ export declare enum EmbedEvent {
             *
             * **Note**: This event is deprecated in v1.21.0.
             * To fire an event when a download action is initiated on a chart or table,
-            * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
-            * or `EmbedEvent.DownloadAsXLSX`
+            * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
+            * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -4470,7 +4475,7 @@ export declare enum HostEvent {
             * @param - autoDrillDown - Optional. If true, the drill down will be
             * done automatically on the most popular column.
             * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
-            * in case of a liveboard.
+            * in case of a Liveboard.
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -4557,26 +4562,26 @@ export declare enum HostEvent {
             */
         SetActiveTab = "SetActiveTab",
         /**
-            * Update runtime filters applied on a Saved Answer or Liveboard. The
-            * runtime filters passed here are appended to the existing runtime
-            * filters.
+            * Updates the runtime filters applied on a Liveboard. The filter
+            * attributes passed with this event are appended to the existing runtime
+            * filters applied on a Liveboard.
+            *
             * Pass an array of runtime filters with the following attributes:
             *
-            * `columnName`
-            * _String_. The name of the column to filter on.
+            * `columnName` - _String_. The name of the column to filter on.
             *
-            * `operator`
-            * Runtime filter operator to apply. For information,
+            * `operator` - Runtime filter operator to apply. For more information,
             * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
             *
-            * `values`
-            * List of operands. Some operators such as EQ, LE allow a single value, whereas
-            * operators such as BW and IN accept multiple operands.
+            * `values` - List of operands. Some operators such as EQ and LE allow a
+            * single value, whereas BW and IN accept multiple values.
+            *
+            * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
+            * and `AppEmbed` only. In full application embedding, this event updates
+            * the runtime filters applied on the Liveboard and saved Answer objects.
             *
-            * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
-            * Search embedding (SearchEmbed) and Natural Language Search
-            * embedding (SageEmbed).
             * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
@@ -5275,7 +5280,7 @@ export declare enum HostEvent {
             */
         ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
         /**
-            * Triggers Update RuntimeParameters for answers and liveboard
+            * Triggers an event to Update Parameter values for Answers and Liveboard
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -5297,13 +5302,23 @@ export declare enum HostEvent {
             */
         GetParameters = "GetParameters",
         /**
-            * Triggers update of persoanlised view for a liveboard
+            * Triggers an event to update a persoanlised view of a Liveboard
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
             * ```
             * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
             */
-        UpdatePersonalisedView = "UpdatePersonalisedView"
+        UpdatePersonalisedView = "UpdatePersonalisedView",
+        /**
+            * Triggers the action to get the current view of the liveboard
+            * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+            */
+        SaveAnswer = "saveAnswer",
+        /**
+            * EmbedApi
+            * @hidden
+            */
+        UIPassthrough = "UiPassthrough"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -6276,7 +6291,7 @@ export declare enum Action {
             */
         ModifySageAnswer = "modifySageAnswer",
         /**
-            * The **Move to Tab** menu action on visualizations in liveboard edit mode.
+            * The **Move to Tab** menu action on visualizations in Liveboard edit mode.
             * Allows moving a visualization to a different tab.
             * @example
             * ```js
@@ -6329,7 +6344,8 @@ export declare enum Action {
             */
         TML = "tml",
         /**
-            * Action Id for CreateLiveboard for liveboard list page & Pin Modal
+            * Action ID for the create Liveboard option on the Liveboard list page
+            * and Pin modal
             * @example
             * ```js
             * hiddenAction: [Action.CreateLiveboard]
@@ -7316,6 +7332,84 @@ export declare const getAnswerFromQuery: (query: string, worksheetId: string) =>
   */
 export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
 
+export declare enum UIPassthroughEvent {
+    PinAnswerToLiveboard = "addVizToPinboard",
+    SaveAnswer = "saveAnswer",
+    GetDiscoverabilityStatus = "getDiscoverabilityStatus",
+    GetAvailableUIPassthroughs = "getAvailableUIPassthroughs",
+    GetAnswerConfig = "getAnswerPageConfig",
+    GetLiveboardConfig = "getPinboardPageConfig"
+}
+export type UIPassthroughContractBase = {
+    [UIPassthroughEvent.PinAnswerToLiveboard]: {
+        request: {
+            vizId?: string;
+            newVizName: string;
+            newVizDescription?: string;
+            pinboardId?: string;
+            tabId?: string;
+            newPinboardName?: string;
+            newTabName?: string;
+        };
+        response: {
+            pinboardId: string;
+            tabId: string;
+            vizId: string;
+        };
+    };
+    [UIPassthroughEvent.SaveAnswer]: {
+        request: {
+            name: string;
+            description: string;
+            vizId?: string;
+            isDiscoverable?: boolean;
+        };
+        response: {
+            answerId: string;
+            saveResponse?: any;
+            shareResponse?: any;
+        };
+    };
+    [UIPassthroughEvent.GetDiscoverabilityStatus]: {
+        request: any;
+        response: {
+            shouldShowDiscoverability: boolean;
+            isDiscoverabilityCheckboxUnselectedPerOrg: boolean;
+        };
+    };
+    [UIPassthroughEvent.GetAvailableUIPassthroughs]: {
+        request: any;
+        response: {
+            keys: string[];
+        };
+    };
+    [UIPassthroughEvent.GetAnswerConfig]: {
+        request: {
+            vizId?: string;
+        };
+        response: any;
+    };
+    [UIPassthroughEvent.GetLiveboardConfig]: {
+        request: any;
+        response: any;
+    };
+};
+export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]['request'];
+export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]['response'];
+export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> = Array<{
+    redId?: string;
+    value?: UIPassthroughResponse<ApiName>;
+    error?: any;
+}>;
+export type EmbedApiHostEventMapping = {
+    [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
+    [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
+};
+export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
+export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
+export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
+export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
+
 /**
     *
     * @param embedConfig
@@ -7370,6 +7464,11 @@ export declare class TsEmbed {
             * will be rendered.
             */
         protected iFrame: HTMLIFrameElement;
+        /**
+            * Setter for the iframe element
+            * @param {HTMLIFrameElement} iFrame HTMLIFrameElement
+            */
+        protected setIframeElement(iFrame: HTMLIFrameElement): void;
         protected viewConfig: ViewConfig;
         protected embedConfig: EmbedConfig;
         /**
@@ -7381,6 +7480,7 @@ export declare class TsEmbed {
             * A flag that is set to true post render.
             */
         protected isRendered: boolean;
+        protected hostEventClient: HostEventClient;
         constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
         /**
             * Handles errors within the SDK
@@ -7500,10 +7600,19 @@ export declare class TsEmbed {
         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
+            * @param {HostEvent} messageType The event type
+            * @param {any} data The payload to send with the message
+            * @returns A promise that resolves with the response from the embedded app
             */
-        trigger(messageType: HostEvent, data?: any): Promise<any>;
+        trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+        /**
+            * Triggers an event to the embedded app, skipping the UI flow.
+            * @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
+            * @param {UIPassthroughRequest} parameters - The parameters to be passed to the API.
+            * @returns {Promise<UIPassthroughRequest>} - A promise that resolves with the response
+            * from the embedded app.
+            */
+        triggerUIPassThrough<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
         /**
             * Marks the ThoughtSpot object to have been rendered
             * Needs to be overridden by subclasses to do the actual
@@ -7577,7 +7686,7 @@ export declare class TsEmbed {
         /**
             * Returns the answerService which can be used to make arbitrary graphql calls on top
             * session.
-            * @param vizId [Optional] to get for a specific viz in case of a liveboard.
+            * @param vizId [Optional] to get for a specific viz in case of a Liveboard.
             * @version SDK: 1.25.0 / ThoughtSpot 9.10.0
             */
         getAnswerService(vizId?: string): Promise<AnswerService>;
@@ -7622,3 +7731,26 @@ export declare class V1Embed extends TsEmbed {
         test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
 }
 
+export declare class HostEventClient {
+        iFrame: HTMLIFrameElement;
+        constructor(iFrame?: HTMLIFrameElement);
+        /**
+            * A wrapper over process trigger to
+            * @param {HostEvent} message Host event to send
+            * @param {any} data Data to send with the host event
+            * @returns {Promise<any>} - the response from the process trigger
+            */
+        protected processTrigger(message: HostEvent, data: any): Promise<any>;
+        handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
+        hostEventFallback(hostEvent: HostEvent, data: any): Promise<any>;
+        /**
+            * Setter for the iframe element used for host events
+            * @param {HTMLIFrameElement} iFrame - the iframe element to set
+            */
+        setIframeElement(iFrame: HTMLIFrameElement): void;
+        triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
+        protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
+        protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>): Promise<any>;
+        triggerHostEvent<HostEventT extends HostEvent, PayloadT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+}
+