@thoughtspot/visual-embed-sdk 1.32.0-alpha.1 → 1.33.0-alpha.1
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/README.md +21 -1
- package/cjs/package.json +6 -4
- package/cjs/src/embed/app.d.ts +7 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +24 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +30 -0
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +31 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/search.d.ts +14 -0
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +4 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +13 -0
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +7 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +12 -3
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +16 -3
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/types.d.ts +18 -8
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +4 -7
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/global-styles.d.ts +2 -0
- package/cjs/src/utils/global-styles.d.ts.map +1 -0
- package/cjs/src/utils/global-styles.js +44 -0
- package/cjs/src/utils/global-styles.js.map +1 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +9 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/preview-service.d.ts +3 -0
- package/cjs/src/utils/graphql/preview-service.d.ts.map +1 -0
- package/cjs/src/utils/graphql/preview-service.js +30 -0
- package/cjs/src/utils/graphql/preview-service.js.map +1 -0
- package/dist/src/embed/app.d.ts +7 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +24 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +14 -0
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +7 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +18 -8
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/global-styles.d.ts +2 -0
- package/dist/src/utils/global-styles.d.ts.map +1 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/src/utils/graphql/preview-service.d.ts +3 -0
- package/dist/src/utils/graphql/preview-service.d.ts.map +1 -0
- package/dist/tsembed-react.es.js +123 -12
- package/dist/tsembed-react.js +123 -12
- package/dist/tsembed.es.js +123 -12
- package/dist/tsembed.js +123 -12
- package/dist/visual-embed-sdk-react-full.d.ts +69 -10
- package/dist/visual-embed-sdk-react.d.ts +69 -10
- package/dist/visual-embed-sdk.d.ts +69 -10
- package/lib/package.json +6 -4
- package/lib/src/embed/app.d.ts +7 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +24 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +30 -0
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +31 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/search.d.ts +14 -0
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +4 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +13 -0
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +7 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +12 -3
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +16 -3
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/types.d.ts +18 -8
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +4 -7
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/global-styles.d.ts +2 -0
- package/lib/src/utils/global-styles.d.ts.map +1 -0
- package/lib/src/utils/global-styles.js +40 -0
- package/lib/src/utils/global-styles.js.map +1 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +9 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/preview-service.d.ts +3 -0
- package/lib/src/utils/graphql/preview-service.d.ts.map +1 -0
- package/lib/src/utils/graphql/preview-service.js +26 -0
- package/lib/src/utils/graphql/preview-service.js.map +1 -0
- package/lib/src/visual-embed-sdk.d.ts +69 -10
- package/package.json +6 -4
- package/src/embed/app.ts +13 -4
- package/src/embed/liveboard.spec.ts +34 -0
- package/src/embed/liveboard.ts +61 -1
- package/src/embed/search.spec.ts +17 -0
- package/src/embed/search.ts +19 -0
- package/src/embed/ts-embed.spec.ts +18 -3
- package/src/embed/ts-embed.ts +14 -4
- package/src/types.ts +31 -20
- package/src/utils/global-styles.ts +40 -0
- package/src/utils/graphql/answerService/answer-queries.ts +9 -0
- package/src/utils/graphql/preview-service.ts +31 -0
|
@@ -701,6 +701,20 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
701
701
|
* ```
|
|
702
702
|
*/
|
|
703
703
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
704
|
+
/**
|
|
705
|
+
* Flag to remove focus from search bar initially when user
|
|
706
|
+
* lands on search embed page.
|
|
707
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
|
|
708
|
+
* @default true
|
|
709
|
+
* @example
|
|
710
|
+
* ```js
|
|
711
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
712
|
+
* ... // other options
|
|
713
|
+
* focusSearchBarOnRender: false,
|
|
714
|
+
* });
|
|
715
|
+
* ```
|
|
716
|
+
*/
|
|
717
|
+
focusSearchBarOnRender?: boolean;
|
|
704
718
|
}
|
|
705
719
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
706
720
|
/**
|
|
@@ -977,7 +991,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
977
991
|
* Flag to control Data panel experience
|
|
978
992
|
* @default false
|
|
979
993
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
980
|
-
* @
|
|
994
|
+
* @example
|
|
995
|
+
* ```js
|
|
996
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
997
|
+
* ... // other options
|
|
998
|
+
* dataPanelV2: true,
|
|
999
|
+
* })
|
|
1000
|
+
* ```
|
|
981
1001
|
*/
|
|
982
1002
|
dataPanelV2?: boolean;
|
|
983
1003
|
/**
|
|
@@ -1393,6 +1413,29 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1393
1413
|
* ```
|
|
1394
1414
|
*/
|
|
1395
1415
|
enable2ColumnLayout?: boolean;
|
|
1416
|
+
/**
|
|
1417
|
+
* Show a preview image of the visualization before the visualization loads.
|
|
1418
|
+
* Only works for visualizations embeds with a viz id.
|
|
1419
|
+
*
|
|
1420
|
+
* Also, viz snashot should be enabled in the ThoughtSpot instance.
|
|
1421
|
+
* Contact ThoughtSpot support to enable this feature.
|
|
1422
|
+
*
|
|
1423
|
+
* Since, this will show preview images, be careful that it may show
|
|
1424
|
+
* undesired data to the user when using row level security.
|
|
1425
|
+
*
|
|
1426
|
+
* @example
|
|
1427
|
+
* ```js
|
|
1428
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1429
|
+
* liveboardId: 'liveboard-id',
|
|
1430
|
+
* vizId: 'viz-id',
|
|
1431
|
+
* showPreviewLoader: true,
|
|
1432
|
+
* });
|
|
1433
|
+
* embed.render();
|
|
1434
|
+
* ```
|
|
1435
|
+
*
|
|
1436
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1437
|
+
*/
|
|
1438
|
+
showPreviewLoader?: boolean;
|
|
1396
1439
|
}
|
|
1397
1440
|
/**
|
|
1398
1441
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -2793,6 +2836,19 @@ export interface ViewConfig {
|
|
|
2793
2836
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2794
2837
|
*/
|
|
2795
2838
|
excludeRuntimeParametersfromURL?: boolean;
|
|
2839
|
+
/**
|
|
2840
|
+
* Enable the V2 shell. This can provide performance benefits
|
|
2841
|
+
* due to a lighterweight shell.
|
|
2842
|
+
* @example
|
|
2843
|
+
* ```js
|
|
2844
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
2845
|
+
* liveboardId: '123',
|
|
2846
|
+
* enableV2Shell_experimental: true
|
|
2847
|
+
* });
|
|
2848
|
+
* ```
|
|
2849
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2850
|
+
*/
|
|
2851
|
+
enableV2Shell_experimental?: boolean;
|
|
2796
2852
|
}
|
|
2797
2853
|
/**
|
|
2798
2854
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -3044,11 +3100,6 @@ export declare enum EmbedEvent {
|
|
|
3044
3100
|
* @important
|
|
3045
3101
|
*/
|
|
3046
3102
|
Data = "data",
|
|
3047
|
-
/**
|
|
3048
|
-
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
3049
|
-
* @hidden
|
|
3050
|
-
*/
|
|
3051
|
-
FiltersChanged = "filtersChanged",
|
|
3052
3103
|
/**
|
|
3053
3104
|
* Search query has been updated by the user.
|
|
3054
3105
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
@@ -4844,7 +4895,8 @@ export declare enum Param {
|
|
|
4844
4895
|
CurrencyFormat = "currencyFormat",
|
|
4845
4896
|
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
4846
4897
|
IsFullAppEmbed = "isFullAppEmbed",
|
|
4847
|
-
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
4898
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
|
|
4899
|
+
FocusSearchBarOnRender = "focusSearchBarOnRender"
|
|
4848
4900
|
}
|
|
4849
4901
|
/**
|
|
4850
4902
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -5666,7 +5718,7 @@ export declare enum Action {
|
|
|
5666
5718
|
* disabledActions: [Action.ManageMonitor]
|
|
5667
5719
|
* ```
|
|
5668
5720
|
*/
|
|
5669
|
-
ManageMonitor = "
|
|
5721
|
+
ManageMonitor = "manageMonitor",
|
|
5670
5722
|
/**
|
|
5671
5723
|
* Action ID for Liveboard Personalised Views dropdown
|
|
5672
5724
|
* @example
|
|
@@ -5709,8 +5761,9 @@ export declare enum Action {
|
|
|
5709
5761
|
* ```js
|
|
5710
5762
|
* hiddenAction: [Action.CreateLiveboard]
|
|
5711
5763
|
* disabledActions: [Action.CreateLiveboard]
|
|
5764
|
+
* ```
|
|
5712
5765
|
*
|
|
5713
|
-
* @version SDK: 1.
|
|
5766
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
|
|
5714
5767
|
*/
|
|
5715
5768
|
CreateLiveboard = "CreateLiveboard",
|
|
5716
5769
|
/**
|
|
@@ -6496,7 +6549,7 @@ export declare class TsEmbed {
|
|
|
6496
6549
|
/**
|
|
6497
6550
|
* The DOM node where the ThoughtSpot app is to be embedded.
|
|
6498
6551
|
*/
|
|
6499
|
-
protected el:
|
|
6552
|
+
protected el: HTMLElement;
|
|
6500
6553
|
/**
|
|
6501
6554
|
* The key to store the embed instance in the DOM node
|
|
6502
6555
|
*/
|
|
@@ -6750,5 +6803,11 @@ export declare class V1Embed extends TsEmbed {
|
|
|
6750
6803
|
* ```
|
|
6751
6804
|
*/
|
|
6752
6805
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
|
|
6806
|
+
/**
|
|
6807
|
+
* Only for testing purposes.
|
|
6808
|
+
*
|
|
6809
|
+
* @hidden
|
|
6810
|
+
*/
|
|
6811
|
+
test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
|
|
6753
6812
|
}
|
|
6754
6813
|
|
|
@@ -691,6 +691,20 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
691
691
|
* ```
|
|
692
692
|
*/
|
|
693
693
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
694
|
+
/**
|
|
695
|
+
* Flag to remove focus from search bar initially when user
|
|
696
|
+
* lands on search embed page.
|
|
697
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
|
|
698
|
+
* @default true
|
|
699
|
+
* @example
|
|
700
|
+
* ```js
|
|
701
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
702
|
+
* ... // other options
|
|
703
|
+
* focusSearchBarOnRender: false,
|
|
704
|
+
* });
|
|
705
|
+
* ```
|
|
706
|
+
*/
|
|
707
|
+
focusSearchBarOnRender?: boolean;
|
|
694
708
|
}
|
|
695
709
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
696
710
|
/**
|
|
@@ -967,7 +981,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
967
981
|
* Flag to control Data panel experience
|
|
968
982
|
* @default false
|
|
969
983
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
970
|
-
* @
|
|
984
|
+
* @example
|
|
985
|
+
* ```js
|
|
986
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
987
|
+
* ... // other options
|
|
988
|
+
* dataPanelV2: true,
|
|
989
|
+
* })
|
|
990
|
+
* ```
|
|
971
991
|
*/
|
|
972
992
|
dataPanelV2?: boolean;
|
|
973
993
|
/**
|
|
@@ -1383,6 +1403,29 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1383
1403
|
* ```
|
|
1384
1404
|
*/
|
|
1385
1405
|
enable2ColumnLayout?: boolean;
|
|
1406
|
+
/**
|
|
1407
|
+
* Show a preview image of the visualization before the visualization loads.
|
|
1408
|
+
* Only works for visualizations embeds with a viz id.
|
|
1409
|
+
*
|
|
1410
|
+
* Also, viz snashot should be enabled in the ThoughtSpot instance.
|
|
1411
|
+
* Contact ThoughtSpot support to enable this feature.
|
|
1412
|
+
*
|
|
1413
|
+
* Since, this will show preview images, be careful that it may show
|
|
1414
|
+
* undesired data to the user when using row level security.
|
|
1415
|
+
*
|
|
1416
|
+
* @example
|
|
1417
|
+
* ```js
|
|
1418
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1419
|
+
* liveboardId: 'liveboard-id',
|
|
1420
|
+
* vizId: 'viz-id',
|
|
1421
|
+
* showPreviewLoader: true,
|
|
1422
|
+
* });
|
|
1423
|
+
* embed.render();
|
|
1424
|
+
* ```
|
|
1425
|
+
*
|
|
1426
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1427
|
+
*/
|
|
1428
|
+
showPreviewLoader?: boolean;
|
|
1386
1429
|
}
|
|
1387
1430
|
/**
|
|
1388
1431
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -2425,6 +2468,19 @@ export interface ViewConfig {
|
|
|
2425
2468
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2426
2469
|
*/
|
|
2427
2470
|
excludeRuntimeParametersfromURL?: boolean;
|
|
2471
|
+
/**
|
|
2472
|
+
* Enable the V2 shell. This can provide performance benefits
|
|
2473
|
+
* due to a lighterweight shell.
|
|
2474
|
+
* @example
|
|
2475
|
+
* ```js
|
|
2476
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
2477
|
+
* liveboardId: '123',
|
|
2478
|
+
* enableV2Shell_experimental: true
|
|
2479
|
+
* });
|
|
2480
|
+
* ```
|
|
2481
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2482
|
+
*/
|
|
2483
|
+
enableV2Shell_experimental?: boolean;
|
|
2428
2484
|
}
|
|
2429
2485
|
/**
|
|
2430
2486
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -2676,11 +2732,6 @@ export declare enum EmbedEvent {
|
|
|
2676
2732
|
* @important
|
|
2677
2733
|
*/
|
|
2678
2734
|
Data = "data",
|
|
2679
|
-
/**
|
|
2680
|
-
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
2681
|
-
* @hidden
|
|
2682
|
-
*/
|
|
2683
|
-
FiltersChanged = "filtersChanged",
|
|
2684
2735
|
/**
|
|
2685
2736
|
* Search query has been updated by the user.
|
|
2686
2737
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
@@ -4476,7 +4527,8 @@ export declare enum Param {
|
|
|
4476
4527
|
CurrencyFormat = "currencyFormat",
|
|
4477
4528
|
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
4478
4529
|
IsFullAppEmbed = "isFullAppEmbed",
|
|
4479
|
-
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
4530
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
|
|
4531
|
+
FocusSearchBarOnRender = "focusSearchBarOnRender"
|
|
4480
4532
|
}
|
|
4481
4533
|
/**
|
|
4482
4534
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -5298,7 +5350,7 @@ export declare enum Action {
|
|
|
5298
5350
|
* disabledActions: [Action.ManageMonitor]
|
|
5299
5351
|
* ```
|
|
5300
5352
|
*/
|
|
5301
|
-
ManageMonitor = "
|
|
5353
|
+
ManageMonitor = "manageMonitor",
|
|
5302
5354
|
/**
|
|
5303
5355
|
* Action ID for Liveboard Personalised Views dropdown
|
|
5304
5356
|
* @example
|
|
@@ -5341,8 +5393,9 @@ export declare enum Action {
|
|
|
5341
5393
|
* ```js
|
|
5342
5394
|
* hiddenAction: [Action.CreateLiveboard]
|
|
5343
5395
|
* disabledActions: [Action.CreateLiveboard]
|
|
5396
|
+
* ```
|
|
5344
5397
|
*
|
|
5345
|
-
* @version SDK: 1.
|
|
5398
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
|
|
5346
5399
|
*/
|
|
5347
5400
|
CreateLiveboard = "CreateLiveboard",
|
|
5348
5401
|
/**
|
|
@@ -5559,7 +5612,7 @@ export declare class TsEmbed {
|
|
|
5559
5612
|
/**
|
|
5560
5613
|
* The DOM node where the ThoughtSpot app is to be embedded.
|
|
5561
5614
|
*/
|
|
5562
|
-
protected el:
|
|
5615
|
+
protected el: HTMLElement;
|
|
5563
5616
|
/**
|
|
5564
5617
|
* The key to store the embed instance in the DOM node
|
|
5565
5618
|
*/
|
|
@@ -5813,6 +5866,12 @@ export declare class V1Embed extends TsEmbed {
|
|
|
5813
5866
|
* ```
|
|
5814
5867
|
*/
|
|
5815
5868
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
|
|
5869
|
+
/**
|
|
5870
|
+
* Only for testing purposes.
|
|
5871
|
+
*
|
|
5872
|
+
* @hidden
|
|
5873
|
+
*/
|
|
5874
|
+
test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
|
|
5816
5875
|
}
|
|
5817
5876
|
|
|
5818
5877
|
export interface executeTMLInput {
|
|
@@ -264,7 +264,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
264
264
|
* Flag to control Data panel experience
|
|
265
265
|
* @default false
|
|
266
266
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
267
|
-
* @
|
|
267
|
+
* @example
|
|
268
|
+
* ```js
|
|
269
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
270
|
+
* ... // other options
|
|
271
|
+
* dataPanelV2: true,
|
|
272
|
+
* })
|
|
273
|
+
* ```
|
|
268
274
|
*/
|
|
269
275
|
dataPanelV2?: boolean;
|
|
270
276
|
/**
|
|
@@ -812,6 +818,29 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
812
818
|
* ```
|
|
813
819
|
*/
|
|
814
820
|
enable2ColumnLayout?: boolean;
|
|
821
|
+
/**
|
|
822
|
+
* Show a preview image of the visualization before the visualization loads.
|
|
823
|
+
* Only works for visualizations embeds with a viz id.
|
|
824
|
+
*
|
|
825
|
+
* Also, viz snashot should be enabled in the ThoughtSpot instance.
|
|
826
|
+
* Contact ThoughtSpot support to enable this feature.
|
|
827
|
+
*
|
|
828
|
+
* Since, this will show preview images, be careful that it may show
|
|
829
|
+
* undesired data to the user when using row level security.
|
|
830
|
+
*
|
|
831
|
+
* @example
|
|
832
|
+
* ```js
|
|
833
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
834
|
+
* liveboardId: 'liveboard-id',
|
|
835
|
+
* vizId: 'viz-id',
|
|
836
|
+
* showPreviewLoader: true,
|
|
837
|
+
* });
|
|
838
|
+
* embed.render();
|
|
839
|
+
* ```
|
|
840
|
+
*
|
|
841
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
842
|
+
*/
|
|
843
|
+
showPreviewLoader?: boolean;
|
|
815
844
|
}
|
|
816
845
|
/**
|
|
817
846
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -1105,6 +1134,20 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1105
1134
|
* ```
|
|
1106
1135
|
*/
|
|
1107
1136
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1137
|
+
/**
|
|
1138
|
+
* Flag to remove focus from search bar initially when user
|
|
1139
|
+
* lands on search embed page.
|
|
1140
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
|
|
1141
|
+
* @default true
|
|
1142
|
+
* @example
|
|
1143
|
+
* ```js
|
|
1144
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
1145
|
+
* ... // other options
|
|
1146
|
+
* focusSearchBarOnRender: false,
|
|
1147
|
+
* });
|
|
1148
|
+
* ```
|
|
1149
|
+
*/
|
|
1150
|
+
focusSearchBarOnRender?: boolean;
|
|
1108
1151
|
}
|
|
1109
1152
|
export const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
1110
1153
|
/**
|
|
@@ -2419,6 +2462,19 @@ export interface ViewConfig {
|
|
|
2419
2462
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2420
2463
|
*/
|
|
2421
2464
|
excludeRuntimeParametersfromURL?: boolean;
|
|
2465
|
+
/**
|
|
2466
|
+
* Enable the V2 shell. This can provide performance benefits
|
|
2467
|
+
* due to a lighterweight shell.
|
|
2468
|
+
* @example
|
|
2469
|
+
* ```js
|
|
2470
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
2471
|
+
* liveboardId: '123',
|
|
2472
|
+
* enableV2Shell_experimental: true
|
|
2473
|
+
* });
|
|
2474
|
+
* ```
|
|
2475
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2476
|
+
*/
|
|
2477
|
+
enableV2Shell_experimental?: boolean;
|
|
2422
2478
|
}
|
|
2423
2479
|
/**
|
|
2424
2480
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -2670,11 +2726,6 @@ export enum EmbedEvent {
|
|
|
2670
2726
|
* @important
|
|
2671
2727
|
*/
|
|
2672
2728
|
Data = "data",
|
|
2673
|
-
/**
|
|
2674
|
-
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
2675
|
-
* @hidden
|
|
2676
|
-
*/
|
|
2677
|
-
FiltersChanged = "filtersChanged",
|
|
2678
2729
|
/**
|
|
2679
2730
|
* Search query has been updated by the user.
|
|
2680
2731
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
@@ -4470,7 +4521,8 @@ export enum Param {
|
|
|
4470
4521
|
CurrencyFormat = "currencyFormat",
|
|
4471
4522
|
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
4472
4523
|
IsFullAppEmbed = "isFullAppEmbed",
|
|
4473
|
-
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
4524
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
|
|
4525
|
+
FocusSearchBarOnRender = "focusSearchBarOnRender"
|
|
4474
4526
|
}
|
|
4475
4527
|
/**
|
|
4476
4528
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -5292,7 +5344,7 @@ export enum Action {
|
|
|
5292
5344
|
* disabledActions: [Action.ManageMonitor]
|
|
5293
5345
|
* ```
|
|
5294
5346
|
*/
|
|
5295
|
-
ManageMonitor = "
|
|
5347
|
+
ManageMonitor = "manageMonitor",
|
|
5296
5348
|
/**
|
|
5297
5349
|
* Action ID for Liveboard Personalised Views dropdown
|
|
5298
5350
|
* @example
|
|
@@ -5335,8 +5387,9 @@ export enum Action {
|
|
|
5335
5387
|
* ```js
|
|
5336
5388
|
* hiddenAction: [Action.CreateLiveboard]
|
|
5337
5389
|
* disabledActions: [Action.CreateLiveboard]
|
|
5390
|
+
* ```
|
|
5338
5391
|
*
|
|
5339
|
-
* @version SDK: 1.
|
|
5392
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
|
|
5340
5393
|
*/
|
|
5341
5394
|
CreateLiveboard = "CreateLiveboard",
|
|
5342
5395
|
/**
|
|
@@ -6268,7 +6321,7 @@ export class TsEmbed {
|
|
|
6268
6321
|
/**
|
|
6269
6322
|
* The DOM node where the ThoughtSpot app is to be embedded.
|
|
6270
6323
|
*/
|
|
6271
|
-
protected el:
|
|
6324
|
+
protected el: HTMLElement;
|
|
6272
6325
|
/**
|
|
6273
6326
|
* The key to store the embed instance in the DOM node
|
|
6274
6327
|
*/
|
|
@@ -6522,5 +6575,11 @@ export class V1Embed extends TsEmbed {
|
|
|
6522
6575
|
* ```
|
|
6523
6576
|
*/
|
|
6524
6577
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
|
|
6578
|
+
/**
|
|
6579
|
+
* Only for testing purposes.
|
|
6580
|
+
*
|
|
6581
|
+
* @hidden
|
|
6582
|
+
*/
|
|
6583
|
+
test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
|
|
6525
6584
|
}
|
|
6526
6585
|
|
package/lib/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@thoughtspot/visual-embed-sdk",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.33.0-alpha.1",
|
|
4
4
|
"description": "ThoughtSpot Embed SDK",
|
|
5
5
|
"module": "lib/src/index.js",
|
|
6
6
|
"main": "dist/tsembed.js",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"size-limit": [
|
|
39
39
|
{
|
|
40
40
|
"path": "dist/tsembed.js",
|
|
41
|
-
"limit": "
|
|
41
|
+
"limit": "48 kB"
|
|
42
42
|
}
|
|
43
43
|
],
|
|
44
44
|
"scripts": {
|
|
@@ -67,7 +67,8 @@
|
|
|
67
67
|
"prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
|
|
68
68
|
"check-size": "npm run build && size-limit",
|
|
69
69
|
"publish-dev": "npm publish --tag dev",
|
|
70
|
-
"publish-prod": "npm publish --tag latest"
|
|
70
|
+
"publish-prod": "npm publish --tag latest",
|
|
71
|
+
"dev": "vite -c vite.local.config.ts"
|
|
71
72
|
},
|
|
72
73
|
"peerDependencies": {
|
|
73
74
|
"react": "> 16.8.0",
|
|
@@ -157,7 +158,8 @@
|
|
|
157
158
|
"typedoc-plugin-toc-group": "thoughtspot/typedoc-plugin-toc-group",
|
|
158
159
|
"typescript": "^4.9.4",
|
|
159
160
|
"url-search-params-polyfill": "^8.1.0",
|
|
160
|
-
"util": "^0.12.4"
|
|
161
|
+
"util": "^0.12.4",
|
|
162
|
+
"vite": "^5.3.4"
|
|
161
163
|
},
|
|
162
164
|
"author": "ThoughtSpot",
|
|
163
165
|
"email": "support@thoughtspot.com",
|
package/lib/src/embed/app.d.ts
CHANGED
|
@@ -250,7 +250,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
250
250
|
* Flag to control Data panel experience
|
|
251
251
|
* @default false
|
|
252
252
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
253
|
-
* @
|
|
253
|
+
* @example
|
|
254
|
+
* ```js
|
|
255
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
256
|
+
* ... // other options
|
|
257
|
+
* dataPanelV2: true,
|
|
258
|
+
* })
|
|
259
|
+
* ```
|
|
254
260
|
*/
|
|
255
261
|
dataPanelV2?: boolean;
|
|
256
262
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAEX,UAAU,EAEV,cAAc,EACjB,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;CACtB;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB
|
|
1
|
+
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAEX,UAAU,EAEV,cAAc,EACjB,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;CACtB;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;;;;;OAiBG;IACH,0CAA0C,CAAC,EAAE,yCAAyC,CAAC;IACvF;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;CAClD;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;IAU/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAiGxB;;;OAGG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAKzC;IAEF;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;OAUG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAO3C"}
|
package/lib/src/embed/app.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EACH,KAAK,EAEL,SAAS,EAET,UAAU,GAEb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,IA6BX;AA7BD,WAAY,IAAI;IACZ;;OAEG;IACH,qBAAa,CAAA;IACb;;OAEG;IACH,yBAAiB,CAAA;IACjB;;OAEG;IACH,2BAAmB,CAAA;IACnB;;OAEG;IACH,iCAAyB,CAAA;IACzB;;OAEG;IACH,+BAAuB,CAAA;IACvB;;OAEG;IACH,qBAAa,CAAA;IACb;;OAEG;IACH,2BAAmB,CAAA;AACvB,CAAC,EA7BW,IAAI,KAAJ,IAAI,QA6Bf;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,yCAaX;AAbD,WAAY,yCAAyC;IACjD;;OAEG;IACH,sEAAyB,CAAA;IACzB;;OAEG;IACH,0EAA6B,CAAA;IAC7B;;OAEG;IACH,0EAA6B,CAAA;AACjC,CAAC,EAbW,yCAAyC,KAAzC,yCAAyC,QAapD;
|
|
1
|
+
{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EACH,KAAK,EAEL,SAAS,EAET,UAAU,GAEb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,IA6BX;AA7BD,WAAY,IAAI;IACZ;;OAEG;IACH,qBAAa,CAAA;IACb;;OAEG;IACH,yBAAiB,CAAA;IACjB;;OAEG;IACH,2BAAmB,CAAA;IACnB;;OAEG;IACH,iCAAyB,CAAA;IACzB;;OAEG;IACH,+BAAuB,CAAA;IACvB;;OAEG;IACH,qBAAa,CAAA;IACb;;OAEG;IACH,2BAAmB,CAAA;AACvB,CAAC,EA7BW,IAAI,KAAJ,IAAI,QA6Bf;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,yCAaX;AAbD,WAAY,yCAAyC;IACjD;;OAEG;IACH,sEAAyB,CAAA;IACzB;;OAEG;IACH,0EAA6B,CAAA;IAC7B;;OAEG;IACH,0EAA6B,CAAA;AACjC,CAAC,EAbW,yCAAyC,KAAzC,yCAAyC,QAapD;AA0UD;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,OAAO;IAKjC,kDAAkD;IAClD,YAAY,WAAwB,EAAE,UAAyB;QAC3D,UAAU,CAAC,kBAAkB,GAAG,UAAU,CAAC;QAC3C,KAAK,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAL3B,kBAAa,GAAG,MAAM,CAAC;QAiI/B;;;;WAIG;QACO,uBAAkB,GAAG,CAAC,IAAoB,EAAE,EAAE;;YACpD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAA,IAAI,CAAC,MAAM,0CAAE,YAAY,CAAC,CAAC,CAAC;QACzE,CAAC,CAAC;QAEM,sBAAiB,GAAG,CAAC,IAAoB,EAAE,SAAc,EAAE,EAAE;YACjE,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YACnC,SAAS,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,iBAAiB,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;QACjE,CAAC,CAAC;QAEM,wCAAmC,GAAG,CAAC,IAAoB,EAAE,EAAE;YACnE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,IAAI,EAAE,CAAC;YACjF,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;gBACjD,IAAI,CAAC,eAAe,CAAC,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC;aAC3D;QACL,CAAC,CAAC;QA9IE,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,KAAK,IAAI,EAAE;YACrC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,mCAAmC,CAAC,CAAC;YAC1E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACzD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;SACjE;IACL,CAAC;IAED;;;OAGG;IACO,cAAc;QACpB,MAAM,EACF,GAAG,EACH,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,WAAW,GAAG,KAAK,EACnB,mBAAmB,GAAG,KAAK,EAC3B,kBAAkB,GAAG,IAAI,EACzB,wBAAwB,GAAG,IAAI,EAC/B,mBAAmB,GAAG,KAAK,EAC3B,qBAAqB,GAAG,KAAK,EAC7B,uBAAuB,GAAG,IAAI,EAC9B,aAAa,EACb,0BAA0B,GAAG,KAAK,EAClC,mBAAmB,EACnB,wBAAwB,GAAG,KAAK,EAChC,oCAAoC,GAAG,KAAK;QAC5C,sCAAsC;QACtC,0CAA0C,GAAG,yCAAyC,CAAC,UAAU,GACpG,GAAG,IAAI,CAAC,UAAU,CAAC;QAEpB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,iBAAiB,CAAC;QACpD,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC;QAC1D,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,uBAAuB,CAAC;QAClE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,eAAe,CAAC;QAClD,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;QACtD,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,wBAAwB,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAAG,uBAAuB,CAAC;QAC9D,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;QAEpC,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEzC,IAAI,UAAU,KAAK,IAAI,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;SACnC;QAED,IAAI,GAAG,EAAE;YACL,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SAC3B;QACD,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,EAAE;YACnC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;SAC3D;QACD,IAAI,WAAW,KAAK,SAAS,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAC;SAClD;QAED,IAAI,kBAAkB,KAAK,SAAS,EAAE;YAClC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;SACzD;QAED,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC;SAC3D;QAED,IAAI,aAAa,EAAE;YACf,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC;SAC/C;QAED,IAAI,oCAAoC,EAAE;YACtC,sCAAsC;YACtC,MAAM,CACF,KAAK,CAAC,oCAAoC,CAC7C,GAAG,oCAAoC,CAAC;SAC5C;QAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,GAAG,qBAAqB,CAAC;QACnE,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,GAAG,0BAA0B,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,GAAG,wBAAwB,CAAC;QAClE,IAAI,0CAA0C;gBACtC,yCAAyC,CAAC,YAAY;eACvD,0CAA0C;oBACzC,yCAAyC,CAAC,YAAY,EAC5D;YACE,sCAAsC;YACtC,MAAM,CACF,KAAK,CAAC,0CAA0C,CACnD,GAAG,0CAA0C,CAAC;SAClD;aAAM;YACH,sCAAsC;YACtC,MAAM,CAAC,KAAK,CAAC,0CAA0C,CAAC,GAAG,yCAAyC,CAAC,UAAU,CAAC;SACnH;QACD,MAAM,WAAW,GAAG,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAEtD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,YAAY;QACf,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;QAChE,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC5F,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,gBAAgB,EAAE,IAAI,SAAS,EAAE,CAAC;QAEpD,MAAM,gBAAgB,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC;QAC5D,GAAG,GAAG,GAAG,GAAG,GAAG,gBAAgB,EAAE,CAAC;QAElC,OAAO,GAAG,CAAC;IACf,CAAC;IAuBD;;;;OAIG;IACK,YAAY,CAAC,MAAY,EAAE,qBAAqB,GAAG,KAAK;QAC5D,QAAQ,MAAM,EAAE;YACZ,KAAK,IAAI,CAAC,MAAM;gBACZ,OAAO,QAAQ,CAAC;YACpB,KAAK,IAAI,CAAC,OAAO;gBACb,OAAO,qBAAqB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,KAAK,IAAI,CAAC,UAAU;gBAChB,OAAO,qBAAqB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,WAAW,CAAC;YACnE,KAAK,IAAI,CAAC,SAAS;gBACf,OAAO,qBAAqB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,WAAW,CAAC;YACnE,KAAK,IAAI,CAAC,IAAI;gBACV,OAAO,aAAa,CAAC;YACzB,KAAK,IAAI,CAAC,MAAM;gBACZ,OAAO,qBAAqB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,kBAAkB,CAAC;YAC/E,KAAK,IAAI,CAAC,IAAI,CAAC;YACf;gBACI,OAAO,MAAM,CAAC;SACrB;IACL,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,IAAY;QAC3B,IAAI,CAAC,IAAI,EAAE;YACP,OAAO,IAAI,CAAC;SACf;QAED,uBAAuB;QACvB,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YACzB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAC5B;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;OAUG;IACI,cAAc,CAAC,IAAqB,EAAE,QAAQ,GAAG,KAAK;QACzD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;YAC7D,OAAO;SACV;QACD,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SAC1C;aAAM;YACH,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC1B,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;gBACzE,OAAO;aACV;YACD,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;YAClC,MAAM,SAAS,GAAG,SAAS,CAAC;YAC5B,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC;YACpE,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI,IAAI,CAAC,OAAO,CAC9E,UAAU,EACV,EAAE,CACL,EAAE,CAAC;SACP;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM;QACf,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAChC,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAE9B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
|
|
@@ -242,6 +242,29 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
242
242
|
* ```
|
|
243
243
|
*/
|
|
244
244
|
enable2ColumnLayout?: boolean;
|
|
245
|
+
/**
|
|
246
|
+
* Show a preview image of the visualization before the visualization loads.
|
|
247
|
+
* Only works for visualizations embeds with a viz id.
|
|
248
|
+
*
|
|
249
|
+
* Also, viz snashot should be enabled in the ThoughtSpot instance.
|
|
250
|
+
* Contact ThoughtSpot support to enable this feature.
|
|
251
|
+
*
|
|
252
|
+
* Since, this will show preview images, be careful that it may show
|
|
253
|
+
* undesired data to the user when using row level security.
|
|
254
|
+
*
|
|
255
|
+
* @example
|
|
256
|
+
* ```js
|
|
257
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
258
|
+
* liveboardId: 'liveboard-id',
|
|
259
|
+
* vizId: 'viz-id',
|
|
260
|
+
* showPreviewLoader: true,
|
|
261
|
+
* });
|
|
262
|
+
* embed.render();
|
|
263
|
+
* ```
|
|
264
|
+
*
|
|
265
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
266
|
+
*/
|
|
267
|
+
showPreviewLoader?: boolean;
|
|
245
268
|
}
|
|
246
269
|
/**
|
|
247
270
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -282,6 +305,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
282
305
|
private embedIframeCenter;
|
|
283
306
|
private setIframeHeightForNonEmbedLiveboard;
|
|
284
307
|
private setActiveTab;
|
|
308
|
+
private showPreviewLoader;
|
|
285
309
|
protected beforePrerenderVisible(): void;
|
|
286
310
|
protected handleRenderForPrerender(): void;
|
|
287
311
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["../../../src/embed/liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;
|
|
1
|
+
{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["../../../src/embed/liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,UAAU,EACb,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC;;;GAGG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,0BAA0B,CAClF;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;OAWG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IAUrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAwExB,OAAO,CAAC,kBAAkB;IAa1B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAcpB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAQzC;IAEF,OAAO,CAAC,YAAY;YAQN,iBAAiB;IAkC/B,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAcxC,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAQ1C;;;;OAIG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpE;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;IAUvC,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAavF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAI"}
|
|
@@ -7,10 +7,12 @@
|
|
|
7
7
|
* @summary Liveboard & visualization embed
|
|
8
8
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
9
9
|
*/
|
|
10
|
+
import { getPreview } from '../utils/graphql/preview-service';
|
|
10
11
|
import { ERROR_MESSAGE } from '../errors';
|
|
11
12
|
import { EmbedEvent, Param, HostEvent, } from '../types';
|
|
12
13
|
import { getQueryParamString, isUndefined } from '../utils';
|
|
13
14
|
import { V1Embed } from './ts-embed';
|
|
15
|
+
import { addPreviewStylesIfNotPresent } from '../utils/global-styles';
|
|
14
16
|
/**
|
|
15
17
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
16
18
|
* waits for the authentication to complete, so you need not wait for
|
|
@@ -144,6 +146,33 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
144
146
|
super.trigger(HostEvent.Navigate, path);
|
|
145
147
|
}
|
|
146
148
|
}
|
|
149
|
+
async showPreviewLoader() {
|
|
150
|
+
if (!this.viewConfig.showPreviewLoader || !this.viewConfig.vizId) {
|
|
151
|
+
return;
|
|
152
|
+
}
|
|
153
|
+
try {
|
|
154
|
+
const preview = await getPreview(this.thoughtSpotHost, this.viewConfig.vizId, this.viewConfig.liveboardId);
|
|
155
|
+
if (!preview.vizContent) {
|
|
156
|
+
return;
|
|
157
|
+
}
|
|
158
|
+
addPreviewStylesIfNotPresent();
|
|
159
|
+
const div = document.createElement('div');
|
|
160
|
+
div.innerHTML = `
|
|
161
|
+
<div class=ts-viz-preview-loader>
|
|
162
|
+
${preview.vizContent}
|
|
163
|
+
</div>
|
|
164
|
+
`;
|
|
165
|
+
const previewDiv = div.firstElementChild;
|
|
166
|
+
this.el.appendChild(previewDiv);
|
|
167
|
+
this.el.style.position = 'relative';
|
|
168
|
+
this.on(EmbedEvent.Data, () => {
|
|
169
|
+
previewDiv.remove();
|
|
170
|
+
});
|
|
171
|
+
}
|
|
172
|
+
catch (error) {
|
|
173
|
+
console.error('Error fetching preview', error);
|
|
174
|
+
}
|
|
175
|
+
}
|
|
147
176
|
beforePrerenderVisible() {
|
|
148
177
|
var _a;
|
|
149
178
|
const embedObj = (_a = this.insertedDomEl) === null || _a === void 0 ? void 0 : _a[this.embedNodeKey];
|
|
@@ -188,6 +217,7 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
188
217
|
super.render();
|
|
189
218
|
const src = this.getIFrameSrc();
|
|
190
219
|
await this.renderV1Embed(src);
|
|
220
|
+
this.showPreviewLoader();
|
|
191
221
|
return this;
|
|
192
222
|
}
|
|
193
223
|
navigateToLiveboard(liveboardId, vizId, activeTabId) {
|