@meshery/schemas 1.3.115 → 1.3.117

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 (34) hide show
  1. package/dist/cloudApi.d.mts +912 -11
  2. package/dist/cloudApi.d.ts +912 -11
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta3/connection/Connection.d.ts +17 -5
  6. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
  7. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
  8. package/dist/constructs/v1beta3/design/Design.d.ts +72 -2
  9. package/dist/constructs/v1beta3/design/DesignSchema.js +4 -2
  10. package/dist/constructs/v1beta3/design/DesignSchema.mjs +4 -2
  11. package/dist/constructs/v1beta3/environment/Environment.d.ts +710 -4
  12. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  13. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  14. package/dist/constructs/v1beta3/errorcode/Errorcode.d.ts +193 -0
  15. package/dist/constructs/v1beta3/errorcode/Errorcode.js +1 -0
  16. package/dist/constructs/v1beta3/errorcode/Errorcode.mjs +0 -0
  17. package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.d.ts +2 -0
  18. package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.js +9 -0
  19. package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.mjs +9 -0
  20. package/dist/constructs/v1beta3/event/Event.d.ts +558 -17
  21. package/dist/constructs/v1beta3/event/EventSchema.js +28 -9
  22. package/dist/constructs/v1beta3/event/EventSchema.mjs +28 -9
  23. package/dist/constructs/v1beta3/schedule/Schedule.d.ts +390 -1
  24. package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +35 -15
  25. package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +35 -15
  26. package/dist/index.d.mts +624 -85
  27. package/dist/index.d.ts +624 -85
  28. package/dist/index.js +10 -10
  29. package/dist/index.mjs +10 -10
  30. package/dist/mesheryApi.d.mts +332 -6
  31. package/dist/mesheryApi.d.ts +332 -6
  32. package/dist/mesheryApi.js +1 -1
  33. package/dist/mesheryApi.mjs +1 -1
  34. package/package.json +1 -1
@@ -290,9 +290,362 @@ export interface components {
290
290
  pageSize?: number;
291
291
  /** @description Total number of items available. */
292
292
  totalCount?: number;
293
- /** @description The connections of the environmentconnectionspage. */
293
+ /** @description Connections associated with the environment, using the canonical Connection response schema. */
294
294
  connections?: {
295
- [key: string]: unknown;
295
+ /**
296
+ * Format: uuid
297
+ * @description Connection ID
298
+ */
299
+ id: string;
300
+ /** @description Connection Name */
301
+ name: string;
302
+ /** @description Human-readable description of the connection and its purpose. */
303
+ description?: string;
304
+ /**
305
+ * Format: uri
306
+ * @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
307
+ */
308
+ url?: string;
309
+ /**
310
+ * Format: uuid
311
+ * @description Associated Credential ID
312
+ */
313
+ credentialId?: string;
314
+ /** @description Connection Type (platform, telemetry, collaboration) */
315
+ type: string;
316
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
317
+ subType: string;
318
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
319
+ kind: string;
320
+ /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
321
+ modelReference?: {
322
+ /**
323
+ * Format: uuid
324
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
325
+ */
326
+ id: string;
327
+ /**
328
+ * @description The unique name for the model within the scope of a registrant.
329
+ * @example cert-manager
330
+ */
331
+ name: string;
332
+ /** @description Version of the model definition. */
333
+ version: string;
334
+ /**
335
+ * @description Human-readable name for the model.
336
+ * @example Cert Manager
337
+ */
338
+ displayName: string;
339
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
340
+ model: {
341
+ /** @description Version of the model as defined by the registrant. */
342
+ version: string;
343
+ };
344
+ registrant: {
345
+ /** @description Kind of the registrant. */
346
+ kind: string;
347
+ };
348
+ };
349
+ /** @description Additional connection metadata */
350
+ metadata?: Record<string, never>;
351
+ /** @description Schema for the credential Associated with the connection */
352
+ credentialSchema?: Record<string, never>;
353
+ /** @description Schema for the connection */
354
+ connectionSchema?: Record<string, never>;
355
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
356
+ styles?: ({
357
+ /** @description Primary color of the component used for UI representation. */
358
+ primaryColor: string;
359
+ /** @description Secondary color of the entity used for UI representation. */
360
+ secondaryColor?: string;
361
+ /** @description White SVG of the entity used for UI representation on dark background. */
362
+ svgWhite: string;
363
+ /** @description Colored SVG of the entity used for UI representation on light background. */
364
+ svgColor: string;
365
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
366
+ svgComplete: string;
367
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
368
+ color?: string;
369
+ /** @description The opacity of the label text, including its outline. */
370
+ textOpacity?: number;
371
+ /** @description A comma-separated list of font names to use on the label text. */
372
+ fontFamily?: string;
373
+ /** @description The size of the label text. */
374
+ fontSize?: string;
375
+ /** @description A CSS font style to be applied to the label text. */
376
+ fontStyle?: string;
377
+ /** @description A CSS font weight to be applied to the label text. */
378
+ fontWeight?: string;
379
+ /**
380
+ * @description A transformation to apply to the label text
381
+ * @enum {string}
382
+ */
383
+ textTransform?: "none" | "uppercase" | "lowercase";
384
+ /** @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. */
385
+ opacity?: number;
386
+ /** @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. */
387
+ zIndex?: number;
388
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
389
+ label?: string;
390
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
391
+ animation?: Record<string, never>;
392
+ } & {
393
+ [key: string]: unknown;
394
+ }) & {
395
+ /**
396
+ * @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)
397
+ * @enum {string}
398
+ */
399
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
400
+ /** @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. */
401
+ position?: {
402
+ /** @description The x-coordinate of the node. */
403
+ x: number;
404
+ /** @description The y-coordinate of the node. */
405
+ y: number;
406
+ };
407
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
408
+ bodyText?: string;
409
+ /**
410
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
411
+ * @enum {string}
412
+ */
413
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
414
+ /** @description The maximum width for wrapping text in the node. */
415
+ bodyTextMaxWidth?: string;
416
+ /** @description The opacity of the node's body text, including its outline. */
417
+ bodyTextOpacity?: number;
418
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
419
+ bodyTextBackgroundColor?: string;
420
+ /** @description The size of the node's body text. */
421
+ bodyTextFontSize?: number;
422
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
423
+ bodyTextColor?: string;
424
+ /** @description A CSS font weight to be applied to the node's body text. */
425
+ bodyTextFontWeight?: string;
426
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
427
+ bodyTextHorizontalAlign?: string;
428
+ /** @description A CSS text decoration to be applied to the node's body text. */
429
+ bodyTextDecoration?: string;
430
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
431
+ bodyTextVerticalAlign?: string;
432
+ /** @description The width of the node's body or the width of an edge's line. */
433
+ width?: number;
434
+ /** @description The height of the node's body */
435
+ height?: number;
436
+ /**
437
+ * Format: uri
438
+ * @description The URL that points to the image to show in the node.
439
+ */
440
+ backgroundImage?: string;
441
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
442
+ backgroundColor?: string;
443
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
444
+ backgroundBlacken?: number;
445
+ /** @description The opacity level of the node's background colour */
446
+ backgroundOpacity?: number;
447
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
448
+ backgroundPositionX?: string;
449
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
450
+ backgroundPositionY?: string;
451
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
452
+ backgroundOffsetX?: string;
453
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
454
+ backgroundOffsetY?: string;
455
+ /**
456
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
457
+ * @enum {string}
458
+ */
459
+ backgroundFit?: "none" | "contain" | "cover";
460
+ /**
461
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
462
+ * @enum {string}
463
+ */
464
+ backgroundClip?: "none" | "node" | "node-border";
465
+ /**
466
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
467
+ * @enum {string}
468
+ */
469
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
470
+ /**
471
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
472
+ * @enum {string}
473
+ */
474
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
475
+ /** @description The size of the node's border. */
476
+ borderWidth?: number;
477
+ /**
478
+ * @description The style of the node's border
479
+ * @enum {string}
480
+ */
481
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
482
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
483
+ borderColor?: string;
484
+ /** @description The opacity of the node's border */
485
+ borderOpacity?: number;
486
+ /** @description The amount of padding around all sides of the node. */
487
+ padding?: number;
488
+ /**
489
+ * @description The horizontal alignment of a node's label
490
+ * @enum {string}
491
+ */
492
+ textHalign?: "left" | "center" | "right";
493
+ /**
494
+ * @description The vertical alignment of a node's label
495
+ * @enum {string}
496
+ */
497
+ textValign?: "top" | "center" | "bottom";
498
+ /**
499
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
500
+ * @default no
501
+ * @enum {string}
502
+ */
503
+ ghost: "yes" | "no";
504
+ /** @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. */
505
+ activeBgColor?: string;
506
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
507
+ activeBgOpacity?: string;
508
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
509
+ activeBgSize?: string;
510
+ /** @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. */
511
+ selectionBoxColor?: string;
512
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
513
+ selectionBoxBorderWidth?: number;
514
+ /** @description The opacity of the selection box. Selector needs to be *core* */
515
+ selectionBoxOpacity?: number;
516
+ /** @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. */
517
+ outsideTextureBgColor?: string;
518
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
519
+ outsideTextureBgOpacity?: number;
520
+ /** @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 ) */
521
+ shapePolygonPoints?: string;
522
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
523
+ menuBackgroundColor?: string;
524
+ /** @description The opacity of the background of the component menu. */
525
+ menuBackgroundOpacity?: number;
526
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
527
+ menuForgroundColor?: string;
528
+ };
529
+ /**
530
+ * @description Connection Status
531
+ * @enum {string}
532
+ */
533
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
534
+ /** @description Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status, along with a description of each transition. */
535
+ transitionMap?: {
536
+ [key: string]: {
537
+ /**
538
+ * @description The connection state reachable from the current state.
539
+ * @enum {string}
540
+ */
541
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
542
+ /** @description Human-readable explanation of when or why this transition occurs. */
543
+ description?: string;
544
+ }[];
545
+ };
546
+ /**
547
+ * Format: uuid
548
+ * @description User ID who owns this connection
549
+ */
550
+ owner?: string;
551
+ /**
552
+ * Format: date-time
553
+ * @description Timestamp when the connection was created.
554
+ */
555
+ createdAt?: string;
556
+ /**
557
+ * Format: date-time
558
+ * @description Timestamp when the connection was last updated.
559
+ */
560
+ updatedAt?: string;
561
+ /**
562
+ * Format: date-time
563
+ * @description Timestamp when the connection was soft-deleted, if applicable.
564
+ */
565
+ deletedAt?: string | null;
566
+ /**
567
+ * Format: uuid
568
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
569
+ */
570
+ organizationId: string;
571
+ /** @description Associated environments for this connection */
572
+ environments?: {
573
+ /**
574
+ * Format: uuid
575
+ * @description ID
576
+ */
577
+ id: string;
578
+ /**
579
+ * @description Specifies the version of the schema to which the environment conforms.
580
+ * @default environments.meshery.io/v1beta3
581
+ * @example [
582
+ * "v1",
583
+ * "v1alpha1",
584
+ * "v2beta3",
585
+ * "v1.custom-suffix",
586
+ * "models.meshery.io/v1beta1",
587
+ * "capability.meshery.io/v1alpha1"
588
+ * ]
589
+ */
590
+ schemaVersion: string;
591
+ /** @description Environment name */
592
+ name: string;
593
+ /** @description Environment description */
594
+ description: string;
595
+ /**
596
+ * Format: uuid
597
+ * @description Environment organization ID
598
+ */
599
+ organizationId: string;
600
+ /**
601
+ * Format: uuid
602
+ * @description Environment owner
603
+ */
604
+ owner?: string;
605
+ /**
606
+ * Format: date-time
607
+ * @description Timestamp when the environment was created.
608
+ */
609
+ createdAt?: string;
610
+ /** @description Additional metadata associated with the environment. */
611
+ metadata?: Record<string, never>;
612
+ /**
613
+ * Format: date-time
614
+ * @description Timestamp when the environment was last updated.
615
+ */
616
+ updatedAt?: string;
617
+ /**
618
+ * Format: date-time
619
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
620
+ */
621
+ deletedAt?: string | null;
622
+ /**
623
+ * @description What the environment exists for. `user` is an ordinary environment that people create to logically group Connections and their Credentials. `administrative` designates an environment the platform itself provisions to hold organization-level configuration, and which resolvers of that configuration therefore trust. Profiles are not environments: they are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`).
624
+ *
625
+ * Absent means `user`. Nothing may read an unset or unrecognised value as administrative: test for the administrative value explicitly rather than for "not user", so the property fails closed.
626
+ *
627
+ * At most one live environment per organization may carry any single privileged purpose - `administrative`, and each privileged value a later version adds. Name those values explicitly wherever the rule is enforced, including the database index predicate: a "not `user`" test also matches the empty value that unmigrated rows and un-normalised writes read back as, which means ordinary. A resolver that selects an environment by purpose MUST fail closed when more than one live row matches: return an error rather than whichever row the database happened to return first.
628
+ *
629
+ * Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged value `user`, and the create-or-edit form has no field for it, so the environment create and update endpoints cannot designate an environment administrative. That restriction is a codegen guarantee, never access control: the registrant connection inlines the full environment entity, so `registerRegistryComponent` and `registerRegistryRelationship` do carry `purpose` in a request type and consumers MUST refuse it on input there too. Whatever surface a value arrives on, every consumer MUST assign this property only from server-side provisioning or a data migration. Permission to create an environment does not confer the ability to make one administrative.
630
+ *
631
+ * The database index that enforces the uniqueness invariant, the migration path for environments that are administrative by naming convention today, and each consumer's obligations are specified in https://github.com/meshery/schemas/blob/master/docs/environment-purpose-contract.md.
632
+ * @enum {string}
633
+ */
634
+ purpose?: "user" | "administrative";
635
+ }[];
636
+ /**
637
+ * @description Specifies the version of the schema used for the definition.
638
+ * @default connections.meshery.io/v1beta3
639
+ * @example [
640
+ * "v1",
641
+ * "v1alpha1",
642
+ * "v2beta3",
643
+ * "v1.custom-suffix",
644
+ * "models.meshery.io/v1beta1",
645
+ * "capability.meshery.io/v1alpha1"
646
+ * ]
647
+ */
648
+ schemaVersion: string;
296
649
  }[];
297
650
  };
298
651
  /** @description Paginated list of environment-to-connection mapping records, returned when a connection is assigned to or unassigned from an environment. Distinct from EnvironmentConnectionsPage, which lists the connections themselves rather than the junction records. */
@@ -1085,9 +1438,362 @@ export interface operations {
1085
1438
  pageSize?: number;
1086
1439
  /** @description Total number of items available. */
1087
1440
  totalCount?: number;
1088
- /** @description The connections of the environmentconnectionspage. */
1441
+ /** @description Connections associated with the environment, using the canonical Connection response schema. */
1089
1442
  connections?: {
1090
- [key: string]: unknown;
1443
+ /**
1444
+ * Format: uuid
1445
+ * @description Connection ID
1446
+ */
1447
+ id: string;
1448
+ /** @description Connection Name */
1449
+ name: string;
1450
+ /** @description Human-readable description of the connection and its purpose. */
1451
+ description?: string;
1452
+ /**
1453
+ * Format: uri
1454
+ * @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
1455
+ */
1456
+ url?: string;
1457
+ /**
1458
+ * Format: uuid
1459
+ * @description Associated Credential ID
1460
+ */
1461
+ credentialId?: string;
1462
+ /** @description Connection Type (platform, telemetry, collaboration) */
1463
+ type: string;
1464
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
1465
+ subType: string;
1466
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
1467
+ kind: string;
1468
+ /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
1469
+ modelReference?: {
1470
+ /**
1471
+ * Format: uuid
1472
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1473
+ */
1474
+ id: string;
1475
+ /**
1476
+ * @description The unique name for the model within the scope of a registrant.
1477
+ * @example cert-manager
1478
+ */
1479
+ name: string;
1480
+ /** @description Version of the model definition. */
1481
+ version: string;
1482
+ /**
1483
+ * @description Human-readable name for the model.
1484
+ * @example Cert Manager
1485
+ */
1486
+ displayName: string;
1487
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1488
+ model: {
1489
+ /** @description Version of the model as defined by the registrant. */
1490
+ version: string;
1491
+ };
1492
+ registrant: {
1493
+ /** @description Kind of the registrant. */
1494
+ kind: string;
1495
+ };
1496
+ };
1497
+ /** @description Additional connection metadata */
1498
+ metadata?: Record<string, never>;
1499
+ /** @description Schema for the credential Associated with the connection */
1500
+ credentialSchema?: Record<string, never>;
1501
+ /** @description Schema for the connection */
1502
+ connectionSchema?: Record<string, never>;
1503
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
1504
+ styles?: ({
1505
+ /** @description Primary color of the component used for UI representation. */
1506
+ primaryColor: string;
1507
+ /** @description Secondary color of the entity used for UI representation. */
1508
+ secondaryColor?: string;
1509
+ /** @description White SVG of the entity used for UI representation on dark background. */
1510
+ svgWhite: string;
1511
+ /** @description Colored SVG of the entity used for UI representation on light background. */
1512
+ svgColor: string;
1513
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
1514
+ svgComplete: string;
1515
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
1516
+ color?: string;
1517
+ /** @description The opacity of the label text, including its outline. */
1518
+ textOpacity?: number;
1519
+ /** @description A comma-separated list of font names to use on the label text. */
1520
+ fontFamily?: string;
1521
+ /** @description The size of the label text. */
1522
+ fontSize?: string;
1523
+ /** @description A CSS font style to be applied to the label text. */
1524
+ fontStyle?: string;
1525
+ /** @description A CSS font weight to be applied to the label text. */
1526
+ fontWeight?: string;
1527
+ /**
1528
+ * @description A transformation to apply to the label text
1529
+ * @enum {string}
1530
+ */
1531
+ textTransform?: "none" | "uppercase" | "lowercase";
1532
+ /** @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. */
1533
+ opacity?: number;
1534
+ /** @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. */
1535
+ zIndex?: number;
1536
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
1537
+ label?: string;
1538
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
1539
+ animation?: Record<string, never>;
1540
+ } & {
1541
+ [key: string]: unknown;
1542
+ }) & {
1543
+ /**
1544
+ * @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)
1545
+ * @enum {string}
1546
+ */
1547
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
1548
+ /** @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. */
1549
+ position?: {
1550
+ /** @description The x-coordinate of the node. */
1551
+ x: number;
1552
+ /** @description The y-coordinate of the node. */
1553
+ y: number;
1554
+ };
1555
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
1556
+ bodyText?: string;
1557
+ /**
1558
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
1559
+ * @enum {string}
1560
+ */
1561
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
1562
+ /** @description The maximum width for wrapping text in the node. */
1563
+ bodyTextMaxWidth?: string;
1564
+ /** @description The opacity of the node's body text, including its outline. */
1565
+ bodyTextOpacity?: number;
1566
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
1567
+ bodyTextBackgroundColor?: string;
1568
+ /** @description The size of the node's body text. */
1569
+ bodyTextFontSize?: number;
1570
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
1571
+ bodyTextColor?: string;
1572
+ /** @description A CSS font weight to be applied to the node's body text. */
1573
+ bodyTextFontWeight?: string;
1574
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
1575
+ bodyTextHorizontalAlign?: string;
1576
+ /** @description A CSS text decoration to be applied to the node's body text. */
1577
+ bodyTextDecoration?: string;
1578
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
1579
+ bodyTextVerticalAlign?: string;
1580
+ /** @description The width of the node's body or the width of an edge's line. */
1581
+ width?: number;
1582
+ /** @description The height of the node's body */
1583
+ height?: number;
1584
+ /**
1585
+ * Format: uri
1586
+ * @description The URL that points to the image to show in the node.
1587
+ */
1588
+ backgroundImage?: string;
1589
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
1590
+ backgroundColor?: string;
1591
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
1592
+ backgroundBlacken?: number;
1593
+ /** @description The opacity level of the node's background colour */
1594
+ backgroundOpacity?: number;
1595
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
1596
+ backgroundPositionX?: string;
1597
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
1598
+ backgroundPositionY?: string;
1599
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
1600
+ backgroundOffsetX?: string;
1601
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
1602
+ backgroundOffsetY?: string;
1603
+ /**
1604
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
1605
+ * @enum {string}
1606
+ */
1607
+ backgroundFit?: "none" | "contain" | "cover";
1608
+ /**
1609
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
1610
+ * @enum {string}
1611
+ */
1612
+ backgroundClip?: "none" | "node" | "node-border";
1613
+ /**
1614
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
1615
+ * @enum {string}
1616
+ */
1617
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
1618
+ /**
1619
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
1620
+ * @enum {string}
1621
+ */
1622
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
1623
+ /** @description The size of the node's border. */
1624
+ borderWidth?: number;
1625
+ /**
1626
+ * @description The style of the node's border
1627
+ * @enum {string}
1628
+ */
1629
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
1630
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
1631
+ borderColor?: string;
1632
+ /** @description The opacity of the node's border */
1633
+ borderOpacity?: number;
1634
+ /** @description The amount of padding around all sides of the node. */
1635
+ padding?: number;
1636
+ /**
1637
+ * @description The horizontal alignment of a node's label
1638
+ * @enum {string}
1639
+ */
1640
+ textHalign?: "left" | "center" | "right";
1641
+ /**
1642
+ * @description The vertical alignment of a node's label
1643
+ * @enum {string}
1644
+ */
1645
+ textValign?: "top" | "center" | "bottom";
1646
+ /**
1647
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
1648
+ * @default no
1649
+ * @enum {string}
1650
+ */
1651
+ ghost: "yes" | "no";
1652
+ /** @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. */
1653
+ activeBgColor?: string;
1654
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
1655
+ activeBgOpacity?: string;
1656
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
1657
+ activeBgSize?: string;
1658
+ /** @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. */
1659
+ selectionBoxColor?: string;
1660
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
1661
+ selectionBoxBorderWidth?: number;
1662
+ /** @description The opacity of the selection box. Selector needs to be *core* */
1663
+ selectionBoxOpacity?: number;
1664
+ /** @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. */
1665
+ outsideTextureBgColor?: string;
1666
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
1667
+ outsideTextureBgOpacity?: number;
1668
+ /** @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 ) */
1669
+ shapePolygonPoints?: string;
1670
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
1671
+ menuBackgroundColor?: string;
1672
+ /** @description The opacity of the background of the component menu. */
1673
+ menuBackgroundOpacity?: number;
1674
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
1675
+ menuForgroundColor?: string;
1676
+ };
1677
+ /**
1678
+ * @description Connection Status
1679
+ * @enum {string}
1680
+ */
1681
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
1682
+ /** @description Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status, along with a description of each transition. */
1683
+ transitionMap?: {
1684
+ [key: string]: {
1685
+ /**
1686
+ * @description The connection state reachable from the current state.
1687
+ * @enum {string}
1688
+ */
1689
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
1690
+ /** @description Human-readable explanation of when or why this transition occurs. */
1691
+ description?: string;
1692
+ }[];
1693
+ };
1694
+ /**
1695
+ * Format: uuid
1696
+ * @description User ID who owns this connection
1697
+ */
1698
+ owner?: string;
1699
+ /**
1700
+ * Format: date-time
1701
+ * @description Timestamp when the connection was created.
1702
+ */
1703
+ createdAt?: string;
1704
+ /**
1705
+ * Format: date-time
1706
+ * @description Timestamp when the connection was last updated.
1707
+ */
1708
+ updatedAt?: string;
1709
+ /**
1710
+ * Format: date-time
1711
+ * @description Timestamp when the connection was soft-deleted, if applicable.
1712
+ */
1713
+ deletedAt?: string | null;
1714
+ /**
1715
+ * Format: uuid
1716
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
1717
+ */
1718
+ organizationId: string;
1719
+ /** @description Associated environments for this connection */
1720
+ environments?: {
1721
+ /**
1722
+ * Format: uuid
1723
+ * @description ID
1724
+ */
1725
+ id: string;
1726
+ /**
1727
+ * @description Specifies the version of the schema to which the environment conforms.
1728
+ * @default environments.meshery.io/v1beta3
1729
+ * @example [
1730
+ * "v1",
1731
+ * "v1alpha1",
1732
+ * "v2beta3",
1733
+ * "v1.custom-suffix",
1734
+ * "models.meshery.io/v1beta1",
1735
+ * "capability.meshery.io/v1alpha1"
1736
+ * ]
1737
+ */
1738
+ schemaVersion: string;
1739
+ /** @description Environment name */
1740
+ name: string;
1741
+ /** @description Environment description */
1742
+ description: string;
1743
+ /**
1744
+ * Format: uuid
1745
+ * @description Environment organization ID
1746
+ */
1747
+ organizationId: string;
1748
+ /**
1749
+ * Format: uuid
1750
+ * @description Environment owner
1751
+ */
1752
+ owner?: string;
1753
+ /**
1754
+ * Format: date-time
1755
+ * @description Timestamp when the environment was created.
1756
+ */
1757
+ createdAt?: string;
1758
+ /** @description Additional metadata associated with the environment. */
1759
+ metadata?: Record<string, never>;
1760
+ /**
1761
+ * Format: date-time
1762
+ * @description Timestamp when the environment was last updated.
1763
+ */
1764
+ updatedAt?: string;
1765
+ /**
1766
+ * Format: date-time
1767
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
1768
+ */
1769
+ deletedAt?: string | null;
1770
+ /**
1771
+ * @description What the environment exists for. `user` is an ordinary environment that people create to logically group Connections and their Credentials. `administrative` designates an environment the platform itself provisions to hold organization-level configuration, and which resolvers of that configuration therefore trust. Profiles are not environments: they are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`).
1772
+ *
1773
+ * Absent means `user`. Nothing may read an unset or unrecognised value as administrative: test for the administrative value explicitly rather than for "not user", so the property fails closed.
1774
+ *
1775
+ * At most one live environment per organization may carry any single privileged purpose - `administrative`, and each privileged value a later version adds. Name those values explicitly wherever the rule is enforced, including the database index predicate: a "not `user`" test also matches the empty value that unmigrated rows and un-normalised writes read back as, which means ordinary. A resolver that selects an environment by purpose MUST fail closed when more than one live row matches: return an error rather than whichever row the database happened to return first.
1776
+ *
1777
+ * Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged value `user`, and the create-or-edit form has no field for it, so the environment create and update endpoints cannot designate an environment administrative. That restriction is a codegen guarantee, never access control: the registrant connection inlines the full environment entity, so `registerRegistryComponent` and `registerRegistryRelationship` do carry `purpose` in a request type and consumers MUST refuse it on input there too. Whatever surface a value arrives on, every consumer MUST assign this property only from server-side provisioning or a data migration. Permission to create an environment does not confer the ability to make one administrative.
1778
+ *
1779
+ * The database index that enforces the uniqueness invariant, the migration path for environments that are administrative by naming convention today, and each consumer's obligations are specified in https://github.com/meshery/schemas/blob/master/docs/environment-purpose-contract.md.
1780
+ * @enum {string}
1781
+ */
1782
+ purpose?: "user" | "administrative";
1783
+ }[];
1784
+ /**
1785
+ * @description Specifies the version of the schema used for the definition.
1786
+ * @default connections.meshery.io/v1beta3
1787
+ * @example [
1788
+ * "v1",
1789
+ * "v1alpha1",
1790
+ * "v2beta3",
1791
+ * "v1.custom-suffix",
1792
+ * "models.meshery.io/v1beta1",
1793
+ * "capability.meshery.io/v1alpha1"
1794
+ * ]
1795
+ */
1796
+ schemaVersion: string;
1091
1797
  }[];
1092
1798
  };
1093
1799
  };