@openvtc/trust-tasks 0.19.14 → 0.19.16

package/src/messaging/queue/purge/0.1/payload.ts

@@ -0,0 +1,270 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/queue/purge/0.1/payload.schema.json
+ */
+
+import type { Ext, Queue, Vid } from "../../../../_shared/components.js";
+
+
+export interface MessagingPurgeQueuePayload {
+  /**
+   * The account whose queue to purge. Omitted = the requester's own account. A requester without administrative standing may name only itself.
+   */
+  did?: Vid;
+  queue: Queue;
+  /**
+   * Only messages exchanged with this counterparty: in a send queue, the recipient; in a receive queue, the sender.
+   */
+  peer?: Vid;
+  /**
+   * Only messages queued at least this long.
+   */
+  olderThanSeconds?: number;
+  /**
+   * Report what would be purged and purge nothing. Default false.
+   */
+  dryRun?: boolean;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The success response to a messaging/queue/purge request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/queue/purge/0.1#response.
+ */
+export interface MessagingPurgeQueueResponsePayload {
+  /**
+   * Messages that matched the selection.
+   */
+  matched: number;
+  matchedBytes?: number;
+  /**
+   * Messages actually removed. 0 on a dry run.
+   */
+  purged: number;
+  dryRun: boolean;
+  /**
+   * 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, Queue, Vid };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/queue/purge/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingPurgeQueuePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/queue/purge/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = MessagingPurgeQueueResponsePayload;
+
+/**
+ * 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/queue/purge/0.1",
+  "title": "Messaging — Purge Queue — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "queue"
+  ],
+  "properties": {
+    "did": {
+      "$ref": "#/$defs/Vid",
+      "description": "The account whose queue to purge. Omitted = the requester's own account. A requester without administrative standing may name only itself."
+    },
+    "queue": {
+      "$ref": "#/$defs/Queue"
+    },
+    "peer": {
+      "$ref": "#/$defs/Vid",
+      "description": "Only messages exchanged with this counterparty: in a send queue, the recipient; in a receive queue, the sender."
+    },
+    "olderThanSeconds": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Only messages queued at least this long."
+    },
+    "dryRun": {
+      "type": "boolean",
+      "description": "Report what would be purged and purge nothing. Default false."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — Purge Queue — response payload",
+      "description": "The success response to a messaging/queue/purge request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/queue/purge/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "matched": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages that matched the selection."
+        },
+        "matchedBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "purged": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages actually removed. 0 on a dry run."
+        },
+        "dryRun": {
+          "type": "boolean"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "matched",
+        "purged",
+        "dryRun"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "Vid": {
+      "title": "Vid",
+      "type": "string",
+      "minLength": 1,
+      "description": "A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID, carried verbatim and compared by exact string equality. For privacy — and because some mediators key accounts by a one-way hash and never hold the full DID — a stable hash of the DID (e.g. its SHA-256 digest) is an equally valid value here: producer and consumer simply agree on the same opaque identifier and compare by exact string equality. The field carries whichever form the issuing mediator uses."
+    },
+    "Queue": {
+      "title": "Queue",
+      "type": "string",
+      "enum": [
+        "receive",
+        "send"
+      ],
+      "description": "Which of an account's two queues. `receive` holds messages addressed to the account awaiting its pickup. `send` holds messages the account sent that are still held against it until their recipient deletes them — so a stalled recipient fills its senders' send queues."
+    }
+  }
+} 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 — Purge Queue — response payload",
+      "description": "The success response to a messaging/queue/purge request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/queue/purge/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "matched": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages that matched the selection."
+        },
+        "matchedBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "purged": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages actually removed. 0 on a dry run."
+        },
+        "dryRun": {
+          "type": "boolean"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "matched",
+        "purged",
+        "dryRun"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "Vid": {
+      "title": "Vid",
+      "type": "string",
+      "minLength": 1,
+      "description": "A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID, carried verbatim and compared by exact string equality. For privacy — and because some mediators key accounts by a one-way hash and never hold the full DID — a stable hash of the DID (e.g. its SHA-256 digest) is an equally valid value here: producer and consumer simply agree on the same opaque identifier and compare by exact string equality. The field carries whichever form the issuing mediator uses."
+    },
+    "Queue": {
+      "title": "Queue",
+      "type": "string",
+      "enum": [
+        "receive",
+        "send"
+      ],
+      "description": "Which of an account's two queues. `receive` holds messages addressed to the account awaiting its pickup. `send` holds messages the account sent that are still held against it until their recipient deletes them — so a stalled recipient fills its senders' send queues."
+    }
+  }
+} 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;