@openvtc/trust-tasks 0.2.55 → 0.2.56

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

@@ -16,9 +16,22 @@ export interface VTCAdminInvitesRevokePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCAdminInvitesRevokeResponsePayload {
+  /**
+   * The revoked invite's identifier, echoed.
+   */
+  jti: string;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/revoke/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAdminInvitesRevokePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/revoke/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAdminInvitesRevokeResponsePayload;

package/src/vtc/auth/admin-session/0.1/payload.ts

@@ -16,9 +16,26 @@ export interface VTCAuthAdminSessionPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCAuthAdminSessionResponsePayload {
+  /**
+   * The cookie-backed session's identifier.
+   */
+  sessionId: string;
+  /**
+   * Session expiry as a Unix timestamp. Matches the presented token's — the exchange does not extend a session.
+   */
+  expiresAt: number;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/auth/admin-session/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAuthAdminSessionPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/auth/admin-session/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAuthAdminSessionResponsePayload;

package/src/vtc/auth/recognise/0.1/payload.ts

@@ -20,9 +20,34 @@ export interface VTCAuthRecognisePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCAuthRecogniseResponsePayload {
+  /**
+   * A cross-community session id (xc-<uuid>), distinguishing it from local-member sessions.
+   */
+  sessionId: string;
+  data: {
+    accessToken: string;
+    /**
+     * Unix-seconds expiry, clamped to min(local default, earliest of the vec/vmc validUntil).
+     */
+    accessExpiresAt: number;
+    foreignIssuerDid: string;
+    /**
+     * The LOCAL role from cross_community_roles policy — not the foreign role.
+     */
+    mappedRole: string;
+  };
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/auth/recognise/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAuthRecognisePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/auth/recognise/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAuthRecogniseResponsePayload;

package/src/vtc/auth/recognise/challenge/0.1/payload.ts

@@ -12,9 +12,26 @@ export interface VTCAuthRecogniseChallengePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCAuthRecogniseChallengeResponsePayload {
+  /**
+   * Single-use, unpredictable value to bind into the presentation. Consumed on first use regardless of verdict.
+   */
+  nonce: string;
+  /**
+   * Unix timestamp after which the nonce is refused.
+   */
+  expiresAt: number;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/auth/recognise/challenge/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAuthRecogniseChallengePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/auth/recognise/challenge/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAuthRecogniseChallengeResponsePayload;

package/src/vtc/backup/export/0.1/payload.ts

@@ -20,9 +20,86 @@ export interface VTCBackupExportPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCBackupExportResponsePayload {
+  envelope: BackupEnvelope;
+  ext?: Ext;
+}
+/**
+ * The encrypted full-state backup.
+ */
+export interface BackupEnvelope {
+  /**
+   * Envelope schema version.
+   */
+  version: number;
+  /**
+   * Envelope format tag, e.g. `vtc-backup-v1`.
+   */
+  format: string;
+  /**
+   * When the export was taken.
+   */
+  createdAt: string;
+  /**
+   * DID of the community exported from, when it has one. An import cross-checks this against the running community.
+   */
+  sourceDid?: string | null;
+  /**
+   * Version of the software that produced the envelope.
+   */
+  sourceVersion: string;
+  kdf: KdfParams;
+  encryption: EncryptionParams;
+  /**
+   * Whether the audit log and its signed checkpoints are inside `ciphertext`.
+   */
+  includesAudit: boolean;
+  /**
+   * base64url(AEAD(JSON(payload))).
+   */
+  ciphertext: string;
+}
+export interface KdfParams {
+  /**
+   * KDF identifier, e.g. `argon2id`.
+   */
+  algorithm: string;
+  /**
+   * base64url, 32 bytes.
+   */
+  salt: string;
+  /**
+   * Argon2id memory cost (KiB).
+   */
+  mCost: number;
+  /**
+   * Argon2id time cost (iterations).
+   */
+  tCost: number;
+  /**
+   * Argon2id parallelism.
+   */
+  pCost: number;
+}
+export interface EncryptionParams {
+  /**
+   * AEAD identifier, e.g. `aes-256-gcm`.
+   */
+  algorithm: string;
+  /**
+   * base64url, 12 bytes.
+   */
+  nonce: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/backup/export/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCBackupExportPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/backup/export/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBackupExportResponsePayload;

package/src/vtc/backup/import/0.1/payload.ts

@@ -88,9 +88,36 @@ export interface EncryptionParams {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCBackupImportResponsePayload {
+  /**
+   * `preview` when `confirm` was not set; `imported` after a restore.
+   */
+  status: "preview" | "imported";
+  /**
+   * The community DID the envelope was taken from.
+   */
+  sourceDid?: string | null;
+  /**
+   * Per-keyspace row counts written, or that would be written on a preview.
+   */
+  counts: {
+    [k: string]: number | undefined;
+  };
+  /**
+   * Human-readable summary for the operator.
+   */
+  message: string;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/backup/import/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCBackupImportPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/backup/import/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBackupImportResponsePayload;

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

@@ -12,9 +12,52 @@ export interface VTCCeremoniesListPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCCeremoniesListResponsePayload {
+  /**
+   * Every ceremony this maintainer implements.
+   */
+  ceremonies: CeremonyManifest[];
+  ext?: Ext;
+}
+export interface CeremonyManifest {
+  /**
+   * Governance purpose this ceremony decides, e.g. join, removal.
+   */
+  purpose: string;
+  /**
+   * Policy package backing the decision.
+   */
+  pkg?: string;
+  /**
+   * Whether the ceremony is automatic, operator-driven, or advisory.
+   */
+  nature: string;
+  /**
+   * Human-readable name for an operator UI.
+   */
+  label: string;
+  /**
+   * Whether the ceremony is actually reachable in this deployment.
+   */
+  wired?: string;
+  /**
+   * One-line explanation shown beside the label.
+   */
+  blurb?: string;
+  /**
+   * Field definitions the UI renders. An unrecognised field type MUST render generically, never be dropped.
+   */
+  fields?: {}[];
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/ceremonies/list/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCCeremoniesListPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/ceremonies/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCCeremoniesListResponsePayload;

package/src/vtc/community/profile/show/0.1/payload.ts

@@ -12,9 +12,35 @@ export interface VTCCommunityProfileShowPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCCommunityProfileShowResponsePayload {
+  profile: CommunityProfile;
+  ext?: Ext;
+}
+export interface CommunityProfile {
+  name: string;
+  description?: string;
+  logoUrl?: string | null;
+  publicUrl?: string | null;
+  contactEmail?: string | null;
+  language: string;
+  /**
+   * Opaque community-defined extension bag.
+   */
+  extensions?: {};
+  /**
+   * Trust-registry reachability. Populated on reads; not settable.
+   */
+  registryStatus?: "active" | "degraded";
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/community/profile/show/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCCommunityProfileShowPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/community/profile/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCCommunityProfileShowResponsePayload;

package/src/vtc/community/profile/update/0.1/payload.ts

@@ -22,9 +22,35 @@ export interface VTCCommunityProfileUpdatePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCCommunityProfileUpdateResponsePayload {
+  profile: CommunityProfile;
+  ext?: Ext;
+}
+export interface CommunityProfile {
+  name: string;
+  description?: string;
+  logoUrl?: string | null;
+  publicUrl?: string | null;
+  contactEmail?: string | null;
+  language: string;
+  /**
+   * Opaque community-defined extension bag.
+   */
+  extensions?: {};
+  /**
+   * Trust-registry reachability. Populated on reads; not settable.
+   */
+  registryStatus?: "active" | "degraded";
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/community/profile/update/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCCommunityProfileUpdatePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/community/profile/update/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCCommunityProfileUpdateResponsePayload;

package/src/vtc/config/export/0.1/payload.ts

@@ -15,9 +15,66 @@ export interface VTCConfigExportPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCConfigExportResponsePayload {
+  document: ConfigExportDocument;
+  ext?: Ext;
+}
+/**
+ * The portable configuration document, ready to feed back to vtc/config/import.
+ */
+export interface ConfigExportDocument {
+  /**
+   * Version of this document's own shape. Not redundant with the Type URI version: once the document is written to a file it is bare JSON with no envelope, and this is the only thing a later reader has to check it against. A consumer MUST reject a version it does not implement rather than guess.
+   */
+  schemaVersion: number;
+  /**
+   * When the export was taken. Provenance for the operator; a consumer does not act on it.
+   */
+  exportedAt: string;
+  communityProfile?: CommunityProfileSnapshot;
+  /**
+   * Stored configuration overrides as `key → value`, keyed by the maintainer's own configuration registry (the same keys `config/show` and `config/patch` use). An empty object is valid and means no overrides are set.
+   */
+  configOverrides: {
+    [k: string]: unknown | undefined;
+  };
+  ext?: Ext;
+}
+/**
+ * The community's profile at export time. Absent when the community has no profile yet — a maintainer exported before bootstrap.
+ */
+export interface CommunityProfileSnapshot {
+  /**
+   * DID of the community this document was taken from. Immutable, set at install.
+   */
+  communityDid: string;
+  name: string;
+  description?: string;
+  logoUrl?: string | null;
+  publicUrl?: string | null;
+  contactEmail?: string | null;
+  /**
+   * BCP 47 language tag.
+   */
+  language: string;
+  /**
+   * Opaque community-defined extension bag.
+   */
+  extensions?: {};
+  /**
+   * When the community was created. Provenance only — an import never writes it.
+   */
+  createdAt?: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/config/export/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCConfigExportPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/config/export/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCConfigExportResponsePayload;

package/src/vtc/config/import/0.1/payload.ts

@@ -67,9 +67,71 @@ export interface CommunityProfileSnapshot {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCConfigImportResponsePayload {
+  /**
+   * `preview` when `confirm` was not set; `imported` after the document was applied.
+   */
+  status: "preview" | "imported";
+  /**
+   * Community-profile members that differ from what is in force. Empty when the document omits `communityProfile`, or when nothing differs. On `imported` these are the changes that were written.
+   */
+  profileChanges: ConfigFieldChange[];
+  /**
+   * Configuration-override keys that differ from what is in force. Rejected keys are not listed here — they appear under `rejected`. On `imported` these are the changes that were written.
+   */
+  overrideChanges: ConfigFieldChange[];
+  /**
+   * Applied keys whose new value takes effect only after a restart. Reported on a preview too, so an operator learns before confirming that the import implies downtime.
+   */
+  pendingRestart?: string[];
+  /**
+   * Keys the consumer declined — unknown to its configuration registry, wrong type, out of range. Reported identically on preview and apply, so a preview surfaces every rejection before anything is written.
+   */
+  rejected: RejectedKey[];
+  ext?: Ext;
+}
+/**
+ * One field an import would change, or did.
+ *
+ * `oldValue` is absent when the field is not currently set — no profile yet, or no stored override for that key. `newValue` is absent when the imported document omits the field, which means "leave the live value alone" rather than "clear it"; a caller that intends to clear a nullable member sends an explicit `null`, which appears here as `newValue: null`. The two are different requests and a consumer MUST NOT conflate them.
+ */
+export interface ConfigFieldChange {
+  /**
+   * The profile member or configuration key, e.g. `name` or `log.level`.
+   */
+  key: string;
+  /**
+   * Value in force before the import. Absent when the field is unset.
+   */
+  oldValue?: {
+    [k: string]: unknown | undefined;
+  };
+  /**
+   * Value the imported document carries. Absent when the document omits the field.
+   */
+  newValue?: {
+    [k: string]: unknown | undefined;
+  };
+}
+/**
+ * A key a patch declined to apply, with the reason.
+ */
+export interface RejectedKey {
+  key: string;
+  /**
+   * Why the key was rejected — unknown key, wrong type, out-of-range, allowlist mismatch, etc.
+   */
+  reason: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/config/import/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCConfigImportPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/config/import/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCConfigImportResponsePayload;

package/src/vtc/directory/query/0.1/payload.ts

@@ -20,9 +20,28 @@ export interface VTCDirectoryQueryPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCDirectoryQueryResponsePayload {
+  /**
+   * The projected member's DID.
+   */
+  subject: string;
+  /**
+   * The permitted projection. A withheld field is ABSENT, never present-and-null.
+   */
+  fields: {
+    [k: string]: unknown | undefined;
+  };
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/directory/query/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCDirectoryQueryPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/directory/query/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCDirectoryQueryResponsePayload;

package/src/vtc/endorsement-types/delete/0.1/payload.ts

@@ -16,9 +16,19 @@ export interface VTCEndorsementTypesDeletePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCEndorsementTypesDeleteResponsePayload {
+  typeUri: string;
+  ext?: Ext;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/delete/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCEndorsementTypesDeletePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/delete/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCEndorsementTypesDeleteResponsePayload;

package/src/vtc/endorsement-types/list/0.1/payload.ts

@@ -14,9 +14,32 @@ export interface VTCEndorsementTypesListPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCEndorsementTypesListResponsePayload {
+  items: EndorsementType[];
+  nextCursor?: string | null;
+  ext?: Ext;
+}
+export interface EndorsementType {
+  /**
+   * The endorsement type's URI. Community-scoped; workspace-reserved URIs (e.g. CommunityRole) are refused at registration.
+   */
+  typeUri: string;
+  description?: string;
+  /**
+   * Optional JSON Schema the endorsement's claims must satisfy (opaque here).
+   */
+  claimSchema?: {};
+  createdAt?: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/list/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCEndorsementTypesListPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCEndorsementTypesListResponsePayload;

package/src/vtc/endorsement-types/register/0.1/payload.ts

@@ -18,9 +18,31 @@ export interface VTCEndorsementTypesRegisterPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+export interface VTCEndorsementTypesRegisterResponsePayload {
+  endorsementType: EndorsementType;
+  ext?: Ext;
+}
+export interface EndorsementType {
+  /**
+   * The endorsement type's URI. Community-scoped; workspace-reserved URIs (e.g. CommunityRole) are refused at registration.
+   */
+  typeUri: string;
+  description?: string;
+  /**
+   * Optional JSON Schema the endorsement's claims must satisfy (opaque here).
+   */
+  claimSchema?: {};
+  createdAt?: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/register/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCEndorsementTypesRegisterPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/register/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCEndorsementTypesRegisterResponsePayload;