@thoughtspot/visual-embed-sdk 1.29.1 → 1.29.2

package/lib/src/visual-embed-sdk.d.ts

@@ -1939,7 +1939,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             };
             /**
                 * 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;
@@ -3159,7 +3160,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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
@@ -3170,6 +3173,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             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
@@ -3646,8 +3651,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * _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
@@ -3775,16 +3780,22 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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)
@@ -3802,7 +3813,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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)
@@ -3870,22 +3886,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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",
@@ -4142,7 +4159,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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);
@@ -4164,11 +4183,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * `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
                 *
@@ -4484,7 +4504,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             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]
@@ -4688,8 +4710,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             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.
@@ -4938,7 +4964,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             QueryDetailsButtons = "queryDetailsButtons",
             /**
-                * The **Delete** action for Answers.
+                * The **Delete** action for Answers in the full application
+                * embedding mode.
+                *
                 * @example
                 * ```js
                 * disabledActions: [Action.AnswerDelete]

package/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",

package/src/types.ts

@@ -528,7 +528,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;
@@ -1771,7 +1772,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
@@ -1782,6 +1785,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
@@ -2260,8 +2265,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
@@ -2389,16 +2394,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)
@@ -2416,7 +2427,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)
@@ -2484,22 +2500,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',
@@ -2756,7 +2773,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);
@@ -2778,11 +2797,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
      *
@@ -3105,7 +3125,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]
@@ -3309,8 +3331,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.
@@ -3560,7 +3586,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/src/utils/graphql/answerService/answer-queries.ts

@@ -67,6 +67,9 @@ export const getAnswer = `
             ${bachSessionId}
             answer {
                 id
+                name
+                description
+                displayMode
                 sources {
                     header {
                         guid
@@ -136,3 +139,19 @@ export const getAnswerData = `
         }
     }
 `;
+
+export const addVizToLiveboard = `
+    mutation AddVizToLiveboard(liveboardId: GUID!, session: BachSessionIdInput!, tabId: GUID, vizId: GUID!) {
+        Answer__addVizToPinboard(
+            pinboardId: liveboardId
+
+            session: $session
+
+            tabId: $tabId
+
+            vizId: $vizId
+        ) {
+            ${bachSessionId}
+        }
+    }
+`;