@openvtc/trust-tasks 0.19.10 → 0.19.12

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

@@ -0,0 +1,199 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/join-requests/withdraw/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * What an applicant sends to close their own open join request. Every member is optional: the authenticated issuer identifies the applicant, and a community that allows at most one open request per applicant can resolve the request from that alone. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCJoinRequestsWithdrawPayload {
+  /**
+   * The request to withdraw. Optional: an applicant whose submit response was lost never received an id, and the id-less form — resolved from the authenticated applicant's own identifier — is the only one available to them. Supply it when you have it; a consumer that has it MUST prefer it over inferring the request from the caller.
+   */
+  requestId?: string;
+  /**
+   * Free text for the humans who will read the community's record of this withdrawal — a vetter who attested, or a maintainer mid-review. A consumer MUST NOT interpret it or branch on its content. A producer MUST NOT put credentials, secrets, or personal data about anyone other than the applicant into it.
+   */
+  reason?: string;
+  ext?: Ext;
+}
+/**
+ * Confirms which request was closed. Failures use trust-task-error, not this shape.
+ */
+export interface VTCJoinRequestsWithdrawResponsePayload {
+  /**
+   * The request that was withdrawn. Returned even when the request omitted it, so an applicant who used the id-less form learns which request they closed.
+   */
+  requestId: string;
+  /**
+   * The request's state after the withdrawal. Always `withdrawn`; returned rather than implied so the response is self-describing to a reader holding only this document.
+   */
+  status: "withdrawn";
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/withdraw/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsWithdrawPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/withdraw/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsWithdrawResponsePayload;
+
+/**
+ * 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/vtc/join-requests/withdraw/0.1",
+  "title": "VTC Join-Requests — Withdraw — payload",
+  "description": "What an applicant sends to close their own open join request. Every member is optional: the authenticated issuer identifies the applicant, and a community that allows at most one open request per applicant can resolve the request from that alone. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "requestId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The request to withdraw. Optional: an applicant whose submit response was lost never received an id, and the id-less form — resolved from the authenticated applicant's own identifier — is the only one available to them. Supply it when you have it; a consumer that has it MUST prefer it over inferring the request from the caller."
+    },
+    "reason": {
+      "type": "string",
+      "maxLength": 1024,
+      "description": "Free text for the humans who will read the community's record of this withdrawal — a vetter who attested, or a maintainer mid-review. A consumer MUST NOT interpret it or branch on its content. A producer MUST NOT put credentials, secrets, or personal data about anyone other than the applicant into it."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Join-Requests — Withdraw — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestId",
+        "status"
+      ],
+      "description": "Confirms which request was closed. Failures use trust-task-error, not this shape.",
+      "properties": {
+        "requestId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The request that was withdrawn. Returned even when the request omitted it, so an applicant who used the id-less form learns which request they closed."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "withdrawn"
+          ],
+          "description": "The request's state after the withdrawal. Always `withdrawn`; returned rather than implied so the response is self-describing to a reader holding only this document."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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": "VTC Join-Requests — Withdraw — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestId",
+        "status"
+      ],
+      "description": "Confirms which request was closed. Failures use trust-task-error, not this shape.",
+      "properties": {
+        "requestId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The request that was withdrawn. Returned even when the request omitted it, so an applicant who used the id-less form learns which request they closed."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "withdrawn"
+          ],
+          "description": "The request's state after the withdrawal. Always `withdrawn`; returned rather than implied so the response is self-describing to a reader holding only this document."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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;