@icepanel/sdk 0.1.2 → 0.1.6
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 +1 -1
- package/dist/cjs/BaseClient.d.ts +7 -9
- package/dist/cjs/BaseClient.js +8 -3
- package/dist/cjs/Client.d.ts +2 -2
- package/dist/cjs/Client.js +1 -1
- package/dist/cjs/IcePanelClient.d.ts +7 -8
- package/dist/cjs/IcePanelClient.js +11 -11
- package/dist/cjs/api/requests/requests.d.ts +62 -142
- package/dist/cjs/api/resources/catalog/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/catalog/client/Client.js +1 -1
- package/dist/cjs/api/resources/catalog/resources/technologies/client/Client.d.ts +2 -71
- package/dist/cjs/api/resources/catalog/resources/technologies/client/Client.js +5 -262
- package/dist/cjs/api/resources/catalog/resources/technologies/types/types.d.ts +0 -12
- package/dist/cjs/api/resources/comments/client/Client.d.ts +7 -5
- package/dist/cjs/api/resources/comments/client/Client.js +25 -28
- package/dist/cjs/api/resources/comments/resources/replies/client/Client.d.ts +5 -3
- package/dist/cjs/api/resources/comments/resources/replies/client/Client.js +23 -26
- package/dist/cjs/api/resources/diagrams/client/Client.d.ts +4 -3
- package/dist/cjs/api/resources/diagrams/client/Client.js +31 -32
- package/dist/cjs/api/resources/diagrams/resources/content/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/diagrams/resources/content/client/Client.js +10 -7
- package/dist/cjs/api/resources/diagrams/resources/export/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/diagrams/resources/export/client/Client.js +7 -5
- package/dist/cjs/api/resources/diagrams/resources/groups/client/Client.d.ts +6 -4
- package/dist/cjs/api/resources/diagrams/resources/groups/client/Client.js +27 -29
- package/dist/cjs/api/resources/domains/client/Client.d.ts +5 -3
- package/dist/cjs/api/resources/domains/client/Client.js +26 -28
- package/dist/cjs/api/resources/drafts/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/drafts/client/Client.js +22 -15
- package/dist/cjs/api/resources/flows/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/flows/client/Client.js +28 -19
- package/dist/cjs/api/resources/flows/resources/export/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/flows/resources/export/client/Client.js +10 -7
- package/dist/cjs/api/resources/landscapes/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/landscapes/client/Client.js +19 -13
- package/dist/cjs/api/resources/landscapes/resources/export/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/landscapes/resources/export/client/Client.js +7 -5
- package/dist/cjs/api/resources/landscapes/resources/logs/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/landscapes/resources/logs/client/Client.js +10 -7
- package/dist/cjs/api/resources/landscapes/resources/logs/resources/stats/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/landscapes/resources/logs/resources/stats/client/Client.js +7 -5
- package/dist/cjs/api/resources/model/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/model/client/Client.js +1 -1
- package/dist/cjs/api/resources/model/resources/connections/client/Client.d.ts +28 -5
- package/dist/cjs/api/resources/model/resources/connections/client/Client.js +95 -17
- package/dist/cjs/api/resources/model/resources/connections/resources/export/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/model/resources/connections/resources/export/client/Client.js +6 -4
- package/dist/cjs/api/resources/model/resources/connections/types/types.d.ts +6 -0
- package/dist/cjs/api/resources/model/resources/objects/client/Client.d.ts +6 -4
- package/dist/cjs/api/resources/model/resources/objects/client/Client.js +24 -27
- package/dist/cjs/api/resources/model/resources/objects/resources/export/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/model/resources/objects/resources/export/client/Client.js +9 -6
- package/dist/cjs/api/resources/organizations/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/client/Client.js +16 -11
- package/dist/cjs/api/resources/organizations/resources/landscapes/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/resources/landscapes/client/Client.js +7 -5
- package/dist/cjs/api/resources/organizations/resources/logs/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/resources/logs/client/Client.js +7 -5
- package/dist/cjs/api/resources/organizations/resources/logs/resources/stats/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/resources/logs/resources/stats/client/Client.js +7 -5
- package/dist/cjs/api/resources/organizations/resources/technologies/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/resources/technologies/client/Client.js +16 -11
- package/dist/cjs/api/resources/organizations/resources/users/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/resources/users/client/Client.js +10 -7
- package/dist/cjs/api/resources/organizations/resources/users/resources/invites/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/resources/users/resources/invites/client/Client.js +10 -7
- package/dist/cjs/api/resources/shareLink/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/shareLink/client/Client.js +13 -9
- package/dist/cjs/api/resources/tags/client/Client.d.ts +8 -6
- package/dist/cjs/api/resources/tags/client/Client.js +26 -29
- package/dist/cjs/api/resources/tags/resources/groups/client/Client.d.ts +7 -5
- package/dist/cjs/api/resources/tags/resources/groups/client/Client.js +25 -28
- package/dist/cjs/api/resources/teams/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/teams/client/Client.js +22 -15
- package/dist/cjs/api/resources/versions/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/versions/client/Client.js +16 -11
- package/dist/cjs/api/resources/versions/resources/reverts/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/versions/resources/reverts/client/Client.js +13 -9
- package/dist/cjs/api/types/types.d.ts +187 -1487
- package/dist/cjs/api/types/types.js +14 -329
- package/dist/cjs/auth/AnyAuthProvider.d.ts +23 -0
- package/dist/cjs/auth/AnyAuthProvider.js +46 -0
- package/dist/cjs/auth/BearerAuthProvider.d.ts +23 -0
- package/dist/cjs/auth/BearerAuthProvider.js +82 -0
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +17 -10
- package/dist/cjs/auth/HeaderAuthProvider.js +22 -9
- package/dist/cjs/auth/index.d.ts +2 -0
- package/dist/cjs/auth/index.js +5 -1
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +2 -2
- package/dist/cjs/environments.d.ts +2 -2
- package/dist/cjs/environments.js +1 -1
- package/dist/cjs/helpers/index.d.ts +1 -1
- package/dist/cjs/helpers/index.js +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +7 -9
- package/dist/esm/BaseClient.mjs +8 -3
- package/dist/esm/Client.d.mts +2 -2
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/IcePanelClient.d.mts +7 -8
- package/dist/esm/IcePanelClient.mjs +10 -10
- package/dist/esm/api/requests/requests.d.mts +62 -142
- package/dist/esm/api/resources/catalog/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/catalog/client/Client.mjs +2 -2
- package/dist/esm/api/resources/catalog/resources/technologies/client/Client.d.mts +2 -71
- package/dist/esm/api/resources/catalog/resources/technologies/client/Client.mjs +6 -263
- package/dist/esm/api/resources/catalog/resources/technologies/types/types.d.mts +0 -12
- package/dist/esm/api/resources/comments/client/Client.d.mts +7 -5
- package/dist/esm/api/resources/comments/client/Client.mjs +26 -29
- package/dist/esm/api/resources/comments/resources/replies/client/Client.d.mts +5 -3
- package/dist/esm/api/resources/comments/resources/replies/client/Client.mjs +24 -27
- package/dist/esm/api/resources/diagrams/client/Client.d.mts +4 -3
- package/dist/esm/api/resources/diagrams/client/Client.mjs +32 -33
- package/dist/esm/api/resources/diagrams/resources/content/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/diagrams/resources/content/client/Client.mjs +11 -8
- package/dist/esm/api/resources/diagrams/resources/export/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/diagrams/resources/export/client/Client.mjs +8 -6
- package/dist/esm/api/resources/diagrams/resources/groups/client/Client.d.mts +6 -4
- package/dist/esm/api/resources/diagrams/resources/groups/client/Client.mjs +28 -30
- package/dist/esm/api/resources/domains/client/Client.d.mts +5 -3
- package/dist/esm/api/resources/domains/client/Client.mjs +27 -29
- package/dist/esm/api/resources/drafts/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/drafts/client/Client.mjs +23 -16
- package/dist/esm/api/resources/flows/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/flows/client/Client.mjs +29 -20
- package/dist/esm/api/resources/flows/resources/export/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/flows/resources/export/client/Client.mjs +11 -8
- package/dist/esm/api/resources/landscapes/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/landscapes/client/Client.mjs +20 -14
- package/dist/esm/api/resources/landscapes/resources/export/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/landscapes/resources/export/client/Client.mjs +8 -6
- package/dist/esm/api/resources/landscapes/resources/logs/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/landscapes/resources/logs/client/Client.mjs +11 -8
- package/dist/esm/api/resources/landscapes/resources/logs/resources/stats/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/landscapes/resources/logs/resources/stats/client/Client.mjs +8 -6
- package/dist/esm/api/resources/model/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/model/client/Client.mjs +2 -2
- package/dist/esm/api/resources/model/resources/connections/client/Client.d.mts +28 -5
- package/dist/esm/api/resources/model/resources/connections/client/Client.mjs +96 -18
- package/dist/esm/api/resources/model/resources/connections/resources/export/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/model/resources/connections/resources/export/client/Client.mjs +7 -5
- package/dist/esm/api/resources/model/resources/connections/types/types.d.mts +6 -0
- package/dist/esm/api/resources/model/resources/objects/client/Client.d.mts +6 -4
- package/dist/esm/api/resources/model/resources/objects/client/Client.mjs +25 -28
- package/dist/esm/api/resources/model/resources/objects/resources/export/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/model/resources/objects/resources/export/client/Client.mjs +10 -7
- package/dist/esm/api/resources/organizations/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/organizations/client/Client.mjs +17 -12
- package/dist/esm/api/resources/organizations/resources/landscapes/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/organizations/resources/landscapes/client/Client.mjs +8 -6
- package/dist/esm/api/resources/organizations/resources/logs/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/organizations/resources/logs/client/Client.mjs +8 -6
- package/dist/esm/api/resources/organizations/resources/logs/resources/stats/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/organizations/resources/logs/resources/stats/client/Client.mjs +8 -6
- package/dist/esm/api/resources/organizations/resources/technologies/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/organizations/resources/technologies/client/Client.mjs +17 -12
- package/dist/esm/api/resources/organizations/resources/users/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/organizations/resources/users/client/Client.mjs +11 -8
- package/dist/esm/api/resources/organizations/resources/users/resources/invites/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/organizations/resources/users/resources/invites/client/Client.mjs +11 -8
- package/dist/esm/api/resources/shareLink/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/shareLink/client/Client.mjs +14 -10
- package/dist/esm/api/resources/tags/client/Client.d.mts +8 -6
- package/dist/esm/api/resources/tags/client/Client.mjs +27 -30
- package/dist/esm/api/resources/tags/resources/groups/client/Client.d.mts +7 -5
- package/dist/esm/api/resources/tags/resources/groups/client/Client.mjs +26 -29
- package/dist/esm/api/resources/teams/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/teams/client/Client.mjs +23 -16
- package/dist/esm/api/resources/versions/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/versions/client/Client.mjs +17 -12
- package/dist/esm/api/resources/versions/resources/reverts/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/versions/resources/reverts/client/Client.mjs +14 -10
- package/dist/esm/api/types/types.d.mts +187 -1487
- package/dist/esm/api/types/types.mjs +11 -325
- package/dist/esm/auth/AnyAuthProvider.d.mts +23 -0
- package/dist/esm/auth/AnyAuthProvider.mjs +42 -0
- package/dist/esm/auth/BearerAuthProvider.d.mts +23 -0
- package/dist/esm/auth/BearerAuthProvider.mjs +45 -0
- package/dist/esm/auth/HeaderAuthProvider.d.mts +17 -10
- package/dist/esm/auth/HeaderAuthProvider.mjs +22 -9
- package/dist/esm/auth/index.d.mts +2 -0
- package/dist/esm/auth/index.mjs +2 -0
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +2 -2
- package/dist/esm/environments.d.mts +2 -2
- package/dist/esm/environments.mjs +1 -1
- package/dist/esm/helpers/index.d.mts +1 -1
- package/dist/esm/helpers/index.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +107 -280
|
@@ -421,32 +421,6 @@ export const CatalogTechnologyReviewRejectionReason = {
|
|
|
421
421
|
Invalid: "invalid",
|
|
422
422
|
Other: "other",
|
|
423
423
|
};
|
|
424
|
-
/** Color type. For example, "accent" or "dark" */
|
|
425
|
-
export const CatalogSuggestionBrandColorType = {
|
|
426
|
-
Accent: "accent",
|
|
427
|
-
Dark: "dark",
|
|
428
|
-
Light: "light",
|
|
429
|
-
Brand: "brand",
|
|
430
|
-
};
|
|
431
|
-
/** File format of the logo */
|
|
432
|
-
export const CatalogSuggestionBrandLogoFormatFormat = {
|
|
433
|
-
Svg: "svg",
|
|
434
|
-
Png: "png",
|
|
435
|
-
Webp: "webp",
|
|
436
|
-
Jpeg: "jpeg",
|
|
437
|
-
};
|
|
438
|
-
/** Theme of the logo. For example, "dark" or "light" */
|
|
439
|
-
export const CatalogSuggestionBrandLogoTheme = {
|
|
440
|
-
Light: "light",
|
|
441
|
-
Dark: "dark",
|
|
442
|
-
};
|
|
443
|
-
/** Logo type. For example, "icon" or "symbol" */
|
|
444
|
-
export const CatalogSuggestionBrandLogoType = {
|
|
445
|
-
Icon: "icon",
|
|
446
|
-
Logo: "logo",
|
|
447
|
-
Symbol: "symbol",
|
|
448
|
-
Other: "other",
|
|
449
|
-
};
|
|
450
424
|
export const CommentBodyType = {
|
|
451
425
|
Idea: "idea",
|
|
452
426
|
Inaccurate: "inaccurate",
|
|
@@ -657,7 +631,6 @@ export const LandscapeExportType = {
|
|
|
657
631
|
Markdown: "markdown",
|
|
658
632
|
Html: "html",
|
|
659
633
|
Llms: "llms",
|
|
660
|
-
Structurizr: "structurizr",
|
|
661
634
|
Json: "json",
|
|
662
635
|
};
|
|
663
636
|
export const LandscapeExportOrientation = {
|
|
@@ -720,6 +693,13 @@ export const OrganizationStatus = {
|
|
|
720
693
|
Trialing: "trialing",
|
|
721
694
|
Unpaid: "unpaid",
|
|
722
695
|
};
|
|
696
|
+
export const OrganizationLanguage = {
|
|
697
|
+
EnUs: "en-US",
|
|
698
|
+
EnGb: "en-GB",
|
|
699
|
+
FrFr: "fr-FR",
|
|
700
|
+
EsEs: "es-ES",
|
|
701
|
+
Es419: "es-419",
|
|
702
|
+
};
|
|
723
703
|
export const OrganizationBillingCurrency = {
|
|
724
704
|
Usd: "usd",
|
|
725
705
|
Cad: "cad",
|
|
@@ -780,6 +760,10 @@ export const TagGroupIcon = {
|
|
|
780
760
|
Users: "users",
|
|
781
761
|
Wifi: "wifi",
|
|
782
762
|
};
|
|
763
|
+
export const AiDescriptionType = {
|
|
764
|
+
Caption: "caption",
|
|
765
|
+
Detailed: "detailed",
|
|
766
|
+
};
|
|
783
767
|
export const AuthType = {
|
|
784
768
|
User: "user",
|
|
785
769
|
ApiKey: "api-key",
|
|
@@ -792,47 +776,6 @@ export const PermissionType = {
|
|
|
792
776
|
Write: "write",
|
|
793
777
|
Admin: "admin",
|
|
794
778
|
};
|
|
795
|
-
export const BackstageApiApiVersion = {
|
|
796
|
-
BackstageIoV1Alpha1: "backstage.io/v1alpha1",
|
|
797
|
-
BackstageIoV1Beta1: "backstage.io/v1beta1",
|
|
798
|
-
};
|
|
799
|
-
export const BackstageApiKind = {
|
|
800
|
-
Api: "API",
|
|
801
|
-
};
|
|
802
|
-
export const BackstageComponentApiVersion = {
|
|
803
|
-
BackstageIoV1Alpha1: "backstage.io/v1alpha1",
|
|
804
|
-
BackstageIoV1Beta1: "backstage.io/v1beta1",
|
|
805
|
-
};
|
|
806
|
-
export const BackstageComponentKind = {
|
|
807
|
-
Component: "Component",
|
|
808
|
-
};
|
|
809
|
-
export const BackstageDomainApiVersion = {
|
|
810
|
-
BackstageIoV1Alpha1: "backstage.io/v1alpha1",
|
|
811
|
-
BackstageIoV1Beta1: "backstage.io/v1beta1",
|
|
812
|
-
};
|
|
813
|
-
export const BackstageDomainKind = {
|
|
814
|
-
Domain: "Domain",
|
|
815
|
-
};
|
|
816
|
-
export const BackstageResourceApiVersion = {
|
|
817
|
-
BackstageIoV1Alpha1: "backstage.io/v1alpha1",
|
|
818
|
-
BackstageIoV1Beta1: "backstage.io/v1beta1",
|
|
819
|
-
};
|
|
820
|
-
export const BackstageResourceKind = {
|
|
821
|
-
Resource: "Resource",
|
|
822
|
-
};
|
|
823
|
-
/** A status level / severity. */
|
|
824
|
-
export const BackstageStatusLevel = {
|
|
825
|
-
Info: "info",
|
|
826
|
-
Warning: "warning",
|
|
827
|
-
Error: "error",
|
|
828
|
-
};
|
|
829
|
-
export const BackstageSystemApiVersion = {
|
|
830
|
-
BackstageIoV1Alpha1: "backstage.io/v1alpha1",
|
|
831
|
-
BackstageIoV1Beta1: "backstage.io/v1beta1",
|
|
832
|
-
};
|
|
833
|
-
export const BackstageSystemKind = {
|
|
834
|
-
System: "System",
|
|
835
|
-
};
|
|
836
779
|
export const RealityConnectorUrlType = {
|
|
837
780
|
Url: "url",
|
|
838
781
|
};
|
|
@@ -914,263 +857,6 @@ export const SearchIndexType = {
|
|
|
914
857
|
Connection: "connection",
|
|
915
858
|
Flow: "flow",
|
|
916
859
|
};
|
|
917
|
-
/** The automatic layout implementation. */
|
|
918
|
-
export const StructurizrAutomaticLayoutImplementation = {
|
|
919
|
-
Graphviz: "Graphviz",
|
|
920
|
-
Dagre: "Dagre",
|
|
921
|
-
};
|
|
922
|
-
/** The algorithm rank direction. */
|
|
923
|
-
export const StructurizrAutomaticLayoutRankDirection = {
|
|
924
|
-
TopBottom: "TopBottom",
|
|
925
|
-
BottomTop: "BottomTop",
|
|
926
|
-
LeftRight: "LeftRight",
|
|
927
|
-
RightLeft: "RightLeft",
|
|
928
|
-
};
|
|
929
|
-
/** The paper size that should be used to render this view. */
|
|
930
|
-
export const StructurizrComponentViewPaperSize = {
|
|
931
|
-
A6Portrait: "A6_Portrait",
|
|
932
|
-
A6Landscape: "A6_Landscape",
|
|
933
|
-
A5Portrait: "A5_Portrait",
|
|
934
|
-
A5Landscape: "A5_Landscape",
|
|
935
|
-
A4Portrait: "A4_Portrait",
|
|
936
|
-
A4Landscape: "A4_Landscape",
|
|
937
|
-
A3Portrait: "A3_Portrait",
|
|
938
|
-
A3Landscape: "A3_Landscape",
|
|
939
|
-
A2Portrait: "A2_Portrait",
|
|
940
|
-
A2Landscape: "A2_Landscape",
|
|
941
|
-
A1Portrait: "A1_Portrait",
|
|
942
|
-
A1Landscape: "A1_Landscape",
|
|
943
|
-
A0Portrait: "A0_Portrait",
|
|
944
|
-
A0Landscape: "A0_Landscape",
|
|
945
|
-
LetterPortrait: "Letter_Portrait",
|
|
946
|
-
LetterLandscape: "Letter_Landscape",
|
|
947
|
-
LegalPortrait: "Legal_Portrait",
|
|
948
|
-
LegalLandscape: "Legal_Landscape",
|
|
949
|
-
Slide43: "Slide_4_3",
|
|
950
|
-
Slide169: "Slide_16_9",
|
|
951
|
-
Slide1610: "Slide_16_10",
|
|
952
|
-
};
|
|
953
|
-
/** The type of symbols to use when rendering metadata. */
|
|
954
|
-
export const StructurizrConfigurationMetadataSymbols = {
|
|
955
|
-
SquareBrackets: "SquareBrackets",
|
|
956
|
-
RoundBrackets: "RoundBrackets",
|
|
957
|
-
CurlyBrackets: "CurlyBrackets",
|
|
958
|
-
AngleBrackets: "AngleBrackets",
|
|
959
|
-
DoubleAngleBrackets: "DoubleAngleBrackets",
|
|
960
|
-
None: "None",
|
|
961
|
-
};
|
|
962
|
-
/** The paper size that should be used to render this view. */
|
|
963
|
-
export const StructurizrContainerViewPaperSize = {
|
|
964
|
-
A6Portrait: "A6_Portrait",
|
|
965
|
-
A6Landscape: "A6_Landscape",
|
|
966
|
-
A5Portrait: "A5_Portrait",
|
|
967
|
-
A5Landscape: "A5_Landscape",
|
|
968
|
-
A4Portrait: "A4_Portrait",
|
|
969
|
-
A4Landscape: "A4_Landscape",
|
|
970
|
-
A3Portrait: "A3_Portrait",
|
|
971
|
-
A3Landscape: "A3_Landscape",
|
|
972
|
-
A2Portrait: "A2_Portrait",
|
|
973
|
-
A2Landscape: "A2_Landscape",
|
|
974
|
-
A1Portrait: "A1_Portrait",
|
|
975
|
-
A1Landscape: "A1_Landscape",
|
|
976
|
-
A0Portrait: "A0_Portrait",
|
|
977
|
-
A0Landscape: "A0_Landscape",
|
|
978
|
-
LetterPortrait: "Letter_Portrait",
|
|
979
|
-
LetterLandscape: "Letter_Landscape",
|
|
980
|
-
LegalPortrait: "Legal_Portrait",
|
|
981
|
-
LegalLandscape: "Legal_Landscape",
|
|
982
|
-
Slide43: "Slide_4_3",
|
|
983
|
-
Slide169: "Slide_16_9",
|
|
984
|
-
Slide1610: "Slide_16_10",
|
|
985
|
-
};
|
|
986
|
-
/** The status of the decision. */
|
|
987
|
-
export const StructurizrDecisionStatus = {
|
|
988
|
-
Proposed: "Proposed",
|
|
989
|
-
Accepted: "Accepted",
|
|
990
|
-
Superseded: "Superseded",
|
|
991
|
-
Deprecated: "Deprecated",
|
|
992
|
-
Rejected: "Rejected",
|
|
993
|
-
};
|
|
994
|
-
/** The content format type. */
|
|
995
|
-
export const StructurizrDecisionFormat = {
|
|
996
|
-
Markdown: "Markdown",
|
|
997
|
-
AsciiDoc: "AsciiDoc",
|
|
998
|
-
};
|
|
999
|
-
/** The paper size that should be used to render this view. */
|
|
1000
|
-
export const StructurizrDeploymentViewPaperSize = {
|
|
1001
|
-
A6Portrait: "A6_Portrait",
|
|
1002
|
-
A6Landscape: "A6_Landscape",
|
|
1003
|
-
A5Portrait: "A5_Portrait",
|
|
1004
|
-
A5Landscape: "A5_Landscape",
|
|
1005
|
-
A4Portrait: "A4_Portrait",
|
|
1006
|
-
A4Landscape: "A4_Landscape",
|
|
1007
|
-
A3Portrait: "A3_Portrait",
|
|
1008
|
-
A3Landscape: "A3_Landscape",
|
|
1009
|
-
A2Portrait: "A2_Portrait",
|
|
1010
|
-
A2Landscape: "A2_Landscape",
|
|
1011
|
-
A1Portrait: "A1_Portrait",
|
|
1012
|
-
A1Landscape: "A1_Landscape",
|
|
1013
|
-
A0Portrait: "A0_Portrait",
|
|
1014
|
-
A0Landscape: "A0_Landscape",
|
|
1015
|
-
LetterPortrait: "Letter_Portrait",
|
|
1016
|
-
LetterLandscape: "Letter_Landscape",
|
|
1017
|
-
LegalPortrait: "Legal_Portrait",
|
|
1018
|
-
LegalLandscape: "Legal_Landscape",
|
|
1019
|
-
Slide43: "Slide_4_3",
|
|
1020
|
-
Slide169: "Slide_16_9",
|
|
1021
|
-
Slide1610: "Slide_16_10",
|
|
1022
|
-
};
|
|
1023
|
-
/** The content format type. */
|
|
1024
|
-
export const StructurizrDocumentationSectionFormat = {
|
|
1025
|
-
Markdown: "Markdown",
|
|
1026
|
-
AsciiDoc: "AsciiDoc",
|
|
1027
|
-
};
|
|
1028
|
-
/** The paper size that should be used to render this view. */
|
|
1029
|
-
export const StructurizrDynamicViewPaperSize = {
|
|
1030
|
-
A6Portrait: "A6_Portrait",
|
|
1031
|
-
A6Landscape: "A6_Landscape",
|
|
1032
|
-
A5Portrait: "A5_Portrait",
|
|
1033
|
-
A5Landscape: "A5_Landscape",
|
|
1034
|
-
A4Portrait: "A4_Portrait",
|
|
1035
|
-
A4Landscape: "A4_Landscape",
|
|
1036
|
-
A3Portrait: "A3_Portrait",
|
|
1037
|
-
A3Landscape: "A3_Landscape",
|
|
1038
|
-
A2Portrait: "A2_Portrait",
|
|
1039
|
-
A2Landscape: "A2_Landscape",
|
|
1040
|
-
A1Portrait: "A1_Portrait",
|
|
1041
|
-
A1Landscape: "A1_Landscape",
|
|
1042
|
-
A0Portrait: "A0_Portrait",
|
|
1043
|
-
A0Landscape: "A0_Landscape",
|
|
1044
|
-
LetterPortrait: "Letter_Portrait",
|
|
1045
|
-
LetterLandscape: "Letter_Landscape",
|
|
1046
|
-
LegalPortrait: "Legal_Portrait",
|
|
1047
|
-
LegalLandscape: "Legal_Landscape",
|
|
1048
|
-
Slide43: "Slide_4_3",
|
|
1049
|
-
Slide169: "Slide_16_9",
|
|
1050
|
-
Slide1610: "Slide_16_10",
|
|
1051
|
-
};
|
|
1052
|
-
/** The shape used to render the element. */
|
|
1053
|
-
export const StructurizrElementStyleShape = {
|
|
1054
|
-
Box: "Box",
|
|
1055
|
-
RoundedBox: "RoundedBox",
|
|
1056
|
-
Component: "Component",
|
|
1057
|
-
Circle: "Circle",
|
|
1058
|
-
Ellipse: "Ellipse",
|
|
1059
|
-
Hexagon: "Hexagon",
|
|
1060
|
-
Diamond: "Diamond",
|
|
1061
|
-
Folder: "Folder",
|
|
1062
|
-
Cylinder: "Cylinder",
|
|
1063
|
-
Pipe: "Pipe",
|
|
1064
|
-
WebBrowser: "WebBrowser",
|
|
1065
|
-
Window: "Window",
|
|
1066
|
-
MobileDevicePortrait: "MobileDevicePortrait",
|
|
1067
|
-
MobileDeviceLandscape: "MobileDeviceLandscape",
|
|
1068
|
-
Person: "Person",
|
|
1069
|
-
Robot: "Robot",
|
|
1070
|
-
};
|
|
1071
|
-
/** The type of border used to render the element. */
|
|
1072
|
-
export const StructurizrElementStyleBorder = {
|
|
1073
|
-
Solid: "Solid",
|
|
1074
|
-
Dashed: "Dashed",
|
|
1075
|
-
Dotted: "Dotted",
|
|
1076
|
-
};
|
|
1077
|
-
/** Whether elements/relationships are being included or excluded based upon the set of tags. */
|
|
1078
|
-
export const StructurizrFilteredViewMode = {
|
|
1079
|
-
Include: "Include",
|
|
1080
|
-
Exclude: "Exclude",
|
|
1081
|
-
};
|
|
1082
|
-
/** The location of this person. */
|
|
1083
|
-
export const StructurizrPersonLocation = {
|
|
1084
|
-
External: "External",
|
|
1085
|
-
Internal: "Internal",
|
|
1086
|
-
Unspecified: "Unspecified",
|
|
1087
|
-
};
|
|
1088
|
-
/** The interaction style (synchronous or asynchronous). */
|
|
1089
|
-
export const StructurizrRelationshipInteractionStyle = {
|
|
1090
|
-
Synchronous: "Synchronous",
|
|
1091
|
-
Asynchronous: "Asynchronous",
|
|
1092
|
-
};
|
|
1093
|
-
/** The routing algorithm used when rendering lines. */
|
|
1094
|
-
export const StructurizrRelationshipStyleRouting = {
|
|
1095
|
-
Direct: "Direct",
|
|
1096
|
-
Curved: "Curved",
|
|
1097
|
-
Orthogonal: "Orthogonal",
|
|
1098
|
-
};
|
|
1099
|
-
/** The routing algorithm used when rendering this individual relationship. */
|
|
1100
|
-
export const StructurizrRelationshipViewRouting = {
|
|
1101
|
-
Direct: "Direct",
|
|
1102
|
-
Curved: "Curved",
|
|
1103
|
-
Orthogonal: "Orthogonal",
|
|
1104
|
-
};
|
|
1105
|
-
/** The location of this software system. */
|
|
1106
|
-
export const StructurizrSoftwareSystemLocation = {
|
|
1107
|
-
External: "External",
|
|
1108
|
-
Internal: "Internal",
|
|
1109
|
-
Unspecified: "Unspecified",
|
|
1110
|
-
};
|
|
1111
|
-
/** The paper size that should be used to render this view. */
|
|
1112
|
-
export const StructurizrSystemContextViewPaperSize = {
|
|
1113
|
-
A6Portrait: "A6_Portrait",
|
|
1114
|
-
A6Landscape: "A6_Landscape",
|
|
1115
|
-
A5Portrait: "A5_Portrait",
|
|
1116
|
-
A5Landscape: "A5_Landscape",
|
|
1117
|
-
A4Portrait: "A4_Portrait",
|
|
1118
|
-
A4Landscape: "A4_Landscape",
|
|
1119
|
-
A3Portrait: "A3_Portrait",
|
|
1120
|
-
A3Landscape: "A3_Landscape",
|
|
1121
|
-
A2Portrait: "A2_Portrait",
|
|
1122
|
-
A2Landscape: "A2_Landscape",
|
|
1123
|
-
A1Portrait: "A1_Portrait",
|
|
1124
|
-
A1Landscape: "A1_Landscape",
|
|
1125
|
-
A0Portrait: "A0_Portrait",
|
|
1126
|
-
A0Landscape: "A0_Landscape",
|
|
1127
|
-
LetterPortrait: "Letter_Portrait",
|
|
1128
|
-
LetterLandscape: "Letter_Landscape",
|
|
1129
|
-
LegalPortrait: "Legal_Portrait",
|
|
1130
|
-
LegalLandscape: "Legal_Landscape",
|
|
1131
|
-
Slide43: "Slide_4_3",
|
|
1132
|
-
Slide169: "Slide_16_9",
|
|
1133
|
-
Slide1610: "Slide_16_10",
|
|
1134
|
-
};
|
|
1135
|
-
/** The paper size that should be used to render this view. */
|
|
1136
|
-
export const StructurizrSystemLandscapeViewPaperSize = {
|
|
1137
|
-
A6Portrait: "A6_Portrait",
|
|
1138
|
-
A6Landscape: "A6_Landscape",
|
|
1139
|
-
A5Portrait: "A5_Portrait",
|
|
1140
|
-
A5Landscape: "A5_Landscape",
|
|
1141
|
-
A4Portrait: "A4_Portrait",
|
|
1142
|
-
A4Landscape: "A4_Landscape",
|
|
1143
|
-
A3Portrait: "A3_Portrait",
|
|
1144
|
-
A3Landscape: "A3_Landscape",
|
|
1145
|
-
A2Portrait: "A2_Portrait",
|
|
1146
|
-
A2Landscape: "A2_Landscape",
|
|
1147
|
-
A1Portrait: "A1_Portrait",
|
|
1148
|
-
A1Landscape: "A1_Landscape",
|
|
1149
|
-
A0Portrait: "A0_Portrait",
|
|
1150
|
-
A0Landscape: "A0_Landscape",
|
|
1151
|
-
LetterPortrait: "Letter_Portrait",
|
|
1152
|
-
LetterLandscape: "Letter_Landscape",
|
|
1153
|
-
LegalPortrait: "Legal_Portrait",
|
|
1154
|
-
LegalLandscape: "Legal_Landscape",
|
|
1155
|
-
Slide43: "Slide_4_3",
|
|
1156
|
-
Slide169: "Slide_16_9",
|
|
1157
|
-
Slide1610: "Slide_16_10",
|
|
1158
|
-
};
|
|
1159
|
-
/** The user's role. */
|
|
1160
|
-
export const StructurizrUserRole = {
|
|
1161
|
-
ReadWrite: "ReadWrite",
|
|
1162
|
-
ReadOnly: "ReadOnly",
|
|
1163
|
-
};
|
|
1164
|
-
/** The visibility of the workspace */
|
|
1165
|
-
export const StructurizrWorkspaceConfigurationVisibility = {
|
|
1166
|
-
Public: "Public",
|
|
1167
|
-
Private: "Private",
|
|
1168
|
-
};
|
|
1169
|
-
/** The scope of the workspace (can be unset for unscoped). */
|
|
1170
|
-
export const StructurizrWorkspaceConfigurationScope = {
|
|
1171
|
-
Landscape: "Landscape",
|
|
1172
|
-
SoftwareSystem: "SoftwareSystem",
|
|
1173
|
-
};
|
|
1174
860
|
export const Theme = {
|
|
1175
861
|
Light: "light",
|
|
1176
862
|
Dark: "dark",
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { NormalizedClientOptions } from "../BaseClient.mjs";
|
|
2
|
+
import type * as core from "../core/index.mjs";
|
|
3
|
+
export declare class AnyAuthProvider implements core.AuthProvider {
|
|
4
|
+
private readonly authProviders;
|
|
5
|
+
constructor(authProviders: core.AuthProvider[]);
|
|
6
|
+
getAuthRequest(arg?: {
|
|
7
|
+
endpointMetadata?: core.EndpointMetadata;
|
|
8
|
+
}): Promise<core.AuthRequest>;
|
|
9
|
+
}
|
|
10
|
+
export declare namespace AnyAuthProvider {
|
|
11
|
+
type UnionToIntersection<U> = (U extends any ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
|
|
12
|
+
type AtLeastOneOf<T extends readonly any[]> = {
|
|
13
|
+
[K in keyof T]: T[K] & Partial<UnionToIntersection<Exclude<T[number], T[K]>>>;
|
|
14
|
+
}[number];
|
|
15
|
+
export type AuthOptions<TAuthProviders extends readonly any[]> = AtLeastOneOf<TAuthProviders>;
|
|
16
|
+
export type Options<TOptions extends readonly any[]> = Partial<UnionToIntersection<TOptions[number]>>;
|
|
17
|
+
type InstantiatableAuthProvider = {
|
|
18
|
+
canCreate: (opts: NormalizedClientOptions) => boolean;
|
|
19
|
+
createInstance: (opts: NormalizedClientOptions) => core.AuthProvider;
|
|
20
|
+
};
|
|
21
|
+
export function createInstance(options: NormalizedClientOptions, authProviderClasses: InstantiatableAuthProvider[]): core.AuthProvider;
|
|
22
|
+
export {};
|
|
23
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
export class AnyAuthProvider {
|
|
12
|
+
constructor(authProviders) {
|
|
13
|
+
this.authProviders = authProviders;
|
|
14
|
+
}
|
|
15
|
+
getAuthRequest(arg) {
|
|
16
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17
|
+
const availableProviders = this.authProviders;
|
|
18
|
+
for (const provider of availableProviders) {
|
|
19
|
+
try {
|
|
20
|
+
const authRequest = yield provider.getAuthRequest(arg);
|
|
21
|
+
if (authRequest.headers.Authorization != null || Object.keys(authRequest.headers).length > 0) {
|
|
22
|
+
return authRequest;
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
catch (_e) {
|
|
26
|
+
// Continue to next auth provider
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
// No auth credentials found
|
|
30
|
+
return { headers: {} };
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
(function (AnyAuthProvider) {
|
|
35
|
+
function createInstance(options, authProviderClasses) {
|
|
36
|
+
const authProviders = authProviderClasses
|
|
37
|
+
.filter((providerClass) => providerClass.canCreate(options))
|
|
38
|
+
.map((providerClass) => providerClass.createInstance(options));
|
|
39
|
+
return new AnyAuthProvider(authProviders);
|
|
40
|
+
}
|
|
41
|
+
AnyAuthProvider.createInstance = createInstance;
|
|
42
|
+
})(AnyAuthProvider || (AnyAuthProvider = {}));
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import * as core from "../core/index.mjs";
|
|
2
|
+
declare const WRAPPER_PROPERTY: "bearerAuth";
|
|
3
|
+
declare const TOKEN_PARAM: "token";
|
|
4
|
+
export declare class BearerAuthProvider implements core.AuthProvider {
|
|
5
|
+
private readonly options;
|
|
6
|
+
constructor(options: BearerAuthProvider.Options);
|
|
7
|
+
static canCreate(options: Partial<BearerAuthProvider.Options>): boolean;
|
|
8
|
+
getAuthRequest({ endpointMetadata, }?: {
|
|
9
|
+
endpointMetadata?: core.EndpointMetadata;
|
|
10
|
+
}): Promise<core.AuthRequest>;
|
|
11
|
+
}
|
|
12
|
+
export declare namespace BearerAuthProvider {
|
|
13
|
+
const AUTH_SCHEME: "BearerAuth";
|
|
14
|
+
const AUTH_CONFIG_ERROR_MESSAGE: string;
|
|
15
|
+
type Options = AuthOptions;
|
|
16
|
+
type AuthOptions = {
|
|
17
|
+
[WRAPPER_PROPERTY]?: {
|
|
18
|
+
[TOKEN_PARAM]?: core.Supplier<core.BearerToken>;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
function createInstance(options: Options): core.AuthProvider;
|
|
22
|
+
}
|
|
23
|
+
export {};
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
import * as core from "../core/index.mjs";
|
|
12
|
+
import * as errors from "../errors/index.mjs";
|
|
13
|
+
const WRAPPER_PROPERTY = "bearerAuth";
|
|
14
|
+
const TOKEN_PARAM = "token";
|
|
15
|
+
export class BearerAuthProvider {
|
|
16
|
+
constructor(options) {
|
|
17
|
+
this.options = options;
|
|
18
|
+
}
|
|
19
|
+
static canCreate(options) {
|
|
20
|
+
var _a;
|
|
21
|
+
return ((_a = options === null || options === void 0 ? void 0 : options[WRAPPER_PROPERTY]) === null || _a === void 0 ? void 0 : _a[TOKEN_PARAM]) != null;
|
|
22
|
+
}
|
|
23
|
+
getAuthRequest() {
|
|
24
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
|
|
25
|
+
var _a;
|
|
26
|
+
const token = yield core.Supplier.get((_a = this.options[WRAPPER_PROPERTY]) === null || _a === void 0 ? void 0 : _a[TOKEN_PARAM]);
|
|
27
|
+
if (token == null) {
|
|
28
|
+
throw new errors.IcePanelError({
|
|
29
|
+
message: BearerAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
return {
|
|
33
|
+
headers: { Authorization: `Bearer ${token}` },
|
|
34
|
+
};
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
(function (BearerAuthProvider) {
|
|
39
|
+
BearerAuthProvider.AUTH_SCHEME = "BearerAuth";
|
|
40
|
+
BearerAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Please provide '${TOKEN_PARAM}' when initializing the client`;
|
|
41
|
+
function createInstance(options) {
|
|
42
|
+
return new BearerAuthProvider(options);
|
|
43
|
+
}
|
|
44
|
+
BearerAuthProvider.createInstance = createInstance;
|
|
45
|
+
})(BearerAuthProvider || (BearerAuthProvider = {}));
|
|
@@ -1,16 +1,23 @@
|
|
|
1
1
|
import * as core from "../core/index.mjs";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
apiKey?: core.Supplier<string>;
|
|
5
|
-
}
|
|
6
|
-
interface Options extends AuthOptions {
|
|
7
|
-
}
|
|
8
|
-
}
|
|
2
|
+
declare const WRAPPER_PROPERTY: "apiKeyAuth";
|
|
3
|
+
declare const PARAM_KEY: "apiKey";
|
|
9
4
|
export declare class HeaderAuthProvider implements core.AuthProvider {
|
|
10
|
-
private readonly
|
|
5
|
+
private readonly options;
|
|
11
6
|
constructor(options: HeaderAuthProvider.Options);
|
|
12
|
-
static canCreate(options: HeaderAuthProvider.Options): boolean;
|
|
13
|
-
getAuthRequest(
|
|
7
|
+
static canCreate(options: Partial<HeaderAuthProvider.Options>): boolean;
|
|
8
|
+
getAuthRequest({ endpointMetadata, }?: {
|
|
14
9
|
endpointMetadata?: core.EndpointMetadata;
|
|
15
10
|
}): Promise<core.AuthRequest>;
|
|
16
11
|
}
|
|
12
|
+
export declare namespace HeaderAuthProvider {
|
|
13
|
+
const AUTH_SCHEME: "ApiKeyAuth";
|
|
14
|
+
const AUTH_CONFIG_ERROR_MESSAGE: string;
|
|
15
|
+
type Options = AuthOptions;
|
|
16
|
+
type AuthOptions = {
|
|
17
|
+
[WRAPPER_PROPERTY]?: {
|
|
18
|
+
[PARAM_KEY]?: core.Supplier<string> | undefined;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
function createInstance(options: Options): core.AuthProvider;
|
|
22
|
+
}
|
|
23
|
+
export {};
|
|
@@ -10,25 +10,38 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
10
10
|
};
|
|
11
11
|
import * as core from "../core/index.mjs";
|
|
12
12
|
import * as errors from "../errors/index.mjs";
|
|
13
|
+
const WRAPPER_PROPERTY = "apiKeyAuth";
|
|
14
|
+
const PARAM_KEY = "apiKey";
|
|
15
|
+
const ENV_HEADER_KEY = "ICEPANEL_API_KEY";
|
|
16
|
+
const HEADER_NAME = "X-API-Key";
|
|
13
17
|
export class HeaderAuthProvider {
|
|
14
18
|
constructor(options) {
|
|
15
|
-
this.
|
|
19
|
+
this.options = options;
|
|
16
20
|
}
|
|
17
21
|
static canCreate(options) {
|
|
18
|
-
|
|
22
|
+
var _a, _b;
|
|
23
|
+
return ((_a = options === null || options === void 0 ? void 0 : options[WRAPPER_PROPERTY]) === null || _a === void 0 ? void 0 : _a[PARAM_KEY]) != null || ((_b = process.env) === null || _b === void 0 ? void 0 : _b[ENV_HEADER_KEY]) != null;
|
|
19
24
|
}
|
|
20
|
-
getAuthRequest(
|
|
21
|
-
return __awaiter(this,
|
|
22
|
-
|
|
23
|
-
|
|
25
|
+
getAuthRequest() {
|
|
26
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
|
|
27
|
+
var _a, _b, _c;
|
|
28
|
+
const headerValue = (_b = (yield core.Supplier.get((_a = this.options[WRAPPER_PROPERTY]) === null || _a === void 0 ? void 0 : _a[PARAM_KEY]))) !== null && _b !== void 0 ? _b : (_c = process.env) === null || _c === void 0 ? void 0 : _c[ENV_HEADER_KEY];
|
|
29
|
+
if (headerValue == null) {
|
|
24
30
|
throw new errors.IcePanelError({
|
|
25
|
-
message:
|
|
31
|
+
message: HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
|
|
26
32
|
});
|
|
27
33
|
}
|
|
28
|
-
const headerValue = apiKey;
|
|
29
34
|
return {
|
|
30
|
-
headers: {
|
|
35
|
+
headers: { [HEADER_NAME]: headerValue },
|
|
31
36
|
};
|
|
32
37
|
});
|
|
33
38
|
}
|
|
34
39
|
}
|
|
40
|
+
(function (HeaderAuthProvider) {
|
|
41
|
+
HeaderAuthProvider.AUTH_SCHEME = "ApiKeyAuth";
|
|
42
|
+
HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Please provide '${PARAM_KEY}' when initializing the client, or set the '${ENV_HEADER_KEY}' environment variable`;
|
|
43
|
+
function createInstance(options) {
|
|
44
|
+
return new HeaderAuthProvider(options);
|
|
45
|
+
}
|
|
46
|
+
HeaderAuthProvider.createInstance = createInstance;
|
|
47
|
+
})(HeaderAuthProvider || (HeaderAuthProvider = {}));
|
package/dist/esm/auth/index.mjs
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { EndpointMetadata } from "./EndpointMetadata.mjs";
|
|
2
2
|
import type { Supplier } from "./Supplier.mjs";
|
|
3
3
|
type EndpointSupplierFn<T> = (arg: {
|
|
4
|
-
endpointMetadata
|
|
4
|
+
endpointMetadata?: EndpointMetadata;
|
|
5
5
|
}) => T | Promise<T>;
|
|
6
6
|
export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
|
|
7
7
|
export declare const EndpointSupplier: {
|
|
8
8
|
get: <T>(supplier: EndpointSupplier<T>, arg: {
|
|
9
|
-
endpointMetadata
|
|
9
|
+
endpointMetadata?: EndpointMetadata;
|
|
10
10
|
}) => Promise<T>;
|
|
11
11
|
};
|
|
12
12
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export declare const IcePanelEnvironment: {
|
|
2
|
-
readonly
|
|
2
|
+
readonly ApiV1: "https://api.icepanel.io/v1";
|
|
3
3
|
};
|
|
4
|
-
export type IcePanelEnvironment = typeof IcePanelEnvironment.
|
|
4
|
+
export type IcePanelEnvironment = typeof IcePanelEnvironment.ApiV1;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export * from './ids';
|
|
1
|
+
export * from './ids.mjs';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export * from './ids';
|
|
1
|
+
export * from './ids.mjs';
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.1.
|
|
1
|
+
export declare const SDK_VERSION = "0.1.6";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.1.
|
|
1
|
+
export const SDK_VERSION = "0.1.6";
|