@openvtc/trust-tasks 0.19.13 → 0.19.15

package/src/persona/profile/put/1.0/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/persona/profile/put/1.0/payload.schema.json
  */
 
-import type { ClaimType, ExpectedVersion_PersonaV0_1 as ExpectedVersion, Ext, ProfileEntry, ProofRung, Provenance, Ulid, ValueType, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
+import type { ClaimType, ExpectedVersion_PersonaV0_1 as ExpectedVersion, Ext, ProfileEntry, ProofRung, Provenance, Slot, Ulid, ValueType, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
 
 
 /**
@@ -56,7 +56,7 @@ export interface PersonaProfilePutResponsePayload {
 }
 
 /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
-export type { ClaimType, ExpectedVersion, Ext, ProfileEntry, ProofRung, Provenance, Ulid, ValueType, Version };
+export type { ClaimType, ExpectedVersion, Ext, ProfileEntry, ProofRung, Provenance, Slot, Ulid, ValueType, Version };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/persona/profile/put/1.0" as const;
@@ -214,7 +214,7 @@ export const PAYLOAD_SCHEMA = {
     },
     "ProfileEntry": {
       "title": "ProfileEntry",
-      "description": "One line of a profile, in exactly one of four forms. Together they are the whole of a profile's flexibility, and each exists for a case the others handle badly.\n\n`{ref}` — use the pool attribute, live. Editing the pool updates every profile that references it, which is the point.\n\n`{ref, pinVersion}` — use the value as it was at that version. For a profile that must keep presenting the value a counterparty already verified.\n\n`{ref, override}` — the same fact, a different value here. (\"In the gaming profile my display name is different.\")\n\n`{inline}` — a value that never enters the pool, and so never leaks into another profile.\n\nOmission is exclusion; there is no removal marker.",
+      "description": "One line of a profile, in exactly one of four forms. Together they are the whole of a profile's flexibility, and each exists for a case the others handle badly.\n\n`{ref}` — use the pool attribute, live. Editing the pool updates every profile that references it, which is the point.\n\n`{ref, pinVersion}` — use the value as it was at that version. For a profile that must keep presenting the value a counterparty already verified.\n\n`{ref, override}` — the same fact, a different value here. (\"In the gaming profile my display name is different.\")\n\n`{inline}` — a value that never enters the pool, and so never leaks into another profile.\n\nOmission is exclusion; there is no removal marker.\n\nAny form MAY carry a `slot` naming the role the entry plays in the profile — see `Slot`. A maintainer MUST refuse a profile in which two entries carry the same slot: a slot exists to answer one question with one entry.",
       "type": "object",
       "oneOf": [
         {
@@ -225,6 +225,9 @@ export const PAYLOAD_SCHEMA = {
           "properties": {
             "ref": {
               "$ref": "#/$defs/Ulid"
+            },
+            "slot": {
+              "$ref": "#/$defs/Slot"
             }
           }
         },
@@ -240,6 +243,9 @@ export const PAYLOAD_SCHEMA = {
             },
             "pinVersion": {
               "$ref": "#/$defs/Version"
+            },
+            "slot": {
+              "$ref": "#/$defs/Slot"
             }
           }
         },
@@ -267,6 +273,9 @@ export const PAYLOAD_SCHEMA = {
                 }
               },
               "description": "Replaces the pool attribute's value for this profile only. `type`, `valueType` and `provenance` are inherited from the referenced attribute and MUST NOT be overridden — an override that changed provenance would let a self-asserted value present as attested."
+            },
+            "slot": {
+              "$ref": "#/$defs/Slot"
             }
           }
         },
@@ -301,11 +310,20 @@ export const PAYLOAD_SCHEMA = {
                   "$ref": "#/$defs/Provenance"
                 }
               }
+            },
+            "slot": {
+              "$ref": "#/$defs/Slot"
             }
           }
         }
       ]
     },
+    "Slot": {
+      "title": "Slot",
+      "type": "string",
+      "pattern": "^[a-z][A-Za-z0-9]{0,31}$",
+      "description": "A role a profile entry plays within its profile, so a consumer can find it without guessing from its claim type. A profile MAY hold several entries of one type — a legal name and a display name, two phone numbers — and only a slot says which answers a given question. Unique within a profile.\n\nWell-known slots:\n\n- `displayName` — what this face calls itself. The entry a consumer renders as the face's name to anyone it is shown to. Distinct from the profile's own `name`, which is the holder's private label and never disclosed.\n- `primaryEmail`, `primaryPhone`, `primaryAddress` — the entry to use where a counterparty asks for one of a kind and the profile holds several.\n- `avatar` — the image this face presents.\n\nOther values are the holder's or the producer's own and carry no meaning a maintainer interprets."
+    },
     "Provenance": {
       "title": "Provenance",
       "description": "Where a value comes from, and the member that makes this family worth building on a trust stack rather than in an address book. It survives to the verifier, so a recipient can tell — per field — what the holder typed from what an issuer attested.\n\n`selfAsserted` — the holder supplied it.\n\n`credentialBacked` — the value is derived from a credential in the vault at `claimPath`. The stored value is a CACHE FOR DISPLAY; the credential is the truth. A maintainer MUST re-derive it on read and MUST fail closed (never presenting a stale value) when the credential has been revoked, has expired, or has been archived or deleted.\n\n`generated` — the value is minted per verifier at disclosure time and recorded against that verifier, so every relying party receives a different one that routes back to the holder. This is the shape of the most widely adopted consumer privacy feature in this space; a maintainer need not operate a relay to conform, but the shape must exist, because retrofitting per-verifier values into a pool-of-values model is a migration rather than an addition.",
@@ -509,7 +527,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
     },
     "ProfileEntry": {
       "title": "ProfileEntry",
-      "description": "One line of a profile, in exactly one of four forms. Together they are the whole of a profile's flexibility, and each exists for a case the others handle badly.\n\n`{ref}` — use the pool attribute, live. Editing the pool updates every profile that references it, which is the point.\n\n`{ref, pinVersion}` — use the value as it was at that version. For a profile that must keep presenting the value a counterparty already verified.\n\n`{ref, override}` — the same fact, a different value here. (\"In the gaming profile my display name is different.\")\n\n`{inline}` — a value that never enters the pool, and so never leaks into another profile.\n\nOmission is exclusion; there is no removal marker.",
+      "description": "One line of a profile, in exactly one of four forms. Together they are the whole of a profile's flexibility, and each exists for a case the others handle badly.\n\n`{ref}` — use the pool attribute, live. Editing the pool updates every profile that references it, which is the point.\n\n`{ref, pinVersion}` — use the value as it was at that version. For a profile that must keep presenting the value a counterparty already verified.\n\n`{ref, override}` — the same fact, a different value here. (\"In the gaming profile my display name is different.\")\n\n`{inline}` — a value that never enters the pool, and so never leaks into another profile.\n\nOmission is exclusion; there is no removal marker.\n\nAny form MAY carry a `slot` naming the role the entry plays in the profile — see `Slot`. A maintainer MUST refuse a profile in which two entries carry the same slot: a slot exists to answer one question with one entry.",
       "type": "object",
       "oneOf": [
         {
@@ -520,6 +538,9 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
           "properties": {
             "ref": {
               "$ref": "#/$defs/Ulid"
+            },
+            "slot": {
+              "$ref": "#/$defs/Slot"
             }
           }
         },
@@ -535,6 +556,9 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
             },
             "pinVersion": {
               "$ref": "#/$defs/Version"
+            },
+            "slot": {
+              "$ref": "#/$defs/Slot"
             }
           }
         },
@@ -562,6 +586,9 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
                 }
               },
               "description": "Replaces the pool attribute's value for this profile only. `type`, `valueType` and `provenance` are inherited from the referenced attribute and MUST NOT be overridden — an override that changed provenance would let a self-asserted value present as attested."
+            },
+            "slot": {
+              "$ref": "#/$defs/Slot"
             }
           }
         },
@@ -596,11 +623,20 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
                   "$ref": "#/$defs/Provenance"
                 }
               }
+            },
+            "slot": {
+              "$ref": "#/$defs/Slot"
             }
           }
         }
       ]
     },
+    "Slot": {
+      "title": "Slot",
+      "type": "string",
+      "pattern": "^[a-z][A-Za-z0-9]{0,31}$",
+      "description": "A role a profile entry plays within its profile, so a consumer can find it without guessing from its claim type. A profile MAY hold several entries of one type — a legal name and a display name, two phone numbers — and only a slot says which answers a given question. Unique within a profile.\n\nWell-known slots:\n\n- `displayName` — what this face calls itself. The entry a consumer renders as the face's name to anyone it is shown to. Distinct from the profile's own `name`, which is the holder's private label and never disclosed.\n- `primaryEmail`, `primaryPhone`, `primaryAddress` — the entry to use where a counterparty asks for one of a kind and the profile holds several.\n- `avatar` — the image this face presents.\n\nOther values are the holder's or the producer's own and carry no meaning a maintainer interprets."
+    },
     "Provenance": {
       "title": "Provenance",
       "description": "Where a value comes from, and the member that makes this family worth building on a trust stack rather than in an address book. It survives to the verifier, so a recipient can tell — per field — what the holder typed from what an issuer attested.\n\n`selfAsserted` — the holder supplied it.\n\n`credentialBacked` — the value is derived from a credential in the vault at `claimPath`. The stored value is a CACHE FOR DISPLAY; the credential is the truth. A maintainer MUST re-derive it on read and MUST fail closed (never presenting a stale value) when the credential has been revoked, has expired, or has been archived or deleted.\n\n`generated` — the value is minted per verifier at disclosure time and recorded against that verifier, so every relying party receives a different one that routes back to the holder. This is the shape of the most widely adopted consumer privacy feature in this space; a maintainer need not operate a relay to conform, but the shape must exist, because retrofitting per-verifier values into a pool-of-values model is a migration rather than an addition.",

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

@@ -218,6 +218,31 @@ export const PAYLOAD_SCHEMA = {
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
+        },
+        "attributes": {
+          "type": "array",
+          "maxItems": 32,
+          "description": "What the applicant told the community about themselves in answer to the manifest's `requestedAttributes` — self-asserted, and to be shown as such to whoever reviews the request. Absent when none were asked for or given.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "value"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+                "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+              },
+              "value": {
+                "description": "The value the applicant gives. Self-asserted: the applicant's own statement, bound to them by the document proof, and attested by nobody."
+              }
+            }
+          }
         }
       }
     }
@@ -362,6 +387,31 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
+        },
+        "attributes": {
+          "type": "array",
+          "maxItems": 32,
+          "description": "What the applicant told the community about themselves in answer to the manifest's `requestedAttributes` — self-asserted, and to be shown as such to whoever reviews the request. Absent when none were asked for or given.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "value"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+                "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+              },
+              "value": {
+                "description": "The value the applicant gives. Self-asserted: the applicant's own statement, bound to them by the document proof, and attested by nobody."
+              }
+            }
+          }
         }
       }
     }

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

@@ -20,6 +20,25 @@ export interface VTCJoinRequestsManifestPayload {
 export interface VTCJoinRequestsManifestResponsePayload {
   communityDid: string;
   criteria: Criterion[];
+  /**
+   * What the community asks an applicant to tell it about themselves, as claim types — never values. Answered in persona terms: the applicant's agent discloses those attributes from the face the applicant chooses, and they arrive on vtc/join-requests/submit as `attributes`. SELF-ASSERTED: a community MUST NOT describe an answer as verified, and MUST NOT make a decision that assumes it is. Outside every criterion, so no `requirementsDigest` covers it. Absent when the community asks nothing.
+   *
+   * @maxItems 32
+   */
+  requestedAttributes?: {
+    /**
+     * A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token.
+     */
+    type: string;
+    /**
+     * False for an attribute the applicant may decline. A submission missing a required one is refused with vtc/join-requests/submit:attributesMissing.
+     */
+    required?: boolean;
+    /**
+     * Why the community asks, in words shown to the applicant before they disclose.
+     */
+    purpose?: string;
+  }[];
   branding?: CommunityBranding;
   ext?: Ext;
 }
@@ -408,6 +427,37 @@ export const PAYLOAD_SCHEMA = {
             "$ref": "#/$defs/Criterion"
           }
         },
+        "requestedAttributes": {
+          "type": "array",
+          "maxItems": 32,
+          "description": "What the community asks an applicant to tell it about themselves, as claim types — never values. Answered in persona terms: the applicant's agent discloses those attributes from the face the applicant chooses, and they arrive on vtc/join-requests/submit as `attributes`. SELF-ASSERTED: a community MUST NOT describe an answer as verified, and MUST NOT make a decision that assumes it is. Outside every criterion, so no `requirementsDigest` covers it. Absent when the community asks nothing.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+                "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+              },
+              "required": {
+                "type": "boolean",
+                "default": true,
+                "description": "False for an attribute the applicant may decline. A submission missing a required one is refused with vtc/join-requests/submit:attributesMissing."
+              },
+              "purpose": {
+                "type": "string",
+                "maxLength": 256,
+                "description": "Why the community asks, in words shown to the applicant before they disclose."
+              }
+            }
+          }
+        },
         "branding": {
           "$ref": "#/$defs/CommunityBranding"
         },
@@ -716,6 +766,37 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
             "$ref": "#/$defs/Criterion"
           }
         },
+        "requestedAttributes": {
+          "type": "array",
+          "maxItems": 32,
+          "description": "What the community asks an applicant to tell it about themselves, as claim types — never values. Answered in persona terms: the applicant's agent discloses those attributes from the face the applicant chooses, and they arrive on vtc/join-requests/submit as `attributes`. SELF-ASSERTED: a community MUST NOT describe an answer as verified, and MUST NOT make a decision that assumes it is. Outside every criterion, so no `requirementsDigest` covers it. Absent when the community asks nothing.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+                "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+              },
+              "required": {
+                "type": "boolean",
+                "default": true,
+                "description": "False for an attribute the applicant may decline. A submission missing a required one is refused with vtc/join-requests/submit:attributesMissing."
+              },
+              "purpose": {
+                "type": "string",
+                "maxLength": 256,
+                "description": "Why the community asks, in words shown to the applicant before they disclose."
+              }
+            }
+          }
+        },
         "branding": {
           "$ref": "#/$defs/CommunityBranding"
         },

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

@@ -180,6 +180,31 @@ export const PAYLOAD_SCHEMA = {
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
+        },
+        "attributes": {
+          "type": "array",
+          "maxItems": 32,
+          "description": "What the applicant told the community about themselves in answer to the manifest's `requestedAttributes` — self-asserted, and to be shown as such to whoever reviews the request. Absent when none were asked for or given.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "value"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+                "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+              },
+              "value": {
+                "description": "The value the applicant gives. Self-asserted: the applicant's own statement, bound to them by the document proof, and attested by nobody."
+              }
+            }
+          }
         }
       }
     }
@@ -309,6 +334,31 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
+        },
+        "attributes": {
+          "type": "array",
+          "maxItems": 32,
+          "description": "What the applicant told the community about themselves in answer to the manifest's `requestedAttributes` — self-asserted, and to be shown as such to whoever reviews the request. Absent when none were asked for or given.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "value"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+                "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+              },
+              "value": {
+                "description": "The value the applicant gives. Self-asserted: the applicant's own statement, bound to them by the document proof, and attested by nobody."
+              }
+            }
+          }
         }
       }
     }

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

@@ -19,6 +19,23 @@ export interface VTCJoinRequestsSubmitPayload {
    * Opaque applicant-supplied extension bag.
    */
   extensions?: {};
+  /**
+   * The applicant's answers to the manifest's `requestedAttributes`: one entry per attribute given. Self-asserted and bound to the applicant by the document proof. A maintainer MUST refuse the submission with `attributesMissing` when a required attribute is absent and with `attributesUnrequested` when an entry names a type the manifest does not request.
+   *
+   * @maxItems 32
+   */
+  attributes?: {
+    /**
+     * A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token.
+     */
+    type: string;
+    /**
+     * The value the applicant gives. Self-asserted: the applicant's own statement, bound to them by the document proof, and attested by nobody.
+     */
+    value: {
+      [k: string]: unknown | undefined;
+    };
+  }[];
   ext?: Ext;
 }
 export interface VTCJoinRequestsSubmitResponsePayload {
@@ -81,6 +98,31 @@ export const PAYLOAD_SCHEMA = {
       "type": "object",
       "description": "Opaque applicant-supplied extension bag."
     },
+    "attributes": {
+      "type": "array",
+      "maxItems": 32,
+      "description": "The applicant's answers to the manifest's `requestedAttributes`: one entry per attribute given. Self-asserted and bound to the applicant by the document proof. A maintainer MUST refuse the submission with `attributesMissing` when a required attribute is absent and with `attributesUnrequested` when an entry names a type the manifest does not request.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "value"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128,
+            "pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
+            "description": "A claim-type token from the persona claim-type registry (persona/_shared/0.1/CLAIM-TYPES.md) — `name.display`, `address.country` — or an `x:` extension token."
+          },
+          "value": {
+            "description": "The value the applicant gives. Self-asserted: the applicant's own statement, bound to them by the document proof, and attested by nobody."
+          }
+        }
+      }
+    },
     "ext": {
       "$ref": "#/$defs/Ext"
     }