@openvtc/trust-tasks 0.28.2 → 0.28.4

package/src/vta/webvh/dids/update/2.0/payload.ts

@@ -9,7 +9,7 @@ import type { DidDocumentChange, DidDocumentPreview, DidVerificationRelationship
 /**
  * Ask a Verifiable Trust Agent to publish a new entry in a did:webvh log it holds the update key for, changing anything but the DID's keys. Keys change only through the key-role tasks (vta/_shared/0.3/CONVENTIONS.md).
  *
- * @deprecated superseded by vta/webvh/dids/update/2.1
+ * @deprecated retired; use vta/dids/update/1.0
  */
 export interface WebVHDIDUpdatePayload {
   /**
@@ -59,7 +59,7 @@ export interface WebVHDIDUpdatePayload {
 /**
  * The outcome. `preview` and `pendingApproval` carry the plan; `applied` carries the published entry.
  *
- * @deprecated superseded by vta/webvh/dids/update/2.1
+ * @deprecated retired; use vta/dids/update/1.0
  */
 export interface WebVHDIDUpdateResponsePayload {
   did: string;
@@ -110,12 +110,12 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = "superseded by vta/webvh/dids/update/2.1";
+export const DEPRECATION: string | null = "retired; use vta/dids/update/1.0";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated superseded by vta/webvh/dids/update/2.1
+ * @deprecated retired; use vta/dids/update/1.0
  */
 export type Payload = WebVHDIDUpdatePayload;
 
@@ -125,7 +125,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/upd
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated superseded by vta/webvh/dids/update/2.1
+ * @deprecated retired; use vta/dids/update/1.0
  */
 export type Response = WebVHDIDUpdateResponsePayload;
 

package/src/vta/webvh/dids/update/2.1/payload.ts

@@ -8,6 +8,8 @@ import type { DidDocumentChange, DidDocumentPreview, DidVerificationRelationship
 
 /**
  * Ask a Verifiable Trust Agent to publish a new entry in a did:webvh log it holds the update key for, changing anything but the DID's keys. Keys change only through the key-role tasks (vta/_shared/0.3/CONVENTIONS.md).
+ *
+ * @deprecated retired; use vta/dids/update/1.0
  */
 export interface WebVHDIDUpdatePayload {
   /**
@@ -56,6 +58,8 @@ export interface WebVHDIDUpdatePayload {
 }
 /**
  * The outcome. `preview` and `pendingApproval` carry the plan; `applied` carries the published entry.
+ *
+ * @deprecated retired; use vta/dids/update/1.0
  */
 export interface WebVHDIDUpdateResponsePayload {
   did: string;
@@ -106,15 +110,23 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = null;
+export const DEPRECATION: string | null = "retired; use vta/dids/update/1.0";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated retired; use vta/dids/update/1.0
+ */
 export type Payload = WebVHDIDUpdatePayload;
 
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/update/2.1#response" as const;
 
-/** Stable alias for this specification's success-response payload shape. */
+/**
+ * Stable alias for this specification's success-response payload shape.
+ *
+ * @deprecated retired; use vta/dids/update/1.0
+ */
 export type Response = WebVHDIDUpdateResponsePayload;
 
 /**

package/src/vtc/_shared/0.2/invite.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/_shared/0.2/invite.schema.json
+ */
+
+/**
+ * Shared types for the vtc/admin/invites/* family. An admin invite is a one-shot install URL and claim code that admits one additional administrator: a **wallet** invitation names the DID that claims it, and a **passkey** invitation names none, the administrator's DID being derived from the passkey registered when it is claimed. `create` mints one and `list` enumerates them, so the summary lives here.
+ */
+export interface VTCSharedAdminInviteDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { InviteKind, InviteStatus, InviteSummary_VtcV0_2 as InviteSummary } from "../../../_shared/components.js";

package/src/vtc/admin/invites/create/0.1/payload.ts

@@ -6,6 +6,7 @@
 import type { Ext } from "../../../../../_shared/components.js";
 
 
+/** @deprecated superseded by vtc/admin/invites/create/0.2 */
 export interface VTCAdminInvitesCreatePayload {
   /**
    * Admin DID the install URL grants a passkey for.
@@ -21,6 +22,7 @@ export interface VTCAdminInvitesCreatePayload {
   label?: string;
   ext?: Ext;
 }
+/** @deprecated superseded by vtc/admin/invites/create/0.2 */
 export interface VTCAdminInvitesCreateResponsePayload {
   /**
    * Invite identifier; the revoke target.
@@ -65,15 +67,23 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = null;
+export const DEPRECATION: string | null = "superseded by vtc/admin/invites/create/0.2";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by vtc/admin/invites/create/0.2
+ */
 export type Payload = VTCAdminInvitesCreatePayload;
 
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/create/0.1#response" as const;
 
-/** Stable alias for this specification's success-response payload shape. */
+/**
+ * Stable alias for this specification's success-response payload shape.
+ *
+ * @deprecated superseded by vtc/admin/invites/create/0.2
+ */
 export type Response = VTCAdminInvitesCreateResponsePayload;
 
 /**

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

@@ -0,0 +1,289 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/invites/create/0.2/payload.schema.json
+ */
+
+import type { Ext, InviteKind } from "../../../../../_shared/components.js";
+
+
+export interface VTCAdminInvitesCreatePayload {
+  /**
+   * The DID a **wallet** invitation is for: the invitee claims it by signing as this DID (vtc/install/claim/start and finish 0.3). Absent, the invitation is a **passkey** invitation, and the administrator's DID is derived from the passkey the invitee registers (vtc/install/claim/passkey/start and finish 0.1).
+   */
+  did?: string;
+  /**
+   * Invite lifetime. Capped at 24 hours.
+   */
+  ttlSeconds?: number;
+  /**
+   * Operator-facing note, recorded as the label of the administrator entry the invitation writes.
+   */
+  label?: string;
+  ext?: Ext;
+}
+export interface VTCAdminInvitesCreateResponsePayload {
+  /**
+   * Invite identifier; the revoke target.
+   */
+  jti: string;
+  kind: InviteKind;
+  /**
+   * One-shot enrolment URL. Returned once and never retrievable again.
+   */
+  installUrl: string;
+  /**
+   * Secret that authorises the enrolment. Returned once.
+   */
+  claimCode: string;
+  /**
+   * When the invite lapses.
+   */
+  expiresAt: string;
+  /**
+   * True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed.
+   */
+  aclEntryCreated: boolean;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, InviteKind };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/create/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 = VTCAdminInvitesCreatePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/create/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAdminInvitesCreateResponsePayload;
+
+/**
+ * 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/create/0.2",
+  "title": "VTC Admin Invites Create — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "did": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^did:",
+      "description": "The DID a **wallet** invitation is for: the invitee claims it by signing as this DID (vtc/install/claim/start and finish 0.3). Absent, the invitation is a **passkey** invitation, and the administrator's DID is derived from the passkey the invitee registers (vtc/install/claim/passkey/start and finish 0.1)."
+    },
+    "ttlSeconds": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 86400,
+      "description": "Invite lifetime. Capped at 24 hours."
+    },
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Operator-facing note, recorded as the label of the administrator entry the invitation writes."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Admin Invites Create — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jti",
+        "kind",
+        "installUrl",
+        "claimCode",
+        "expiresAt",
+        "aclEntryCreated"
+      ],
+      "properties": {
+        "jti": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Invite identifier; the revoke target."
+        },
+        "kind": {
+          "$ref": "#/$defs/InviteKind"
+        },
+        "installUrl": {
+          "type": "string",
+          "minLength": 1,
+          "description": "One-shot enrolment URL. Returned once and never retrievable again."
+        },
+        "claimCode": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Secret that authorises the enrolment. Returned once."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the invite lapses."
+        },
+        "aclEntryCreated": {
+          "type": "boolean",
+          "description": "True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed."
+        },
+        "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-]+)+$"
+      }
+    },
+    "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 Create — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jti",
+        "kind",
+        "installUrl",
+        "claimCode",
+        "expiresAt",
+        "aclEntryCreated"
+      ],
+      "properties": {
+        "jti": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Invite identifier; the revoke target."
+        },
+        "kind": {
+          "$ref": "#/$defs/InviteKind"
+        },
+        "installUrl": {
+          "type": "string",
+          "minLength": 1,
+          "description": "One-shot enrolment URL. Returned once and never retrievable again."
+        },
+        "claimCode": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Secret that authorises the enrolment. Returned once."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the invite lapses."
+        },
+        "aclEntryCreated": {
+          "type": "boolean",
+          "description": "True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed."
+        },
+        "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-]+)+$"
+      }
+    },
+    "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: 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/admin/invites/list/0.1/payload.ts

@@ -6,9 +6,11 @@
 import type { Ext, InviteStatus, InviteSummary_VtcV0_1 as InviteSummary } from "../../../../../_shared/components.js";
 
 
+/** @deprecated superseded by vtc/admin/invites/list/0.2 */
 export interface VTCAdminInvitesListPayload {
   ext?: Ext;
 }
+/** @deprecated superseded by vtc/admin/invites/list/0.2 */
 export interface VTCAdminInvitesListResponsePayload {
   /**
    * Every invite the community holds, outstanding and terminal.
@@ -37,15 +39,23 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = null;
+export const DEPRECATION: string | null = "superseded by vtc/admin/invites/list/0.2";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by vtc/admin/invites/list/0.2
+ */
 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.1#response" as const;
 
-/** Stable alias for this specification's success-response payload shape. */
+/**
+ * Stable alias for this specification's success-response payload shape.
+ *
+ * @deprecated superseded by vtc/admin/invites/list/0.2
+ */
 export type Response = VTCAdminInvitesListResponsePayload;
 
 /**