@openvtc/trust-tasks 0.19.14 → 0.19.16

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"
     }