@thoughtspot/visual-embed-sdk 1.24.0-alpha.6 → 1.24.0-dev

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

@@ -109,6 +109,7 @@ type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmb
     * @returns {React.MutableRefObject<T extends TsEmbed>} ref
     */
 export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<React.ComponentRef<T>>;
+export const PreRenderedLiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
 
 /**
   * Copyright (c) 2023
@@ -369,6 +370,10 @@ export interface SearchViewConfig extends ViewConfig {
             * @version: SDK: 1.24.0
             */
         useLastSelectedSources?: boolean;
+        /**
+            * The list of parameter override to apply to a search answer.
+            */
+        runtimeParameters?: RuntimeParameter[];
 }
 export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
@@ -673,6 +678,10 @@ export interface LiveboardViewConfig extends ViewConfig {
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         hideTabPanel?: boolean;
+        /**
+            * The list of parameter override to apply to a Liveboard.
+            */
+        runtimeParameters?: RuntimeParameter[];
 }
 /**
     * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -711,6 +720,7 @@ export declare class LiveboardEmbed extends V1Embed {
             * visualization ID and the runtime filters.
             */
         render(): LiveboardEmbed;
+        preRender(): LiveboardEmbed;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
 }
 /**
@@ -1639,6 +1649,11 @@ export interface ViewConfig {
             * visualization, or Liveboard.
             */
         runtimeFilters?: RuntimeFilter[];
+        /**
+            * The list of parameter override to apply to a search answer,
+            * visualization, or Liveboard.
+            */
+        runtimeParameters?: RuntimeParameter[];
         /**
             * The locale/language to use for the embedded view.
             *
@@ -1748,6 +1763,7 @@ export interface ViewConfig {
         /**
             * Hide the home page modules
             * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+            *
             * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
             */
         hiddenHomepageModules?: HomepageModule[];
@@ -1775,9 +1791,14 @@ export interface ViewConfig {
             * There are 8 home nav list items, we will send those item as list
             * which we want to hide for TSE.
             * eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
+            *
             * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
+        /**
+            * TBD
+            */
+        preRenderId?: string;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1938,6 +1959,20 @@ export interface RuntimeFilter {
             */
         values: (number | boolean | string)[];
 }
+/**
+    * A filter that can be applied to ThoughtSpot answers, Liveboards, or
+    * visualizations at runtime.
+    */
+export interface RuntimeParameter {
+        /**
+            * The name of the runtime parameter to filter on (case-sensitive)
+            */
+        name: string;
+        /**
+            * Values
+            */
+        value: number | boolean | string;
+}
 /**
     * Event types emitted by the embedded ThoughtSpot application.
     *
@@ -2362,21 +2397,21 @@ export declare enum EmbedEvent {
             */
         InsertIntoSlide = "insertInToSlide",
         /**
+            * @hidden
             * Emitted when a user changes any filter on a Liveboard.
-            *
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         FilterChanged = "filterChanged",
         /**
             *  Emitted when a user click on Go button in Sage Embed
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageEmbedQuery = "sageEmbedQuery",
         /**
             * Emitten when a user select data source in Sage Embed
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageWorksheetUpdated = "sageWorksheetUpdated",
         /**
@@ -2384,7 +2419,52 @@ export declare enum EmbedEvent {
             *
             * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
             */
-        UpdateConnection = "updateConnection"
+        UpdateConnection = "updateConnection",
+        /**
+            * Emitted when name, status (private or public) or filter values of a
+            * PersonalisedView is updated.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        UpdatePersonalisedView = "updatePersonalisedView",
+        /**
+            * Emitted when a PersonalisedView is saved.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        SavePersonalisedView = "savePersonalisedView",
+        /**
+            * Emitted when a Liveboard is reset.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        ResetLiveboard = "resetLiveboard",
+        /**
+            * Emitted when a PersonalisedView is deleted.
+            *
+            * @returns views: string[]
+            * @returns liveboardId: string
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        DeletePersonalisedView = "deletePersonalisedView",
+        /**
+            * Emitten when a user creates a new worksheet
+            *
+            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        CreateWorksheet = "createWorksheet"
 }
 /**
     * Event types that can be triggered by the host application
@@ -3027,16 +3107,16 @@ export declare enum HostEvent {
             */
         ResetSearch = "resetSearch",
         /**
+            * @hidden
             * Gets the currents visible and runtime filters applied on a Liveboard
-            *
             * @example
             * liveboardEmbed.trigger(HostEvent.GetFilters)
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         GetFilters = "getFilters",
         /**
+            * @hidden
             * Updates the visible filters on the Liveboard.
-            *
             * @param - filter: filter object containing column name and filter operation and values
             * @example
             *
@@ -4016,7 +4096,17 @@ export declare enum Action {
             * disabledActions: [Action.ManageMonitor]
             * ```
             */
-        ManageMonitor = "ManageMonitor"
+        ManageMonitor = "ManageMonitor",
+        /**
+            * Action ID for Liveboard Personalised Views dropdown
+            *
+            *  @example
+            * ```js
+            * disabledActions: [Action.PersonalisedViewsDropdown]
+            * ```
+            *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        PersonalisedViewsDropdown = "personalisedViewsDropdown"
 }
 export interface SessionInterface {
         sessionId: string;
@@ -4459,6 +4549,20 @@ export declare class TsEmbed {
             * @param frameOptions
             */
         protected renderIFrame(url: string): Promise<any>;
+        getPreRenderIds(): {
+                wrapper: string;
+                shield: string;
+                child: string;
+        };
+        protected createPreRenderWrapper(child: HTMLElement): HTMLDivElement;
+        protected preRenderWrapper: HTMLElement;
+        protected preRenderShield: HTMLElement;
+        protected preRenderChild: HTMLElement;
+        protected isPreRenderAvailable(): boolean;
+        protected insertIntoDOMForPreRender(child: string | HTMLElement): void;
+        hidePreRender(): void;
+        showPreRender(): void;
+        syncPreRenderStyle(): void;
         protected insertIntoDOM(child: string | Node): void;
         /**
             * Sets the height of the iframe
@@ -4555,6 +4659,10 @@ export declare class TsEmbed {
             * @param args
             */
         render(): TsEmbed;
+        /**
+            * Creates the preRender shell
+            */
+        preRender(): TsEmbed;
         /**
             * Get the Post Url Params for THOUGHTSPOT from the current
             * host app URL.

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

@@ -109,6 +109,7 @@ type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmb
     * @returns {React.MutableRefObject<T extends TsEmbed>} ref
     */
 export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<React.ComponentRef<T>>;
+export const PreRenderedLiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
 
 /**
     * @group Embed components
@@ -358,6 +359,10 @@ export interface SearchViewConfig extends ViewConfig {
             * @version: SDK: 1.24.0
             */
         useLastSelectedSources?: boolean;
+        /**
+            * The list of parameter override to apply to a search answer.
+            */
+        runtimeParameters?: RuntimeParameter[];
 }
 export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
@@ -662,6 +667,10 @@ export interface LiveboardViewConfig extends ViewConfig {
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         hideTabPanel?: boolean;
+        /**
+            * The list of parameter override to apply to a Liveboard.
+            */
+        runtimeParameters?: RuntimeParameter[];
 }
 /**
     * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -700,6 +709,7 @@ export declare class LiveboardEmbed extends V1Embed {
             * visualization ID and the runtime filters.
             */
         render(): LiveboardEmbed;
+        preRender(): LiveboardEmbed;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
 }
 /**
@@ -1350,6 +1360,11 @@ export interface ViewConfig {
             * visualization, or Liveboard.
             */
         runtimeFilters?: RuntimeFilter[];
+        /**
+            * The list of parameter override to apply to a search answer,
+            * visualization, or Liveboard.
+            */
+        runtimeParameters?: RuntimeParameter[];
         /**
             * The locale/language to use for the embedded view.
             *
@@ -1459,6 +1474,7 @@ export interface ViewConfig {
         /**
             * Hide the home page modules
             * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+            *
             * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
             */
         hiddenHomepageModules?: HomepageModule[];
@@ -1486,9 +1502,14 @@ export interface ViewConfig {
             * There are 8 home nav list items, we will send those item as list
             * which we want to hide for TSE.
             * eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
+            *
             * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
+        /**
+            * TBD
+            */
+        preRenderId?: string;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1649,6 +1670,20 @@ export interface RuntimeFilter {
             */
         values: (number | boolean | string)[];
 }
+/**
+    * A filter that can be applied to ThoughtSpot answers, Liveboards, or
+    * visualizations at runtime.
+    */
+export interface RuntimeParameter {
+        /**
+            * The name of the runtime parameter to filter on (case-sensitive)
+            */
+        name: string;
+        /**
+            * Values
+            */
+        value: number | boolean | string;
+}
 /**
     * Event types emitted by the embedded ThoughtSpot application.
     *
@@ -2073,21 +2108,21 @@ export declare enum EmbedEvent {
             */
         InsertIntoSlide = "insertInToSlide",
         /**
+            * @hidden
             * Emitted when a user changes any filter on a Liveboard.
-            *
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         FilterChanged = "filterChanged",
         /**
             *  Emitted when a user click on Go button in Sage Embed
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageEmbedQuery = "sageEmbedQuery",
         /**
             * Emitten when a user select data source in Sage Embed
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageWorksheetUpdated = "sageWorksheetUpdated",
         /**
@@ -2095,7 +2130,52 @@ export declare enum EmbedEvent {
             *
             * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
             */
-        UpdateConnection = "updateConnection"
+        UpdateConnection = "updateConnection",
+        /**
+            * Emitted when name, status (private or public) or filter values of a
+            * PersonalisedView is updated.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        UpdatePersonalisedView = "updatePersonalisedView",
+        /**
+            * Emitted when a PersonalisedView is saved.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        SavePersonalisedView = "savePersonalisedView",
+        /**
+            * Emitted when a Liveboard is reset.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        ResetLiveboard = "resetLiveboard",
+        /**
+            * Emitted when a PersonalisedView is deleted.
+            *
+            * @returns views: string[]
+            * @returns liveboardId: string
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        DeletePersonalisedView = "deletePersonalisedView",
+        /**
+            * Emitten when a user creates a new worksheet
+            *
+            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        CreateWorksheet = "createWorksheet"
 }
 /**
     * Event types that can be triggered by the host application
@@ -2738,16 +2818,16 @@ export declare enum HostEvent {
             */
         ResetSearch = "resetSearch",
         /**
+            * @hidden
             * Gets the currents visible and runtime filters applied on a Liveboard
-            *
             * @example
             * liveboardEmbed.trigger(HostEvent.GetFilters)
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         GetFilters = "getFilters",
         /**
+            * @hidden
             * Updates the visible filters on the Liveboard.
-            *
             * @param - filter: filter object containing column name and filter operation and values
             * @example
             *
@@ -3727,7 +3807,17 @@ export declare enum Action {
             * disabledActions: [Action.ManageMonitor]
             * ```
             */
-        ManageMonitor = "ManageMonitor"
+        ManageMonitor = "ManageMonitor",
+        /**
+            * Action ID for Liveboard Personalised Views dropdown
+            *
+            *  @example
+            * ```js
+            * disabledActions: [Action.PersonalisedViewsDropdown]
+            * ```
+            *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        PersonalisedViewsDropdown = "personalisedViewsDropdown"
 }
 export interface SessionInterface {
         sessionId: string;
@@ -3829,6 +3919,20 @@ export declare class TsEmbed {
             * @param frameOptions
             */
         protected renderIFrame(url: string): Promise<any>;
+        getPreRenderIds(): {
+                wrapper: string;
+                shield: string;
+                child: string;
+        };
+        protected createPreRenderWrapper(child: HTMLElement): HTMLDivElement;
+        protected preRenderWrapper: HTMLElement;
+        protected preRenderShield: HTMLElement;
+        protected preRenderChild: HTMLElement;
+        protected isPreRenderAvailable(): boolean;
+        protected insertIntoDOMForPreRender(child: string | HTMLElement): void;
+        hidePreRender(): void;
+        showPreRender(): void;
+        syncPreRenderStyle(): void;
         protected insertIntoDOM(child: string | Node): void;
         /**
             * Sets the height of the iframe
@@ -3925,6 +4029,10 @@ export declare class TsEmbed {
             * @param args
             */
         render(): TsEmbed;
+        /**
+            * Creates the preRender shell
+            */
+        preRender(): TsEmbed;
         /**
             * Get the Post Url Params for THOUGHTSPOT from the current
             * host app URL.