@thoughtspot/visual-embed-sdk 1.41.0 → 1.42.0

package/src/react/util.ts

@@ -24,10 +24,10 @@ export function getViewPropsAndListeners<
     return Object.keys(props).reduce(
         (accu, key) => {
             if (key.startsWith('on')) {
-                const eventName = key.substr(2);
-                accu.listeners[EmbedEvent[eventName]] = props[key];
+                const eventName = key.substr(2) as any;
+                (accu.listeners as any)[EmbedEvent[eventName as keyof typeof EmbedEvent] as any] = props[key as keyof T];
             } else {
-                accu.viewConfig[key] = props[key];
+                (accu.viewConfig as any)[key] = props[key as keyof T];
             }
             return accu;
         },

package/src/types.ts

@@ -231,12 +231,12 @@ export type DOMSelector = string | HTMLElement;
  * Use {@link CustomCssVariables} or css rules.
  */
 export interface customCssInterface {
-  /**
-   * The custom css variables, which can be set.
-   * The variables are available in the {@link CustomCssVariables}
-   * interface. For more information, see
-   * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
-   */
+    /**
+     * The custom css variables, which can be set.
+     * The variables are available in the {@link CustomCssVariables}
+     * interface. For more information, see
+     * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
+     */
     variables?: CustomCssVariables;
     /**
      * Can be used to define a custom font face
@@ -648,7 +648,7 @@ export interface EmbedConfig {
      * ```
      *  @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-    customVariablesForThirdPartyTools?: Record< string, any >;
+    customVariablesForThirdPartyTools?: Record<string, any>;
 
     disablePreauthCache?: boolean;
 
@@ -695,7 +695,7 @@ export interface EmbedConfig {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface LayoutConfig {}
+export interface LayoutConfig { }
 
 /**
  * Embedded iframe configuration
@@ -1281,8 +1281,8 @@ export interface SearchLiveboardCommonViewConfig {
      * Flag to control Data panel experience
      *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
-     * @default false
-     * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+     * @default true
+     * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -1481,21 +1481,21 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     enableAskSage?: boolean;
-     /**
-     * This flag is used to show or hide checkboxes for including or excluding
-     * the cover and filters pages in the Liveboard PDF.
-     *
-     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-     * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
-     * @example
-     * ```js
-     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
-     * const embed = new <EmbedComponent>('#tsEmbed', {
-     *    ... // other embed view config
-     *    coverAndFilterOptionInPDF: false,
-     * })
-     * ```
-     */
+    /**
+    * This flag is used to show or hide checkboxes for including or excluding
+    * the cover and filters pages in the Liveboard PDF.
+    *
+    * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+    * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
+    * @example
+    * ```js
+    * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+    * const embed = new <EmbedComponent>('#tsEmbed', {
+    *    ... // other embed view config
+    *    coverAndFilterOptionInPDF: false,
+    * })
+    * ```
+    */
     coverAndFilterOptionInPDF?: boolean;
     /**
      * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
@@ -1515,7 +1515,7 @@ export interface LiveboardAppEmbedViewConfig {
 
 }
 
-export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {}
+export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig { }
 
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2774,25 +2774,25 @@ export enum EmbedEvent {
      * ```
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-     TableVizRendered = 'TableVizRendered',
-     /**
-     * Emitted when the liveboard is created from pin modal or Liveboard list page.
-     * You can use this event as a hook to trigger
-     * other events on liveboard creation.
-     *
-     * ```js
-     * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
-     *     console.log('payload', payload);
-     * })
-     *```
-     * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
-     */
+    TableVizRendered = 'TableVizRendered',
+    /**
+    * Emitted when the liveboard is created from pin modal or Liveboard list page.
+    * You can use this event as a hook to trigger
+    * other events on liveboard creation.
+    *
+    * ```js
+    * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
+    *     console.log('payload', payload);
+    * })
+    *```
+    * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
+    */
     CreateLiveboard = 'createLiveboard',
     /**
      * Emitted when a user creates a Model.
      * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-     CreateModel = 'createModel',
+    CreateModel = 'createModel',
     /**
      * @hidden
      * Emitted when a user exits present mode.
@@ -3670,24 +3670,45 @@ export enum HostEvent {
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     Share = 'share',
-    /**
-     * Trigger the **Save**  action on a Liveboard or Answer.
-     * Saves the changes.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
-     * @example
-     * ```js
-     * liveboardEmbed.trigger(HostEvent.Save)
-     * ```
-     * ```js
-     * searchEmbed.trigger(HostEvent.Save)
-     * ```
-     * ```js
-     * spotterEmbed.trigger(HostEvent.Save, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
-     * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
-     */
+  /**
+   * Trigger the **Save** action on a Liveboard, Answer, or Spotter.
+   * Saves the changes.
+   *
+   * @param - `vizId` refers to the Spotter Visualization Id used in Spotter embed.
+   * It is required and can be retrieved from the data embed event.
+   *
+   * @example
+   * ```js
+   * // Save changes in a Liveboard
+   * liveboardEmbed.trigger(HostEvent.Save)
+   * ```
+   *
+   * ```js
+   * // Save the current Answer in Search embed
+   * searchEmbed.trigger(HostEvent.Save)
+   * ```
+   *
+   * ```js
+   * // Save an Answer in Spotter (requires vizId)
+   * spotterEmbed.trigger(HostEvent.Save, {
+   *   vizId: "730496d6-6903-4601-937e-2c691821af3c"
+   * })
+   * ```
+   *
+   * ```js
+   * // How to get the vizId in Spotter?
+   *
+   * // You can use the Data event dispatched on each answer creation to get the vizId.
+   * let latestSpotterVizId = '';
+   * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+   *   latestSpotterVizId = payload.data.id;
+   * });
+   *
+   * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
+   * ```
+   *
+   * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
+   */
     Save = 'save',
     /**
      * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
@@ -3823,7 +3844,7 @@ export enum HostEvent {
      *      column: "Date",
      *      oper: 'EQ',
      *      values: ["2023-07-31"],
-     *      types: "EXACT_DATE"
+     *      type: "EXACT_DATE"
      *    }]
      * });
      * ```
@@ -4015,7 +4036,7 @@ export enum HostEvent {
      *```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
-     InfoSuccess = 'InfoSuccess',
+    InfoSuccess = 'InfoSuccess',
     /**
      * Trigger the save action for an Answer.
      * To programmatically save an answer without opening the
@@ -4169,6 +4190,17 @@ export enum HostEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     AskSpotter = 'AskSpotter',
+
+    /**
+     * @hidden
+     * Triggers the update of the embed params.
+     * 
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
+     * ```
+     */
+    UpdateEmbedParams = 'updateEmbedParams',
 }
 
 /**
@@ -4317,6 +4349,7 @@ export enum Param {
     IsLazyLoadingForEmbedEnabled = 'isLazyLoadingForEmbedEnabled',
     RootMarginForLazyLoad = 'rootMarginForLazyLoad',
     LiveboardXLSXCSVDownload = 'isLiveboardXLSXCSVDownloadEnabled',
+    isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
 }
 
 /**
@@ -5616,6 +5649,29 @@ export enum Action {
      *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
      */
     SpotterTokenQuickEdit = 'SpotterTokenQuickEdit',
+    /**
+     * The **PNG screenshot in email** option in the schedule email dialog.
+     * Includes a PNG screenshot in the notification email body.
+     * @example
+     * ```js
+     * disabledActions: [Action.PngScreenshotInEmail]
+     * ```
+     * ```
+     *  @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
+     */
+    PngScreenshotInEmail = 'pngScreenshotInEmail',
+    /**
+     * The **Remove attachment** action in the schedule email dialog.
+     * Removes an attachment from the email configuration.
+     * @example
+     * ```js
+     * disabledActions: [Action.RemoveAttachment]
+     * ```
+     * ```
+     * ```
+     *  @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
+     */
+    RemoveAttachment = 'removeAttachment',
 }
 
 export interface AnswerServiceType {
@@ -5647,15 +5703,15 @@ export interface ColumnValue {
         [key: string]: any;
     };
     value:
-        | string
-        | number
-        | boolean
-        | {
-              v: {
-                  s: number;
-                  e: number;
-              };
-          };
+    | string
+    | number
+    | boolean
+    | {
+        v: {
+            s: number;
+            e: number;
+        };
+    };
 }
 
 export interface VizPoint {

package/src/utils.spec.ts

@@ -18,6 +18,7 @@ import {
     getTypeFromValue,
     arrayIncludesString,
     calculateVisibleElementData,
+    formatTemplate,
 } from './utils';
 import { RuntimeFilterOp } from './types';
 import { logger } from './utils/logger';
@@ -718,3 +719,20 @@ describe('calculateVisibleElementData', () => {
         });
     });
 });
+
+describe('formatTemplate', () => {
+    it('should replace placeholders with provided values', () => {
+        expect(
+            formatTemplate('Hello {name}, you are {age} years old', { name: 'John', age: 30 }),
+        ).toBe('Hello John, you are 30 years old');
+        expect(
+            formatTemplate('Expected {type}, but received {actual}', {
+                type: 'string',
+                actual: 'number',
+            }),
+        ).toBe('Expected string, but received number');
+        expect(
+            formatTemplate('Hello {name}, you are {age} years old', { name: 'John' }),
+        ).toBe('Hello John, you are {age} years old');
+    });
+});

package/src/utils.ts

@@ -499,3 +499,24 @@ export const calculateVisibleElementData = (element: HTMLElement) => {
 
     return data;
 }
+
+/**
+ * Replaces placeholders in a template string with provided values.
+ * Placeholders should be in the format {key}.
+ * @param template - The template string with placeholders
+ * @param values - An object containing key-value pairs to replace placeholders
+ * @returns The template string with placeholders replaced
+ * @example
+ * formatTemplate('Hello {name}, you are {age} years old', { name: 'John', age: 30 })
+ * // Returns: 'Hello John, you are 30 years old'
+ *
+ * formatTemplate('Expected {type}, but received {actual}', { type: 'string', actual: 'number' })
+ * // Returns: 'Expected string, but received number'
+ */
+export const formatTemplate = (template: string, values: Record<string, any>): string => {
+    // This regex /\{(\w+)\}/g finds all placeholders in the format {word} 
+    // and captures the word inside the braces for replacement.
+    return template.replace(/\{(\w+)\}/g, (match, key) => {
+        return values[key] !== undefined ? String(values[key]) : match;
+    });
+};