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

package/src/types.ts

@@ -8,6 +8,7 @@
  */
 
 import { CustomCssVariables } from './css-variables';
+import type { SessionInterface } from './utils/graphql/answerService/answerService';
 
 /**
  * The authentication mechanism for allowing access to the
@@ -178,6 +179,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 +463,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,12 +515,22 @@ 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
@@ -619,6 +642,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 +751,19 @@ 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[];
+    /**
+     * reordering the home page modules
+     * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
+     * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
+     */
+    reorderedHomepageModules?: HomepageModule[];
     /**
      * The list of tab IDs to show in the embedded.
      * Only this Tabs will be shown in their respective LBs.
@@ -742,6 +783,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 +916,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 = 'MY_LIBRARY',
+    /**
+     * Trending list
+     */
+    Trending = 'TRENDING',
+    /**
+     * Learning videos
+     */
+    Learning = 'LEARNING',
+}
+
 /**
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
  * visualizations at runtime.
@@ -886,6 +967,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 +1407,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 +2119,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 +2254,7 @@ export enum Param {
     DisableLoginRedirect = 'disableLoginRedirect',
     visibleVizs = 'pinboardVisibleVizs',
     LiveboardV2Enabled = 'isPinboardV2Enabled',
-    DataPanelV2Enabled ='enableDataPanelV2',
+    DataPanelV2Enabled = 'enableDataPanelV2',
     ShowAlerts = 'showAlerts',
     Locale = 'locale',
     CustomStyle = 'customStyle',
@@ -2138,7 +2284,10 @@ export enum Param {
     HideTabPanel = 'hideTabPanel',
     HideSampleQuestions = 'hideSampleQuestions',
     WorksheetId = 'worksheet',
-    Query = 'query'
+    Query = 'query',
+    HideHomepageLeftNav = 'hideHomepageLeftNav',
+    ModularHomeExperienceEnabled = 'modularHomeExperience',
+    PendoTrackingKey = 'additionalPendoKey',
 }
 
 /**
@@ -2170,15 +2319,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 +2581,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 +2706,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 +2735,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 +2763,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,18 +3098,35 @@ export enum Action {
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     ModifySageAnswer = 'modifySageAnswer',
-}
-
-export interface SessionInterface {
-    sessionId: string;
-    genNo: number;
-    acSession: { sessionId: string; genNo: number };
-}
-
-// eslint-disable-next-line no-shadow
-export enum OperationType {
-    GetChartWithData = 'GetChartWithData',
-    GetTableWithHeadlineData = 'GetTableWithHeadlineData',
+    /**
+     * 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 AnswerServiceType {
@@ -2981,3 +3147,39 @@ export enum ContextMenuTriggerOptions {
     LEFT_CLICK = 'left-click',
     RIGHT_CLICK = 'right-click',
 }
+
+export interface ColumnValue {
+    column: {
+        id: string,
+        name: string,
+        dataType: string,
+        [key: string]: any
+    },
+    value: string | number | boolean;
+}
+
+export interface VizPoint {
+    selectedAttributes: ColumnValue[],
+    selectedMeasures: ColumnValue[]
+}
+
+export interface CustomActionPayload {
+    contextMenuPoints?: {
+        clickedPoint: VizPoint
+        selectedPoints: VizPoint[]
+    };
+    embedAnswerData: {
+        name: string,
+        id: string,
+        sources: {
+            header: {
+                guid: string
+            }
+        },
+        columns: any[],
+        data: any[],
+        [key: string]: any
+    };
+    session: SessionInterface;
+    vizId?: string;
+}

package/src/utils/graphql/answerService/answer-queries.ts

@@ -0,0 +1,80 @@
+const bachSessionId = `
+id {
+    sessionId
+    genNo
+    acSession {
+        sessionId
+        genNo
+    }
+}
+`;
+
+export const getUnaggregatedAnswerSession = `
+mutation GetUnAggregatedAnswerSession($session: BachSessionIdInput!, $columns: [UserPointSelectionInput!]!) {
+    Answer__getUnaggregatedAnswer(session: $session, columns: $columns) {
+        ${bachSessionId}
+        answer {
+            visualizations {
+                ... on TableViz {
+                    columns {
+                        column {
+                            id
+                            name
+                            referencedColumns {
+                                guid
+                                displayName
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}  
+`;
+
+export const removeColumns = `
+mutation RemoveColumns($session: BachSessionIdInput!, $logicalColumnIds: [GUID!], $columnIds: [GUID!]) {
+    Answer__removeColumns(
+        session: $session
+        logicalColumnIds: $logicalColumnIds
+        columnIds: $columnIds
+        ) {
+            ${bachSessionId}
+    }
+}
+    `;
+
+export const addColumns = `
+    mutation AddColumns($session: BachSessionIdInput!, $columns: [AnswerColumnInfo!]!) {
+        Answer__addColumn(session: $session, columns: $columns) {
+            ${bachSessionId}
+        }
+    }
+    `;
+
+export const getAnswerData = `
+    query GetTableWithHeadlineData($session: BachSessionIdInput!, $deadline: Int!, $dataPaginationParams: DataPaginationParamsInput!) {
+        getAnswer(session: $session) {
+            ${bachSessionId}
+            answer {
+                id
+                visualizations {
+                    id
+                    ... on TableViz {
+                        columns {
+                            column {
+                                id
+                                name
+                                type
+                                aggregationType
+                                dataType
+                            }
+                        }
+                        data(deadline: $deadline, pagination: $dataPaginationParams)
+                    }          
+                }
+            }
+        }
+    }
+`;