@thoughtspot/visual-embed-sdk 1.21.0 → 1.21.1

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

@@ -102,7 +102,7 @@ export const useEmbedRef: () => React.MutableRefObject<TsEmbed>;
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, };
+export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
 
 /**
     * @group Embed components
@@ -1243,9 +1243,40 @@ export declare enum AuthType {
 export type DOMSelector = string | HTMLElement;
 /**
     * inline customCSS within the {@link CustomisationsInterface}.
+    * Use {@link CustomCssVariables} or css rules.
     */
 export interface customCssInterface {
+        /**
+            * The custom css variables, which can be set.
+            * The allowed list is in the CustomCssVariables
+            * interface.
+            * Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
+            */
         variables?: CustomCssVariables;
+        /**
+            * Can be used to define a custom font face
+            * like:
+            * @example
+            * ```js
+            * rules_UNSTABLE?: {
+            *     "@font-face": {
+            *         "font-family": "custom-font",
+            *         "src": url("/path/")
+            *  *     };
+            *   };
+            * ```
+            *
+            * * Also, custom css rules outside of variables.
+            * @example
+            * ```js
+            * rules_UNSTABLE?: {
+            *     ".thoughtspot_class_name": {
+            *         "border-radius": "10px",
+            *         margin: "20px"
+            *     };
+            *   };
+            * ```
+            */
         rules_UNSTABLE?: {
                 [selector: string]: {
                         [declaration: string]: string;
@@ -3128,6 +3159,10 @@ export declare enum ContextMenuTriggerOptions {
         RIGHT_CLICK = "right-click"
 }
 
+/**
+    * The list of customization css variables. These
+    * are the only allowed variables possible.
+    */
 export interface CustomCssVariables {
         /**
             * Background color of the Liveboard, visualization, Search, and Answer pages.
@@ -3425,6 +3460,5 @@ export interface CustomCssVariables {
             * Background color of the footer area on dialogs.
             */
         '--ts-var-dialog-footer-background'?: string;
-        [key: string]: string;
 }
 

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

@@ -787,7 +787,7 @@ export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewCon
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, };
+export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
 
 /**
     * Copyright (c) 2023
@@ -967,9 +967,40 @@ export declare enum AuthType {
 export type DOMSelector = string | HTMLElement;
 /**
     * inline customCSS within the {@link CustomisationsInterface}.
+    * Use {@link CustomCssVariables} or css rules.
     */
 export interface customCssInterface {
+        /**
+            * The custom css variables, which can be set.
+            * The allowed list is in the CustomCssVariables
+            * interface.
+            * Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
+            */
         variables?: CustomCssVariables;
+        /**
+            * Can be used to define a custom font face
+            * like:
+            * @example
+            * ```js
+            * rules_UNSTABLE?: {
+            *     "@font-face": {
+            *         "font-family": "custom-font",
+            *         "src": url("/path/")
+            *  *     };
+            *   };
+            * ```
+            *
+            * * Also, custom css rules outside of variables.
+            * @example
+            * ```js
+            * rules_UNSTABLE?: {
+            *     ".thoughtspot_class_name": {
+            *         "border-radius": "10px",
+            *         margin: "20px"
+            *     };
+            *   };
+            * ```
+            */
         rules_UNSTABLE?: {
                 [selector: string]: {
                         [declaration: string]: string;
@@ -3128,6 +3159,10 @@ export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean
 export declare const isAuthenticated: () => boolean;
 export {};
 
+/**
+    * The list of customization css variables. These
+    * are the only allowed variables possible.
+    */
 export interface CustomCssVariables {
         /**
             * Background color of the Liveboard, visualization, Search, and Answer pages.
@@ -3425,6 +3460,5 @@ export interface CustomCssVariables {
             * Background color of the footer area on dialogs.
             */
         '--ts-var-dialog-footer-background'?: string;
-        [key: string]: string;
 }
 

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, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, };
+export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
 
 /**
     * Copyright (c) 2022
@@ -909,9 +909,40 @@ export enum AuthType {
 export type DOMSelector = string | HTMLElement;
 /**
     * inline customCSS within the {@link CustomisationsInterface}.
+    * Use {@link CustomCssVariables} or css rules.
     */
 export interface customCssInterface {
+        /**
+            * The custom css variables, which can be set.
+            * The allowed list is in the CustomCssVariables
+            * interface.
+            * Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
+            */
         variables?: CustomCssVariables;
+        /**
+            * Can be used to define a custom font face
+            * like:
+            * @example
+            * ```js
+            * rules_UNSTABLE?: {
+            *     "@font-face": {
+            *         "font-family": "custom-font",
+            *         "src": url("/path/")
+            *  *     };
+            *   };
+            * ```
+            *
+            * * Also, custom css rules outside of variables.
+            * @example
+            * ```js
+            * rules_UNSTABLE?: {
+            *     ".thoughtspot_class_name": {
+            *         "border-radius": "10px",
+            *         margin: "20px"
+            *     };
+            *   };
+            * ```
+            */
         rules_UNSTABLE?: {
                 [selector: string]: {
                         [declaration: string]: string;
@@ -2795,232 +2826,9 @@ export enum ContextMenuTriggerOptions {
 }
 
 /**
-    * Copyright (c) 2022
-    *
-    * Base classes
-    *
-    * @summary Base classes
-    * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
-    */
-/**
-    * Global prefix for all Thoughtspot postHash Params.
-    */
-export 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 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
+    * The list of customization css variables. These
+    * are the only allowed variables possible.
     */
-export 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 interface CustomCssVariables {
         /**
             * Background color of the Liveboard, visualization, Search, and Answer pages.
@@ -3318,6 +3126,232 @@ export interface CustomCssVariables {
             * Background color of the footer area on dialogs.
             */
         '--ts-var-dialog-footer-background'?: string;
-        [key: string]: string;
+}
+
+/**
+    * Copyright (c) 2022
+    *
+    * Base classes
+    *
+    * @summary Base classes
+    * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+    */
+/**
+    * Global prefix for all Thoughtspot postHash Params.
+    */
+export 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 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 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;
 }
 

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.21.0",
+    "version": "1.21.1",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -84,6 +84,7 @@
         "lodash": "^4.17.21",
         "mixpanel-browser": "^2.45.0",
         "ts-deepmerge": "^6.0.2",
+        "tslib": "^2.5.3",
         "use-deep-compare-effect": "^1.8.1"
     },
     "devDependencies": {

package/lib/src/css-variables.d.ts

@@ -1,3 +1,7 @@
+/**
+ * The list of customization css variables. These
+ * are the only allowed variables possible.
+ */
 export interface CustomCssVariables {
     /**
      * Background color of the Liveboard, visualization, Search, and Answer pages.
@@ -295,6 +299,5 @@ export interface CustomCssVariables {
      * Background color of the footer area on dialogs.
      */
     '--ts-var-dialog-footer-background'?: string;
-    [key: string]: string;
 }
 //# sourceMappingURL=css-variables.d.ts.map