@thoughtspot/visual-embed-sdk 1.35.11 → 1.35.13

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

@@ -1698,10 +1698,11 @@ export declare class LiveboardEmbed extends V1Embed {
         protected handleRenderForPrerender(): void;
         /**
             * Triggers an event to the embedded app
-            * @param messageType The event type
-            * @param data The payload to send with the message
+            * @param {HostEvent} messageType The event type
+            * @param {any} data The payload to send with the message
+            * @returns A promise that resolves with the response from the embedded app
             */
-        trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
+        trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
         /**
             * Render an embedded ThoughtSpot Liveboard or visualization
             * @param renderOptions An object specifying the Liveboard ID,
@@ -1749,6 +1750,10 @@ export interface SearchOptions {
             */
         searchQuery: string;
 }
+/**
+    * The configuration for the embedded conversationEmbed options.
+    * @group Embed components
+    */
 export interface ConversationViewConfig extends ViewConfig {
         /**
             * The ID of the worksheet to use for the conversation.
@@ -1783,6 +1788,46 @@ export interface ConversationViewConfig extends ViewConfig {
             * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
             */
         hideSourceSelection?: boolean;
+        /**
+            * Flag to control Data panel experience
+            * @default false
+            * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    dataPanelV2: true,
+            * })
+            * ```
+            */
+        dataPanelV2?: boolean;
+        /**
+            * showSpotterLimitations : show limitation text
+            * of the spotter underneath the chat input.
+            * default is false.
+            * @example
+            * ```js
+            * const embed = new ConversationEmbed('#tsEmbed', {
+            *    ... // other options
+            *    showSpotterLimitations : true,
+            * })
+            * ```
+            * @version SDK: 1.36.0 | Thoughtspot: 10.5.0.cl
+            */
+        showSpotterLimitations?: boolean;
+        /**
+            * hideSampleQuestions : Hide sample questions on
+            * the initial screen of the conversation.
+            * @example
+            * ```js
+            * const embed = new ConversationEmbed('#tsEmbed', {
+            *    ... // other options
+            *    hideSampleQuestions : true,
+            * })
+            * ```
+            * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+            */
+        hideSampleQuestions?: boolean;
 }
 /**
     * Embed ThoughtSpot AI Conversation.
@@ -1996,7 +2041,8 @@ export declare enum AuthFailureType {
         SDK = "SDK",
         NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
         EXPIRY = "EXPIRY",
-        OTHER = "OTHER"
+        OTHER = "OTHER",
+        IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT"
 }
 /**
     * Enum for auth status emitted by the emitter returned from {@link init}.
@@ -2723,7 +2769,12 @@ export interface EmbedConfig {
             */
         suppressErrorAlerts?: boolean;
         /**
-            * Log level for the SDK.
+            * Suppress or show specific types of logs in the console output.
+            * For example, `LogLevel.ERROR` shows only Visual Embed SDK and
+            * ThoughtSpot application errors and suppresses
+            * other logs such as warnings, information alerts,
+            * and debug messages in the console output.
+            *
             * @default LogLevel.ERROR
             * @example
             * ```js
@@ -3303,12 +3354,6 @@ export interface ViewConfig {
             * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
             */
         overrideOrgId?: number;
-        /**
-            * Flag to control new flip tooltip context menu experience
-            * @default false
-            * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
-            */
-        enableFlipTooltipToContextMenu?: boolean;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3760,6 +3805,11 @@ export declare enum EmbedEvent {
             * @hidden
             */
         AuthFailure = "ThoughtspotAuthFailure",
+        /**
+            * ThoughtSpot failed to re validate the auth session.
+            * @hidden
+            */
+        IdleSessionTimeout = "IdleSessionTimeout",
         /**
             * ThoughtSpot failed to validate the auth session.
             * @hidden
@@ -4465,7 +4515,37 @@ export declare enum EmbedEvent {
             *```
             * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
             */
-        ParameterChanged = "parameterChanged"
+        ParameterChanged = "parameterChanged",
+        /**
+            * Emitted when the table viz renders.
+            * You can use this event as a hook to trigger
+            * other events on the rendered table viz data.
+            * @example
+            * ```js
+            * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
+            *       console.log(payload);
+            *       const columnDataLite = payload.data.data.columnDataLite;
+            *       columnDataLite[0].dataValue[0]="new fob";
+            *       console.log('>>> new Data', columnDataLite);
+            *       searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
+            * })
+            * ```
+            * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+            */
+        TableVizRendered = "TableVizRendered",
+        /**
+         * Emitted when the liveboard is created from pin modal or liveboard list page.
+         * You can use this event as a hook to trigger
+         * other events on liveboard creation.
+         *
+         * ```js
+         * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
+         *     console.log('payload', payload);
+         * })
+         *```
+         * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
+         */
+        CreateLiveboard = "createLiveboard"
 }
 /**
     * Event types that can be triggered by the host application
@@ -4874,7 +4954,7 @@ export declare enum HostEvent {
             * @param - an object with `vizId` as a key
             * @example
             * ```js
-            * liveboardEmbed.trigger(HostEvent.CreateMonitor {
+            * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
             *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             * ```
@@ -5406,7 +5486,26 @@ export declare enum HostEvent {
             * EmbedApi
             * @hidden
             */
-        UIPassthrough = "UiPassthrough"
+        UIPassthrough = "UiPassthrough",
+        /**
+            * Triggers the table viz rerender with the updated data.
+            * Includes the following properties:
+            * @param - columnDataLite - an array of object containing data
+            * transformed from data picked from TableVizRendered event.
+            * For example, { columnDataLite: []}
+            * @example
+            * ```js
+            * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
+            *       console.log(payload);
+            *       const columnDataLite = payload.data.data.columnDataLite;
+            *       columnDataLite[0].dataValue[0]="new fob";
+            *       console.log('>>> new Data', columnDataLite);
+            *       searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
+            * })
+            * ```
+            * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+            */
+        TransformTableVizData = "TransformTableVizData"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -5447,6 +5546,7 @@ export declare enum Param {
         HideResult = "hideResult",
         UseLastSelectedDataSource = "useLastSelectedSources",
         Tag = "tag",
+        AutoLogin = "autoLogin",
         searchTokenString = "searchTokenString",
         executeSearch = "executeSearch",
         fullHeight = "isFullHeightPinboard",
@@ -5468,7 +5568,7 @@ export declare enum Param {
         AuthType = "authType",
         IconSpriteUrl = "iconSprite",
         cookieless = "cookieless",
-        ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
+        ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
         LinkOverride = "linkOverride",
         blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
         ShowInsertToSlide = "insertInToSlide",
@@ -5523,10 +5623,10 @@ export declare enum Param {
         SpotterEnabled = "isSpotterExperienceEnabled",
         IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled",
         OverrideOrgId = "orgId",
-        EnableFlipTooltipToContextMenu = "flipTooltipToContextMenuEnabled",
         OauthPollingInterval = "oAuthPollingInterval",
         IsForceRedirect = "isForceRedirect",
-        DataSourceId = "dataSourceId"
+        DataSourceId = "dataSourceId",
+        ShowSpotterLimitations = "showSpotterLimitations"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -6725,10 +6825,12 @@ export declare enum PrefetchFeatures {
 }
 /**
     * Enum for options to change context trigger
+    * BOTH_CLICKS option is introduced in 10.7
     */
 export declare enum ContextMenuTriggerOptions {
         LEFT_CLICK = "left-click",
-        RIGHT_CLICK = "right-click"
+        RIGHT_CLICK = "right-click",
+        BOTH_CLICKS = "both-clicks"
 }
 export interface ColumnValue {
         column: {
@@ -6771,9 +6873,16 @@ export interface CustomActionPayload {
         session: SessionInterface;
         vizId?: string;
 }
+/**
+    * Enum options to show or suppress Visual Embed SDK and
+    * ThoughtSpot application logs in the console output.
+    * This attribute doesn't support suppressing
+    * browser warnings or errors.
+    */
 export declare enum LogLevel {
         /**
-            * No logs will be logged in the console.
+            * No application or SDK-related logs will be logged
+            * in the console output.
             * @example
             * ```js
             * init({
@@ -6785,7 +6894,7 @@ export declare enum LogLevel {
             */
         SILENT = "SILENT",
         /**
-            * Only ERROR logs will be logged in the console.
+            * Log only errors in the console output.
             * @example
             * ```js
             * init({
@@ -6797,7 +6906,7 @@ export declare enum LogLevel {
             */
         ERROR = "ERROR",
         /**
-            * Only WARN and ERROR logs will be logged in the console.
+            * Log only warnings and errors in the console output.
             * @example
             * ```js
             * init({
@@ -6809,7 +6918,8 @@ export declare enum LogLevel {
             */
         WARN = "WARN",
         /**
-            * Only INFO, WARN, and ERROR logs will be logged in the console.
+            * Log only the information alerts, warnings, and errors
+            * in the console output.
             * @example
             * ```js
             * init({
@@ -6821,7 +6931,8 @@ export declare enum LogLevel {
             */
         INFO = "INFO",
         /**
-            * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
+            * Log debug messages, warnings, information alerts,
+            * and errors in the console output.
             * @example
             * ```js
             * init({
@@ -6833,7 +6944,7 @@ export declare enum LogLevel {
             */
         DEBUG = "DEBUG",
         /**
-            * All logs will be logged in the console.
+            * All logs will be logged in the browser console.
             * @example
             * ```js
             * init({
@@ -7527,13 +7638,13 @@ export type UIPassthroughContractBase = {
             vizId?: string;
             newVizName: string;
             newVizDescription?: string;
-            pinboardId?: string;
+            liveboardId?: string;
             tabId?: string;
-            newPinboardName?: string;
+            newLiveboardName?: string;
             newTabName?: string;
         };
         response: {
-            pinboardId: string;
+            liveboardId: string;
             tabId: string;
             vizId: string;
         };

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

@@ -1688,10 +1688,11 @@ export declare class LiveboardEmbed extends V1Embed {
         protected handleRenderForPrerender(): void;
         /**
             * Triggers an event to the embedded app
-            * @param messageType The event type
-            * @param data The payload to send with the message
+            * @param {HostEvent} messageType The event type
+            * @param {any} data The payload to send with the message
+            * @returns A promise that resolves with the response from the embedded app
             */
-        trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
+        trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
         /**
             * Render an embedded ThoughtSpot Liveboard or visualization
             * @param renderOptions An object specifying the Liveboard ID,
@@ -1739,6 +1740,10 @@ export interface SearchOptions {
             */
         searchQuery: string;
 }
+/**
+    * The configuration for the embedded conversationEmbed options.
+    * @group Embed components
+    */
 export interface ConversationViewConfig extends ViewConfig {
         /**
             * The ID of the worksheet to use for the conversation.
@@ -1773,6 +1778,46 @@ export interface ConversationViewConfig extends ViewConfig {
             * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
             */
         hideSourceSelection?: boolean;
+        /**
+            * Flag to control Data panel experience
+            * @default false
+            * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    dataPanelV2: true,
+            * })
+            * ```
+            */
+        dataPanelV2?: boolean;
+        /**
+            * showSpotterLimitations : show limitation text
+            * of the spotter underneath the chat input.
+            * default is false.
+            * @example
+            * ```js
+            * const embed = new ConversationEmbed('#tsEmbed', {
+            *    ... // other options
+            *    showSpotterLimitations : true,
+            * })
+            * ```
+            * @version SDK: 1.36.0 | Thoughtspot: 10.5.0.cl
+            */
+        showSpotterLimitations?: boolean;
+        /**
+            * hideSampleQuestions : Hide sample questions on
+            * the initial screen of the conversation.
+            * @example
+            * ```js
+            * const embed = new ConversationEmbed('#tsEmbed', {
+            *    ... // other options
+            *    hideSampleQuestions : true,
+            * })
+            * ```
+            * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+            */
+        hideSampleQuestions?: boolean;
 }
 /**
     * Embed ThoughtSpot AI Conversation.
@@ -2315,7 +2360,12 @@ export interface EmbedConfig {
             */
         suppressErrorAlerts?: boolean;
         /**
-            * Log level for the SDK.
+            * Suppress or show specific types of logs in the console output.
+            * For example, `LogLevel.ERROR` shows only Visual Embed SDK and
+            * ThoughtSpot application errors and suppresses
+            * other logs such as warnings, information alerts,
+            * and debug messages in the console output.
+            *
             * @default LogLevel.ERROR
             * @example
             * ```js
@@ -2895,12 +2945,6 @@ export interface ViewConfig {
             * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
             */
         overrideOrgId?: number;
-        /**
-            * Flag to control new flip tooltip context menu experience
-            * @default false
-            * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
-            */
-        enableFlipTooltipToContextMenu?: boolean;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3352,6 +3396,11 @@ export declare enum EmbedEvent {
             * @hidden
             */
         AuthFailure = "ThoughtspotAuthFailure",
+        /**
+            * ThoughtSpot failed to re validate the auth session.
+            * @hidden
+            */
+        IdleSessionTimeout = "IdleSessionTimeout",
         /**
             * ThoughtSpot failed to validate the auth session.
             * @hidden
@@ -4057,7 +4106,37 @@ export declare enum EmbedEvent {
             *```
             * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
             */
-        ParameterChanged = "parameterChanged"
+        ParameterChanged = "parameterChanged",
+        /**
+            * Emitted when the table viz renders.
+            * You can use this event as a hook to trigger
+            * other events on the rendered table viz data.
+            * @example
+            * ```js
+            * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
+            *       console.log(payload);
+            *       const columnDataLite = payload.data.data.columnDataLite;
+            *       columnDataLite[0].dataValue[0]="new fob";
+            *       console.log('>>> new Data', columnDataLite);
+            *       searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
+            * })
+            * ```
+            * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+            */
+        TableVizRendered = "TableVizRendered",
+        /**
+         * Emitted when the liveboard is created from pin modal or liveboard list page.
+         * You can use this event as a hook to trigger
+         * other events on liveboard creation.
+         *
+         * ```js
+         * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
+         *     console.log('payload', payload);
+         * })
+         *```
+         * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
+         */
+        CreateLiveboard = "createLiveboard"
 }
 /**
     * Event types that can be triggered by the host application
@@ -4466,7 +4545,7 @@ export declare enum HostEvent {
             * @param - an object with `vizId` as a key
             * @example
             * ```js
-            * liveboardEmbed.trigger(HostEvent.CreateMonitor {
+            * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
             *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             * ```
@@ -4998,7 +5077,26 @@ export declare enum HostEvent {
             * EmbedApi
             * @hidden
             */
-        UIPassthrough = "UiPassthrough"
+        UIPassthrough = "UiPassthrough",
+        /**
+            * Triggers the table viz rerender with the updated data.
+            * Includes the following properties:
+            * @param - columnDataLite - an array of object containing data
+            * transformed from data picked from TableVizRendered event.
+            * For example, { columnDataLite: []}
+            * @example
+            * ```js
+            * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
+            *       console.log(payload);
+            *       const columnDataLite = payload.data.data.columnDataLite;
+            *       columnDataLite[0].dataValue[0]="new fob";
+            *       console.log('>>> new Data', columnDataLite);
+            *       searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
+            * })
+            * ```
+            * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+            */
+        TransformTableVizData = "TransformTableVizData"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -5039,6 +5137,7 @@ export declare enum Param {
         HideResult = "hideResult",
         UseLastSelectedDataSource = "useLastSelectedSources",
         Tag = "tag",
+        AutoLogin = "autoLogin",
         searchTokenString = "searchTokenString",
         executeSearch = "executeSearch",
         fullHeight = "isFullHeightPinboard",
@@ -5060,7 +5159,7 @@ export declare enum Param {
         AuthType = "authType",
         IconSpriteUrl = "iconSprite",
         cookieless = "cookieless",
-        ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
+        ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
         LinkOverride = "linkOverride",
         blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
         ShowInsertToSlide = "insertInToSlide",
@@ -5115,10 +5214,10 @@ export declare enum Param {
         SpotterEnabled = "isSpotterExperienceEnabled",
         IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled",
         OverrideOrgId = "orgId",
-        EnableFlipTooltipToContextMenu = "flipTooltipToContextMenuEnabled",
         OauthPollingInterval = "oAuthPollingInterval",
         IsForceRedirect = "isForceRedirect",
-        DataSourceId = "dataSourceId"
+        DataSourceId = "dataSourceId",
+        ShowSpotterLimitations = "showSpotterLimitations"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -6317,10 +6416,12 @@ export declare enum PrefetchFeatures {
 }
 /**
     * Enum for options to change context trigger
+    * BOTH_CLICKS option is introduced in 10.7
     */
 export declare enum ContextMenuTriggerOptions {
         LEFT_CLICK = "left-click",
-        RIGHT_CLICK = "right-click"
+        RIGHT_CLICK = "right-click",
+        BOTH_CLICKS = "both-clicks"
 }
 export interface ColumnValue {
         column: {
@@ -6363,9 +6464,16 @@ export interface CustomActionPayload {
         session: SessionInterface;
         vizId?: string;
 }
+/**
+    * Enum options to show or suppress Visual Embed SDK and
+    * ThoughtSpot application logs in the console output.
+    * This attribute doesn't support suppressing
+    * browser warnings or errors.
+    */
 export declare enum LogLevel {
         /**
-            * No logs will be logged in the console.
+            * No application or SDK-related logs will be logged
+            * in the console output.
             * @example
             * ```js
             * init({
@@ -6377,7 +6485,7 @@ export declare enum LogLevel {
             */
         SILENT = "SILENT",
         /**
-            * Only ERROR logs will be logged in the console.
+            * Log only errors in the console output.
             * @example
             * ```js
             * init({
@@ -6389,7 +6497,7 @@ export declare enum LogLevel {
             */
         ERROR = "ERROR",
         /**
-            * Only WARN and ERROR logs will be logged in the console.
+            * Log only warnings and errors in the console output.
             * @example
             * ```js
             * init({
@@ -6401,7 +6509,8 @@ export declare enum LogLevel {
             */
         WARN = "WARN",
         /**
-            * Only INFO, WARN, and ERROR logs will be logged in the console.
+            * Log only the information alerts, warnings, and errors
+            * in the console output.
             * @example
             * ```js
             * init({
@@ -6413,7 +6522,8 @@ export declare enum LogLevel {
             */
         INFO = "INFO",
         /**
-            * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
+            * Log debug messages, warnings, information alerts,
+            * and errors in the console output.
             * @example
             * ```js
             * init({
@@ -6425,7 +6535,7 @@ export declare enum LogLevel {
             */
         DEBUG = "DEBUG",
         /**
-            * All logs will be logged in the console.
+            * All logs will be logged in the browser console.
             * @example
             * ```js
             * init({
@@ -6771,13 +6881,13 @@ export type UIPassthroughContractBase = {
             vizId?: string;
             newVizName: string;
             newVizDescription?: string;
-            pinboardId?: string;
+            liveboardId?: string;
             tabId?: string;
-            newPinboardName?: string;
+            newLiveboardName?: string;
             newTabName?: string;
         };
         response: {
-            pinboardId: string;
+            liveboardId: string;
             tabId: string;
             vizId: string;
         };
@@ -7025,7 +7135,8 @@ export declare enum AuthFailureType {
         SDK = "SDK",
         NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
         EXPIRY = "EXPIRY",
-        OTHER = "OTHER"
+        OTHER = "OTHER",
+        IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT"
 }
 /**
     * Enum for auth status emitted by the emitter returned from {@link init}.