@thoughtspot/visual-embed-sdk 1.36.4 → 1.36.6

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

@@ -3329,8 +3329,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             Load = "load",
             /**
-                * Data pertaining to an Answer or Liveboard is received
-                * @return data - The Answer or Liveboard data
+                * Data pertaining to an Answer or Liveboard 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
                 * @example
                 *```js
@@ -4234,17 +4235,39 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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.
+                * Emits when a table visualization is rendered in
+                * the ThoughtSpot embedded app.
+                * You can also use this event as a hook to trigger host events
+                * such as `HostEvent.TransformTableVizData` on the table visualization.
+                * The event payload contains the data used in the rendered table.
+                * You can extract the relevant data from the payload
+                * stored in `payload.data.data.columnDataLite`.
+                * `columnDataLite` is a multidimensional array that contains
+                * data values for each column, which was used in the query to
+                * generate the table visualization. To find and modify specific cell data,
+                * you can either loop through the array or directly access a cell if
+                * you know its position and data index.
+                * In the following code sample, the first cell in the first column
+                * (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
+                * Note that any changes made to the data in the payload will only update the
+                * visual presentation and do not affect the underlying data.
+                * To persist data value modifications after a reload or during chart
+                * interactions such as drill down, ensure that the modified
+                * payload in the `columnDataLite` is passed on to
+                * `HostEvent.TransformTableVizData` and trigger an update to
+                * the table visualization.
+                * If the Row-Level Security (RLS) rules are applied on the
+                * Worksheet or Model, exercise caution when changing column
+                * or table cell values to maintain data security.
+                *
                 * @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);
+                *      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
@@ -4262,7 +4285,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
              *```
              * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
              */
-            CreateLiveboard = "createLiveboard"
+            CreateLiveboard = "createLiveboard",
+            /**
+                * Emitted when a user creates a Model.
+                * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
+                */
+            CreateModel = "createModel"
     }
     /**
         * Event types that can be triggered by the host application
@@ -5281,19 +5309,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             UIPassthrough = "UiPassthrough",
             /**
-                * Triggers the table viz rerender with the updated data.
+                * Triggers the table visualization re-render 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: []}
+                * @param - `columnDataLite` - an array of object containing the
+                * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
+                * payload.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);
+                *      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
@@ -6621,7 +6650,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
                 */
-            EditTokens = "editTokens"
+            EditTokens = "editTokens",
+            /**
+                * Action ID for hiding rename option for Column rename
+                *  @example
+                * ```js
+                * hiddenAction: [Action.ColumnRename]
+                * ```
+                *  @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
+                */
+            ColumnRename = "columnRename"
     }
     export interface AnswerServiceType {
             getAnswer?: (offset: number, batchSize: number) => any;
@@ -6879,7 +6917,7 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
             /**
                 * Background color of the previously asked prompt message in the Spotter page.
                 */
-            '--ts-var-spotter-prompt-background': string;
+            '--ts-var-spotter-prompt-background'?: string;
             /**
                 * Background color of the data panel.
                 */

package/package.json

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

package/src/css-variables.ts

@@ -119,7 +119,7 @@ export interface CustomCssVariables {
     /**
      * Background color of the previously asked prompt message in the Spotter page.
      */
-    '--ts-var-spotter-prompt-background': string;
+    '--ts-var-spotter-prompt-background'?: string;
 
     /**
      * Background color of the data panel.

package/src/types.ts

@@ -1402,8 +1402,9 @@ export enum EmbedEvent {
      */
     Load = 'load',
     /**
-     * Data pertaining to an Answer or Liveboard is received
-     * @return data - The Answer or Liveboard data
+     * Data pertaining to an Answer or Liveboard 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
      * @example
      *```js
@@ -2309,17 +2310,39 @@ export enum EmbedEvent {
      */
     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.
+     * Emits when a table visualization is rendered in
+     * the ThoughtSpot embedded app.
+     * You can also use this event as a hook to trigger host events
+     * such as `HostEvent.TransformTableVizData` on the table visualization.
+     * The event payload contains the data used in the rendered table.
+     * You can extract the relevant data from the payload
+     * stored in `payload.data.data.columnDataLite`.
+     * `columnDataLite` is a multidimensional array that contains
+     * data values for each column, which was used in the query to
+     * generate the table visualization. To find and modify specific cell data,
+     * you can either loop through the array or directly access a cell if
+     * you know its position and data index.
+     * In the following code sample, the first cell in the first column
+     * (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
+     * Note that any changes made to the data in the payload will only update the
+     * visual presentation and do not affect the underlying data.
+     * To persist data value modifications after a reload or during chart
+     * interactions such as drill down, ensure that the modified
+     * payload in the `columnDataLite` is passed on to
+     * `HostEvent.TransformTableVizData` and trigger an update to
+     * the table visualization.
+     * If the Row-Level Security (RLS) rules are applied on the
+     * Worksheet or Model, exercise caution when changing column
+     * or table cell values to maintain data security.
+     *
      * @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);
+     *      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
@@ -2338,6 +2361,11 @@ export enum EmbedEvent {
      * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
      */
     CreateLiveboard = 'createLiveboard',
+    /**
+     * Emitted when a user creates a Model.
+     * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
+     */
+     CreateModel = 'createModel',
 }
 
 /**
@@ -3358,19 +3386,20 @@ export enum HostEvent {
      */
     UIPassthrough = 'UiPassthrough',
     /**
-     * Triggers the table viz rerender with the updated data.
+     * Triggers the table visualization re-render 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: []}
+     * @param - `columnDataLite` - an array of object containing the
+     * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
+     * payload.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);
+     *      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
@@ -4728,6 +4757,15 @@ export enum Action {
      *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     EditTokens = 'editTokens',
+    /**
+     * Action ID for hiding rename option for Column rename
+     *  @example
+     * ```js
+     * hiddenAction: [Action.ColumnRename]
+     * ```
+     *  @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
+     */
+    ColumnRename = 'columnRename',
 }
 
 export interface AnswerServiceType {