@thoughtspot/visual-embed-sdk 1.42.3 → 1.43.0

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

@@ -2695,7 +2695,7 @@ export declare 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
@@ -3114,6 +3114,17 @@ export declare enum EmbedEvent {
 	 *```
 	 */
 	AnswerDelete = "answerDelete",
+	/**
+	 * Emitted when the AI Highlights action is triggered on a Liveboard
+	 * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
+	 * @example
+	 *```js
+	 * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
+	 *   console.log('AI Highlights', payload);
+	 * })
+	 *```
+	 */
+	AIHighlights = "AIHighlights",
 	/**
 	 * Emitted when a user initiates the Pin action to
 	 *  add an Answer to a Liveboard.
@@ -4063,7 +4074,7 @@ export declare 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
@@ -4115,10 +4126,16 @@ export declare 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",
@@ -4193,14 +4210,29 @@ export declare 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
 	 */
 	DownloadAsPdf = "downloadAsPdf",
+	/**
+	 * Trigger the **AI Highlights** action on an embedded Liveboard
+	 *
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.AIHighlights)
+	 * ```
+	 * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
+	 */
+	AIHighlights = "AIHighlights",
 	/**
 	 * Trigger the **Make a copy** action on a Liveboard,
 	 * visualization, or Answer page.
@@ -4223,10 +4255,14 @@ export declare 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",
@@ -4311,15 +4347,7 @@ export declare 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
 	 */
@@ -4368,16 +4396,23 @@ export declare 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
 	 */
@@ -4441,7 +4476,7 @@ export declare 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:
@@ -4451,10 +4486,14 @@ export declare 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
@@ -4472,9 +4511,13 @@ export declare 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
@@ -4483,7 +4526,7 @@ export declare 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:
@@ -4496,9 +4539,13 @@ export declare 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
 	 */
@@ -4506,7 +4553,7 @@ export declare 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:
@@ -4519,9 +4566,13 @@ export declare 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
 	 */
@@ -4558,7 +4609,7 @@ export declare 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"
 	 * })
@@ -4859,15 +4910,21 @@ export declare enum HostEvent {
 	ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
 	/**
 	 * Triggers an action to update Parameter values on embedded
-	 * Answers, Liveboard and Spotter answer in Edit mode.
+	 * Answers, Liveboard, and Spotter answer in Edit mode.
+	 * @param - `name` - Name of the Parameter
+	 * @param - `value` - The value to set for the Parameter.
+	 *
+	 * Optionally, to control the visibility of the Parameter chip,
+	 * use the `isVisibleToUser` attribute when applying an override.
 	 *
 	 * @example
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
-	 * name: "Color",
-	 * value: "almond"
+	 *   name: "Integer Range Param",
+	 *   value: 10,
+	 *   isVisibleToUser: false
 	 * }])
-	 *
+	 * ```
 	 * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
 	 */
 	UpdateParameters = "UpdateParameters",
@@ -4880,11 +4937,13 @@ export declare 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
 	 */
@@ -4914,10 +4973,11 @@ export declare enum HostEvent {
 	 * If no parameters are specified, the save action is
 	 * triggered with a modal to prompt users to
 	 * add a name and description for the Answer.
-	 * @param - optional attributes to set Answer properties.
-	 *  `name` - Name string for the Answer.
-	 *  `description` - Description text for the Answer.
-	 * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+	 * @param - `vizId` refers to the Answer ID in Spotter embed
+	 * and is required in Spotter embed.
+	 * Optional attributes to set Answer properties include:
+	 * @param - `name` - Name string for the Answer.
+	 * @param - `description` - Description text for the Answer.
 	 * @example
 	 * ```js
 	 * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -4927,11 +4987,13 @@ export declare 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
 	 */
@@ -5015,12 +5077,15 @@ export declare 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
 	 */
@@ -5049,12 +5114,16 @@ export declare 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
 	 */

package/lib/package.json

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