@openvtc/trust-tasks 0.20.8 → 0.21.0

package/src/vtc/credentials/reissue/0.1/payload.ts

@@ -0,0 +1,357 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/credentials/reissue/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Ask a VTC to re-sign its status lists and re-issue the attestation artefacts still in force that an attestation key revoked for compromise signed, under the community's current attestation key. Re-sending the same request returns the progress of the job it started.
+ */
+export interface VTCCredentialsReissuePayload {
+  /**
+   * The revocation that requires re-issuance. The VTC MUST verify it against its own DID's key roles (vta/webvh/dids/keys/list) rather than trust it.
+   */
+  cause: {
+    /**
+     * The attestation key of the community's DID that was revoked for compromise.
+     */
+    verificationMethod: string;
+    /**
+     * The VTA's rotation record (`kind: compromise`) for the revocation, when known.
+     */
+    rotationId?: string;
+  };
+  /**
+   * `all` (the default) re-signs status lists first and then re-issues artefacts. `statusListsOnly` re-signs status lists and stops — for an operator who must restore status checking within minutes and schedule the rest.
+   */
+  scope?: "all" | "statusListsOnly";
+  /**
+   * Report what would be re-signed and re-issued, without doing it. Absent reads as false.
+   */
+  dryRun?: boolean;
+  ext?: Ext;
+}
+/**
+ * Success response. Type https://trusttasks.org/spec/vtc/credentials/reissue/0.1#response. Counts only — never a list of members or credentials.
+ */
+export interface VTCCredentialsReissueResponsePayload {
+  /**
+   * The job this cause started. The same cause always names the same job.
+   */
+  jobId: string;
+  /**
+   * `planned` — a dry run. `running` — status lists are being re-signed. `statusListsDone` — every status list is re-signed; artefacts are being re-issued (or, for `statusListsOnly`, the job is done). `completed` — everything in scope is re-signed and re-issued. `failed` — the job stopped; `artefacts.failed` and the audit trail say where.
+   */
+  state: "planned" | "running" | "statusListsDone" | "completed" | "failed";
+  dryRun: boolean;
+  statusLists: ReissueProgress;
+  artefacts: ReissueProgress;
+  /**
+   * The attestation keys (verification methods) the new signatures are made with.
+   */
+  signedWith?: string[];
+  ext?: Ext;
+}
+export interface ReissueProgress {
+  total: number;
+  done: number;
+  failed: number;
+  /**
+   * Artefacts re-issued but not yet delivered to their holder — the holder is offline or unreachable. They are held for the holder's next renewal or contact.
+   */
+  undeliverable?: number;
+}
+
+/** 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/credentials/reissue/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCCredentialsReissuePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/credentials/reissue/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCCredentialsReissueResponsePayload;
+
+/**
+ * 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/credentials/reissue/0.1",
+  "title": "VTC Credentials Reissue — payload",
+  "description": "Ask a VTC to re-sign its status lists and re-issue the attestation artefacts still in force that an attestation key revoked for compromise signed, under the community's current attestation key. Re-sending the same request returns the progress of the job it started.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "cause"
+  ],
+  "properties": {
+    "cause": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "verificationMethod"
+      ],
+      "description": "The revocation that requires re-issuance. The VTC MUST verify it against its own DID's key roles (vta/webvh/dids/keys/list) rather than trust it.",
+      "properties": {
+        "verificationMethod": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The attestation key of the community's DID that was revoked for compromise."
+        },
+        "rotationId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The VTA's rotation record (`kind: compromise`) for the revocation, when known."
+        }
+      }
+    },
+    "scope": {
+      "type": "string",
+      "enum": [
+        "all",
+        "statusListsOnly"
+      ],
+      "description": "`all` (the default) re-signs status lists first and then re-issues artefacts. `statusListsOnly` re-signs status lists and stops — for an operator who must restore status checking within minutes and schedule the rest."
+    },
+    "dryRun": {
+      "type": "boolean",
+      "description": "Report what would be re-signed and re-issued, without doing it. Absent reads as false."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Credentials Reissue — response payload",
+      "description": "Success response. Type https://trusttasks.org/spec/vtc/credentials/reissue/0.1#response. Counts only — never a list of members or credentials.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobId",
+        "state",
+        "dryRun",
+        "statusLists",
+        "artefacts"
+      ],
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The job this cause started. The same cause always names the same job."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "planned",
+            "running",
+            "statusListsDone",
+            "completed",
+            "failed"
+          ],
+          "description": "`planned` — a dry run. `running` — status lists are being re-signed. `statusListsDone` — every status list is re-signed; artefacts are being re-issued (or, for `statusListsOnly`, the job is done). `completed` — everything in scope is re-signed and re-issued. `failed` — the job stopped; `artefacts.failed` and the audit trail say where."
+        },
+        "dryRun": {
+          "type": "boolean"
+        },
+        "statusLists": {
+          "$ref": "#/$defs/Progress"
+        },
+        "artefacts": {
+          "$ref": "#/$defs/Progress"
+        },
+        "signedWith": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The attestation keys (verification methods) the new signatures are made with."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Progress": {
+      "title": "ReissueProgress",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "total",
+        "done",
+        "failed"
+      ],
+      "properties": {
+        "total": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "done": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "failed": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "undeliverable": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Artefacts re-issued but not yet delivered to their holder — the holder is offline or unreachable. They are held for the holder's next renewal or contact."
+        }
+      }
+    },
+    "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 Credentials Reissue — response payload",
+      "description": "Success response. Type https://trusttasks.org/spec/vtc/credentials/reissue/0.1#response. Counts only — never a list of members or credentials.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobId",
+        "state",
+        "dryRun",
+        "statusLists",
+        "artefacts"
+      ],
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The job this cause started. The same cause always names the same job."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "planned",
+            "running",
+            "statusListsDone",
+            "completed",
+            "failed"
+          ],
+          "description": "`planned` — a dry run. `running` — status lists are being re-signed. `statusListsDone` — every status list is re-signed; artefacts are being re-issued (or, for `statusListsOnly`, the job is done). `completed` — everything in scope is re-signed and re-issued. `failed` — the job stopped; `artefacts.failed` and the audit trail say where."
+        },
+        "dryRun": {
+          "type": "boolean"
+        },
+        "statusLists": {
+          "$ref": "#/$defs/Progress"
+        },
+        "artefacts": {
+          "$ref": "#/$defs/Progress"
+        },
+        "signedWith": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The attestation keys (verification methods) the new signatures are made with."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Progress": {
+      "title": "ReissueProgress",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "total",
+        "done",
+        "failed"
+      ],
+      "properties": {
+        "total": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "done": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "failed": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "undeliverable": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Artefacts re-issued but not yet delivered to their holder — the holder is offline or unreachable. They are held for the holder's next renewal or contact."
+        }
+      }
+    },
+    "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;

package/src/vtc/members/personhood/challenge/0.1/payload.ts

@@ -159,7 +159,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
 export const SPEC = {
   typeUri: TYPE_URI,
   isBearer: false,
-  isProofRequired: false,
+  isProofRequired: true,
   isRecipientRequired: true,
   isIssuedAtRequired: false,
   payloadSchema: PAYLOAD_SCHEMA,
@@ -173,7 +173,7 @@ export const SPEC = {
 export const RESPONSE_SPEC = {
   typeUri: RESPONSE_TYPE_URI,
   isBearer: false,
-  isProofRequired: false,
+  isProofRequired: true,
   isRecipientRequired: true,
   isIssuedAtRequired: false,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,

package/src/vtc/vetting/vetters/profile/0.1/payload.ts

@@ -626,7 +626,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
 export const SPEC = {
   typeUri: TYPE_URI,
   isBearer: false,
-  isProofRequired: false,
+  isProofRequired: true,
   isRecipientRequired: true,
   isIssuedAtRequired: true,
   payloadSchema: PAYLOAD_SCHEMA,
@@ -640,7 +640,7 @@ export const SPEC = {
 export const RESPONSE_SPEC = {
   typeUri: RESPONSE_TYPE_URI,
   isBearer: false,
-  isProofRequired: false,
+  isProofRequired: true,
   isRecipientRequired: true,
   isIssuedAtRequired: true,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,

package/src/vtc/vetting/vetters/resend/0.1/payload.ts

@@ -153,7 +153,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
 export const SPEC = {
   typeUri: TYPE_URI,
   isBearer: false,
-  isProofRequired: false,
+  isProofRequired: true,
   isRecipientRequired: true,
   isIssuedAtRequired: false,
   payloadSchema: PAYLOAD_SCHEMA,
@@ -167,7 +167,7 @@ export const SPEC = {
 export const RESPONSE_SPEC = {
   typeUri: RESPONSE_TYPE_URI,
   isBearer: false,
-  isProofRequired: false,
+  isProofRequired: true,
   isRecipientRequired: true,
   isIssuedAtRequired: false,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,