@thoughtspot/visual-embed-sdk 1.21.0-react.2 → 1.21.0-sage.0

package/src/embed/sage.ts

@@ -0,0 +1,153 @@
+/**
+ * Copyright (c) 2022
+ *
+ * Embed ThoughtSpot Sage
+ *
+ * @summary TS Sage embed
+ * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
+ */
+
+import {
+    Action, DOMSelector, EmbedEvent, MessagePayload, Param, ViewConfig,
+} from '../types';
+import { getQueryParamString } from '../utils';
+import { V1Embed } from './ts-embed';
+
+/**
+ * The configuration attributes for the embedded search view.
+ *
+ * @group Embed components
+ */
+export interface SageViewConfig extends ViewConfig {
+    /**
+     * If set to false, eureka results are hidden
+     */
+    hideEurekaResults?: boolean;
+    /**
+     * primary flag to enable eureka(/sage) page embedding.
+     */
+    isSageEmbed?: boolean,
+    /**
+     * flag to disable changing worksheet. default false.
+     */
+    disableWorksheetChange?: boolean,
+    /**
+     * flag to hide worksheet selector. default false.
+     */
+    hideWorksheetSelector?: boolean,
+    fullHeight?:boolean;
+}
+export const HiddenActionItemByDefaultForSageEmbed = [
+    Action.Save,
+    Action.Pin,
+];
+/**
+ * Embed ThoughtSpot search
+ *
+ * @group Embed components
+ */
+export class SageEmbed extends V1Embed {
+    /**
+     * The view configuration for the embedded ThoughtSpot sage.
+     *
+     */
+    protected viewConfig: SageViewConfig;
+
+    private defaultHeight = 500;
+
+    // eslint-disable-next-line no-useless-constructor
+    constructor(domSelector: DOMSelector, viewConfig: SageViewConfig) {
+        super(domSelector, viewConfig);
+        if (this.viewConfig.fullHeight === true) {
+            this.on(EmbedEvent.RouteChange, this.setIframeHeightForNonEmbedLiveboard);
+            this.on(EmbedEvent.EmbedHeight, this.updateIFrameHeight);
+            this.on(EmbedEvent.EmbedIframeCenter, this.embedIframeCenter);
+        }
+    }
+
+    /**
+     * Constructs a map of parameters to be passed on to the
+     * embedded Eureka or Sage search page.
+     *
+     * @returns {string} query string
+     */
+    protected getEmbedParams(): string {
+        const {
+            hideEurekaResults, isSageEmbed, disableWorksheetChange, hideWorksheetSelector,
+        } = this.viewConfig;
+
+        const params = {};
+        params[Param.EmbedApp] = true;
+        params[Param.HideActions] = [...(params[Param.HideActions] ?? [])];
+        params[Param.HideActions] = [
+            ...(params[Param.HideActions] ?? []),
+            ...HiddenActionItemByDefaultForSageEmbed,
+        ];
+        if (hideEurekaResults) {
+            params[Param.HideEurekaResults] = true;
+        }
+        if (isSageEmbed) {
+            params[Param.IsSageEmbed] = true;
+        }
+        if (disableWorksheetChange) {
+            params[Param.DisableWorksheetChange] = true;
+        }
+        if (hideWorksheetSelector) {
+            params[Param.HideWorksheetSelector] = true;
+        }
+        const queryParamsString = getQueryParamString(params, true);
+        let query = '';
+        if (queryParamsString) {
+            query = `?${queryParamsString}`;
+        }
+        return query;
+    }
+
+    /**
+     * Set the iframe height as per the computed height received
+     * from the ThoughtSpot app.
+     *
+     * @param {MessagePayload} data The event payload
+     */
+    private updateIFrameHeight = (data: MessagePayload) => {
+        this.setIFrameHeight(Math.max(data.data, this.defaultHeight));
+    };
+
+    private embedIframeCenter = (data: MessagePayload, responder: any) => {
+        const obj = this.getIframeCenter();
+        responder({ type: EmbedEvent.EmbedIframeCenter, data: obj });
+    };
+
+    private setIframeHeightForNonEmbedLiveboard = (data: MessagePayload) => {
+        if (!data.data.currentPath.startsWith('/embed/viz/')) {
+            this.setIFrameHeight(this.defaultHeight);
+        }
+    };
+
+    /**
+     * Construct the URL of the embedded ThoughtSpot sage to be
+     * loaded in the iframe
+     *
+     * @returns {string} iframe url
+     */
+    private getIFrameSrc() {
+        const path = 'eureka';
+        const tsPostHashParams = this.getThoughtSpotPostUrlParams();
+
+        return `${this.getRootIframeSrc()}/embed/${path}${tsPostHashParams}`;
+    }
+
+    /**
+     * Render the embedded ThoughtSpot Sage
+     *
+     * @returns {SageEmbed} Eureka/Sage embed
+     */
+    public render(): SageEmbed {
+        super.render();
+
+        const src = this.getIFrameSrc();
+        this.renderV1Embed(src);
+
+        return this;
+    }
+}

package/src/errors.ts

@@ -3,4 +3,5 @@ export const ERROR_MESSAGE = {
     LIVEBOARD_VIZ_ID_VALIDATION: 'Please provide either liveboardId or pinboardId',
     TRIGGER_TIMED_OUT: 'Trigger timedout in getting response',
     SEARCHEMBED_BETA_WRANING_MESSAGE: 'Search Embed is in Beta in this release.',
+    SAGE_EMBED_BETA_WARNING_MESSAGE: 'Sage Embed is in Beta in this release.',
 };

package/src/index.ts

@@ -37,6 +37,7 @@ import {
     customCssInterface,
     ContextMenuTriggerOptions,
 } from './types';
+import { SageEmbed } from './embed/sage';
 
 export {
     init,
@@ -50,6 +51,7 @@ export {
     SearchBarEmbed,
     PinboardEmbed,
     LiveboardEmbed,
+    SageEmbed,
     AppEmbed,
     AuthFailureType,
     AuthStatus,

package/src/mixpanel-service.ts

@@ -56,17 +56,13 @@ export function initMixpanel(sessionInfo: any): void {
     // userGUID
     const isPublicCluster = !!sessionInfo.isPublicUser;
     const token = sessionInfo.mixpanelToken;
-    try {
-        if (token) {
-            mixpanel.init(token);
-            if (!isPublicCluster) {
-                mixpanel.identify(sessionInfo.userGUID);
-            }
-            isMixpanelInitialized = true;
-            emptyQueue();
+    if (token) {
+        mixpanel.init(token);
+        if (!isPublicCluster) {
+            mixpanel.identify(sessionInfo.userGUID);
         }
-    } catch (e) {
-        console.error('Error initializing mixpanel', e);
+        isMixpanelInitialized = true;
+        emptyQueue();
     }
 }
 

package/src/react/index.tsx

@@ -2,6 +2,7 @@ import React from 'react';
 import useDeepCompareEffect from 'use-deep-compare-effect';
 import { deepMerge } from '../utils';
 import { SearchBarEmbed as _SearchBarEmbed, SearchBarViewConfig } from '../embed/search-bar';
+import { SageEmbed as _SageEmbed, SageViewConfig } from '../embed/sage';
 import { SearchEmbed as _SearchEmbed, SearchViewConfig } from '../embed/search';
 import { AppEmbed as _AppEmbed, AppViewConfig } from '../embed/app';
 import { LiveboardEmbed as _LiveboardEmbed, LiveboardViewConfig } from '../embed/liveboard';
@@ -150,6 +151,14 @@ export const SearchBarEmbed = componentFactory<
     SearchBarViewConfig
 >(_SearchBarEmbed);
 
+interface SageEmbedProps extends EmbedProps, SageViewConfig {}
+
+export const SageEmbed = componentFactory<
+    typeof _SageEmbed,
+    SageEmbedProps,
+    SageViewConfig
+>(_SageEmbed);
+
 /**
  * Get a reference to the embed component to trigger events on the component.
  *
@@ -167,7 +176,7 @@ export const SearchBarEmbed = componentFactory<
  * ```
  * @returns {React.MutableRefObject<TsEmbed>} ref
  */
-export const useEmbedRef = (): React.MutableRefObject<_AppEmbed | _LiveboardEmbed | _SearchEmbed | _SearchBarEmbed> => React.useRef<_AppEmbed | _LiveboardEmbed | _SearchEmbed | _SearchBarEmbed>(null);
+export const useEmbedRef = (): React.MutableRefObject<TsEmbed> => React.useRef<TsEmbed>(null);
 
 export {
     LiveboardViewConfig,

package/src/types.ts

@@ -407,6 +407,10 @@ 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 SearchEmbed.
+     */
+    suppressSageEmbedBetaWarning?: boolean;
     /**
      * Custom style params for embed Config.
      *
@@ -1842,6 +1846,10 @@ export enum Param {
     HideProfleAndHelp = 'profileAndHelpInNavBarHidden',
     HideApplicationSwitcher= 'applicationSwitcherHidden',
     HideOrgSwitcher= 'orgSwitcherHidden',
+    IsSageEmbed = 'isSageEmbed',
+    HideWorksheetSelector = 'hideWorksheetSelector',
+    DisableWorksheetChange = 'disableWorksheetChange',
+    HideEurekaResults = 'hideEurekaResults',
 }
 
 /**