@thoughtspot/visual-embed-sdk 1.27.0-loggers → 1.27.8

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, 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, RuntimeParameter, };
+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, RuntimeParameter, LogLevel, };
 
 /**
     * Copyright (c) 2022
@@ -198,6 +198,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         isLiveboardHeaderSticky?: boolean;
+        /**
+            * enable or disable ask sage
+            *
+            * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+            * @default false
+            */
+        enableAskSage?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -206,13 +213,18 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
     */
 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
             * embedded Liveboard or visualization.
             */
         protected getEmbedParams(): string;
+        /**
+            * Constructs the URL of the ThoughtSpot app page to be rendered.
+            *
+            * @param pageId The ID of the page to be embedded.
+            */
+        getIFrameSrc(): string;
         /**
             * Set the iframe height as per the computed height received
             * from the ThoughtSpot app.
@@ -510,6 +522,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             */
         isLiveboardHeaderSticky?: boolean;
+        /**
+            * enable or disable ask sage
+            *
+            * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+            * @default false
+            */
+        enableAskSage?: boolean;
 }
 /**
     * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -529,7 +548,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
     */
 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
@@ -606,6 +624,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * using raw answer data.
             */
         hideResults?: boolean;
+        /**
+            * If set to true, expands all the data sources panel.
+            */
+        expandAllDataSource?: boolean;
         /**
             * If set to true, the Search Assist feature is enabled.
             *
@@ -694,9 +716,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;
+        /**
+            * Construct the URL of the embedded ThoughtSpot search to be
+            * loaded in the iframe
+            *
+            * @param answerId The GUID of a saved answer
+            * @param dataSources A list of data source GUIDs
+            */
+        getIFrameSrc(): string;
         /**
             * Render the embedded ThoughtSpot search
             */
@@ -1461,8 +1490,8 @@ export interface EmbedConfig {
         suppressErrorAlerts?: boolean;
         /**
             * Log level for the SDK.
-            * @default LogLevel.ERROR
             *
+            * @default LogLevel.ERROR
             * @example
             * ```js
             * init({
@@ -1470,7 +1499,7 @@ export interface EmbedConfig {
             *   logLevel: LogLevel.SILENT
             * })
             * ```
-            * @version SDK: 1.26.3 | ThoughtSpot: 9.10.0.cl
+            * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
             */
         logLevel?: LogLevel;
 }
@@ -1709,6 +1738,7 @@ export interface ViewConfig {
             * ```js
             * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
             * ```
+            *
             * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -1746,6 +1776,12 @@ export interface ViewConfig {
             * const myComponent = new MyComponent(config);
             */
         doNotTrackPreRenderSize?: boolean;
+        /**
+            * For internal tracking of the embed component type.
+            *
+            * @hidden
+            */
+        embedComponentType?: string;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1943,6 +1979,7 @@ export interface RuntimeParameter {
 export enum EmbedEvent {
         /**
             * Rendering has initialized.
+            *
             * @example
             *```js
             * liveboardEmbed.on(EmbedEvent.Init, showLoader)
@@ -1951,7 +1988,6 @@ export enum EmbedEvent {
             * document.getElementById("loader");
             * }
             *```
-            *
             * @returns timestamp - The timestamp when the event was generated.
             */
         Init = "init",
@@ -1964,12 +2000,12 @@ export enum EmbedEvent {
             *    console.log('AuthInit', payload);
             * })
             *```
-            *
             * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
             */
         AuthInit = "authInit",
         /**
             * The embed object container has loaded.
+            *
             * @returns timestamp - The timestamp when the event was generated.
             * @example
             *```js
@@ -1983,6 +2019,7 @@ export enum EmbedEvent {
         Load = "load",
         /**
             * Data pertaining to answer or Liveboard is received
+            *
             * @return data - The answer or Liveboard data
             * @example
             *```js
@@ -2006,7 +2043,6 @@ export enum EmbedEvent {
             *```js
             * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
             *```
-            *
             */
         QueryChanged = "queryChanged",
         /**
@@ -2015,7 +2051,6 @@ export enum EmbedEvent {
             * @returns additionalFilters - Any additional filters applied
             * @returns drillDownColumns - The columns on which drill down was performed
             * @returns nonFilteredColumns - The columns that were not filtered
-            *
             * @example
             *```js
             * searchEmbed.trigger(HostEvent.DrillDown, {
@@ -2029,7 +2064,6 @@ export enum EmbedEvent {
             * In this example, `VizPointDoubleClick` event is used for
             * triggering the `DrillDown` event when an area or specific
             * data point on a table or chart is double-clicked.
-            *
             * @example
             *```js
             * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2046,34 +2080,31 @@ export enum EmbedEvent {
             *     })
             * })
             *```
-            *
             */
         Drilldown = "drillDown",
         /**
             * One or more data sources have been selected.
-            * @returns dataSourceIds - the list of data sources
             *
+            * @returns dataSourceIds - the list of data sources
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
             *    console.log('DataSourceSelected', payload);
             * })
             * ```
-            *
             */
         DataSourceSelected = "dataSourceSelected",
         /**
             * One or more data columns have been selected.
+            *
             * @returns columnIds - the list of columns
             * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
-            *
             * @example
             * ```js
             * appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
             *   console.log('AddRemoveColumns', payload);
             * })
             * ```
-            *
             */
         AddRemoveColumns = "addRemoveColumns",
         /**
@@ -2081,7 +2112,6 @@ export enum EmbedEvent {
             *
             * @returns actionId - ID of the custom action
             * @returns data - Response payload with the Answer or Liveboard data
-            *
             * @example
             * ```js
             * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -2097,9 +2127,7 @@ export enum EmbedEvent {
             * Listen to double click actions on a visualization.
             *
             * @return ContextMenuInputPoints - Data point that is double-clicked
-            *
             * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
-            *
             * @example
             * ```js
             * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
@@ -2114,7 +2142,6 @@ export enum EmbedEvent {
             * @return viz, clickedPoint - metadata about the point that is clicked
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @important
-            *
             * @example
             * ```js
             * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
@@ -2133,7 +2160,6 @@ export enum EmbedEvent {
             * An error has occurred.
             *
             * @returns error - An error object or message
-            *
             * @example
             * ```js
             * SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
@@ -2141,19 +2167,16 @@ export enum EmbedEvent {
             *  function showErrorMsg() {
             *    document.getElementById("error");
             * ```
-            *
             */
         Error = "Error",
         /**
             * The embedded object has sent an alert.
             *
             * @returns alert - An alert object
-            *
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.Alert)
             * ```
-            *
             */
         Alert = "alert",
         /**
@@ -2200,7 +2223,6 @@ export enum EmbedEvent {
             * Applicable to `SearchBarEmbed` only.
             *
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
-            *
             * @example
             *```js
             * searchbarEmbed.on(EmbedEvent.GetDataClick)
@@ -2247,8 +2269,8 @@ export enum EmbedEvent {
         SAMLComplete = "samlComplete",
         /**
             * Emitted when any modal is opened in the app
-            * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
             *
+            * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
             * @example
             *```js
             * appEmbed.on(EmbedEvent.DialogOpen, payload => {
@@ -2259,8 +2281,8 @@ export enum EmbedEvent {
         DialogOpen = "dialog-open",
         /**
             * Emitted when any modal is closed in the app
-            * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
             *
+            * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
             * @example
             *```js
             * appEmbed.on(EmbedEvent.DialogClose, payload => {
@@ -2273,8 +2295,8 @@ export enum EmbedEvent {
             * Emitted when the Liveboard shell loads.
             * You can use this event as a hook to trigger
             * other events on the rendered Liveboard.
-            * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
             *
+            * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
             * @example
             *```js
             * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
@@ -2283,7 +2305,6 @@ export enum EmbedEvent {
             *```
             * The following example shows how to trigger
             * `SetVisibleVizs` event using LiveboardRendered embed event:
-            *
             * @example
             *```js
             * const embedRef = useEmbedRef();
@@ -2296,8 +2317,8 @@ export enum EmbedEvent {
         /**
             * This can be used to register an event listener which
             * is triggered on all events.
-            * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
             *
+            * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
             * @example
             *```js
             * appEmbed.on(EmbedEvent.ALL, payload => {
@@ -2308,6 +2329,7 @@ export enum EmbedEvent {
         ALL = "*",
         /**
             * Emitted when an Answer is saved in the app
+            *
             * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -2333,7 +2355,6 @@ export enum EmbedEvent {
             * or `EmbedEvent.DownloadAsXLSX`
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-            *
             * @example
             *```js
             * liveboardEmbed.trigger(HostEvent.Download, {
@@ -2344,8 +2365,8 @@ export enum EmbedEvent {
         Download = "download",
         /**
             * Emitted when the download action is triggered on an answer
-            * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
             *
+            * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
             * @example
             *```js
             * //trigger when action starts
@@ -2355,14 +2376,12 @@ export enum EmbedEvent {
             * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
             *   console.log('download PNG', payload)})
             *```
-            *
             */
         DownloadAsPng = "downloadAsPng",
         /**
             * Emitted when the Download as PDF action is triggered on an answer
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-            *
             * @example
             *```js
             * //trigger when action starts
@@ -2372,7 +2391,6 @@ export enum EmbedEvent {
             * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
             *   console.log('download PDF', payload)})
             *```
-            *
             */
         DownloadAsPdf = "downloadAsPdf",
         /**
@@ -2394,7 +2412,6 @@ export enum EmbedEvent {
             * Emitted when the Download as XLSX action is triggered on an answer
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-            *
             * @example
             *```js
             * //trigger when action starts
@@ -2410,7 +2427,6 @@ export enum EmbedEvent {
             * Emitted when an Answer is deleted in the app
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-            *
             * @example
             *```js
             * //trigger when action starts
@@ -2464,7 +2480,6 @@ export enum EmbedEvent {
             * Emitted when a user shares an object with another user or group
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-            *
             * @example
             *```js
             * //trigger when action starts
@@ -2544,6 +2559,7 @@ export enum EmbedEvent {
         /**
             * Emitted when the **Export TML** action is triggered on an
             * an embedded object in the app
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -2681,7 +2697,6 @@ export enum EmbedEvent {
             *```js
             * liveboardEmbed.trigger(HostEvent.Present)
             *```
-            *
             * @example
             *```js
             * liveboardEmbed.on(EmbedEvent.Present, {
@@ -2699,77 +2714,65 @@ export enum EmbedEvent {
             * liveboardEmbed.trigger(HostEvent.Delete,
             *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
-            *
             */
         Delete = "delete",
         /**
             * Emitted when a user clicks Manage schedules on a Liveboard
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-            *
             * @example
             *```js
             * liveboardEmbed.trigger(HostEvent.SchedulesList)
             *```
-            *
             */
         SchedulesList = "schedule-list",
         /**
             * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-            *
             * @example
             *```js
             * liveboardEmbed.trigger(HostEvent.Cancel)
             *```
-            *
             */
         Cancel = "cancel",
         /**
             * Emitted when a user clicks **Explore** on a visualization
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-            *
             * @example
             *```js
             * liveboardEmbed.trigger(HostEvent.Explore,  {
             *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
-            *
             */
         Explore = "explore",
         /**
             * Emitted when a user clicks **Copy link** action on a visualization
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-            *
             * @example
             *```js
             * liveboardEmbed.trigger(HostEvent.CopyLink, {
             *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
-            *
             */
         CopyLink = "embedDocument",
         /**
             * Emitted when a user interacts with cross filters on a visualization or Liveboard
             *
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
-            *
             * @example
             *```js
             * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
             *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
-            *
             */
         CrossFilterChanged = "cross-filter-changed",
         /**
             * Emitted when a user right clicks on a visualization (chart or table)
             *
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
-            *
             * @example
             *```js
             * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
@@ -2800,7 +2803,6 @@ export enum EmbedEvent {
             * Emitted when a user selects a data source.
             *
             * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-            *
             */
         SageWorksheetUpdated = "sageWorksheetUpdated",
         /**
@@ -2859,7 +2861,23 @@ export enum EmbedEvent {
             *
             * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
             */
-        CreateWorksheet = "createWorksheet"
+        CreateWorksheet = "createWorksheet",
+        /**
+            * Emitted when Ask Sage is initialized.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
+            */
+        AskSageInit = "AskSageInit",
+        /**
+            * Emitted when a LB/viz is renamed
+            *
+            * @version SDK : 1.28.0 | ThoughtSpot: 9.11.0.cl
+            */
+        Rename = "rename"
 }
 /**
     * Event types that can be triggered by the host application
@@ -2948,7 +2966,7 @@ export enum HostEvent {
             *        clickedPoint,
             *        selectedPoints: selectedPoint
             *      },
-            *      autoDrillDown: true,
+            *      columnGuid: "<guid of the column to drill>",
             *      vizId: payload.data.vizId
             *    });
             *  })
@@ -3027,7 +3045,6 @@ export enum HostEvent {
             *
             * @param - `path` - the path to navigate to to go forward or back. The path value can
             * be a number; for example, `1`, `-1`.
-            *
             * @example
             * ```js
             * appEmbed.navigateToPage(-1)
@@ -3598,9 +3615,7 @@ export enum HostEvent {
             * Updates the search query string for Natural Language Search operations.
             *
             * @param - `queryString`: Text string in Natural Language format
-            *
             * @param - `executeSearch`: Boolean to execute search and update search query
-            *
             * @example
             * ```js
             * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -3623,7 +3638,18 @@ export enum HostEvent {
             * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
             */
-        GetAnswerSession = "getAnswerSession"
+        GetAnswerSession = "getAnswerSession",
+        /**
+            * Trigger Ask Sage for viz
+            *
+            * @example
+            * ```js
+            * liveboardEmbed.trigger(HostEvent.AskSage,
+            * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+            * ```
+            * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+            */
+        AskSage = "AskSage"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -3718,7 +3744,8 @@ export enum Param {
         HideSageAnswerHeader = "hideSageAnswerHeader",
         HideSearchBar = "hideSearchBar",
         ClientLogLevel = "clientLogLevel",
-        OverrideNativeConsole = "overrideConsoleLogs"
+        OverrideNativeConsole = "overrideConsoleLogs",
+        enableAskSage = "enableAskSage"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -4577,7 +4604,17 @@ export enum Action {
             * ```
             *  @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
             */
-        VerifiedLiveboard = "verifiedLiveboard"
+        VerifiedLiveboard = "verifiedLiveboard",
+        /**
+            * Action ID for ask sage button
+            *
+            *  @example
+            * ```js
+            * hiddenAction: [Action.AskAi]
+            * ```
+            *  @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+            */
+        AskAi = "AskAi"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -4634,11 +4671,83 @@ export interface CustomActionPayload {
         vizId?: string;
 }
 export enum LogLevel {
+        /**
+            * No logs will be logged in the console.
+            *
+            * @example
+            * ```js
+            * init({
+            *   ... // other options,
+            *  logLevel: LogLevel.SILENT,
+            * })
+            * ```
+            * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+            */
         SILENT = "SILENT",
+        /**
+            * Only ERROR logs will be logged in the console.
+            *
+            * @example
+            * ```js
+            * init({
+            *   ... // other options,
+            *  logLevel: LogLevel.ERROR,
+            * })
+            * ```
+            * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+            */
         ERROR = "ERROR",
+        /**
+            * Only WARN and ERROR logs will be logged in the console.
+            *
+            * @example
+            * ```js
+            * init({
+            *   ... // other options,
+            *  logLevel: LogLevel.WARN,
+            * })
+            * ```
+            * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+            */
         WARN = "WARN",
+        /**
+            * Only INFO, WARN, and ERROR logs will be logged in the console.
+            *
+            * @example
+            * ```js
+            * init({
+            *   ... // other options,
+            *  logLevel: LogLevel.INFO,
+            * })
+            * ```
+            * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+            */
         INFO = "INFO",
+        /**
+            * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
+            *
+            * @example
+            * ```js
+            * init({
+            *   ... // other options,
+            *  logLevel: LogLevel.DEBUG,
+            * })
+            * ```
+            * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+            */
         DEBUG = "DEBUG",
+        /**
+            * All logs will be logged in the console.
+            *
+            * @example
+            * ```js
+            * init({
+            *   ... // other options,
+            *  logLevel: LogLevel.TRACE,
+            * })
+            * ```
+            * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+            */
         TRACE = "TRACE"
 }
 
@@ -5122,7 +5231,6 @@ 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
@@ -5131,6 +5239,13 @@ export class SageEmbed extends V1Embed {
             * @returns {string} query string
             */
         protected getEmbedParams(): string;
+        /**
+            * Construct the URL of the embedded ThoughtSpot sage to be
+            * loaded in the iframe
+            *
+            * @returns {string} iframe url
+            */
+        getIFrameSrc(): string;
         /**
             * Render the embedded ThoughtSpot Sage
             *
@@ -5276,7 +5391,6 @@ export class TsEmbed {
             */
         protected thoughtSpotHost: string;
         protected thoughtSpotV2Base: string;
-        protected embedComponentType: string;
         /**
             * A flag that is set to true post render.
             */
@@ -5424,6 +5538,7 @@ export class TsEmbed {
             * @param args
             */
         render(): TsEmbed;
+        getIframeSrc(): string;
         protected handleRenderForPrerender(): void;
         /**
             * Creates the preRender shell