@thoughtspot/visual-embed-sdk 1.42.0 → 1.42.1-HE2

package/src/types.ts

@@ -1512,7 +1512,22 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     liveboardXLSXCSVDownload?: boolean;
-
+    /**
+     * This flag is used to enable or disable the link parameters in liveboard.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isLinkParametersEnabled: true,
+     * })
+     * ```
+     */
+    isLinkParametersEnabled?: boolean;
+    
 }
 
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig { }
@@ -1820,7 +1835,7 @@ export enum EmbedEvent {
      */
     Load = 'load',
     /**
-     * Data pertaining to an Answer or Liveboard is received.
+     * Data pertaining to an Answer, Liveboard or Spotter visualization is received.
      * The event payload includes the raw data of the object.
      * @return data -  Answer of Liveboard data
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
@@ -3194,7 +3209,7 @@ export enum HostEvent {
      * the following parameters:
      *
      * @param
-     * `vizId`-  GUID of the saved Answer or visualization to pin to a Liveboard.
+     * `vizId`-  GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
      *  Optional when pinning a new chart or table generated from a Search query.
      *  **Required** in Spotter Embed.
      * @param
@@ -3246,10 +3261,16 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const pinResponse = await spotterEmbed.trigger(HostEvent.Pin, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
+    * ```
+     * 
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     Pin = 'pin',
@@ -3324,10 +3345,15 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
+    * ```
      * 
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
@@ -3354,10 +3380,14 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
+    * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     MakeACopy = 'makeACopy',
@@ -3442,15 +3472,7 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
-     * @example
-     * ```js
-     * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
+     * spotterEmbed.trigger(HostEvent.Edit);
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
@@ -3499,16 +3521,23 @@ export enum HostEvent {
      *   );
      * })
      * ```
-     * @example
+     * * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.GetTML, {
-     *   vizId: '730496d6-6903-4601-937e-2c691821af3c'
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.GetTML, {
+     *   vizId: latestSpotterVizId
      * }).then((tml) => {
      *   console.log(
      *      tml.answer.search_query // TML representation of the search query
      *   );
      * })
-     * ```
+    * ```
      * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
      * @important
      */
@@ -3572,7 +3601,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** action on charts in
      * the embedded view.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -3582,10 +3611,14 @@ export enum HostEvent {
      * embed.trigger(HostEvent.Download)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.Download, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
+    * ```
      * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
      * Use {@link DownloadAsPng}
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -3603,9 +3636,13 @@ export enum HostEvent {
      *
      * searchEmbed.trigger(HostEvent.DownloadAsPng)
      * 
-     * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
      * ```
      * 
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
@@ -3614,7 +3651,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** > **CSV**  action on tables in
      * the embedded view.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -3627,9 +3664,13 @@ export enum HostEvent {
      * searchEmbed.trigger(HostEvent.DownloadAsCsv)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
@@ -3637,7 +3678,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** > **XLSX**  action on tables
      * in the embedded view.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -3650,9 +3691,13 @@ export enum HostEvent {
      * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
@@ -3689,7 +3734,7 @@ export enum HostEvent {
    * ```
    *
    * ```js
-   * // Save an Answer in Spotter (requires vizId)
+   * // Save a Visualization in Spotter (requires vizId)
    * spotterEmbed.trigger(HostEvent.Save, {
    *   vizId: "730496d6-6903-4601-937e-2c691821af3c"
    * })
@@ -4011,11 +4056,13 @@ export enum HostEvent {
      * });
      *```
      *```js
-     * spotterEmbed.trigger(HostEvent.GetParameters, {
-     *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
-     * }).then((parameter) => {
-     *  console.log('parameters', parameter);
-     * });
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
      *```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
@@ -4058,11 +4105,13 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
-     *      vizId: '730496d6-6903-4601-937e-2c691821af3c',
-     *      name: "Sales by states",
-     *      description: "Total sales by states in MidWest"
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
      * });
+    *
+    * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
@@ -4146,12 +4195,15 @@ export enum HostEvent {
     DeleteLastPrompt = 'DeleteLastPrompt',
     /**
      * Toggle the visualization to chart or table view.
-     * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
+     * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
-     *          vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
      * });
+    *
+    * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
      *```
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
@@ -4180,12 +4232,16 @@ export enum HostEvent {
      */
     VisibleEmbedCoordinates = 'visibleEmbedCoordinates',
     /**
-     * Trigger the *Ask Spotter* action for visualizations
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * Trigger the *Spotter* action for visualizations present on the liveboard's vizzes.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required.
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.AskSpotter,
-     * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+    *
+    * spotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
@@ -4246,6 +4302,7 @@ export enum Param {
     HideResult = 'hideResult',
     UseLastSelectedDataSource = 'useLastSelectedSources',
     Tag = 'tag',
+    HideTagFilterChips = 'hideTagFilterChips',
     AutoLogin = 'autoLogin',
     searchTokenString = 'searchTokenString',
     executeSearch = 'executeSearch',
@@ -4350,6 +4407,7 @@ export enum Param {
     RootMarginForLazyLoad = 'rootMarginForLazyLoad',
     LiveboardXLSXCSVDownload = 'isLiveboardXLSXCSVDownloadEnabled',
     isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
+    isLinkParametersEnabled = 'isLinkParametersEnabled',
 }
 
 /**

package/src/utils/processTrigger.ts

@@ -22,12 +22,13 @@ export const reload = (iFrame: HTMLIFrameElement) => {
  * @param message
  * @param message.type
  * @param message.data
+ * @param message.context
  * @param thoughtSpotHost
  * @param channel
  */
 function postIframeMessage(
     iFrame: HTMLIFrameElement,
-    message: { type: HostEvent; data: any },
+    message: { type: HostEvent; data: any, context?: any },
     thoughtSpotHost: string,
     channel?: MessageChannel,
 ) {
@@ -42,12 +43,14 @@ export const TRIGGER_TIMEOUT = 30000;
  * @param messageType
  * @param thoughtSpotHost
  * @param data
+ * @param context
  */
 export function processTrigger(
     iFrame: HTMLIFrameElement,
     messageType: HostEvent,
     thoughtSpotHost: string,
     data: any,
+    context?: any,
 ): Promise<any> {
     return new Promise<any>((res, rej) => {
         if (messageType === HostEvent.Reload) {
@@ -83,6 +86,6 @@ export function processTrigger(
             res(new Error(ERROR_MESSAGE.TRIGGER_TIMED_OUT));
         }, TRIGGER_TIMEOUT);
 
-        return postIframeMessage(iFrame, { type: messageType, data }, thoughtSpotHost, channel);
+        return postIframeMessage(iFrame, { type: messageType, data, context }, thoughtSpotHost, channel);
     });
 }