@thoughtspot/visual-embed-sdk 1.29.1 → 1.29.2

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

@@ -2271,7 +2271,8 @@ export interface EmbedConfig {
         };
         /**
             * Pendo API key to enable Pendo tracking to your own subscription, the key
-            * is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
+            * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
+            *
             * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
             */
         pendoTrackingKey?: string;
@@ -3491,7 +3492,9 @@ export declare enum EmbedEvent {
             */
         CopyToClipboard = "context-menu-item-copy-to-clipboard",
         /**
-            * Emitted when a user clicks the **Update TML** action
+            * Emitted when a user clicks the **Update TML** action on
+            * embedded Liveboard.
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3502,6 +3505,8 @@ export declare enum EmbedEvent {
         UpdateTML = "updateTSL",
         /**
             * Emitted when a user clicks the **Edit TML** action
+            * on an embedded Liveboard.
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3978,8 +3983,8 @@ export declare enum HostEvent {
             * _String_. The name of the column to filter on.
             *
             * `operator`
-            * Runtime filter operator to apply. For information,
-            * see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+            *  Runtime filter operator to apply. For information,
+            *  see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
             *
             * `values`
             * List of operands. Some operators such as EQ, LE allow a single value, whereas
@@ -4107,16 +4112,22 @@ export declare enum HostEvent {
             */
         SchedulesList = "schedule-list",
         /**
-            * Trigger the **Export TML** action on an embedded Liveboard.
+            * Trigger the **Export TML** action on an embedded Liveboard or
+            * Answer.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.ExportTML)
             * ```
+            *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         ExportTML = "exportTSL",
         /**
-            * Trigger the **Edit TML** action on an embedded Liveboard.
+            * Trigger the **Edit TML** action on an embedded Liveboard or
+            * saved Answers in the full application embedding.
+            *
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -4134,7 +4145,12 @@ export declare enum HostEvent {
             */
         UpdateTML = "updateTSL",
         /**
-            * Trigger the **Download PDF** action on an embedded Liveboard.
+            * Trigger the **Download PDF** action on an embedded Liveboard,
+            * visualization or Answer.
+            *
+            * **NOTE**: The **Download** > **PDF** action is available on
+            * visualizations and Answers if the data is in tabular format.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -4202,22 +4218,23 @@ export declare enum HostEvent {
             */
         ManageMonitor = "manageMonitor",
         /**
-            * Trigger the **Edit** action on a Liveboard or visualization
+            * Trigger the **Edit** action on a Liveboard or a visualization
+            * on a Liveboard.
+            *
+            * This event is not supported in visualization embed and search embed.
+            *
             * @param - object - To trigger the action for a specific visualization
             * in Liveboard embed, pass in `vizId` as a key.
-            * Can be left undefined when embedding Search, full app, or
-            * a visualization.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
             * ```
+            * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
             * '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
-            * ```js
-            * vizEmbed.trigger((HostEvent.Edit)
-            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         Edit = "edit",
@@ -4474,7 +4491,9 @@ export declare enum HostEvent {
             */
         ResetSearch = "resetSearch",
         /**
-            * Get details of the visible and runtime filters applied on Liveboard.
+            * Get details of filters applied on the Liveboard.
+            * Returns arrays containing Liveboard filter and runtime filter elements.
+            *
             * @example
             * ```js
             * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -4496,11 +4515,12 @@ export declare enum HostEvent {
             *
             * `oper`  - Filter operator, for example, EQ, IN, CONTAINS.
             *  For information about the supported filter operators,
-            *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
+            *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
             *
             * `values` - An array of one or several values. The value definition on the
             *  data type you choose to filter on. For a complete list of supported data types,
-            *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
+            *  see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
+            *
             * @example
             * ```js
             *
@@ -4816,7 +4836,9 @@ export declare enum Action {
         SaveUntitled = "saveUntitled",
         /**
             * The **Save as View** action on the Answer
-            * page. Saves an Answer as a View object.
+            * page. Saves an Answer as a View object in the full
+            * application embedding mode.
+            *
             * @example
             * ```js
             * disabledActions: [Action.SaveAsView]
@@ -5020,8 +5042,12 @@ export declare enum Action {
         DownloadAsPng = "downloadAsPng",
         /**
             *
-            *The **Download PDF** action that downloads a Liveboard,
-            *visualization, or Answer as a PDF file.
+            * The **Download PDF** action that downloads a Liveboard,
+            * visualization, or Answer as a PDF file.
+            *
+            *
+            * **NOTE**: The **Download** > **PDF** action is available on
+            * visualizations and Answers if the data is in tabular format.
             *
             ***NOTE**: The **Download** > **PDF** action is available on
             *visualizations and Answers if the data is in tabular format.
@@ -5270,7 +5296,9 @@ export declare enum Action {
             */
         QueryDetailsButtons = "queryDetailsButtons",
         /**
-            * The **Delete** action for Answers.
+            * The **Delete** action for Answers in the full application
+            * embedding mode.
+            *
             * @example
             * ```js
             * disabledActions: [Action.AnswerDelete]

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

@@ -1967,7 +1967,8 @@ export interface EmbedConfig {
         };
         /**
             * Pendo API key to enable Pendo tracking to your own subscription, the key
-            * is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
+            * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
+            *
             * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
             */
         pendoTrackingKey?: string;
@@ -3187,7 +3188,9 @@ export declare enum EmbedEvent {
             */
         CopyToClipboard = "context-menu-item-copy-to-clipboard",
         /**
-            * Emitted when a user clicks the **Update TML** action
+            * Emitted when a user clicks the **Update TML** action on
+            * embedded Liveboard.
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3198,6 +3201,8 @@ export declare enum EmbedEvent {
         UpdateTML = "updateTSL",
         /**
             * Emitted when a user clicks the **Edit TML** action
+            * on an embedded Liveboard.
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3674,8 +3679,8 @@ export declare enum HostEvent {
             * _String_. The name of the column to filter on.
             *
             * `operator`
-            * Runtime filter operator to apply. For information,
-            * see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+            *  Runtime filter operator to apply. For information,
+            *  see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
             *
             * `values`
             * List of operands. Some operators such as EQ, LE allow a single value, whereas
@@ -3803,16 +3808,22 @@ export declare enum HostEvent {
             */
         SchedulesList = "schedule-list",
         /**
-            * Trigger the **Export TML** action on an embedded Liveboard.
+            * Trigger the **Export TML** action on an embedded Liveboard or
+            * Answer.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.ExportTML)
             * ```
+            *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         ExportTML = "exportTSL",
         /**
-            * Trigger the **Edit TML** action on an embedded Liveboard.
+            * Trigger the **Edit TML** action on an embedded Liveboard or
+            * saved Answers in the full application embedding.
+            *
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -3830,7 +3841,12 @@ export declare enum HostEvent {
             */
         UpdateTML = "updateTSL",
         /**
-            * Trigger the **Download PDF** action on an embedded Liveboard.
+            * Trigger the **Download PDF** action on an embedded Liveboard,
+            * visualization or Answer.
+            *
+            * **NOTE**: The **Download** > **PDF** action is available on
+            * visualizations and Answers if the data is in tabular format.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -3898,22 +3914,23 @@ export declare enum HostEvent {
             */
         ManageMonitor = "manageMonitor",
         /**
-            * Trigger the **Edit** action on a Liveboard or visualization
+            * Trigger the **Edit** action on a Liveboard or a visualization
+            * on a Liveboard.
+            *
+            * This event is not supported in visualization embed and search embed.
+            *
             * @param - object - To trigger the action for a specific visualization
             * in Liveboard embed, pass in `vizId` as a key.
-            * Can be left undefined when embedding Search, full app, or
-            * a visualization.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
             * ```
+            * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
             * '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
-            * ```js
-            * vizEmbed.trigger((HostEvent.Edit)
-            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         Edit = "edit",
@@ -4170,7 +4187,9 @@ export declare enum HostEvent {
             */
         ResetSearch = "resetSearch",
         /**
-            * Get details of the visible and runtime filters applied on Liveboard.
+            * Get details of filters applied on the Liveboard.
+            * Returns arrays containing Liveboard filter and runtime filter elements.
+            *
             * @example
             * ```js
             * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -4192,11 +4211,12 @@ export declare enum HostEvent {
             *
             * `oper`  - Filter operator, for example, EQ, IN, CONTAINS.
             *  For information about the supported filter operators,
-            *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
+            *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
             *
             * `values` - An array of one or several values. The value definition on the
             *  data type you choose to filter on. For a complete list of supported data types,
-            *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
+            *  see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
+            *
             * @example
             * ```js
             *
@@ -4512,7 +4532,9 @@ export declare enum Action {
         SaveUntitled = "saveUntitled",
         /**
             * The **Save as View** action on the Answer
-            * page. Saves an Answer as a View object.
+            * page. Saves an Answer as a View object in the full
+            * application embedding mode.
+            *
             * @example
             * ```js
             * disabledActions: [Action.SaveAsView]
@@ -4716,8 +4738,12 @@ export declare enum Action {
         DownloadAsPng = "downloadAsPng",
         /**
             *
-            *The **Download PDF** action that downloads a Liveboard,
-            *visualization, or Answer as a PDF file.
+            * The **Download PDF** action that downloads a Liveboard,
+            * visualization, or Answer as a PDF file.
+            *
+            *
+            * **NOTE**: The **Download** > **PDF** action is available on
+            * visualizations and Answers if the data is in tabular format.
             *
             ***NOTE**: The **Download** > **PDF** action is available on
             *visualizations and Answers if the data is in tabular format.
@@ -4966,7 +4992,9 @@ export declare enum Action {
             */
         QueryDetailsButtons = "queryDetailsButtons",
         /**
-            * The **Delete** action for Answers.
+            * The **Delete** action for Answers in the full application
+            * embedding mode.
+            *
             * @example
             * ```js
             * disabledActions: [Action.AnswerDelete]

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

@@ -1897,7 +1897,8 @@ export interface EmbedConfig {
         };
         /**
             * Pendo API key to enable Pendo tracking to your own subscription, the key
-            * is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
+            * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
+            *
             * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
             */
         pendoTrackingKey?: string;
@@ -3117,7 +3118,9 @@ export enum EmbedEvent {
             */
         CopyToClipboard = "context-menu-item-copy-to-clipboard",
         /**
-            * Emitted when a user clicks the **Update TML** action
+            * Emitted when a user clicks the **Update TML** action on
+            * embedded Liveboard.
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3128,6 +3131,8 @@ export enum EmbedEvent {
         UpdateTML = "updateTSL",
         /**
             * Emitted when a user clicks the **Edit TML** action
+            * on an embedded Liveboard.
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -3604,8 +3609,8 @@ export enum HostEvent {
             * _String_. The name of the column to filter on.
             *
             * `operator`
-            * Runtime filter operator to apply. For information,
-            * see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+            *  Runtime filter operator to apply. For information,
+            *  see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
             *
             * `values`
             * List of operands. Some operators such as EQ, LE allow a single value, whereas
@@ -3733,16 +3738,22 @@ export enum HostEvent {
             */
         SchedulesList = "schedule-list",
         /**
-            * Trigger the **Export TML** action on an embedded Liveboard.
+            * Trigger the **Export TML** action on an embedded Liveboard or
+            * Answer.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.ExportTML)
             * ```
+            *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         ExportTML = "exportTSL",
         /**
-            * Trigger the **Edit TML** action on an embedded Liveboard.
+            * Trigger the **Edit TML** action on an embedded Liveboard or
+            * saved Answers in the full application embedding.
+            *
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -3760,7 +3771,12 @@ export enum HostEvent {
             */
         UpdateTML = "updateTSL",
         /**
-            * Trigger the **Download PDF** action on an embedded Liveboard.
+            * Trigger the **Download PDF** action on an embedded Liveboard,
+            * visualization or Answer.
+            *
+            * **NOTE**: The **Download** > **PDF** action is available on
+            * visualizations and Answers if the data is in tabular format.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -3828,22 +3844,23 @@ export enum HostEvent {
             */
         ManageMonitor = "manageMonitor",
         /**
-            * Trigger the **Edit** action on a Liveboard or visualization
+            * Trigger the **Edit** action on a Liveboard or a visualization
+            * on a Liveboard.
+            *
+            * This event is not supported in visualization embed and search embed.
+            *
             * @param - object - To trigger the action for a specific visualization
             * in Liveboard embed, pass in `vizId` as a key.
-            * Can be left undefined when embedding Search, full app, or
-            * a visualization.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
             * ```
+            * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
             * '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
-            * ```js
-            * vizEmbed.trigger((HostEvent.Edit)
-            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         Edit = "edit",
@@ -4100,7 +4117,9 @@ export enum HostEvent {
             */
         ResetSearch = "resetSearch",
         /**
-            * Get details of the visible and runtime filters applied on Liveboard.
+            * Get details of filters applied on the Liveboard.
+            * Returns arrays containing Liveboard filter and runtime filter elements.
+            *
             * @example
             * ```js
             * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -4122,11 +4141,12 @@ export enum HostEvent {
             *
             * `oper`  - Filter operator, for example, EQ, IN, CONTAINS.
             *  For information about the supported filter operators,
-            *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
+            *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
             *
             * `values` - An array of one or several values. The value definition on the
             *  data type you choose to filter on. For a complete list of supported data types,
-            *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
+            *  see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
+            *
             * @example
             * ```js
             *
@@ -4442,7 +4462,9 @@ export enum Action {
         SaveUntitled = "saveUntitled",
         /**
             * The **Save as View** action on the Answer
-            * page. Saves an Answer as a View object.
+            * page. Saves an Answer as a View object in the full
+            * application embedding mode.
+            *
             * @example
             * ```js
             * disabledActions: [Action.SaveAsView]
@@ -4646,8 +4668,12 @@ export enum Action {
         DownloadAsPng = "downloadAsPng",
         /**
             *
-            *The **Download PDF** action that downloads a Liveboard,
-            *visualization, or Answer as a PDF file.
+            * The **Download PDF** action that downloads a Liveboard,
+            * visualization, or Answer as a PDF file.
+            *
+            *
+            * **NOTE**: The **Download** > **PDF** action is available on
+            * visualizations and Answers if the data is in tabular format.
             *
             ***NOTE**: The **Download** > **PDF** action is available on
             *visualizations and Answers if the data is in tabular format.
@@ -4896,7 +4922,9 @@ export enum Action {
             */
         QueryDetailsButtons = "queryDetailsButtons",
         /**
-            * The **Delete** action for Answers.
+            * The **Delete** action for Answers in the full application
+            * embedding mode.
+            *
             * @example
             * ```js
             * disabledActions: [Action.AnswerDelete]

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.29.1",
+    "version": "1.29.2",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",