[SCAL-299968] SDK changes for Send Now

Author: midhun-kr

src/embed/app.spec.ts

@@ -653,6 +653,34 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set isSendNowLiveboardSchedulingEnabled to true in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            isSendNowLiveboardSchedulingEnabled: true,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isSendNowLiveboardSchedulingEnabled=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('should set isSendNowLiveboardSchedulingEnabled to false in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            isSendNowLiveboardSchedulingEnabled: false,
+        } as AppViewConfig);
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isSendNowLiveboardSchedulingEnabled=false${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should set isCentralizedLiveboardFilterUXEnabled to true in url', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

src/embed/app.ts

@@ -640,6 +640,25 @@ export interface AppViewConfig extends AllEmbedViewConfig {
      */
     isGranularXLSXCSVSchedulesEnabled?: boolean;
 
+    /**
+     * This flag is used to enable/disable the Send Now feature for
+     * Liveboard scheduling, which allows sending a test schedule email.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @type {boolean}
+     * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.6.0.cl
+     * @default false
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isSendNowLiveboardSchedulingEnabled: true,
+     * })
+     * ```
+     */
+    isSendNowLiveboardSchedulingEnabled?: boolean;
+
     /**
      * This flag is used to enable the full height lazy load data.
      *
@@ -850,6 +869,7 @@ export class AppEmbed extends V1Embed {
             isPNGInScheduledEmailsEnabled = false,
             isLiveboardXLSXCSVDownloadEnabled = false,
             isGranularXLSXCSVSchedulesEnabled = false,
+            isSendNowLiveboardSchedulingEnabled,
             isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
             updatedSpotterChatPrompt,
@@ -1015,6 +1035,10 @@ export class AppEmbed extends V1Embed {
             params[Param.isGranularXLSXCSVSchedulesEnabled] = isGranularXLSXCSVSchedulesEnabled;
         }
 
+        if (isSendNowLiveboardSchedulingEnabled !== undefined) {
+            params[Param.isSendNowLiveboardSchedulingEnabled] = isSendNowLiveboardSchedulingEnabled;
+        }
+
         if (hideTagFilterChips !== undefined) {
             params[Param.HideTagFilterChips] = hideTagFilterChips;
         }

src/embed/liveboard.spec.ts

@@ -335,6 +335,36 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set isSendNowLiveboardSchedulingEnabled to true in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isSendNowLiveboardSchedulingEnabled: true,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isSendNowLiveboardSchedulingEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
+    test('should set isSendNowLiveboardSchedulingEnabled to false in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isSendNowLiveboardSchedulingEnabled: false,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isSendNowLiveboardSchedulingEnabled=false${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should set isLinkParametersEnabled to true in url', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             isLinkParametersEnabled: true,

src/embed/liveboard.ts

@@ -437,6 +437,23 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
      * ```
      */
     isGranularXLSXCSVSchedulesEnabled?: boolean;
+    /**
+     * This flag is used to enable/disable the Send Now feature for
+     * Liveboard scheduling, which allows sending a test schedule email.
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @type {boolean}
+     * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     * @default false
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    isSendNowLiveboardSchedulingEnabled: true,
+     * })
+     * ```
+     */
+    isSendNowLiveboardSchedulingEnabled?: boolean;
     /**
      * This flag is used to enable the full height lazy load data.
      *
@@ -610,6 +627,7 @@ export class LiveboardEmbed extends V1Embed {
             isPNGInScheduledEmailsEnabled = false,
             isLiveboardXLSXCSVDownloadEnabled = false,
             isGranularXLSXCSVSchedulesEnabled = false,
+            isSendNowLiveboardSchedulingEnabled,
             showSpotterLimitations,
             isCentralizedLiveboardFilterUXEnabled = false,
             isLinkParametersEnabled,
@@ -698,6 +716,10 @@ export class LiveboardEmbed extends V1Embed {
             params[Param.isGranularXLSXCSVSchedulesEnabled] = isGranularXLSXCSVSchedulesEnabled;
         }
 
+        if (isSendNowLiveboardSchedulingEnabled !== undefined) {
+            params[Param.isSendNowLiveboardSchedulingEnabled] = isSendNowLiveboardSchedulingEnabled;
+        }
+
         if (showSpotterLimitations !== undefined) {
             params[Param.ShowSpotterLimitations] = showSpotterLimitations;
         }

src/types.ts

@@ -3654,6 +3654,20 @@ export enum EmbedEvent {
      * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
      */
     RefreshAuthToken = 'RefreshAuthToken',
+    /**
+     * Emitted when a user clicks the **Send Test Email** button in the
+     * Liveboard schedule modal. Requires `isSendNowLiveboardSchedulingEnabled`
+     * to be enabled.
+     * @example
+     * ```js
+     * liveboardEmbed.on(EmbedEvent.SendTestScheduleEmail, (payload) => {
+     *     console.log('Send test email', payload);
+     *     // payload: { liveboardId: string, sendToSelf: boolean }
+     * })
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     */
+    SendTestScheduleEmail = 'sendTestScheduleEmail',
 }
 
 /**
@@ -5369,7 +5383,8 @@ export enum HostEvent {
      * ```js
      * // Get parameters from liveboard context
      * import { ContextType } from '@thoughtspot/visual-embed-sdk';
-     * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
+     * liveboardEmbed.trigger(HostEvent.GetParameters, {},
+     * ContextType.Liveboard).then((parameters) => {
      *     console.log('parameters', parameters);
      * });
      * ```
@@ -5715,14 +5730,34 @@ export enum HostEvent {
     /**
      * @hidden
      * Get the current context of the embedded page.
-     * 
+     *
      * @example
      * ```js
      * const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
      * ```
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     GetPageContext = 'GetPageContext',
+    /**
+     * Trigger the **Send Test Email** action in the Liveboard schedule modal.
+     * Sends a test schedule email to self or all recipients.
+     * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
+     *     sendToSelf: true,
+     * })
+     * ```
+     * @example
+     * ```js
+     * // Send to all recipients
+     * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
+     *     sendToSelf: false,
+     * })
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     */
+    SendTestScheduleEmail = 'sendTestScheduleEmail',
 }
 
 /**
@@ -5880,6 +5915,7 @@ export enum Param {
     IsWYSIWYGLiveboardPDFEnabled = 'isWYSIWYGLiveboardPDFEnabled',
     isLiveboardXLSXCSVDownloadEnabled = 'isLiveboardXLSXCSVDownloadEnabled',
     isGranularXLSXCSVSchedulesEnabled = 'isGranularXLSXCSVSchedulesEnabled',
+    isSendNowLiveboardSchedulingEnabled = 'isSendNowLiveboardSchedulingEnabled',
     isCentralizedLiveboardFilterUXEnabled = 'isCentralizedLiveboardFilterUXEnabled',
     isLinkParametersEnabled = 'isLinkParametersEnabled',
     EnablePastConversationsSidebar = 'enablePastConversationsSidebar',
@@ -7514,6 +7550,18 @@ export enum Action {
      * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
      */
     IncludeCurrentPeriod = 'includeCurrentPeriod',
+    /**
+     * The **Send Test Email** button in the Liveboard schedule modal.
+     * Allows sending a test schedule email to self or all recipients.
+     * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
+     * @example
+     * ```js
+     * disabledActions: [Action.SendTestScheduleEmail]
+     * hiddenActions: [Action.SendTestScheduleEmail]
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     */
+    SendTestScheduleEmail = 'sendTestScheduleEmail',
 }
 export interface AnswerServiceType {
     getAnswer?: (offset: number, batchSize: number) => any;