@openvtc/trust-tasks 0.2.55 → 0.2.57

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

@@ -16,9 +16,50 @@ export interface VTCJoinRequestsShowPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsShowResponsePayload {
+  request: JoinRequest;
+  ext?: Ext;
+}
+/**
+ * One application to join a Verifiable Trust Community.
+ */
+export interface JoinRequest {
+  /**
+   * Stable id of this join request (a UUID).
+   */
+  id: string;
+  /**
+   * DID of the applicant.
+   */
+  applicantDid: string;
+  /**
+   * The W3C Verifiable Presentation the applicant submitted (opaque here).
+   */
+  vp: {};
+  submittedAt: string;
+  status: "pending" | "approved" | "rejected" | "withdrawn" | "deferred";
+  /**
+   * The community policy verdict recorded for this request (opaque here); absent while pending.
+   */
+  policyDecision?: {};
+  /**
+   * Whether the applicant consented to trust-registry publication.
+   */
+  registryConsent?: boolean;
+  /**
+   * Opaque community-defined extension bag.
+   */
+  extensions?: {};
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/show/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsShowPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsShowResponsePayload;

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

@@ -16,9 +16,28 @@ export interface VTCJoinRequestsStatusPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsStatusResponsePayload {
+  requestId: string;
+  status: "pending" | "deferred" | "approved" | "rejected" | "withdrawn";
+  /**
+   * When deferred, what the applicant must supply next.
+   */
+  needs?: string[];
+  /**
+   * When more evidence is needed, the presentation-definition to satisfy (opaque here).
+   */
+  presentationDefinition?: {};
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/status/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsStatusPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/status/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsStatusResponsePayload;

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

@@ -24,9 +24,23 @@ export interface VTCJoinRequestsSubmitPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsSubmitResponsePayload {
+  /**
+   * Id of the created join request (a UUID).
+   */
+  requestId: string;
+  status: "pending";
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/submit/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsSubmitPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/submit/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsSubmitResponsePayload;

package/src/vtc/join-requests/submit-receipt/0.1/payload.ts

@@ -20,9 +20,22 @@ export interface VTCJoinRequestsSubmitReceiptPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsSubmitReceiptResponsePayload {
+  /**
+   * The applicant received the receipt.
+   */
+  acknowledged: boolean;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/submit-receipt/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsSubmitReceiptPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/submit-receipt/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsSubmitReceiptResponsePayload;

package/src/vtc/members/admin-remove/0.1/payload.ts

@@ -21,9 +21,21 @@ export interface VTCMembersAdminRemovePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersAdminRemoveResponsePayload {
+  did: string;
+  disposition: "purge" | "tombstone" | "historical";
+  removed: boolean;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/admin-remove/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersAdminRemovePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/admin-remove/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersAdminRemoveResponsePayload;

package/src/vtc/members/list/0.1/payload.ts

@@ -24,9 +24,69 @@ export interface VTCMembersListPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersListResponsePayload {
+  items: MemberResponse[];
+  /**
+   * Continuation token for the next page, or null when this is the last.
+   */
+  nextCursor?: string | null;
+  /**
+   * Approximate total matching members, when the maintainer can cheaply estimate it.
+   */
+  totalEstimate?: number | null;
+  ext?: Ext;
+}
+/**
+ * One community member as the maintainer sees it: the membership record joined with its ACL role.
+ */
+export interface MemberResponse {
+  /**
+   * The member's DID.
+   */
+  did: string;
+  /**
+   * The member's role in wire form (e.g. `admin`, `moderator`, `custom:editor`).
+   */
+  role: string;
+  /**
+   * Optional human-readable label.
+   */
+  label?: string | null;
+  joinedAt: string;
+  /**
+   * Whether the member consented to being published in the community directory.
+   */
+  publishConsent: boolean;
+  /**
+   * How the member's record is handled on departure.
+   */
+  departurePreference: "purge" | "tombstone" | "historical" | "policydefault";
+  /**
+   * The member's slot on the community's membership status list, when allocated.
+   */
+  statusListIndex?: number | null;
+  /**
+   * Id of the member's current Verifiable Membership Credential, if issued.
+   */
+  currentVmcId?: string | null;
+  /**
+   * Id of the member's current role Verifiable Endorsement Credential, if issued.
+   */
+  currentRoleVecId?: string | null;
+  /**
+   * Opaque community-defined extension bag. Keys are maintainer-defined; the maintainer caps its size (16 KiB in the reference implementation).
+   */
+  extensions: {};
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/list/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersListPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersListResponsePayload;

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

@@ -20,9 +20,31 @@ export interface VTCMembersPersonhoodAssertPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersPersonhoodAssertResponsePayload {
+  did: string;
+  /**
+   * Always true on success — the flag flipped or stayed asserted.
+   */
+  personhood: true;
+  /**
+   * Re-issued membership credential carrying the asserted personhood (opaque here).
+   */
+  vmc: {};
+  /**
+   * Re-issued role credential (opaque here).
+   */
+  roleVec: {};
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/personhood/assert/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersPersonhoodAssertPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/personhood/assert/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersPersonhoodAssertResponsePayload;

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

@@ -16,9 +16,26 @@ export interface VTCMembersPersonhoodChallengePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersPersonhoodChallengeResponsePayload {
+  /**
+   * Single-use nonce (a UUID). Embed it into the assert VP's proof.challenge.
+   */
+  challengeId: string;
+  /**
+   * The assert handler refuses the presentation past this point.
+   */
+  expiresAt: string;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/personhood/challenge/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersPersonhoodChallengePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/personhood/challenge/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersPersonhoodChallengeResponsePayload;

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

@@ -16,9 +16,31 @@ export interface VTCMembersPersonhoodRevokePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersPersonhoodRevokeResponsePayload {
+  did: string;
+  /**
+   * Always false on success.
+   */
+  personhood: false;
+  /**
+   * Newly-minted membership credential carrying personhood false; omitted on an idempotent no-op.
+   */
+  vmc?: {};
+  /**
+   * Newly-minted role credential; omitted on an idempotent no-op.
+   */
+  roleVec?: {};
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/personhood/revoke/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersPersonhoodRevokePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/personhood/revoke/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersPersonhoodRevokeResponsePayload;

package/src/vtc/members/purge/0.1/payload.ts

@@ -16,9 +16,30 @@ export interface VTCMembersPurgePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersPurgeResponsePayload {
+  /**
+   * The purged DID, echoed.
+   */
+  did: string;
+  /**
+   * How the member's published record was disposed of.
+   */
+  disposition: string;
+  /**
+   * True when a record or tombstone was erased.
+   */
+  removed: boolean;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/purge/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersPurgePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/purge/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersPurgeResponsePayload;

package/src/vtc/members/removed/0.1/payload.ts

@@ -12,9 +12,40 @@ export interface VTCMembersRemovedPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersRemovedResponsePayload {
+  /**
+   * One entry per tombstone. Purged members are absent.
+   */
+  removed: RemovedMember[];
+  ext?: Ext;
+}
+export interface RemovedMember {
+  /**
+   * DID of the departed member.
+   */
+  did: string;
+  /**
+   * When the removal took effect.
+   */
+  removedAt: string;
+  /**
+   * Slot in the community's published status list holding this member's revocation bit.
+   */
+  statusListIndex?: number | null;
+  /**
+   * Tombstone state, e.g. how the departure was dispositioned.
+   */
+  status: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/removed/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersRemovedPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/removed/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersRemovedResponsePayload;

package/src/vtc/members/renew/0.1/payload.ts

@@ -12,9 +12,35 @@ export interface VTCMembersRenewPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersRenewResponsePayload {
+  did: string;
+  /**
+   * The freshly-issued W3C Verifiable Membership Credential (opaque here).
+   */
+  vmc: {};
+  /**
+   * The freshly-issued role Verifiable Endorsement Credential (opaque here).
+   */
+  roleVec: {};
+  /**
+   * Whether the renewed membership carries a personhood assertion.
+   */
+  personhood: boolean;
+  /**
+   * Whether the personhood state changed on this renewal.
+   */
+  personhoodChanged: boolean;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/renew/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersRenewPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/renew/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersRenewResponsePayload;

package/src/vtc/members/request-vmc/0.1/payload.ts

@@ -20,9 +20,22 @@ export interface VTCMembersRequestVMCPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersRequestVMCResponsePayload {
+  /**
+   * The member received the request. NOT a commitment to issue — the credential arrives separately as vtc/members/vmc, or never.
+   */
+  acknowledged: boolean;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/request-vmc/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersRequestVMCPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/request-vmc/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersRequestVMCResponsePayload;

package/src/vtc/members/rotate/0.1/payload.ts

@@ -26,9 +26,28 @@ export interface VTCMembersRotatePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersRotateResponsePayload {
+  newDid: string;
+  method: "did:key" | "did:webvh";
+  /**
+   * Membership credential re-issued to the new DID (opaque here).
+   */
+  vmc: {};
+  /**
+   * Role credential re-issued to the new DID (opaque here).
+   */
+  roleVec: {};
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/rotate/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersRotatePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/rotate/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersRotateResponsePayload;

package/src/vtc/members/rotate-challenge/0.1/payload.ts

@@ -16,9 +16,31 @@ export interface VTCMembersRotateChallengePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersRotateChallengeResponsePayload {
+  /**
+   * A UUID identifying this rotation ceremony.
+   */
+  rotationId: string;
+  expiresAt: string;
+  /**
+   * Hex bytes the member signs with both the old and new keys to prove control of each.
+   */
+  signingPayloadHex: string;
+  /**
+   * The canonical rotation template the signatures cover (opaque here).
+   */
+  canonicalTemplate: {};
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/rotate-challenge/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersRotateChallengePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/rotate-challenge/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersRotateChallengeResponsePayload;

package/src/vtc/members/self-remove/0.1/payload.ts

@@ -16,9 +16,27 @@ export interface VTCMembersSelfRemovePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersSelfRemoveResponsePayload {
+  /**
+   * The removed member (the caller).
+   */
+  did: string;
+  /**
+   * The disposition actually applied (policydefault resolved to a concrete one).
+   */
+  disposition: "purge" | "tombstone" | "historical";
+  removed: boolean;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/self-remove/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersSelfRemovePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/self-remove/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersSelfRemoveResponsePayload;

package/src/vtc/members/self-remove-receipt/0.1/payload.ts

@@ -24,9 +24,22 @@ export interface VTCMembersSelfRemoveReceiptPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersSelfRemoveReceiptResponsePayload {
+  /**
+   * The member received the receipt.
+   */
+  acknowledged: boolean;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/self-remove-receipt/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersSelfRemoveReceiptPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/self-remove-receipt/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersSelfRemoveReceiptResponsePayload;

package/src/vtc/members/show/0.1/payload.ts

@@ -16,9 +16,61 @@ export interface VTCMembersShowPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersShowResponsePayload {
+  member: MemberResponse;
+  ext?: Ext;
+}
+/**
+ * One community member as the maintainer sees it: the membership record joined with its ACL role.
+ */
+export interface MemberResponse {
+  /**
+   * The member's DID.
+   */
+  did: string;
+  /**
+   * The member's role in wire form (e.g. `admin`, `moderator`, `custom:editor`).
+   */
+  role: string;
+  /**
+   * Optional human-readable label.
+   */
+  label?: string | null;
+  joinedAt: string;
+  /**
+   * Whether the member consented to being published in the community directory.
+   */
+  publishConsent: boolean;
+  /**
+   * How the member's record is handled on departure.
+   */
+  departurePreference: "purge" | "tombstone" | "historical" | "policydefault";
+  /**
+   * The member's slot on the community's membership status list, when allocated.
+   */
+  statusListIndex?: number | null;
+  /**
+   * Id of the member's current Verifiable Membership Credential, if issued.
+   */
+  currentVmcId?: string | null;
+  /**
+   * Id of the member's current role Verifiable Endorsement Credential, if issued.
+   */
+  currentRoleVecId?: string | null;
+  /**
+   * Opaque community-defined extension bag. Keys are maintainer-defined; the maintainer caps its size (16 KiB in the reference implementation).
+   */
+  extensions: {};
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/show/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersShowPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersShowResponsePayload;

package/src/vtc/members/solicit-vmc/0.1/payload.ts

@@ -20,9 +20,30 @@ export interface VTCMembersSolicitVMCPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCMembersSolicitVMCResponsePayload {
+  /**
+   * The member the request was dispatched to.
+   */
+  memberDid: string;
+  /**
+   * The request was DISPATCHED. Not a delivery or reply receipt.
+   */
+  requested: boolean;
+  /**
+   * Correlates the member's eventual vtc/members/vmc delivery with this solicitation.
+   */
+  threadId: string;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/solicit-vmc/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersSolicitVMCPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/solicit-vmc/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersSolicitVMCResponsePayload;