@thoughtspot/visual-embed-sdk 1.17.0-alpha.0 → 1.17.0-alpha.2
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/dist/src/embed/base.d.ts +1 -1
- package/dist/src/embed/ts-embed.d.ts +2 -8
- package/dist/src/test/test-utils.d.ts +4 -0
- package/dist/src/types.d.ts +105 -10
- package/dist/src/utils.d.ts +7 -1
- package/dist/tsembed.es.js +1099 -17069
- package/dist/tsembed.js +1099 -17069
- package/lib/package.json +2 -2
- package/lib/src/auth.js +11 -6
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +11 -3
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/embed/app.spec.js +2 -6
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -1
- package/lib/src/embed/base.js +24 -6
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +33 -0
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +3 -6
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/pinboard.spec.js +3 -6
- package/lib/src/embed/pinboard.spec.js.map +1 -1
- package/lib/src/embed/search.spec.js +1 -3
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +2 -8
- package/lib/src/embed/ts-embed.js +12 -18
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +23 -4
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.spec.js +2 -2
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/test/test-utils.d.ts +4 -0
- package/lib/src/test/test-utils.js +19 -1
- package/lib/src/test/test-utils.js.map +1 -1
- package/lib/src/types.d.ts +105 -10
- package/lib/src/types.js +89 -7
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils.d.ts +7 -1
- package/lib/src/utils.js +10 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +108 -13
- package/package.json +2 -2
- package/src/auth.spec.ts +11 -3
- package/src/auth.ts +20 -10
- package/src/embed/app.spec.ts +4 -4
- package/src/embed/base.spec.ts +38 -0
- package/src/embed/base.ts +33 -6
- package/src/embed/liveboard.spec.ts +4 -4
- package/src/embed/pinboard.spec.ts +4 -4
- package/src/embed/search.spec.ts +1 -1
- package/src/embed/ts-embed.spec.ts +27 -6
- package/src/embed/ts-embed.ts +16 -18
- package/src/react/index.spec.tsx +2 -2
- package/src/test/test-utils.ts +21 -2
- package/src/types.ts +103 -7
- package/src/utils.ts +12 -0
package/lib/src/types.d.ts
CHANGED
|
@@ -15,23 +15,52 @@ export declare enum AuthType {
|
|
|
15
15
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
|
|
16
16
|
*/
|
|
17
17
|
None = "None",
|
|
18
|
+
/**
|
|
19
|
+
* Passthrough SSO to the embedded App within the iframe. Requires least configuration, but may not
|
|
20
|
+
* be supported by all IDPs. This will behave like `None` if SSO is not configured on ThoughtSpot.
|
|
21
|
+
* @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
|
|
22
|
+
*/
|
|
23
|
+
EmbeddedSSO = "EmbeddedSSO",
|
|
18
24
|
/**
|
|
19
25
|
* SSO using SAML
|
|
20
|
-
* @deprecated Use {@link
|
|
26
|
+
* @deprecated Use {@link SAMLRedirect} instead
|
|
27
|
+
* @hidden
|
|
21
28
|
*/
|
|
22
29
|
SSO = "SSO_SAML",
|
|
23
30
|
/**
|
|
24
31
|
* SSO using SAML
|
|
32
|
+
* @deprecated Use {@link SAMLRedirect} instead
|
|
33
|
+
* @hidden
|
|
25
34
|
*/
|
|
26
35
|
SAML = "SSO_SAML",
|
|
36
|
+
/**
|
|
37
|
+
* SSO using SAML
|
|
38
|
+
* Will make the host application redirect to the SAML Idp.
|
|
39
|
+
*/
|
|
40
|
+
SAMLRedirect = "SSO_SAML",
|
|
27
41
|
/**
|
|
28
42
|
* SSO using OIDC
|
|
43
|
+
* @hidden
|
|
44
|
+
* @deprecated Use {@link OIDCRedirect} instead
|
|
29
45
|
*/
|
|
30
46
|
OIDC = "SSO_OIDC",
|
|
47
|
+
/**
|
|
48
|
+
* SSO using OIDC
|
|
49
|
+
* Will make the host application redirect to the OIDC Idp.
|
|
50
|
+
*/
|
|
51
|
+
OIDCRedirect = "SSO_OIDC",
|
|
31
52
|
/**
|
|
32
53
|
* Trusted authentication server
|
|
54
|
+
* @hidden
|
|
55
|
+
* @deprecated Use {@link TrustedAuth} instead
|
|
33
56
|
*/
|
|
34
57
|
AuthServer = "AuthServer",
|
|
58
|
+
/**
|
|
59
|
+
* Trusted authentication server, Use you own authentication server
|
|
60
|
+
* which returns a bearer token, generated using the secret_key obtained from
|
|
61
|
+
* ThoughtSpot.
|
|
62
|
+
*/
|
|
63
|
+
TrustedAuthToken = "AuthServer",
|
|
35
64
|
/**
|
|
36
65
|
* Use the ThoughtSpot login API to authenticate to the cluster directly.
|
|
37
66
|
*
|
|
@@ -198,6 +227,20 @@ export interface EmbedConfig {
|
|
|
198
227
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
|
|
199
228
|
*/
|
|
200
229
|
customisations?: CustomisationsInterface;
|
|
230
|
+
/**
|
|
231
|
+
* For noRedirect SSO Auth, we need a button which the user
|
|
232
|
+
* click to trigger the flow. This is the containing element
|
|
233
|
+
* for that button.
|
|
234
|
+
*
|
|
235
|
+
* @version SDK: 1.17.0 | ThoughtSpot: *
|
|
236
|
+
*/
|
|
237
|
+
authTriggerContainer?: string | HTMLElement;
|
|
238
|
+
/**
|
|
239
|
+
* Text to show in the button which triggers the popup auth flow.
|
|
240
|
+
* Default: "Authorize".
|
|
241
|
+
* @version SDK: 1.17.0 | ThoughtSpot: *
|
|
242
|
+
*/
|
|
243
|
+
authTriggerText?: string;
|
|
201
244
|
}
|
|
202
245
|
/**
|
|
203
246
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -624,16 +667,25 @@ export declare enum EmbedEvent {
|
|
|
624
667
|
export declare enum HostEvent {
|
|
625
668
|
/**
|
|
626
669
|
* Trigger a search
|
|
627
|
-
* @param dataSourceIds - The list of data source GUIDs
|
|
628
|
-
* @param searchQuery - The search query
|
|
670
|
+
* @param - dataSourceIds - The list of data source GUIDs
|
|
671
|
+
* @param - searchQuery - The search query
|
|
672
|
+
* @example
|
|
673
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
674
|
+
* searchQuery: "[sales] by [item type],
|
|
675
|
+
* "dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
|
|
676
|
+
* })
|
|
629
677
|
*/
|
|
630
678
|
Search = "search",
|
|
631
679
|
/**
|
|
632
680
|
* Trigger a drill on certain points by certain column
|
|
633
|
-
* @param points - an object containing selectedPoints/clickedPoints
|
|
681
|
+
* @param - points - an object containing selectedPoints/clickedPoints
|
|
634
682
|
* eg. { selectedPoints: []}
|
|
635
|
-
* @param columnGuid - a string guid of the column to drill by. This is optional,
|
|
683
|
+
* @param - columnGuid - a string guid of the column to drill by. This is optional,
|
|
636
684
|
* if not provided it will auto drill by the configured column.
|
|
685
|
+
* @example searchEmbed.trigger(HostEvent.DrillDown, {
|
|
686
|
+
* points: clickedPointData,
|
|
687
|
+
* autoDrillDown: true,
|
|
688
|
+
* })
|
|
637
689
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
638
690
|
*/
|
|
639
691
|
DrillDown = "triggerDrillDown",
|
|
@@ -651,6 +703,8 @@ export declare enum HostEvent {
|
|
|
651
703
|
* Set the visible visualizations on a Liveboard.
|
|
652
704
|
* @param - an array of ids of visualizations to show, the ids not passed
|
|
653
705
|
* will be hidden.
|
|
706
|
+
* @example
|
|
707
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['730496d6-6903-4601-937e-2c691821af3c', 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
654
708
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
655
709
|
*/
|
|
656
710
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
@@ -658,18 +712,25 @@ export declare enum HostEvent {
|
|
|
658
712
|
* Update the runtime filters. The runtime filters passed here are extended
|
|
659
713
|
* on to the existing runtime filters if they exist.
|
|
660
714
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
715
|
+
* @example
|
|
716
|
+
* liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
|
|
717
|
+
* {columnName: "state",operator: "EQ",values: ["michigan"]},
|
|
718
|
+
* {columnName: "item type",operator: "EQ",values: ["Jackets"]}
|
|
719
|
+
* ])
|
|
661
720
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
662
721
|
*/
|
|
663
722
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
664
723
|
/**
|
|
665
724
|
* Navigate to a specific page in App embed without any reload.
|
|
666
725
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
667
|
-
* @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
726
|
+
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
727
|
+
* @example appEmbed.navigateToPage(-1)
|
|
668
728
|
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
|
|
669
729
|
*/
|
|
670
730
|
Navigate = "Navigate",
|
|
671
731
|
/**
|
|
672
732
|
* Gets the current pinboard content.
|
|
733
|
+
* @example liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
|
|
673
734
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
674
735
|
*/
|
|
675
736
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
@@ -677,70 +738,82 @@ export declare enum HostEvent {
|
|
|
677
738
|
* Triggers the Pin action on an embedded object
|
|
678
739
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
679
740
|
* can be left empty for search and visualization embeds
|
|
741
|
+
* @example liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
680
742
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
681
743
|
*/
|
|
682
744
|
Pin = "pin",
|
|
683
745
|
/**
|
|
684
746
|
* Triggers the Show Liveboard details action on a Liveboard
|
|
747
|
+
* @example liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
685
748
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
686
749
|
*/
|
|
687
750
|
LiveboardInfo = "pinboardInfo",
|
|
688
751
|
/**
|
|
689
752
|
* Triggers the Schedule action on a Liveboard
|
|
753
|
+
* @example liveboardEmbed.trigger(HostEvent.Schedule)
|
|
690
754
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
691
755
|
*/
|
|
692
756
|
Schedule = "subscription",
|
|
693
757
|
/**
|
|
694
758
|
* Triggers the Manage schedule action on a Liveboard
|
|
759
|
+
* @example liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
695
760
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
696
761
|
*/
|
|
697
762
|
SchedulesList = "schedule-list",
|
|
698
763
|
/**
|
|
699
764
|
* Triggers the Export TML action on a Liveboard
|
|
765
|
+
* @example liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
700
766
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
701
767
|
*/
|
|
702
768
|
ExportTML = "exportTSL",
|
|
703
769
|
/**
|
|
704
770
|
* Triggers the Edit TML action on a Liveboard
|
|
771
|
+
* @example liveboardEmbed.trigger(HostEvent.EditTML)
|
|
705
772
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
706
773
|
*/
|
|
707
774
|
EditTML = "editTSL",
|
|
708
775
|
/**
|
|
709
776
|
* Triggers the Update TML action on a Liveboard
|
|
777
|
+
* @example liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
710
778
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
711
779
|
*/
|
|
712
780
|
UpdateTML = "updateTSL",
|
|
713
781
|
/**
|
|
714
782
|
* Triggers the Download PDF action on a Liveboard
|
|
783
|
+
* @example liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
|
|
715
784
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
716
785
|
*/
|
|
717
786
|
DownloadAsPdf = "downloadAsPdf",
|
|
718
787
|
/**
|
|
719
788
|
* Triggers the Make a copy action on a Liveboard
|
|
789
|
+
* @example liveboardEmbed.trigger(HostEvent.MakeACopy)
|
|
720
790
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
721
791
|
*/
|
|
722
792
|
MakeACopy = "makeACopy",
|
|
723
793
|
/**
|
|
724
794
|
* Triggers the Delete action on a Liveboard
|
|
795
|
+
* @example appEmbed.trigger(HostEvent.Remove)
|
|
725
796
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
726
797
|
*/
|
|
727
798
|
Remove = "delete",
|
|
728
799
|
/**
|
|
729
800
|
* Triggers the Explore action on a visualization
|
|
730
801
|
* @param - an object with vizId as a key
|
|
731
|
-
*
|
|
802
|
+
* @example liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
732
803
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
733
804
|
*/
|
|
734
805
|
Explore = "explore",
|
|
735
806
|
/**
|
|
736
807
|
* Triggers the Create alert action on a visualization
|
|
737
808
|
* @param - an object with vizId as a key
|
|
809
|
+
* @example liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
738
810
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
739
811
|
*/
|
|
740
812
|
CreateMonitor = "createMonitor",
|
|
741
813
|
/**
|
|
742
814
|
* Triggers the Manage alert action on a visualization
|
|
743
815
|
* @param - an object with vizId as a key
|
|
816
|
+
* @example liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
744
817
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
745
818
|
*/
|
|
746
819
|
ManageMonitor = "manageMonitor",
|
|
@@ -776,9 +849,26 @@ export declare enum HostEvent {
|
|
|
776
849
|
Present = "present",
|
|
777
850
|
/**
|
|
778
851
|
* Get TML for the current search.
|
|
852
|
+
* @example searchEmbed.trigger(HostEvent.GetTML)
|
|
779
853
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
|
|
780
854
|
*/
|
|
781
|
-
GetTML = "getTML"
|
|
855
|
+
GetTML = "getTML",
|
|
856
|
+
/**
|
|
857
|
+
* Triggers the Share action on a liveboard or answer
|
|
858
|
+
* @example
|
|
859
|
+
* liveboardEmbed.trigger(HostEvent.Share)
|
|
860
|
+
* searchEmbed.trigger(HostEvent.Share)
|
|
861
|
+
* @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
|
|
862
|
+
*/
|
|
863
|
+
Share = "share",
|
|
864
|
+
/**
|
|
865
|
+
* Trigger the Save action on a liveboard or answer
|
|
866
|
+
* @example
|
|
867
|
+
* liveboardEmbed.trigger(HostEvent.Save)
|
|
868
|
+
* searchEmbed.trigger(HostEvent.Save)
|
|
869
|
+
* @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
|
|
870
|
+
*/
|
|
871
|
+
Save = "save"
|
|
782
872
|
}
|
|
783
873
|
/**
|
|
784
874
|
* The different visual modes that the data sources panel within
|
|
@@ -834,7 +924,9 @@ export declare enum Param {
|
|
|
834
924
|
LiveboardV2Enabled = "isPinboardV2Enabled",
|
|
835
925
|
ShowAlerts = "showAlerts",
|
|
836
926
|
Locale = "locale",
|
|
837
|
-
CustomStyle = "customStyle"
|
|
927
|
+
CustomStyle = "customStyle",
|
|
928
|
+
ForceSAMLAutoRedirect = "forceSAMLAutoRedirect",
|
|
929
|
+
AuthType = "authType"
|
|
838
930
|
}
|
|
839
931
|
/**
|
|
840
932
|
* The list of actions that can be performed on visual ThoughtSpot
|
|
@@ -978,7 +1070,10 @@ export declare enum Action {
|
|
|
978
1070
|
/**
|
|
979
1071
|
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
980
1072
|
*/
|
|
981
|
-
ReportError = "reportError"
|
|
1073
|
+
ReportError = "reportError",
|
|
1074
|
+
SyncToSheets = "sync-to-sheets",
|
|
1075
|
+
SyncToOtherApps = "sync-to-other-apps",
|
|
1076
|
+
ManagePipelines = "manage-pipeline"
|
|
982
1077
|
}
|
|
983
1078
|
export interface SessionInterface {
|
|
984
1079
|
sessionId: string;
|
package/lib/src/types.js
CHANGED
|
@@ -17,23 +17,52 @@ export var AuthType;
|
|
|
17
17
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
|
|
18
18
|
*/
|
|
19
19
|
AuthType["None"] = "None";
|
|
20
|
+
/**
|
|
21
|
+
* Passthrough SSO to the embedded App within the iframe. Requires least configuration, but may not
|
|
22
|
+
* be supported by all IDPs. This will behave like `None` if SSO is not configured on ThoughtSpot.
|
|
23
|
+
* @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
|
|
24
|
+
*/
|
|
25
|
+
AuthType["EmbeddedSSO"] = "EmbeddedSSO";
|
|
20
26
|
/**
|
|
21
27
|
* SSO using SAML
|
|
22
|
-
* @deprecated Use {@link
|
|
28
|
+
* @deprecated Use {@link SAMLRedirect} instead
|
|
29
|
+
* @hidden
|
|
23
30
|
*/
|
|
24
31
|
AuthType["SSO"] = "SSO_SAML";
|
|
25
32
|
/**
|
|
26
33
|
* SSO using SAML
|
|
34
|
+
* @deprecated Use {@link SAMLRedirect} instead
|
|
35
|
+
* @hidden
|
|
27
36
|
*/
|
|
28
37
|
AuthType["SAML"] = "SSO_SAML";
|
|
38
|
+
/**
|
|
39
|
+
* SSO using SAML
|
|
40
|
+
* Will make the host application redirect to the SAML Idp.
|
|
41
|
+
*/
|
|
42
|
+
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
29
43
|
/**
|
|
30
44
|
* SSO using OIDC
|
|
45
|
+
* @hidden
|
|
46
|
+
* @deprecated Use {@link OIDCRedirect} instead
|
|
31
47
|
*/
|
|
32
48
|
AuthType["OIDC"] = "SSO_OIDC";
|
|
49
|
+
/**
|
|
50
|
+
* SSO using OIDC
|
|
51
|
+
* Will make the host application redirect to the OIDC Idp.
|
|
52
|
+
*/
|
|
53
|
+
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
33
54
|
/**
|
|
34
55
|
* Trusted authentication server
|
|
56
|
+
* @hidden
|
|
57
|
+
* @deprecated Use {@link TrustedAuth} instead
|
|
35
58
|
*/
|
|
36
59
|
AuthType["AuthServer"] = "AuthServer";
|
|
60
|
+
/**
|
|
61
|
+
* Trusted authentication server, Use you own authentication server
|
|
62
|
+
* which returns a bearer token, generated using the secret_key obtained from
|
|
63
|
+
* ThoughtSpot.
|
|
64
|
+
*/
|
|
65
|
+
AuthType["TrustedAuthToken"] = "AuthServer";
|
|
37
66
|
/**
|
|
38
67
|
* Use the ThoughtSpot login API to authenticate to the cluster directly.
|
|
39
68
|
*
|
|
@@ -425,16 +454,25 @@ export var HostEvent;
|
|
|
425
454
|
(function (HostEvent) {
|
|
426
455
|
/**
|
|
427
456
|
* Trigger a search
|
|
428
|
-
* @param dataSourceIds - The list of data source GUIDs
|
|
429
|
-
* @param searchQuery - The search query
|
|
457
|
+
* @param - dataSourceIds - The list of data source GUIDs
|
|
458
|
+
* @param - searchQuery - The search query
|
|
459
|
+
* @example
|
|
460
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
461
|
+
* searchQuery: "[sales] by [item type],
|
|
462
|
+
* "dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
|
|
463
|
+
* })
|
|
430
464
|
*/
|
|
431
465
|
HostEvent["Search"] = "search";
|
|
432
466
|
/**
|
|
433
467
|
* Trigger a drill on certain points by certain column
|
|
434
|
-
* @param points - an object containing selectedPoints/clickedPoints
|
|
468
|
+
* @param - points - an object containing selectedPoints/clickedPoints
|
|
435
469
|
* eg. { selectedPoints: []}
|
|
436
|
-
* @param columnGuid - a string guid of the column to drill by. This is optional,
|
|
470
|
+
* @param - columnGuid - a string guid of the column to drill by. This is optional,
|
|
437
471
|
* if not provided it will auto drill by the configured column.
|
|
472
|
+
* @example searchEmbed.trigger(HostEvent.DrillDown, {
|
|
473
|
+
* points: clickedPointData,
|
|
474
|
+
* autoDrillDown: true,
|
|
475
|
+
* })
|
|
438
476
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
439
477
|
*/
|
|
440
478
|
HostEvent["DrillDown"] = "triggerDrillDown";
|
|
@@ -452,6 +490,8 @@ export var HostEvent;
|
|
|
452
490
|
* Set the visible visualizations on a Liveboard.
|
|
453
491
|
* @param - an array of ids of visualizations to show, the ids not passed
|
|
454
492
|
* will be hidden.
|
|
493
|
+
* @example
|
|
494
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['730496d6-6903-4601-937e-2c691821af3c', 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
455
495
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
456
496
|
*/
|
|
457
497
|
HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
|
|
@@ -459,18 +499,25 @@ export var HostEvent;
|
|
|
459
499
|
* Update the runtime filters. The runtime filters passed here are extended
|
|
460
500
|
* on to the existing runtime filters if they exist.
|
|
461
501
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
502
|
+
* @example
|
|
503
|
+
* liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
|
|
504
|
+
* {columnName: "state",operator: "EQ",values: ["michigan"]},
|
|
505
|
+
* {columnName: "item type",operator: "EQ",values: ["Jackets"]}
|
|
506
|
+
* ])
|
|
462
507
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
463
508
|
*/
|
|
464
509
|
HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
|
|
465
510
|
/**
|
|
466
511
|
* Navigate to a specific page in App embed without any reload.
|
|
467
512
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
468
|
-
* @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
513
|
+
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
514
|
+
* @example appEmbed.navigateToPage(-1)
|
|
469
515
|
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
|
|
470
516
|
*/
|
|
471
517
|
HostEvent["Navigate"] = "Navigate";
|
|
472
518
|
/**
|
|
473
519
|
* Gets the current pinboard content.
|
|
520
|
+
* @example liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
|
|
474
521
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
475
522
|
*/
|
|
476
523
|
HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
|
|
@@ -478,70 +525,82 @@ export var HostEvent;
|
|
|
478
525
|
* Triggers the Pin action on an embedded object
|
|
479
526
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
480
527
|
* can be left empty for search and visualization embeds
|
|
528
|
+
* @example liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
481
529
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
482
530
|
*/
|
|
483
531
|
HostEvent["Pin"] = "pin";
|
|
484
532
|
/**
|
|
485
533
|
* Triggers the Show Liveboard details action on a Liveboard
|
|
534
|
+
* @example liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
486
535
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
487
536
|
*/
|
|
488
537
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
489
538
|
/**
|
|
490
539
|
* Triggers the Schedule action on a Liveboard
|
|
540
|
+
* @example liveboardEmbed.trigger(HostEvent.Schedule)
|
|
491
541
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
492
542
|
*/
|
|
493
543
|
HostEvent["Schedule"] = "subscription";
|
|
494
544
|
/**
|
|
495
545
|
* Triggers the Manage schedule action on a Liveboard
|
|
546
|
+
* @example liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
496
547
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
497
548
|
*/
|
|
498
549
|
HostEvent["SchedulesList"] = "schedule-list";
|
|
499
550
|
/**
|
|
500
551
|
* Triggers the Export TML action on a Liveboard
|
|
552
|
+
* @example liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
501
553
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
502
554
|
*/
|
|
503
555
|
HostEvent["ExportTML"] = "exportTSL";
|
|
504
556
|
/**
|
|
505
557
|
* Triggers the Edit TML action on a Liveboard
|
|
558
|
+
* @example liveboardEmbed.trigger(HostEvent.EditTML)
|
|
506
559
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
507
560
|
*/
|
|
508
561
|
HostEvent["EditTML"] = "editTSL";
|
|
509
562
|
/**
|
|
510
563
|
* Triggers the Update TML action on a Liveboard
|
|
564
|
+
* @example liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
511
565
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
512
566
|
*/
|
|
513
567
|
HostEvent["UpdateTML"] = "updateTSL";
|
|
514
568
|
/**
|
|
515
569
|
* Triggers the Download PDF action on a Liveboard
|
|
570
|
+
* @example liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
|
|
516
571
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
517
572
|
*/
|
|
518
573
|
HostEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
519
574
|
/**
|
|
520
575
|
* Triggers the Make a copy action on a Liveboard
|
|
576
|
+
* @example liveboardEmbed.trigger(HostEvent.MakeACopy)
|
|
521
577
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
522
578
|
*/
|
|
523
579
|
HostEvent["MakeACopy"] = "makeACopy";
|
|
524
580
|
/**
|
|
525
581
|
* Triggers the Delete action on a Liveboard
|
|
582
|
+
* @example appEmbed.trigger(HostEvent.Remove)
|
|
526
583
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
527
584
|
*/
|
|
528
585
|
HostEvent["Remove"] = "delete";
|
|
529
586
|
/**
|
|
530
587
|
* Triggers the Explore action on a visualization
|
|
531
588
|
* @param - an object with vizId as a key
|
|
532
|
-
*
|
|
589
|
+
* @example liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
533
590
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
534
591
|
*/
|
|
535
592
|
HostEvent["Explore"] = "explore";
|
|
536
593
|
/**
|
|
537
594
|
* Triggers the Create alert action on a visualization
|
|
538
595
|
* @param - an object with vizId as a key
|
|
596
|
+
* @example liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
539
597
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
540
598
|
*/
|
|
541
599
|
HostEvent["CreateMonitor"] = "createMonitor";
|
|
542
600
|
/**
|
|
543
601
|
* Triggers the Manage alert action on a visualization
|
|
544
602
|
* @param - an object with vizId as a key
|
|
603
|
+
* @example liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
545
604
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
546
605
|
*/
|
|
547
606
|
HostEvent["ManageMonitor"] = "manageMonitor";
|
|
@@ -577,9 +636,26 @@ export var HostEvent;
|
|
|
577
636
|
HostEvent["Present"] = "present";
|
|
578
637
|
/**
|
|
579
638
|
* Get TML for the current search.
|
|
639
|
+
* @example searchEmbed.trigger(HostEvent.GetTML)
|
|
580
640
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
|
|
581
641
|
*/
|
|
582
642
|
HostEvent["GetTML"] = "getTML";
|
|
643
|
+
/**
|
|
644
|
+
* Triggers the Share action on a liveboard or answer
|
|
645
|
+
* @example
|
|
646
|
+
* liveboardEmbed.trigger(HostEvent.Share)
|
|
647
|
+
* searchEmbed.trigger(HostEvent.Share)
|
|
648
|
+
* @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
|
|
649
|
+
*/
|
|
650
|
+
HostEvent["Share"] = "share";
|
|
651
|
+
/**
|
|
652
|
+
* Trigger the Save action on a liveboard or answer
|
|
653
|
+
* @example
|
|
654
|
+
* liveboardEmbed.trigger(HostEvent.Save)
|
|
655
|
+
* searchEmbed.trigger(HostEvent.Save)
|
|
656
|
+
* @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
|
|
657
|
+
*/
|
|
658
|
+
HostEvent["Save"] = "save";
|
|
583
659
|
})(HostEvent || (HostEvent = {}));
|
|
584
660
|
/**
|
|
585
661
|
* The different visual modes that the data sources panel within
|
|
@@ -640,6 +716,9 @@ export var Param;
|
|
|
640
716
|
Param["ShowAlerts"] = "showAlerts";
|
|
641
717
|
Param["Locale"] = "locale";
|
|
642
718
|
Param["CustomStyle"] = "customStyle";
|
|
719
|
+
Param["ForceSAMLAutoRedirect"] = "forceSAMLAutoRedirect";
|
|
720
|
+
// eslint-disable-next-line @typescript-eslint/no-shadow
|
|
721
|
+
Param["AuthType"] = "authType";
|
|
643
722
|
})(Param || (Param = {}));
|
|
644
723
|
/**
|
|
645
724
|
* The list of actions that can be performed on visual ThoughtSpot
|
|
@@ -786,6 +865,9 @@ export var Action;
|
|
|
786
865
|
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
787
866
|
*/
|
|
788
867
|
Action["ReportError"] = "reportError";
|
|
868
|
+
Action["SyncToSheets"] = "sync-to-sheets";
|
|
869
|
+
Action["SyncToOtherApps"] = "sync-to-other-apps";
|
|
870
|
+
Action["ManagePipelines"] = "manage-pipeline";
|
|
789
871
|
})(Action || (Action = {}));
|
|
790
872
|
// eslint-disable-next-line no-shadow
|
|
791
873
|
export var OperationType;
|
package/lib/src/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,QA0DX;AA1DD,WAAY,QAAQ;IAChB;;OAEG;IACH,yBAAa,CAAA;IACb;;;;OAIG;IACH,uCAA2B,CAAA;IAC3B;;;;OAIG;IACH,4BAAgB,CAAA;IAChB;;;;OAIG;IACH,6BAAiB,CAAA;IACjB;;;OAGG;IACH,qCAAyB,CAAA;IACzB;;;;OAIG;IACH,6BAAiB,CAAA;IACjB;;;OAGG;IACH,qCAAyB,CAAA;IACzB;;;;OAIG;IACH,qCAAyB,CAAA;IACzB;;;;OAIG;IACH,2CAA+B,CAAA;IAC/B;;;;;OAKG;IACH,2BAAe,CAAA;AACnB,CAAC,EA1DW,QAAQ,KAAR,QAAQ,QA0DnB;AA0OD;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,eAyDX;AAzDD,WAAY,eAAe;IACvB;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,wCAAqB,CAAA;IACrB;;OAEG;IACH,8CAA2B,CAAA;IAC3B;;OAEG;IACH,0CAAuB,CAAA;IACvB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;AACb,CAAC,EAzDW,eAAe,KAAf,eAAe,QAyD1B;AAsBD;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,UA8SX;AA9SD,WAAY,UAAU;IAClB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,mCAAqB,CAAA;IACrB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,+CAAiC,CAAA;IACjC;;OAEG;IACH,2CAA6B,CAAA;IAC7B;;;;;OAKG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,uDAAyC,CAAA;IACzC;;;;OAIG;IACH,mDAAqC,CAAA;IACrC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;;;OAIG;IACH,yDAA2C,CAAA;IAC3C;;;;OAIG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,6BAAe,CAAA;IACf;;;OAGG;IACH,6BAAe,CAAA;IACf;;OAEG;IACH,mDAAqC,CAAA;IACrC;;;OAGG;IACH,oDAAsC,CAAA;IACtC;;;OAGG;IACH,kDAAoC,CAAA;IACpC;;;;OAIG;IACH,0CAA4B,CAAA;IAC5B;;;;OAIG;IACH,qDAAuC,CAAA;IACvC;;OAEG;IACH,0CAA4B,CAAA;IAC5B;;;OAGG;IACH,8CAAgC,CAAA;IAChC;;;;;OAKG;IACH,+CAAiC,CAAA;IACjC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;;OAGG;IACH,wCAA0B,CAAA;IAC1B;;;OAGG;IACH,0CAA4B,CAAA;IAC5B;;;;;OAKG;IACH,oDAAsC,CAAA;IACtC;;;;OAIG;IACH,uBAAS,CAAA;IACT;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,mCAAqB,CAAA;IACrB;;;OAGG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,+CAAiC,CAAA;IACjC;;;OAGG;IACH,2CAA6B,CAAA;IAC7B;;;OAGG;IACH,yBAAW,CAAA;IACX;;;OAGG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,6BAAe,CAAA;IACf;;;OAGG;IACH,wDAA0C,CAAA;IAC1C;;;OAGG;IACH,wDAA0C,CAAA;IAC1C;;;OAGG;IACH,qEAAuD,CAAA;IACvD;;;OAGG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,iCAAmB,CAAA;IACnB;;;OAGG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,uCAAyB,CAAA;IACzB;;;OAGG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,uDAAyC,CAAA;IACzC;;;OAGG;IACH,yDAA2C,CAAA;IAC3C;;;OAGG;IACH,kCAAoB,CAAA;IACpB;;;OAGG;IACH,4CAA8B,CAAA;IAC9B;;;OAGG;IACH,+CAAiC,CAAA;IACjC;;;OAGG;IACH,uCAAyB,CAAA;IACzB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,iCAAmB,CAAA;IACnB;;;OAGG;IACH,+BAAiB,CAAA;IACjB;;;OAGG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,+BAAiB,CAAA;IACjB;;;OAGG;IACH,iCAAmB,CAAA;IACnB;;;OAGG;IACH,wCAA0B,CAAA;AAC9B,CAAC,EA9SW,UAAU,KAAV,UAAU,QA8SrB;AAED;;;;;;GAMG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,SA6MX;AA7MD,WAAY,SAAS;IACjB;;;;;;;;;OASG;IACH,8BAAiB,CAAA;IACjB;;;;;;;;;;;OAWG;IACH,2CAA8B,CAAA;IAC9B;;;OAGG;IACH,8BAAiB,CAAA;IACjB;;;OAGG;IACH,8BAAiB,CAAA;IACjB;;;;;;;OAOG;IACH,sDAAyC,CAAA;IACzC;;;;;;;;;;OAUG;IACH,0DAA6C,CAAA;IAC7C;;;;;;OAMG;IACH,kCAAqB,CAAA;IACrB;;;;OAIG;IACH,sFAAyE,CAAA;IACzE;;;;;;OAMG;IACH,wBAAW,CAAA;IACX;;;;OAIG;IACH,2CAA8B,CAAA;IAC9B;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B;;;;OAIG;IACH,oCAAuB,CAAA;IACvB;;;;OAIG;IACH,gCAAmB,CAAA;IACnB;;;;OAIG;IACH,oCAAuB,CAAA;IACvB;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B;;;;OAIG;IACH,oCAAuB,CAAA;IACvB;;;;OAIG;IACH,8BAAiB,CAAA;IACjB;;;;;OAKG;IACH,gCAAmB,CAAA;IACnB;;;;;OAKG;IACH,4CAA+B,CAAA;IAC/B;;;;;OAKG;IACH,4CAA+B,CAAA;IAC/B;;;;;;;;OAQG;IACH,0BAAa,CAAA;IACb;;;;;;;;OAQG;IACH,uCAA0B,CAAA;IAC1B;;;;;;;;OAQG;IACH,gCAAmB,CAAA;IACnB;;;;OAIG;IACH,8BAAiB,CAAA;IACjB;;;;;;OAMG;IACH,4BAAe,CAAA;IACf;;;;;;OAMG;IACH,0BAAa,CAAA;AACjB,CAAC,EA7MW,SAAS,KAAT,SAAS,QA6MpB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,oBAaX;AAbD,WAAY,oBAAoB;IAC5B;;OAEG;IACH,uCAAe,CAAA;IACf;;OAEG;IACH,8CAAsB,CAAA;IACtB;;OAEG;IACH,2CAAmB,CAAA;AACvB,CAAC,EAbW,oBAAoB,KAApB,oBAAoB,QAa/B;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,KAoCX;AApCD,WAAY,KAAK;IACb,oCAA2B,CAAA;IAC3B,0CAAiC,CAAA;IACjC,yCAAgC,CAAA;IAChC,4CAAmC,CAAA;IACnC,kCAAyB,CAAA;IACzB,uEAA8D,CAAA;IAC9D,oCAA2B,CAAA;IAC3B,mCAA0B,CAAA;IAC1B,oCAA2B,CAAA;IAC3B,kCAAyB,CAAA;IACzB,wDAA+C,CAAA;IAC/C,kDAAyC,CAAA;IACzC,kCAAyB,CAAA;IACzB,6DAAoD,CAAA;IACpD,oBAAW,CAAA;IACX,gDAAuC,CAAA;IACvC,wCAA+B,CAAA;IAC/B,4CAAmC,CAAA;IACnC,6CAAoC,CAAA;IACpC,sCAA6B,CAAA;IAC7B,gCAAuB,CAAA;IACvB,+BAAsB,CAAA;IACtB,0CAAiC,CAAA;IACjC,wCAA+B,CAAA;IAC/B,yCAAgC,CAAA;IAChC,sCAA6B,CAAA;IAC7B,sDAA6C,CAAA;IAC7C,4CAAmC,CAAA;IACnC,mDAA0C,CAAA;IAC1C,kCAAyB,CAAA;IACzB,0BAAiB,CAAA;IACjB,oCAA2B,CAAA;IAC3B,wDAA+C,CAAA;IAC/C,wDAAwD;IACxD,8BAAqB,CAAA;AACzB,CAAC,EApCW,KAAK,KAAL,KAAK,QAoChB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,MA8IX;AA9ID,WAAY,MAAM;IACd,uBAAa,CAAA;IACb;;OAEG;IACH,2BAAiB,CAAA;IACjB;;OAEG;IACH,uCAA6B,CAAA;IAC7B,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,oCAA0B,CAAA;IAC1B;;OAEG;IACH,qCAA2B,CAAA;IAC3B,mCAAyB,CAAA;IACzB,yCAA+B,CAAA;IAC/B,yBAAe,CAAA;IACf,iCAAuB,CAAA;IACvB,6CAAmC,CAAA;IACnC;;OAEG;IACH,mCAAyB,CAAA;IACzB;;OAEG;IACH,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B;;OAEG;IACH,2CAAiC,CAAA;IACjC;;OAEG;IACH,uCAA6B,CAAA;IAC7B,+BAAqB,CAAA;IACrB;;OAEG;IACH,uCAA6B,CAAA;IAC7B,mDAAyC,CAAA;IACzC,+BAAqB,CAAA;IACrB,yCAA+B,CAAA;IAC/B,yCAA+B,CAAA;IAC/B,2CAAiC,CAAA;IACjC;;OAEG;IACH,yCAA+B,CAAA;IAC/B,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;IACnB,mCAAyB,CAAA;IACzB,uBAAa,CAAA;IACb,iCAAuB,CAAA;IACvB,2BAAiB,CAAA;IACjB;;OAEG;IACH,6BAAmB,CAAA;IACnB;;OAEG;IACH,+BAAqB,CAAA;IACrB;;OAEG;IACH,2BAAiB,CAAA;IACjB;;OAEG;IACH,mDAAyC,CAAA;IACzC;;OAEG;IACH,uCAA6B,CAAA;IAC7B,wCAA8B,CAAA;IAC9B;;OAEG;IACH,6CAAmC,CAAA;IACnC;;OAEG;IACH,2DAAiD,CAAA;IACjD,qBAAW,CAAA;IACX;;OAEG;IACH,uCAA6B,CAAA;IAC7B,uCAA6B,CAAA;IAC7B,6BAAmB,CAAA;IACnB,oDAA0C,CAAA;IAC1C,oDAA0C,CAAA;IAC1C,iEAAuD,CAAA;IACvD,yDAA+C,CAAA;IAC/C;;OAEG;IACH,8CAAoC,CAAA;IACpC,wDAA8C,CAAA;IAC9C,mDAAyC,CAAA;IACzC;;OAEG;IACH,6BAAmB,CAAA;IACnB,yCAA+B,CAAA;IAC/B,qDAA2C,CAAA;IAC3C;;OAEG;IACH,yCAA+B,CAAA;IAC/B;;OAEG;IACH,qDAA2C,CAAA;IAC3C;;OAEG;IACH,2CAAiC,CAAA;IACjC;;OAEG;IACH,qCAA2B,CAAA;IAC3B;;OAEG;IACH,yCAA+B,CAAA;IAC/B;;OAEG;IACH,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,gDAAsC,CAAA;IACtC,6CAAmC,CAAA;AACvC,CAAC,EA9IW,MAAM,KAAN,MAAM,QA8IjB;AAQD,qCAAqC;AACrC,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,sDAAqC,CAAA;IACrC,sEAAqD,CAAA;AACzD,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAMD,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IACxB,uCAAmB,CAAA;IACnB,+CAA2B,CAAA;IAC3B,qDAAiC,CAAA;IACjC,yCAAqB,CAAA;AACzB,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B"}
|
package/lib/src/utils.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* @summary Utils
|
|
7
7
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
8
8
|
*/
|
|
9
|
-
import { EmbedConfig, QueryParams, RuntimeFilter, CustomisationsInterface } from './types';
|
|
9
|
+
import { EmbedConfig, QueryParams, RuntimeFilter, CustomisationsInterface, DOMSelector } from './types';
|
|
10
10
|
/**
|
|
11
11
|
* Construct a runtime filters query string from the given filters.
|
|
12
12
|
* Refer to the following docs for more details on runtime filter syntax:
|
|
@@ -44,3 +44,9 @@ export declare const setAttributes: (element: HTMLElement, attributes: {
|
|
|
44
44
|
}) => void;
|
|
45
45
|
export declare const checkReleaseVersionInBeta: (releaseVersion: string, suppressBetaWarning: boolean) => boolean;
|
|
46
46
|
export declare const getCustomisations: (embedConfig: EmbedConfig) => CustomisationsInterface;
|
|
47
|
+
/**
|
|
48
|
+
* Gets a reference to the DOM node given
|
|
49
|
+
* a selector.
|
|
50
|
+
* @param domSelector
|
|
51
|
+
*/
|
|
52
|
+
export declare function getDOMNode(domSelector: DOMSelector): HTMLElement;
|
package/lib/src/utils.js
CHANGED
|
@@ -142,4 +142,14 @@ export const getCustomisations = (embedConfig) => {
|
|
|
142
142
|
customisations.style.customCSSUrl || customCssUrl;
|
|
143
143
|
return customisations;
|
|
144
144
|
};
|
|
145
|
+
/**
|
|
146
|
+
* Gets a reference to the DOM node given
|
|
147
|
+
* a selector.
|
|
148
|
+
* @param domSelector
|
|
149
|
+
*/
|
|
150
|
+
export function getDOMNode(domSelector) {
|
|
151
|
+
return typeof domSelector === 'string'
|
|
152
|
+
? document.querySelector(domSelector)
|
|
153
|
+
: domSelector;
|
|
154
|
+
}
|
|
145
155
|
//# sourceMappingURL=utils.js.map
|
package/lib/src/utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAUH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,cAA+B,EAAU,EAAE;IACtE,IAAI,cAAc,IAAI,cAAc,CAAC,MAAM,EAAE;QACzC,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE;YACtD,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;YAC7B,MAAM,UAAU,GAAG,EAAE,CAAC;YACtB,UAAU,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;YACpD,UAAU,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjD,UAAU,CAAC,IAAI,CACX,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CACjE,CAAC;YAEF,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;KACjC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc,GAAG,CAAC,KAAU,EAAE,EAAE;IAClC,mCAAmC;IACnC,IACI,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,SAAS,EAC5B;QACE,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,CACjC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAC/B,WAAwB,EACxB,0BAA0B,GAAG,KAAK,EAC5B,EAAE;IACR,MAAM,EAAE,GAAa,EAAE,CAAC;IACxB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,GAAG,KAAK,SAAS,EAAE;YACnB,MAAM,eAAe,GAAG,0BAA0B;gBAC9C,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC;gBACrB,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACzB,EAAE,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,eAAe,EAAE,CAAC,CAAC;SACxC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,EAAE,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACvB;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAU,EAAE;IAC9D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3B,OAAO,GAAG,KAAK,IAAI,CAAC;KACvB;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,cAAsB,EAAE,EAAE;IACnE,IAAI,SAAS,GAAG,GAAG,CAAC;IACpB,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAE7D,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACvB,SAAS,GAAG,GAAG,SAAS,GAAG,iBAAiB,EAAE,CAAC;KAClD;SAAM;QACH,SAAS,GAAG,GAAG,SAAS,IAAI,iBAAiB,EAAE,CAAC;KACnD;IAED,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,cAAsB,EAAE,IAAI,GAAG,EAAE;IACzE,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC;IAC1E,OAAO,eAAe,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC/D,IAAI,CAAC,WAAW,EAAE;QACd,OAAO,WAAW,CAAC;KACtB;IACD,OAAO,IAAI,CAAC,WAAW,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAY,EAAE,EAAE;IACzC,MAAM,IAAI,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAC7C,OAAO,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;CACb,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CACzB,OAAoB,EACpB,UAAwD,EACpD,EAAE;IACN,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACpC,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAEpE,4CAA4C;AAC5C,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACrC,cAAsB,EACtB,mBAA4B,EACrB,EAAE;IACT,IAAI,cAAc,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE;QAC1D,MAAM,sBAAsB,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,YAAY,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,aAAa,GAAG,YAAY,GAAG,CAAC,CAAC;QACvC,OAAO,CAAC,mBAAmB,IAAI,aAAa,CAAC;KAChD;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC7B,WAAwB,EACD,EAAE;IACzB,MAAM,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC;IACrC,IAAI,EAAE,cAAc,EAAE,GAAG,WAAW,CAAC;IACrC,cAAc,GAAG,cAAc,IAAK,EAA8B,CAAC;IACnE,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;IAClD,cAAc,CAAC,KAAK,CAAC,YAAY;QAC7B,cAAc,CAAC,KAAK,CAAC,YAAY,IAAI,YAAY,CAAC;IACtD,OAAO,cAAc,CAAC;AAC1B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,WAAwB;IAC/C,OAAO,OAAO,WAAW,KAAK,QAAQ;QAClC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC;QACrC,CAAC,CAAC,WAAW,CAAC;AACtB,CAAC"}
|