@openvtc/trust-tasks 0.21.14 → 0.21.16

package/src/vtc/relationships/revoke/0.2/payload.ts

@@ -0,0 +1,209 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/relationships/revoke/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface VTCRelationshipsRevokePayload {
+  /**
+   * The relationship to revoke.
+   */
+  id: string;
+  /**
+   * Proof that the caller controls the key behind the relationship's issuerDid, when the document's own proof signer is neither that issuer nor an administrator — i.e. for an edge published under a pairwise relationship DID. A member publishes an edge under a relationship DID, an identifier scoped to one counterparty, which names nobody; this document's own proof says only that a member sent the request, not that they control the edge's issuing key. Omit `pop` when the document's proof signer equals the relationship's issuerDid, or is an administrator: the document's own proof, or the administrator's standing, already establishes authority.
+   */
+  pop?: {
+    /**
+     * Distinct from vtc/relationships/publish's VrcPublishAuthorization, so a signature made to authorize a publish cannot be replayed here to authorize a revoke.
+     */
+    type: "VrcRevokeAuthorization";
+    /**
+     * The `id` of the Trust Task document carrying this authorization. Binds the authorization to one document, so a captured one cannot be replayed in another — including by a different member.
+     */
+    documentId: string;
+    /**
+     * The relationship id this authorization applies to. MUST equal the top-level `id`, so an authorization signed for one edge cannot be presented against another.
+     */
+    relationship: string;
+    /**
+     * Data-integrity proof over this object, by a verification method the relationship's issuerDid controls. This is the proof of possession; the members above only bound what it authorizes.
+     */
+    proof: {};
+  };
+  ext?: Ext;
+}
+export interface VTCRelationshipsRevokeResponsePayload {
+  id: string;
+  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/relationships/revoke/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRelationshipsRevokePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/revoke/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRelationshipsRevokeResponsePayload;
+
+/**
+ * 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/relationships/revoke/0.2",
+  "title": "VTC Relationships Revoke — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The relationship to revoke."
+    },
+    "pop": {
+      "type": "object",
+      "description": "Proof that the caller controls the key behind the relationship's issuerDid, when the document's own proof signer is neither that issuer nor an administrator — i.e. for an edge published under a pairwise relationship DID. A member publishes an edge under a relationship DID, an identifier scoped to one counterparty, which names nobody; this document's own proof says only that a member sent the request, not that they control the edge's issuing key. Omit `pop` when the document's proof signer equals the relationship's issuerDid, or is an administrator: the document's own proof, or the administrator's standing, already establishes authority.",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "documentId",
+        "relationship",
+        "proof"
+      ],
+      "properties": {
+        "type": {
+          "const": "VrcRevokeAuthorization",
+          "description": "Distinct from vtc/relationships/publish's VrcPublishAuthorization, so a signature made to authorize a publish cannot be replayed here to authorize a revoke."
+        },
+        "documentId": {
+          "type": "string",
+          "description": "The `id` of the Trust Task document carrying this authorization. Binds the authorization to one document, so a captured one cannot be replayed in another — including by a different member."
+        },
+        "relationship": {
+          "type": "string",
+          "description": "The relationship id this authorization applies to. MUST equal the top-level `id`, so an authorization signed for one edge cannot be presented against another."
+        },
+        "proof": {
+          "type": "object",
+          "description": "Data-integrity proof over this object, by a verification method the relationship's issuerDid controls. This is the proof of possession; the members above only bound what it authorizes."
+        }
+      }
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Relationships Revoke — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "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 Relationships Revoke — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;