@thoughtspot/visual-embed-sdk 1.24.0-sage.3 → 1.24.0

package/src/types.ts

@@ -178,6 +178,17 @@ export enum AuthType {
     Basic = 'Basic',
 }
 
+export enum HomeLeftNavItem {
+    QueryBuilder = 'query-builder',
+    Home = 'insights-home',
+    Liveboards = 'liveboards',
+    Answers = 'answers',
+    MonitorSubscription = 'monitor-alerts',
+    SpotIQAnalysis = 'spotiq-analysis',
+    Tutorials = 'tutorials',
+    Documentation = 'documentation',
+    Community = 'community',
+}
 export type DOMSelector = string | HTMLElement;
 
 /**
@@ -451,6 +462,7 @@ export interface EmbedConfig {
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
      */
     suppressSearchEmbedBetaWarning?: boolean;
+
     /**
      * Hide beta alert warning message for SageEmbed.
      *
@@ -502,16 +514,26 @@ export interface EmbedConfig {
 
     /**
      * Host config incase embedded app is inside TS app itself
+     *
+     * @hidden
      */
     hostConfig?: {
         hostUserGuid: string;
         hostClusterId: string;
         hostClusterName: string;
-    }
+    };
+
+    /**
+     * Pendo API key to enable Pendo tracking to your own subscription, the key
+     * is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
+     *
+     * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
+     */
+    pendoTrackingKey?: string;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface LayoutConfig { }
+export interface LayoutConfig {}
 
 /**
  * Embedded iFrame configuration
@@ -619,6 +641,11 @@ export interface ViewConfig {
      * visualization, or Liveboard.
      */
     runtimeFilters?: RuntimeFilter[];
+    /**
+     * The list of parameter override to apply to a search answer,
+     * visualization, or Liveboard.
+     */
+    runtimeParameters?: RuntimeParameter[];
     /**
      * The locale/language to use for the embedded view.
      *
@@ -723,6 +750,13 @@ export interface ViewConfig {
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     hiddenTabs?: string[];
+    /**
+     * Hide the home page modules
+     * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+     *
+     * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+     */
+    hiddenHomepageModules?: HomepageModule[];
     /**
      * The list of tab IDs to show in the embedded.
      * Only this Tabs will be shown in their respective LBs.
@@ -742,6 +776,15 @@ export interface ViewConfig {
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     visibleTabs?: string[];
+    /**
+     * homepageLeftNavItems : show/hide Homeapage Left Nav Bar Items
+     * There are 8 home nav list items, we will send those item as list
+     * which we want to hide for TSE.
+     * eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
+     *
+     * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+     */
+    hiddenHomeLeftNavItems?: HomeLeftNavItem[];
 }
 
 /**
@@ -866,6 +909,37 @@ export enum RuntimeFilterOp {
     IN = 'IN',
 }
 
+/**
+ * Home page module that can be hide
+ */
+// eslint-disable-next-line no-shadow
+export enum HomepageModule {
+    /**
+     * Search bar
+     */
+    Search = 'search',
+    /**
+     * kPI watchlist module
+     */
+    Watchlist = 'watchlist',
+    /**
+     * favorite objects
+     */
+    Favorite = 'favorite',
+    /**
+     * List of answers and liveboards
+     */
+    MyLibrary = 'mylibrary',
+    /**
+     * Trending list
+     */
+    Trending = 'trending',
+    /**
+     * Learning videos
+     */
+    Learning = 'learning',
+}
+
 /**
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
  * visualizations at runtime.
@@ -886,6 +960,20 @@ export interface RuntimeFilter {
      */
     values: (number | boolean | string)[];
 }
+/**
+ * A filter that can be applied to ThoughtSpot answers, Liveboards, or
+ * visualizations at runtime.
+ */
+export interface RuntimeParameter {
+    /**
+     * The name of the runtime parameter to filter on (case-sensitive)
+     */
+    name: string;
+    /**
+     * Values
+     */
+    value: number | boolean | string;
+}
 
 /**
  * Event types emitted by the embedded ThoughtSpot application.
@@ -1312,23 +1400,74 @@ export enum EmbedEvent {
      */
     InsertIntoSlide = 'insertInToSlide',
     /**
+     * @hidden
      * Emitted when a user changes any filter on a Liveboard.
-     *
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     FilterChanged = 'filterChanged',
     /**
      *  Emitted when a user click on Go button in Sage Embed
      *
-     * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     SageEmbedQuery = 'sageEmbedQuery',
     /**
      * Emitten when a user select data source in Sage Embed
      *
-     * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     SageWorksheetUpdated = 'sageWorksheetUpdated',
+    /**
+     * Emitten when a user updates a connection in Data tab
+     *
+     * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+     */
+    UpdateConnection = 'updateConnection',
+    /**
+     * Emitted when name, status (private or public) or filter values of a
+     * PersonalisedView is updated.
+     *
+     * @returns viewName: string
+     * @returns viewId: string
+     * @returns liveboardId: string
+     * @returns isPublic: boolean
+     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+     */
+    UpdatePersonalisedView = 'updatePersonalisedView',
+    /**
+     * Emitted when a PersonalisedView is saved.
+     *
+     * @returns viewName: string
+     * @returns viewId: string
+     * @returns liveboardId: string
+     * @returns isPublic: boolean
+     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+     */
+    SavePersonalisedView = 'savePersonalisedView',
+    /**
+     * Emitted when a Liveboard is reset.
+     *
+     * @returns viewName: string
+     * @returns viewId: string
+     * @returns liveboardId: string
+     * @returns isPublic: boolean
+     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+     */
+    ResetLiveboard = 'resetLiveboard',
+    /**
+     * Emitted when a PersonalisedView is deleted.
+     *
+     * @returns views: string[]
+     * @returns liveboardId: string
+     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+     */
+    DeletePersonalisedView = 'deletePersonalisedView',
+    /**
+     * Emitten when a user creates a new worksheet
+     *
+     * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+     */
+    CreateWorksheet = 'createWorksheet',
 }
 
 /**
@@ -1973,16 +2112,16 @@ export enum HostEvent {
      */
     ResetSearch = 'resetSearch',
     /**
+     * @hidden
      * Gets the currents visible and runtime filters applied on a Liveboard
-     *
      * @example
      * liveboardEmbed.trigger(HostEvent.GetFilters)
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     GetFilters = 'getFilters',
     /**
+     * @hidden
      * Updates the visible filters on the Liveboard.
-     *
      * @param - filter: filter object containing column name and filter operation and values
      * @example
      *
@@ -2108,7 +2247,7 @@ export enum Param {
     DisableLoginRedirect = 'disableLoginRedirect',
     visibleVizs = 'pinboardVisibleVizs',
     LiveboardV2Enabled = 'isPinboardV2Enabled',
-    DataPanelV2Enabled ='enableDataPanelV2',
+    DataPanelV2Enabled = 'enableDataPanelV2',
     ShowAlerts = 'showAlerts',
     Locale = 'locale',
     CustomStyle = 'customStyle',
@@ -2138,7 +2277,10 @@ export enum Param {
     HideTabPanel = 'hideTabPanel',
     HideSampleQuestions = 'hideSampleQuestions',
     WorksheetId = 'worksheet',
-    Query = 'query'
+    Query = 'query',
+    HideHomepageLeftNav = 'hideHomepageLeftNav',
+    ModularHomeExperienceEnabled = 'modularHomeExperience',
+    PendoTrackingKey = 'additionalPendoKey',
 }
 
 /**
@@ -2170,15 +2312,15 @@ export enum Param {
  */
 // eslint-disable-next-line no-shadow
 export enum Action {
-   /**
-    * The **Save** action on an Answer or Liveboard.
-    * Allows users to save the changes.
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.SaveAsView]
-    * ```
-    */
+    /**
+     * The **Save** action on an Answer or Liveboard.
+     * Allows users to save the changes.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.SaveAsView]
+     * ```
+     */
     Save = 'save',
     /**
      * @hidden
@@ -2432,25 +2574,25 @@ export enum Action {
      * ```
      */
     ImportTML = 'importTSL',
-   /**
-    * The **Update TML** menu action for Liveboards and Answers.
-    * Update TML representation of ThoughtSpot objects.
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.UpdateTML]
-    * ```
-    */
+    /**
+     * The **Update TML** menu action for Liveboards and Answers.
+     * Update TML representation of ThoughtSpot objects.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.UpdateTML]
+     * ```
+     */
     UpdateTML = 'updateTSL',
-   /**
-    * The **Edit TML** menu action for Liveboards and Answers.
-    * Opens the TML editor.
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.EditTML]
-    * ```
-    */
+    /**
+     * The **Edit TML** menu action for Liveboards and Answers.
+     * Opens the TML editor.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.EditTML]
+     * ```
+     */
     EditTML = 'editTSL',
     /**
      * The **Present** menu action for Liveboards and Answers.
@@ -2557,14 +2699,14 @@ export enum Action {
      * @hidden
      */
     AnalysisInfo = 'analysisInfo',
-   /**
-    * The **Schedule** menu action on a Liveboard.
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.Subscription]
-    * ```
-    */
+    /**
+     * The **Schedule** menu action on a Liveboard.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.Subscription]
+     * ```
+     */
     Subscription = 'subscription',
     /**
      * The **Explore** action on Liveboard visualizations
@@ -2586,26 +2728,26 @@ export enum Action {
      */
 
     DrillInclude = 'context-menu-item-include',
-   /**
-    * The action to exclude data points on a drilled-down Answer
-    * or visualization
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.DrillInclude]
-    * ```
-    */
+    /**
+     * The action to exclude data points on a drilled-down Answer
+     * or visualization
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.DrillInclude]
+     * ```
+     */
     DrillExclude = 'context-menu-item-exclude',
-   /**
-    * The **Copy to clipboard** menu action on tables in an Answer
-    * or Liveboard.
-    * Copies the selected data point.
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.CopyToClipboard]
-    * ```
-    */
+    /**
+     * The **Copy to clipboard** menu action on tables in an Answer
+     * or Liveboard.
+     * Copies the selected data point.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.CopyToClipboard]
+     * ```
+     */
     CopyToClipboard = 'context-menu-item-copy-to-clipboard',
     CopyAndEdit = 'context-menu-item-copy-and-edit',
     /**
@@ -2614,37 +2756,37 @@ export enum Action {
     DrillEdit = 'context-menu-item-edit',
     EditMeasure = 'context-menu-item-edit-measure',
     Separator = 'context-menu-item-separator',
-   /**
-    * The **Drill down** menu action on Answers and Liveboard
-    * visualizations.
-    * Allows drilling down to a specific data point on a chart or table.
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.DrillDown]
-    * ```
-    */
+    /**
+     * The **Drill down** menu action on Answers and Liveboard
+     * visualizations.
+     * Allows drilling down to a specific data point on a chart or table.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.DrillDown]
+     * ```
+     */
     DrillDown = 'DRILL',
-   /**
-    * The request access action on Liveboards.
-    * Allows users with view permissions to request edit access to a Liveboard.
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.RequestAccess]
-    * ```
-    */
+    /**
+     * The request access action on Liveboards.
+     * Allows users with view permissions to request edit access to a Liveboard.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.RequestAccess]
+     * ```
+     */
     RequestAccess = 'requestAccess',
-   /**
-    * The **Query visualizer** and **Query SQL** buttons in Query details panel
-    * of the Answer page
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.QueryDetailsButtons]
-    * ```
-    */
-    QueryDetailsButtons = 'QueryDetailsButtons',
+    /**
+     * The **Query visualizer** and **Query SQL** buttons in Query details panel
+     * of the Answer page
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.QueryDetailsButtons]
+     * ```
+     */
+    QueryDetailsButtons = 'queryDetailsButtons',
     /**
      * The **Delete** action for Answers.
      *
@@ -2949,6 +3091,35 @@ export enum Action {
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     ModifySageAnswer = 'modifySageAnswer',
+    /**
+     * The **Move to Tab** menu action on visualizations in liveboard edit mode.
+     * Allows moving a visualization to a different tab.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.MoveToTab]
+     * ```
+     */
+    MoveToTab = 'onContainerMove',
+    /**
+     * The **Manage Alertsb** menu action on KPI visualizations.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.ManageMonitor]
+     * ```
+     */
+    ManageMonitor = 'ManageMonitor',
+    /**
+     * Action ID for Liveboard Personalised Views dropdown
+     *
+     *  @example
+     * ```js
+     * disabledActions: [Action.PersonalisedViewsDropdown]
+     * ```
+     *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+     */
+    PersonalisedViewsDropdown = 'personalisedViewsDropdown',
 }
 
 export interface SessionInterface {

package/src/utils.spec.ts

@@ -10,6 +10,7 @@ import {
     appendToUrlHash,
     getRedirectUrl,
     checkReleaseVersionInBeta,
+    getRuntimeParameters,
 } from './utils';
 import { RuntimeFilterOp } from './types';
 
@@ -65,6 +66,36 @@ describe('unit test for utils', () => {
             'col1=foo&op1=EQ&val1=42&col2=bar&op2=BW_INC&val2=1&val2=10&col3=baz&op3=CONTAINS&val3=abc',
         );
     });
+    test('getParameterOverride', () => {
+        expect(getRuntimeParameters([])).toBe(null);
+
+        expect(
+            getRuntimeParameters([
+                {
+                    name: 'foo',
+                    value: 'bar',
+                },
+            ]),
+        ).toBe('param1=foo&paramVal1=bar');
+
+        const params = [
+            {
+                name: 'foo',
+                value: 42,
+            },
+            {
+                name: 'bar',
+                value: 'abc',
+            },
+            {
+                name: 'baz',
+                value: true,
+            },
+        ];
+        expect(getRuntimeParameters(params)).toBe(
+            'param1=foo&paramVal1=42&param2=bar&paramVal2=abc&param3=baz&paramVal3=true',
+        );
+    });
 
     test('getCssDimension', () => {
         expect(getCssDimension(100)).toBe('100px');

package/src/utils.ts

@@ -15,6 +15,7 @@ import {
     CustomisationsInterface,
     DOMSelector,
     ViewConfig,
+    RuntimeParameter,
 } from './types';
 
 /**
@@ -43,6 +44,28 @@ export const getFilterQuery = (runtimeFilters: RuntimeFilter[]): string => {
     return null;
 };
 
+/**
+ * Construct a runtime parameter override query string from the given option.
+ *
+ * @param runtimeParameters
+ */
+export const getRuntimeParameters = (runtimeParameters: RuntimeParameter[]): string => {
+    if (runtimeParameters && runtimeParameters.length) {
+        const params = runtimeParameters.map((param, valueIndex) => {
+            const index = valueIndex + 1;
+            const filterExpr = [];
+            filterExpr.push(`param${index}=${encodeURIComponent(param.name)}`);
+            filterExpr.push(`paramVal${index}=${encodeURIComponent(param.value)}`);
+
+            return filterExpr.join('&');
+        });
+
+        return `${params.join('&')}`;
+    }
+
+    return null;
+};
+
 /**
  * Convert a value to a string representation to be sent as a query
  * parameter to the ThoughtSpot app.