SCAL-243755 - New flag to set pendo help

Author: Sreenivas-Kandhade

package.json

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

src/embed/app.spec.ts

@@ -509,6 +509,33 @@ describe('App embed tests', () => {
         });
     });
 
+    test('Should add enablePendoHelp flag to the iframe src conditional on navbar', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?enablePendoHelp=true&embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+
+        const noNavEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            enablePendoHelp: false,
+        } as AppViewConfig);
+
+        noNavEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?enablePendoHelp=false&embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add HomePageSearchBarMode flag with object search to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

src/embed/app.ts

@@ -137,6 +137,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      * ```
      */
     disableProfileAndHelp?: boolean;
+    /**
+     * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
+     * @default true
+     * Whether the help menu in the top nav bar should be served
+     * from Pendo or ThoughtSpot's internal help items.
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *   ... // other options
+     *  enablePendoHelp: false,
+     * });
+     * ```
+     */
+    enablePendoHelp?: boolean
     /**
      * Control the visibility of the application switcher button on the nav-bar.
      * By default, the application switcher is shown.
@@ -526,6 +540,7 @@ export class AppEmbed extends V1Embed {
             hideIrrelevantChipsInLiveboardTabs = false,
             homePageSearchBarMode,
             isUnifiedSearchExperienceEnabled = true,
+            enablePendoHelp = true,
         } = this.viewConfig;
 
         let params = {};
@@ -583,6 +598,10 @@ export class AppEmbed extends V1Embed {
             params[Param.HomePageSearchBarMode] = homePageSearchBarMode;
         }
 
+        if (enablePendoHelp !== undefined) {
+            params[Param.EnablePendoHelp] = enablePendoHelp;
+        }
+
         params[Param.DataPanelV2Enabled] = dataPanelV2;
         params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
         params[Param.ModularHomeExperienceEnabled] = modularHomeExperience;

src/types.ts

@@ -3417,6 +3417,7 @@ export enum Param {
     HostAppUrl = 'hostAppUrl',
     EnableVizTransformations = 'enableVizTransform',
     EnableSearchAssist = 'enableSearchAssist',
+    EnablePendoHelp = 'enablePendoHelp',
     HideResult = 'hideResult',
     UseLastSelectedDataSource = 'useLastSelectedSources',
     Tag = 'tag',