@openvtc/trust-tasks 0.2.55 → 0.2.56

package/src/vtc/endorsements/issue/0.1/payload.ts

@@ -3,6 +3,11 @@
  * Source: specs/vtc/endorsements/issue/0.1/payload.schema.json
  */
 
+/**
+ * Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.
+ */
+export type CredentialId = string;
+
 export interface VTCEndorsementsIssuePayload {
   /**
    * DID of the endorsement's subject (becomes credentialSubject.id).
@@ -28,9 +33,64 @@ export interface VTCEndorsementsIssuePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCEndorsementsIssueResponsePayload {
+  endorsement: Endorsement;
+  ext?: Ext;
+}
+export interface Endorsement {
+  /**
+   * Community-scoped identifier for this endorsement row.
+   */
+  endorsementId: string;
+  /**
+   * The registered endorsement type this VEC asserts; see vtc/endorsement-types/*.
+   */
+  typeUri: string;
+  /**
+   * DID of the endorsement's subject (becomes credentialSubject.id).
+   */
+  subjectDid: string;
+  /**
+   * The attested claim body, validated against the endorsement type's claimSchema when it declares one.
+   */
+  claim?: {};
+  issued: IssuedCredential;
+  /**
+   * The endorsement's slot on the community's shared Revocation status list. Published, so a foreign verifier can check revocation without contacting this community.
+   */
+  statusListIndex: number;
+  /**
+   * When the endorsement was revoked, or null while live.
+   */
+  revokedAt?: string | null;
+}
+/**
+ * The registry-wide issuance receipt — credentialId, the signed VEC, and expiry.
+ */
+export interface IssuedCredential {
+  credentialId: CredentialId;
+  /**
+   * The issued Verifiable Credential (W3C VC Data Model 2.0), signed by the issuer's key. Opaque to the framework.
+   */
+  credential: {};
+  /**
+   * When the credential was minted.
+   */
+  issuedAt?: string;
+  /**
+   * When the credential's validUntil falls due.
+   */
+  expiresAt: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/issue/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = CredentialId;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/issue/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCEndorsementsIssueResponsePayload;

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

@@ -3,6 +3,11 @@
  * Source: specs/vtc/endorsements/list/0.1/payload.schema.json
  */
 
+/**
+ * Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.
+ */
+export type CredentialId = string;
+
 export interface VTCEndorsementsListPayload {
   /**
    * Filter to endorsements of this registered type.
@@ -32,9 +37,72 @@ export interface VTCEndorsementsListPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCEndorsementsListResponsePayload {
+  items: Endorsement[];
+  /**
+   * Continuation token for the next page, or null when this is the last.
+   */
+  nextCursor?: string | null;
+  /**
+   * Approximate total matching endorsements, when the maintainer can cheaply estimate it.
+   */
+  totalEstimate?: number | null;
+  ext?: Ext;
+}
+export interface Endorsement {
+  /**
+   * Community-scoped identifier for this endorsement row.
+   */
+  endorsementId: string;
+  /**
+   * The registered endorsement type this VEC asserts; see vtc/endorsement-types/*.
+   */
+  typeUri: string;
+  /**
+   * DID of the endorsement's subject (becomes credentialSubject.id).
+   */
+  subjectDid: string;
+  /**
+   * The attested claim body, validated against the endorsement type's claimSchema when it declares one.
+   */
+  claim?: {};
+  issued: IssuedCredential;
+  /**
+   * The endorsement's slot on the community's shared Revocation status list. Published, so a foreign verifier can check revocation without contacting this community.
+   */
+  statusListIndex: number;
+  /**
+   * When the endorsement was revoked, or null while live.
+   */
+  revokedAt?: string | null;
+}
+/**
+ * The registry-wide issuance receipt — credentialId, the signed VEC, and expiry.
+ */
+export interface IssuedCredential {
+  credentialId: CredentialId;
+  /**
+   * The issued Verifiable Credential (W3C VC Data Model 2.0), signed by the issuer's key. Opaque to the framework.
+   */
+  credential: {};
+  /**
+   * When the credential was minted.
+   */
+  issuedAt?: string;
+  /**
+   * When the credential's validUntil falls due.
+   */
+  expiresAt: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/list/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = CredentialId;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCEndorsementsListResponsePayload;

package/src/vtc/endorsements/revoke/0.1/payload.ts

@@ -3,6 +3,11 @@
  * Source: specs/vtc/endorsements/revoke/0.1/payload.schema.json
  */
 
+/**
+ * Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.
+ */
+export type CredentialId = string;
+
 export interface VTCEndorsementsRevokePayload {
   endorsementId: string;
   /**
@@ -17,9 +22,34 @@ export interface VTCEndorsementsRevokePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCEndorsementsRevokeResponsePayload {
+  endorsementId: string;
+  revocation: RevocationReceipt;
+  /**
+   * The status-list slot whose bit was flipped, so a verifier can confirm the published effect.
+   */
+  statusListIndex: number;
+  ext?: Ext;
+}
+/**
+ * The registry-wide revocation receipt for the underlying VEC.
+ */
+export interface RevocationReceipt {
+  credentialId: CredentialId;
+  /**
+   * When the revocation was recorded.
+   */
+  revokedAt: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/revoke/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = CredentialId;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/revoke/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCEndorsementsRevokeResponsePayload;

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

@@ -3,6 +3,11 @@
  * Source: specs/vtc/endorsements/show/0.1/payload.schema.json
  */
 
+/**
+ * Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.
+ */
+export type CredentialId = string;
+
 export interface VTCEndorsementsShowPayload {
   endorsementId: string;
   ext?: Ext;
@@ -13,9 +18,64 @@ export interface VTCEndorsementsShowPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCEndorsementsShowResponsePayload {
+  endorsement: Endorsement;
+  ext?: Ext;
+}
+export interface Endorsement {
+  /**
+   * Community-scoped identifier for this endorsement row.
+   */
+  endorsementId: string;
+  /**
+   * The registered endorsement type this VEC asserts; see vtc/endorsement-types/*.
+   */
+  typeUri: string;
+  /**
+   * DID of the endorsement's subject (becomes credentialSubject.id).
+   */
+  subjectDid: string;
+  /**
+   * The attested claim body, validated against the endorsement type's claimSchema when it declares one.
+   */
+  claim?: {};
+  issued: IssuedCredential;
+  /**
+   * The endorsement's slot on the community's shared Revocation status list. Published, so a foreign verifier can check revocation without contacting this community.
+   */
+  statusListIndex: number;
+  /**
+   * When the endorsement was revoked, or null while live.
+   */
+  revokedAt?: string | null;
+}
+/**
+ * The registry-wide issuance receipt — credentialId, the signed VEC, and expiry.
+ */
+export interface IssuedCredential {
+  credentialId: CredentialId;
+  /**
+   * The issued Verifiable Credential (W3C VC Data Model 2.0), signed by the issuer's key. Opaque to the framework.
+   */
+  credential: {};
+  /**
+   * When the credential was minted.
+   */
+  issuedAt?: string;
+  /**
+   * When the credential's validUntil falls due.
+   */
+  expiresAt: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/show/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = CredentialId;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCEndorsementsShowResponsePayload;

package/src/vtc/install/claim/finish/0.1/payload.ts

@@ -25,9 +25,26 @@ export interface VTCInstallClaimFinishPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCInstallClaimFinishResponsePayload {
+  /**
+   * Candidate admin DID derived from the passkey's Ed25519 public key.
+   */
+  adminDid: string;
+  /**
+   * EdDSA JWT (aud=vtc-install-session, 5min TTL) consumed by admin/bootstrap.
+   */
+  setupSessionToken: string;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/finish/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInstallClaimFinishPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/finish/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInstallClaimFinishResponsePayload;

package/src/vtc/install/claim/start/0.1/payload.ts

@@ -16,9 +16,30 @@ export interface VTCInstallClaimStartPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCInstallClaimStartResponsePayload {
+  /**
+   * Echoes the install token's jti (a UUID); pass it back to claim/finish.
+   */
+  registrationId: string;
+  /**
+   * WebAuthn PublicKeyCredentialCreationOptions (opaque here); pubKeyCredParams = [{public-key, -8}].
+   */
+  options: {};
+  /**
+   * Base64url-no-pad 32 random bytes the candidate did:key must sign.
+   */
+  didBindingChallenge: string;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/start/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInstallClaimStartPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/start/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInstallClaimStartResponsePayload;

package/src/vtc/invitations/issue/0.1/payload.ts

@@ -24,9 +24,30 @@ export interface VTCInvitationsIssuePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCInvitationsIssueResponsePayload {
+  /**
+   * The invited DID, echoed.
+   */
+  subjectDid: string;
+  /**
+   * Expiry, or null when the invitation does not lapse.
+   */
+  validUntil?: string | null;
+  /**
+   * The signed Invitation Credential (W3C VC). Opaque here; returned once.
+   */
+  vic: {};
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/invitations/issue/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInvitationsIssuePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/invitations/issue/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInvitationsIssueResponsePayload;

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

@@ -12,9 +12,55 @@ export interface VTCInvitationsListPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCInvitationsListResponsePayload {
+  /**
+   * Every issued invitation, live and revoked. Never includes credential material.
+   */
+  invitations: InvitationSummary[];
+  ext?: Ext;
+}
+/**
+ * Registry view of one issued Invitation Credential. Carries no credential material — the VIC itself is returned only once, by `issue`.
+ */
+export interface InvitationSummary {
+  /**
+   * VIC identifier; the revoke target.
+   */
+  id: string;
+  /**
+   * DID the invitation admits.
+   */
+  subjectDid: string;
+  /**
+   * Role granted on redemption, when the invitation names one.
+   */
+  role?: string;
+  /**
+   * DID of the operator who issued it.
+   */
+  issuedBy: string;
+  /**
+   * When it was issued.
+   */
+  issuedAt: string;
+  /**
+   * Expiry, when the invitation is time-bounded.
+   */
+  validUntil?: string;
+  /**
+   * When it was revoked; absent while live.
+   */
+  revokedAt?: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/invitations/list/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInvitationsListPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/invitations/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInvitationsListResponsePayload;

package/src/vtc/invitations/revoke/0.1/payload.ts

@@ -16,9 +16,30 @@ export interface VTCInvitationsRevokePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCInvitationsRevokeResponsePayload {
+  /**
+   * The revoked invitation's identifier, echoed.
+   */
+  id: string;
+  /**
+   * When the credential was revoked. On a repeat call this is the ORIGINAL revocation time, not now.
+   */
+  revokedAt: string;
+  /**
+   * True when this call flipped the bit; false when it was already revoked.
+   */
+  newlyRevoked: boolean;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/invitations/revoke/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInvitationsRevokePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/invitations/revoke/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInvitationsRevokeResponsePayload;

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

@@ -24,9 +24,24 @@ export interface VTCJoinRequestsAcceptPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsAcceptResponsePayload {
+  requestId: string;
+  status: "accepted";
+  /**
+   * Id the community assigned to the stored reciprocal credential.
+   */
+  reciprocalVcId?: string;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/accept/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsAcceptPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/accept/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsAcceptResponsePayload;

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

@@ -16,9 +16,20 @@ export interface VTCJoinRequestsApprovePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsApproveResponsePayload {
+  requestId: string;
+  status: "approved";
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/approve/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsApprovePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/approve/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsApproveResponsePayload;

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

@@ -24,9 +24,26 @@ export interface VTCJoinRequestsDecidePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * The success response to a vtc/join-requests/decide request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/join-requests/decide/0.1#response.
+ */
+export interface VTCJoinRequestsDecideResponsePayload {
+  requestId: string;
+  /**
+   * The request's post-decision state; echoes the decision.
+   */
+  status: "approved" | "rejected";
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/decide/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsDecidePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/decide/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsDecideResponsePayload;

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

@@ -24,9 +24,52 @@ export interface VTCJoinRequestsListPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsListResponsePayload {
+  items: JoinRequest[];
+  nextCursor?: string | null;
+  totalEstimate?: number | null;
+  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/list/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsListPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsListResponsePayload;

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

@@ -12,9 +12,27 @@ export interface VTCJoinRequestsManifestPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsManifestResponsePayload {
+  communityDid: string;
+  criteria: {
+    id: string;
+    description?: string;
+    /**
+     * The presentation-definition an applicant must satisfy for this criterion (opaque here).
+     */
+    presentationDefinition: {};
+  }[];
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/manifest/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsManifestPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/manifest/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsManifestResponsePayload;

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

@@ -20,9 +20,20 @@ export interface VTCJoinRequestsRejectPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCJoinRequestsRejectResponsePayload {
+  requestId: string;
+  status: "rejected";
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/reject/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsRejectPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/reject/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsRejectResponsePayload;