@openvtc/trust-tasks 0.28.10 → 0.28.11

package/src/vtn/broadcasts/send/0.1/payload.ts

@@ -0,0 +1,478 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/broadcasts/send/0.1/payload.schema.json
+ */
+
+import type { BroadcastRecord, Credential, DeliveryStatus, Did_VtnV0_1 as Did, Ext, Receipt, RoleName_VtnV0_1 as RoleName } from "../../../../_shared/components.js";
+
+
+/**
+ * An administrator's message for every group registered for a role. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNBroadcastsSendPayload {
+  /**
+   * The role to address: delivered to every current member's group registered for it.
+   */
+  role: RoleName;
+  /**
+   * What kind of message it is, for the receiving group to sort on: `notice` (the default), `request-for-action`, `room-invite`, or another the network's framework names.
+   */
+  class?: string;
+  /**
+   * A one-line subject.
+   */
+  subject: string;
+  /**
+   * The message text.
+   */
+  body: string;
+  /**
+   * Where replies go, such as a URL or DID for a network data room, so that a broadcast never becomes reply-all.
+   */
+  replyTo?: string;
+  ext?: Ext;
+}
+/**
+ * The broadcast as recorded, with each group's receipt as it stands when the network answers. Queued deliveries are retried from the outbox and update the record later.
+ */
+export interface VTNBroadcastsSendResponsePayload {
+  broadcast: BroadcastRecord;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { BroadcastRecord, Credential, DeliveryStatus, Did, Ext, Receipt, RoleName };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtn/broadcasts/send/0.1" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTNBroadcastsSendPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtn/broadcasts/send/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNBroadcastsSendResponsePayload;
+
+/**
+ * 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/vtn/broadcasts/send/0.1",
+  "title": "VTN Broadcasts — Send — payload",
+  "description": "An administrator's message for every group registered for a role. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "role",
+    "subject",
+    "body"
+  ],
+  "properties": {
+    "role": {
+      "$ref": "#/$defs/RoleName",
+      "description": "The role to address: delivered to every current member's group registered for it."
+    },
+    "class": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]{0,62}$",
+      "description": "What kind of message it is, for the receiving group to sort on: `notice` (the default), `request-for-action`, `room-invite`, or another the network's framework names."
+    },
+    "subject": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "description": "A one-line subject."
+    },
+    "body": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 20000,
+      "description": "The message text."
+    },
+    "replyTo": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048,
+      "description": "Where replies go, such as a URL or DID for a network data room, so that a broadcast never becomes reply-all."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTN Broadcasts — Send — response payload",
+      "description": "The broadcast as recorded, with each group's receipt as it stands when the network answers. Queued deliveries are retried from the outbox and update the record later.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "broadcast"
+      ],
+      "properties": {
+        "broadcast": {
+          "$ref": "#/$defs/BroadcastRecord"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "BroadcastRecord": {
+      "description": "A broadcast as this network sent or relayed it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "direction",
+        "role",
+        "message",
+        "recordedAt",
+        "receipts",
+        "reached"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The message id."
+        },
+        "direction": {
+          "type": "string",
+          "enum": [
+            "sent",
+            "received"
+          ],
+          "description": "Whether this network sent it or received it to relay."
+        },
+        "role": {
+          "$ref": "#/$defs/RoleName",
+          "description": "The role it was addressed to."
+        },
+        "message": {
+          "$ref": "#/$defs/Credential",
+          "description": "The signed message."
+        },
+        "from": {
+          "$ref": "#/$defs/Did",
+          "description": "For a received message, the network that delivered it."
+        },
+        "actor": {
+          "$ref": "#/$defs/Did",
+          "description": "For a sent message, the administrator that sent it."
+        },
+        "recordedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When."
+        },
+        "receipts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Receipt"
+          },
+          "description": "Per group."
+        },
+        "reached": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Groups delivered to, counting relays."
+        }
+      }
+    },
+    "Receipt": {
+      "description": "The outcome of one delivery.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "group",
+        "member",
+        "status"
+      ],
+      "properties": {
+        "group": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The group delivered to."
+        },
+        "member": {
+          "$ref": "#/$defs/Did",
+          "description": "The member that owns it."
+        },
+        "status": {
+          "$ref": "#/$defs/DeliveryStatus"
+        },
+        "detail": {
+          "type": "string",
+          "maxLength": 1000,
+          "description": "Why, for anything but `delivered`."
+        },
+        "network": {
+          "type": "boolean",
+          "description": "Whether the group is a network group, which relays further."
+        },
+        "relayed": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Receipt"
+          },
+          "description": "The receipts the network group's own relay returned."
+        }
+      }
+    },
+    "DeliveryStatus": {
+      "type": "string",
+      "enum": [
+        "delivered",
+        "duplicate",
+        "refused",
+        "queued",
+        "failed"
+      ],
+      "description": "What happened to one delivery. `queued` will be retried."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    },
+    "Credential": {
+      "type": "object",
+      "description": "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers."
+    },
+    "RoleName": {
+      "type": "string",
+      "pattern": "^[a-z0-9_-]{1,64}$",
+      "description": "A role's name: 1–64 lowercase letters, digits, `-` or `_`."
+    }
+  }
+} 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": "VTN Broadcasts — Send — response payload",
+      "description": "The broadcast as recorded, with each group's receipt as it stands when the network answers. Queued deliveries are retried from the outbox and update the record later.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "broadcast"
+      ],
+      "properties": {
+        "broadcast": {
+          "$ref": "#/$defs/BroadcastRecord"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "BroadcastRecord": {
+      "description": "A broadcast as this network sent or relayed it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "direction",
+        "role",
+        "message",
+        "recordedAt",
+        "receipts",
+        "reached"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The message id."
+        },
+        "direction": {
+          "type": "string",
+          "enum": [
+            "sent",
+            "received"
+          ],
+          "description": "Whether this network sent it or received it to relay."
+        },
+        "role": {
+          "$ref": "#/$defs/RoleName",
+          "description": "The role it was addressed to."
+        },
+        "message": {
+          "$ref": "#/$defs/Credential",
+          "description": "The signed message."
+        },
+        "from": {
+          "$ref": "#/$defs/Did",
+          "description": "For a received message, the network that delivered it."
+        },
+        "actor": {
+          "$ref": "#/$defs/Did",
+          "description": "For a sent message, the administrator that sent it."
+        },
+        "recordedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When."
+        },
+        "receipts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Receipt"
+          },
+          "description": "Per group."
+        },
+        "reached": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Groups delivered to, counting relays."
+        }
+      }
+    },
+    "Receipt": {
+      "description": "The outcome of one delivery.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "group",
+        "member",
+        "status"
+      ],
+      "properties": {
+        "group": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The group delivered to."
+        },
+        "member": {
+          "$ref": "#/$defs/Did",
+          "description": "The member that owns it."
+        },
+        "status": {
+          "$ref": "#/$defs/DeliveryStatus"
+        },
+        "detail": {
+          "type": "string",
+          "maxLength": 1000,
+          "description": "Why, for anything but `delivered`."
+        },
+        "network": {
+          "type": "boolean",
+          "description": "Whether the group is a network group, which relays further."
+        },
+        "relayed": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Receipt"
+          },
+          "description": "The receipts the network group's own relay returned."
+        }
+      }
+    },
+    "DeliveryStatus": {
+      "type": "string",
+      "enum": [
+        "delivered",
+        "duplicate",
+        "refused",
+        "queued",
+        "failed"
+      ],
+      "description": "What happened to one delivery. `queued` will be retried."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    },
+    "Credential": {
+      "type": "object",
+      "description": "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers."
+    },
+    "RoleName": {
+      "type": "string",
+      "pattern": "^[a-z0-9_-]{1,64}$",
+      "description": "A role's name: 1–64 lowercase letters, digits, `-` or `_`."
+    }
+  }
+} 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;