@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0

package/src/embed/ts-embed.ts

@@ -771,6 +771,7 @@ export class TsEmbed {
             insertInToSlide,
             disableRedirectionLinksInNewTab,
             overrideOrgId,
+            overrideHistoryState,
             exposeTranslationIDs,
             primaryAction,
         } = this.viewConfig;
@@ -869,6 +870,9 @@ export class TsEmbed {
         if (overrideOrgId !== undefined) {
             queryParams[Param.OverrideOrgId] = overrideOrgId;
         }
+        if (overrideHistoryState !== undefined) {
+            queryParams[Param.OverrideHistoryState] = overrideHistoryState;
+        }
 
         if (this.isPreAuthCacheEnabled()) {
             queryParams[Param.preAuthCache] = true;
@@ -1706,6 +1710,9 @@ export class TsEmbed {
      * @param args
      */
     public async render(): Promise<TsEmbed> {
+        uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_RENDER_CALLED, {
+            embedComponentType: this.viewConfig.embedComponentType,
+        });
         if (!getIsInitCalled()) {
             logger.error(ERROR_MESSAGE.RENDER_CALLED_BEFORE_INIT);
         }
@@ -1786,6 +1793,10 @@ export class TsEmbed {
         showPreRenderByDefault = false,
         replaceExistingPreRender = false,
     ): Promise<TsEmbed> {
+        uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_PRE_RENDER, {
+            showPreRenderByDefault,
+            replaceExistingPreRender,
+        });
         if (!this.viewConfig.preRenderId) {
             logger.error(ERROR_MESSAGE.PRERENDER_ID_MISSING);
             return this;
@@ -1974,8 +1985,14 @@ export class TsEmbed {
      * wrapper to overlay it.
      */
     public async showPreRender(): Promise<TsEmbed> {
+        uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_SHOW_PRE_RENDER, {
+            preRenderId: this.viewConfig.preRenderId,
+            embedComponentType: this.viewConfig.embedComponentType,
+        });
+
         if (this.shouldWaitForRenderPromise) await this.isReadyForRenderPromise;
 
+
         if (!this.viewConfig.preRenderId) {
             logger.error(ERROR_MESSAGE.PRERENDER_ID_MISSING);
             return this;
@@ -1999,10 +2016,14 @@ export class TsEmbed {
             }
 
             const placeHolderId = this.getPreRenderIds().placeHolder;
-            const oldEle = this.hostElement.querySelector(`#${placeHolderId}`);
-            if (oldEle) {
-                this.hostElement.removeChild(oldEle);
-            }
+            // Remove any stale placeholder from a previous cycle. It is located
+            // via a subtree-wide querySelector, so it may be nested deeper than a
+            // direct child (E.g.: with fullHeight the host app can wrap it). Use
+            // Element.remove() — which detaches from whatever the real parent is —
+            // rather than hostElement.removeChild(), which throws NotFoundError
+            // when the match is not a direct child. Mirrors the wrapper/child
+            // cleanup in createPreRenderWrapper()/createPreRenderChild().
+            this.hostElement.querySelector(`#${placeHolderId}`)?.remove();
 
             this.hostElement.appendChild(this.insertedDomEl);
 
@@ -2090,6 +2111,11 @@ export class TsEmbed {
      * If the component is not preRendered, it issues a warning.
      */
     public hidePreRender(): void {
+        uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_HIDE_PRE_RENDER, {
+            preRenderId: this.viewConfig.preRenderId,
+            embedComponentType: this.viewConfig.embedComponentType,
+        });
+
         logger.debug('HidePreRender Called');
         if (!this.isPreRenderConnected()) {
             // if the embed component is not preRendered , nothing to hide

package/src/errors.ts

@@ -31,6 +31,7 @@ export const ERROR_MESSAGE = {
     INVALID_SPOTTER_DOCUMENTATION_URL: 'Invalid spotterDocumentationUrl. Please provide a valid http or https URL.',
     UPDATEFILTERS_INVALID_PAYLOAD: 'UpdateFilters requires a valid filter or filters array. Expected: { filter: { column, oper, values } } or { filters: [{ column, oper, values }, ...] }',
     DRILLDOWN_INVALID_PAYLOAD: 'DrillDown requires a valid points object. Expected: { points: { clickedPoint?, selectedPoints? }, autoDrillDown?, vizId? }',
+    UPDATEPARAMETERS_INVALID_PAYLOAD: 'UpdateParameters received an invalid applicability. Expected: { level: LIVEBOARD | TAB | GROUP, targetId } where targetId is required for TAB and GROUP levels',
 };
 
 export const CUSTOM_ACTIONS_ERROR_MESSAGE = {

package/src/index.ts

@@ -32,7 +32,7 @@ import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from './embed/live
 import { SearchEmbed, SearchViewConfig } from './embed/search';
 import { SearchBarEmbed, SearchBarViewConfig } from './embed/search-bar';
 import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversation, BodylessConversationViewConfig} from './embed/bodyless-conversation';
-import { SpotterEmbed, SpotterEmbedViewConfig, SpotterChatViewConfig, SpotterSidebarViewConfig, ConversationEmbed, ConversationViewConfig } from './embed/conversation';
+import { SpotterEmbed, SpotterEmbedViewConfig, SpotterChatViewConfig, SpotterSidebarViewConfig, SpotterQueryMode, SpotterShareConversationConfig, ConversationEmbed, ConversationViewConfig } from './embed/conversation';
 import { SpotterVizConfig, SpotterVizStarterPrompt, SpotterVizLoaderTip } from './embed/spotter-viz-utils';
 import {
     AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter,
@@ -117,6 +117,8 @@ export {
     SpotterEmbedViewConfig,
     SpotterChatViewConfig,
     SpotterSidebarViewConfig,
+    SpotterQueryMode,
+    SpotterShareConversationConfig,
     ConversationViewConfig,
     ConversationEmbed,
     AuthFailureType,

package/src/mixpanel-service.ts

@@ -26,6 +26,10 @@ export const MIXPANEL_EVENT = {
     VISUAL_SDK_IFRAME_LOAD_PERFORMANCE: 'visual-sdk-iframe-load-performance',
     VISUAL_SDK_EMBED_CREATE: 'visual-sdk-embed-create',
     VERCEL_INTEGRATION_COMPLETED: 'vercel-integration-completed',
+    VISUAL_SDK_RENDER_CALLED: 'visual-sdk-render-called',
+    VISUAL_SDK_PRE_RENDER: 'visual-sdk-pre-render',
+    VISUAL_SDK_SHOW_PRE_RENDER: 'visual-sdk-show-pre-render',
+    VISUAL_SDK_HIDE_PRE_RENDER: 'visual-sdk-hide-pre-render',
 };
 
 let isMixpanelInitialized = false;

package/src/react/util.spec.tsx

@@ -84,5 +84,260 @@ describe('React util functions', () => {
                 [EmbedEvent.QueryChanged]: onQueryChanged,
             });
         });
+
+        test('all onX props map to their correct EmbedEvent listener keys', () => {
+            const onDrilldown: MessageCallback = jest.fn();
+            const onDataSourceSelected: MessageCallback = jest.fn();
+            const onAddRemoveColumns: MessageCallback = jest.fn();
+            const onVizPointDoubleClick: MessageCallback = jest.fn();
+            const onVizPointClick: MessageCallback = jest.fn();
+            const onAlert: MessageCallback = jest.fn();
+            const onGetDataClick: MessageCallback = jest.fn();
+            const onDialogClose: MessageCallback = jest.fn();
+            const onDownload: MessageCallback = jest.fn();
+            const onDownloadAsPng: MessageCallback = jest.fn();
+            const onDownloadAsPdf: MessageCallback = jest.fn();
+            const onDownloadAsCsv: MessageCallback = jest.fn();
+            const onDownloadAsXlsx: MessageCallback = jest.fn();
+            const onDownloadLiveboardAsContinuousPDF: MessageCallback = jest.fn();
+            const onAnswerDelete: MessageCallback = jest.fn();
+            const onAIHighlights: MessageCallback = jest.fn();
+            const onPin: MessageCallback = jest.fn();
+            const onSpotIQAnalyze: MessageCallback = jest.fn();
+            const onShare: MessageCallback = jest.fn();
+            const onDrillInclude: MessageCallback = jest.fn();
+            const onDrillExclude: MessageCallback = jest.fn();
+            const onCopyToClipboard: MessageCallback = jest.fn();
+            const onUpdateTML: MessageCallback = jest.fn();
+            const onEditTML: MessageCallback = jest.fn();
+            const onExportTML: MessageCallback = jest.fn();
+            const onSaveAsView: MessageCallback = jest.fn();
+            const onCopyAEdit: MessageCallback = jest.fn();
+            const onShowUnderlyingData: MessageCallback = jest.fn();
+            const onAnswerChartSwitcher: MessageCallback = jest.fn();
+            const onLiveboardInfo: MessageCallback = jest.fn();
+            const onAddToFavorites: MessageCallback = jest.fn();
+            const onSchedule: MessageCallback = jest.fn();
+            const onEdit: MessageCallback = jest.fn();
+            const onMakeACopy: MessageCallback = jest.fn();
+            const onPresent: MessageCallback = jest.fn();
+            const onDelete: MessageCallback = jest.fn();
+            const onSchedulesList: MessageCallback = jest.fn();
+            const onCancel: MessageCallback = jest.fn();
+            const onExplore: MessageCallback = jest.fn();
+            const onCopyLink: MessageCallback = jest.fn();
+            const onCrossFilterChanged: MessageCallback = jest.fn();
+            const onVizPointRightClick: MessageCallback = jest.fn();
+            const onInsertIntoSlide: MessageCallback = jest.fn();
+            const onFilterChanged: MessageCallback = jest.fn();
+            const onUpdateConnection: MessageCallback = jest.fn();
+            const onCreateConnection: MessageCallback = jest.fn();
+            const onResetLiveboard: MessageCallback = jest.fn();
+            const onChangePersonalizedView: MessageCallback = jest.fn();
+            const onCreateWorksheet: MessageCallback = jest.fn();
+            const onAskSageInit: MessageCallback = jest.fn();
+            const onRename: MessageCallback = jest.fn();
+            const onParameterChanged: MessageCallback = jest.fn();
+            const onTableVizRendered: MessageCallback = jest.fn();
+            const onCreateLiveboard: MessageCallback = jest.fn();
+            const onCreateModel: MessageCallback = jest.fn();
+            const onSpotterData: MessageCallback = jest.fn();
+            const onPreviewSpotterData: MessageCallback = jest.fn();
+            const onAddToCoaching: MessageCallback = jest.fn();
+            const onDataModelInstructions: MessageCallback = jest.fn();
+            const onSpotterQueryTriggered: MessageCallback = jest.fn();
+            const onLastPromptEdited: MessageCallback = jest.fn();
+            const onLastPromptDeleted: MessageCallback = jest.fn();
+            const onResetSpotterConversation: MessageCallback = jest.fn();
+            const onSpotterInit: MessageCallback = jest.fn();
+            const onSpotterLoadComplete: MessageCallback = jest.fn();
+            const onOrgSwitched: MessageCallback = jest.fn();
+            const onSpotterConversationRenamed: MessageCallback = jest.fn();
+            const onSpotterConversationDeleted: MessageCallback = jest.fn();
+            const onSpotterConversationSelected: MessageCallback = jest.fn();
+            const onEmbedPageContextChanged: MessageCallback = jest.fn();
+            const onSubscribed: MessageCallback = jest.fn();
+            const onSendTestScheduleEmail: MessageCallback = jest.fn();
+            const onSpotterVizInit: MessageCallback = jest.fn();
+            const onSpotterVizQueryTriggered: MessageCallback = jest.fn();
+            const onSpotterVizResponseComplete: MessageCallback = jest.fn();
+            const onSpotterVizCheckpointCreated: MessageCallback = jest.fn();
+            const onSpotterVizCheckpointRestored: MessageCallback = jest.fn();
+            const onSpotterVizError: MessageCallback = jest.fn();
+            const onSpotterVizClosed: MessageCallback = jest.fn();
+            const onRefreshLiveboardBrowserCache: MessageCallback = jest.fn();
+            const onV1Data: MessageCallback = jest.fn();
+
+            const props = {
+                onDrilldown,
+                onDataSourceSelected,
+                onAddRemoveColumns,
+                onVizPointDoubleClick,
+                onVizPointClick,
+                onAlert,
+                onGetDataClick,
+                onDialogClose,
+                onDownload,
+                onDownloadAsPng,
+                onDownloadAsPdf,
+                onDownloadAsCsv,
+                onDownloadAsXlsx,
+                onDownloadLiveboardAsContinuousPDF,
+                onAnswerDelete,
+                onAIHighlights,
+                onPin,
+                onSpotIQAnalyze,
+                onShare,
+                onDrillInclude,
+                onDrillExclude,
+                onCopyToClipboard,
+                onUpdateTML,
+                onEditTML,
+                onExportTML,
+                onSaveAsView,
+                onCopyAEdit,
+                onShowUnderlyingData,
+                onAnswerChartSwitcher,
+                onLiveboardInfo,
+                onAddToFavorites,
+                onSchedule,
+                onEdit,
+                onMakeACopy,
+                onPresent,
+                onDelete,
+                onSchedulesList,
+                onCancel,
+                onExplore,
+                onCopyLink,
+                onCrossFilterChanged,
+                onVizPointRightClick,
+                onInsertIntoSlide,
+                onFilterChanged,
+                onUpdateConnection,
+                onCreateConnection,
+                onResetLiveboard,
+                onChangePersonalizedView,
+                onCreateWorksheet,
+                onAskSageInit,
+                onRename,
+                onParameterChanged,
+                onTableVizRendered,
+                onCreateLiveboard,
+                onCreateModel,
+                onSpotterData,
+                onPreviewSpotterData,
+                onAddToCoaching,
+                onDataModelInstructions,
+                onSpotterQueryTriggered,
+                onLastPromptEdited,
+                onLastPromptDeleted,
+                onResetSpotterConversation,
+                onSpotterInit,
+                onSpotterLoadComplete,
+                onOrgSwitched,
+                onSpotterConversationRenamed,
+                onSpotterConversationDeleted,
+                onSpotterConversationSelected,
+                onEmbedPageContextChanged,
+                onSubscribed,
+                onSendTestScheduleEmail,
+                onSpotterVizInit,
+                onSpotterVizQueryTriggered,
+                onSpotterVizResponseComplete,
+                onSpotterVizCheckpointCreated,
+                onSpotterVizCheckpointRestored,
+                onSpotterVizError,
+                onSpotterVizClosed,
+                onRefreshLiveboardBrowserCache,
+                onV1Data,
+            };
+
+            const result = getViewPropsAndListeners(props);
+
+            expect(result.viewConfig).toEqual({});
+            expect(result.listeners).toEqual({
+                [EmbedEvent.Drilldown]: onDrilldown,
+                [EmbedEvent.DataSourceSelected]: onDataSourceSelected,
+                [EmbedEvent.AddRemoveColumns]: onAddRemoveColumns,
+                [EmbedEvent.VizPointDoubleClick]: onVizPointDoubleClick,
+                [EmbedEvent.VizPointClick]: onVizPointClick,
+                [EmbedEvent.Alert]: onAlert,
+                [EmbedEvent.GetDataClick]: onGetDataClick,
+                [EmbedEvent.DialogClose]: onDialogClose,
+                [EmbedEvent.Download]: onDownload,
+                [EmbedEvent.DownloadAsPng]: onDownloadAsPng,
+                [EmbedEvent.DownloadAsPdf]: onDownloadAsPdf,
+                [EmbedEvent.DownloadAsCsv]: onDownloadAsCsv,
+                [EmbedEvent.DownloadAsXlsx]: onDownloadAsXlsx,
+                [EmbedEvent.DownloadLiveboardAsContinuousPDF]: onDownloadLiveboardAsContinuousPDF,
+                [EmbedEvent.AnswerDelete]: onAnswerDelete,
+                [EmbedEvent.AIHighlights]: onAIHighlights,
+                [EmbedEvent.Pin]: onPin,
+                [EmbedEvent.SpotIQAnalyze]: onSpotIQAnalyze,
+                [EmbedEvent.Share]: onShare,
+                [EmbedEvent.DrillInclude]: onDrillInclude,
+                [EmbedEvent.DrillExclude]: onDrillExclude,
+                [EmbedEvent.CopyToClipboard]: onCopyToClipboard,
+                [EmbedEvent.UpdateTML]: onUpdateTML,
+                [EmbedEvent.EditTML]: onEditTML,
+                [EmbedEvent.ExportTML]: onExportTML,
+                [EmbedEvent.SaveAsView]: onSaveAsView,
+                [EmbedEvent.CopyAEdit]: onCopyAEdit,
+                [EmbedEvent.ShowUnderlyingData]: onShowUnderlyingData,
+                [EmbedEvent.AnswerChartSwitcher]: onAnswerChartSwitcher,
+                [EmbedEvent.LiveboardInfo]: onLiveboardInfo,
+                [EmbedEvent.AddToFavorites]: onAddToFavorites,
+                [EmbedEvent.Schedule]: onSchedule,
+                [EmbedEvent.Edit]: onEdit,
+                [EmbedEvent.MakeACopy]: onMakeACopy,
+                [EmbedEvent.Present]: onPresent,
+                [EmbedEvent.Delete]: onDelete,
+                [EmbedEvent.SchedulesList]: onSchedulesList,
+                [EmbedEvent.Cancel]: onCancel,
+                [EmbedEvent.Explore]: onExplore,
+                [EmbedEvent.CopyLink]: onCopyLink,
+                [EmbedEvent.CrossFilterChanged]: onCrossFilterChanged,
+                [EmbedEvent.VizPointRightClick]: onVizPointRightClick,
+                [EmbedEvent.InsertIntoSlide]: onInsertIntoSlide,
+                [EmbedEvent.FilterChanged]: onFilterChanged,
+                [EmbedEvent.UpdateConnection]: onUpdateConnection,
+                [EmbedEvent.CreateConnection]: onCreateConnection,
+                [EmbedEvent.ResetLiveboard]: onResetLiveboard,
+                [EmbedEvent.ChangePersonalizedView]: onChangePersonalizedView,
+                [EmbedEvent.CreateWorksheet]: onCreateWorksheet,
+                [EmbedEvent.AskSageInit]: onAskSageInit,
+                [EmbedEvent.Rename]: onRename,
+                [EmbedEvent.ParameterChanged]: onParameterChanged,
+                [EmbedEvent.TableVizRendered]: onTableVizRendered,
+                [EmbedEvent.CreateLiveboard]: onCreateLiveboard,
+                [EmbedEvent.CreateModel]: onCreateModel,
+                [EmbedEvent.SpotterData]: onSpotterData,
+                [EmbedEvent.PreviewSpotterData]: onPreviewSpotterData,
+                [EmbedEvent.AddToCoaching]: onAddToCoaching,
+                [EmbedEvent.DataModelInstructions]: onDataModelInstructions,
+                [EmbedEvent.SpotterQueryTriggered]: onSpotterQueryTriggered,
+                [EmbedEvent.LastPromptEdited]: onLastPromptEdited,
+                [EmbedEvent.LastPromptDeleted]: onLastPromptDeleted,
+                [EmbedEvent.ResetSpotterConversation]: onResetSpotterConversation,
+                [EmbedEvent.SpotterInit]: onSpotterInit,
+                [EmbedEvent.SpotterLoadComplete]: onSpotterLoadComplete,
+                [EmbedEvent.OrgSwitched]: onOrgSwitched,
+                [EmbedEvent.SpotterConversationRenamed]: onSpotterConversationRenamed,
+                [EmbedEvent.SpotterConversationDeleted]: onSpotterConversationDeleted,
+                [EmbedEvent.SpotterConversationSelected]: onSpotterConversationSelected,
+                [EmbedEvent.EmbedPageContextChanged]: onEmbedPageContextChanged,
+                [EmbedEvent.Subscribed]: onSubscribed,
+                [EmbedEvent.SendTestScheduleEmail]: onSendTestScheduleEmail,
+                [EmbedEvent.SpotterVizInit]: onSpotterVizInit,
+                [EmbedEvent.SpotterVizQueryTriggered]: onSpotterVizQueryTriggered,
+                [EmbedEvent.SpotterVizResponseComplete]: onSpotterVizResponseComplete,
+                [EmbedEvent.SpotterVizCheckpointCreated]: onSpotterVizCheckpointCreated,
+                [EmbedEvent.SpotterVizCheckpointRestored]: onSpotterVizCheckpointRestored,
+                [EmbedEvent.SpotterVizError]: onSpotterVizError,
+                [EmbedEvent.SpotterVizClosed]: onSpotterVizClosed,
+                [EmbedEvent.RefreshLiveboardBrowserCache]: onRefreshLiveboardBrowserCache,
+                [EmbedEvent.V1Data]: onV1Data,
+            });
+        });
     });
 });