@openvtc/trust-tasks 0.28.2 → 0.28.4

package/src/vtc/admin/invites/list/0.2/payload.ts

@@ -0,0 +1,294 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/invites/list/0.2/payload.schema.json
+ */
+
+import type { Ext, InviteKind, InviteStatus, InviteSummary_VtcV0_2 as InviteSummary } from "../../../../../_shared/components.js";
+
+
+export interface VTCAdminInvitesListPayload {
+  ext?: Ext;
+}
+export interface VTCAdminInvitesListResponsePayload {
+  /**
+   * Every invite the community holds, outstanding and terminal.
+   */
+  invites: InviteSummary[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, InviteKind, InviteStatus, InviteSummary };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/list/0.2" 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 = VTCAdminInvitesListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/list/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAdminInvitesListResponsePayload;
+
+/**
+ * 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/admin/invites/list/0.2",
+  "title": "VTC Admin Invites List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Admin Invites List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invites"
+      ],
+      "properties": {
+        "invites": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/InviteSummary"
+          },
+          "description": "Every invite the community holds, outstanding and terminal."
+        },
+        "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-]+)+$"
+      }
+    },
+    "InviteSummary": {
+      "$anchor": "inviteSummary",
+      "title": "InviteSummary",
+      "description": "One outstanding or historical admin invite. Consumed rows are retained as audit history.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jti",
+        "kind",
+        "status"
+      ],
+      "properties": {
+        "jti": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Unique invite identifier; the revoke target."
+        },
+        "kind": {
+          "$ref": "#/$defs/InviteKind"
+        },
+        "status": {
+          "$ref": "#/$defs/InviteStatus"
+        },
+        "targetDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The administrator's DID: for a wallet invitation the DID it names; for a passkey invitation the DID derived from the passkey that claimed it, so absent until it is consumed."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When an `issued` invite lapses."
+        },
+        "consumedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the invite was redeemed, if it was."
+        }
+      }
+    },
+    "InviteStatus": {
+      "$anchor": "inviteStatus",
+      "title": "InviteStatus",
+      "type": "string",
+      "enum": [
+        "issued",
+        "consumed",
+        "expired"
+      ],
+      "description": "`issued` is outstanding and revocable; `consumed` and `expired` are terminal."
+    },
+    "InviteKind": {
+      "$anchor": "inviteKind",
+      "title": "InviteKind",
+      "type": "string",
+      "enum": [
+        "wallet",
+        "passkey"
+      ],
+      "description": "`wallet`: the invitation names a DID, and is claimed by signing as it (vtc/install/claim/start and finish 0.3). `passkey`: it names none, and the administrator's DID is the `did:key` of the passkey registered at its claim (vtc/install/claim/passkey/start and finish 0.1)."
+    }
+  }
+} 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 Admin Invites List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invites"
+      ],
+      "properties": {
+        "invites": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/InviteSummary"
+          },
+          "description": "Every invite the community holds, outstanding and terminal."
+        },
+        "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-]+)+$"
+      }
+    },
+    "InviteSummary": {
+      "$anchor": "inviteSummary",
+      "title": "InviteSummary",
+      "description": "One outstanding or historical admin invite. Consumed rows are retained as audit history.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jti",
+        "kind",
+        "status"
+      ],
+      "properties": {
+        "jti": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Unique invite identifier; the revoke target."
+        },
+        "kind": {
+          "$ref": "#/$defs/InviteKind"
+        },
+        "status": {
+          "$ref": "#/$defs/InviteStatus"
+        },
+        "targetDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The administrator's DID: for a wallet invitation the DID it names; for a passkey invitation the DID derived from the passkey that claimed it, so absent until it is consumed."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When an `issued` invite lapses."
+        },
+        "consumedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the invite was redeemed, if it was."
+        }
+      }
+    },
+    "InviteStatus": {
+      "$anchor": "inviteStatus",
+      "title": "InviteStatus",
+      "type": "string",
+      "enum": [
+        "issued",
+        "consumed",
+        "expired"
+      ],
+      "description": "`issued` is outstanding and revocable; `consumed` and `expired` are terminal."
+    },
+    "InviteKind": {
+      "$anchor": "inviteKind",
+      "title": "InviteKind",
+      "type": "string",
+      "enum": [
+        "wallet",
+        "passkey"
+      ],
+      "description": "`wallet`: the invitation names a DID, and is claimed by signing as it (vtc/install/claim/start and finish 0.3). `passkey`: it names none, and the administrator's DID is the `did:key` of the passkey registered at its claim (vtc/install/claim/passkey/start and finish 0.1)."
+    }
+  }
+} 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  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: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

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

@@ -11,7 +11,7 @@ import type { Ext } from "../../../../_shared/components.js";
  */
 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.
+   * The revocation that requires re-issuance. The VTC MUST verify it against its own DID's key roles (vta/dids/keys/list) rather than trust it.
    */
   cause: {
     /**
@@ -121,7 +121,7 @@ export const PAYLOAD_SCHEMA = {
       "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.",
+      "description": "The revocation that requires re-issuance. The VTC MUST verify it against its own DID's key roles (vta/dids/keys/list) rather than trust it.",
       "properties": {
         "verificationMethod": {
           "type": "string",