@openvtc/trust-tasks 0.14.2 → 0.16.0

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

@@ -3,95 +3,25 @@
  * Source: specs/vtc/config/export/0.1/payload.schema.json
  */
 
+import type { CommunityProfileSnapshot, ConfigExportDocument, Ext, PersonhoodGovernance } from "../../../../_shared/components.js";
+
+
 /**
  * Export a community's portable configuration — its profile and its stored configuration overrides — as one document. Takes no parameters: a partial export is not portable, so there is nothing to select.
  */
 export interface VTCConfigExportPayload {
   ext?: Ext;
 }
-/**
- * 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.
- */
-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.
+   * The portable configuration document, ready to feed back to vtc/config/import.
    */
-  configOverrides: {
-    [k: string]: unknown | undefined;
-  };
+  document: ConfigExportDocument;
   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;
-  /**
-   * The community's declared relationship-identifier default, as defined on `CommunityProfile` in the `vtc/_shared/0.1/community` schema. Carried in a config export so a restore reproduces the declaration rather than silently reverting it to the implementation default.
-   */
-  relationshipIdentifierDefault?: "attributed" | "pairwise";
-  personhood?: PersonhoodGovernance;
-  /**
-   * Opaque community-defined extension bag.
-   */
-  extensions?: {};
-  /**
-   * When the community was created. Provenance only — an import never writes it.
-   */
-  createdAt?: string;
-}
-/**
- * The community's published personhood position, carried so an export restores it. Governance state, not runtime state — unlike `registryStatus`, which is deliberately absent here because reachability belongs to a running maintainer rather than to exported state.
- */
-export interface PersonhoodGovernance {
-  /**
-   * Governance requires that members are real humans. Defaults to `false` when absent: a community that has not considered the question asserts nothing, which is the only safe default for a claim a verifier may rely on.
-   */
-  realHuman?: boolean;
-  /**
-   * Governance requires that each person holds at most one membership in **this** community. Per-community by definition — the glossary says "exactly one membership in that VTC" — so a single community can satisfy it without any network above it.
-   */
-  singleMembership?: boolean;
-  /**
-   * DIDs of the identity-verification providers whose credentials this community accepts as personhood evidence. A community that vets its own members in person lists its own community DID here — it is acting as its own IDVP, which §IDVC permits. An empty list means no list has been published, not that everything is accepted.
-   */
-  acceptedIdvps?: string[];
-  /**
-   * Where the governance framework these assertions refer to can be read.
-   */
-  governanceFrameworkUrl?: string | null;
-}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CommunityProfileSnapshot, ConfigExportDocument, Ext, PersonhoodGovernance };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/config/export/0.1" as const;
@@ -210,10 +140,12 @@ export const PAYLOAD_SCHEMA = {
         },
         "name": {
           "type": "string",
-          "minLength": 1
+          "minLength": 1,
+          "maxLength": 256
         },
         "description": {
-          "type": "string"
+          "type": "string",
+          "maxLength": 1024
         },
         "logoUrl": {
           "type": [
@@ -384,10 +316,12 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         },
         "name": {
           "type": "string",
-          "minLength": 1
+          "minLength": 1,
+          "maxLength": 256
         },
         "description": {
-          "type": "string"
+          "type": "string",
+          "maxLength": 1024
         },
         "logoUrl": {
           "type": [
@@ -481,6 +415,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -494,5 +429,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;

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

@@ -3,10 +3,16 @@
  * Source: specs/vtc/config/import/0.1/payload.schema.json
  */
 
+import type { CommunityProfileSnapshot, ConfigExportDocument, ConfigFieldChange, Ext, PersonhoodGovernance, RejectedKey } from "../../../../_shared/components.js";
+
+
 /**
  * Apply a portable configuration document to this community, or preview what applying it would change. Defaults to a preview.
  */
 export interface VTCConfigImportPayload {
+  /**
+   * The document returned by `vtc/config/export`.
+   */
   document: ConfigExportDocument;
   /**
    * `false` (default) previews: the diff is computed and returned, nothing is written. `true` applies it. The preview and the apply return the same shape, so an operator UX can render one and then re-submit.
@@ -14,85 +20,6 @@ export interface VTCConfigImportPayload {
   confirm?: boolean;
   ext?: Ext;
 }
-/**
- * The document returned by `vtc/config/export`.
- */
-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;
-  /**
-   * The community's declared relationship-identifier default, as defined on `CommunityProfile` in the `vtc/_shared/0.1/community` schema. Carried in a config export so a restore reproduces the declaration rather than silently reverting it to the implementation default.
-   */
-  relationshipIdentifierDefault?: "attributed" | "pairwise";
-  personhood?: PersonhoodGovernance;
-  /**
-   * Opaque community-defined extension bag.
-   */
-  extensions?: {};
-  /**
-   * When the community was created. Provenance only — an import never writes it.
-   */
-  createdAt?: string;
-}
-/**
- * The community's published personhood position, carried so an export restores it. Governance state, not runtime state — unlike `registryStatus`, which is deliberately absent here because reachability belongs to a running maintainer rather than to exported state.
- */
-export interface PersonhoodGovernance {
-  /**
-   * Governance requires that members are real humans. Defaults to `false` when absent: a community that has not considered the question asserts nothing, which is the only safe default for a claim a verifier may rely on.
-   */
-  realHuman?: boolean;
-  /**
-   * Governance requires that each person holds at most one membership in **this** community. Per-community by definition — the glossary says "exactly one membership in that VTC" — so a single community can satisfy it without any network above it.
-   */
-  singleMembership?: boolean;
-  /**
-   * DIDs of the identity-verification providers whose credentials this community accepts as personhood evidence. A community that vets its own members in person lists its own community DID here — it is acting as its own IDVP, which §IDVC permits. An empty list means no list has been published, not that everything is accepted.
-   */
-  acceptedIdvps?: string[];
-  /**
-   * Where the governance framework these assertions refer to can be read.
-   */
-  governanceFrameworkUrl?: string | null;
-}
-/**
- * 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.
- */
-export interface Ext {
-  [k: string]: unknown | undefined;
-}
 export interface VTCConfigImportResponsePayload {
   /**
    * `preview` when `confirm` was not set; `imported` after the document was applied.
@@ -116,39 +43,9 @@ export interface VTCConfigImportResponsePayload {
   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;
-}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CommunityProfileSnapshot, ConfigExportDocument, ConfigFieldChange, Ext, PersonhoodGovernance, RejectedKey };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/config/import/0.1" as const;
@@ -279,6 +176,7 @@ export const PAYLOAD_SCHEMA = {
         "reason": {
           "type": "string",
           "minLength": 1,
+          "maxLength": 1024,
           "description": "Why the key was rejected — unknown key, wrong type, out-of-range, allowlist mismatch, etc."
         }
       }
@@ -361,10 +259,12 @@ export const PAYLOAD_SCHEMA = {
         },
         "name": {
           "type": "string",
-          "minLength": 1
+          "minLength": 1,
+          "maxLength": 256
         },
         "description": {
-          "type": "string"
+          "type": "string",
+          "maxLength": 1024
         },
         "logoUrl": {
           "type": [
@@ -535,6 +435,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "reason": {
           "type": "string",
           "minLength": 1,
+          "maxLength": 1024,
           "description": "Why the key was rejected — unknown key, wrong type, out-of-range, allowlist mismatch, etc."
         }
       }
@@ -617,10 +518,12 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         },
         "name": {
           "type": "string",
-          "minLength": 1
+          "minLength": 1,
+          "maxLength": 256
         },
         "description": {
-          "type": "string"
+          "type": "string",
+          "maxLength": 1024
         },
         "logoUrl": {
           "type": [
@@ -714,6 +617,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: true,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -727,5 +631,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: true,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;

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

@@ -3,6 +3,9 @@
  * Source: specs/vtc/directory/query/0.1/payload.schema.json
  */
 
+import type { Ext } from "../../../../_shared/components.js";
+
+
 export interface VTCDirectoryQueryPayload {
   /**
    * DID of the member whose directory projection is requested.
@@ -14,12 +17,6 @@ export interface VTCDirectoryQueryPayload {
   fields?: string;
   ext?: Ext;
 }
-/**
- * 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.
- */
-export interface Ext {
-  [k: string]: unknown | undefined;
-}
 export interface VTCDirectoryQueryResponsePayload {
   /**
    * The projected member's DID.
@@ -34,6 +31,9 @@ export interface VTCDirectoryQueryResponsePayload {
   ext?: Ext;
 }
 
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/directory/query/0.1" as const;
 
@@ -172,6 +172,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: false,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -185,5 +186,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: false,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;

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

@@ -3,6 +3,9 @@
  * Source: specs/vtc/endorsement-types/delete/0.1/payload.schema.json
  */
 
+import type { Ext } from "../../../../_shared/components.js";
+
+
 export interface VTCEndorsementTypesDeletePayload {
   /**
    * The endorsement type to delete.
@@ -10,17 +13,14 @@ export interface VTCEndorsementTypesDeletePayload {
   typeUri: string;
   ext?: Ext;
 }
-/**
- * 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.
- */
-export interface Ext {
-  [k: string]: unknown | undefined;
-}
 export interface VTCEndorsementTypesDeleteResponsePayload {
   typeUri: string;
   ext?: Ext;
 }
 
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/delete/0.1" as const;
 
@@ -141,6 +141,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: true,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -154,5 +155,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: true,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;

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

@@ -3,38 +3,22 @@
  * Source: specs/vtc/endorsement-types/list/0.1/payload.schema.json
  */
 
+import type { EndorsementType, Ext } from "../../../../_shared/components.js";
+
+
 export interface VTCEndorsementTypesListPayload {
   cursor?: string;
   limit?: number;
   ext?: Ext;
 }
-/**
- * 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.
- */
-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;
-  /**
-   * The member who registered this endorsement type. An endorsement vocabulary is community-defined and shapes what every later endorsement can claim, so who introduced a type is audit-relevant in a way its creation time alone is not.
-   */
-  createdByDid?: string;
-}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { EndorsementType, Ext };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/list/0.1" as const;
@@ -237,6 +221,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: false,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -250,5 +235,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: false,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;

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

@@ -3,6 +3,9 @@
  * Source: specs/vtc/endorsement-types/register/0.1/payload.schema.json
  */
 
+import type { EndorsementType, Ext } from "../../../../_shared/components.js";
+
+
 export interface VTCEndorsementTypesRegisterPayload {
   typeUri: string;
   description?: string;
@@ -12,32 +15,13 @@ export interface VTCEndorsementTypesRegisterPayload {
   claimSchema?: {};
   ext?: Ext;
 }
-/**
- * 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.
- */
-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;
-  /**
-   * The member who registered this endorsement type. An endorsement vocabulary is community-defined and shapes what every later endorsement can claim, so who introduced a type is audit-relevant in a way its creation time alone is not.
-   */
-  createdByDid?: string;
-}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { EndorsementType, Ext };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsement-types/register/0.1" as const;
@@ -230,6 +214,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: true,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -243,5 +228,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: true,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;

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

@@ -3,10 +3,8 @@
  * 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;
+import type { CredentialId, CredentialReference, Endorsement, Ext } from "../../../../_shared/components.js";
+
 
 export interface VTCEndorsementsIssuePayload {
   /**
@@ -27,12 +25,6 @@ export interface VTCEndorsementsIssuePayload {
   validitySeconds?: number;
   ext?: Ext;
 }
-/**
- * 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.
- */
-export interface Ext {
-  [k: string]: unknown | undefined;
-}
 export interface VTCEndorsementsIssueResponsePayload {
   endorsement: Endorsement;
   /**
@@ -41,47 +33,9 @@ export interface VTCEndorsementsIssueResponsePayload {
   credential: {};
   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: CredentialReference;
-  /**
-   * 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;
-}
-/**
- * A pointer to the issued VEC — its identifier and lifetime, not its bytes. `endorsements/issue` additionally returns the credential itself, because that is the one call whose caller has no other way to receive it.
- */
-export interface CredentialReference {
-  credentialId: CredentialId;
-  /**
-   * When the credential was minted.
-   */
-  issuedAt?: string;
-  /**
-   * When it lapses, or null when it does not.
-   */
-  expiresAt?: string | null;
-}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CredentialId, CredentialReference, Endorsement, Ext };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/issue/0.1" as const;
@@ -402,6 +356,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: true,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -415,5 +370,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: true,
   isRecipientRequired: true,
+  isIssuedAtRequired: true,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;