@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.
Files changed (191) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/BaseClient.d.ts +7 -9
  3. package/dist/cjs/BaseClient.js +8 -3
  4. package/dist/cjs/Client.d.ts +2 -2
  5. package/dist/cjs/Client.js +1 -1
  6. package/dist/cjs/IcePanelClient.d.ts +7 -8
  7. package/dist/cjs/IcePanelClient.js +11 -11
  8. package/dist/cjs/api/requests/requests.d.ts +62 -142
  9. package/dist/cjs/api/resources/catalog/client/Client.d.ts +2 -2
  10. package/dist/cjs/api/resources/catalog/client/Client.js +1 -1
  11. package/dist/cjs/api/resources/catalog/resources/technologies/client/Client.d.ts +2 -71
  12. package/dist/cjs/api/resources/catalog/resources/technologies/client/Client.js +5 -262
  13. package/dist/cjs/api/resources/catalog/resources/technologies/types/types.d.ts +0 -12
  14. package/dist/cjs/api/resources/comments/client/Client.d.ts +7 -5
  15. package/dist/cjs/api/resources/comments/client/Client.js +25 -28
  16. package/dist/cjs/api/resources/comments/resources/replies/client/Client.d.ts +5 -3
  17. package/dist/cjs/api/resources/comments/resources/replies/client/Client.js +23 -26
  18. package/dist/cjs/api/resources/diagrams/client/Client.d.ts +4 -3
  19. package/dist/cjs/api/resources/diagrams/client/Client.js +31 -32
  20. package/dist/cjs/api/resources/diagrams/resources/content/client/Client.d.ts +2 -2
  21. package/dist/cjs/api/resources/diagrams/resources/content/client/Client.js +10 -7
  22. package/dist/cjs/api/resources/diagrams/resources/export/client/Client.d.ts +2 -2
  23. package/dist/cjs/api/resources/diagrams/resources/export/client/Client.js +7 -5
  24. package/dist/cjs/api/resources/diagrams/resources/groups/client/Client.d.ts +6 -4
  25. package/dist/cjs/api/resources/diagrams/resources/groups/client/Client.js +27 -29
  26. package/dist/cjs/api/resources/domains/client/Client.d.ts +5 -3
  27. package/dist/cjs/api/resources/domains/client/Client.js +26 -28
  28. package/dist/cjs/api/resources/drafts/client/Client.d.ts +2 -2
  29. package/dist/cjs/api/resources/drafts/client/Client.js +22 -15
  30. package/dist/cjs/api/resources/flows/client/Client.d.ts +2 -2
  31. package/dist/cjs/api/resources/flows/client/Client.js +28 -19
  32. package/dist/cjs/api/resources/flows/resources/export/client/Client.d.ts +2 -2
  33. package/dist/cjs/api/resources/flows/resources/export/client/Client.js +10 -7
  34. package/dist/cjs/api/resources/landscapes/client/Client.d.ts +2 -2
  35. package/dist/cjs/api/resources/landscapes/client/Client.js +19 -13
  36. package/dist/cjs/api/resources/landscapes/resources/export/client/Client.d.ts +2 -2
  37. package/dist/cjs/api/resources/landscapes/resources/export/client/Client.js +7 -5
  38. package/dist/cjs/api/resources/landscapes/resources/logs/client/Client.d.ts +2 -2
  39. package/dist/cjs/api/resources/landscapes/resources/logs/client/Client.js +10 -7
  40. package/dist/cjs/api/resources/landscapes/resources/logs/resources/stats/client/Client.d.ts +2 -2
  41. package/dist/cjs/api/resources/landscapes/resources/logs/resources/stats/client/Client.js +7 -5
  42. package/dist/cjs/api/resources/model/client/Client.d.ts +2 -2
  43. package/dist/cjs/api/resources/model/client/Client.js +1 -1
  44. package/dist/cjs/api/resources/model/resources/connections/client/Client.d.ts +28 -5
  45. package/dist/cjs/api/resources/model/resources/connections/client/Client.js +95 -17
  46. package/dist/cjs/api/resources/model/resources/connections/resources/export/client/Client.d.ts +3 -3
  47. package/dist/cjs/api/resources/model/resources/connections/resources/export/client/Client.js +6 -4
  48. package/dist/cjs/api/resources/model/resources/connections/types/types.d.ts +6 -0
  49. package/dist/cjs/api/resources/model/resources/objects/client/Client.d.ts +6 -4
  50. package/dist/cjs/api/resources/model/resources/objects/client/Client.js +24 -27
  51. package/dist/cjs/api/resources/model/resources/objects/resources/export/client/Client.d.ts +3 -3
  52. package/dist/cjs/api/resources/model/resources/objects/resources/export/client/Client.js +9 -6
  53. package/dist/cjs/api/resources/organizations/client/Client.d.ts +2 -2
  54. package/dist/cjs/api/resources/organizations/client/Client.js +16 -11
  55. package/dist/cjs/api/resources/organizations/resources/landscapes/client/Client.d.ts +2 -2
  56. package/dist/cjs/api/resources/organizations/resources/landscapes/client/Client.js +7 -5
  57. package/dist/cjs/api/resources/organizations/resources/logs/client/Client.d.ts +2 -2
  58. package/dist/cjs/api/resources/organizations/resources/logs/client/Client.js +7 -5
  59. package/dist/cjs/api/resources/organizations/resources/logs/resources/stats/client/Client.d.ts +2 -2
  60. package/dist/cjs/api/resources/organizations/resources/logs/resources/stats/client/Client.js +7 -5
  61. package/dist/cjs/api/resources/organizations/resources/technologies/client/Client.d.ts +2 -2
  62. package/dist/cjs/api/resources/organizations/resources/technologies/client/Client.js +16 -11
  63. package/dist/cjs/api/resources/organizations/resources/users/client/Client.d.ts +2 -2
  64. package/dist/cjs/api/resources/organizations/resources/users/client/Client.js +10 -7
  65. package/dist/cjs/api/resources/organizations/resources/users/resources/invites/client/Client.d.ts +2 -2
  66. package/dist/cjs/api/resources/organizations/resources/users/resources/invites/client/Client.js +10 -7
  67. package/dist/cjs/api/resources/shareLink/client/Client.d.ts +2 -2
  68. package/dist/cjs/api/resources/shareLink/client/Client.js +13 -9
  69. package/dist/cjs/api/resources/tags/client/Client.d.ts +8 -6
  70. package/dist/cjs/api/resources/tags/client/Client.js +26 -29
  71. package/dist/cjs/api/resources/tags/resources/groups/client/Client.d.ts +7 -5
  72. package/dist/cjs/api/resources/tags/resources/groups/client/Client.js +25 -28
  73. package/dist/cjs/api/resources/teams/client/Client.d.ts +2 -2
  74. package/dist/cjs/api/resources/teams/client/Client.js +22 -15
  75. package/dist/cjs/api/resources/versions/client/Client.d.ts +2 -2
  76. package/dist/cjs/api/resources/versions/client/Client.js +16 -11
  77. package/dist/cjs/api/resources/versions/resources/reverts/client/Client.d.ts +2 -2
  78. package/dist/cjs/api/resources/versions/resources/reverts/client/Client.js +13 -9
  79. package/dist/cjs/api/types/types.d.ts +187 -1487
  80. package/dist/cjs/api/types/types.js +14 -329
  81. package/dist/cjs/auth/AnyAuthProvider.d.ts +23 -0
  82. package/dist/cjs/auth/AnyAuthProvider.js +46 -0
  83. package/dist/cjs/auth/BearerAuthProvider.d.ts +23 -0
  84. package/dist/cjs/auth/BearerAuthProvider.js +82 -0
  85. package/dist/cjs/auth/HeaderAuthProvider.d.ts +17 -10
  86. package/dist/cjs/auth/HeaderAuthProvider.js +22 -9
  87. package/dist/cjs/auth/index.d.ts +2 -0
  88. package/dist/cjs/auth/index.js +5 -1
  89. package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +2 -2
  90. package/dist/cjs/environments.d.ts +2 -2
  91. package/dist/cjs/environments.js +1 -1
  92. package/dist/cjs/helpers/index.d.ts +1 -1
  93. package/dist/cjs/helpers/index.js +1 -1
  94. package/dist/cjs/version.d.ts +1 -1
  95. package/dist/cjs/version.js +1 -1
  96. package/dist/esm/BaseClient.d.mts +7 -9
  97. package/dist/esm/BaseClient.mjs +8 -3
  98. package/dist/esm/Client.d.mts +2 -2
  99. package/dist/esm/Client.mjs +2 -2
  100. package/dist/esm/IcePanelClient.d.mts +7 -8
  101. package/dist/esm/IcePanelClient.mjs +10 -10
  102. package/dist/esm/api/requests/requests.d.mts +62 -142
  103. package/dist/esm/api/resources/catalog/client/Client.d.mts +2 -2
  104. package/dist/esm/api/resources/catalog/client/Client.mjs +2 -2
  105. package/dist/esm/api/resources/catalog/resources/technologies/client/Client.d.mts +2 -71
  106. package/dist/esm/api/resources/catalog/resources/technologies/client/Client.mjs +6 -263
  107. package/dist/esm/api/resources/catalog/resources/technologies/types/types.d.mts +0 -12
  108. package/dist/esm/api/resources/comments/client/Client.d.mts +7 -5
  109. package/dist/esm/api/resources/comments/client/Client.mjs +26 -29
  110. package/dist/esm/api/resources/comments/resources/replies/client/Client.d.mts +5 -3
  111. package/dist/esm/api/resources/comments/resources/replies/client/Client.mjs +24 -27
  112. package/dist/esm/api/resources/diagrams/client/Client.d.mts +4 -3
  113. package/dist/esm/api/resources/diagrams/client/Client.mjs +32 -33
  114. package/dist/esm/api/resources/diagrams/resources/content/client/Client.d.mts +2 -2
  115. package/dist/esm/api/resources/diagrams/resources/content/client/Client.mjs +11 -8
  116. package/dist/esm/api/resources/diagrams/resources/export/client/Client.d.mts +2 -2
  117. package/dist/esm/api/resources/diagrams/resources/export/client/Client.mjs +8 -6
  118. package/dist/esm/api/resources/diagrams/resources/groups/client/Client.d.mts +6 -4
  119. package/dist/esm/api/resources/diagrams/resources/groups/client/Client.mjs +28 -30
  120. package/dist/esm/api/resources/domains/client/Client.d.mts +5 -3
  121. package/dist/esm/api/resources/domains/client/Client.mjs +27 -29
  122. package/dist/esm/api/resources/drafts/client/Client.d.mts +2 -2
  123. package/dist/esm/api/resources/drafts/client/Client.mjs +23 -16
  124. package/dist/esm/api/resources/flows/client/Client.d.mts +2 -2
  125. package/dist/esm/api/resources/flows/client/Client.mjs +29 -20
  126. package/dist/esm/api/resources/flows/resources/export/client/Client.d.mts +2 -2
  127. package/dist/esm/api/resources/flows/resources/export/client/Client.mjs +11 -8
  128. package/dist/esm/api/resources/landscapes/client/Client.d.mts +2 -2
  129. package/dist/esm/api/resources/landscapes/client/Client.mjs +20 -14
  130. package/dist/esm/api/resources/landscapes/resources/export/client/Client.d.mts +2 -2
  131. package/dist/esm/api/resources/landscapes/resources/export/client/Client.mjs +8 -6
  132. package/dist/esm/api/resources/landscapes/resources/logs/client/Client.d.mts +2 -2
  133. package/dist/esm/api/resources/landscapes/resources/logs/client/Client.mjs +11 -8
  134. package/dist/esm/api/resources/landscapes/resources/logs/resources/stats/client/Client.d.mts +2 -2
  135. package/dist/esm/api/resources/landscapes/resources/logs/resources/stats/client/Client.mjs +8 -6
  136. package/dist/esm/api/resources/model/client/Client.d.mts +2 -2
  137. package/dist/esm/api/resources/model/client/Client.mjs +2 -2
  138. package/dist/esm/api/resources/model/resources/connections/client/Client.d.mts +28 -5
  139. package/dist/esm/api/resources/model/resources/connections/client/Client.mjs +96 -18
  140. package/dist/esm/api/resources/model/resources/connections/resources/export/client/Client.d.mts +3 -3
  141. package/dist/esm/api/resources/model/resources/connections/resources/export/client/Client.mjs +7 -5
  142. package/dist/esm/api/resources/model/resources/connections/types/types.d.mts +6 -0
  143. package/dist/esm/api/resources/model/resources/objects/client/Client.d.mts +6 -4
  144. package/dist/esm/api/resources/model/resources/objects/client/Client.mjs +25 -28
  145. package/dist/esm/api/resources/model/resources/objects/resources/export/client/Client.d.mts +3 -3
  146. package/dist/esm/api/resources/model/resources/objects/resources/export/client/Client.mjs +10 -7
  147. package/dist/esm/api/resources/organizations/client/Client.d.mts +2 -2
  148. package/dist/esm/api/resources/organizations/client/Client.mjs +17 -12
  149. package/dist/esm/api/resources/organizations/resources/landscapes/client/Client.d.mts +2 -2
  150. package/dist/esm/api/resources/organizations/resources/landscapes/client/Client.mjs +8 -6
  151. package/dist/esm/api/resources/organizations/resources/logs/client/Client.d.mts +2 -2
  152. package/dist/esm/api/resources/organizations/resources/logs/client/Client.mjs +8 -6
  153. package/dist/esm/api/resources/organizations/resources/logs/resources/stats/client/Client.d.mts +2 -2
  154. package/dist/esm/api/resources/organizations/resources/logs/resources/stats/client/Client.mjs +8 -6
  155. package/dist/esm/api/resources/organizations/resources/technologies/client/Client.d.mts +2 -2
  156. package/dist/esm/api/resources/organizations/resources/technologies/client/Client.mjs +17 -12
  157. package/dist/esm/api/resources/organizations/resources/users/client/Client.d.mts +2 -2
  158. package/dist/esm/api/resources/organizations/resources/users/client/Client.mjs +11 -8
  159. package/dist/esm/api/resources/organizations/resources/users/resources/invites/client/Client.d.mts +2 -2
  160. package/dist/esm/api/resources/organizations/resources/users/resources/invites/client/Client.mjs +11 -8
  161. package/dist/esm/api/resources/shareLink/client/Client.d.mts +2 -2
  162. package/dist/esm/api/resources/shareLink/client/Client.mjs +14 -10
  163. package/dist/esm/api/resources/tags/client/Client.d.mts +8 -6
  164. package/dist/esm/api/resources/tags/client/Client.mjs +27 -30
  165. package/dist/esm/api/resources/tags/resources/groups/client/Client.d.mts +7 -5
  166. package/dist/esm/api/resources/tags/resources/groups/client/Client.mjs +26 -29
  167. package/dist/esm/api/resources/teams/client/Client.d.mts +2 -2
  168. package/dist/esm/api/resources/teams/client/Client.mjs +23 -16
  169. package/dist/esm/api/resources/versions/client/Client.d.mts +2 -2
  170. package/dist/esm/api/resources/versions/client/Client.mjs +17 -12
  171. package/dist/esm/api/resources/versions/resources/reverts/client/Client.d.mts +2 -2
  172. package/dist/esm/api/resources/versions/resources/reverts/client/Client.mjs +14 -10
  173. package/dist/esm/api/types/types.d.mts +187 -1487
  174. package/dist/esm/api/types/types.mjs +11 -325
  175. package/dist/esm/auth/AnyAuthProvider.d.mts +23 -0
  176. package/dist/esm/auth/AnyAuthProvider.mjs +42 -0
  177. package/dist/esm/auth/BearerAuthProvider.d.mts +23 -0
  178. package/dist/esm/auth/BearerAuthProvider.mjs +45 -0
  179. package/dist/esm/auth/HeaderAuthProvider.d.mts +17 -10
  180. package/dist/esm/auth/HeaderAuthProvider.mjs +22 -9
  181. package/dist/esm/auth/index.d.mts +2 -0
  182. package/dist/esm/auth/index.mjs +2 -0
  183. package/dist/esm/core/fetcher/EndpointSupplier.d.mts +2 -2
  184. package/dist/esm/environments.d.mts +2 -2
  185. package/dist/esm/environments.mjs +1 -1
  186. package/dist/esm/helpers/index.d.mts +1 -1
  187. package/dist/esm/helpers/index.mjs +1 -1
  188. package/dist/esm/version.d.mts +1 -1
  189. package/dist/esm/version.mjs +1 -1
  190. package/package.json +1 -1
  191. package/reference.md +107 -280
@@ -1,22 +1,4 @@
1
1
  import type * as IcePanel from "../index.mjs";
2
- export interface DiagramContentPartialComments {
3
- $add?: Record<string, IcePanel.DiagramComment>;
4
- $remove?: string[];
5
- $replace?: Record<string, IcePanel.DiagramComment>;
6
- $update?: Record<string, IcePanel.DiagramCommentPartial>;
7
- }
8
- export interface DiagramContentPartialConnections {
9
- $add?: Record<string, IcePanel.DiagramConnection>;
10
- $remove?: string[];
11
- $replace?: Record<string, IcePanel.DiagramConnection>;
12
- $update?: Record<string, IcePanel.DiagramConnectionPartial>;
13
- }
14
- export interface DiagramContentPartialObjects {
15
- $add?: Record<string, IcePanel.DiagramObject>;
16
- $remove?: string[];
17
- $replace?: Record<string, IcePanel.DiagramObject>;
18
- $update?: Record<string, IcePanel.DiagramObjectPartial>;
19
- }
20
2
  export declare const LandscapeActionType: {
21
3
  readonly CommentCreate: "comment-create";
22
4
  readonly CommentDelete: "comment-delete";
@@ -896,9 +878,9 @@ export interface ActionDraftTaskCreate {
896
878
  type: IcePanel.ActionDraftTaskCreateType;
897
879
  }
898
880
  export interface ActionLandscapeCreateContext {
899
- backstageImport: boolean;
881
+ backstageImport?: boolean;
900
882
  name: string;
901
- structurizrImport: boolean;
883
+ structurizrImport?: boolean;
902
884
  }
903
885
  export declare const ActionLandscapeCreateType: {
904
886
  readonly LandscapeCreate: "landscape-create";
@@ -1644,93 +1626,6 @@ export interface CatalogTechnology {
1644
1626
  updatedById: string;
1645
1627
  updatesXmlUrl?: string;
1646
1628
  }
1647
- export interface CatalogSuggestionInformation {
1648
- /** Technical description for the technology */
1649
- description?: string;
1650
- /** Documentation or readme url */
1651
- docsUrl?: string;
1652
- /** GitHub repo url */
1653
- githubUrl?: string;
1654
- name?: string;
1655
- /** Short name to show in places with limited space */
1656
- nameShort?: string;
1657
- /** News url */
1658
- newsUrl?: string;
1659
- /** Type or category of technology */
1660
- type?: IcePanel.CatalogTechnologyTypeNullable | null;
1661
- /** Release notes or changelog url */
1662
- updatesUrl?: string;
1663
- }
1664
- /** Color type. For example, "accent" or "dark" */
1665
- export declare const CatalogSuggestionBrandColorType: {
1666
- readonly Accent: "accent";
1667
- readonly Dark: "dark";
1668
- readonly Light: "light";
1669
- readonly Brand: "brand";
1670
- };
1671
- export type CatalogSuggestionBrandColorType = (typeof CatalogSuggestionBrandColorType)[keyof typeof CatalogSuggestionBrandColorType];
1672
- export interface CatalogSuggestionBrandColor {
1673
- /** Color brightness. Calculated based on the standard formula 0.2126R + 0.7152G + 0.0722*B */
1674
- brightness: number;
1675
- /** Hexadecimal color code */
1676
- hex: string;
1677
- /** Color type. For example, "accent" or "dark" */
1678
- type: IcePanel.CatalogSuggestionBrandColorType;
1679
- }
1680
- /** File format of the logo */
1681
- export declare const CatalogSuggestionBrandLogoFormatFormat: {
1682
- readonly Svg: "svg";
1683
- readonly Png: "png";
1684
- readonly Webp: "webp";
1685
- readonly Jpeg: "jpeg";
1686
- };
1687
- export type CatalogSuggestionBrandLogoFormatFormat = (typeof CatalogSuggestionBrandLogoFormatFormat)[keyof typeof CatalogSuggestionBrandLogoFormatFormat];
1688
- export interface CatalogSuggestionBrandLogoFormat {
1689
- /** Indicates if the file has a transparent background. */
1690
- background: string | null;
1691
- /** File format of the logo */
1692
- format: IcePanel.CatalogSuggestionBrandLogoFormatFormat;
1693
- /** Height of the logo in pixels */
1694
- height: number | null;
1695
- /** File size in bytes */
1696
- size: number;
1697
- /** File source url of the logo */
1698
- src: string;
1699
- /** Width of the logo in pixels */
1700
- width: number | null;
1701
- }
1702
- /** Theme of the logo. For example, "dark" or "light" */
1703
- export declare const CatalogSuggestionBrandLogoTheme: {
1704
- readonly Light: "light";
1705
- readonly Dark: "dark";
1706
- };
1707
- export type CatalogSuggestionBrandLogoTheme = (typeof CatalogSuggestionBrandLogoTheme)[keyof typeof CatalogSuggestionBrandLogoTheme];
1708
- /** Logo type. For example, "icon" or "symbol" */
1709
- export declare const CatalogSuggestionBrandLogoType: {
1710
- readonly Icon: "icon";
1711
- readonly Logo: "logo";
1712
- readonly Symbol: "symbol";
1713
- readonly Other: "other";
1714
- };
1715
- export type CatalogSuggestionBrandLogoType = (typeof CatalogSuggestionBrandLogoType)[keyof typeof CatalogSuggestionBrandLogoType];
1716
- export interface CatalogSuggestionBrandLogo {
1717
- /** A list of format objects containing files in different formats */
1718
- formats: IcePanel.CatalogSuggestionBrandLogoFormat[];
1719
- /** A list of strings attached to the logo. For example, if the logo icon is "photographic" rather than a logomark. */
1720
- tags: string[];
1721
- /** Theme of the logo. For example, "dark" or "light" */
1722
- theme: IcePanel.CatalogSuggestionBrandLogoTheme | null;
1723
- /** Logo type. For example, "icon" or "symbol" */
1724
- type: IcePanel.CatalogSuggestionBrandLogoType;
1725
- }
1726
- export interface CatalogSuggestionBrand {
1727
- /** Accent, dark, light & palette colors of the brand */
1728
- colors: IcePanel.CatalogSuggestionBrandColor[];
1729
- /** true when the brand is for adult content, e.g. is not safe for work */
1730
- isNsfw: boolean;
1731
- /** Logos, symbols & icons of the brand */
1732
- logos: IcePanel.CatalogSuggestionBrandLogo[];
1733
- }
1734
1629
  export interface CommentDiagram {
1735
1630
  commentId: string;
1736
1631
  id: string;
@@ -1746,6 +1641,12 @@ export interface CommentRequired {
1746
1641
  mentionedUserIds?: string[];
1747
1642
  handleId?: string;
1748
1643
  }
1644
+ export interface CommentUpsert {
1645
+ body: IcePanel.CommentBody;
1646
+ commit?: number;
1647
+ mentionedUserIds?: string[];
1648
+ handleId?: string;
1649
+ }
1749
1650
  export interface Comment {
1750
1651
  body: IcePanel.CommentBody;
1751
1652
  commit: number;
@@ -1873,6 +1774,10 @@ export interface CommentReplyRequired {
1873
1774
  content: string;
1874
1775
  mentionedUserIds?: string[];
1875
1776
  }
1777
+ export interface CommentReplyUpsert {
1778
+ content: string;
1779
+ mentionedUserIds?: string[];
1780
+ }
1876
1781
  export interface CommentReply {
1877
1782
  content: string;
1878
1783
  mentionedUserIds: string[];
@@ -1941,8 +1846,7 @@ export interface DiagramPartial {
1941
1846
  pinnedAt?: string;
1942
1847
  pinnedIndex?: number;
1943
1848
  status?: IcePanel.DiagramStatus;
1944
- /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
1945
- zoomOverrides?: Record<string, string | null> | null;
1849
+ zoomOverrides?: IcePanel.DiagramZoomOverridesNullable | null;
1946
1850
  }
1947
1851
  export interface DiagramRequired {
1948
1852
  commit?: number;
@@ -1958,11 +1862,52 @@ export interface DiagramRequired {
1958
1862
  pinnedAt?: string;
1959
1863
  pinnedIndex?: number;
1960
1864
  status?: IcePanel.DiagramStatus;
1961
- /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
1962
- zoomOverrides?: Record<string, string | null> | null;
1865
+ zoomOverrides?: IcePanel.DiagramZoomOverridesNullable | null;
1963
1866
  handleId?: string;
1964
1867
  type: IcePanel.DiagramType;
1965
1868
  }
1869
+ /**
1870
+ * Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id.
1871
+ */
1872
+ export type DiagramZoomOverrides = Record<string, string>;
1873
+ export type DiagramZoomOverridesNullable = IcePanel.DiagramZoomOverrides | null;
1874
+ export interface DiagramContentPartialComments {
1875
+ $add?: Record<string, IcePanel.DiagramComment>;
1876
+ $remove?: string[];
1877
+ $replace?: Record<string, IcePanel.DiagramComment>;
1878
+ $update?: Record<string, IcePanel.DiagramCommentPartial>;
1879
+ }
1880
+ export interface DiagramContentPartialConnections {
1881
+ $add?: Record<string, IcePanel.DiagramConnection>;
1882
+ $remove?: string[];
1883
+ $replace?: Record<string, IcePanel.DiagramConnection>;
1884
+ $update?: Record<string, IcePanel.DiagramConnectionPartial>;
1885
+ }
1886
+ export interface DiagramContentPartialObjects {
1887
+ $add?: Record<string, IcePanel.DiagramObject>;
1888
+ $remove?: string[];
1889
+ $replace?: Record<string, IcePanel.DiagramObject>;
1890
+ $update?: Record<string, IcePanel.DiagramObjectPartial>;
1891
+ }
1892
+ export interface DiagramUpsert {
1893
+ commit?: number;
1894
+ description?: string;
1895
+ groupId?: string | null;
1896
+ index?: number;
1897
+ labels?: Record<string, string>;
1898
+ /** model object id this object belongs to */
1899
+ modelId?: string;
1900
+ name?: string;
1901
+ parentId?: string | null;
1902
+ pinned?: boolean;
1903
+ pinnedAt?: string;
1904
+ pinnedIndex?: number;
1905
+ status?: IcePanel.DiagramStatus;
1906
+ zoomOverrides?: IcePanel.DiagramZoomOverridesNullable | null;
1907
+ comments?: IcePanel.DiagramContentPartialComments;
1908
+ connections?: IcePanel.DiagramContentPartialConnections;
1909
+ objects?: IcePanel.DiagramContentPartialObjects;
1910
+ }
1966
1911
  export interface Diagram {
1967
1912
  commit: number;
1968
1913
  description: string;
@@ -1977,8 +1922,7 @@ export interface Diagram {
1977
1922
  pinnedAt?: string;
1978
1923
  pinnedIndex?: number;
1979
1924
  status: IcePanel.DiagramStatus;
1980
- /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
1981
- zoomOverrides?: Record<string, string | null> | null;
1925
+ zoomOverrides?: IcePanel.DiagramZoomOverridesNullable | null;
1982
1926
  handleId: string;
1983
1927
  type: IcePanel.DiagramType;
1984
1928
  commentCount: number;
@@ -2013,8 +1957,7 @@ export interface DiagramCreate {
2013
1957
  pinnedAt?: string;
2014
1958
  pinnedIndex?: number;
2015
1959
  status?: IcePanel.DiagramStatus;
2016
- /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
2017
- zoomOverrides?: Record<string, string | null> | null;
1960
+ zoomOverrides?: IcePanel.DiagramZoomOverridesNullable | null;
2018
1961
  handleId?: string;
2019
1962
  type: IcePanel.DiagramType;
2020
1963
  comments?: Record<string, IcePanel.DiagramComment>;
@@ -2228,6 +2171,14 @@ export interface DiagramGroupRequired {
2228
2171
  name: string;
2229
2172
  handleId?: string;
2230
2173
  }
2174
+ export interface DiagramGroupUpsert {
2175
+ commit?: number;
2176
+ index?: number;
2177
+ labels?: Record<string, string>;
2178
+ modelId: string;
2179
+ name: string;
2180
+ handleId?: string;
2181
+ }
2231
2182
  export interface DiagramGroup {
2232
2183
  commit: number;
2233
2184
  index: number;
@@ -2269,6 +2220,13 @@ export interface DomainRequired {
2269
2220
  name: string;
2270
2221
  handleId?: string;
2271
2222
  }
2223
+ export interface DomainUpsert {
2224
+ commit?: number;
2225
+ index?: number;
2226
+ labels?: Record<string, string>;
2227
+ name: string;
2228
+ handleId?: string;
2229
+ }
2272
2230
  export interface Domain {
2273
2231
  commit: number;
2274
2232
  index: number;
@@ -2429,8 +2387,7 @@ export interface DraftTaskDiagramCreateProps {
2429
2387
  pinnedAt?: string;
2430
2388
  pinnedIndex?: number;
2431
2389
  status?: IcePanel.DiagramStatus;
2432
- /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
2433
- zoomOverrides?: Record<string, string | null> | null;
2390
+ zoomOverrides?: IcePanel.DiagramZoomOverridesNullable | null;
2434
2391
  handleId?: string;
2435
2392
  type: IcePanel.DiagramType;
2436
2393
  comments?: Record<string, IcePanel.DiagramComment>;
@@ -2460,8 +2417,7 @@ export interface DraftTaskDiagramUpdateProps {
2460
2417
  pinnedAt?: string;
2461
2418
  pinnedIndex?: number;
2462
2419
  status?: IcePanel.DiagramStatus;
2463
- /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
2464
- zoomOverrides?: Record<string, string | null> | null;
2420
+ zoomOverrides?: IcePanel.DiagramZoomOverridesNullable | null;
2465
2421
  comments?: IcePanel.DiagramContentPartialComments;
2466
2422
  connections?: IcePanel.DiagramContentPartialConnections;
2467
2423
  objects?: IcePanel.DiagramContentPartialObjects;
@@ -2774,6 +2730,8 @@ export interface FlowStepPath {
2774
2730
  index: number;
2775
2731
  name: string;
2776
2732
  }
2733
+ export type FlowStepPaths = Record<string, IcePanel.FlowStepPath>;
2734
+ export type FlowStepPathsNullable = IcePanel.FlowStepPaths | null;
2777
2735
  /** Type of flow step - deprecated values: reply */
2778
2736
  export declare const FlowStepPartialType: {
2779
2737
  readonly AlternatePath: "alternate-path";
@@ -2797,7 +2755,7 @@ export interface FlowStepPartial {
2797
2755
  index?: number;
2798
2756
  originId?: string | null;
2799
2757
  parentId?: string | null;
2800
- paths?: Record<string, IcePanel.FlowStepPath | null> | null;
2758
+ paths?: IcePanel.FlowStepPathsNullable | null;
2801
2759
  targetId?: string | null;
2802
2760
  /** Type of flow step - deprecated values: reply */
2803
2761
  type?: IcePanel.FlowStepPartialType | null;
@@ -2813,7 +2771,7 @@ export interface FlowStep {
2813
2771
  index: number;
2814
2772
  originId: string | null;
2815
2773
  parentId: string | null;
2816
- paths: Record<string, IcePanel.FlowStepPath | null> | null;
2774
+ paths: IcePanel.FlowStepPathsNullable | null;
2817
2775
  targetId: string | null;
2818
2776
  /** Type of flow step - deprecated values: reply */
2819
2777
  type: IcePanel.FlowStepType | null;
@@ -2845,7 +2803,6 @@ export declare const LandscapeExportType: {
2845
2803
  readonly Markdown: "markdown";
2846
2804
  readonly Html: "html";
2847
2805
  readonly Llms: "llms";
2848
- readonly Structurizr: "structurizr";
2849
2806
  readonly Json: "json";
2850
2807
  };
2851
2808
  export type LandscapeExportType = (typeof LandscapeExportType)[keyof typeof LandscapeExportType];
@@ -2911,7 +2868,7 @@ export type ModelConnectionFilterViaId = string
2911
2868
  * Filter any connections with this via id */
2912
2869
  | string[];
2913
2870
  export interface ModelConnectionFilter {
2914
- direction?: IcePanel.ModelConnectionDirection | null;
2871
+ direction?: IcePanel.ModelConnectionDirection;
2915
2872
  handleId?: IcePanel.ModelConnectionFilterHandleId;
2916
2873
  labels?: Record<string, string>;
2917
2874
  linked?: boolean;
@@ -2928,6 +2885,7 @@ export declare const ModelConnectionDirection: {
2928
2885
  readonly Bidirectional: "bidirectional";
2929
2886
  };
2930
2887
  export type ModelConnectionDirection = (typeof ModelConnectionDirection)[keyof typeof ModelConnectionDirection];
2888
+ export type ModelConnectionDirectionNullable = IcePanel.ModelConnectionDirection | null;
2931
2889
  export declare const ModelConnectionStatus: {
2932
2890
  readonly Deprecated: "deprecated";
2933
2891
  readonly Future: "future";
@@ -2986,7 +2944,7 @@ string[]
2986
2944
  export interface ModelConnectionPartial {
2987
2945
  commit?: number;
2988
2946
  description?: string;
2989
- direction?: IcePanel.ModelConnectionDirection | null;
2947
+ direction?: IcePanel.ModelConnectionDirectionNullable | null;
2990
2948
  labels?: Record<string, string>;
2991
2949
  links?: IcePanel.ModelConnectionPartialLinks;
2992
2950
  name?: string;
@@ -3003,7 +2961,27 @@ export interface ModelConnectionPartial {
3003
2961
  export interface ModelConnectionRequired {
3004
2962
  commit?: number;
3005
2963
  description?: string;
3006
- direction: IcePanel.ModelConnectionDirection | null;
2964
+ direction: IcePanel.ModelConnectionDirectionNullable | null;
2965
+ labels?: Record<string, string>;
2966
+ links?: Record<string, IcePanel.RealityLinkRequired>;
2967
+ name: string;
2968
+ /** Model object that initiates the connection */
2969
+ originId: string;
2970
+ status?: IcePanel.ModelConnectionStatus;
2971
+ /** Tag IDs assigned to this model */
2972
+ tagIds?: string[];
2973
+ /** Model object that receives the message */
2974
+ targetId: string;
2975
+ /** Technology IDs assigned to this model */
2976
+ technologyIds?: string[];
2977
+ /** Model object that facilitates the connection, such as a Kafka topic, or RabbitMQ queue */
2978
+ viaId?: string | null;
2979
+ handleId?: string;
2980
+ }
2981
+ export interface ModelConnectionUpsert {
2982
+ commit?: number;
2983
+ description?: string;
2984
+ direction: IcePanel.ModelConnectionDirectionNullable | null;
3007
2985
  labels?: Record<string, string>;
3008
2986
  links?: Record<string, IcePanel.RealityLinkRequired>;
3009
2987
  name: string;
@@ -3023,7 +3001,7 @@ export interface ModelConnectionRequired {
3023
3001
  export interface ModelConnection {
3024
3002
  commit: number;
3025
3003
  description?: string;
3026
- direction: IcePanel.ModelConnectionDirection | null;
3004
+ direction: IcePanel.ModelConnectionDirectionNullable | null;
3027
3005
  labels: Record<string, string>;
3028
3006
  links: Record<string, IcePanel.RealityLink>;
3029
3007
  name: string;
@@ -3133,7 +3111,7 @@ export declare const ModelObjectStatus: {
3133
3111
  readonly Removed: "removed";
3134
3112
  };
3135
3113
  export type ModelObjectStatus = (typeof ModelObjectStatus)[keyof typeof ModelObjectStatus];
3136
- export interface ModelObjectIconNullable {
3114
+ export interface ModelObjectIcon {
3137
3115
  catalogTechnologyId: string;
3138
3116
  name: string;
3139
3117
  /** Use either urlDark or urlLight */
@@ -3143,6 +3121,7 @@ export interface ModelObjectIconNullable {
3143
3121
  /** Icon that only works on light backgrounds */
3144
3122
  urlLight?: string;
3145
3123
  }
3124
+ export type ModelObjectIconNullable = IcePanel.ModelObjectIcon | null;
3146
3125
  export interface ModelObjectDiagram {
3147
3126
  id: string;
3148
3127
  objectId: string;
@@ -3271,6 +3250,34 @@ export interface ModelObjectRequired {
3271
3250
  domainId?: string;
3272
3251
  handleId?: string;
3273
3252
  }
3253
+ export interface ModelObjectUpsert {
3254
+ /** Short summary of the object shown as the display description */
3255
+ caption?: string;
3256
+ commit?: number;
3257
+ description?: string;
3258
+ external?: boolean;
3259
+ /** IDs of the groups this model object belongs to */
3260
+ groupIds?: string[];
3261
+ icon?: IcePanel.ModelObjectIconNullable | null;
3262
+ /** Generic key value store used for creating custom integrations */
3263
+ labels?: Record<string, string>;
3264
+ links?: Record<string, IcePanel.RealityLinkRequired>;
3265
+ name: string;
3266
+ /** Parent model object ID, null for the root level model object */
3267
+ parentId: string | null;
3268
+ status?: IcePanel.ModelObjectStatus;
3269
+ /** Tag IDs assigned to this model */
3270
+ tagIds?: string[];
3271
+ /** Team IDs that own this model object, does not propergate up or down */
3272
+ teamIds?: string[];
3273
+ /** Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins */
3274
+ teamOnlyEditing?: boolean;
3275
+ /** Technology IDs assigned to this model */
3276
+ technologyIds?: string[];
3277
+ type: IcePanel.ModelObjectType;
3278
+ domainId?: string;
3279
+ handleId?: string;
3280
+ }
3274
3281
  export interface ModelObject {
3275
3282
  /** Short summary of the object shown as the display description */
3276
3283
  caption?: string;
@@ -3358,6 +3365,14 @@ export declare const OrganizationStatus: {
3358
3365
  readonly Unpaid: "unpaid";
3359
3366
  };
3360
3367
  export type OrganizationStatus = (typeof OrganizationStatus)[keyof typeof OrganizationStatus];
3368
+ export declare const OrganizationLanguage: {
3369
+ readonly EnUs: "en-US";
3370
+ readonly EnGb: "en-GB";
3371
+ readonly FrFr: "fr-FR";
3372
+ readonly EsEs: "es-ES";
3373
+ readonly Es419: "es-419";
3374
+ };
3375
+ export type OrganizationLanguage = (typeof OrganizationLanguage)[keyof typeof OrganizationLanguage];
3361
3376
  export interface OrganizationUser {
3362
3377
  landscapePermissions?: Record<string, boolean>;
3363
3378
  permission: IcePanel.PermissionType;
@@ -3368,34 +3383,56 @@ export interface OrganizationUserInfo {
3368
3383
  lastActiveAt: string;
3369
3384
  name?: string;
3370
3385
  }
3386
+ /**
3387
+ * AI features that are enabled for the organization
3388
+ */
3389
+ export interface OrganizationAiFeatures {
3390
+ /** Whether to enable detailed descriptions for objects, connections, and diagrams */
3391
+ generateDetailedDescriptions?: boolean;
3392
+ /** Whether to enable display descriptions for objects */
3393
+ generateDisplayDescriptions?: boolean;
3394
+ /** Whether to enable draft summaries for diagrams */
3395
+ generateDraftSummary?: boolean;
3396
+ /** Whether to enable object summaries for objects and connections in the right click context menu */
3397
+ generateObjectSummary?: boolean;
3398
+ }
3371
3399
  export interface OrganizationPartial {
3400
+ aiFeatures?: IcePanel.OrganizationAiFeatures;
3401
+ /** Whether to enable all AI features for the organization */
3372
3402
  aiFeaturesEnabled?: boolean;
3373
3403
  billingCurrency?: IcePanel.OrganizationBillingCurrency;
3374
3404
  billingCycle?: IcePanel.OrganizationBillingCycle;
3375
3405
  billingEmail?: string;
3376
3406
  experiments?: Record<string, boolean>;
3407
+ language?: IcePanel.OrganizationLanguage;
3377
3408
  lineShapeDefault?: IcePanel.LineShape;
3378
3409
  name?: string;
3379
3410
  shareLinkAuthDomains?: string[] | null;
3380
3411
  shareLinksEnabled?: boolean;
3381
3412
  }
3382
3413
  export interface OrganizationRequired {
3414
+ aiFeatures?: IcePanel.OrganizationAiFeatures;
3415
+ /** Whether to enable all AI features for the organization */
3383
3416
  aiFeaturesEnabled?: boolean;
3384
3417
  billingCurrency?: IcePanel.OrganizationBillingCurrency;
3385
3418
  billingCycle?: IcePanel.OrganizationBillingCycle;
3386
3419
  billingEmail?: string;
3387
3420
  experiments?: Record<string, boolean>;
3421
+ language?: IcePanel.OrganizationLanguage;
3388
3422
  lineShapeDefault?: IcePanel.LineShape;
3389
3423
  name: string;
3390
3424
  shareLinkAuthDomains?: string[] | null;
3391
3425
  shareLinksEnabled?: boolean;
3392
3426
  }
3393
3427
  export interface Organization {
3428
+ aiFeatures?: IcePanel.OrganizationAiFeatures;
3429
+ /** Whether to enable all AI features for the organization */
3394
3430
  aiFeaturesEnabled?: boolean;
3395
3431
  billingCurrency?: IcePanel.OrganizationBillingCurrency;
3396
3432
  billingCycle?: IcePanel.OrganizationBillingCycle;
3397
3433
  billingEmail?: string;
3398
3434
  experiments?: Record<string, boolean>;
3435
+ language?: IcePanel.OrganizationLanguage;
3399
3436
  lineShapeDefault: IcePanel.LineShape;
3400
3437
  name: string;
3401
3438
  shareLinkAuthDomains: string[] | null;
@@ -3612,6 +3649,15 @@ export interface TagRequired {
3612
3649
  name: string;
3613
3650
  handleId?: string;
3614
3651
  }
3652
+ export interface TagUpsert {
3653
+ color: IcePanel.TagColor;
3654
+ commit?: number;
3655
+ groupId: string;
3656
+ index: number;
3657
+ labels?: Record<string, string>;
3658
+ name: string;
3659
+ handleId?: string;
3660
+ }
3615
3661
  export interface Tag {
3616
3662
  color: IcePanel.TagColor;
3617
3663
  commit: number;
@@ -3691,6 +3737,14 @@ export interface TagGroupRequired {
3691
3737
  name: string;
3692
3738
  handleId?: string;
3693
3739
  }
3740
+ export interface TagGroupUpsert {
3741
+ commit?: number;
3742
+ icon: IcePanel.TagGroupIcon;
3743
+ index: number;
3744
+ labels?: Record<string, string>;
3745
+ name: string;
3746
+ handleId?: string;
3747
+ }
3694
3748
  export interface TagGroup {
3695
3749
  commit: number;
3696
3750
  icon: IcePanel.TagGroupIcon;
@@ -3783,6 +3837,11 @@ export interface VersionRevert {
3783
3837
  updatedBy: IcePanel.AuthType;
3784
3838
  updatedById: string;
3785
3839
  }
3840
+ export declare const AiDescriptionType: {
3841
+ readonly Caption: "caption";
3842
+ readonly Detailed: "detailed";
3843
+ };
3844
+ export type AiDescriptionType = (typeof AiDescriptionType)[keyof typeof AiDescriptionType];
3786
3845
  export declare const AuthType: {
3787
3846
  readonly User: "user";
3788
3847
  readonly ApiKey: "api-key";
@@ -3797,273 +3856,6 @@ export declare const PermissionType: {
3797
3856
  readonly Admin: "admin";
3798
3857
  };
3799
3858
  export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType];
3800
- export declare const BackstageApiApiVersion: {
3801
- readonly BackstageIoV1Alpha1: "backstage.io/v1alpha1";
3802
- readonly BackstageIoV1Beta1: "backstage.io/v1beta1";
3803
- };
3804
- export type BackstageApiApiVersion = (typeof BackstageApiApiVersion)[keyof typeof BackstageApiApiVersion];
3805
- export declare const BackstageApiKind: {
3806
- readonly Api: "API";
3807
- };
3808
- export type BackstageApiKind = (typeof BackstageApiKind)[keyof typeof BackstageApiKind];
3809
- export interface BackstageApiSpec {
3810
- /** The type of the API definition. */
3811
- type: string;
3812
- /** The lifecycle state of the API. */
3813
- lifecycle: string;
3814
- /** An entity reference to the owner of the API. */
3815
- owner: string;
3816
- /** An entity reference to the system that the API belongs to. */
3817
- system?: string;
3818
- /** The definition of the API, based on the format defined by the type. */
3819
- definition: string;
3820
- }
3821
- /**
3822
- * An API describes an interface that can be exposed by a component. The API can be defined in different formats, like OpenAPI, AsyncAPI, GraphQL, gRPC, or other formats.
3823
- */
3824
- export interface BackstageApi {
3825
- metadata: IcePanel.BackstageEntityMeta;
3826
- /** The relations that this entity has with other entities. */
3827
- relations?: IcePanel.BackstageRelation[];
3828
- status?: IcePanel.BackstageStatus;
3829
- apiVersion: IcePanel.BackstageApiApiVersion;
3830
- kind: IcePanel.BackstageApiKind;
3831
- spec: IcePanel.BackstageApiSpec;
3832
- }
3833
- export declare const BackstageComponentApiVersion: {
3834
- readonly BackstageIoV1Alpha1: "backstage.io/v1alpha1";
3835
- readonly BackstageIoV1Beta1: "backstage.io/v1beta1";
3836
- };
3837
- export type BackstageComponentApiVersion = (typeof BackstageComponentApiVersion)[keyof typeof BackstageComponentApiVersion];
3838
- export declare const BackstageComponentKind: {
3839
- readonly Component: "Component";
3840
- };
3841
- export type BackstageComponentKind = (typeof BackstageComponentKind)[keyof typeof BackstageComponentKind];
3842
- export interface BackstageComponentSpec {
3843
- /** The type of component. */
3844
- type: string;
3845
- /** The lifecycle state of the component. */
3846
- lifecycle: string;
3847
- /** An entity reference to the owner of the component. */
3848
- owner: string;
3849
- /** An entity reference to the system that the component belongs to. */
3850
- system?: string;
3851
- /** An entity reference to another component of which the component is a part. */
3852
- subcomponentOf?: string;
3853
- /** An array of entity references to the APIs that are provided by the component. */
3854
- providesApis?: string[];
3855
- /** An array of entity references to the APIs that are consumed by the component. */
3856
- consumesApis?: string[];
3857
- /** An array of references to other entities that the component depends on to function. */
3858
- dependsOn?: string[];
3859
- }
3860
- /**
3861
- * A Component describes a software component. It is typically intimately linked to the source code that constitutes the component, and should be what a developer may regard a "unit of software", usually with a distinct deployable or linkable artifact.
3862
- */
3863
- export interface BackstageComponent {
3864
- metadata: IcePanel.BackstageEntityMeta;
3865
- /** The relations that this entity has with other entities. */
3866
- relations?: IcePanel.BackstageRelation[];
3867
- status?: IcePanel.BackstageStatus;
3868
- apiVersion: IcePanel.BackstageComponentApiVersion;
3869
- kind: IcePanel.BackstageComponentKind;
3870
- spec: IcePanel.BackstageComponentSpec;
3871
- }
3872
- export declare const BackstageDomainApiVersion: {
3873
- readonly BackstageIoV1Alpha1: "backstage.io/v1alpha1";
3874
- readonly BackstageIoV1Beta1: "backstage.io/v1beta1";
3875
- };
3876
- export type BackstageDomainApiVersion = (typeof BackstageDomainApiVersion)[keyof typeof BackstageDomainApiVersion];
3877
- export declare const BackstageDomainKind: {
3878
- readonly Domain: "Domain";
3879
- };
3880
- export type BackstageDomainKind = (typeof BackstageDomainKind)[keyof typeof BackstageDomainKind];
3881
- export interface BackstageDomainSpec {
3882
- /** An entity reference to the owner of the component. */
3883
- owner: string;
3884
- }
3885
- /**
3886
- * A Domain groups a collection of systems that share terminology, domain models, business purpose, or documentation, i.e. form a bounded context.
3887
- */
3888
- export interface BackstageDomain {
3889
- metadata: IcePanel.BackstageEntityMeta;
3890
- /** The relations that this entity has with other entities. */
3891
- relations?: IcePanel.BackstageRelation[];
3892
- status?: IcePanel.BackstageStatus;
3893
- apiVersion: IcePanel.BackstageDomainApiVersion;
3894
- kind: IcePanel.BackstageDomainKind;
3895
- spec: IcePanel.BackstageDomainSpec;
3896
- }
3897
- /**
3898
- * The parts of the format that's common to all versions/kinds of entity.
3899
- */
3900
- export interface BackstageEntityMap {
3901
- apis?: IcePanel.BackstageApi[];
3902
- components?: IcePanel.BackstageComponent[];
3903
- domains?: IcePanel.BackstageDomain[];
3904
- resources?: IcePanel.BackstageResource[];
3905
- systems?: IcePanel.BackstageSystem[];
3906
- }
3907
- export interface BackstageEntityMetaLinksItem {
3908
- /** A url in a standard uri format. */
3909
- url: string;
3910
- /** A user friendly display name for the link. */
3911
- title?: string;
3912
- /** A key representing a visual icon to be displayed in the UI. */
3913
- icon?: string;
3914
- /** An optional value to categorize links into specific groups. */
3915
- type?: string;
3916
- }
3917
- /**
3918
- * Metadata fields common to all versions/kinds of entity.
3919
- */
3920
- export interface BackstageEntityMeta {
3921
- /** A globally unique ID for the entity. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, but the server is free to reject requests that do so in such a way that it breaks semantics. */
3922
- uid?: string;
3923
- /** An opaque string that changes for each update operation to any part of the entity, including metadata. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, and the server will then reject the operation if it does not match the current stored value. */
3924
- etag?: string;
3925
- /** The name of the entity. Must be unique within the catalog at any given point in time, for any given namespace + kind pair. */
3926
- name: string;
3927
- /** The namespace that the entity belongs to. */
3928
- namespace?: string;
3929
- /** A display name of the entity, to be presented in user interfaces instead of the name property, when available. */
3930
- title?: string;
3931
- /** A short (typically relatively few words, on one line) description of the entity. */
3932
- description?: string;
3933
- /** Key/value pairs of identifying information attached to the entity. */
3934
- labels?: Record<string, unknown>;
3935
- /** Key/value pairs of non-identifying auxiliary information attached to the entity. */
3936
- annotations?: Record<string, unknown> | null;
3937
- /** A list of single-valued strings, to for example classify catalog entities in various ways. */
3938
- tags?: string[];
3939
- /** A list of external hyperlinks related to the entity. Links can provide additional contextual information that may be located outside of Backstage itself. For example, an admin dashboard or external CMS page. */
3940
- links?: IcePanel.BackstageEntityMetaLinksItem[];
3941
- /** Accepts any additional properties */
3942
- [key: string]: any;
3943
- }
3944
- /**
3945
- * A serialized error object.
3946
- */
3947
- export interface BackstageError {
3948
- /** The type name of the error */
3949
- name: string;
3950
- /** The message of the error */
3951
- message: string;
3952
- /** An error code associated with the error */
3953
- code?: string;
3954
- /** An error stack trace */
3955
- stack?: string;
3956
- /** Accepts any additional properties */
3957
- [key: string]: any;
3958
- }
3959
- /**
3960
- * A reference by name to another entity.
3961
- */
3962
- export interface BackstageReference {
3963
- /** The kind field of the entity. */
3964
- kind: string;
3965
- /** The metadata.namespace field of the entity. */
3966
- namespace: string;
3967
- /** The metadata.name field of the entity. */
3968
- name: string;
3969
- }
3970
- /**
3971
- * A directed relation from one entity to another.
3972
- */
3973
- export interface BackstageRelation {
3974
- /** The type of relation. */
3975
- type: string;
3976
- target: IcePanel.BackstageReference;
3977
- /** The entity ref of the target of this relation. */
3978
- targetRef?: string;
3979
- }
3980
- export declare const BackstageResourceApiVersion: {
3981
- readonly BackstageIoV1Alpha1: "backstage.io/v1alpha1";
3982
- readonly BackstageIoV1Beta1: "backstage.io/v1beta1";
3983
- };
3984
- export type BackstageResourceApiVersion = (typeof BackstageResourceApiVersion)[keyof typeof BackstageResourceApiVersion];
3985
- export declare const BackstageResourceKind: {
3986
- readonly Resource: "Resource";
3987
- };
3988
- export type BackstageResourceKind = (typeof BackstageResourceKind)[keyof typeof BackstageResourceKind];
3989
- export interface BackstageResourceSpec {
3990
- /** The type of resource. */
3991
- type: string;
3992
- /** An entity reference to the owner of the resource. */
3993
- owner: string;
3994
- /** An array of references to other entities that the resource depends on to function. */
3995
- dependsOn?: string[];
3996
- /** An entity reference to the system that the resource belongs to. */
3997
- system?: string;
3998
- }
3999
- /**
4000
- * A resource describes the infrastructure a system needs to operate, like BigTable databases, Pub/Sub topics, S3 buckets or CDNs. Modelling them together with components and systems allows to visualize resource footprint, and create tooling around them.
4001
- */
4002
- export interface BackstageResource {
4003
- metadata: IcePanel.BackstageEntityMeta;
4004
- /** The relations that this entity has with other entities. */
4005
- relations?: IcePanel.BackstageRelation[];
4006
- status?: IcePanel.BackstageStatus;
4007
- apiVersion: IcePanel.BackstageResourceApiVersion;
4008
- kind: IcePanel.BackstageResourceKind;
4009
- spec: IcePanel.BackstageResourceSpec;
4010
- }
4011
- /**
4012
- * The current status of the entity, as claimed by various sources.
4013
- */
4014
- export interface BackstageStatus {
4015
- items?: IcePanel.BackstageStatusItem[];
4016
- /** Accepts any additional properties */
4017
- [key: string]: any;
4018
- }
4019
- /**
4020
- * A specific status item on a well known format.
4021
- */
4022
- export interface BackstageStatusItem {
4023
- type: string;
4024
- /** The status level / severity of the status item. */
4025
- level: IcePanel.BackstageStatusLevel;
4026
- /** A brief message describing the status, intended for human consumption. */
4027
- message: string;
4028
- /** An optional serialized error object related to the status. */
4029
- error?: IcePanel.BackstageError;
4030
- /** Accepts any additional properties */
4031
- [key: string]: any;
4032
- }
4033
- /** A status level / severity. */
4034
- export declare const BackstageStatusLevel: {
4035
- readonly Info: "info";
4036
- readonly Warning: "warning";
4037
- readonly Error: "error";
4038
- };
4039
- export type BackstageStatusLevel = (typeof BackstageStatusLevel)[keyof typeof BackstageStatusLevel];
4040
- export declare const BackstageSystemApiVersion: {
4041
- readonly BackstageIoV1Alpha1: "backstage.io/v1alpha1";
4042
- readonly BackstageIoV1Beta1: "backstage.io/v1beta1";
4043
- };
4044
- export type BackstageSystemApiVersion = (typeof BackstageSystemApiVersion)[keyof typeof BackstageSystemApiVersion];
4045
- export declare const BackstageSystemKind: {
4046
- readonly System: "System";
4047
- };
4048
- export type BackstageSystemKind = (typeof BackstageSystemKind)[keyof typeof BackstageSystemKind];
4049
- export interface BackstageSystemSpec {
4050
- /** An entity reference to the owner of the component. */
4051
- owner: string;
4052
- /** An entity reference to the domain that the system belongs to. */
4053
- domain?: string;
4054
- }
4055
- /**
4056
- * A system is a collection of resources and components. The system may expose or consume one or several APIs. It is viewed as abstraction level that provides potential consumers insights into exposed features without needing a too detailed view into the details of all components. This also gives the owning team the possibility to decide about published artifacts and APIs.
4057
- */
4058
- export interface BackstageSystem {
4059
- metadata: IcePanel.BackstageEntityMeta;
4060
- /** The relations that this entity has with other entities. */
4061
- relations?: IcePanel.BackstageRelation[];
4062
- status?: IcePanel.BackstageStatus;
4063
- apiVersion: IcePanel.BackstageSystemApiVersion;
4064
- kind: IcePanel.BackstageSystemKind;
4065
- spec: IcePanel.BackstageSystemSpec;
4066
- }
4067
3859
  export interface Error_ {
4068
3860
  code?: string;
4069
3861
  errors?: string[];
@@ -4091,7 +3883,7 @@ export interface DomainExport {
4091
3883
  }
4092
3884
  export interface ModelConnectionExport {
4093
3885
  description: string;
4094
- direction: IcePanel.ModelConnectionDirection | null;
3886
+ direction: IcePanel.ModelConnectionDirectionNullable | null;
4095
3887
  id: string;
4096
3888
  links?: Record<string, IcePanel.RealityLink>;
4097
3889
  name: string;
@@ -4428,1098 +4220,6 @@ export interface SearchResult {
4428
4220
  score: number;
4429
4221
  type: IcePanel.SearchIndexType;
4430
4222
  }
4431
- /**
4432
- * An animation step
4433
- */
4434
- export interface StructurizrAnimationStep {
4435
- /** The order of this animation step. */
4436
- order?: number;
4437
- /** The set of element IDs that should be included in this animation step. */
4438
- elements?: string[];
4439
- /** The set of relationship IDs that should be included in this animation step. */
4440
- relationships?: string[];
4441
- }
4442
- /** The automatic layout implementation. */
4443
- export declare const StructurizrAutomaticLayoutImplementation: {
4444
- readonly Graphviz: "Graphviz";
4445
- readonly Dagre: "Dagre";
4446
- };
4447
- export type StructurizrAutomaticLayoutImplementation = (typeof StructurizrAutomaticLayoutImplementation)[keyof typeof StructurizrAutomaticLayoutImplementation];
4448
- /** The algorithm rank direction. */
4449
- export declare const StructurizrAutomaticLayoutRankDirection: {
4450
- readonly TopBottom: "TopBottom";
4451
- readonly BottomTop: "BottomTop";
4452
- readonly LeftRight: "LeftRight";
4453
- readonly RightLeft: "RightLeft";
4454
- };
4455
- export type StructurizrAutomaticLayoutRankDirection = (typeof StructurizrAutomaticLayoutRankDirection)[keyof typeof StructurizrAutomaticLayoutRankDirection];
4456
- /**
4457
- * Represents the auto-layout configuration for a given view.
4458
- */
4459
- export interface StructurizrAutomaticLayout {
4460
- /** The automatic layout implementation. */
4461
- implementation?: IcePanel.StructurizrAutomaticLayoutImplementation;
4462
- /** The algorithm rank direction. */
4463
- rankDirection?: IcePanel.StructurizrAutomaticLayoutRankDirection;
4464
- /** The separation between ranks (pixels). */
4465
- rankSeparation?: number;
4466
- /** The separation between nodes in the same rank (pixels). */
4467
- nodeSeparation?: number;
4468
- /** The separation between edges (pixels). */
4469
- edgeSeparation?: number;
4470
- /** Whether vertices should be created during automatic layout. */
4471
- vertices?: boolean;
4472
- }
4473
- /**
4474
- * Represents a font, including a name and an optional URL for web fonts.
4475
- */
4476
- export interface StructurizrBrandingFont {
4477
- /** The font name (e.g. "Times New Roman", "Open Sans", etc). */
4478
- name?: string;
4479
- /** For web fonts, the URL where the font can be found. */
4480
- url?: string;
4481
- }
4482
- /**
4483
- * A wrapper for the font and logo for diagram/documentation branding purposes.
4484
- */
4485
- export interface StructurizrBranding {
4486
- /** A Base64 data URI representation of a PNG/JPG/GIF file. */
4487
- logo?: string;
4488
- /** Represents a font, including a name and an optional URL for web fonts. */
4489
- font?: IcePanel.StructurizrBrandingFont;
4490
- }
4491
- /**
4492
- * A component (a grouping of related functionality behind an interface that runs inside a container).
4493
- */
4494
- export interface StructurizrComponent {
4495
- /** The ID of this component in the model. */
4496
- id?: string;
4497
- /** The name of this component. */
4498
- name?: string;
4499
- /** A short description of this component. */
4500
- description?: string;
4501
- /** The technology associated with this component (e.g. Spring Bean). */
4502
- technology?: string;
4503
- /** A comma separated list of tags associated with this component. */
4504
- tags?: string;
4505
- /** The URL where more information about this element can be found. */
4506
- url?: string;
4507
- /** The name of the group in which this component should be included in. */
4508
- group?: string;
4509
- /** A set of arbitrary name-value properties. */
4510
- properties?: Record<string, unknown>;
4511
- /** The set of perspectives associated with this element. */
4512
- perspectives?: IcePanel.StructurizrPerspective[];
4513
- /** The set of relationships from this component to other elements. */
4514
- relationships?: IcePanel.StructurizrRelationship[];
4515
- documentation?: IcePanel.StructurizrDocumentation;
4516
- }
4517
- /** The paper size that should be used to render this view. */
4518
- export declare const StructurizrComponentViewPaperSize: {
4519
- readonly A6Portrait: "A6_Portrait";
4520
- readonly A6Landscape: "A6_Landscape";
4521
- readonly A5Portrait: "A5_Portrait";
4522
- readonly A5Landscape: "A5_Landscape";
4523
- readonly A4Portrait: "A4_Portrait";
4524
- readonly A4Landscape: "A4_Landscape";
4525
- readonly A3Portrait: "A3_Portrait";
4526
- readonly A3Landscape: "A3_Landscape";
4527
- readonly A2Portrait: "A2_Portrait";
4528
- readonly A2Landscape: "A2_Landscape";
4529
- readonly A1Portrait: "A1_Portrait";
4530
- readonly A1Landscape: "A1_Landscape";
4531
- readonly A0Portrait: "A0_Portrait";
4532
- readonly A0Landscape: "A0_Landscape";
4533
- readonly LetterPortrait: "Letter_Portrait";
4534
- readonly LetterLandscape: "Letter_Landscape";
4535
- readonly LegalPortrait: "Legal_Portrait";
4536
- readonly LegalLandscape: "Legal_Landscape";
4537
- readonly Slide43: "Slide_4_3";
4538
- readonly Slide169: "Slide_16_9";
4539
- readonly Slide1610: "Slide_16_10";
4540
- };
4541
- export type StructurizrComponentViewPaperSize = (typeof StructurizrComponentViewPaperSize)[keyof typeof StructurizrComponentViewPaperSize];
4542
- /**
4543
- * A component view.
4544
- */
4545
- export interface StructurizrComponentView {
4546
- /** A unique identifier for this view. */
4547
- key?: string;
4548
- /** An integer representing the creation order of this view. */
4549
- order?: number;
4550
- /** The title of this view (optional). */
4551
- title?: string;
4552
- /** The description of this view. */
4553
- description?: string;
4554
- /** A set of arbitrary name-value properties. */
4555
- properties?: Record<string, unknown>;
4556
- /** The ID of the container this view is associated with. */
4557
- containerId?: string;
4558
- /** The paper size that should be used to render this view. */
4559
- paperSize?: IcePanel.StructurizrComponentViewPaperSize;
4560
- dimensions?: IcePanel.StructurizrDimensions;
4561
- automaticLayout?: IcePanel.StructurizrAutomaticLayout;
4562
- /** The set of elements in this views. */
4563
- elements?: IcePanel.StructurizrElementView[];
4564
- /** The set of relationships in this views. */
4565
- relationships?: IcePanel.StructurizrRelationshipView[];
4566
- /** The set of animation steps (optional). */
4567
- animations?: IcePanel.StructurizrAnimationStep[];
4568
- /** Specifies whether container boundaries should be visible for "external" components (those outside the container in scope). */
4569
- externalContainerBoundariesVisible?: boolean;
4570
- }
4571
- /**
4572
- * The styles associated with this set of views.
4573
- */
4574
- export interface StructurizrConfigurationStyles {
4575
- /** The set of element styles. */
4576
- elements?: IcePanel.StructurizrElementStyle[];
4577
- /** The set of relationship styles. */
4578
- relationships?: IcePanel.StructurizrRelationshipStyle[];
4579
- }
4580
- /** The type of symbols to use when rendering metadata. */
4581
- export declare const StructurizrConfigurationMetadataSymbols: {
4582
- readonly SquareBrackets: "SquareBrackets";
4583
- readonly RoundBrackets: "RoundBrackets";
4584
- readonly CurlyBrackets: "CurlyBrackets";
4585
- readonly AngleBrackets: "AngleBrackets";
4586
- readonly DoubleAngleBrackets: "DoubleAngleBrackets";
4587
- readonly None: "None";
4588
- };
4589
- export type StructurizrConfigurationMetadataSymbols = (typeof StructurizrConfigurationMetadataSymbols)[keyof typeof StructurizrConfigurationMetadataSymbols];
4590
- /**
4591
- * The configuration associated with a set of views.
4592
- */
4593
- export interface StructurizrConfiguration {
4594
- /** The styles associated with this set of views. */
4595
- styles?: IcePanel.StructurizrConfigurationStyles;
4596
- /** The key of the view that was saved most recently. */
4597
- lastSavedView?: string;
4598
- /** The key of the view that should be shown by default. */
4599
- defaultView?: string;
4600
- /** The URL(s) of the theme(s) to be used when rendering diagrams. */
4601
- themes?: string[];
4602
- branding?: IcePanel.StructurizrBranding;
4603
- terminology?: IcePanel.StructurizrTerminology;
4604
- /** The type of symbols to use when rendering metadata. */
4605
- metadataSymbols?: IcePanel.StructurizrConfigurationMetadataSymbols;
4606
- /** A set of arbitrary name-value properties. */
4607
- properties?: Record<string, unknown>;
4608
- }
4609
- /**
4610
- * A container (something that can execute code or host data).
4611
- */
4612
- export interface StructurizrContainer {
4613
- /** The ID of this container in the model. */
4614
- id?: string;
4615
- /** The name of this container. */
4616
- name?: string;
4617
- /** A short description of this container. */
4618
- description?: string;
4619
- /** The technology associated with this container (e.g. Apache Tomcat). */
4620
- technology?: string;
4621
- /** A comma separated list of tags associated with this container. */
4622
- tags?: string;
4623
- /** The URL where more information about this element can be found. */
4624
- url?: string;
4625
- /** The set of components within this container. */
4626
- components?: IcePanel.StructurizrComponent[];
4627
- /** The name of the group in which this container should be included in. */
4628
- group?: string;
4629
- /** A set of arbitrary name-value properties. */
4630
- properties?: Record<string, unknown>;
4631
- /** The set of perspectives associated with this element. */
4632
- perspectives?: IcePanel.StructurizrPerspective[];
4633
- /** The set of relationships from this container to other elements. */
4634
- relationships?: IcePanel.StructurizrRelationship[];
4635
- documentation?: IcePanel.StructurizrDocumentation;
4636
- }
4637
- /**
4638
- * An instance of a container, running on a deployment node.
4639
- */
4640
- export interface StructurizrContainerInstance {
4641
- /** The ID of this container instance in the model. */
4642
- id?: string;
4643
- /** The ID of the container this is an instance of. */
4644
- containerId?: string;
4645
- /** The number/index of this instance. */
4646
- instanceId?: number;
4647
- /** The deployment environment in which this container instance resides (e.g. "Development", "Live", etc). */
4648
- environment?: string;
4649
- /** A comma separated list of tags associated with this container instance. */
4650
- tags?: string;
4651
- /** A set of arbitrary name-value properties. */
4652
- properties?: Record<string, unknown>;
4653
- /** The set of perspectives associated with this element. */
4654
- perspectives?: IcePanel.StructurizrPerspective[];
4655
- /** The set of relationships from this container instance to other elements. */
4656
- relationships?: IcePanel.StructurizrRelationship[];
4657
- /** The set of HTTP-based health checks for this container instance. */
4658
- healthChecks?: IcePanel.StructurizrHttpHealthCheck[];
4659
- }
4660
- /** The paper size that should be used to render this view. */
4661
- export declare const StructurizrContainerViewPaperSize: {
4662
- readonly A6Portrait: "A6_Portrait";
4663
- readonly A6Landscape: "A6_Landscape";
4664
- readonly A5Portrait: "A5_Portrait";
4665
- readonly A5Landscape: "A5_Landscape";
4666
- readonly A4Portrait: "A4_Portrait";
4667
- readonly A4Landscape: "A4_Landscape";
4668
- readonly A3Portrait: "A3_Portrait";
4669
- readonly A3Landscape: "A3_Landscape";
4670
- readonly A2Portrait: "A2_Portrait";
4671
- readonly A2Landscape: "A2_Landscape";
4672
- readonly A1Portrait: "A1_Portrait";
4673
- readonly A1Landscape: "A1_Landscape";
4674
- readonly A0Portrait: "A0_Portrait";
4675
- readonly A0Landscape: "A0_Landscape";
4676
- readonly LetterPortrait: "Letter_Portrait";
4677
- readonly LetterLandscape: "Letter_Landscape";
4678
- readonly LegalPortrait: "Legal_Portrait";
4679
- readonly LegalLandscape: "Legal_Landscape";
4680
- readonly Slide43: "Slide_4_3";
4681
- readonly Slide169: "Slide_16_9";
4682
- readonly Slide1610: "Slide_16_10";
4683
- };
4684
- export type StructurizrContainerViewPaperSize = (typeof StructurizrContainerViewPaperSize)[keyof typeof StructurizrContainerViewPaperSize];
4685
- /**
4686
- * A container view.
4687
- */
4688
- export interface StructurizrContainerView {
4689
- /** A unique identifier for this view. */
4690
- key?: string;
4691
- /** An integer representing the creation order of this view. */
4692
- order?: number;
4693
- /** The title of this view (optional). */
4694
- title?: string;
4695
- /** The description of this view. */
4696
- description?: string;
4697
- /** A set of arbitrary name-value properties. */
4698
- properties?: Record<string, unknown>;
4699
- /** The ID of the software system this view is associated with. */
4700
- softwareSystemId?: string;
4701
- /** The paper size that should be used to render this view. */
4702
- paperSize?: IcePanel.StructurizrContainerViewPaperSize;
4703
- dimensions?: IcePanel.StructurizrDimensions;
4704
- automaticLayout?: IcePanel.StructurizrAutomaticLayout;
4705
- /** The set of elements in this views. */
4706
- elements?: IcePanel.StructurizrElementView[];
4707
- /** The set of relationships in this views. */
4708
- relationships?: IcePanel.StructurizrRelationshipView[];
4709
- /** The set of animation steps (optional). */
4710
- animations?: IcePanel.StructurizrAnimationStep[];
4711
- /** Specifies whether software system boundaries should be visible for "external" containers (those outside the software system in scope). */
4712
- externalSoftwareSystemBoundariesVisible?: boolean;
4713
- }
4714
- /** The status of the decision. */
4715
- export declare const StructurizrDecisionStatus: {
4716
- readonly Proposed: "Proposed";
4717
- readonly Accepted: "Accepted";
4718
- readonly Superseded: "Superseded";
4719
- readonly Deprecated: "Deprecated";
4720
- readonly Rejected: "Rejected";
4721
- };
4722
- export type StructurizrDecisionStatus = (typeof StructurizrDecisionStatus)[keyof typeof StructurizrDecisionStatus];
4723
- /** The content format type. */
4724
- export declare const StructurizrDecisionFormat: {
4725
- readonly Markdown: "Markdown";
4726
- readonly AsciiDoc: "AsciiDoc";
4727
- };
4728
- export type StructurizrDecisionFormat = (typeof StructurizrDecisionFormat)[keyof typeof StructurizrDecisionFormat];
4729
- /**
4730
- * A decision record (e.g. architecture decision record).
4731
- */
4732
- export interface StructurizrDecision {
4733
- /** The ID of the decision. */
4734
- id?: string;
4735
- /** The date that the decision was made (ISO 8601 format). */
4736
- date?: string;
4737
- /** The status of the decision. */
4738
- status?: IcePanel.StructurizrDecisionStatus;
4739
- /** The title of the decision. */
4740
- title?: string;
4741
- /** The Markdown or AsciiDoc content of the section. */
4742
- content?: string;
4743
- /** The content format type. */
4744
- format?: IcePanel.StructurizrDecisionFormat;
4745
- /** The ID of the element (in the model) that this decision applies to (optional). */
4746
- elementId?: string;
4747
- }
4748
- /**
4749
- * A deployment node.
4750
- */
4751
- export interface StructurizrDeploymentNode {
4752
- /** The ID of this deployment node in the model. */
4753
- id?: string;
4754
- /** The name of this deployment node. */
4755
- name?: string;
4756
- /** A short description of this deployment node. */
4757
- description?: string;
4758
- /** The technology associated with this deployment node (e.g. Apache Tomcat). */
4759
- technology?: string;
4760
- /** The deployment environment in which this deployment node resides (e.g. "Development", "Live", etc). */
4761
- environment?: string;
4762
- /** The number of instances; either a number (e.g. 1, 2, etc) or a range (e.g. 0..N, 0..*, 1..3, etc). */
4763
- instances?: string;
4764
- /** A comma separated list of tags associated with this deployment node. */
4765
- tags?: string;
4766
- /** The URL where more information about this element can be found. */
4767
- url?: string;
4768
- /** The set of child/nested deployment nodes. */
4769
- children?: IcePanel.StructurizrDeploymentNode[];
4770
- infrastructureNodes?: IcePanel.StructurizrInfrastructureNode[];
4771
- /** The set of software systems instances running in this deployment node.. */
4772
- softwareSystemInstances?: IcePanel.StructurizrSoftwareSystemInstance[];
4773
- /** The set of container instances running in this deployment node.. */
4774
- containerInstances?: IcePanel.StructurizrContainerInstance[];
4775
- /** A set of arbitrary name-value properties. */
4776
- properties?: Record<string, unknown>;
4777
- /** The set of perspectives associated with this element. */
4778
- perspectives?: IcePanel.StructurizrPerspective[];
4779
- /** The set of relationships from this deployment node to other elements. */
4780
- relationships?: IcePanel.StructurizrRelationship[];
4781
- }
4782
- /** The paper size that should be used to render this view. */
4783
- export declare const StructurizrDeploymentViewPaperSize: {
4784
- readonly A6Portrait: "A6_Portrait";
4785
- readonly A6Landscape: "A6_Landscape";
4786
- readonly A5Portrait: "A5_Portrait";
4787
- readonly A5Landscape: "A5_Landscape";
4788
- readonly A4Portrait: "A4_Portrait";
4789
- readonly A4Landscape: "A4_Landscape";
4790
- readonly A3Portrait: "A3_Portrait";
4791
- readonly A3Landscape: "A3_Landscape";
4792
- readonly A2Portrait: "A2_Portrait";
4793
- readonly A2Landscape: "A2_Landscape";
4794
- readonly A1Portrait: "A1_Portrait";
4795
- readonly A1Landscape: "A1_Landscape";
4796
- readonly A0Portrait: "A0_Portrait";
4797
- readonly A0Landscape: "A0_Landscape";
4798
- readonly LetterPortrait: "Letter_Portrait";
4799
- readonly LetterLandscape: "Letter_Landscape";
4800
- readonly LegalPortrait: "Legal_Portrait";
4801
- readonly LegalLandscape: "Legal_Landscape";
4802
- readonly Slide43: "Slide_4_3";
4803
- readonly Slide169: "Slide_16_9";
4804
- readonly Slide1610: "Slide_16_10";
4805
- };
4806
- export type StructurizrDeploymentViewPaperSize = (typeof StructurizrDeploymentViewPaperSize)[keyof typeof StructurizrDeploymentViewPaperSize];
4807
- /**
4808
- * A deployment view.
4809
- */
4810
- export interface StructurizrDeploymentView {
4811
- /** A unique identifier for this view. */
4812
- key?: string;
4813
- /** An integer representing the creation order of this view. */
4814
- order?: number;
4815
- /** The title of this view (optional). */
4816
- title?: string;
4817
- /** The description of this view. */
4818
- description?: string;
4819
- /** A set of arbitrary name-value properties. */
4820
- properties?: Record<string, unknown>;
4821
- /** The ID of the software system this view is associated with (optional). */
4822
- softwareSystemId?: string;
4823
- /** The name of the environment that this deployment view is for (e.g. "Development", "Live", etc). */
4824
- environment?: string;
4825
- /** The paper size that should be used to render this view. */
4826
- paperSize?: IcePanel.StructurizrDeploymentViewPaperSize;
4827
- dimensions?: IcePanel.StructurizrDimensions;
4828
- automaticLayout?: IcePanel.StructurizrAutomaticLayout;
4829
- /** The set of elements in this views. */
4830
- elements?: IcePanel.StructurizrElementView[];
4831
- /** The set of relationships in this views. */
4832
- relationships?: IcePanel.StructurizrRelationshipView[];
4833
- /** The set of animation steps (optional). */
4834
- animations?: IcePanel.StructurizrAnimationStep[];
4835
- }
4836
- /**
4837
- * Represents a width and height pair.
4838
- */
4839
- export interface StructurizrDimensions {
4840
- /** The width (pixels). */
4841
- width?: number;
4842
- /** The height (pixels). */
4843
- height?: number;
4844
- }
4845
- /**
4846
- * A wrapper for documentation.
4847
- */
4848
- export interface StructurizrDocumentation {
4849
- sections?: IcePanel.StructurizrDocumentationSection[];
4850
- decisions?: IcePanel.StructurizrDecision[];
4851
- images?: IcePanel.StructurizrImage[];
4852
- }
4853
- /** The content format type. */
4854
- export declare const StructurizrDocumentationSectionFormat: {
4855
- readonly Markdown: "Markdown";
4856
- readonly AsciiDoc: "AsciiDoc";
4857
- };
4858
- export type StructurizrDocumentationSectionFormat = (typeof StructurizrDocumentationSectionFormat)[keyof typeof StructurizrDocumentationSectionFormat];
4859
- /**
4860
- * A documentation section.
4861
- */
4862
- export interface StructurizrDocumentationSection {
4863
- /** The Markdown or AsciiDoc content of the section. */
4864
- content?: string;
4865
- /** The content format type. */
4866
- format?: IcePanel.StructurizrDocumentationSectionFormat;
4867
- /** The order (index) of the section in the document. */
4868
- order?: number;
4869
- }
4870
- /** The paper size that should be used to render this view. */
4871
- export declare const StructurizrDynamicViewPaperSize: {
4872
- readonly A6Portrait: "A6_Portrait";
4873
- readonly A6Landscape: "A6_Landscape";
4874
- readonly A5Portrait: "A5_Portrait";
4875
- readonly A5Landscape: "A5_Landscape";
4876
- readonly A4Portrait: "A4_Portrait";
4877
- readonly A4Landscape: "A4_Landscape";
4878
- readonly A3Portrait: "A3_Portrait";
4879
- readonly A3Landscape: "A3_Landscape";
4880
- readonly A2Portrait: "A2_Portrait";
4881
- readonly A2Landscape: "A2_Landscape";
4882
- readonly A1Portrait: "A1_Portrait";
4883
- readonly A1Landscape: "A1_Landscape";
4884
- readonly A0Portrait: "A0_Portrait";
4885
- readonly A0Landscape: "A0_Landscape";
4886
- readonly LetterPortrait: "Letter_Portrait";
4887
- readonly LetterLandscape: "Letter_Landscape";
4888
- readonly LegalPortrait: "Legal_Portrait";
4889
- readonly LegalLandscape: "Legal_Landscape";
4890
- readonly Slide43: "Slide_4_3";
4891
- readonly Slide169: "Slide_16_9";
4892
- readonly Slide1610: "Slide_16_10";
4893
- };
4894
- export type StructurizrDynamicViewPaperSize = (typeof StructurizrDynamicViewPaperSize)[keyof typeof StructurizrDynamicViewPaperSize];
4895
- /**
4896
- * A dynamic view.
4897
- */
4898
- export interface StructurizrDynamicView {
4899
- /** A unique identifier for this view. */
4900
- key?: string;
4901
- /** An integer representing the creation order of this view. */
4902
- order?: number;
4903
- /** The title of this view (optional). */
4904
- title?: string;
4905
- /** The description of this view. */
4906
- description?: string;
4907
- /** A set of arbitrary name-value properties. */
4908
- properties?: Record<string, unknown>;
4909
- /** The ID of the element this view is associated with (optional). */
4910
- elementId?: string;
4911
- /** The paper size that should be used to render this view. */
4912
- paperSize?: IcePanel.StructurizrDynamicViewPaperSize;
4913
- dimensions?: IcePanel.StructurizrDimensions;
4914
- automaticLayout?: IcePanel.StructurizrAutomaticLayout;
4915
- /** The set of elements in this views. */
4916
- elements?: IcePanel.StructurizrElementView[];
4917
- /** The set of relationships in this views. */
4918
- relationships?: IcePanel.StructurizrRelationshipView[];
4919
- /** Specifies software system/container boundaries should be visible for "external" containers/components (those outside the element in scope) */
4920
- externalBoundariesVisible?: boolean;
4921
- }
4922
- /** The shape used to render the element. */
4923
- export declare const StructurizrElementStyleShape: {
4924
- readonly Box: "Box";
4925
- readonly RoundedBox: "RoundedBox";
4926
- readonly Component: "Component";
4927
- readonly Circle: "Circle";
4928
- readonly Ellipse: "Ellipse";
4929
- readonly Hexagon: "Hexagon";
4930
- readonly Diamond: "Diamond";
4931
- readonly Folder: "Folder";
4932
- readonly Cylinder: "Cylinder";
4933
- readonly Pipe: "Pipe";
4934
- readonly WebBrowser: "WebBrowser";
4935
- readonly Window: "Window";
4936
- readonly MobileDevicePortrait: "MobileDevicePortrait";
4937
- readonly MobileDeviceLandscape: "MobileDeviceLandscape";
4938
- readonly Person: "Person";
4939
- readonly Robot: "Robot";
4940
- };
4941
- export type StructurizrElementStyleShape = (typeof StructurizrElementStyleShape)[keyof typeof StructurizrElementStyleShape];
4942
- /** The type of border used to render the element. */
4943
- export declare const StructurizrElementStyleBorder: {
4944
- readonly Solid: "Solid";
4945
- readonly Dashed: "Dashed";
4946
- readonly Dotted: "Dotted";
4947
- };
4948
- export type StructurizrElementStyleBorder = (typeof StructurizrElementStyleBorder)[keyof typeof StructurizrElementStyleBorder];
4949
- /**
4950
- * A definition of an element style.
4951
- */
4952
- export interface StructurizrElementStyle {
4953
- /** The tag to which this element style applies. */
4954
- tag?: string;
4955
- /** The width of the element, in pixels. */
4956
- width?: number;
4957
- /** The height of the element, in pixels. */
4958
- height?: number;
4959
- /** The background colour of the element, as a HTML RGB hex string (e.g. '#ffffff'). */
4960
- background?: string;
4961
- /** The stroke colour of the element, as a HTML RGB hex string (e.g. '#000000'). */
4962
- stroke?: string;
4963
- /** The width of the stroke, in pixels. */
4964
- strokeWidth?: number;
4965
- /** The foreground (text) colour of the element, as a HTML RGB hex string (e.g. '#ffffff'). */
4966
- color?: string;
4967
- /** The standard font size used to render text, in pixels. */
4968
- fontSize?: number;
4969
- /** The shape used to render the element. */
4970
- shape?: IcePanel.StructurizrElementStyleShape;
4971
- /** A Base64 data URI representation of a PNG/JPG/GIF file. */
4972
- icon?: string;
4973
- /** The type of border used to render the element. */
4974
- border?: IcePanel.StructurizrElementStyleBorder;
4975
- /** The opacity used when rendering the element; 0-100. */
4976
- opacity?: number;
4977
- /** Whether the element metadata should be shown or not. */
4978
- metadata?: boolean;
4979
- /** Whether the element description should be shown or not. */
4980
- description?: boolean;
4981
- }
4982
- /**
4983
- * An instance of a model element (Person, Software System, Container or Component) in a View.
4984
- */
4985
- export interface StructurizrElementView {
4986
- /** The ID of the element. */
4987
- id?: string;
4988
- /** The horizontal position of the element when rendered. */
4989
- x?: number;
4990
- /** The vertical position of the element when rendered. */
4991
- y?: number;
4992
- }
4993
- /** Whether elements/relationships are being included or excluded based upon the set of tags. */
4994
- export declare const StructurizrFilteredViewMode: {
4995
- readonly Include: "Include";
4996
- readonly Exclude: "Exclude";
4997
- };
4998
- export type StructurizrFilteredViewMode = (typeof StructurizrFilteredViewMode)[keyof typeof StructurizrFilteredViewMode];
4999
- /**
5000
- * Represents a view on top of a view, which can be used to include or exclude specific elements.
5001
- */
5002
- export interface StructurizrFilteredView {
5003
- /** A unique identifier for this view. */
5004
- key?: string;
5005
- /** An integer representing the creation order of this view. */
5006
- order?: number;
5007
- /** The title of this view (optional). */
5008
- title?: string;
5009
- /** The description of this view. */
5010
- description?: string;
5011
- /** A set of arbitrary name-value properties. */
5012
- properties?: Record<string, unknown>;
5013
- /** The key of the view on which this filtered view is based. */
5014
- baseViewKey?: string;
5015
- /** Whether elements/relationships are being included or excluded based upon the set of tags. */
5016
- mode?: IcePanel.StructurizrFilteredViewMode;
5017
- /** The set of tags to include/exclude elements/relationships when rendering this filtered view. */
5018
- tags?: string[];
5019
- }
5020
- /**
5021
- * Describes a HTTP based health check.
5022
- */
5023
- export interface StructurizrHttpHealthCheck {
5024
- /** The name of the health check. */
5025
- name?: string;
5026
- /** The health check URL/endpoint. */
5027
- url?: string;
5028
- /** The polling interval, in seconds. */
5029
- interval?: number;
5030
- /** The timeout after which a health check is deemed as failed, in milliseconds. */
5031
- timeout?: number;
5032
- /** A set of name-value pairs corresponding to HTTP headers that should be sent with the request. */
5033
- headers?: Record<string, unknown>;
5034
- }
5035
- /**
5036
- * Represents a base64 encoded image (png/jpg/gif).
5037
- */
5038
- export interface StructurizrImage {
5039
- /** The name of the image. */
5040
- name?: string;
5041
- /** The (base64 encoded) content of the image. */
5042
- content?: string;
5043
- /** The image MIME type (e.g. "image/png"). */
5044
- type?: string;
5045
- }
5046
- /**
5047
- * A view that has been rendered elsewhere (e.g. PlantUML, Mermaid, Kroki, etc) as a image (e.g. PNG).
5048
- */
5049
- export interface StructurizrImageView {
5050
- /** A unique identifier for this view. */
5051
- key?: string;
5052
- /** An integer representing the creation order of this view. */
5053
- order?: number;
5054
- /** The title of this view (optional). */
5055
- title?: string;
5056
- /** The description of this view. */
5057
- description?: string;
5058
- /** A set of arbitrary name-value properties. */
5059
- properties?: Record<string, unknown>;
5060
- /** The ID of the element this view is associated with (optional). */
5061
- elementId?: string;
5062
- /** The content of this image view, which needs to be a URL or a data URI. */
5063
- content?: string;
5064
- /** The content type of this view (e.g. "image/png"). */
5065
- contentType?: string;
5066
- }
5067
- /**
5068
- * An infrastructure node.
5069
- */
5070
- export interface StructurizrInfrastructureNode {
5071
- /** The ID of this infrastructure node in the model. */
5072
- id?: string;
5073
- /** The name of this infrastructure node. */
5074
- name?: string;
5075
- /** A short description of this infrastructure node. */
5076
- description?: string;
5077
- /** The technology associated with this infrastructure node (e.g. "Route 53"). */
5078
- technology?: string;
5079
- /** The deployment environment in which this infrastructure node resides (e.g. "Development", "Live", etc). */
5080
- environment?: string;
5081
- /** A comma separated list of tags associated with this infrastructure node. */
5082
- tags?: string;
5083
- /** The URL where more information about this element can be found. */
5084
- url?: string;
5085
- /** A set of arbitrary name-value properties. */
5086
- properties?: Record<string, unknown>;
5087
- /** The set of perspectives associated with this element. */
5088
- perspectives?: IcePanel.StructurizrPerspective[];
5089
- /** The set of relationships from this infrastructure node to other elements. */
5090
- relationships?: IcePanel.StructurizrRelationship[];
5091
- }
5092
- /**
5093
- * The enterprise associated with this model.
5094
- */
5095
- export interface StructurizrModelEnterprise {
5096
- /** The name of the enterprise. */
5097
- name?: string;
5098
- }
5099
- /**
5100
- * A software architecture model.
5101
- */
5102
- export interface StructurizrModel {
5103
- /** The enterprise associated with this model. */
5104
- enterprise?: IcePanel.StructurizrModelEnterprise;
5105
- people?: IcePanel.StructurizrPerson[];
5106
- softwareSystems?: IcePanel.StructurizrSoftwareSystem[];
5107
- deploymentNodes?: IcePanel.StructurizrDeploymentNode[];
5108
- /** A set of arbitrary name-value properties. */
5109
- properties?: Record<string, unknown>;
5110
- }
5111
- /** The location of this person. */
5112
- export declare const StructurizrPersonLocation: {
5113
- readonly External: "External";
5114
- readonly Internal: "Internal";
5115
- readonly Unspecified: "Unspecified";
5116
- };
5117
- export type StructurizrPersonLocation = (typeof StructurizrPersonLocation)[keyof typeof StructurizrPersonLocation];
5118
- /**
5119
- * A person who uses a software system.
5120
- */
5121
- export interface StructurizrPerson {
5122
- /** The ID of this person in the model. */
5123
- id?: string;
5124
- /** The name of this person. */
5125
- name?: string;
5126
- /** A short description of this person. */
5127
- description?: string;
5128
- /** A comma separated list of tags associated with this person. */
5129
- tags?: string;
5130
- /** The URL where more information about this element can be found. */
5131
- url?: string;
5132
- /** The location of this person. */
5133
- location?: IcePanel.StructurizrPersonLocation;
5134
- /** The name of the group in which this person should be included in. */
5135
- group?: string;
5136
- /** A set of arbitrary name-value properties. */
5137
- properties?: Record<string, unknown>;
5138
- /** The set of perspectives associated with this element. */
5139
- perspectives?: IcePanel.StructurizrPerspective[];
5140
- /** The set of relationships from this person to other elements. */
5141
- relationships?: IcePanel.StructurizrRelationship[];
5142
- }
5143
- /**
5144
- * Represents an architectural perspective, that can be applied to elements and relationships.
5145
- */
5146
- export interface StructurizrPerspective {
5147
- /** The name of this perspective (e.g. "Security"). */
5148
- name?: string;
5149
- /** The description of this perspective. */
5150
- description?: string;
5151
- /** The value of this perspective (optional). */
5152
- value?: string;
5153
- }
5154
- /** The interaction style (synchronous or asynchronous). */
5155
- export declare const StructurizrRelationshipInteractionStyle: {
5156
- readonly Synchronous: "Synchronous";
5157
- readonly Asynchronous: "Asynchronous";
5158
- };
5159
- export type StructurizrRelationshipInteractionStyle = (typeof StructurizrRelationshipInteractionStyle)[keyof typeof StructurizrRelationshipInteractionStyle];
5160
- /**
5161
- * A relationship between two elements.
5162
- */
5163
- export interface StructurizrRelationship {
5164
- /** The ID of this relationship in the model. */
5165
- id?: string;
5166
- /** A short description of this relationship. */
5167
- description?: string;
5168
- /** A comma separated list of tags associated with this relationship. */
5169
- tags?: string;
5170
- /** The URL where more information about this relationship can be found. */
5171
- url?: string;
5172
- /** A set of arbitrary name-value properties. */
5173
- properties?: Record<string, unknown>;
5174
- /** The set of perspectives associated with this relationship. */
5175
- perspectives?: IcePanel.StructurizrPerspective[];
5176
- /** The ID of the source element. */
5177
- sourceId?: string;
5178
- /** The ID of the destination element. */
5179
- destinationId?: string;
5180
- /** The technology associated with this relationship (e.g. HTTPS, JDBC, etc). */
5181
- technology?: string;
5182
- /** The interaction style (synchronous or asynchronous). */
5183
- interactionStyle?: IcePanel.StructurizrRelationshipInteractionStyle;
5184
- /** The ID of the container-container relationship upon which this container instance-container instance relationship is based. */
5185
- linkedRelationshipId?: string;
5186
- }
5187
- /** The routing algorithm used when rendering lines. */
5188
- export declare const StructurizrRelationshipStyleRouting: {
5189
- readonly Direct: "Direct";
5190
- readonly Curved: "Curved";
5191
- readonly Orthogonal: "Orthogonal";
5192
- };
5193
- export type StructurizrRelationshipStyleRouting = (typeof StructurizrRelationshipStyleRouting)[keyof typeof StructurizrRelationshipStyleRouting];
5194
- /**
5195
- * A definition of a relationship style.
5196
- */
5197
- export interface StructurizrRelationshipStyle {
5198
- /** The tag to which this relationship style applies. */
5199
- tag?: string;
5200
- /** The thickness of the line, in pixels. */
5201
- thickness?: number;
5202
- /** The colour of the line, as a HTML RGB hex string (e.g. '#ffffff'). */
5203
- color?: string;
5204
- /** The standard font size used to render the relationship annotation, in pixels. */
5205
- fontSize?: number;
5206
- /** The width of the relationship annotation, in pixels. */
5207
- width?: number;
5208
- /** A flag to indicate whether the line is rendered as dashed or not. */
5209
- dashed?: boolean;
5210
- /** The routing algorithm used when rendering lines. */
5211
- routing?: IcePanel.StructurizrRelationshipStyleRouting;
5212
- /** The position of the annotation along the line; 0 (start) to 100 (end). */
5213
- position?: number;
5214
- /** The opacity used when rendering the line; 0-100. */
5215
- opacity?: number;
5216
- }
5217
- /** The routing algorithm used when rendering this individual relationship. */
5218
- export declare const StructurizrRelationshipViewRouting: {
5219
- readonly Direct: "Direct";
5220
- readonly Curved: "Curved";
5221
- readonly Orthogonal: "Orthogonal";
5222
- };
5223
- export type StructurizrRelationshipViewRouting = (typeof StructurizrRelationshipViewRouting)[keyof typeof StructurizrRelationshipViewRouting];
5224
- /**
5225
- * An instance of a model relationship in a View.
5226
- */
5227
- export interface StructurizrRelationshipView {
5228
- /** The ID of the relationship. */
5229
- id?: string;
5230
- /** The description of this relationship (used in dynamic views only). */
5231
- description?: string;
5232
- /** Signifies whether this relationship represents a return/response message (used in dynamic views only). */
5233
- response?: boolean;
5234
- /** Gets the order of this relationship (used in dynamic views only; e.g. 1.0, 1.1, 2.0, etc). */
5235
- order?: string;
5236
- /** The set of vertices used to render the relationship. */
5237
- vertices?: IcePanel.StructurizrVertex[];
5238
- /** The routing algorithm used when rendering this individual relationship. */
5239
- routing?: IcePanel.StructurizrRelationshipViewRouting;
5240
- /** The position of the annotation along the line; 0 (start) to 100 (end). */
5241
- position?: number;
5242
- }
5243
- /** The location of this software system. */
5244
- export declare const StructurizrSoftwareSystemLocation: {
5245
- readonly External: "External";
5246
- readonly Internal: "Internal";
5247
- readonly Unspecified: "Unspecified";
5248
- };
5249
- export type StructurizrSoftwareSystemLocation = (typeof StructurizrSoftwareSystemLocation)[keyof typeof StructurizrSoftwareSystemLocation];
5250
- /**
5251
- * A software system.
5252
- */
5253
- export interface StructurizrSoftwareSystem {
5254
- /** The ID of this software system in the model. */
5255
- id?: string;
5256
- /** The name of this software system. */
5257
- name?: string;
5258
- /** A short description of this software system. */
5259
- description?: string;
5260
- /** The location of this software system. */
5261
- location?: IcePanel.StructurizrSoftwareSystemLocation;
5262
- /** A comma separated list of tags associated with this software system. */
5263
- tags?: string;
5264
- /** The URL where more information about this element can be found. */
5265
- url?: string;
5266
- /** The set of containers within this software system. */
5267
- containers?: IcePanel.StructurizrContainer[];
5268
- /** The name of the group in which this software system should be included in. */
5269
- group?: string;
5270
- /** A set of arbitrary name-value properties. */
5271
- properties?: Record<string, unknown>;
5272
- /** The set of perspectives associated with this element. */
5273
- perspectives?: IcePanel.StructurizrPerspective[];
5274
- /** The set of relationships from this software system to other elements. */
5275
- relationships?: IcePanel.StructurizrRelationship[];
5276
- documentation?: IcePanel.StructurizrDocumentation;
5277
- }
5278
- /**
5279
- * An instance of a software system, running on a deployment node.
5280
- */
5281
- export interface StructurizrSoftwareSystemInstance {
5282
- /** The ID of this software system instance in the model. */
5283
- id?: string;
5284
- /** The ID of the software system this is an instance of. */
5285
- softwareSystemId?: string;
5286
- /** The number/index of this instance. */
5287
- instanceId?: number;
5288
- /** The deployment environment in which this software system instance resides (e.g. "Development", "Live", etc). */
5289
- environment?: string;
5290
- /** A comma separated list of tags associated with this software system instance. */
5291
- tags?: string;
5292
- /** A set of arbitrary name-value properties. */
5293
- properties?: Record<string, unknown>;
5294
- /** The set of perspectives associated with this element. */
5295
- perspectives?: IcePanel.StructurizrPerspective[];
5296
- /** The set of relationships from this software system instance to other elements. */
5297
- relationships?: IcePanel.StructurizrRelationship[];
5298
- /** The set of HTTP-based health checks for this software system instance. */
5299
- healthChecks?: IcePanel.StructurizrHttpHealthCheck[];
5300
- }
5301
- /** The paper size that should be used to render this view. */
5302
- export declare const StructurizrSystemContextViewPaperSize: {
5303
- readonly A6Portrait: "A6_Portrait";
5304
- readonly A6Landscape: "A6_Landscape";
5305
- readonly A5Portrait: "A5_Portrait";
5306
- readonly A5Landscape: "A5_Landscape";
5307
- readonly A4Portrait: "A4_Portrait";
5308
- readonly A4Landscape: "A4_Landscape";
5309
- readonly A3Portrait: "A3_Portrait";
5310
- readonly A3Landscape: "A3_Landscape";
5311
- readonly A2Portrait: "A2_Portrait";
5312
- readonly A2Landscape: "A2_Landscape";
5313
- readonly A1Portrait: "A1_Portrait";
5314
- readonly A1Landscape: "A1_Landscape";
5315
- readonly A0Portrait: "A0_Portrait";
5316
- readonly A0Landscape: "A0_Landscape";
5317
- readonly LetterPortrait: "Letter_Portrait";
5318
- readonly LetterLandscape: "Letter_Landscape";
5319
- readonly LegalPortrait: "Legal_Portrait";
5320
- readonly LegalLandscape: "Legal_Landscape";
5321
- readonly Slide43: "Slide_4_3";
5322
- readonly Slide169: "Slide_16_9";
5323
- readonly Slide1610: "Slide_16_10";
5324
- };
5325
- export type StructurizrSystemContextViewPaperSize = (typeof StructurizrSystemContextViewPaperSize)[keyof typeof StructurizrSystemContextViewPaperSize];
5326
- /**
5327
- * A system context view.
5328
- */
5329
- export interface StructurizrSystemContextView {
5330
- /** A unique identifier for this view. */
5331
- key?: string;
5332
- /** An integer representing the creation order of this view. */
5333
- order?: number;
5334
- /** The title of this view (optional). */
5335
- title?: string;
5336
- /** The description of this view. */
5337
- description?: string;
5338
- /** A set of arbitrary name-value properties. */
5339
- properties?: Record<string, unknown>;
5340
- /** The ID of the software system this view is associated with. */
5341
- softwareSystemId?: string;
5342
- /** The paper size that should be used to render this view. */
5343
- paperSize?: IcePanel.StructurizrSystemContextViewPaperSize;
5344
- dimensions?: IcePanel.StructurizrDimensions;
5345
- automaticLayout?: IcePanel.StructurizrAutomaticLayout;
5346
- /** Specifies whether the enterprise boundary (to differentiate internal elements from external elements") should be visible on the resulting diagram. */
5347
- enterpriseBoundaryVisible?: boolean;
5348
- /** The set of elements in this view. */
5349
- elements?: IcePanel.StructurizrElementView[];
5350
- /** The set of relationships in this view. */
5351
- relationships?: IcePanel.StructurizrRelationshipView[];
5352
- /** The set of animation steps (optional). */
5353
- animations?: IcePanel.StructurizrAnimationStep[];
5354
- }
5355
- /** The paper size that should be used to render this view. */
5356
- export declare const StructurizrSystemLandscapeViewPaperSize: {
5357
- readonly A6Portrait: "A6_Portrait";
5358
- readonly A6Landscape: "A6_Landscape";
5359
- readonly A5Portrait: "A5_Portrait";
5360
- readonly A5Landscape: "A5_Landscape";
5361
- readonly A4Portrait: "A4_Portrait";
5362
- readonly A4Landscape: "A4_Landscape";
5363
- readonly A3Portrait: "A3_Portrait";
5364
- readonly A3Landscape: "A3_Landscape";
5365
- readonly A2Portrait: "A2_Portrait";
5366
- readonly A2Landscape: "A2_Landscape";
5367
- readonly A1Portrait: "A1_Portrait";
5368
- readonly A1Landscape: "A1_Landscape";
5369
- readonly A0Portrait: "A0_Portrait";
5370
- readonly A0Landscape: "A0_Landscape";
5371
- readonly LetterPortrait: "Letter_Portrait";
5372
- readonly LetterLandscape: "Letter_Landscape";
5373
- readonly LegalPortrait: "Legal_Portrait";
5374
- readonly LegalLandscape: "Legal_Landscape";
5375
- readonly Slide43: "Slide_4_3";
5376
- readonly Slide169: "Slide_16_9";
5377
- readonly Slide1610: "Slide_16_10";
5378
- };
5379
- export type StructurizrSystemLandscapeViewPaperSize = (typeof StructurizrSystemLandscapeViewPaperSize)[keyof typeof StructurizrSystemLandscapeViewPaperSize];
5380
- /**
5381
- * A system landscape view.
5382
- */
5383
- export interface StructurizrSystemLandscapeView {
5384
- /** A unique identifier for this view. */
5385
- key?: string;
5386
- /** An integer representing the creation order of this view. */
5387
- order?: number;
5388
- /** The title of this view (optional). */
5389
- title?: string;
5390
- /** The description of this view. */
5391
- description?: string;
5392
- /** A set of arbitrary name-value properties. */
5393
- properties?: Record<string, unknown>;
5394
- /** The paper size that should be used to render this view. */
5395
- paperSize?: IcePanel.StructurizrSystemLandscapeViewPaperSize;
5396
- dimensions?: IcePanel.StructurizrDimensions;
5397
- automaticLayout?: IcePanel.StructurizrAutomaticLayout;
5398
- /** Specifies whether the enterprise boundary (to differentiate internal elements from external elements) should be visible on the resulting diagram. */
5399
- enterpriseBoundaryVisible?: boolean;
5400
- /** The set of elements in this views. */
5401
- elements?: IcePanel.StructurizrElementView[];
5402
- /** The set of relationships in this views. */
5403
- relationships?: IcePanel.StructurizrRelationshipView[];
5404
- /** The set of animation steps (optional). */
5405
- animations?: IcePanel.StructurizrAnimationStep[];
5406
- }
5407
- /**
5408
- * Provides a way for the terminology on diagrams, etc to be modified (e.g. language translations).
5409
- */
5410
- export interface StructurizrTerminology {
5411
- /** The terminology used when rendering the enterprise boundary. */
5412
- enterprise?: string;
5413
- /** The terminology used when rendering people. */
5414
- person?: string;
5415
- /** The terminology used when rendering software systems. */
5416
- softwareSystem?: string;
5417
- /** The terminology used when rendering containers. */
5418
- container?: string;
5419
- /** The terminology used when rendering components. */
5420
- component?: string;
5421
- /** The terminology used when rendering code elements. */
5422
- code?: string;
5423
- /** The terminology used when rendering deployment nodes. */
5424
- deploymentNode?: string;
5425
- /** The terminology used when rendering relationships. */
5426
- relationship?: string;
5427
- }
5428
- /** The user's role. */
5429
- export declare const StructurizrUserRole: {
5430
- readonly ReadWrite: "ReadWrite";
5431
- readonly ReadOnly: "ReadOnly";
5432
- };
5433
- export type StructurizrUserRole = (typeof StructurizrUserRole)[keyof typeof StructurizrUserRole];
5434
- /**
5435
- * Represents a user who should have access to a workspace.
5436
- */
5437
- export interface StructurizrUser {
5438
- /** The username of the user (e.g. e-mail address). */
5439
- username?: string;
5440
- /** The user's role. */
5441
- role?: IcePanel.StructurizrUserRole;
5442
- }
5443
- /**
5444
- * The X, Y coordinate of a bend in a line.
5445
- */
5446
- export interface StructurizrVertex {
5447
- /** The horizontal position of the vertex when rendered. */
5448
- x?: number;
5449
- /** The vertical position of the vertex when rendered. */
5450
- y?: number;
5451
- }
5452
- /**
5453
- * The set of views onto a software architecture model.
5454
- */
5455
- export interface StructurizrViews {
5456
- /** The set of system landscape views. */
5457
- systemLandscapeViews?: IcePanel.StructurizrSystemLandscapeView[];
5458
- /** The set of system context views. */
5459
- systemContextViews?: IcePanel.StructurizrSystemContextView[];
5460
- /** The set of container views. */
5461
- containerViews?: IcePanel.StructurizrContainerView[];
5462
- /** The set of component views. */
5463
- componentViews?: IcePanel.StructurizrComponentView[];
5464
- /** The set of dynamic views. */
5465
- dynamicViews?: IcePanel.StructurizrDynamicView[];
5466
- /** The set of deployment views. */
5467
- deploymentViews?: IcePanel.StructurizrDeploymentView[];
5468
- /** The set of filtered views. */
5469
- filteredViews?: IcePanel.StructurizrFilteredView[];
5470
- /** The set of image views. */
5471
- imageViews?: IcePanel.StructurizrImageView[];
5472
- configuration?: IcePanel.StructurizrConfiguration;
5473
- }
5474
- /**
5475
- * Represents a Structurizr workspace, which is a wrapper for a software architecture model, views, and documentation.
5476
- */
5477
- export interface StructurizrWorkspace {
5478
- /** The workspace ID. */
5479
- id?: number;
5480
- /** The name of the workspace. */
5481
- name?: string;
5482
- /** A short description of the workspace. */
5483
- description?: string;
5484
- /** A version number for the workspace. */
5485
- version?: string;
5486
- /** The thumbnail associated with the workspace; a Base64 encoded PNG file as a data URI (data:image/png;base64). */
5487
- thumbnail?: string;
5488
- /** The last modified date, in ISO 8601 format (e.g. "2018-09-08T12:40:03Z"). */
5489
- lastModifiedDate?: string;
5490
- /** A string identifying the user who last modified the workspace (e.g. an e-mail address or username). */
5491
- lastModifiedUser?: string;
5492
- /** A string identifying the agent that was last used to modify the workspace (e.g. "structurizr-java/1.2.0"). */
5493
- lastModifiedAgent?: string;
5494
- model?: IcePanel.StructurizrModel;
5495
- views?: IcePanel.StructurizrViews;
5496
- documentation?: IcePanel.StructurizrDocumentation;
5497
- configuration?: IcePanel.StructurizrWorkspaceConfiguration;
5498
- /** A set of arbitrary name-value properties. */
5499
- properties?: Record<string, unknown>;
5500
- }
5501
- /** The visibility of the workspace */
5502
- export declare const StructurizrWorkspaceConfigurationVisibility: {
5503
- readonly Public: "Public";
5504
- readonly Private: "Private";
5505
- };
5506
- export type StructurizrWorkspaceConfigurationVisibility = (typeof StructurizrWorkspaceConfigurationVisibility)[keyof typeof StructurizrWorkspaceConfigurationVisibility];
5507
- /** The scope of the workspace (can be unset for unscoped). */
5508
- export declare const StructurizrWorkspaceConfigurationScope: {
5509
- readonly Landscape: "Landscape";
5510
- readonly SoftwareSystem: "SoftwareSystem";
5511
- };
5512
- export type StructurizrWorkspaceConfigurationScope = (typeof StructurizrWorkspaceConfigurationScope)[keyof typeof StructurizrWorkspaceConfigurationScope];
5513
- /**
5514
- * The workspace configuration (for Structurizr cloud service and on-premises installation).
5515
- */
5516
- export interface StructurizrWorkspaceConfiguration {
5517
- users?: IcePanel.StructurizrUser[];
5518
- /** The visibility of the workspace */
5519
- visibility?: IcePanel.StructurizrWorkspaceConfigurationVisibility;
5520
- /** The scope of the workspace (can be unset for unscoped). */
5521
- scope?: IcePanel.StructurizrWorkspaceConfigurationScope;
5522
- }
5523
4223
  export declare const Theme: {
5524
4224
  readonly Light: "light";
5525
4225
  readonly Dark: "dark";