@meshery/schemas 1.3.114 → 1.3.116

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 (37) hide show
  1. package/dist/cloudApi.d.mts +1080 -8
  2. package/dist/cloudApi.d.ts +1080 -8
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta2/core/Core.d.ts +8 -0
  6. package/dist/constructs/v1beta2/core/CoreSchema.js +2 -2
  7. package/dist/constructs/v1beta2/core/CoreSchema.mjs +2 -2
  8. package/dist/constructs/v1beta2/credential/Credential.d.ts +144 -0
  9. package/dist/constructs/v1beta2/credential/CredentialSchema.js +4 -1
  10. package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +4 -1
  11. package/dist/constructs/v1beta3/design/Design.d.ts +84 -2
  12. package/dist/constructs/v1beta3/design/DesignSchema.js +4 -2
  13. package/dist/constructs/v1beta3/design/DesignSchema.mjs +4 -2
  14. package/dist/constructs/v1beta3/environment/Environment.d.ts +710 -4
  15. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  16. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  17. package/dist/constructs/v1beta3/errorcode/Errorcode.d.ts +193 -0
  18. package/dist/constructs/v1beta3/errorcode/Errorcode.js +1 -0
  19. package/dist/constructs/v1beta3/errorcode/Errorcode.mjs +0 -0
  20. package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.d.ts +2 -0
  21. package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.js +9 -0
  22. package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.mjs +9 -0
  23. package/dist/constructs/v1beta3/event/Event.d.ts +930 -8
  24. package/dist/constructs/v1beta3/event/EventSchema.js +27 -11
  25. package/dist/constructs/v1beta3/event/EventSchema.mjs +27 -11
  26. package/dist/constructs/v1beta3/user/User.d.ts +8 -0
  27. package/dist/constructs/v1beta3/user/UserSchema.js +1 -1
  28. package/dist/constructs/v1beta3/user/UserSchema.mjs +1 -1
  29. package/dist/index.d.mts +805 -79
  30. package/dist/index.d.ts +805 -79
  31. package/dist/index.js +10 -10
  32. package/dist/index.mjs +10 -10
  33. package/dist/mesheryApi.d.mts +338 -6
  34. package/dist/mesheryApi.d.ts +338 -6
  35. package/dist/mesheryApi.js +1 -1
  36. package/dist/mesheryApi.mjs +1 -1
  37. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- interface components$C {
1
+ interface components$D {
2
2
  schemas: {
3
3
  /**
4
4
  * @description Meshery manages entities in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
@@ -109,7 +109,7 @@ interface components$C {
109
109
  pathItems: never;
110
110
  }
111
111
 
112
- interface components$B {
112
+ interface components$C {
113
113
  schemas: {
114
114
  CatalogData: {
115
115
  /** @description Tracks the specific content version that has been made available in the Catalog. */
@@ -149,7 +149,7 @@ interface components$B {
149
149
  pathItems: never;
150
150
  }
151
151
 
152
- interface components$A {
152
+ interface components$B {
153
153
  schemas: {
154
154
  /**
155
155
  * @description Meshery manages entities in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
@@ -260,7 +260,7 @@ interface components$A {
260
260
  pathItems: never;
261
261
  }
262
262
 
263
- interface components$z {
263
+ interface components$A {
264
264
  schemas: {
265
265
  /** @description Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components */
266
266
  ComponentDefinition: {
@@ -1022,7 +1022,7 @@ interface components$z {
1022
1022
  pathItems: never;
1023
1023
  }
1024
1024
 
1025
- interface components$y {
1025
+ interface components$z {
1026
1026
  schemas: {
1027
1027
  /** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
1028
1028
  Connection: {
@@ -1434,7 +1434,7 @@ interface components$y {
1434
1434
  pathItems: never;
1435
1435
  }
1436
1436
 
1437
- interface components$x {
1437
+ interface components$y {
1438
1438
  schemas: {
1439
1439
  /** @description Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems. */
1440
1440
  Credential: {
@@ -1571,7 +1571,7 @@ interface components$x {
1571
1571
  pathItems: never;
1572
1572
  }
1573
1573
 
1574
- interface components$w {
1574
+ interface components$x {
1575
1575
  schemas: {
1576
1576
  /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1577
1577
  Model: {
@@ -2319,7 +2319,7 @@ interface components$w {
2319
2319
  pathItems: never;
2320
2320
  }
2321
2321
 
2322
- interface components$v {
2322
+ interface components$w {
2323
2323
  schemas: {
2324
2324
  /** @description Represents a user */
2325
2325
  User: {
@@ -3316,7 +3316,7 @@ interface components$v {
3316
3316
  pathItems: never;
3317
3317
  }
3318
3318
 
3319
- interface components$u {
3319
+ interface components$v {
3320
3320
  schemas: {
3321
3321
  DeletePatternModel: {
3322
3322
  /** Format: uuid */
@@ -10644,7 +10644,7 @@ interface components$u {
10644
10644
  pathItems: never;
10645
10645
  }
10646
10646
 
10647
- interface components$t {
10647
+ interface components$u {
10648
10648
  schemas: {
10649
10649
  /** @description Category of the model. */
10650
10650
  CategoryDefinition: {
@@ -10670,7 +10670,7 @@ interface components$t {
10670
10670
  pathItems: never;
10671
10671
  }
10672
10672
 
10673
- interface components$s {
10673
+ interface components$t {
10674
10674
  schemas: {
10675
10675
  /**
10676
10676
  * SubCategory
@@ -10687,7 +10687,7 @@ interface components$s {
10687
10687
  pathItems: never;
10688
10688
  }
10689
10689
 
10690
- interface components$r {
10690
+ interface components$s {
10691
10691
  schemas: {
10692
10692
  /**
10693
10693
  * Environment
@@ -10943,7 +10943,7 @@ interface components$r {
10943
10943
  pathItems: never;
10944
10944
  }
10945
10945
 
10946
- interface components$q {
10946
+ interface components$r {
10947
10947
  schemas: {
10948
10948
  EvaluationRequest: {
10949
10949
  /**
@@ -13905,7 +13905,7 @@ interface components$q {
13905
13905
  pathItems: never;
13906
13906
  }
13907
13907
 
13908
- interface components$p {
13908
+ interface components$q {
13909
13909
  schemas: {
13910
13910
  /** @description A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design. */
13911
13911
  Feature: {
@@ -14094,7 +14094,7 @@ interface components$p {
14094
14094
  pathItems: never;
14095
14095
  }
14096
14096
 
14097
- interface components$o {
14097
+ interface components$p {
14098
14098
  schemas: {
14099
14099
  /** @description Represents an authorization key used for access control. */
14100
14100
  Key: {
@@ -14247,7 +14247,7 @@ interface components$o {
14247
14247
  pathItems: never;
14248
14248
  }
14249
14249
 
14250
- interface components$n {
14250
+ interface components$o {
14251
14251
  schemas: {
14252
14252
  /** @description Represents a collection of keys. */
14253
14253
  Keychain: {
@@ -14382,7 +14382,7 @@ interface components$n {
14382
14382
  pathItems: never;
14383
14383
  }
14384
14384
 
14385
- interface components$m {
14385
+ interface components$n {
14386
14386
  schemas: {
14387
14387
  /**
14388
14388
  * Format: uuid
@@ -15091,7 +15091,7 @@ interface components$m {
15091
15091
  pathItems: never;
15092
15092
  }
15093
15093
 
15094
- interface components$l {
15094
+ interface components$m {
15095
15095
  schemas: {
15096
15096
  /** @description Role definition */
15097
15097
  Role: {
@@ -15311,7 +15311,7 @@ interface components$l {
15311
15311
  pathItems: never;
15312
15312
  }
15313
15313
 
15314
- interface components$k {
15314
+ interface components$l {
15315
15315
  schemas: {
15316
15316
  /** @description A schedule defines a recurring cron-based trigger for performance tests or other automated tasks. */
15317
15317
  Schedule: {
@@ -15432,7 +15432,7 @@ interface components$k {
15432
15432
  pathItems: never;
15433
15433
  }
15434
15434
 
15435
- interface components$j {
15435
+ interface components$k {
15436
15436
  schemas: {
15437
15437
  /** @description Request body for sending a test email through the configured SMTP provider. */
15438
15438
  EmailTestRequest: {
@@ -15927,7 +15927,7 @@ interface components$j {
15927
15927
  pathItems: never;
15928
15928
  }
15929
15929
 
15930
- interface components$i {
15930
+ interface components$j {
15931
15931
  schemas: {
15932
15932
  /** @description A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within Meshery. Learn more at https://docs.meshery.io/concepts/logical/teams */
15933
15933
  Team: {
@@ -16164,7 +16164,7 @@ interface components$i {
16164
16164
  pathItems: never;
16165
16165
  }
16166
16166
 
16167
- interface components$h {
16167
+ interface components$i {
16168
16168
  schemas: {
16169
16169
  /** @description A workspace is a logical grouping of resources within an organization. Workspaces provide a way to organize environments, designs, teams, and views. Learn more at https://docs.meshery.io/concepts/logical/workspaces */
16170
16170
  Workspace: {
@@ -18193,7 +18193,7 @@ interface components$h {
18193
18193
  pathItems: never;
18194
18194
  }
18195
18195
 
18196
- interface components$g {
18196
+ interface components$h {
18197
18197
  schemas: {
18198
18198
  /**
18199
18199
  * Format: uuid
@@ -18411,7 +18411,7 @@ interface components$g {
18411
18411
  pathItems: never;
18412
18412
  }
18413
18413
 
18414
- interface components$f {
18414
+ interface components$g {
18415
18415
  schemas: {
18416
18416
  /** @description Payload for creating or updating a badge. */
18417
18417
  BadgePayload: {
@@ -18604,7 +18604,7 @@ interface components$f {
18604
18604
  pathItems: never;
18605
18605
  }
18606
18606
 
18607
- interface components$e {
18607
+ interface components$f {
18608
18608
  schemas: {
18609
18609
  /**
18610
18610
  * @description Organization ID that owns this learning path
@@ -22641,7 +22641,7 @@ interface components$e {
22641
22641
  pathItems: never;
22642
22642
  }
22643
22643
 
22644
- interface components$d {
22644
+ interface components$e {
22645
22645
  schemas: {
22646
22646
  CatalogData: {
22647
22647
  /** @description Tracks the specific content version that has been made available in the Catalog. */
@@ -22681,7 +22681,7 @@ interface components$d {
22681
22681
  pathItems: never;
22682
22682
  }
22683
22683
 
22684
- interface components$c {
22684
+ interface components$d {
22685
22685
  schemas: {
22686
22686
  /** @description Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components */
22687
22687
  ComponentDefinition: {
@@ -23461,7 +23461,7 @@ interface components$c {
23461
23461
  pathItems: never;
23462
23462
  }
23463
23463
 
23464
- interface components$b {
23464
+ interface components$c {
23465
23465
  schemas: {
23466
23466
  /** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
23467
23467
  Connection: {
@@ -23893,7 +23893,7 @@ interface components$b {
23893
23893
  pathItems: never;
23894
23894
  }
23895
23895
 
23896
- interface components$a {
23896
+ interface components$b {
23897
23897
  schemas: {
23898
23898
  DeletePatternModel: {
23899
23899
  /** Format: uuid */
@@ -31504,7 +31504,7 @@ interface components$a {
31504
31504
  pathItems: never;
31505
31505
  }
31506
31506
 
31507
- interface components$9 {
31507
+ interface components$a {
31508
31508
  schemas: {
31509
31509
  UpdateEventStatusRequest: {
31510
31510
  /**
@@ -31681,7 +31681,7 @@ interface components$9 {
31681
31681
  pathItems: never;
31682
31682
  }
31683
31683
 
31684
- interface components$8 {
31684
+ interface components$9 {
31685
31685
  schemas: {
31686
31686
  /**
31687
31687
  * Format: uuid
@@ -31922,7 +31922,7 @@ interface components$8 {
31922
31922
  pathItems: never;
31923
31923
  }
31924
31924
 
31925
- interface components$7 {
31925
+ interface components$8 {
31926
31926
  schemas: {
31927
31927
  /**
31928
31928
  * Format: uuid
@@ -33836,7 +33836,7 @@ interface components$7 {
33836
33836
  pathItems: never;
33837
33837
  }
33838
33838
 
33839
- interface components$6 {
33839
+ interface components$7 {
33840
33840
  schemas: {
33841
33841
  PlanPage: {
33842
33842
  /** @description Current page number of the result set. */
@@ -33939,7 +33939,7 @@ interface components$6 {
33939
33939
  pathItems: never;
33940
33940
  }
33941
33941
 
33942
- interface components$5 {
33942
+ interface components$6 {
33943
33943
  schemas: {
33944
33944
  /** @description Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships. */
33945
33945
  RelationshipDefinition: {
@@ -35913,7 +35913,7 @@ interface components$5 {
35913
35913
  pathItems: never;
35914
35914
  }
35915
35915
 
35916
- interface components$4 {
35916
+ interface components$5 {
35917
35917
  schemas: {
35918
35918
  /**
35919
35919
  * @description Supported payment processors
@@ -36168,7 +36168,7 @@ interface components$4 {
36168
36168
  pathItems: never;
36169
36169
  }
36170
36170
 
36171
- interface components$3 {
36171
+ interface components$4 {
36172
36172
  schemas: {
36173
36173
  /** @description Represents a user-owned API token or OAuth session. */
36174
36174
  UserToken: {
@@ -36317,9 +36317,194 @@ interface components$3 {
36317
36317
  pathItems: never;
36318
36318
  }
36319
36319
 
36320
+ interface components$3 {
36321
+ schemas: {
36322
+ /** @description One error code's definition: the registry entry behind a code such as `meshery-server-1033`. It names the situation the code reports and, for each probable cause, the remediations that answer that cause. A definition is not stored by any server and has no endpoints: the component that owns the code declares it in source (MeshKit's `errors.NewV3`), MeshKit's `errorutil` exports it to the component's `*_errors_index.json`, and docs.meshery.io publishes every definition in an ErrorReferenceIndex. It therefore declares no `id`, `createdAt`, `updatedAt` or `deletedAt`; the code is its key. Causes and remediations are nested, never two parallel lists: each remediation sits under the cause it addresses, and one remediation that answers several causes is repeated under each with the same `id`, so the pairing is explicit and the text is defined once. The flat `probableCause` and `suggestedRemediation` lists earlier consumers read are derived from the nesting (see `probableCause`). The rules JSON Schema cannot state - ids unique, a repeated remediation identical, an `action` behind every `automatic` or `requiresApproval` policy, `code` ending in `-<numericCode>` and the flat lists equal to the derivation - are checked by `Validate` in the generated Go package's helper and by `validateErrorDefinition` in the TypeScript package (docs/error-definition-contract.md). */
36323
+ ErrorDefinition: {
36324
+ /** @description The full error code, `<component name>-<numericCode>`, for example `meshery-server-1033`. Codes are scoped to the component that owns them and carry no meaning of their own, so a code is unique only together with its component and nothing may be derived from the number alone. */
36325
+ code: string;
36326
+ /** @description The name the code has in source, for example `ErrCreatingUUIDInstanceCode` or `ErrApplyManifest`: what MeshKit's export calls `name`. It is not unique across components. */
36327
+ moniker: string;
36328
+ /** @description The component that owns the code. */
36329
+ component: {
36330
+ /** @description The kind of component, for example `component` (Meshery Server), `adapter`, `library` (MeshKit) or `client` (mesheryctl). An open set: a new kind of component needs no schema change. */
36331
+ type: string;
36332
+ /** @description The component's name, for example `meshery-server`, `meshkit` or `mesheryctl`. It is the prefix of every code the component owns. */
36333
+ name: string;
36334
+ };
36335
+ /** @description The number at the end of `code`, as a string of digits so leading zeros survive, for example `1033`. MeshKit's `errorutil` allocates it from the component's `component_info.json` and never reuses it. */
36336
+ numericCode: string;
36337
+ /**
36338
+ * @description How severe the error is when it occurs. Omitted when the component assigns none (MeshKit's `None`).
36339
+ * @enum {string}
36340
+ */
36341
+ severity?: "emergency" | "alert" | "critical" | "fatal" | "error" | "warning" | "informational" | "debug";
36342
+ /** @description One line saying what went wrong, for example `Unable to create UUID instance`. MeshKit's `ShortDescription` lines are joined with `. `. Omitted only for a code whose details the export could not read. */
36343
+ shortDescription?: string;
36344
+ /** @description The full explanation of the error. Omitted when the definition has only text rendered at run time, which MeshKit's `errorutil` cannot export. */
36345
+ longDescription?: string;
36346
+ /** @description What may have caused the error, most likely first, each with the remediations that answer it. Cause ids are unique within the definition. Omitted for a definition that documents no causes, such as a code declared with MeshKit's flat `errors.New`, whose flat lists are then the only record (and are unpaired). */
36347
+ probableCauses?: {
36348
+ /** @description Stable id of the cause, unique within the error's definition, for example `service-not-running`. An event names the causes that apply to one occurrence by this id (`EventError.matchedCauses`), and the docs page links to it, so it never changes once published. Lowercase words joined by hyphens. */
36349
+ id: string;
36350
+ /** @description What may have caused the error, for example `The service is not running.` */
36351
+ description: string;
36352
+ /** @description What answers this cause, the most likely fix first. A remediation that also answers another cause is repeated under that cause with the same `id` and identical fields. */
36353
+ remediations: {
36354
+ /** @description Stable id of the remediation, unique within the error's definition, for example `start-service`. The same id under two causes is one remediation answering both, so its fields must be identical in each place, and the flattened `suggestedRemediation` list carries it once. Lowercase words joined by hyphens. */
36355
+ id: string;
36356
+ /** @description What to do, written for a person, for example `Start the service.` */
36357
+ description: string;
36358
+ /** @description Identifier of an action a client can run to apply this remediation, as dot-separated lowercase words, for example `service.start` or `connection.reconnect`. The client that runs it owns its meaning; the definition only names it. Omitted when only a person can apply the remediation. */
36359
+ action?: string;
36360
+ /**
36361
+ * @description Whether a client may run `action` on its own. `automatic` and `requiresApproval` need an `action`. Omitted means `manual`.
36362
+ * @enum {string}
36363
+ */
36364
+ actionPolicy?: "automatic" | "requiresApproval" | "manual";
36365
+ }[];
36366
+ }[];
36367
+ /** @description The flat list of cause descriptions earlier consumers read (MeshKit's `ProbableCause`). When `probableCauses` is present it equals each cause's `description`, in order. Without `probableCauses` it is the definition's only record of its causes, and nothing pairs an entry with an entry of `suggestedRemediation`. */
36368
+ probableCause?: string[];
36369
+ /** @description The flat list of remediation descriptions earlier consumers read (MeshKit's `SuggestedRemediation`). When `probableCauses` is present it equals every remediation's `description` across the causes, in order, each remediation `id` once (the first time it appears). */
36370
+ suggestedRemediation?: string[];
36371
+ /**
36372
+ * Format: uri
36373
+ * @description The stable docs.meshery.io page for this code, for example `https://docs.meshery.io/reference/error-codes/component-meshery-server/errcreatinguuidinstancecode-1001/`. Always present in a published ErrorReferenceIndex; a component's export may omit it, because the docs build assigns it.
36374
+ */
36375
+ referenceUrl?: string;
36376
+ };
36377
+ /** @description The component that owns an error code: the `type` and `name` of its MeshKit `component_info.json`. Codes are unique only within one component. */
36378
+ ErrorComponent: {
36379
+ /** @description The kind of component, for example `component` (Meshery Server), `adapter`, `library` (MeshKit) or `client` (mesheryctl). An open set: a new kind of component needs no schema change. */
36380
+ type: string;
36381
+ /** @description The component's name, for example `meshery-server`, `meshkit` or `mesheryctl`. It is the prefix of every code the component owns. */
36382
+ name: string;
36383
+ };
36384
+ /**
36385
+ * @description How severe an error is, as its definition declares. MeshKit's severities map one to one: `Emergency` to `emergency`, `Alert` to `alert`, `Critical` to `critical` and `Fatal` to `fatal`; MeshKit's `None` is an omitted severity. `error`, `warning`, `informational` and `debug` name the less severe levels of the event severity ladder for components that define them. The event that reports an occurrence carries its own `severity`.
36386
+ * @enum {string}
36387
+ */
36388
+ ErrorSeverity: "emergency" | "alert" | "critical" | "fatal" | "error" | "warning" | "informational" | "debug";
36389
+ /** @description One probable cause of an error, with the remediations that answer it. Remediations are nested under the cause they address, never kept in a parallel list. */
36390
+ ProbableCause: {
36391
+ /** @description Stable id of the cause, unique within the error's definition, for example `service-not-running`. An event names the causes that apply to one occurrence by this id (`EventError.matchedCauses`), and the docs page links to it, so it never changes once published. Lowercase words joined by hyphens. */
36392
+ id: string;
36393
+ /** @description What may have caused the error, for example `The service is not running.` */
36394
+ description: string;
36395
+ /** @description What answers this cause, the most likely fix first. A remediation that also answers another cause is repeated under that cause with the same `id` and identical fields. */
36396
+ remediations: {
36397
+ /** @description Stable id of the remediation, unique within the error's definition, for example `start-service`. The same id under two causes is one remediation answering both, so its fields must be identical in each place, and the flattened `suggestedRemediation` list carries it once. Lowercase words joined by hyphens. */
36398
+ id: string;
36399
+ /** @description What to do, written for a person, for example `Start the service.` */
36400
+ description: string;
36401
+ /** @description Identifier of an action a client can run to apply this remediation, as dot-separated lowercase words, for example `service.start` or `connection.reconnect`. The client that runs it owns its meaning; the definition only names it. Omitted when only a person can apply the remediation. */
36402
+ action?: string;
36403
+ /**
36404
+ * @description Whether a client may run `action` on its own. `automatic` and `requiresApproval` need an `action`. Omitted means `manual`.
36405
+ * @enum {string}
36406
+ */
36407
+ actionPolicy?: "automatic" | "requiresApproval" | "manual";
36408
+ }[];
36409
+ };
36410
+ /** @description One remediation for a probable cause: what to do, and optionally a machine-readable action a client may run and the policy that says whether it may run it without asking a person. */
36411
+ Remediation: {
36412
+ /** @description Stable id of the remediation, unique within the error's definition, for example `start-service`. The same id under two causes is one remediation answering both, so its fields must be identical in each place, and the flattened `suggestedRemediation` list carries it once. Lowercase words joined by hyphens. */
36413
+ id: string;
36414
+ /** @description What to do, written for a person, for example `Start the service.` */
36415
+ description: string;
36416
+ /** @description Identifier of an action a client can run to apply this remediation, as dot-separated lowercase words, for example `service.start` or `connection.reconnect`. The client that runs it owns its meaning; the definition only names it. Omitted when only a person can apply the remediation. */
36417
+ action?: string;
36418
+ /**
36419
+ * @description Whether a client may run `action` on its own. `automatic` and `requiresApproval` need an `action`. Omitted means `manual`.
36420
+ * @enum {string}
36421
+ */
36422
+ actionPolicy?: "automatic" | "requiresApproval" | "manual";
36423
+ };
36424
+ /**
36425
+ * @description Whether a client may apply a remediation on its own. `automatic`: the client may run the remediation's `action` without asking and then tells the person it did. `requiresApproval`: the client runs the `action` only after a person approves it. `manual`: a person applies the remediation; a client shows it and never runs anything. An omitted policy is `manual`, and a reader treats a policy it does not know as `manual`, so a remediation is never run by mistake.
36426
+ * @enum {string}
36427
+ */
36428
+ ActionPolicy: "automatic" | "requiresApproval" | "manual";
36429
+ /** @description A list of error definitions, each code once. Published by docs.meshery.io at `https://docs.meshery.io/reference/error-codes/index.json`, it lists every component's codes, and every entry carries its `referenceUrl`; tools and bots validate codes and link to their pages from it. The same format is a component's export in the nested form (MeshKit's `errorutil`, `*_errors_index.json`): that component's definitions, where `referenceUrl` may be absent because the docs build assigns it when it merges the exports. A code is identified by its component and code. */
36430
+ ErrorReferenceIndex: {
36431
+ /**
36432
+ * @description Version of the index format. `2` is this schema, whose entries are ErrorDefinitions. Version `1` was the flat format the docs build first published, whose entries carry `componentType`, `componentName`, `name`, the numeric `code` and the joined `probableCause` and `suggestedRemediation` strings; a reader that meets it reads it as unpaired definitions.
36433
+ * @enum {integer}
36434
+ */
36435
+ schemaVersion: 2;
36436
+ /**
36437
+ * Format: date-time
36438
+ * @description When the docs build generated the index.
36439
+ */
36440
+ generatedAt?: string;
36441
+ /** @description The definitions, each code once; the published index orders them by `referenceUrl`. */
36442
+ errors: {
36443
+ /** @description The full error code, `<component name>-<numericCode>`, for example `meshery-server-1033`. Codes are scoped to the component that owns them and carry no meaning of their own, so a code is unique only together with its component and nothing may be derived from the number alone. */
36444
+ code: string;
36445
+ /** @description The name the code has in source, for example `ErrCreatingUUIDInstanceCode` or `ErrApplyManifest`: what MeshKit's export calls `name`. It is not unique across components. */
36446
+ moniker: string;
36447
+ /** @description The component that owns the code. */
36448
+ component: {
36449
+ /** @description The kind of component, for example `component` (Meshery Server), `adapter`, `library` (MeshKit) or `client` (mesheryctl). An open set: a new kind of component needs no schema change. */
36450
+ type: string;
36451
+ /** @description The component's name, for example `meshery-server`, `meshkit` or `mesheryctl`. It is the prefix of every code the component owns. */
36452
+ name: string;
36453
+ };
36454
+ /** @description The number at the end of `code`, as a string of digits so leading zeros survive, for example `1033`. MeshKit's `errorutil` allocates it from the component's `component_info.json` and never reuses it. */
36455
+ numericCode: string;
36456
+ /**
36457
+ * @description How severe the error is when it occurs. Omitted when the component assigns none (MeshKit's `None`).
36458
+ * @enum {string}
36459
+ */
36460
+ severity?: "emergency" | "alert" | "critical" | "fatal" | "error" | "warning" | "informational" | "debug";
36461
+ /** @description One line saying what went wrong, for example `Unable to create UUID instance`. MeshKit's `ShortDescription` lines are joined with `. `. Omitted only for a code whose details the export could not read. */
36462
+ shortDescription?: string;
36463
+ /** @description The full explanation of the error. Omitted when the definition has only text rendered at run time, which MeshKit's `errorutil` cannot export. */
36464
+ longDescription?: string;
36465
+ /** @description What may have caused the error, most likely first, each with the remediations that answer it. Cause ids are unique within the definition. Omitted for a definition that documents no causes, such as a code declared with MeshKit's flat `errors.New`, whose flat lists are then the only record (and are unpaired). */
36466
+ probableCauses?: {
36467
+ /** @description Stable id of the cause, unique within the error's definition, for example `service-not-running`. An event names the causes that apply to one occurrence by this id (`EventError.matchedCauses`), and the docs page links to it, so it never changes once published. Lowercase words joined by hyphens. */
36468
+ id: string;
36469
+ /** @description What may have caused the error, for example `The service is not running.` */
36470
+ description: string;
36471
+ /** @description What answers this cause, the most likely fix first. A remediation that also answers another cause is repeated under that cause with the same `id` and identical fields. */
36472
+ remediations: {
36473
+ /** @description Stable id of the remediation, unique within the error's definition, for example `start-service`. The same id under two causes is one remediation answering both, so its fields must be identical in each place, and the flattened `suggestedRemediation` list carries it once. Lowercase words joined by hyphens. */
36474
+ id: string;
36475
+ /** @description What to do, written for a person, for example `Start the service.` */
36476
+ description: string;
36477
+ /** @description Identifier of an action a client can run to apply this remediation, as dot-separated lowercase words, for example `service.start` or `connection.reconnect`. The client that runs it owns its meaning; the definition only names it. Omitted when only a person can apply the remediation. */
36478
+ action?: string;
36479
+ /**
36480
+ * @description Whether a client may run `action` on its own. `automatic` and `requiresApproval` need an `action`. Omitted means `manual`.
36481
+ * @enum {string}
36482
+ */
36483
+ actionPolicy?: "automatic" | "requiresApproval" | "manual";
36484
+ }[];
36485
+ }[];
36486
+ /** @description The flat list of cause descriptions earlier consumers read (MeshKit's `ProbableCause`). When `probableCauses` is present it equals each cause's `description`, in order. Without `probableCauses` it is the definition's only record of its causes, and nothing pairs an entry with an entry of `suggestedRemediation`. */
36487
+ probableCause?: string[];
36488
+ /** @description The flat list of remediation descriptions earlier consumers read (MeshKit's `SuggestedRemediation`). When `probableCauses` is present it equals every remediation's `description` across the causes, in order, each remediation `id` once (the first time it appears). */
36489
+ suggestedRemediation?: string[];
36490
+ /**
36491
+ * Format: uri
36492
+ * @description The stable docs.meshery.io page for this code, for example `https://docs.meshery.io/reference/error-codes/component-meshery-server/errcreatinguuidinstancecode-1001/`. Always present in a published ErrorReferenceIndex; a component's export may omit it, because the docs build assigns it.
36493
+ */
36494
+ referenceUrl?: string;
36495
+ }[];
36496
+ };
36497
+ };
36498
+ responses: never;
36499
+ parameters: never;
36500
+ requestBodies: never;
36501
+ headers: never;
36502
+ pathItems: never;
36503
+ }
36504
+
36320
36505
  interface components$2 {
36321
36506
  schemas: {
36322
- /** @description Payload for creating a new event. */
36507
+ /** @description Payload for creating a new event. If visibility is absent, the event is private. */
36323
36508
  EventPayload: {
36324
36509
  /**
36325
36510
  * Format: uuid
@@ -36328,12 +36513,55 @@ interface components$2 {
36328
36513
  owner?: string;
36329
36514
  /** @description The category of the event. */
36330
36515
  category?: string;
36516
+ /**
36517
+ * @description Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed.
36518
+ * @default private
36519
+ * @enum {string}
36520
+ */
36521
+ visibility: "private" | "public";
36331
36522
  /** @description The action of the event. */
36332
36523
  action?: string;
36333
36524
  /** @description Description of the event. */
36334
36525
  description?: string;
36526
+ /** @description Event level. MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire - the event write APIs persist the value they are given - so consumers must tolerate other values. */
36527
+ severity?: string;
36335
36528
  /** @description Optional client-chosen key that makes recording this event safe to retry. Keys are scoped to the authenticated caller (organization and user), never to the client-settable `owner` field, so `owner` may be omitted without affecting deduplication. The first event a caller records with a key is kept, and a later create with the same key records nothing and answers 200 with that event, whatever the rest of the payload says. Use a value that names the occurrence, for example a run id, so a client replaying a local queue after a timeout never records a duplicate. Omit it for events that need no deduplication. */
36336
36529
  idempotencyKey?: string;
36530
+ /** @description Optional key naming the ongoing condition this event reports, so repeated occurrences count on one open event instead of recording one each (see createEvent). Name the condition, not the occurrence, and qualify it by the emitting source and component plus the subject, for example `meshery-server/k8s-connection/<connectionId>/unreachable`. Never use an error code alone: codes are scoped to the component that owns them. Unlike `idempotencyKey`, which makes one create safe to retry, this key spans many creates. */
36531
+ correlationKey?: string;
36532
+ /** @description Number of occurrences this create reports, for a producer that counted repeats locally before sending. A create without a `correlationKey`, and a call that identifies no user, stores this value exactly as sent, including when it is omitted. For a call that identifies a user and carries a `correlationKey`, omitted means 1. An opening create stores that count, counting an open condition adds it, and an already-resolved insert stores it. A resolving create on that open event does not add it. */
36533
+ occurrenceCount?: number;
36534
+ /**
36535
+ * Format: date-time
36536
+ * @description When the producer first saw the occurrences this create reports. A call that identifies no user stores this value exactly as sent. For a call that identifies a user, omitted while opening a condition means `lastSeenAt`, or the time of receipt, and omitted on a resolving create that inserts an already resolved event means `resolvedAt`. Stored when that create opens a condition or inserts one already resolved; a close of an open condition keeps the stored time.
36537
+ */
36538
+ firstSeenAt?: string;
36539
+ /**
36540
+ * Format: date-time
36541
+ * @description When the producer last saw the occurrences this create reports. A call that identifies no user stores this value exactly as sent. For a call that identifies a user, omitted while opening a condition means `firstSeenAt`; omitted while counting an open condition, or while closing one, means the time of receipt; and omitted on a resolving create that inserts an already resolved event means `resolvedAt`.
36542
+ */
36543
+ lastSeenAt?: string;
36544
+ /**
36545
+ * Format: date-time
36546
+ * @description When the condition named by `correlationKey` cleared. A call that identifies no user stores this value exactly as sent and does not match an open event. For a call that identifies a user, a create that carries it is a resolution: it closes that caller's open event with that key, copying this payload's `severity` and `description` onto the event when this payload carries them (an omitted field keeps the stored value) and setting `lastSeenAt` to the later of the stored time and this payload's `lastSeenAt` (the time of receipt when omitted), so the closed condition reads as cleared and the next occurrence opens a new condition (see createEvent). Give the resolution a severity and description that say what cleared, for example severity `success` and `Connection to cluster prod-1 restored`, under the condition's category.
36547
+ */
36548
+ resolvedAt?: string;
36549
+ /**
36550
+ * Format: uri-reference
36551
+ * @description Which surface emitted the event, as a CloudEvents-compatible `source` (a URI reference): `meshery-server`, `meshery-ui`, `mesheryctl`, `meshery-adapter-<name>` (for example `meshery-adapter-istio`), `layer5-cloud`, or another client's name. `systemId` says which instance; `source` says which kind of client, so a failure a person caused in the UI is told apart from the same failure from the CLI. An open set: a new surface needs no schema change.
36552
+ */
36553
+ source?: string;
36554
+ /** @description CloudEvents-compatible `type`: a reverse-DNS name of the kind of occurrence, for example `io.meshery.user.signup`. It does not replace `category` and `action`, which stay two free strings; `type` is for CloudEvents-aware consumers. */
36555
+ type?: string;
36556
+ /**
36557
+ * @description The CloudEvents specification version the event's `source`, `type` and `id` are compatible with, when the producer sets them as CloudEvents attributes. A Meshery event is CloudEvents compatible; it is not a CloudEvent.
36558
+ * @enum {string}
36559
+ */
36560
+ specversion?: "1.0";
36561
+ /** @description W3C Trace Context `trace-id` (32 lowercase hex digits, not all zeros) of the user-level operation the event belongs to, so the event joins the OpenTelemetry trace that operation recorded. The client that starts the operation mints it, and every event of the operation and its sub-operations carries it; the server never mints one at persist time. */
36562
+ traceId?: string;
36563
+ /** @description W3C Trace Context `parent-id` (16 lowercase hex digits, not all zeros): the span of the sub-operation that emitted the event, so the events of one operation form its tree. Minted by the client with `traceId`, never by the server. */
36564
+ parentId?: string;
36337
36565
  } & {
36338
36566
  [key: string]: unknown;
36339
36567
  };
@@ -36384,6 +36612,12 @@ interface components$2 {
36384
36612
  };
36385
36613
  /** @description EventResult entity schema. */
36386
36614
  EventResult: {
36615
+ /**
36616
+ * @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
36617
+ * @default private
36618
+ * @enum {string}
36619
+ */
36620
+ visibility: "private" | "public";
36387
36621
  /**
36388
36622
  * Format: uuid
36389
36623
  * @description UUID of the user associated with the event.
@@ -36406,6 +36640,11 @@ interface components$2 {
36406
36640
  firstName?: string;
36407
36641
  /** @description The last name of the user associated with the event. */
36408
36642
  lastName?: string;
36643
+ /**
36644
+ * Format: uri
36645
+ * @description URL to the avatar image of the user associated with the event.
36646
+ */
36647
+ avatarUrl?: string;
36409
36648
  /**
36410
36649
  * Format: email
36411
36650
  * @description Email address of the user associated with the event.
@@ -36418,6 +36657,74 @@ interface components$2 {
36418
36657
  * @description Timestamp when the event was recorded.
36419
36658
  */
36420
36659
  createdAt?: string;
36660
+ /** @description Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition. */
36661
+ correlationKey?: string;
36662
+ /** @description How many occurrences of the condition the event counts (see Event.occurrenceCount). A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, it is the payload's `occurrenceCount` (1 when omitted) when the event was recorded, opening a condition or inserted already resolved, growing only as later creates that do not resolve are counted. A resolving create on the open event does not add to it. */
36663
+ occurrenceCount?: number;
36664
+ /**
36665
+ * Format: date-time
36666
+ * @description When the condition's first counted occurrence was seen (see Event.firstSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
36667
+ */
36668
+ firstSeenAt?: string;
36669
+ /**
36670
+ * Format: date-time
36671
+ * @description When the condition was last seen (see Event.lastSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
36672
+ */
36673
+ lastSeenAt?: string;
36674
+ /**
36675
+ * Format: date-time
36676
+ * @description When the condition cleared (see Event.resolvedAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user it is omitted while the condition is open.
36677
+ */
36678
+ resolvedAt?: string;
36679
+ /**
36680
+ * Format: uri-reference
36681
+ * @description Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).
36682
+ */
36683
+ source?: string;
36684
+ /** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type). */
36685
+ type?: string;
36686
+ /**
36687
+ * @description The CloudEvents specification version the event is compatible with (see Event.specversion).
36688
+ * @enum {string}
36689
+ */
36690
+ specversion?: "1.0";
36691
+ /** @description W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId). */
36692
+ traceId?: string;
36693
+ /** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId). */
36694
+ parentId?: string;
36695
+ /**
36696
+ * Format: uuid
36697
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36698
+ */
36699
+ id?: string;
36700
+ /**
36701
+ * Format: uuid
36702
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36703
+ */
36704
+ actedUpon?: string;
36705
+ /**
36706
+ * Format: uuid
36707
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36708
+ */
36709
+ operationId?: string;
36710
+ /** @description Event level (see Event.severity). MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire, so consumers must tolerate other values. */
36711
+ severity?: string;
36712
+ /** @description Read state of the event (see Event.status). MeshKit records new events as `unread`, and acknowledged ones become `read`; consumers must tolerate other values. */
36713
+ status?: string;
36714
+ /** @description Event-specific details, the same nullable free-form map as Event.metadata. `null` when the producer attached none. On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. */
36715
+ metadata?: {
36716
+ [key: string]: unknown;
36717
+ } | null;
36718
+ /**
36719
+ * Format: date-time
36720
+ * @description Timestamp when the event was last updated (see Event.updatedAt).
36721
+ */
36722
+ updatedAt?: string;
36723
+ /**
36724
+ * Format: date-time
36725
+ * @description Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).
36726
+ */
36727
+ deletedAt?: string | null;
36421
36728
  };
36422
36729
  /** @description One recorded event (an `event_trackers` row) in the wire form MeshKit's `models/events.Event` serializes. Meshery Cloud returns these, for example, as the per-path failure records of a GitHub repository import (`importGithubRepository`, `errors`). Unlike EventResult, it carries no joined user profile fields. */
36423
36730
  Event: {
@@ -36437,7 +36744,7 @@ interface components$2 {
36437
36744
  category: string;
36438
36745
  /** @description Human-readable summary of what happened. */
36439
36746
  description: string;
36440
- /** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
36747
+ /** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`; docs/error-definition-contract.md), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
36441
36748
  metadata: {
36442
36749
  [key: string]: unknown;
36443
36750
  } | null;
@@ -36475,11 +36782,52 @@ interface components$2 {
36475
36782
  * @description Timestamp when the event was last updated.
36476
36783
  */
36477
36784
  updatedAt: string;
36785
+ /**
36786
+ * @description Who can see the event. Defaults to `private`.
36787
+ * @default private
36788
+ * @enum {string}
36789
+ */
36790
+ visibility: "private" | "public";
36478
36791
  /**
36479
36792
  * Format: date-time
36480
36793
  * @description Timestamp when the event was soft-deleted; omitted when it was not.
36481
36794
  */
36482
36795
  deletedAt?: string | null;
36796
+ /** @description Key of the ongoing condition the event records (see EventPayload.correlationKey and createEvent); omitted for an event that reports no condition. */
36797
+ correlationKey?: string;
36798
+ /** @description How many occurrences of the condition this event counts. A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, an opening create or a resolving create inserted already resolved stores the payload's `occurrenceCount` (1 when omitted). Later creates that do not resolve add their count. A resolving create on the open event does not add to it. */
36799
+ occurrenceCount?: number;
36800
+ /**
36801
+ * Format: date-time
36802
+ * @description When the condition's first counted occurrence was seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
36803
+ */
36804
+ firstSeenAt?: string;
36805
+ /**
36806
+ * Format: date-time
36807
+ * @description When the condition was last seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
36808
+ */
36809
+ lastSeenAt?: string;
36810
+ /**
36811
+ * Format: date-time
36812
+ * @description When the condition cleared. A call that identifies no user stores the payload's value exactly as sent and does not close another event. For a call that identifies a user it is omitted while the condition is open, and set by a resolution (see createEvent), which also replaces `severity` and `description` with the payload's when the payload carries them (an omitted field keeps the stored value) and brings `lastSeenAt` forward, after which a new occurrence opens a new event.
36813
+ */
36814
+ resolvedAt?: string;
36815
+ /**
36816
+ * Format: uri-reference
36817
+ * @description Which surface emitted the event (CloudEvents-compatible `source`), for example `meshery-server`, `meshery-ui`, `mesheryctl` or `meshery-adapter-istio`; see EventPayload.source. Omitted when the producer did not say.
36818
+ */
36819
+ source?: string;
36820
+ /** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification. */
36821
+ type?: string;
36822
+ /**
36823
+ * @description The CloudEvents specification version the event is compatible with; see EventPayload.specversion.
36824
+ * @enum {string}
36825
+ */
36826
+ specversion?: "1.0";
36827
+ /** @description W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId. */
36828
+ traceId?: string;
36829
+ /** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId. */
36830
+ parentId?: string;
36483
36831
  };
36484
36832
  /** @description Paginated list of events. */
36485
36833
  EventsPage: {
@@ -36491,6 +36839,12 @@ interface components$2 {
36491
36839
  totalCount?: number;
36492
36840
  /** @description The events returned on the current page. */
36493
36841
  data?: {
36842
+ /**
36843
+ * @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
36844
+ * @default private
36845
+ * @enum {string}
36846
+ */
36847
+ visibility: "private" | "public";
36494
36848
  /**
36495
36849
  * Format: uuid
36496
36850
  * @description UUID of the user associated with the event.
@@ -36513,6 +36867,11 @@ interface components$2 {
36513
36867
  firstName?: string;
36514
36868
  /** @description The last name of the user associated with the event. */
36515
36869
  lastName?: string;
36870
+ /**
36871
+ * Format: uri
36872
+ * @description URL to the avatar image of the user associated with the event.
36873
+ */
36874
+ avatarUrl?: string;
36516
36875
  /**
36517
36876
  * Format: email
36518
36877
  * @description Email address of the user associated with the event.
@@ -36525,6 +36884,207 @@ interface components$2 {
36525
36884
  * @description Timestamp when the event was recorded.
36526
36885
  */
36527
36886
  createdAt?: string;
36887
+ /** @description Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition. */
36888
+ correlationKey?: string;
36889
+ /** @description How many occurrences of the condition the event counts (see Event.occurrenceCount). A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, it is the payload's `occurrenceCount` (1 when omitted) when the event was recorded, opening a condition or inserted already resolved, growing only as later creates that do not resolve are counted. A resolving create on the open event does not add to it. */
36890
+ occurrenceCount?: number;
36891
+ /**
36892
+ * Format: date-time
36893
+ * @description When the condition's first counted occurrence was seen (see Event.firstSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
36894
+ */
36895
+ firstSeenAt?: string;
36896
+ /**
36897
+ * Format: date-time
36898
+ * @description When the condition was last seen (see Event.lastSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
36899
+ */
36900
+ lastSeenAt?: string;
36901
+ /**
36902
+ * Format: date-time
36903
+ * @description When the condition cleared (see Event.resolvedAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user it is omitted while the condition is open.
36904
+ */
36905
+ resolvedAt?: string;
36906
+ /**
36907
+ * Format: uri-reference
36908
+ * @description Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).
36909
+ */
36910
+ source?: string;
36911
+ /** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type). */
36912
+ type?: string;
36913
+ /**
36914
+ * @description The CloudEvents specification version the event is compatible with (see Event.specversion).
36915
+ * @enum {string}
36916
+ */
36917
+ specversion?: "1.0";
36918
+ /** @description W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId). */
36919
+ traceId?: string;
36920
+ /** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId). */
36921
+ parentId?: string;
36922
+ /**
36923
+ * Format: uuid
36924
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36925
+ */
36926
+ id?: string;
36927
+ /**
36928
+ * Format: uuid
36929
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36930
+ */
36931
+ actedUpon?: string;
36932
+ /**
36933
+ * Format: uuid
36934
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36935
+ */
36936
+ operationId?: string;
36937
+ /** @description Event level (see Event.severity). MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire, so consumers must tolerate other values. */
36938
+ severity?: string;
36939
+ /** @description Read state of the event (see Event.status). MeshKit records new events as `unread`, and acknowledged ones become `read`; consumers must tolerate other values. */
36940
+ status?: string;
36941
+ /** @description Event-specific details, the same nullable free-form map as Event.metadata. `null` when the producer attached none. On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. */
36942
+ metadata?: {
36943
+ [key: string]: unknown;
36944
+ } | null;
36945
+ /**
36946
+ * Format: date-time
36947
+ * @description Timestamp when the event was last updated (see Event.updatedAt).
36948
+ */
36949
+ updatedAt?: string;
36950
+ /**
36951
+ * Format: date-time
36952
+ * @description Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).
36953
+ */
36954
+ deletedAt?: string | null;
36955
+ }[];
36956
+ };
36957
+ /**
36958
+ * @description A CloudEvents specification version a Meshery event is compatible with. Only `1.0` is defined.
36959
+ * @enum {string}
36960
+ */
36961
+ EventSpecVersion: "1.0";
36962
+ /**
36963
+ * @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time. Clients such as Blowhorn decide whether to mark their own events public.
36964
+ * @default private
36965
+ * @enum {string}
36966
+ */
36967
+ EventVisibility: "private" | "public";
36968
+ /**
36969
+ * @description An event projected into the public feed. It never includes email,
36970
+ * firstName, lastName, description, provider or raw metadata.
36971
+ * `platform`, `role`, `line` and `networks` are projected from
36972
+ * ScheduleCompletedEventMetadata; events without valid required
36973
+ * metadata are skipped. Public profile fields are resolved by Cloud at
36974
+ * read time and are included only when the user's profile is public.
36975
+ */
36976
+ EventFeedItem: {
36977
+ /**
36978
+ * Format: uuid
36979
+ * @description Event ID.
36980
+ */
36981
+ id: string;
36982
+ /**
36983
+ * Format: uuid
36984
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36985
+ */
36986
+ userId: string;
36987
+ /** @description Event category. */
36988
+ category: string;
36989
+ /** @description Event action. */
36990
+ action: string;
36991
+ /**
36992
+ * Format: date-time
36993
+ * @description Event creation time; the feed is ordered newest first.
36994
+ */
36995
+ createdAt: string;
36996
+ /**
36997
+ * @description Always `public` in the feed.
36998
+ * @default private
36999
+ * @enum {string}
37000
+ */
37001
+ visibility: "private" | "public";
37002
+ /**
37003
+ * @description Platform from ScheduleCompletedEventMetadata.
37004
+ * @enum {string}
37005
+ */
37006
+ platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
37007
+ /** @description Role from ScheduleCompletedEventMetadata. */
37008
+ role: string;
37009
+ /** @description One-line result from ScheduleCompletedEventMetadata. */
37010
+ line: string;
37011
+ /** @description Networks from ScheduleCompletedEventMetadata, when present. */
37012
+ networks?: string[];
37013
+ /** @description Public username, never a real name; present only for a public profile. */
37014
+ displayName?: string;
37015
+ /**
37016
+ * Format: uri
37017
+ * @description Public avatar URL; present only for a public profile.
37018
+ */
37019
+ avatarUrl?: string;
37020
+ /** @description Public organization name; present only for a public profile. */
37021
+ organizationName?: string;
37022
+ /**
37023
+ * Format: uri
37024
+ * @description HTTPS URL of the user's public profile.
37025
+ */
37026
+ publicProfileUrl?: string;
37027
+ };
37028
+ /** @description One page of event feed items, newest first. */
37029
+ EventFeedPage: {
37030
+ /** @description Current page number of the result set. */
37031
+ page: number;
37032
+ /** @description Number of items per page. */
37033
+ pageSize: number;
37034
+ /** @description Total number of matching feed events. */
37035
+ totalCount: number;
37036
+ /** @description Events for the requested page, newest first. */
37037
+ data: {
37038
+ /**
37039
+ * Format: uuid
37040
+ * @description Event ID.
37041
+ */
37042
+ id: string;
37043
+ /**
37044
+ * Format: uuid
37045
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
37046
+ */
37047
+ userId: string;
37048
+ /** @description Event category. */
37049
+ category: string;
37050
+ /** @description Event action. */
37051
+ action: string;
37052
+ /**
37053
+ * Format: date-time
37054
+ * @description Event creation time; the feed is ordered newest first.
37055
+ */
37056
+ createdAt: string;
37057
+ /**
37058
+ * @description Always `public` in the feed.
37059
+ * @default private
37060
+ * @enum {string}
37061
+ */
37062
+ visibility: "private" | "public";
37063
+ /**
37064
+ * @description Platform from ScheduleCompletedEventMetadata.
37065
+ * @enum {string}
37066
+ */
37067
+ platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
37068
+ /** @description Role from ScheduleCompletedEventMetadata. */
37069
+ role: string;
37070
+ /** @description One-line result from ScheduleCompletedEventMetadata. */
37071
+ line: string;
37072
+ /** @description Networks from ScheduleCompletedEventMetadata, when present. */
37073
+ networks?: string[];
37074
+ /** @description Public username, never a real name; present only for a public profile. */
37075
+ displayName?: string;
37076
+ /**
37077
+ * Format: uri
37078
+ * @description Public avatar URL; present only for a public profile.
37079
+ */
37080
+ avatarUrl?: string;
37081
+ /** @description Public organization name; present only for a public profile. */
37082
+ organizationName?: string;
37083
+ /**
37084
+ * Format: uri
37085
+ * @description HTTPS URL of the user's public profile.
37086
+ */
37087
+ publicProfileUrl?: string;
36528
37088
  }[];
36529
37089
  };
36530
37090
  /** @description Aggregated event counts across categories. */
@@ -36680,6 +37240,75 @@ interface components$2 {
36680
37240
  /** @description One short, human-readable line saying what went wrong; omitted when the producer has none. Never design contents. */
36681
37241
  message?: string;
36682
37242
  };
37243
+ /** @description The `metadata.error` of an event that reports an error: one occurrence of an ErrorDefinition (the error construct). It carries the code, the descriptions as rendered for this occurrence, the causes and remediations that apply, which of those causes are likely this time (`matchedCauses`), and the values the descriptions were rendered from (`details`). It holds only the error, never the design, the request or the response that failed. A producer that has only MeshKit's flat lists sends `probableCause` and `suggestedRemediation` alone; such an error is unpaired, and nothing may pair the lists by position. A producer with the nested form sends `probableCauses` and should also send the flat lists derived from it, for readers that predate the nesting. Like every metadata shape it is a sub-shape of Event.metadata, which stays a free-form map, so it has no `*Payload` twin (docs/error-definition-contract.md). */
37244
+ EventError: {
37245
+ /** @description The full error code, for example `meshery-server-1033`, as the definition names it. Consumers must tolerate codes they do not know. */
37246
+ code: string;
37247
+ /** @description The component that owns the code, when the producer names it; the code's prefix is the component's name. */
37248
+ component?: {
37249
+ /** @description The kind of component, for example `component` (Meshery Server), `adapter`, `library` (MeshKit) or `client` (mesheryctl). An open set: a new kind of component needs no schema change. */
37250
+ type: string;
37251
+ /** @description The component's name, for example `meshery-server`, `meshkit` or `mesheryctl`. It is the prefix of every code the component owns. */
37252
+ name: string;
37253
+ };
37254
+ /**
37255
+ * @description The definition's severity. The event's own `severity` is the level this occurrence was recorded at.
37256
+ * @enum {string}
37257
+ */
37258
+ severity?: "emergency" | "alert" | "critical" | "fatal" | "error" | "warning" | "informational" | "debug";
37259
+ /** @description The definition's short description, rendered for this occurrence. */
37260
+ shortDescription?: string;
37261
+ /** @description The definition's long description, rendered for this occurrence. */
37262
+ longDescription?: string;
37263
+ /** @description The definition's causes that apply to this occurrence, each with the remediations that answer it, in the definition's order. A producer may narrow the definition's causes to those that can apply; omitted when the producer has only flat lists. */
37264
+ probableCauses?: {
37265
+ /** @description Stable id of the cause, unique within the error's definition, for example `service-not-running`. An event names the causes that apply to one occurrence by this id (`EventError.matchedCauses`), and the docs page links to it, so it never changes once published. Lowercase words joined by hyphens. */
37266
+ id: string;
37267
+ /** @description What may have caused the error, for example `The service is not running.` */
37268
+ description: string;
37269
+ /** @description What answers this cause, the most likely fix first. A remediation that also answers another cause is repeated under that cause with the same `id` and identical fields. */
37270
+ remediations: {
37271
+ /** @description Stable id of the remediation, unique within the error's definition, for example `start-service`. The same id under two causes is one remediation answering both, so its fields must be identical in each place, and the flattened `suggestedRemediation` list carries it once. Lowercase words joined by hyphens. */
37272
+ id: string;
37273
+ /** @description What to do, written for a person, for example `Start the service.` */
37274
+ description: string;
37275
+ /** @description Identifier of an action a client can run to apply this remediation, as dot-separated lowercase words, for example `service.start` or `connection.reconnect`. The client that runs it owns its meaning; the definition only names it. Omitted when only a person can apply the remediation. */
37276
+ action?: string;
37277
+ /**
37278
+ * @description Whether a client may run `action` on its own. `automatic` and `requiresApproval` need an `action`. Omitted means `manual`.
37279
+ * @enum {string}
37280
+ */
37281
+ actionPolicy?: "automatic" | "requiresApproval" | "manual";
37282
+ }[];
37283
+ }[];
37284
+ /** @description The causes most likely for this occurrence, most likely first, so a reader leads with their remediations. Each names a cause `id` of the definition and, when `probableCauses` is present, one of its causes. Omitted when the producer cannot tell which cause applies. */
37285
+ matchedCauses?: {
37286
+ /** @description The `id` of the matched cause in the error's definition (ProbableCause.id). */
37287
+ causeId: string;
37288
+ /** @description How sure the producer is that this cause applies, from 0 (a guess) to 1 (certain); omitted when the producer does not estimate it. */
37289
+ confidence?: number;
37290
+ }[];
37291
+ /** @description The flat list of cause descriptions (MeshKit's `ProbableCause`). With `probableCauses`, it equals each cause's `description` in order; without, it is unpaired. */
37292
+ probableCause?: string[];
37293
+ /** @description The flat list of remediation descriptions (MeshKit's `SuggestedRemediation`). With `probableCauses`, it equals every remediation's `description` in order, each remediation `id` once; without, it is unpaired. */
37294
+ suggestedRemediation?: string[];
37295
+ /**
37296
+ * Format: uri
37297
+ * @description The code's page on docs.meshery.io (ErrorDefinition.referenceUrl), when the producer knows it.
37298
+ */
37299
+ referenceUrl?: string;
37300
+ /** @description The instance values this occurrence's descriptions were rendered from, for example the connection name or the path that failed. Keys are camelCase. Never secrets, credentials, design contents or request bodies; Meshery Server's 16 KB metadata guard applies. */
37301
+ details?: {
37302
+ [key: string]: unknown;
37303
+ };
37304
+ };
37305
+ /** @description One cause an error event names as likely for this occurrence (EventError.matchedCauses). */
37306
+ EventMatchedCause: {
37307
+ /** @description The `id` of the matched cause in the error's definition (ProbableCause.id). */
37308
+ causeId: string;
37309
+ /** @description How sure the producer is that this cause applies, from 0 (a guess) to 1 (certain); omitted when the producer does not estimate it. */
37310
+ confidence?: number;
37311
+ };
36683
37312
  /** @description Metadata of a design saved event (category `pattern`, action `create` or `update`): a history title and the saved design's ID and name, never its contents. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields. */
36684
37313
  DesignSavedEventMetadata: {
36685
37314
  /** @description One-line title of the save for the design's history, for example `Version v0.0.3 - 12 components and 9 relationships`. */
@@ -36705,6 +37334,20 @@ interface components$2 {
36705
37334
  /** @description Name of the saved design. */
36706
37335
  name?: string;
36707
37336
  };
37337
+ /** @description Metadata for a completed scheduled run (category `schedule`, action `completed`). This typed shape keeps client-specific display data out of the core Event fields and is projected into EventFeedItem. */
37338
+ ScheduleCompletedEventMetadata: {
37339
+ /**
37340
+ * @description Platform the completed run acted on.
37341
+ * @enum {string}
37342
+ */
37343
+ platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
37344
+ /** @description Role the completed run acted in. */
37345
+ role: string;
37346
+ /** @description One-line result of the run. */
37347
+ line: string;
37348
+ /** @description Networks or communities where the run acted. */
37349
+ networks?: string[];
37350
+ };
36708
37351
  };
36709
37352
  responses: {
36710
37353
  /** @description Invalid request body or request param */
@@ -36808,6 +37451,12 @@ interface components$2 {
36808
37451
  * @description Get responses by pagesize. Deprecated alias of pageSize.
36809
37452
  */
36810
37453
  pagesizeLegacy: number;
37454
+ /** @description Number of feed items per page. */
37455
+ feedPagesize: number;
37456
+ /** @description Optional event category filter. */
37457
+ feedCategory: string;
37458
+ /** @description Optional event action filter. */
37459
+ feedAction: string;
36811
37460
  /** @description Get responses that match search param value */
36812
37461
  search: string;
36813
37462
  /** @description Get ordered responses */
@@ -36822,7 +37471,10 @@ interface components$2 {
36822
37471
  eventsScope: "user" | "organization";
36823
37472
  };
36824
37473
  requestBodies: never;
36825
- headers: never;
37474
+ headers: {
37475
+ /** @description What `createEvent` did with the payload: `created` (a new event was recorded), `replayed` (the `idempotencyKey` was already used; nothing changed), `incremented` (an occurrence of the open condition with this `correlationKey` was counted) or `resolved` (that condition was closed). `incremented` and `resolved` apply only to a call that identifies a user; a call that identifies no user is `created`, with the correlation fields stored exactly as sent. A server MAY answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `created`, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read this header rather than the status code to tell created from replayed. A server that implements condition correlation sends it on every 200 and 201. A server that predates correlation omits it; there 201 means created and 200 means replayed. A browser client calling a server on another origin reads it only when that server lists it in `Access-Control-Expose-Headers`. */
37476
+ EventDisposition: "created" | "replayed" | "incremented" | "resolved";
37477
+ };
36826
37478
  pathItems: never;
36827
37479
  }
36828
37480
 
@@ -36921,6 +37573,8 @@ interface components$1 {
36921
37573
  };
36922
37574
  /** @description The anonymous usage stats of the preference. */
36923
37575
  anonymousUsageStats: boolean;
37576
+ /** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
37577
+ shareActivityPublicly?: boolean;
36924
37578
  /** @description The anonymous perf results of the preference. */
36925
37579
  anonymousPerfResults: boolean;
36926
37580
  /**
@@ -37378,6 +38032,8 @@ interface components$1 {
37378
38032
  };
37379
38033
  /** @description The anonymous usage stats of the preference. */
37380
38034
  anonymousUsageStats: boolean;
38035
+ /** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
38036
+ shareActivityPublicly?: boolean;
37381
38037
  /** @description The anonymous perf results of the preference. */
37382
38038
  anonymousPerfResults: boolean;
37383
38039
  /**
@@ -37453,6 +38109,8 @@ interface components$1 {
37453
38109
  };
37454
38110
  /** @description The anonymous usage stats of the preference. */
37455
38111
  anonymousUsageStats?: boolean;
38112
+ /** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
38113
+ shareActivityPublicly?: boolean;
37456
38114
  /** @description The anonymous perf results of the preference. */
37457
38115
  anonymousPerfResults?: boolean;
37458
38116
  /** @description The dashboard preferences of the preference. */
@@ -38535,6 +39193,62 @@ declare const MentionAliasPlatforms: {
38535
39193
  };
38536
39194
  type MentionAliasPlatform = (typeof MentionAliasPlatforms)[keyof typeof MentionAliasPlatforms];
38537
39195
 
39196
+ /**
39197
+ * Helpers for the v1beta3 error construct (docs/error-definition-contract.md):
39198
+ * derive the flat `probableCause` / `suggestedRemediation` lists from nested
39199
+ * causes, and check the rules JSON Schema cannot state. Pure functions with
39200
+ * no runtime dependencies, mirrored by the Go helpers in
39201
+ * models/v1beta3/errorcode and models/v1beta3/event.
39202
+ */
39203
+ type ErrorDefinition = components$3["schemas"]["ErrorDefinition"];
39204
+ type ErrorReferenceIndex = components$3["schemas"]["ErrorReferenceIndex"];
39205
+ type ProbableCause = components$3["schemas"]["ProbableCause"];
39206
+ type Remediation = components$3["schemas"]["Remediation"];
39207
+ type ActionPolicy = components$3["schemas"]["ActionPolicy"];
39208
+ type EventError = components$2["schemas"]["EventError"];
39209
+ /** The flat lists earlier consumers read, derived from nested causes. */
39210
+ interface FlattenedCauses {
39211
+ probableCause: string[];
39212
+ suggestedRemediation: string[];
39213
+ }
39214
+ /** One broken rule, with the JSON path of the value that breaks it. */
39215
+ interface ErrorContractViolation {
39216
+ path: string;
39217
+ message: string;
39218
+ }
39219
+ /**
39220
+ * Derives the flat lists from nested causes: each cause's description in
39221
+ * order, and each remediation's description walking causes then
39222
+ * remediations in order, with each remediation id kept the first time it
39223
+ * appears. An absent list yields two empty lists.
39224
+ */
39225
+ declare function flattenProbableCauses(causes: readonly ProbableCause[] | undefined): FlattenedCauses;
39226
+ /**
39227
+ * The policy a client acts on: the remediation's own, `manual` when it is
39228
+ * omitted, and `manual` for a value this version does not know, so a
39229
+ * remediation is never run by mistake.
39230
+ */
39231
+ declare function effectiveActionPolicy(remediation: Pick<Remediation, "actionPolicy">): ActionPolicy;
39232
+ /**
39233
+ * Checks the rules of an error definition that JSON Schema cannot state.
39234
+ * Returns every violation; an empty list means the definition follows the
39235
+ * contract. Validate the shape against the schema first.
39236
+ */
39237
+ declare function validateErrorDefinition(definition: ErrorDefinition, base?: string): ErrorContractViolation[];
39238
+ /**
39239
+ * Checks an index: every definition, and each code once per component. Pass
39240
+ * `requireReferenceUrl` for the published index, where every entry is linked.
39241
+ */
39242
+ declare function validateErrorReferenceIndex(index: ErrorReferenceIndex, options?: {
39243
+ requireReferenceUrl?: boolean;
39244
+ }): ErrorContractViolation[];
39245
+ /**
39246
+ * Checks an event's `metadata.error`: the nested causes, the flat lists
39247
+ * against them, and that each matched cause is one of the event's causes
39248
+ * when it carries them.
39249
+ */
39250
+ declare function validateEventError(error: EventError): ErrorContractViolation[];
39251
+
38538
39252
  /**
38539
39253
  * Minimal structural types for the form-schema artifacts. Defined
38540
39254
  * locally rather than imported from `@rjsf/utils` because:
@@ -38636,54 +39350,66 @@ declare const SupportRequestRjsfSchemaV1Beta1: RJSFSchema;
38636
39350
  declare const SupportRequestRjsfUiSchemaV1Beta1: UiSchema;
38637
39351
 
38638
39352
  declare namespace v1alpha1 {
38639
- type CatalogData = components$B["schemas"]["CatalogData"];
38640
- type Capability = components$C["schemas"];
39353
+ type CatalogData = components$C["schemas"]["CatalogData"];
39354
+ type Capability = components$D["schemas"];
38641
39355
  }
38642
39356
  declare namespace v1alpha2 {
38643
- type CatalogData = components$B["schemas"]["CatalogData"];
39357
+ type CatalogData = components$C["schemas"]["CatalogData"];
38644
39358
  }
38645
39359
  declare namespace v1beta1 {
38646
- type Badge = components$f["schemas"]["Badge"];
38647
- type Capability = components$A["schemas"]["Capability"];
38648
- type Category = components$t["schemas"]["CategoryDefinition"];
38649
- type Component = components$z["schemas"]["ComponentDefinition"];
38650
- type Connection = components$y["schemas"]["Connection"];
38651
- type ConnectionStatusValue = components$y["schemas"]["ConnectionStatusValue"];
38652
- type ControllerStatusValue = components$j["schemas"]["ControllerStatusValue"];
38653
- type Credential = components$x["schemas"]["Credential"];
38654
- type Design = components$u["schemas"]["PatternFile"];
38655
- type Environment = components$r["schemas"]["Environment"];
38656
- type EvaluationRequest = components$q["schemas"]["EvaluationRequest"];
38657
- type EvaluationResponse = components$q["schemas"]["EvaluationResponse"];
38658
- type Feature = components$p["schemas"]["Feature"];
38659
- type Invitation = components$g["schemas"]["Invitation"];
38660
- type Key = components$o["schemas"]["Key"];
38661
- type Keychain = components$n["schemas"]["Keychain"];
38662
- type Model = components$w["schemas"]["ModelDefinition"];
38663
- type Organization = components$m["schemas"]["Organization"];
38664
- type Role = components$l["schemas"]["Role"];
38665
- type Schedule = components$k["schemas"]["Schedule"];
38666
- type Subcategory = components$s["schemas"]["SubCategoryDefinition"];
38667
- type Team = components$i["schemas"]["Team"];
38668
- type User = components$v["schemas"]["User"];
38669
- type Workspace = components$h["schemas"]["Workspace"];
39360
+ type Badge = components$g["schemas"]["Badge"];
39361
+ type Capability = components$B["schemas"]["Capability"];
39362
+ type Category = components$u["schemas"]["CategoryDefinition"];
39363
+ type Component = components$A["schemas"]["ComponentDefinition"];
39364
+ type Connection = components$z["schemas"]["Connection"];
39365
+ type ConnectionStatusValue = components$z["schemas"]["ConnectionStatusValue"];
39366
+ type ControllerStatusValue = components$k["schemas"]["ControllerStatusValue"];
39367
+ type Credential = components$y["schemas"]["Credential"];
39368
+ type Design = components$v["schemas"]["PatternFile"];
39369
+ type Environment = components$s["schemas"]["Environment"];
39370
+ type EvaluationRequest = components$r["schemas"]["EvaluationRequest"];
39371
+ type EvaluationResponse = components$r["schemas"]["EvaluationResponse"];
39372
+ type Feature = components$q["schemas"]["Feature"];
39373
+ type Invitation = components$h["schemas"]["Invitation"];
39374
+ type Key = components$p["schemas"]["Key"];
39375
+ type Keychain = components$o["schemas"]["Keychain"];
39376
+ type Model = components$x["schemas"]["ModelDefinition"];
39377
+ type Organization = components$n["schemas"]["Organization"];
39378
+ type Role = components$m["schemas"]["Role"];
39379
+ type Schedule = components$l["schemas"]["Schedule"];
39380
+ type Subcategory = components$t["schemas"]["SubCategoryDefinition"];
39381
+ type Team = components$j["schemas"]["Team"];
39382
+ type User = components$w["schemas"]["User"];
39383
+ type Workspace = components$i["schemas"]["Workspace"];
38670
39384
  }
38671
39385
 
38672
39386
  declare namespace v1beta2 {
38673
- type Academy = components$e["schemas"]["AcademyCurricula"];
38674
- type CatalogData = components$d["schemas"]["CatalogData"];
38675
- type Component = components$c["schemas"]["ComponentDefinition"];
38676
- type Connection = components$b["schemas"]["Connection"];
38677
- type Design = components$a["schemas"]["PatternFile"];
38678
- type EventResult = components$9["schemas"]["EventResult"];
38679
- type Invitation = components$8["schemas"]["Invitation"];
38680
- type Organization = components$7["schemas"]["Organization"];
38681
- type Plan = components$6["schemas"]["Plan"];
38682
- type Relationship = components$5["schemas"]["RelationshipDefinition"];
38683
- type Subscription = components$4["schemas"]["Subscription"];
38684
- type Token = components$3["schemas"]["UserToken"];
39387
+ type Academy = components$f["schemas"]["AcademyCurricula"];
39388
+ type CatalogData = components$e["schemas"]["CatalogData"];
39389
+ type Component = components$d["schemas"]["ComponentDefinition"];
39390
+ type Connection = components$c["schemas"]["Connection"];
39391
+ type Design = components$b["schemas"]["PatternFile"];
39392
+ type EventResult = components$a["schemas"]["EventResult"];
39393
+ type Invitation = components$9["schemas"]["Invitation"];
39394
+ type Organization = components$8["schemas"]["Organization"];
39395
+ type Plan = components$7["schemas"]["Plan"];
39396
+ type Relationship = components$6["schemas"]["RelationshipDefinition"];
39397
+ type Subscription = components$5["schemas"]["Subscription"];
39398
+ type Token = components$4["schemas"]["UserToken"];
38685
39399
  }
38686
39400
  declare namespace v1beta3 {
39401
+ type ErrorDefinition = components$3["schemas"]["ErrorDefinition"];
39402
+ type ErrorComponent = components$3["schemas"]["ErrorComponent"];
39403
+ type ErrorSeverity = components$3["schemas"]["ErrorSeverity"];
39404
+ type ProbableCause = components$3["schemas"]["ProbableCause"];
39405
+ type Remediation = components$3["schemas"]["Remediation"];
39406
+ type ActionPolicy = components$3["schemas"]["ActionPolicy"];
39407
+ type ErrorReferenceIndex = components$3["schemas"]["ErrorReferenceIndex"];
39408
+ type EventError = components$2["schemas"]["EventError"];
39409
+ type EventMatchedCause = components$2["schemas"]["EventMatchedCause"];
39410
+ type Event = components$2["schemas"]["Event"];
39411
+ type EventPayload = components$2["schemas"]["EventPayload"];
39412
+ type EventSpecVersion = components$2["schemas"]["EventSpecVersion"];
38687
39413
  type DesignEventIdentity = components$2["schemas"]["DesignEventIdentity"];
38688
39414
  type RelationshipEvaluationEventMetadata = components$2["schemas"]["RelationshipEvaluationEventMetadata"];
38689
39415
  type DesignValidationEventMetadata = components$2["schemas"]["DesignValidationEventMetadata"];
@@ -38698,4 +39424,4 @@ declare namespace v1beta3 {
38698
39424
  type SearchableUsersPage = components$1["schemas"]["SearchableUsersPage"];
38699
39425
  }
38700
39426
 
38701
- export { BadgeSchema, CatalogPublishRjsfSchemaV1Beta2, CatalogPublishRjsfUiSchemaV1Beta2, CategorySchema as CategoryDefinitionV1Beta1OpenApiSchema, ComponentSchema$1 as ComponentDefinitionV1Beta1OpenApiSchema, ComponentSchema as ComponentDefinitionV1Beta2OpenApiSchema, ConnectionSchema as ConnectionDefinitionV1Beta2OpenApiSchema, ConnectionHelmCreateRjsfSchemaV1Beta3, ConnectionHelmCreateRjsfUiSchemaV1Beta3, type CoreConnectionKind, CoreConnectionKinds, PatternSchema as DesignDefinitionV1Beta1OpenApiSchema, DesignSchema as DesignDefinitionV1Beta2OpenApiSchema, DesignImportRjsfSchemaV1Beta3, DesignImportRjsfUiSchemaV1Beta3, type DestinationConnectionKind, DestinationConnectionKinds, EnvironmentCreateOrEditRjsfSchemaV1Beta3, EnvironmentCreateOrEditRjsfUiSchemaV1Beta3, EnvironmentSchema as EnvironmentDefinitionV1Beta1OpenApiSchema, FilterImportRjsfSchemaV1Beta3, FilterImportRjsfUiSchemaV1Beta3, GrafanaCredentialRjsfSchemaV1Beta1, GrafanaCredentialRjsfUiSchemaV1Beta1, InvitationSchema as InvitationDefinitionV1Beta2OpenApiSchema, InvitationSchema$1 as InvitationSchema, KubernetesCredentialRjsfSchemaV1Beta1, KubernetesCredentialRjsfUiSchemaV1Beta1, type MentionAliasPlatform, MentionAliasPlatforms, ModelSchema as ModelDefinitionV1Beta1OpenApiSchema, ModelImportRjsfSchemaV1Beta2, ModelImportRjsfUiSchemaV1Beta2, PrometheusCredentialRjsfSchemaV1Beta1, PrometheusCredentialRjsfUiSchemaV1Beta1, type RJSFSchema, RelationshipSchema as RelationshipDefinitionV1Alpha3OpenApiSchema, RelationshipSchema$1 as RelationshipDefinitionV1Beta2OpenApiSchema, SubcategorySchema as SubCategoryDefinitionV1Beta1OpenApiSchema, SupportRequestRjsfSchemaV1Beta1, SupportRequestRjsfUiSchemaV1Beta1, type UiSchema, WorkspaceCreateOrEditRjsfSchemaV1Beta3, WorkspaceCreateOrEditRjsfUiSchemaV1Beta3, WorkspaceSchema as WorkspaceDefinitionV1Beta1OpenApiSchema, Core as core, v1alpha1, v1alpha2, v1beta1, v1beta2, v1beta3 };
39427
+ export { BadgeSchema, CatalogPublishRjsfSchemaV1Beta2, CatalogPublishRjsfUiSchemaV1Beta2, CategorySchema as CategoryDefinitionV1Beta1OpenApiSchema, ComponentSchema$1 as ComponentDefinitionV1Beta1OpenApiSchema, ComponentSchema as ComponentDefinitionV1Beta2OpenApiSchema, ConnectionSchema as ConnectionDefinitionV1Beta2OpenApiSchema, ConnectionHelmCreateRjsfSchemaV1Beta3, ConnectionHelmCreateRjsfUiSchemaV1Beta3, type CoreConnectionKind, CoreConnectionKinds, PatternSchema as DesignDefinitionV1Beta1OpenApiSchema, DesignSchema as DesignDefinitionV1Beta2OpenApiSchema, DesignImportRjsfSchemaV1Beta3, DesignImportRjsfUiSchemaV1Beta3, type DestinationConnectionKind, DestinationConnectionKinds, EnvironmentCreateOrEditRjsfSchemaV1Beta3, EnvironmentCreateOrEditRjsfUiSchemaV1Beta3, EnvironmentSchema as EnvironmentDefinitionV1Beta1OpenApiSchema, type ErrorContractViolation, FilterImportRjsfSchemaV1Beta3, FilterImportRjsfUiSchemaV1Beta3, type FlattenedCauses, GrafanaCredentialRjsfSchemaV1Beta1, GrafanaCredentialRjsfUiSchemaV1Beta1, InvitationSchema as InvitationDefinitionV1Beta2OpenApiSchema, InvitationSchema$1 as InvitationSchema, KubernetesCredentialRjsfSchemaV1Beta1, KubernetesCredentialRjsfUiSchemaV1Beta1, type MentionAliasPlatform, MentionAliasPlatforms, ModelSchema as ModelDefinitionV1Beta1OpenApiSchema, ModelImportRjsfSchemaV1Beta2, ModelImportRjsfUiSchemaV1Beta2, PrometheusCredentialRjsfSchemaV1Beta1, PrometheusCredentialRjsfUiSchemaV1Beta1, type RJSFSchema, RelationshipSchema as RelationshipDefinitionV1Alpha3OpenApiSchema, RelationshipSchema$1 as RelationshipDefinitionV1Beta2OpenApiSchema, SubcategorySchema as SubCategoryDefinitionV1Beta1OpenApiSchema, SupportRequestRjsfSchemaV1Beta1, SupportRequestRjsfUiSchemaV1Beta1, type UiSchema, WorkspaceCreateOrEditRjsfSchemaV1Beta3, WorkspaceCreateOrEditRjsfUiSchemaV1Beta3, WorkspaceSchema as WorkspaceDefinitionV1Beta1OpenApiSchema, Core as core, effectiveActionPolicy, flattenProbableCauses, v1alpha1, v1alpha2, v1beta1, v1beta2, v1beta3, validateErrorDefinition, validateErrorReferenceIndex, validateEventError };