@thoughtspot/visual-embed-sdk 1.39.2-alpha.1 → 1.39.2-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/config.spec.js +9 -0
- package/cjs/src/config.spec.js.map +1 -1
- package/cjs/src/embed/app.d.ts +75 -15
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +68 -9
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +360 -7
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/bodyless-conversation.d.ts +19 -7
- package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/cjs/src/embed/bodyless-conversation.js +24 -4
- package/cjs/src/embed/bodyless-conversation.js.map +1 -1
- package/cjs/src/embed/bodyless-conversation.spec.js +8 -190
- package/cjs/src/embed/bodyless-conversation.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +2 -60
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +1 -9
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +0 -102
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +56 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +46 -0
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +206 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +1 -0
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +1 -0
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/all-types-export.d.ts +1 -1
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +3 -2
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/react/index.d.ts +71 -20
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +79 -42
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +436 -100
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +46 -4
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +28 -0
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/nlsService/conversation-service.d.ts.map +1 -1
- package/cjs/src/utils/graphql/nlsService/conversation-service.js +2 -0
- package/cjs/src/utils/graphql/nlsService/conversation-service.js.map +1 -1
- package/cjs/src/utils/processTrigger.js +2 -1
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils.d.ts +6 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +23 -3
- package/cjs/src/utils.js.map +1 -1
- package/cjs/src/utils.spec.js +237 -1
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/index-D1pyb7RG.js +7371 -0
- package/dist/index-e3Uw3YFO.js +7371 -0
- package/dist/src/embed/app.d.ts +75 -15
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/bodyless-conversation.d.ts +19 -7
- package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +2 -60
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +56 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/errors.d.ts +1 -0
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/all-types-export.d.ts +1 -1
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +71 -20
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +46 -4
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/nlsService/conversation-service.d.ts.map +1 -1
- package/dist/src/utils.d.ts +6 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +276 -74
- package/dist/tsembed-react.js +276 -72
- package/dist/tsembed.es.js +194 -27
- package/dist/tsembed.js +192 -25
- package/dist/visual-embed-sdk-react-full.d.ts +246 -105
- package/dist/visual-embed-sdk-react.d.ts +246 -105
- package/dist/visual-embed-sdk.d.ts +176 -86
- package/lib/package.json +1 -1
- package/lib/src/config.spec.js +9 -0
- package/lib/src/config.spec.js.map +1 -1
- package/lib/src/embed/app.d.ts +75 -15
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +68 -9
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +361 -8
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/bodyless-conversation.d.ts +19 -7
- package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/lib/src/embed/bodyless-conversation.js +23 -4
- package/lib/src/embed/bodyless-conversation.js.map +1 -1
- package/lib/src/embed/bodyless-conversation.spec.js +9 -191
- package/lib/src/embed/bodyless-conversation.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +2 -60
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +2 -10
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +2 -104
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +56 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +47 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +206 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/errors.d.ts +1 -0
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +1 -0
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/all-types-export.d.ts +1 -1
- package/lib/src/react/all-types-export.d.ts.map +1 -1
- package/lib/src/react/all-types-export.js +1 -1
- package/lib/src/react/all-types-export.js.map +1 -1
- package/lib/src/react/index.d.ts +71 -20
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +79 -43
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +439 -103
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +46 -4
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +28 -0
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/nlsService/conversation-service.d.ts.map +1 -1
- package/lib/src/utils/graphql/nlsService/conversation-service.js +2 -0
- package/lib/src/utils/graphql/nlsService/conversation-service.js.map +1 -1
- package/lib/src/utils/processTrigger.js +2 -1
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils.d.ts +6 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +21 -2
- package/lib/src/utils.js.map +1 -1
- package/lib/src/utils.spec.js +238 -2
- package/lib/src/utils.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +178 -88
- package/package.json +1 -1
- package/src/config.spec.ts +11 -0
- package/src/embed/app.spec.ts +451 -8
- package/src/embed/app.ts +131 -27
- package/src/embed/bodyless-conversation.spec.ts +9 -203
- package/src/embed/bodyless-conversation.ts +24 -10
- package/src/embed/conversation.spec.ts +5 -131
- package/src/embed/conversation.ts +10 -82
- package/src/embed/liveboard.spec.ts +254 -1
- package/src/embed/liveboard.ts +96 -5
- package/src/errors.ts +1 -0
- package/src/index.ts +2 -0
- package/src/react/all-types-export.ts +2 -1
- package/src/react/index.spec.tsx +556 -157
- package/src/react/index.tsx +117 -51
- package/src/types.ts +42 -0
- package/src/utils/graphql/nlsService/conversation-service.ts +2 -0
- package/src/utils/processTrigger.ts +1 -1
- package/src/utils.spec.ts +279 -2
- package/src/utils.ts +28 -2
|
@@ -12,7 +12,7 @@ import EventEmitter from 'eventemitter3';
|
|
|
12
12
|
* @summary ThoughtSpot Visual Embed SDK
|
|
13
13
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
14
14
|
*/
|
|
15
|
-
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
|
|
15
|
+
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* Copyright (c) 2022
|
|
@@ -106,6 +106,21 @@ export enum HomePage {
|
|
|
106
106
|
*/
|
|
107
107
|
Modular = "v2"
|
|
108
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* Define the version of the list page
|
|
111
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
112
|
+
*/
|
|
113
|
+
export enum ListPage {
|
|
114
|
+
/**
|
|
115
|
+
* List (v2) is the traditional List Experience.
|
|
116
|
+
* It serves as the foundational version of the list page.
|
|
117
|
+
*/
|
|
118
|
+
List = "v2",
|
|
119
|
+
/**
|
|
120
|
+
* ListWithUXChanges (v3) introduces the new updated list page with UX changes.
|
|
121
|
+
*/
|
|
122
|
+
ListWithUXChanges = "v3"
|
|
123
|
+
}
|
|
109
124
|
/**
|
|
110
125
|
* Define the discovery experience
|
|
111
126
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -119,6 +134,10 @@ export interface DiscoveryExperience {
|
|
|
119
134
|
* homePage determines the version of the home page.
|
|
120
135
|
*/
|
|
121
136
|
homePage?: HomePage;
|
|
137
|
+
/**
|
|
138
|
+
* listPageVersion determines the version of the list page.
|
|
139
|
+
*/
|
|
140
|
+
listPageVersion?: ListPage;
|
|
122
141
|
}
|
|
123
142
|
/**
|
|
124
143
|
* The view configuration for full app embedding.
|
|
@@ -490,21 +509,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
490
509
|
* ```
|
|
491
510
|
*/
|
|
492
511
|
isUnifiedSearchExperienceEnabled?: boolean;
|
|
493
|
-
/**
|
|
494
|
-
* Show alert messages and toast messages in the embedded
|
|
495
|
-
* view in full app embed.
|
|
496
|
-
*
|
|
497
|
-
* Supported embed types: `AppEmbed`
|
|
498
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
499
|
-
* @example
|
|
500
|
-
* ```js
|
|
501
|
-
* const embed = new AppEmbed('#tsEmbed', {
|
|
502
|
-
* ... // other embed view config
|
|
503
|
-
* showAlerts:true,
|
|
504
|
-
* })
|
|
505
|
-
* ```
|
|
506
|
-
*/
|
|
507
|
-
showAlerts?: boolean;
|
|
508
512
|
/**
|
|
509
513
|
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
510
514
|
*
|
|
@@ -521,6 +525,46 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
521
525
|
* ```
|
|
522
526
|
*/
|
|
523
527
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
528
|
+
/**
|
|
529
|
+
* This flag is used to enable the full height lazy load data.
|
|
530
|
+
*
|
|
531
|
+
* @example
|
|
532
|
+
* ```js
|
|
533
|
+
* const embed = new AppEmbed('#embed-container', {
|
|
534
|
+
* // ...other options
|
|
535
|
+
* fullHeight: true,
|
|
536
|
+
* lazyLoadingForFullHeight: true,
|
|
537
|
+
* })
|
|
538
|
+
* ```
|
|
539
|
+
*
|
|
540
|
+
* @type {boolean}
|
|
541
|
+
* @default false
|
|
542
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
543
|
+
*/
|
|
544
|
+
lazyLoadingForFullHeight?: boolean;
|
|
545
|
+
/**
|
|
546
|
+
* The margin to be used for lazy loading.
|
|
547
|
+
*
|
|
548
|
+
* For example, if the margin is set to '10px',
|
|
549
|
+
* the visualization will be loaded 10px before the its top edge is visible in the
|
|
550
|
+
* viewport.
|
|
551
|
+
*
|
|
552
|
+
* The format is similar to CSS margin.
|
|
553
|
+
*
|
|
554
|
+
* @example
|
|
555
|
+
* ```js
|
|
556
|
+
* const embed = new AppEmbed('#embed-container', {
|
|
557
|
+
* // ...other options
|
|
558
|
+
* fullHeight: true,
|
|
559
|
+
* lazyLoadingForFullHeight: true,
|
|
560
|
+
* // Using 0px, the visualization will be only loaded when its visible in the viewport.
|
|
561
|
+
* lazyLoadingMargin: '0px',
|
|
562
|
+
* })
|
|
563
|
+
* ```
|
|
564
|
+
* @type {string}
|
|
565
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
566
|
+
*/
|
|
567
|
+
lazyLoadingMargin?: string;
|
|
524
568
|
}
|
|
525
569
|
/**
|
|
526
570
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -557,6 +601,11 @@ export class AppEmbed extends V1Embed {
|
|
|
557
601
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
558
602
|
*/
|
|
559
603
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
604
|
+
/**
|
|
605
|
+
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
606
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
607
|
+
*/
|
|
608
|
+
destroy(): void;
|
|
560
609
|
/**
|
|
561
610
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
562
611
|
* @param renderOptions An object containing the page ID
|
|
@@ -1008,6 +1057,46 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
1008
1057
|
* ```
|
|
1009
1058
|
*/
|
|
1010
1059
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
1060
|
+
/**
|
|
1061
|
+
* This flag is used to enable the full height lazy load data.
|
|
1062
|
+
*
|
|
1063
|
+
* @example
|
|
1064
|
+
* ```js
|
|
1065
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1066
|
+
* // ...other options
|
|
1067
|
+
* fullHeight: true,
|
|
1068
|
+
* lazyLoadingForFullHeight: true,
|
|
1069
|
+
* })
|
|
1070
|
+
* ```
|
|
1071
|
+
*
|
|
1072
|
+
* @type {boolean}
|
|
1073
|
+
* @default false
|
|
1074
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
1075
|
+
*/
|
|
1076
|
+
lazyLoadingForFullHeight?: boolean;
|
|
1077
|
+
/**
|
|
1078
|
+
* The margin to be used for lazy loading.
|
|
1079
|
+
*
|
|
1080
|
+
* For example, if the margin is set to '10px',
|
|
1081
|
+
* the visualization will be loaded 10px before the its top edge is visible in the
|
|
1082
|
+
* viewport.
|
|
1083
|
+
*
|
|
1084
|
+
* The format is similar to CSS margin.
|
|
1085
|
+
*
|
|
1086
|
+
* @example
|
|
1087
|
+
* ```js
|
|
1088
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1089
|
+
* // ...other options
|
|
1090
|
+
* fullHeight: true,
|
|
1091
|
+
* lazyLoadingForFullHeight: true,
|
|
1092
|
+
* // Using 0px, the visualization will be only loaded when its visible in the viewport.
|
|
1093
|
+
* lazyLoadingMargin: '0px',
|
|
1094
|
+
* })
|
|
1095
|
+
* ```
|
|
1096
|
+
* @type {string}
|
|
1097
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
1098
|
+
*/
|
|
1099
|
+
lazyLoadingMargin?: string;
|
|
1011
1100
|
}
|
|
1012
1101
|
/**
|
|
1013
1102
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -1041,6 +1130,11 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
1041
1130
|
* @returns A promise that resolves with the response from the embedded app
|
|
1042
1131
|
*/
|
|
1043
1132
|
trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
|
|
1133
|
+
/**
|
|
1134
|
+
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
1135
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1136
|
+
*/
|
|
1137
|
+
destroy(): void;
|
|
1044
1138
|
/**
|
|
1045
1139
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
1046
1140
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
@@ -1519,10 +1613,6 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
|
|
|
1519
1613
|
* The ID of the worksheet to use for the conversation.
|
|
1520
1614
|
*/
|
|
1521
1615
|
worksheetId: string;
|
|
1522
|
-
/**
|
|
1523
|
-
* Optional CSS class name to add to the container div.
|
|
1524
|
-
*/
|
|
1525
|
-
containerClassName?: string;
|
|
1526
1616
|
}
|
|
1527
1617
|
/**
|
|
1528
1618
|
* Configuration for conversation options.
|
|
@@ -1532,13 +1622,13 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'prima
|
|
|
1532
1622
|
*/
|
|
1533
1623
|
export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
|
|
1534
1624
|
}
|
|
1535
|
-
interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
|
|
1625
|
+
export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
|
|
1536
1626
|
sessionId: string;
|
|
1537
1627
|
genNo: number;
|
|
1538
1628
|
acSessionId: string;
|
|
1539
1629
|
acGenNo: number;
|
|
1540
1630
|
}
|
|
1541
|
-
class ConversationMessage extends TsEmbed {
|
|
1631
|
+
export class ConversationMessage extends TsEmbed {
|
|
1542
1632
|
protected viewConfig: SpotterAgentMessageViewConfig;
|
|
1543
1633
|
constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
|
|
1544
1634
|
getIframeSrc(): string;
|
|
@@ -1574,6 +1664,23 @@ export class SpotterAgentEmbed {
|
|
|
1574
1664
|
viz: ConversationMessage;
|
|
1575
1665
|
error?: undefined;
|
|
1576
1666
|
}>;
|
|
1667
|
+
/**
|
|
1668
|
+
* Send a message to the conversation service and return only the data.
|
|
1669
|
+
* @param userMessage - The message to send to the conversation service.
|
|
1670
|
+
* @returns The data from the conversation service.
|
|
1671
|
+
*/
|
|
1672
|
+
sendMessageData(userMessage: string): Promise<{
|
|
1673
|
+
error: any;
|
|
1674
|
+
data?: undefined;
|
|
1675
|
+
} | {
|
|
1676
|
+
data: {
|
|
1677
|
+
sessionId: any;
|
|
1678
|
+
genNo: any;
|
|
1679
|
+
acSessionId: any;
|
|
1680
|
+
acGenNo: any;
|
|
1681
|
+
};
|
|
1682
|
+
error?: undefined;
|
|
1683
|
+
}>;
|
|
1577
1684
|
}
|
|
1578
1685
|
/**
|
|
1579
1686
|
* Create a conversation embed, which can be integrated inside
|
|
@@ -1598,7 +1705,6 @@ export class SpotterAgentEmbed {
|
|
|
1598
1705
|
export class BodylessConversation extends SpotterAgentEmbed {
|
|
1599
1706
|
constructor(viewConfig: BodylessConversationViewConfig);
|
|
1600
1707
|
}
|
|
1601
|
-
export {};
|
|
1602
1708
|
|
|
1603
1709
|
/**
|
|
1604
1710
|
* Configuration for search options
|
|
@@ -1615,8 +1721,7 @@ export interface SearchOptions {
|
|
|
1615
1721
|
*/
|
|
1616
1722
|
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
1617
1723
|
/**
|
|
1618
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
1619
|
-
* this object to query data and generate Answers.
|
|
1724
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
|
|
1620
1725
|
*/
|
|
1621
1726
|
worksheetId: string;
|
|
1622
1727
|
/**
|
|
@@ -1699,63 +1804,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
1699
1804
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
1700
1805
|
*/
|
|
1701
1806
|
hideSampleQuestions?: boolean;
|
|
1702
|
-
/**
|
|
1703
|
-
* The list of runtime filters to apply to a search Answer,
|
|
1704
|
-
* visualization, or Liveboard.
|
|
1705
|
-
*
|
|
1706
|
-
* Supported embed types: `SpotterEmbed`
|
|
1707
|
-
* @example
|
|
1708
|
-
* ```js
|
|
1709
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
1710
|
-
* ... // other embed view config
|
|
1711
|
-
* runtimeFilters: [
|
|
1712
|
-
* {
|
|
1713
|
-
* columnName: 'value',
|
|
1714
|
-
* operator: RuntimeFilterOp.EQ,
|
|
1715
|
-
* values: ['string' | 123 | true],
|
|
1716
|
-
* },
|
|
1717
|
-
* ],
|
|
1718
|
-
* })
|
|
1719
|
-
* ```
|
|
1720
|
-
*/
|
|
1721
|
-
runtimeFilters?: RuntimeFilter[];
|
|
1722
|
-
/**
|
|
1723
|
-
* Flag to control whether runtime filters should be included in the URL.
|
|
1724
|
-
* If true, filters will be passed via app initialization payload instead.
|
|
1725
|
-
* If false/undefined, filters will be added to URL (default behavior).
|
|
1726
|
-
*
|
|
1727
|
-
* Supported embed types: `SpotterEmbed`
|
|
1728
|
-
* @default false
|
|
1729
|
-
*/
|
|
1730
|
-
excludeRuntimeFiltersfromURL?: boolean;
|
|
1731
|
-
/**
|
|
1732
|
-
* The list of runtime parameters to apply to the conversation.
|
|
1733
|
-
*
|
|
1734
|
-
* Supported embed types: `SpotterEmbed`
|
|
1735
|
-
* @example
|
|
1736
|
-
* ```js
|
|
1737
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
1738
|
-
* ... // other embed view config
|
|
1739
|
-
* runtimeParameters: [
|
|
1740
|
-
* {
|
|
1741
|
-
* name: 'Parameter Name',
|
|
1742
|
-
* value: 'Parameter Value',
|
|
1743
|
-
* },
|
|
1744
|
-
* ],
|
|
1745
|
-
* })
|
|
1746
|
-
* ```
|
|
1747
|
-
*/
|
|
1748
|
-
runtimeParameters?: RuntimeParameter[];
|
|
1749
|
-
/**
|
|
1750
|
-
* Flag to control whether runtime parameters should be included in the URL.
|
|
1751
|
-
* If true, parameters will be passed via app initialization payload instead.
|
|
1752
|
-
* If false/undefined, parameters will be added to URL (default behavior).
|
|
1753
|
-
*
|
|
1754
|
-
* Supported embed types: `SpotterEmbed`
|
|
1755
|
-
* @default false
|
|
1756
|
-
*
|
|
1757
|
-
*/
|
|
1758
|
-
excludeRuntimeParametersfromURL?: boolean;
|
|
1759
1807
|
}
|
|
1760
1808
|
/**
|
|
1761
1809
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -2304,7 +2352,13 @@ export enum HomeLeftNavItem {
|
|
|
2304
2352
|
* available when new navigation V3 is enabled.
|
|
2305
2353
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
2306
2354
|
*/
|
|
2307
|
-
Spotter = "spotter"
|
|
2355
|
+
Spotter = "spotter",
|
|
2356
|
+
/**
|
|
2357
|
+
* Favorites option in the insights left navigation,
|
|
2358
|
+
* available when new navigation V3 is enabled.
|
|
2359
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
2360
|
+
*/
|
|
2361
|
+
Favorites = "favorites"
|
|
2308
2362
|
}
|
|
2309
2363
|
export type DOMSelector = string | HTMLElement;
|
|
2310
2364
|
/**
|
|
@@ -3070,6 +3124,20 @@ export interface BaseViewConfig {
|
|
|
3070
3124
|
* @private
|
|
3071
3125
|
*/
|
|
3072
3126
|
insertInToSlide?: boolean;
|
|
3127
|
+
/**
|
|
3128
|
+
* Show alert messages and toast messages in the embed.
|
|
3129
|
+
* Supported embed in all embed types.
|
|
3130
|
+
*
|
|
3131
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3132
|
+
* @example
|
|
3133
|
+
* ```js
|
|
3134
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
3135
|
+
* ... // other embed view config
|
|
3136
|
+
* showAlerts:true,
|
|
3137
|
+
* })
|
|
3138
|
+
* ```
|
|
3139
|
+
*/
|
|
3140
|
+
showAlerts?: boolean;
|
|
3073
3141
|
}
|
|
3074
3142
|
/**
|
|
3075
3143
|
* The configuration object for Home page embeds configs.
|
|
@@ -4722,7 +4790,13 @@ export enum EmbedEvent {
|
|
|
4722
4790
|
* Emitted when a user exits present mode.
|
|
4723
4791
|
* @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4724
4792
|
*/
|
|
4725
|
-
ExitPresentMode = "exitPresentMode"
|
|
4793
|
+
ExitPresentMode = "exitPresentMode",
|
|
4794
|
+
/**
|
|
4795
|
+
* Emitted when a user requests the full height lazy load data.
|
|
4796
|
+
* @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
|
|
4797
|
+
* @hidden
|
|
4798
|
+
*/
|
|
4799
|
+
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates"
|
|
4726
4800
|
}
|
|
4727
4801
|
/**
|
|
4728
4802
|
* Event types that can be triggered by the host application
|
|
@@ -5804,7 +5878,20 @@ export enum HostEvent {
|
|
|
5804
5878
|
*```
|
|
5805
5879
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5806
5880
|
*/
|
|
5807
|
-
ExitPresentMode = "exitPresentMode"
|
|
5881
|
+
ExitPresentMode = "exitPresentMode",
|
|
5882
|
+
/**
|
|
5883
|
+
* Triggers the full height lazy load data.
|
|
5884
|
+
* @example
|
|
5885
|
+
* ```js
|
|
5886
|
+
* liveboardEmbed.on(EmbedEvent.RequestVisibleEmbedCoordinates, (payload) => {
|
|
5887
|
+
* console.log(payload);
|
|
5888
|
+
* });
|
|
5889
|
+
* ```
|
|
5890
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
5891
|
+
*
|
|
5892
|
+
* @hidden
|
|
5893
|
+
*/
|
|
5894
|
+
VisibleEmbedCoordinates = "visibleEmbedCoordinates"
|
|
5808
5895
|
}
|
|
5809
5896
|
/**
|
|
5810
5897
|
* The different visual modes that the data sources panel within
|
|
@@ -5900,6 +5987,7 @@ export enum Param {
|
|
|
5900
5987
|
Query = "query",
|
|
5901
5988
|
HideHomepageLeftNav = "hideHomepageLeftNav",
|
|
5902
5989
|
ModularHomeExperienceEnabled = "modularHomeExperience",
|
|
5990
|
+
ListPageVersion = "listpageVersion",
|
|
5903
5991
|
PendoTrackingKey = "additionalPendoKey",
|
|
5904
5992
|
LiveboardHeaderSticky = "isLiveboardHeaderSticky",
|
|
5905
5993
|
IsProductTour = "isProductTour",
|
|
@@ -5937,7 +6025,9 @@ export enum Param {
|
|
|
5937
6025
|
CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
|
|
5938
6026
|
PrimaryAction = "primaryAction",
|
|
5939
6027
|
isSpotterAgentEmbed = "isSpotterAgentEmbed",
|
|
5940
|
-
IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
|
|
6028
|
+
IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
|
|
6029
|
+
IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
|
|
6030
|
+
RootMarginForLazyLoad = "rootMarginForLazyLoad"
|
|
5941
6031
|
}
|
|
5942
6032
|
/**
|
|
5943
6033
|
* ThoughtSpot application pages include actions and menu commands
|
package/lib/package.json
CHANGED
package/lib/src/config.spec.js
CHANGED
|
@@ -16,6 +16,15 @@ describe('getThoughtSpotHost', () => {
|
|
|
16
16
|
};
|
|
17
17
|
expect(testFn).toThrow(Error);
|
|
18
18
|
});
|
|
19
|
+
test('invalid URL format', () => {
|
|
20
|
+
const testFn = () => {
|
|
21
|
+
getThoughtSpotHost({
|
|
22
|
+
...embedConfig,
|
|
23
|
+
thoughtSpotHost: '',
|
|
24
|
+
});
|
|
25
|
+
};
|
|
26
|
+
expect(testFn).toThrow('Error parsing ThoughtSpot host. Please provide a valid URL.');
|
|
27
|
+
});
|
|
19
28
|
test('IP address/hostname only', () => {
|
|
20
29
|
expect(getThoughtSpotHost({
|
|
21
30
|
...embedConfig,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.spec.js","sourceRoot":"","sources":["../../src/config.spec.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,MAAM,WAAW,GAAG;IAChB,QAAQ,EAAE,QAAQ,CAAC,GAAG;CACzB,CAAC;AAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,MAAM,GAAG,GAAG,EAAE;YAChB,kBAAkB,CAAC;gBACf,GAAG,WAAW;gBACd,eAAe,EAAE,IAAI;aACxB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,SAAS;SAC7B,CAAC,CACL,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAE1B,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,QAAQ;SAC5B,CAAC,CACL,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,eAAe;SACnC,CAAC,CACL,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,qBAAqB;SACzC,CAAC,CACL,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,+CAA+C;SACnE,CAAC,CACL,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,eAAe,EAAE,+CAA+C;SACnE,CAAC,CACL,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,QAAQ,GAAG,aAAa,CAAC;YAC3B,QAAQ,EAAE,MAAM;YAChB,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE,QAAQ,CAAC,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"config.spec.js","sourceRoot":"","sources":["../../src/config.spec.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,MAAM,WAAW,GAAG;IAChB,QAAQ,EAAE,QAAQ,CAAC,GAAG;CACzB,CAAC;AAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,MAAM,GAAG,GAAG,EAAE;YAChB,kBAAkB,CAAC;gBACf,GAAG,WAAW;gBACd,eAAe,EAAE,IAAI;aACxB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,MAAM,GAAG,GAAG,EAAE;YAChB,kBAAkB,CAAC;gBACf,GAAG,WAAW;gBACd,eAAe,EAAE,EAAE;aACtB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,6DAA6D,CAAC,CAAC;IAC1F,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,SAAS;SAC7B,CAAC,CACL,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAE1B,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,QAAQ;SAC5B,CAAC,CACL,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,eAAe;SACnC,CAAC,CACL,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,qBAAqB;SACzC,CAAC,CACL,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,eAAe,EAAE,+CAA+C;SACnE,CAAC,CACL,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,CACF,kBAAkB,CAAC;YACf,GAAG,WAAW;YACd,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,eAAe,EAAE,+CAA+C;SACnE,CAAC,CACL,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,QAAQ,GAAG,aAAa,CAAC;YAC3B,QAAQ,EAAE,MAAM;YAChB,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE,QAAQ,CAAC,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
package/lib/src/embed/app.d.ts
CHANGED
|
@@ -92,6 +92,21 @@ export declare enum HomePage {
|
|
|
92
92
|
*/
|
|
93
93
|
Modular = "v2"
|
|
94
94
|
}
|
|
95
|
+
/**
|
|
96
|
+
* Define the version of the list page
|
|
97
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
98
|
+
*/
|
|
99
|
+
export declare enum ListPage {
|
|
100
|
+
/**
|
|
101
|
+
* List (v2) is the traditional List Experience.
|
|
102
|
+
* It serves as the foundational version of the list page.
|
|
103
|
+
*/
|
|
104
|
+
List = "v2",
|
|
105
|
+
/**
|
|
106
|
+
* ListWithUXChanges (v3) introduces the new updated list page with UX changes.
|
|
107
|
+
*/
|
|
108
|
+
ListWithUXChanges = "v3"
|
|
109
|
+
}
|
|
95
110
|
/**
|
|
96
111
|
* Define the discovery experience
|
|
97
112
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -105,6 +120,10 @@ export interface DiscoveryExperience {
|
|
|
105
120
|
* homePage determines the version of the home page.
|
|
106
121
|
*/
|
|
107
122
|
homePage?: HomePage;
|
|
123
|
+
/**
|
|
124
|
+
* listPageVersion determines the version of the list page.
|
|
125
|
+
*/
|
|
126
|
+
listPageVersion?: ListPage;
|
|
108
127
|
}
|
|
109
128
|
/**
|
|
110
129
|
* The view configuration for full app embedding.
|
|
@@ -476,21 +495,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
476
495
|
* ```
|
|
477
496
|
*/
|
|
478
497
|
isUnifiedSearchExperienceEnabled?: boolean;
|
|
479
|
-
/**
|
|
480
|
-
* Show alert messages and toast messages in the embedded
|
|
481
|
-
* view in full app embed.
|
|
482
|
-
*
|
|
483
|
-
* Supported embed types: `AppEmbed`
|
|
484
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
485
|
-
* @example
|
|
486
|
-
* ```js
|
|
487
|
-
* const embed = new AppEmbed('#tsEmbed', {
|
|
488
|
-
* ... // other embed view config
|
|
489
|
-
* showAlerts:true,
|
|
490
|
-
* })
|
|
491
|
-
* ```
|
|
492
|
-
*/
|
|
493
|
-
showAlerts?: boolean;
|
|
494
498
|
/**
|
|
495
499
|
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
496
500
|
*
|
|
@@ -507,6 +511,46 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
507
511
|
* ```
|
|
508
512
|
*/
|
|
509
513
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
514
|
+
/**
|
|
515
|
+
* This flag is used to enable the full height lazy load data.
|
|
516
|
+
*
|
|
517
|
+
* @example
|
|
518
|
+
* ```js
|
|
519
|
+
* const embed = new AppEmbed('#embed-container', {
|
|
520
|
+
* // ...other options
|
|
521
|
+
* fullHeight: true,
|
|
522
|
+
* lazyLoadingForFullHeight: true,
|
|
523
|
+
* })
|
|
524
|
+
* ```
|
|
525
|
+
*
|
|
526
|
+
* @type {boolean}
|
|
527
|
+
* @default false
|
|
528
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
529
|
+
*/
|
|
530
|
+
lazyLoadingForFullHeight?: boolean;
|
|
531
|
+
/**
|
|
532
|
+
* The margin to be used for lazy loading.
|
|
533
|
+
*
|
|
534
|
+
* For example, if the margin is set to '10px',
|
|
535
|
+
* the visualization will be loaded 10px before the its top edge is visible in the
|
|
536
|
+
* viewport.
|
|
537
|
+
*
|
|
538
|
+
* The format is similar to CSS margin.
|
|
539
|
+
*
|
|
540
|
+
* @example
|
|
541
|
+
* ```js
|
|
542
|
+
* const embed = new AppEmbed('#embed-container', {
|
|
543
|
+
* // ...other options
|
|
544
|
+
* fullHeight: true,
|
|
545
|
+
* lazyLoadingForFullHeight: true,
|
|
546
|
+
* // Using 0px, the visualization will be only loaded when its visible in the viewport.
|
|
547
|
+
* lazyLoadingMargin: '0px',
|
|
548
|
+
* })
|
|
549
|
+
* ```
|
|
550
|
+
* @type {string}
|
|
551
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
552
|
+
*/
|
|
553
|
+
lazyLoadingMargin?: string;
|
|
510
554
|
}
|
|
511
555
|
/**
|
|
512
556
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -521,6 +565,14 @@ export declare class AppEmbed extends V1Embed {
|
|
|
521
565
|
* embedded Liveboard or visualization.
|
|
522
566
|
*/
|
|
523
567
|
protected getEmbedParams(): string;
|
|
568
|
+
private sendFullHeightLazyLoadData;
|
|
569
|
+
/**
|
|
570
|
+
* This is a handler for the RequestVisibleEmbedCoordinates event.
|
|
571
|
+
* It is used to send the visible coordinates data to the host application.
|
|
572
|
+
* @param data The event payload
|
|
573
|
+
* @param responder The responder function
|
|
574
|
+
*/
|
|
575
|
+
private requestVisibleEmbedCoordinatesHandler;
|
|
524
576
|
/**
|
|
525
577
|
* Constructs the URL of the ThoughtSpot app page to be rendered.
|
|
526
578
|
* @param pageId The ID of the page to be embedded.
|
|
@@ -558,6 +610,14 @@ export declare class AppEmbed extends V1Embed {
|
|
|
558
610
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
559
611
|
*/
|
|
560
612
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
613
|
+
/**
|
|
614
|
+
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
615
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
616
|
+
*/
|
|
617
|
+
destroy(): void;
|
|
618
|
+
private postRender;
|
|
619
|
+
private registerLazyLoadEvents;
|
|
620
|
+
private unregisterLazyLoadEvents;
|
|
561
621
|
/**
|
|
562
622
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
563
623
|
* @param renderOptions An object containing the page ID
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAGX,cAAc,EACd,kBAAkB,EACrB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,aAAa;IACnB;;OAEG;IACH,OAAO,YAAY;CACtB;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED,oBAAY,qBAAqB;IAC7B,aAAa,iBAAiB;IAC9B,SAAS,aAAa;IACtB,IAAI,SAAS;CAChB;AAED;;;GAGG;AACH,oBAAY,oBAAoB;IAC5B;;;;OAIG;IACH,OAAO,OAAO;CACjB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAChB;;;OAGG;IACH,OAAO,OAAO;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAGX,cAAc,EACd,kBAAkB,EACrB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,aAAa;IACnB;;OAEG;IACH,OAAO,YAAY;CACtB;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED,oBAAY,qBAAqB;IAC7B,aAAa,iBAAiB;IAC9B,SAAS,aAAa;IACtB,IAAI,SAAS;CAChB;AAED;;;GAGG;AACH,oBAAY,oBAAoB;IAC5B;;;;OAIG;IACH,OAAO,OAAO;CACjB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAChB;;;OAGG;IACH,OAAO,OAAO;CACjB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAChB;;;OAGG;IACH,IAAI,OAAO;IACX;;OAEG;IACH,iBAAiB,OAAO;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,QAAQ,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACrD;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0CAA0C,CAAC,EAAE,yCAAyC,CAAC;IACvF;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C;;;;;;;;;;;;;OAaG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C;;;;;;;;;;;;;;OAcG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAE/C;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAU;gBAGnB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAW/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAkKxB,OAAO,CAAC,0BAA0B,CAGjC;IAED;;;;;OAKG;IACH,OAAO,CAAC,qCAAqC,CAI5C;IAED;;;OAGG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAGlD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAqBzC;IAEF;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAsBpB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;OAUG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;OAGG;IACI,OAAO;IAKd,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,sBAAsB;IAQ9B,OAAO,CAAC,wBAAwB;IAOhC;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAS3C"}
|