@openvtc/trust-tasks 0.19.14 → 0.19.16

package/src/messaging/stats/show/0.1/payload.ts

@@ -0,0 +1,611 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/stats/show/0.1/payload.schema.json
+ */
+
+import type { Ext, QueueDepth } from "../../../../_shared/components.js";
+
+
+export interface MessagingShowMediatorStatisticsPayload {
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The success response to a messaging/stats/show request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/stats/show/0.1#response.
+ */
+export interface MessagingShowMediatorStatisticsResponsePayload {
+  /**
+   * The mediator software's version string.
+   */
+  version: string;
+  startedAt?: string;
+  uptimeSeconds: number;
+  connections: {
+    websocketActive: number;
+    /**
+     * Configured ceiling; absent when unlimited.
+     */
+    websocketMax?: number;
+  };
+  /**
+   * Lifetime counters since the mediator's store was created. Monotonic; a client derives rates from successive readings.
+   */
+  totals: {
+    receivedCount: number;
+    receivedBytes: number;
+    sentCount: number;
+    sentBytes: number;
+    deletedCount: number;
+    deletedBytes?: number;
+    websocketOpened?: number;
+    websocketClosed?: number;
+    sessionsCreated?: number;
+    sessionsAuthenticated?: number;
+    invitationsCreated?: number;
+    invitationsClaimed?: number;
+  };
+  forwarding: {
+    /**
+     * Messages waiting to be forwarded to other mediators.
+     */
+    queueLength: number;
+    queueLimit?: number;
+    /**
+     * State of the store circuit breaker. `open` means the mediator is shedding store operations.
+     */
+    circuitBreaker?: "closed" | "open" | "halfOpen";
+  };
+  /**
+   * Aggregate of the mediator's most recent queue survey. Absent when no survey has completed.
+   */
+  queues?: {
+    surveyedAt: string;
+    /**
+     * Accounts the survey covered.
+     */
+    accounts: number;
+    /**
+     * The survey stopped before covering every account.
+     */
+    truncated?: boolean;
+    /**
+     * Totals across every surveyed receive queue; `saturation` is the maximum of any single queue.
+     */
+    receive?: QueueDepth;
+    /**
+     * Totals across every surveyed send queue; `saturation` is the maximum of any single queue.
+     */
+    send?: QueueDepth;
+  };
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, QueueDepth };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/stats/show/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingShowMediatorStatisticsPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/stats/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = MessagingShowMediatorStatisticsResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/messaging/stats/show/0.1",
+  "title": "Messaging — Show Mediator Statistics — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — Show Mediator Statistics — response payload",
+      "description": "The success response to a messaging/stats/show request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/stats/show/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "version": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The mediator software's version string."
+        },
+        "startedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "uptimeSeconds": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "connections": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "websocketActive"
+          ],
+          "properties": {
+            "websocketActive": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "websocketMax": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Configured ceiling; absent when unlimited."
+            }
+          }
+        },
+        "totals": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Lifetime counters since the mediator's store was created. Monotonic; a client derives rates from successive readings.",
+          "required": [
+            "receivedCount",
+            "receivedBytes",
+            "sentCount",
+            "sentBytes",
+            "deletedCount"
+          ],
+          "properties": {
+            "receivedCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "receivedBytes": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "sentCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "sentBytes": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "deletedCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "deletedBytes": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "websocketOpened": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "websocketClosed": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "sessionsCreated": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "sessionsAuthenticated": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "invitationsCreated": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "invitationsClaimed": {
+              "type": "integer",
+              "minimum": 0
+            }
+          }
+        },
+        "forwarding": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "queueLength"
+          ],
+          "properties": {
+            "queueLength": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Messages waiting to be forwarded to other mediators."
+            },
+            "queueLimit": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "circuitBreaker": {
+              "type": "string",
+              "enum": [
+                "closed",
+                "open",
+                "halfOpen"
+              ],
+              "description": "State of the store circuit breaker. `open` means the mediator is shedding store operations."
+            }
+          }
+        },
+        "queues": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Aggregate of the mediator's most recent queue survey. Absent when no survey has completed.",
+          "required": [
+            "surveyedAt",
+            "accounts"
+          ],
+          "properties": {
+            "surveyedAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "accounts": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Accounts the survey covered."
+            },
+            "truncated": {
+              "type": "boolean",
+              "description": "The survey stopped before covering every account."
+            },
+            "receive": {
+              "$ref": "#/$defs/QueueDepth",
+              "description": "Totals across every surveyed receive queue; `saturation` is the maximum of any single queue."
+            },
+            "send": {
+              "$ref": "#/$defs/QueueDepth",
+              "description": "Totals across every surveyed send queue; `saturation` is the maximum of any single queue."
+            }
+          }
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "version",
+        "uptimeSeconds",
+        "connections",
+        "totals",
+        "forwarding"
+      ]
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "QueueDepth": {
+      "title": "QueueDepth",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "count",
+        "bytes"
+      ],
+      "description": "The depth of one queue and its effective limit.",
+      "properties": {
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages currently in the queue."
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total stored size of those messages, in bytes."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": -1,
+          "description": "The effective message-count limit for this queue after account overrides and mediator defaults are applied; -1 = unlimited."
+        },
+        "saturation": {
+          "type": "number",
+          "minimum": 0,
+          "description": "count ÷ limit. Absent when the limit is unlimited. May exceed 1 when a limit was lowered below the current depth."
+        },
+        "oldestAgeSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Age of the oldest message in the queue, in seconds. Absent when the queue is empty or the mediator did not measure it."
+        },
+        "deliveredUnacked": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages in the queue whose state is `delivered` — handed out but not yet deleted by the recipient. Absent when the mediator did not measure it."
+        }
+      }
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — Show Mediator Statistics — response payload",
+      "description": "The success response to a messaging/stats/show request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/stats/show/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "version": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The mediator software's version string."
+        },
+        "startedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "uptimeSeconds": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "connections": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "websocketActive"
+          ],
+          "properties": {
+            "websocketActive": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "websocketMax": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Configured ceiling; absent when unlimited."
+            }
+          }
+        },
+        "totals": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Lifetime counters since the mediator's store was created. Monotonic; a client derives rates from successive readings.",
+          "required": [
+            "receivedCount",
+            "receivedBytes",
+            "sentCount",
+            "sentBytes",
+            "deletedCount"
+          ],
+          "properties": {
+            "receivedCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "receivedBytes": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "sentCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "sentBytes": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "deletedCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "deletedBytes": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "websocketOpened": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "websocketClosed": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "sessionsCreated": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "sessionsAuthenticated": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "invitationsCreated": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "invitationsClaimed": {
+              "type": "integer",
+              "minimum": 0
+            }
+          }
+        },
+        "forwarding": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "queueLength"
+          ],
+          "properties": {
+            "queueLength": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Messages waiting to be forwarded to other mediators."
+            },
+            "queueLimit": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "circuitBreaker": {
+              "type": "string",
+              "enum": [
+                "closed",
+                "open",
+                "halfOpen"
+              ],
+              "description": "State of the store circuit breaker. `open` means the mediator is shedding store operations."
+            }
+          }
+        },
+        "queues": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Aggregate of the mediator's most recent queue survey. Absent when no survey has completed.",
+          "required": [
+            "surveyedAt",
+            "accounts"
+          ],
+          "properties": {
+            "surveyedAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "accounts": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Accounts the survey covered."
+            },
+            "truncated": {
+              "type": "boolean",
+              "description": "The survey stopped before covering every account."
+            },
+            "receive": {
+              "$ref": "#/$defs/QueueDepth",
+              "description": "Totals across every surveyed receive queue; `saturation` is the maximum of any single queue."
+            },
+            "send": {
+              "$ref": "#/$defs/QueueDepth",
+              "description": "Totals across every surveyed send queue; `saturation` is the maximum of any single queue."
+            }
+          }
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "version",
+        "uptimeSeconds",
+        "connections",
+        "totals",
+        "forwarding"
+      ]
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "QueueDepth": {
+      "title": "QueueDepth",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "count",
+        "bytes"
+      ],
+      "description": "The depth of one queue and its effective limit.",
+      "properties": {
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages currently in the queue."
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total stored size of those messages, in bytes."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": -1,
+          "description": "The effective message-count limit for this queue after account overrides and mediator defaults are applied; -1 = unlimited."
+        },
+        "saturation": {
+          "type": "number",
+          "minimum": 0,
+          "description": "count ÷ limit. Absent when the limit is unlimited. May exceed 1 when a limit was lowered below the current depth."
+        },
+        "oldestAgeSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Age of the oldest message in the queue, in seconds. Absent when the queue is empty or the mediator did not measure it."
+        },
+        "deliveredUnacked": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages in the queue whose state is `delivered` — handed out but not yet deleted by the recipient. Absent when the mediator did not measure it."
+        }
+      }
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vtc/join-requests/list/0.1/payload.ts

@@ -218,6 +218,31 @@ export const PAYLOAD_SCHEMA = {
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
+        },
+        "attributes": {
+          "type": "array",
+          "maxItems": 32,
+          "description": "What the applicant told the community about themselves in answer to the manifest's `requestedAttributes` — self-asserted, and to be shown as such to whoever reviews the request. Absent when none were asked for or given.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "value"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+                "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+              },
+              "value": {
+                "description": "The value the applicant gives. Self-asserted: the applicant's own statement, bound to them by the document proof, and attested by nobody."
+              }
+            }
+          }
         }
       }
     }
@@ -362,6 +387,31 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
+        },
+        "attributes": {
+          "type": "array",
+          "maxItems": 32,
+          "description": "What the applicant told the community about themselves in answer to the manifest's `requestedAttributes` — self-asserted, and to be shown as such to whoever reviews the request. Absent when none were asked for or given.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "value"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+                "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+              },
+              "value": {
+                "description": "The value the applicant gives. Self-asserted: the applicant's own statement, bound to them by the document proof, and attested by nobody."
+              }
+            }
+          }
         }
       }
     }