@thoughtspot/visual-embed-sdk 1.51.1 → 1.52.0

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

@@ -445,7 +445,7 @@ export interface CustomCssVariables {
 	 * Left and right margin of the header and the tab/filter section of an
 	 * embedded Liveboard. Use alongside the `liveboardGutter` view config to
 	 * keep the header aligned with a custom tile-grid gutter.
-	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 * @version SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl
 	 */
 	"--ts-var-liveboard-header-horizontal-margin"?: string;
 	/**
@@ -2100,9 +2100,11 @@ export interface FrameParams {
 }
 /**
  * Configuration for the pre-render wrapper element.
- * All properties here mirror the top-level preRender properties on
- * {@link BaseViewConfig} and take precedence over them when both are set,
- * so existing top-level usage continues to work without any changes.
+ * Each property here supersedes its deprecated top-level counterpart on
+ * {@link BaseViewConfig} — `id` over `preRenderId`, `containerSelector` over
+ * `preRenderContainer` and `doNotTrackSize` over `doNotTrackPreRenderSize` —
+ * and takes precedence when both are set, so existing top-level usage continues
+ * to work without any changes.
  *
  * @version SDK: 1.52.0
  * @example
@@ -2110,9 +2112,9 @@ export interface FrameParams {
  * init({ thoughtSpotHost: '...', authType: AuthType.None });
  * const embed = new LiveboardEmbed('#tsEmbed', {
  *   preRenderConfig: {
- *     preRenderId: 'my-liveboard',
- *     preRenderContainer: '#my-scroll-container',
- *     doNotTrackPreRenderSize: false,
+ *     id: 'my-liveboard',
+ *     containerSelector: '#my-scroll-container',
+ *     doNotTrackSize: false,
  *     zIndex: -10,
  *   },
  * });
@@ -2133,7 +2135,7 @@ export interface PreRenderConfig {
 	 *
 	 * @default undefined
 	 */
-	preRenderId?: string;
+	id?: string;
 	/**
 	 * The DOM element or CSS selector string specifying the container into
 	 * which the pre-rendered wrapper is inserted.
@@ -2149,7 +2151,7 @@ export interface PreRenderConfig {
 	 *
 	 * @default document.body
 	 */
-	preRenderContainer?: string | HTMLElement;
+	containerSelector?: string | HTMLElement;
 	/**
 	 * Disables the `ResizeObserver` that keeps the wrapper sized to the
 	 * placeholder element.
@@ -2161,7 +2163,7 @@ export interface PreRenderConfig {
 	 *
 	 * @default false
 	 */
-	doNotTrackPreRenderSize?: boolean;
+	doNotTrackSize?: boolean;
 	/**
 	 * CSS `z-index` value applied to the pre-render wrapper when hidden.
 	 * Override this when the host page's stacking context does not reach `-1000`
@@ -2368,7 +2370,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
 	 * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
-	 * @deprecated Use {@link PreRenderConfig.preRenderId} via `preRenderConfig` instead.
+	 * @deprecated Use {@link PreRenderConfig.id} via `preRenderConfig` instead.
 	 * @example
 	 * ```js
 	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2388,7 +2390,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	 * @type {boolean}
 	 * @default false
 	 * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
-	 * @deprecated Use {@link PreRenderConfig.doNotTrackPreRenderSize} via `preRenderConfig` instead.
+	 * @deprecated Use {@link PreRenderConfig.doNotTrackSize} via `preRenderConfig` instead.
 	 * @example
 	 * ```js
 	 * // Disable tracking PreRender size in the configuration
@@ -2430,7 +2432,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	 *
 	 * @type {string | HTMLElement}
 	 * @version SDK: 1.49.2 | ThoughtSpot: *
-	 * @deprecated Use {@link PreRenderConfig.preRenderContainer} via `preRenderConfig` instead.
+	 * @deprecated Use {@link PreRenderConfig.containerSelector} via `preRenderConfig` instead.
 	 * @example
 	 * ```js
 	 * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -2443,9 +2445,11 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	preRenderContainer?: string | HTMLElement;
 	/**
 	 * Configuration for the pre-render wrapper element.
-	 * All properties here mirror the top-level preRender properties on
-	 * `BaseViewConfig` and take precedence over them when both are set,
-	 * so existing top-level usage continues to work without any changes.
+	 * Each property here supersedes its deprecated top-level counterpart on
+	 * `BaseViewConfig` — `id` over `preRenderId`, `containerSelector` over
+	 * `preRenderContainer` and `doNotTrackSize` over `doNotTrackPreRenderSize` —
+	 * and takes precedence when both are set, so existing top-level usage
+	 * continues to work without any changes.
 	 * See {@link PreRenderConfig} for available options.
 	 *
 	 * @version SDK: 1.52.0
@@ -2453,7 +2457,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
 	 * ```js
 	 * const embed = new LiveboardEmbed('#tsEmbed', {
 	 *   preRenderConfig: {
-	 *     preRenderId: 'my-liveboard',
+	 *     id: 'my-liveboard',
 	 *     zIndex: -10,
 	 *   },
 	 * });
@@ -3205,7 +3209,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
 	 * @type {boolean}
-	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 * @version SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl
 	 * @default false
 	 * @example
 	 * ```js
@@ -3330,7 +3334,7 @@ export interface LiveboardAppEmbedViewConfig {
 	 *
 	 * Supported embed types: `AppEmbed`, `LiveboardEmbed`
 	 * @type {number}
-	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 * @version SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl
 	 * @example
 	 * ```js
 	 * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -4978,7 +4982,32 @@ export declare enum EmbedEvent {
 	 */
 	OrgSwitched = "orgSwitched",
 	/**
-	 * Emitted when the user intercepts a URL.
+	 * Emitted before the embedded ThoughtSpot app sends a network request whose
+	 * fully resolved URL matches one of the `interceptUrls` in the view config.
+	 * The request is held until you call `responder`, which decides whether the
+	 * real request goes out or a response you supply is used in its place.
+	 *
+	 * Setting `interceptUrls` is what enables this; there is no separate enable
+	 * flag. If `responder` is not called within `interceptTimeout` (30000 ms by
+	 * default) the request fails and `EmbedEvent.Error` is emitted.
+	 *
+	 * The payload is `{ input, init, urlType }`, where `input` is the request
+	 * URL and `init` is the `fetch` init object, with `init.body` parsed into an
+	 * object when it is valid JSON. `urlType` is the matching
+	 * `InterceptedApiType`; it is `InterceptedApiType.ALL` for any URL outside
+	 * the recognized API groups.
+	 *
+	 * Interception wraps the outermost layer of `fetch`, so `init` holds the
+	 * request as the application composed it, before ThoughtSpot attaches its
+	 * authentication headers. Those headers, and any token refresh and retry,
+	 * are applied afterwards and only when you pass `execute: true`. Only
+	 * requests made through `fetch` are intercepted.
+	 *
+	 * Pass `execute: true` to let the original request proceed untouched, in
+	 * which case any `response` you supply alongside it is ignored. With
+	 * `execute: false` the request is never sent, and your `response.body` is
+	 * returned to the app as JSON, defaulting to status 200 and a
+	 * `Content-Type: application/json` header.
 	 *
 	 * Supported on all embed types.
 	 *
@@ -5787,7 +5816,7 @@ export declare enum HostEvent {
 	 *
 	 * Unlike {@link HostEvent.OpenFilter}, which opens the panel of an
 	 * existing filter, this event starts the creation of a new filter.
-	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 * @version SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl
 	 * @example
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.OpenAddFilterModal);
@@ -5803,7 +5832,7 @@ export declare enum HostEvent {
 	 * Hiding the *Add parameter* button with `hiddenActions:
 	 * [Action.AddParameter]` does not block this event, but disabling it
 	 * with `disabledActions` does.
-	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
+	 * @version SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl
 	 * @example
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.OpenAddParameterModal);
@@ -7680,7 +7709,13 @@ export declare enum HostEvent {
 	 */
 	UpdateEmbedParams = "updateEmbedParams",
 	/**
-	 * Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
+	 * Notifies the embedded ThoughtSpot app that the embed is being torn down, so that
+	 * it can release any resources it holds before the iframe is removed from the DOM.
+	 *
+	 * This is triggered for you by `embed.destroy()`; you rarely need to trigger it
+	 * directly. If `waitForCleanupOnDestroy` is set in the embed config, `destroy()`
+	 * waits for the app to acknowledge this event (up to `cleanupTimeout`) before
+	 * removing the iframe.
 	 * @example
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.DestroyEmbed);
@@ -9612,7 +9647,7 @@ export declare enum Action {
 	 * ```js
 	 * hiddenActions: [Action.QuickSearchPill]
 	 * ```
-	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
 	 */
 	QuickSearchPill = "quickSearchPill",
 	/**
@@ -9627,7 +9662,7 @@ export declare enum Action {
 	 * ```js
 	 * hiddenActions: [Action.DeepAnalysisPill]
 	 * ```
-	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
 	 */
 	DeepAnalysisPill = "deepAnalysisPill",
 	/**
@@ -9642,7 +9677,7 @@ export declare enum Action {
 	 * ```js
 	 * hiddenActions: [Action.DataLiteracyPill]
 	 * ```
-	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
 	 */
 	DataLiteracyPill = "dataLiteracyPill",
 	/**
@@ -10124,9 +10159,19 @@ export interface EmbedErrorDetailsEvent {
 	message: string | string[];
 	/** Machine-readable error code for programmatic error handling */
 	code: EmbedErrorCodes;
+	/** How badly the embed is affected. Defaults to {@link EmbedErrorSeverity.SEV3}. */
+	severity?: EmbedErrorSeverity;
 	/** Additional context-specific for backward compatibility */
 	[key: string]: any;
 }
+declare enum EmbedErrorSeverity {
+	/** The embed cannot render. Nothing usable is on screen. */
+	SEV1 = 1,
+	/** Something is degraded but the embed still works. */
+	SEV2 = 2,
+	/** Everything else, including validation of the embedder's own input. */
+	SEV3 = 3
+}
 declare enum ContextType {
 	/**
 	 * Search answer context for search page or edit viz dialog on liveboard page.
@@ -10169,21 +10214,34 @@ export interface DefaultAppInitData {
 }
 declare enum InterceptedApiType {
 	/**
-	 * The apis that are use to get the data for the embed
+	 * The APIs that fetch the data backing an Answer, including its chart,
+	 * table, and headline data.
 	 */
 	AnswerData = "AnswerData",
 	/**
-	 * This will intercept all the apis
+	 * Intercepts every `fetch` request the embedded application makes, not only
+	 * the data APIs. This includes authentication, session, and metadata calls,
+	 * so the handler must respond to requests it does not recognize by passing
+	 * `execute: true`. Listing this alongside other entries in `interceptUrls`
+	 * supersedes them.
 	 */
 	ALL = "ALL",
 	/**
-	 * The apis that are use to get the data for the liveboard
+	 * The APIs that fetch the data backing a Liveboard.
 	 */
 	LiveboardData = "LiveboardData"
 }
 export type ApiInterceptFlags = {
 	/**
-	 * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
+	 * Emits `EmbedEvent.OnBeforeGetVizDataIntercept` before the Answer data
+	 * APIs are called. This is the earlier, narrower form of interception, kept
+	 * for backward compatibility and implemented on top of
+	 * `EmbedEvent.ApiIntercept`. Prefer `interceptUrls` with
+	 * `InterceptedApiType.AnswerData` in new code.
+	 *
+	 * Setting this also intercepts the Answer data APIs, so both
+	 * `EmbedEvent.OnBeforeGetVizDataIntercept` and `EmbedEvent.ApiIntercept`
+	 * are emitted for those requests.
 	 *
 	 * Can be used for Search and App Embed from SDK 1.29.0
 	 *
@@ -10191,14 +10249,21 @@ export type ApiInterceptFlags = {
 	 */
 	isOnBeforeGetVizDataInterceptEnabled?: boolean;
 	/**
-	 * This allows to intercept the urls passed, once intercepted the api will only
-	 * run based on the response from the responder of ApiIntercept event.
+	 * The requests to intercept, given as `InterceptedApiType` groups, absolute
+	 * URLs, or paths beginning with `/` that are resolved against the
+	 * ThoughtSpot host. Setting this is what turns interception on.
+	 *
+	 * A URL matches only on exact equality with the request's fully resolved
+	 * URL, query string included, so prefer an `InterceptedApiType` group where
+	 * one covers the API you need.
+	 *
+	 * Each intercepted request pauses and emits `EmbedEvent.ApiIntercept`, then
+	 * proceeds according to the response passed to that event's responder.
 	 *
 	 * @example
 	 * ```js
 	 * const embed = new LiveboardEmbed('#embed', {
 	 *   ...viewConfig,
-	 *   enableApiIntercept: true,
 	 *   interceptUrls: [InterceptedApiType.LiveboardData],
 	 * })
 	 * ```
@@ -10207,14 +10272,14 @@ export type ApiInterceptFlags = {
 	 */
 	interceptUrls?: (string | InterceptedApiType)[];
 	/**
-	 * The timeout for the intercept, default is 30000ms
-	 * the api will error out if the timeout is reached
+	 * How long, in milliseconds, an intercepted request waits for the
+	 * `EmbedEvent.ApiIntercept` responder before it is abandoned. Defaults to
+	 * 30000. On timeout the request fails and `EmbedEvent.Error` is emitted.
 	 *
 	 * @example
 	 * ```js
 	 * const embed = new LiveboardEmbed('#embed', {
 	 *   ...viewConfig,
-	 *   enableApiIntercept: true,
 	 *   interceptUrls: [InterceptedApiType.ALL],
 	 *   interceptTimeout: 1000,
 	 * })
@@ -11267,7 +11332,87 @@ declare class TsEmbed {
 	 * @param query
 	 */
 	protected getEmbedBasePath(query: string): string;
-	protected getUpdateEmbedParamsObject(): Promise<Record<any, any>>;
+	protected getUpdateEmbedParamsObject(): Promise<{
+		customisations: CustomisationsInterface;
+		authToken: string;
+		runtimeFilterParams: string;
+		runtimeParameterParams: string;
+		hiddenHomepageModules: HomepageModule[];
+		reorderedHomepageModules: string[];
+		hostConfig: Record<string, any>;
+		hiddenHomeLeftNavItems: string[];
+		customVariablesForThirdPartyTools: Record<string, any>;
+		hiddenListColumns: ListPageColumns[];
+		customActions: CustomAction[];
+		interceptTimeout: number;
+		interceptUrls: string[];
+		embedExpiryInAuthToken: boolean;
+		shouldBypassPayloadValidation?: boolean;
+		useHostEventsV2?: boolean;
+		layoutConfig?: LayoutConfig;
+		frameParams?: FrameParams;
+		theme?: string;
+		styleSheet__unstable?: string;
+		disabledActions?: Action[];
+		disabledActionReason?: string;
+		hiddenActions?: Action[];
+		visibleActions?: Action[];
+		locale?: string;
+		additionalFlags?: {
+			[key: string]: string | number | boolean;
+		};
+		customizations?: CustomisationsInterface;
+		insertAsSibling?: boolean;
+		usePrerenderedIfAvailable?: boolean;
+		preRenderId?: string;
+		doNotTrackPreRenderSize?: boolean;
+		preRenderContainer?: string | HTMLElement;
+		preRenderConfig?: PreRenderConfig;
+		enableV2Shell_experimental?: boolean;
+		embedComponentType?: string;
+		exposeTranslationIDs?: boolean;
+		disableRedirectionLinksInNewTab?: boolean;
+		overrideOrgId?: number;
+		overrideHistoryState?: boolean;
+		linkOverride?: boolean;
+		enableLinkOverridesV2?: boolean;
+		primaryAction?: string;
+		insertInToSlide?: boolean;
+		showAlerts?: boolean;
+		refreshAuthTokenOnNearExpiry?: boolean;
+		isOnBeforeGetVizDataInterceptEnabled?: boolean;
+		runtimeFilters?: RuntimeFilter[];
+		runtimeParameters?: RuntimeParameter[];
+		contextMenuTrigger?: ContextMenuTriggerOptions;
+		excludeRuntimeFiltersfromURL?: boolean;
+		excludeRuntimeParametersfromURL?: boolean;
+		collapseSearchBar?: boolean;
+		dataPanelV2?: boolean;
+		enableCustomColumnGroups?: boolean;
+		isThisPeriodInDateFiltersEnabled?: boolean;
+		hideLiveboardHeader?: boolean;
+		showLiveboardTitle?: boolean;
+		showLiveboardDescription?: boolean;
+		isLiveboardHeaderSticky?: boolean;
+		enable2ColumnLayout?: boolean;
+		isLiveboardAlwaysOn12ColLayout?: boolean;
+		isLiveboardCompactHeaderEnabled?: boolean;
+		showLiveboardVerifiedBadge?: boolean;
+		hideIrrelevantChipsInLiveboardTabs?: boolean;
+		showLiveboardReverifyBanner?: boolean;
+		enableAskSage?: boolean;
+		coverAndFilterOptionInPDF?: boolean;
+		liveboardGutter?: number;
+		isCentralizedLiveboardFilterUXEnabled?: boolean;
+		isScopedLiveboardFilteringEnabled?: boolean;
+		isLinkParametersEnabled?: boolean;
+		isEnhancedFilterInteractivityEnabled?: boolean;
+		showMaskedFilterChip?: boolean;
+		isLiveboardMasterpiecesEnabled?: boolean;
+		newChartsLibrary?: boolean;
+		visibleTabs?: string[];
+		hiddenTabs?: string[];
+	}>;
 	/**
 	 * Common query params set for all the embed modes.
 	 * @param queryParams
@@ -11287,9 +11432,10 @@ declare class TsEmbed {
 	protected getRootIframeSrc(): string;
 	protected createIframeEl(frameSrc: string): HTMLIFrameElement;
 	/**
-	 * Returns a merged {@link PreRenderConfig} object where each shared key
-	 * prefers `preRenderConfig.key` over the top-level `viewConfig.key` for
-	 * backward compatibility.
+	 * Returns a merged {@link PreRenderConfig} object where each key prefers the
+	 * value from `preRenderConfig` over its deprecated top-level `viewConfig`
+	 * counterpart (`id`/`preRenderId`, `containerSelector`/`preRenderContainer`,
+	 * `doNotTrackSize`/`doNotTrackPreRenderSize`) for backward compatibility.
 	 */
 	protected getPreRenderConfig(): PreRenderConfig;
 	/**
@@ -12343,7 +12489,7 @@ export interface SpotterShareConversationConfig {
 }
 /**
  * A single starter prompt question shown under a category pill.
- * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
  * @group Embed components
  */
 export interface StarterPromptQuestion {
@@ -12361,7 +12507,7 @@ export interface StarterPromptQuestion {
 /**
  * Configuration for a starter prompt category with questions
  * (`quick` and `research`).
- * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
  * @group Embed components
  */
 export interface StarterPromptCategory {
@@ -12379,7 +12525,7 @@ export interface StarterPromptCategory {
 /**
  * Configuration for the Data Literacy starter prompt category.
  * Only the label is customizable; the prompt text comes from the backend.
- * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
  * @group Embed components
  */
 export interface StarterPreviewDataCategory {
@@ -12397,7 +12543,7 @@ export interface StarterPreviewDataCategory {
  * Note: this controls the Spotter chat interface only. The starter prompts on
  * the Liveboard SpotterViz surface are configured separately through
  * {@link SpotterVizConfig.customStarterPrompts}.
- * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
  * @group Embed components
  */
 export interface StarterPromptsConfig {
@@ -12477,7 +12623,7 @@ export interface SpotterChatViewConfig {
 	 * `Action.DeepAnalysisPill` and `Action.DataLiteracyPill`.
 	 *
 	 * Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
-	 * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+	 * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
 	 * @example
 	 * ```js
 	 * const embed = new SpotterEmbed('#tsEmbed', {
@@ -14899,9 +15045,9 @@ export interface SearchProps extends EmbedProps, SearchViewConfig {
 }
 /**
  * The PreRendered components require a preRender id. It can be supplied either
- * through `preRenderConfig.preRenderId` (SDK: 1.52.0 and later) or through the
+ * through `preRenderConfig.id` (SDK: 1.52.0 and later) or through the
  * top-level `preRenderId` prop (SDK: 1.25.0 and later, now deprecated).
- * `preRenderConfig.preRenderId` takes precedence when both are set.
+ * `preRenderConfig.id` takes precedence when both are set.
  *
  * Use PreRender to render the embed in the background and then
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
@@ -14910,14 +15056,14 @@ export interface SearchProps extends EmbedProps, SearchViewConfig {
  * // Preferred, SDK: 1.52.0 and later.
  * function LandingPageComponent() {
  *  return <PreRenderedLiveboardEmbed
- *      preRenderConfig={{ preRenderId: "someId" }}
+ *      preRenderConfig={{ id: "someId" }}
  *      liveboardId="libId"
  *  />
  * }
  *
  * function MyComponent() {
  *  return <LiveboardEmbed
- *      preRenderConfig={{ preRenderId: "someId" }}
+ *      preRenderConfig={{ id: "someId" }}
  *      liveboardId="libId"
  *  />
  * }
@@ -14934,7 +15080,7 @@ export type PreRenderProps = {
 	/**
 	 * PreRender id to be used for PreRendering the embed.
 	 * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
-	 * @deprecated Use `preRenderConfig.preRenderId` instead.
+	 * @deprecated Use `preRenderConfig.id` instead.
 	 */
 	preRenderId: string;
 	/**
@@ -14947,17 +15093,17 @@ export type PreRenderProps = {
 	/**
 	 * PreRender id to be used for PreRendering the embed.
 	 * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
-	 * @deprecated Use `preRenderConfig.preRenderId` instead.
+	 * @deprecated Use `preRenderConfig.id` instead.
 	 */
 	preRenderId?: string;
 	/**
-	 * Configuration for the pre-render wrapper element. `preRenderId` is
+	 * Configuration for the pre-render wrapper element. `id` is
 	 * required here when the top-level `preRenderId` prop is not passed.
 	 * See {@link PreRenderConfig} for available options.
 	 * @version SDK: 1.52.0
 	 */
 	preRenderConfig: PreRenderConfig & {
-		preRenderId: string;
+		id: string;
 	};
 };
 /**