@meshery/schemas 1.2.14 → 1.2.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +1516 -1516
- package/dist/cloudApi.d.ts +1516 -1516
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +114 -0
- package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1alpha1/core/Core.d.ts +832 -0
- package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1937 -0
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6417 -0
- package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/badge/Badge.d.ts +546 -0
- package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/capability/Capability.d.ts +114 -0
- package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1beta1/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/category/Category.d.ts +46 -0
- package/dist/constructs/v1beta1/category/CategorySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/component/Component.d.ts +869 -0
- package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1300 -0
- package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/core/Core.d.ts +832 -0
- package/dist/constructs/v1beta1/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/credential/Credential.d.ts +530 -0
- package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/environment/Environment.d.ts +759 -0
- package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6338 -0
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/event/Event.d.ts +570 -0
- package/dist/constructs/v1beta1/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/feature/Feature.d.ts +308 -0
- package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +983 -0
- package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/key/Key.d.ts +514 -0
- package/dist/constructs/v1beta1/key/KeySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +642 -0
- package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/model/Model.d.ts +659 -0
- package/dist/constructs/v1beta1/model/ModelSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1598 -0
- package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +18407 -0
- package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/plan/Plan.d.ts +149 -0
- package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/relationship/Relationship.d.ts +1921 -0
- package/dist/constructs/v1beta1/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/role/Role.d.ts +745 -0
- package/dist/constructs/v1beta1/role/RoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +374 -0
- package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +68 -0
- package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +752 -0
- package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/support/Support.d.ts +91 -0
- package/dist/constructs/v1beta1/support/SupportSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +846 -0
- package/dist/constructs/v1beta1/team/TeamSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/token/Token.d.ts +539 -0
- package/dist/constructs/v1beta1/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/user/User.d.ts +1677 -0
- package/dist/constructs/v1beta1/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/view/View.d.ts +759 -0
- package/dist/constructs/v1beta1/view/ViewSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4947 -0
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7762 -0
- package/dist/constructs/v1beta2/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta2/badge/Badge.d.ts +563 -0
- package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1beta2/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/component/Component.d.ts +887 -0
- package/dist/constructs/v1beta2/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1330 -0
- package/dist/constructs/v1beta2/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/core/Core.d.ts +866 -0
- package/dist/constructs/v1beta2/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/credential/Credential.d.ts +519 -0
- package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/design/Design.d.ts +19039 -0
- package/dist/constructs/v1beta2/design/DesignSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/event/Event.d.ts +626 -0
- package/dist/constructs/v1beta2/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1052 -0
- package/dist/constructs/v1beta2/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/key/Key.d.ts +524 -0
- package/dist/constructs/v1beta2/key/KeySchema.d.ts +2 -0
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +652 -0
- package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/model/Model.d.ts +697 -0
- package/dist/constructs/v1beta2/model/ModelSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/organization/Organization.d.ts +1915 -0
- package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/plan/Plan.d.ts +162 -0
- package/dist/constructs/v1beta2/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2134 -0
- package/dist/constructs/v1beta2/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/role/Role.d.ts +752 -0
- package/dist/constructs/v1beta2/role/RoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +431 -0
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +785 -0
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/team/Team.d.ts +960 -0
- package/dist/constructs/v1beta2/team/TeamSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/token/Token.d.ts +544 -0
- package/dist/constructs/v1beta2/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/user/User.d.ts +1677 -0
- package/dist/constructs/v1beta2/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/view/View.d.ts +767 -0
- package/dist/constructs/v1beta2/view/ViewSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7762 -0
- package/dist/constructs/v1beta3/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta3/component/Component.d.ts +892 -0
- package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1414 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/design/Design.d.ts +5704 -0
- package/dist/constructs/v1beta3/design/DesignSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/environment/Environment.d.ts +785 -0
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/event/Event.d.ts +720 -0
- package/dist/constructs/v1beta3/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1452 -0
- package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1060 -0
- package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +813 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/plan/Plan.d.ts +199 -0
- package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2134 -0
- package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +915 -0
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/token/Token.d.ts +544 -0
- package/dist/constructs/v1beta3/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5086 -0
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +2 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/mesheryApi.d.mts +546 -546
- package/dist/mesheryApi.d.ts +546 -546
- package/package.json +2 -2
|
@@ -0,0 +1,866 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {}
|
|
7
|
+
|
|
8
|
+
export interface components {
|
|
9
|
+
schemas: {
|
|
10
|
+
/** @description A string starting with an alphanumeric character. Spaces and hyphens allowed. */
|
|
11
|
+
InputString: string;
|
|
12
|
+
/**
|
|
13
|
+
* @description API version of the object, optionally prefixed with an API group (e.g. "group.example.io/v1beta1" or bare "v1beta1").
|
|
14
|
+
* @example [
|
|
15
|
+
* "v1",
|
|
16
|
+
* "v1alpha1",
|
|
17
|
+
* "v2beta3",
|
|
18
|
+
* "v1.custom-suffix",
|
|
19
|
+
* "models.meshery.io/v1beta1",
|
|
20
|
+
* "capability.meshery.io/v1alpha1"
|
|
21
|
+
* ]
|
|
22
|
+
*/
|
|
23
|
+
VersionString: string;
|
|
24
|
+
/** @description A valid semantic version string between 5 and 100 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1'. */
|
|
25
|
+
SemverString: string;
|
|
26
|
+
/**
|
|
27
|
+
* Format: uuid
|
|
28
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
29
|
+
*/
|
|
30
|
+
Uuid: string;
|
|
31
|
+
/** Format: uuid */
|
|
32
|
+
Id: string;
|
|
33
|
+
Username: string;
|
|
34
|
+
/** @description One of (x-oapi-codegen-extra-tags-cloud, github, google) */
|
|
35
|
+
Provider: string;
|
|
36
|
+
/** Format: date-time */
|
|
37
|
+
Time: string;
|
|
38
|
+
/** Format: date-time */
|
|
39
|
+
SqlNullTime: string;
|
|
40
|
+
/**
|
|
41
|
+
* Format: email
|
|
42
|
+
* @description email
|
|
43
|
+
*/
|
|
44
|
+
Email: string;
|
|
45
|
+
Text: string;
|
|
46
|
+
/**
|
|
47
|
+
* @description Visibility level of a resource. Controls who can see and access it.
|
|
48
|
+
* - `private`: Only the owner and explicitly shared users can access.
|
|
49
|
+
* - `public`: Anyone in the organization (or anonymous, depending on resource) can discover and access.
|
|
50
|
+
* - `published`: Promoted to the catalog for broad discovery beyond the owning organization.
|
|
51
|
+
*
|
|
52
|
+
* @enum {string}
|
|
53
|
+
*/
|
|
54
|
+
Visibility: "private" | "public" | "published";
|
|
55
|
+
Number: number;
|
|
56
|
+
/** @description Link for profile picture */
|
|
57
|
+
AvatarUrl: string;
|
|
58
|
+
MapObject: { [key: string]: string };
|
|
59
|
+
Status: string;
|
|
60
|
+
Bio: string;
|
|
61
|
+
AcceptedTermsAt: string;
|
|
62
|
+
Emails: string[];
|
|
63
|
+
UserIds: string[];
|
|
64
|
+
/** Format: int32 */
|
|
65
|
+
Price: number;
|
|
66
|
+
/**
|
|
67
|
+
* Format: uri
|
|
68
|
+
* @description endpoint
|
|
69
|
+
*/
|
|
70
|
+
Endpoint: string;
|
|
71
|
+
RoleNames: string[];
|
|
72
|
+
RecordsPage: {
|
|
73
|
+
/** @description Current page number of the result set. */
|
|
74
|
+
page?: number;
|
|
75
|
+
/** @description Number of items per page. */
|
|
76
|
+
page_size?: number;
|
|
77
|
+
/** @description The records total of the recordspage. */
|
|
78
|
+
recordsTotal?: number;
|
|
79
|
+
/** @description The record type of the recordspage. */
|
|
80
|
+
recordType?: string;
|
|
81
|
+
};
|
|
82
|
+
ResultsPage: {
|
|
83
|
+
/** @description Current page number of the result set. */
|
|
84
|
+
page?: number;
|
|
85
|
+
/** @description Number of items per page. */
|
|
86
|
+
page_size?: number;
|
|
87
|
+
/** @description Total number of items available. */
|
|
88
|
+
total_count?: number;
|
|
89
|
+
/** @description The result type of the resultspage. */
|
|
90
|
+
resultType?: string;
|
|
91
|
+
};
|
|
92
|
+
/** @description Body for empty request */
|
|
93
|
+
Empty: { [key: string]: unknown };
|
|
94
|
+
EmailPreference: {
|
|
95
|
+
/** @description The welcome email of the emailpreference. */
|
|
96
|
+
welcomeEmail?: boolean;
|
|
97
|
+
/** @description The notify role change of the emailpreference. */
|
|
98
|
+
notifyRoleChange?: boolean;
|
|
99
|
+
};
|
|
100
|
+
/** Format: uuid */
|
|
101
|
+
UserUuid: string;
|
|
102
|
+
/** Format: uuid */
|
|
103
|
+
OrganizationId: string;
|
|
104
|
+
/** Format: uuid */
|
|
105
|
+
GeneralId: string;
|
|
106
|
+
/** Format: uuid */
|
|
107
|
+
EnvironmentId: string;
|
|
108
|
+
/** Format: uuid */
|
|
109
|
+
WorkspaceId: string;
|
|
110
|
+
/** Format: uuid */
|
|
111
|
+
ViewId: string;
|
|
112
|
+
/** Format: uuid */
|
|
113
|
+
TeamId: string;
|
|
114
|
+
/** Format: uuid */
|
|
115
|
+
DesignId: string;
|
|
116
|
+
/** Format: uuid */
|
|
117
|
+
CredentialUuid: string;
|
|
118
|
+
/** Format: uuid */
|
|
119
|
+
MesheryInstanceUuid: string;
|
|
120
|
+
/** Format: uuid */
|
|
121
|
+
KubernetesServerUuid: string;
|
|
122
|
+
/** Format: uuid */
|
|
123
|
+
SystemId: string;
|
|
124
|
+
/** Format: uuid */
|
|
125
|
+
OperationId: string;
|
|
126
|
+
/** @description user's email or username */
|
|
127
|
+
UserId: string;
|
|
128
|
+
/**
|
|
129
|
+
* Format: date-time
|
|
130
|
+
* @description Timestamp when the resource was created.
|
|
131
|
+
*/
|
|
132
|
+
CreatedAt: string;
|
|
133
|
+
/**
|
|
134
|
+
* Format: date-time
|
|
135
|
+
* @description Timestamp when the resource was updated.
|
|
136
|
+
*/
|
|
137
|
+
UpdatedAt: string;
|
|
138
|
+
/**
|
|
139
|
+
* Format: date-time
|
|
140
|
+
* @description Timestamp when the resource was deleted.
|
|
141
|
+
*/
|
|
142
|
+
DeletedAt: string;
|
|
143
|
+
/**
|
|
144
|
+
* Format: date-time
|
|
145
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
146
|
+
*/
|
|
147
|
+
NullTime: string;
|
|
148
|
+
/** @description Common styles for all entities */
|
|
149
|
+
Styles: {
|
|
150
|
+
/** @description Primary color of the component used for UI representation. */
|
|
151
|
+
primaryColor: string;
|
|
152
|
+
/** @description Secondary color of the entity used for UI representation. */
|
|
153
|
+
secondaryColor?: string;
|
|
154
|
+
/** @description White SVG of the entity used for UI representation on dark background. */
|
|
155
|
+
svgWhite: string;
|
|
156
|
+
/** @description Colored SVG of the entity used for UI representation on light background. */
|
|
157
|
+
svgColor: string;
|
|
158
|
+
/** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
159
|
+
svgComplete: string;
|
|
160
|
+
/** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
161
|
+
color?: string;
|
|
162
|
+
/** @description The opacity of the label text, including its outline. */
|
|
163
|
+
textOpacity?: number;
|
|
164
|
+
/** @description A comma-separated list of font names to use on the label text. */
|
|
165
|
+
fontFamily?: string;
|
|
166
|
+
/** @description The size of the label text. */
|
|
167
|
+
fontSize?: string;
|
|
168
|
+
/** @description A CSS font style to be applied to the label text. */
|
|
169
|
+
fontStyle?: string;
|
|
170
|
+
/** @description A CSS font weight to be applied to the label text. */
|
|
171
|
+
fontWeight?: string;
|
|
172
|
+
/**
|
|
173
|
+
* @description A transformation to apply to the label text
|
|
174
|
+
* @enum {string}
|
|
175
|
+
*/
|
|
176
|
+
textTransform?: "none" | "uppercase" | "lowercase";
|
|
177
|
+
/** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
|
|
178
|
+
opacity?: number;
|
|
179
|
+
/** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
180
|
+
zIndex?: number;
|
|
181
|
+
/** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
182
|
+
label?: string;
|
|
183
|
+
/** @description The animation to apply to the element. example ripple,bounce,etc */
|
|
184
|
+
animation?: { [key: string]: unknown };
|
|
185
|
+
} & { [key: string]: unknown };
|
|
186
|
+
/**
|
|
187
|
+
* @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
|
|
188
|
+
* @enum {string}
|
|
189
|
+
*/
|
|
190
|
+
Shape:
|
|
191
|
+
| "ellipse"
|
|
192
|
+
| "triangle"
|
|
193
|
+
| "round-triangle"
|
|
194
|
+
| "rectangle"
|
|
195
|
+
| "round-rectangle"
|
|
196
|
+
| "bottom-round-rectangle"
|
|
197
|
+
| "cut-rectangle"
|
|
198
|
+
| "barrel"
|
|
199
|
+
| "rhomboid"
|
|
200
|
+
| "diamond"
|
|
201
|
+
| "round-diamond"
|
|
202
|
+
| "pentagon"
|
|
203
|
+
| "round-pentagon"
|
|
204
|
+
| "hexagon"
|
|
205
|
+
| "round-hexagon"
|
|
206
|
+
| "concave-hexagon"
|
|
207
|
+
| "heptagon"
|
|
208
|
+
| "round-heptagon"
|
|
209
|
+
| "octagon"
|
|
210
|
+
| "round-octagon"
|
|
211
|
+
| "star"
|
|
212
|
+
| "tag"
|
|
213
|
+
| "round-tag"
|
|
214
|
+
| "vee"
|
|
215
|
+
| "polygon";
|
|
216
|
+
/** @description Visualization styles for a relationship */
|
|
217
|
+
EdgeStyles: ({
|
|
218
|
+
/** @description Primary color of the component used for UI representation. */
|
|
219
|
+
primaryColor: string;
|
|
220
|
+
/** @description Secondary color of the entity used for UI representation. */
|
|
221
|
+
secondaryColor?: string;
|
|
222
|
+
/** @description White SVG of the entity used for UI representation on dark background. */
|
|
223
|
+
svgWhite: string;
|
|
224
|
+
/** @description Colored SVG of the entity used for UI representation on light background. */
|
|
225
|
+
svgColor: string;
|
|
226
|
+
/** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
227
|
+
svgComplete: string;
|
|
228
|
+
/** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
229
|
+
color?: string;
|
|
230
|
+
/** @description The opacity of the label text, including its outline. */
|
|
231
|
+
textOpacity?: number;
|
|
232
|
+
/** @description A comma-separated list of font names to use on the label text. */
|
|
233
|
+
fontFamily?: string;
|
|
234
|
+
/** @description The size of the label text. */
|
|
235
|
+
fontSize?: string;
|
|
236
|
+
/** @description A CSS font style to be applied to the label text. */
|
|
237
|
+
fontStyle?: string;
|
|
238
|
+
/** @description A CSS font weight to be applied to the label text. */
|
|
239
|
+
fontWeight?: string;
|
|
240
|
+
/**
|
|
241
|
+
* @description A transformation to apply to the label text
|
|
242
|
+
* @enum {string}
|
|
243
|
+
*/
|
|
244
|
+
textTransform?: "none" | "uppercase" | "lowercase";
|
|
245
|
+
/** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
|
|
246
|
+
opacity?: number;
|
|
247
|
+
/** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
248
|
+
zIndex?: number;
|
|
249
|
+
/** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
250
|
+
label?: string;
|
|
251
|
+
/** @description The animation to apply to the element. example ripple,bounce,etc */
|
|
252
|
+
animation?: { [key: string]: unknown };
|
|
253
|
+
} & { [key: string]: unknown }) & {
|
|
254
|
+
/** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
|
|
255
|
+
edgeAnimation?: string;
|
|
256
|
+
/**
|
|
257
|
+
* @description The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.
|
|
258
|
+
* @default straight
|
|
259
|
+
* @enum {string}
|
|
260
|
+
*/
|
|
261
|
+
curveStyle?:
|
|
262
|
+
| "straight"
|
|
263
|
+
| "haystack"
|
|
264
|
+
| "bezier"
|
|
265
|
+
| "unbundled-bezier"
|
|
266
|
+
| "segments"
|
|
267
|
+
| "taxi";
|
|
268
|
+
/** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
269
|
+
lineColor?: string;
|
|
270
|
+
/**
|
|
271
|
+
* @description The style of the edge's line.
|
|
272
|
+
* @enum {string}
|
|
273
|
+
*/
|
|
274
|
+
lineStyle?: "solid" | "dotted" | "dashed";
|
|
275
|
+
/**
|
|
276
|
+
* @description The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.
|
|
277
|
+
* @default butt
|
|
278
|
+
* @enum {string}
|
|
279
|
+
*/
|
|
280
|
+
lineCap?: "butt" | "round" | "square";
|
|
281
|
+
/**
|
|
282
|
+
* @description The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents.
|
|
283
|
+
* @default 1
|
|
284
|
+
*/
|
|
285
|
+
lineOpacity?: number;
|
|
286
|
+
/** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
287
|
+
targetArrowColor?: string;
|
|
288
|
+
/**
|
|
289
|
+
* @description The shape of the edge's source arrow
|
|
290
|
+
* @enum {string}
|
|
291
|
+
*/
|
|
292
|
+
targetArrowShape?:
|
|
293
|
+
| "triangle"
|
|
294
|
+
| "triangle-tee"
|
|
295
|
+
| "circle-triangle"
|
|
296
|
+
| "triangle-cross"
|
|
297
|
+
| "triangle-backcurve"
|
|
298
|
+
| "vee"
|
|
299
|
+
| "tee"
|
|
300
|
+
| "square"
|
|
301
|
+
| "circle"
|
|
302
|
+
| "diamond"
|
|
303
|
+
| "chevron"
|
|
304
|
+
| "none";
|
|
305
|
+
/**
|
|
306
|
+
* @description The fill state of the edge's source arrow
|
|
307
|
+
* @enum {string}
|
|
308
|
+
*/
|
|
309
|
+
targetArrowFill?: "filled" | "hollow";
|
|
310
|
+
/** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
311
|
+
midTargetArrowColor?: string;
|
|
312
|
+
/**
|
|
313
|
+
* @description The shape of the edge's source arrow
|
|
314
|
+
* @enum {string}
|
|
315
|
+
*/
|
|
316
|
+
midTargetArrowShape?:
|
|
317
|
+
| "triangle"
|
|
318
|
+
| "triangle-tee"
|
|
319
|
+
| "circle-triangle"
|
|
320
|
+
| "triangle-cross"
|
|
321
|
+
| "triangle-backcurve"
|
|
322
|
+
| "vee"
|
|
323
|
+
| "tee"
|
|
324
|
+
| "square"
|
|
325
|
+
| "circle"
|
|
326
|
+
| "diamond"
|
|
327
|
+
| "chevron"
|
|
328
|
+
| "none";
|
|
329
|
+
/**
|
|
330
|
+
* @description The fill state of the edge's source arrow
|
|
331
|
+
* @enum {string}
|
|
332
|
+
*/
|
|
333
|
+
midTargetArrowFill?: "filled" | "hollow";
|
|
334
|
+
/** @description Scaling for the arrow size. */
|
|
335
|
+
arrowScale?: number;
|
|
336
|
+
/** @description The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id */
|
|
337
|
+
sourceLabel?: string;
|
|
338
|
+
/** @description The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id */
|
|
339
|
+
targetLabel?: string;
|
|
340
|
+
};
|
|
341
|
+
/** @description Visualization styles for a component */
|
|
342
|
+
ComponentStyles: ({
|
|
343
|
+
/** @description Primary color of the component used for UI representation. */
|
|
344
|
+
primaryColor: string;
|
|
345
|
+
/** @description Secondary color of the entity used for UI representation. */
|
|
346
|
+
secondaryColor?: string;
|
|
347
|
+
/** @description White SVG of the entity used for UI representation on dark background. */
|
|
348
|
+
svgWhite: string;
|
|
349
|
+
/** @description Colored SVG of the entity used for UI representation on light background. */
|
|
350
|
+
svgColor: string;
|
|
351
|
+
/** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
352
|
+
svgComplete: string;
|
|
353
|
+
/** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
354
|
+
color?: string;
|
|
355
|
+
/** @description The opacity of the label text, including its outline. */
|
|
356
|
+
textOpacity?: number;
|
|
357
|
+
/** @description A comma-separated list of font names to use on the label text. */
|
|
358
|
+
fontFamily?: string;
|
|
359
|
+
/** @description The size of the label text. */
|
|
360
|
+
fontSize?: string;
|
|
361
|
+
/** @description A CSS font style to be applied to the label text. */
|
|
362
|
+
fontStyle?: string;
|
|
363
|
+
/** @description A CSS font weight to be applied to the label text. */
|
|
364
|
+
fontWeight?: string;
|
|
365
|
+
/**
|
|
366
|
+
* @description A transformation to apply to the label text
|
|
367
|
+
* @enum {string}
|
|
368
|
+
*/
|
|
369
|
+
textTransform?: "none" | "uppercase" | "lowercase";
|
|
370
|
+
/** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
|
|
371
|
+
opacity?: number;
|
|
372
|
+
/** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
373
|
+
zIndex?: number;
|
|
374
|
+
/** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
375
|
+
label?: string;
|
|
376
|
+
/** @description The animation to apply to the element. example ripple,bounce,etc */
|
|
377
|
+
animation?: { [key: string]: unknown };
|
|
378
|
+
} & { [key: string]: unknown }) & {
|
|
379
|
+
/**
|
|
380
|
+
* @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
|
|
381
|
+
* @enum {string}
|
|
382
|
+
*/
|
|
383
|
+
shape?:
|
|
384
|
+
| "ellipse"
|
|
385
|
+
| "triangle"
|
|
386
|
+
| "round-triangle"
|
|
387
|
+
| "rectangle"
|
|
388
|
+
| "round-rectangle"
|
|
389
|
+
| "bottom-round-rectangle"
|
|
390
|
+
| "cut-rectangle"
|
|
391
|
+
| "barrel"
|
|
392
|
+
| "rhomboid"
|
|
393
|
+
| "diamond"
|
|
394
|
+
| "round-diamond"
|
|
395
|
+
| "pentagon"
|
|
396
|
+
| "round-pentagon"
|
|
397
|
+
| "hexagon"
|
|
398
|
+
| "round-hexagon"
|
|
399
|
+
| "concave-hexagon"
|
|
400
|
+
| "heptagon"
|
|
401
|
+
| "round-heptagon"
|
|
402
|
+
| "octagon"
|
|
403
|
+
| "round-octagon"
|
|
404
|
+
| "star"
|
|
405
|
+
| "tag"
|
|
406
|
+
| "round-tag"
|
|
407
|
+
| "vee"
|
|
408
|
+
| "polygon";
|
|
409
|
+
/** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
|
|
410
|
+
position?: {
|
|
411
|
+
/** @description The x-coordinate of the node. */
|
|
412
|
+
x: number;
|
|
413
|
+
/** @description The y-coordinate of the node. */
|
|
414
|
+
y: number;
|
|
415
|
+
};
|
|
416
|
+
/** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
|
|
417
|
+
bodyText?: string;
|
|
418
|
+
/**
|
|
419
|
+
* @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
|
|
420
|
+
* @enum {string}
|
|
421
|
+
*/
|
|
422
|
+
bodyTextWrap?: "none" | "wrap" | "ellipsis";
|
|
423
|
+
/** @description The maximum width for wrapping text in the node. */
|
|
424
|
+
bodyTextMaxWidth?: string;
|
|
425
|
+
/** @description The opacity of the node's body text, including its outline. */
|
|
426
|
+
bodyTextOpacity?: number;
|
|
427
|
+
/** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
428
|
+
bodyTextBackgroundColor?: string;
|
|
429
|
+
/** @description The size of the node's body text. */
|
|
430
|
+
bodyTextFontSize?: number;
|
|
431
|
+
/** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
432
|
+
bodyTextColor?: string;
|
|
433
|
+
/** @description A CSS font weight to be applied to the node's body text. */
|
|
434
|
+
bodyTextFontWeight?: string;
|
|
435
|
+
/** @description A CSS horizontal alignment to be applied to the node's body text. */
|
|
436
|
+
bodyTextHorizontalAlign?: string;
|
|
437
|
+
/** @description A CSS text decoration to be applied to the node's body text. */
|
|
438
|
+
bodyTextDecoration?: string;
|
|
439
|
+
/** @description A CSS vertical alignment to be applied to the node's body text. */
|
|
440
|
+
bodyTextVerticalAlign?: string;
|
|
441
|
+
/** @description The width of the node's body or the width of an edge's line. */
|
|
442
|
+
width?: number;
|
|
443
|
+
/** @description The height of the node's body */
|
|
444
|
+
height?: number;
|
|
445
|
+
/**
|
|
446
|
+
* Format: uri
|
|
447
|
+
* @description The URL that points to the image to show in the node.
|
|
448
|
+
*/
|
|
449
|
+
backgroundImage?: string;
|
|
450
|
+
/** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
451
|
+
backgroundColor?: string;
|
|
452
|
+
/** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
|
|
453
|
+
backgroundBlacken?: number;
|
|
454
|
+
/** @description The opacity level of the node's background colour */
|
|
455
|
+
backgroundOpacity?: number;
|
|
456
|
+
/** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
457
|
+
backgroundPositionX?: string;
|
|
458
|
+
/** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
459
|
+
backgroundPositionY?: string;
|
|
460
|
+
/** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
461
|
+
backgroundOffsetX?: string;
|
|
462
|
+
/** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
463
|
+
backgroundOffsetY?: string;
|
|
464
|
+
/**
|
|
465
|
+
* @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
|
|
466
|
+
* @enum {string}
|
|
467
|
+
*/
|
|
468
|
+
backgroundFit?: "none" | "contain" | "cover";
|
|
469
|
+
/**
|
|
470
|
+
* @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
|
|
471
|
+
* @enum {string}
|
|
472
|
+
*/
|
|
473
|
+
backgroundClip?: "none" | "node" | "node-border";
|
|
474
|
+
/**
|
|
475
|
+
* @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
|
|
476
|
+
* @enum {string}
|
|
477
|
+
*/
|
|
478
|
+
backgroundWidthRelativeTo?: "none" | "inner" | "outer";
|
|
479
|
+
/**
|
|
480
|
+
* @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
|
|
481
|
+
* @enum {string}
|
|
482
|
+
*/
|
|
483
|
+
backgroundHeightRelativeTo?: "none" | "inner" | "outer";
|
|
484
|
+
/** @description The size of the node's border. */
|
|
485
|
+
borderWidth?: number;
|
|
486
|
+
/**
|
|
487
|
+
* @description The style of the node's border
|
|
488
|
+
* @enum {string}
|
|
489
|
+
*/
|
|
490
|
+
borderStyle?: "solid" | "dotted" | "dashed" | "double";
|
|
491
|
+
/** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
492
|
+
borderColor?: string;
|
|
493
|
+
/** @description The opacity of the node's border */
|
|
494
|
+
borderOpacity?: number;
|
|
495
|
+
/** @description The amount of padding around all sides of the node. */
|
|
496
|
+
padding?: number;
|
|
497
|
+
/**
|
|
498
|
+
* @description The horizontal alignment of a node's label
|
|
499
|
+
* @enum {string}
|
|
500
|
+
*/
|
|
501
|
+
textHalign?: "left" | "center" | "right";
|
|
502
|
+
/**
|
|
503
|
+
* @description The vertical alignment of a node's label
|
|
504
|
+
* @enum {string}
|
|
505
|
+
*/
|
|
506
|
+
textValign?: "top" | "center" | "bottom";
|
|
507
|
+
/**
|
|
508
|
+
* @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
|
|
509
|
+
* @default no
|
|
510
|
+
* @enum {string}
|
|
511
|
+
*/
|
|
512
|
+
ghost?: "yes" | "no";
|
|
513
|
+
/** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
514
|
+
activeBgColor?: string;
|
|
515
|
+
/** @description The opacity of the active background indicator. Selector needs to be *core*. */
|
|
516
|
+
activeBgOpacity?: string;
|
|
517
|
+
/** @description The opacity of the active background indicator. Selector needs to be *core*. */
|
|
518
|
+
activeBgSize?: string;
|
|
519
|
+
/** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
520
|
+
selectionBoxColor?: string;
|
|
521
|
+
/** @description The size of the border on the selection box. Selector needs to be *core* */
|
|
522
|
+
selectionBoxBorderWidth?: number;
|
|
523
|
+
/** @description The opacity of the selection box. Selector needs to be *core* */
|
|
524
|
+
selectionBoxOpacity?: number;
|
|
525
|
+
/** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
526
|
+
outsideTextureBgColor?: string;
|
|
527
|
+
/** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
|
|
528
|
+
outsideTextureBgOpacity?: number;
|
|
529
|
+
/** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
|
|
530
|
+
shapePolygonPoints?: string;
|
|
531
|
+
/** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
532
|
+
menuBackgroundColor?: string;
|
|
533
|
+
/** @description The opacity of the background of the component menu. */
|
|
534
|
+
menuBackgroundOpacity?: number;
|
|
535
|
+
/** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
536
|
+
menuForgroundColor?: string;
|
|
537
|
+
} & {
|
|
538
|
+
shape: unknown;
|
|
539
|
+
primaryColor: unknown;
|
|
540
|
+
svgColor: unknown;
|
|
541
|
+
svgWhite: unknown;
|
|
542
|
+
svgComplete: unknown;
|
|
543
|
+
};
|
|
544
|
+
RelationshipStyles:
|
|
545
|
+
| (({
|
|
546
|
+
/** @description Primary color of the component used for UI representation. */
|
|
547
|
+
primaryColor: string;
|
|
548
|
+
/** @description Secondary color of the entity used for UI representation. */
|
|
549
|
+
secondaryColor?: string;
|
|
550
|
+
/** @description White SVG of the entity used for UI representation on dark background. */
|
|
551
|
+
svgWhite: string;
|
|
552
|
+
/** @description Colored SVG of the entity used for UI representation on light background. */
|
|
553
|
+
svgColor: string;
|
|
554
|
+
/** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
555
|
+
svgComplete: string;
|
|
556
|
+
/** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
557
|
+
color?: string;
|
|
558
|
+
/** @description The opacity of the label text, including its outline. */
|
|
559
|
+
textOpacity?: number;
|
|
560
|
+
/** @description A comma-separated list of font names to use on the label text. */
|
|
561
|
+
fontFamily?: string;
|
|
562
|
+
/** @description The size of the label text. */
|
|
563
|
+
fontSize?: string;
|
|
564
|
+
/** @description A CSS font style to be applied to the label text. */
|
|
565
|
+
fontStyle?: string;
|
|
566
|
+
/** @description A CSS font weight to be applied to the label text. */
|
|
567
|
+
fontWeight?: string;
|
|
568
|
+
/**
|
|
569
|
+
* @description A transformation to apply to the label text
|
|
570
|
+
* @enum {string}
|
|
571
|
+
*/
|
|
572
|
+
textTransform?: "none" | "uppercase" | "lowercase";
|
|
573
|
+
/** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
|
|
574
|
+
opacity?: number;
|
|
575
|
+
/** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
576
|
+
zIndex?: number;
|
|
577
|
+
/** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
578
|
+
label?: string;
|
|
579
|
+
/** @description The animation to apply to the element. example ripple,bounce,etc */
|
|
580
|
+
animation?: { [key: string]: unknown };
|
|
581
|
+
} & { [key: string]: unknown }) & {
|
|
582
|
+
/** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
|
|
583
|
+
edgeAnimation?: string;
|
|
584
|
+
/**
|
|
585
|
+
* @description The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.
|
|
586
|
+
* @default straight
|
|
587
|
+
* @enum {string}
|
|
588
|
+
*/
|
|
589
|
+
curveStyle?:
|
|
590
|
+
| "straight"
|
|
591
|
+
| "haystack"
|
|
592
|
+
| "bezier"
|
|
593
|
+
| "unbundled-bezier"
|
|
594
|
+
| "segments"
|
|
595
|
+
| "taxi";
|
|
596
|
+
/** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
597
|
+
lineColor?: string;
|
|
598
|
+
/**
|
|
599
|
+
* @description The style of the edge's line.
|
|
600
|
+
* @enum {string}
|
|
601
|
+
*/
|
|
602
|
+
lineStyle?: "solid" | "dotted" | "dashed";
|
|
603
|
+
/**
|
|
604
|
+
* @description The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.
|
|
605
|
+
* @default butt
|
|
606
|
+
* @enum {string}
|
|
607
|
+
*/
|
|
608
|
+
lineCap?: "butt" | "round" | "square";
|
|
609
|
+
/**
|
|
610
|
+
* @description The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents.
|
|
611
|
+
* @default 1
|
|
612
|
+
*/
|
|
613
|
+
lineOpacity?: number;
|
|
614
|
+
/** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
615
|
+
targetArrowColor?: string;
|
|
616
|
+
/**
|
|
617
|
+
* @description The shape of the edge's source arrow
|
|
618
|
+
* @enum {string}
|
|
619
|
+
*/
|
|
620
|
+
targetArrowShape?:
|
|
621
|
+
| "triangle"
|
|
622
|
+
| "triangle-tee"
|
|
623
|
+
| "circle-triangle"
|
|
624
|
+
| "triangle-cross"
|
|
625
|
+
| "triangle-backcurve"
|
|
626
|
+
| "vee"
|
|
627
|
+
| "tee"
|
|
628
|
+
| "square"
|
|
629
|
+
| "circle"
|
|
630
|
+
| "diamond"
|
|
631
|
+
| "chevron"
|
|
632
|
+
| "none";
|
|
633
|
+
/**
|
|
634
|
+
* @description The fill state of the edge's source arrow
|
|
635
|
+
* @enum {string}
|
|
636
|
+
*/
|
|
637
|
+
targetArrowFill?: "filled" | "hollow";
|
|
638
|
+
/** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
639
|
+
midTargetArrowColor?: string;
|
|
640
|
+
/**
|
|
641
|
+
* @description The shape of the edge's source arrow
|
|
642
|
+
* @enum {string}
|
|
643
|
+
*/
|
|
644
|
+
midTargetArrowShape?:
|
|
645
|
+
| "triangle"
|
|
646
|
+
| "triangle-tee"
|
|
647
|
+
| "circle-triangle"
|
|
648
|
+
| "triangle-cross"
|
|
649
|
+
| "triangle-backcurve"
|
|
650
|
+
| "vee"
|
|
651
|
+
| "tee"
|
|
652
|
+
| "square"
|
|
653
|
+
| "circle"
|
|
654
|
+
| "diamond"
|
|
655
|
+
| "chevron"
|
|
656
|
+
| "none";
|
|
657
|
+
/**
|
|
658
|
+
* @description The fill state of the edge's source arrow
|
|
659
|
+
* @enum {string}
|
|
660
|
+
*/
|
|
661
|
+
midTargetArrowFill?: "filled" | "hollow";
|
|
662
|
+
/** @description Scaling for the arrow size. */
|
|
663
|
+
arrowScale?: number;
|
|
664
|
+
/** @description The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id */
|
|
665
|
+
sourceLabel?: string;
|
|
666
|
+
/** @description The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id */
|
|
667
|
+
targetLabel?: string;
|
|
668
|
+
})
|
|
669
|
+
| (({
|
|
670
|
+
/** @description Primary color of the component used for UI representation. */
|
|
671
|
+
primaryColor: string;
|
|
672
|
+
/** @description Secondary color of the entity used for UI representation. */
|
|
673
|
+
secondaryColor?: string;
|
|
674
|
+
/** @description White SVG of the entity used for UI representation on dark background. */
|
|
675
|
+
svgWhite: string;
|
|
676
|
+
/** @description Colored SVG of the entity used for UI representation on light background. */
|
|
677
|
+
svgColor: string;
|
|
678
|
+
/** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
679
|
+
svgComplete: string;
|
|
680
|
+
/** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
681
|
+
color?: string;
|
|
682
|
+
/** @description The opacity of the label text, including its outline. */
|
|
683
|
+
textOpacity?: number;
|
|
684
|
+
/** @description A comma-separated list of font names to use on the label text. */
|
|
685
|
+
fontFamily?: string;
|
|
686
|
+
/** @description The size of the label text. */
|
|
687
|
+
fontSize?: string;
|
|
688
|
+
/** @description A CSS font style to be applied to the label text. */
|
|
689
|
+
fontStyle?: string;
|
|
690
|
+
/** @description A CSS font weight to be applied to the label text. */
|
|
691
|
+
fontWeight?: string;
|
|
692
|
+
/**
|
|
693
|
+
* @description A transformation to apply to the label text
|
|
694
|
+
* @enum {string}
|
|
695
|
+
*/
|
|
696
|
+
textTransform?: "none" | "uppercase" | "lowercase";
|
|
697
|
+
/** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
|
|
698
|
+
opacity?: number;
|
|
699
|
+
/** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
700
|
+
zIndex?: number;
|
|
701
|
+
/** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
702
|
+
label?: string;
|
|
703
|
+
/** @description The animation to apply to the element. example ripple,bounce,etc */
|
|
704
|
+
animation?: { [key: string]: unknown };
|
|
705
|
+
} & { [key: string]: unknown }) & { [key: string]: unknown });
|
|
706
|
+
/** @description An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents */
|
|
707
|
+
NonResolvedAlias: {
|
|
708
|
+
/**
|
|
709
|
+
* Format: uuid
|
|
710
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
711
|
+
*/
|
|
712
|
+
relationshipId: string;
|
|
713
|
+
/**
|
|
714
|
+
* Format: uuid
|
|
715
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
716
|
+
*/
|
|
717
|
+
aliasComponentId: string;
|
|
718
|
+
/**
|
|
719
|
+
* Format: uuid
|
|
720
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
721
|
+
*/
|
|
722
|
+
immediateParentId: string;
|
|
723
|
+
/** @description The immediate ref field path of the nonresolvedalias. */
|
|
724
|
+
immediateRefFieldPath: string[];
|
|
725
|
+
};
|
|
726
|
+
/** @description An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also */
|
|
727
|
+
ResolvedAlias: {
|
|
728
|
+
/**
|
|
729
|
+
* Format: uuid
|
|
730
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
731
|
+
*/
|
|
732
|
+
relationshipId: string;
|
|
733
|
+
/**
|
|
734
|
+
* Format: uuid
|
|
735
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
736
|
+
*/
|
|
737
|
+
aliasComponentId: string;
|
|
738
|
+
/**
|
|
739
|
+
* Format: uuid
|
|
740
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
741
|
+
*/
|
|
742
|
+
immediateParentId: string;
|
|
743
|
+
/** @description The immediate ref field path of the nonresolvedalias. */
|
|
744
|
+
immediateRefFieldPath: string[];
|
|
745
|
+
} & {
|
|
746
|
+
/**
|
|
747
|
+
* Format: uuid
|
|
748
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
749
|
+
*/
|
|
750
|
+
resolvedParentId: string;
|
|
751
|
+
/** @description Fully resolved field path targeted by the alias. */
|
|
752
|
+
resolvedRefFieldPath: string[];
|
|
753
|
+
};
|
|
754
|
+
/**
|
|
755
|
+
* @description The type of the IaC file
|
|
756
|
+
* @enum {string}
|
|
757
|
+
*/
|
|
758
|
+
IaCFileTypes:
|
|
759
|
+
| "meshery-design"
|
|
760
|
+
| "helm-chart"
|
|
761
|
+
| "k8s-manifest"
|
|
762
|
+
| "docker-compose"
|
|
763
|
+
| "k8s-kustomize";
|
|
764
|
+
};
|
|
765
|
+
responses: {
|
|
766
|
+
/** ok */
|
|
767
|
+
200: {
|
|
768
|
+
content: {
|
|
769
|
+
"text/plain": string;
|
|
770
|
+
};
|
|
771
|
+
};
|
|
772
|
+
201: {
|
|
773
|
+
content: {
|
|
774
|
+
"text/plain": string;
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
/** Invalid request body or request param */
|
|
778
|
+
400: {
|
|
779
|
+
content: {
|
|
780
|
+
"text/plain": string;
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
/** Expired JWT token used or insufficient privilege */
|
|
784
|
+
401: {
|
|
785
|
+
content: {
|
|
786
|
+
"text/plain": string;
|
|
787
|
+
};
|
|
788
|
+
};
|
|
789
|
+
/** Result not found */
|
|
790
|
+
404: {
|
|
791
|
+
content: {
|
|
792
|
+
"text/plain": string;
|
|
793
|
+
};
|
|
794
|
+
};
|
|
795
|
+
/** Publish request already exists */
|
|
796
|
+
409: {
|
|
797
|
+
content: {
|
|
798
|
+
"text/plain": string;
|
|
799
|
+
};
|
|
800
|
+
};
|
|
801
|
+
/** Internal server error */
|
|
802
|
+
500: {
|
|
803
|
+
content: {
|
|
804
|
+
"text/plain": string;
|
|
805
|
+
};
|
|
806
|
+
};
|
|
807
|
+
};
|
|
808
|
+
parameters: {
|
|
809
|
+
/** @description Unique identifier */
|
|
810
|
+
id: string;
|
|
811
|
+
/** @description Get all possible entries */
|
|
812
|
+
all: boolean;
|
|
813
|
+
/** @description Get responses by page */
|
|
814
|
+
page: string;
|
|
815
|
+
/** @description Filter catalog items by user ID. Pass multiple user IDs to fetch content for several users simultaneously. */
|
|
816
|
+
userId: string;
|
|
817
|
+
/** @description Include metrics associated with the designs. */
|
|
818
|
+
metrics: string;
|
|
819
|
+
/** @description Filter catalog items based on their support class. Specify one or more classes per request as needed. Example: 'official' and 'verified' */
|
|
820
|
+
class: string;
|
|
821
|
+
/** @description Get responses by pagesize */
|
|
822
|
+
pagesize: string;
|
|
823
|
+
/** @description Get responses by pagesize (pass all to get all responses) */
|
|
824
|
+
pagesizeWithAll: string;
|
|
825
|
+
/** @description Get ordered responses */
|
|
826
|
+
order: string;
|
|
827
|
+
/** @description Get responses based on visibility - private, public or published */
|
|
828
|
+
visibility: "private" | "public" | "published";
|
|
829
|
+
/** @description Populate the response with additional data like pattern_file */
|
|
830
|
+
populate: string;
|
|
831
|
+
/** @description Get responses that match search param value */
|
|
832
|
+
search: string;
|
|
833
|
+
/** @description Get filtered reponses */
|
|
834
|
+
filter: string;
|
|
835
|
+
/** @description To get OAuth tokens as well */
|
|
836
|
+
isOAuth: string;
|
|
837
|
+
/** @description Name of the resource */
|
|
838
|
+
name: string;
|
|
839
|
+
/** @description Purpose for which token is generated */
|
|
840
|
+
purpose: string;
|
|
841
|
+
/** @description Cumulative events */
|
|
842
|
+
cumulative: string;
|
|
843
|
+
/** @description meshery version */
|
|
844
|
+
mesheryVersion: string;
|
|
845
|
+
/** @description user's os */
|
|
846
|
+
os: string;
|
|
847
|
+
/** @description Is playground mode */
|
|
848
|
+
playground: string;
|
|
849
|
+
/** @description Namespace */
|
|
850
|
+
namespace: string;
|
|
851
|
+
/** @description Type */
|
|
852
|
+
type: string;
|
|
853
|
+
/** @description Type of actor e.g user, team, system, registrant */
|
|
854
|
+
actorType: string;
|
|
855
|
+
/** @description Type of resource e.g design, filter, view, environment, workspace */
|
|
856
|
+
resourceType: string;
|
|
857
|
+
/** @description Filter catalog data based on type of content e.g (deployment, workloads, scaling...) multiple params can be passed */
|
|
858
|
+
contentType: string;
|
|
859
|
+
/** @description Filter catalog data based on technology(compatibility) of content e.g (kubernetes, istio...) multiple params can be passed */
|
|
860
|
+
contentTechnology: string;
|
|
861
|
+
};
|
|
862
|
+
}
|
|
863
|
+
|
|
864
|
+
export interface operations {}
|
|
865
|
+
|
|
866
|
+
export interface external {}
|