@openvtc/trust-tasks 0.26.18 → 0.26.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +87 -0
- package/dist/_shared/components.d.ts +113 -1
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -0
- package/dist/index.js.map +1 -1
- package/dist/rooms/owner/group/add/0.3/payload.d.ts +417 -0
- package/dist/rooms/owner/group/add/0.3/payload.d.ts.map +1 -0
- package/dist/rooms/owner/group/add/0.3/payload.js +218 -0
- package/dist/rooms/owner/group/add/0.3/payload.js.map +1 -0
- package/dist/rooms/owner/group/renew/0.2/payload.d.ts +299 -0
- package/dist/rooms/owner/group/renew/0.2/payload.d.ts.map +1 -0
- package/dist/rooms/owner/group/renew/0.2/payload.js +163 -0
- package/dist/rooms/owner/group/renew/0.2/payload.js.map +1 -0
- package/dist/vtc/directory/_shared/0.1/directory-card.d.ts +1 -1
- package/dist/vtc/directory/_shared/0.1/directory-card.d.ts.map +1 -1
- package/dist/vtc/directory/_shared/0.1/disclosure-statement.d.ts +18 -0
- package/dist/vtc/directory/_shared/0.1/disclosure-statement.d.ts.map +1 -0
- package/dist/vtc/directory/_shared/0.1/disclosure-statement.js +6 -0
- package/dist/vtc/directory/_shared/0.1/disclosure-statement.js.map +1 -0
- package/dist/vtc/directory/card/assert/0.1/payload.d.ts +4 -4
- package/dist/vtc/directory/card/assert/0.1/payload.js +2 -2
- package/dist/vtc/directory/card/assert/0.1/payload.js.map +1 -1
- package/dist/vtc/directory/card/public/0.1/payload.d.ts +348 -0
- package/dist/vtc/directory/card/public/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/directory/card/public/0.1/payload.js +197 -0
- package/dist/vtc/directory/card/public/0.1/payload.js.map +1 -0
- package/dist/vtc/directory/card/publish/0.1/payload.d.ts +384 -0
- package/dist/vtc/directory/card/publish/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/directory/card/publish/0.1/payload.js +222 -0
- package/dist/vtc/directory/card/publish/0.1/payload.js.map +1 -0
- package/dist/vtc/directory/card/show/0.1/payload.d.ts +138 -6
- package/dist/vtc/directory/card/show/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/directory/card/show/0.1/payload.js +82 -2
- package/dist/vtc/directory/card/show/0.1/payload.js.map +1 -1
- package/dist/vtc/directory/card/update/0.1/payload.d.ts +138 -6
- package/dist/vtc/directory/card/update/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/directory/card/update/0.1/payload.js +82 -2
- package/dist/vtc/directory/card/update/0.1/payload.js.map +1 -1
- package/dist/vtc/directory/disclosure/0.1/payload.d.ts +951 -0
- package/dist/vtc/directory/disclosure/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/directory/disclosure/0.1/payload.js +613 -0
- package/dist/vtc/directory/disclosure/0.1/payload.js.map +1 -0
- package/dist/vtc/directory/entries/list/0.1/payload.d.ts +4 -4
- package/dist/vtc/directory/entries/list/0.1/payload.js +2 -2
- package/dist/vtc/directory/entries/list/0.1/payload.js.map +1 -1
- package/dist/vtc/directory/entries/show/0.1/payload.d.ts +4 -4
- package/dist/vtc/directory/entries/show/0.1/payload.js +2 -2
- package/dist/vtc/directory/entries/show/0.1/payload.js.map +1 -1
- package/dist/vtc/directory/images/get/0.1/payload.d.ts +484 -0
- package/dist/vtc/directory/images/get/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/directory/images/get/0.1/payload.js +273 -0
- package/dist/vtc/directory/images/get/0.1/payload.js.map +1 -0
- package/dist/vtc/directory/images/upload/0.1/payload.d.ts +441 -0
- package/dist/vtc/directory/images/upload/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/directory/images/upload/0.1/payload.js +262 -0
- package/dist/vtc/directory/images/upload/0.1/payload.js.map +1 -0
- package/dist/vtc/directory/introduction/0.1/payload.d.ts +2 -2
- package/dist/vtc/directory/introduction/0.1/payload.js +1 -1
- package/dist/vtc/directory/introduction/0.1/payload.js.map +1 -1
- package/dist/vtc/groups/join/0.1/payload.d.ts +4 -4
- package/dist/vtc/groups/join/0.1/payload.js +2 -2
- package/dist/vtc/groups/join/0.1/payload.js.map +1 -1
- package/dist/vtc/groups/members/add/0.1/payload.d.ts +4 -4
- package/dist/vtc/groups/members/add/0.1/payload.js +2 -2
- package/dist/vtc/groups/members/add/0.1/payload.js.map +1 -1
- package/dist/vtc/groups/members/list/0.1/payload.d.ts +4 -4
- package/dist/vtc/groups/members/list/0.1/payload.js +2 -2
- package/dist/vtc/groups/members/list/0.1/payload.js.map +1 -1
- package/dist/vtc/groups/requests/decide/0.1/payload.d.ts +4 -4
- package/dist/vtc/groups/requests/decide/0.1/payload.js +2 -2
- package/dist/vtc/groups/requests/decide/0.1/payload.js.map +1 -1
- package/dist/vtc/groups/requests/list/0.1/payload.d.ts +4 -4
- package/dist/vtc/groups/requests/list/0.1/payload.js +2 -2
- package/dist/vtc/groups/requests/list/0.1/payload.js.map +1 -1
- package/dist/vtc/join-requests/manifest/0.4/payload.d.ts +2303 -0
- package/dist/vtc/join-requests/manifest/0.4/payload.d.ts.map +1 -0
- package/dist/vtc/join-requests/manifest/0.4/payload.js +1293 -0
- package/dist/vtc/join-requests/manifest/0.4/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_shared/components.ts +113 -1
- package/src/index.ts +9 -0
- package/src/rooms/owner/group/add/0.3/payload.ts +288 -0
- package/src/rooms/owner/group/renew/0.2/payload.ts +213 -0
- package/src/vtc/directory/_shared/0.1/directory-card.ts +1 -1
- package/src/vtc/directory/_shared/0.1/disclosure-statement.ts +19 -0
- package/src/vtc/directory/card/assert/0.1/payload.ts +2 -2
- package/src/vtc/directory/card/public/0.1/payload.ts +238 -0
- package/src/vtc/directory/card/publish/0.1/payload.ts +261 -0
- package/src/vtc/directory/card/show/0.1/payload.ts +84 -4
- package/src/vtc/directory/card/update/0.1/payload.ts +84 -4
- package/src/vtc/directory/disclosure/0.1/payload.ts +645 -0
- package/src/vtc/directory/entries/list/0.1/payload.ts +2 -2
- package/src/vtc/directory/entries/show/0.1/payload.ts +2 -2
- package/src/vtc/directory/images/get/0.1/payload.ts +320 -0
- package/src/vtc/directory/images/upload/0.1/payload.ts +308 -0
- package/src/vtc/directory/introduction/0.1/payload.ts +1 -1
- package/src/vtc/groups/join/0.1/payload.ts +2 -2
- package/src/vtc/groups/members/add/0.1/payload.ts +2 -2
- package/src/vtc/groups/members/list/0.1/payload.ts +2 -2
- package/src/vtc/groups/requests/decide/0.1/payload.ts +2 -2
- package/src/vtc/groups/requests/list/0.1/payload.ts +2 -2
- package/src/vtc/join-requests/manifest/0.4/payload.ts +1490 -0
|
@@ -0,0 +1,1293 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/join-requests/manifest/0.4/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
/** Trust Task type URI. */
|
|
6
|
+
export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/manifest/0.4";
|
|
7
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
8
|
+
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/manifest/0.4#response";
|
|
9
|
+
/**
|
|
10
|
+
* This specification's payload schema, as a value.
|
|
11
|
+
*
|
|
12
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
13
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
14
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
15
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
16
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
17
|
+
*/
|
|
18
|
+
export const PAYLOAD_SCHEMA = {
|
|
19
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
20
|
+
"$id": "https://trusttasks.org/spec/vtc/join-requests/manifest/0.4",
|
|
21
|
+
"title": "VTC Join-Requests Manifest — payload",
|
|
22
|
+
"description": "Discover a community's join criteria before applying. The request carries nothing. Version 0.2 adds, per criterion, an optional `vetting` requirements object — how many identity-vetting statements a community needs, by which methods, from whom — and a `requirementsDigest` that names the exact version of the criterion an applicant started under. The response may also carry `branding`, how the community asks to be shown. Version 0.4 adds `directoryDisclosure`: where the community has a member directory, the statement of what it would disclose about a member and to whom, so an applicant reads it before applying.",
|
|
23
|
+
"type": "object",
|
|
24
|
+
"additionalProperties": false,
|
|
25
|
+
"properties": {
|
|
26
|
+
"ext": {
|
|
27
|
+
"$ref": "#/$defs/Ext"
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"$defs": {
|
|
31
|
+
"Duration": {
|
|
32
|
+
"title": "Duration",
|
|
33
|
+
"type": "string",
|
|
34
|
+
"maxLength": 32,
|
|
35
|
+
"pattern": "^P(([0-9]+W)?([0-9]+D)?T([0-9]+H([0-9]+M)?([0-9]+S)?|[0-9]+M([0-9]+S)?|[0-9]+S)|[0-9]+W([0-9]+D)?|[0-9]+D)$",
|
|
36
|
+
"description": "An ISO 8601 duration in weeks, days, hours, minutes and seconds only (e.g. `P120D`, `P2W`, `P1DT12H`, `PT15M`). Years and months are refused: their length depends on the calendar, and an age limit that means different things on different days is not a limit."
|
|
37
|
+
},
|
|
38
|
+
"Criterion": {
|
|
39
|
+
"title": "Criterion",
|
|
40
|
+
"type": "object",
|
|
41
|
+
"additionalProperties": false,
|
|
42
|
+
"required": [
|
|
43
|
+
"id",
|
|
44
|
+
"admission",
|
|
45
|
+
"requirementsDigest"
|
|
46
|
+
],
|
|
47
|
+
"properties": {
|
|
48
|
+
"id": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"minLength": 1,
|
|
51
|
+
"maxLength": 128
|
|
52
|
+
},
|
|
53
|
+
"description": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"maxLength": 1024,
|
|
56
|
+
"description": "Plain-language summary of the criterion, authored by the community and shown to prospective applicants. Informative: where it and `vetting` disagree, `vetting` governs."
|
|
57
|
+
},
|
|
58
|
+
"admission": {
|
|
59
|
+
"type": "string",
|
|
60
|
+
"enum": [
|
|
61
|
+
"automatic",
|
|
62
|
+
"review"
|
|
63
|
+
],
|
|
64
|
+
"description": "How the community decides a submission that meets this criterion. `automatic`: it admits the applicant without a person deciding. `review`: it refers the submission to an administrator, who decides."
|
|
65
|
+
},
|
|
66
|
+
"presentationDefinition": {
|
|
67
|
+
"type": "object",
|
|
68
|
+
"description": "The credentials an applicant must present for this criterion (opaque here). Absent: the criterion requires no credential."
|
|
69
|
+
},
|
|
70
|
+
"credentialIssuers": {
|
|
71
|
+
"type": "string",
|
|
72
|
+
"enum": [
|
|
73
|
+
"any",
|
|
74
|
+
"community",
|
|
75
|
+
"recognised"
|
|
76
|
+
],
|
|
77
|
+
"description": "Whose credentials meet `presentationDefinition`: `community` (this community's own), `recognised` (this community's, or a community it recognises), or `any` (any issuer whose credential verifies). Present exactly when `presentationDefinition` is."
|
|
78
|
+
},
|
|
79
|
+
"invitationRequired": {
|
|
80
|
+
"type": "boolean",
|
|
81
|
+
"description": "True: the criterion is met only by a submission carrying a valid, unconsumed invitation this community issued to the applicant."
|
|
82
|
+
},
|
|
83
|
+
"vetting": {
|
|
84
|
+
"$ref": "#/$defs/VettingRequirements"
|
|
85
|
+
},
|
|
86
|
+
"requirementsDigest": {
|
|
87
|
+
"$ref": "#/$defs/DigestMultibase",
|
|
88
|
+
"description": "Digest over the RFC 8785 (JCS) canonicalization of this criterion object with the `requirementsDigest` member removed, as a multibase-encoded multihash (SHA-256 and base58btc RECOMMENDED). Names one version of the criterion: an applicant records it when starting an application and echoes it to vetters and at submission."
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
"dependentRequired": {
|
|
92
|
+
"presentationDefinition": [
|
|
93
|
+
"credentialIssuers"
|
|
94
|
+
],
|
|
95
|
+
"credentialIssuers": [
|
|
96
|
+
"presentationDefinition"
|
|
97
|
+
]
|
|
98
|
+
}
|
|
99
|
+
},
|
|
100
|
+
"VettingRequirements": {
|
|
101
|
+
"title": "VettingRequirements",
|
|
102
|
+
"type": "object",
|
|
103
|
+
"additionalProperties": true,
|
|
104
|
+
"required": [
|
|
105
|
+
"version",
|
|
106
|
+
"statementType",
|
|
107
|
+
"minStatements",
|
|
108
|
+
"acceptedMethods",
|
|
109
|
+
"eligibleVetters"
|
|
110
|
+
],
|
|
111
|
+
"description": "What identity-vetting evidence a criterion needs, beyond what a presentation-definition can express: distinct eligible vetters, per-method floors, independence caps. Every number is the community's own policy. This schema supplies no defaults — an absent optional member means the community imposes no constraint of that kind, never that some protocol value applies. Deliberately open: a consumer MUST ignore members it does not recognise, so a community publishing a newer shape does not make an older client unable to read the rest. Durations: `maxStatementAge` — a statement older than this at decision time does not count (absent: no limit beyond the statement's own validity); `decisionSla` — how long after submission the community undertakes to decide, including on a referred application; `requirementsGrace` — how long an application started under an earlier `requirementsDigest` is still evaluated under that version.",
|
|
112
|
+
"properties": {
|
|
113
|
+
"version": {
|
|
114
|
+
"type": "string",
|
|
115
|
+
"pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$",
|
|
116
|
+
"description": "Version of this requirements object's shape. `0.1` for the members defined here."
|
|
117
|
+
},
|
|
118
|
+
"statementType": {
|
|
119
|
+
"type": "string",
|
|
120
|
+
"format": "uri",
|
|
121
|
+
"minLength": 1,
|
|
122
|
+
"maxLength": 512,
|
|
123
|
+
"description": "The predicate IRI a counted vetting statement carries in `credentialSubject.predicate` — `https://registry.trustoverip.org/dtg/vsc/vetted/1`, the DTG VSC registry's identity-vetting predicate, or a predicate in a namespace the community controls — registered as one the community accepts via vtc/endorsement-types/register. A statement under any other predicate does not count."
|
|
124
|
+
},
|
|
125
|
+
"minStatements": {
|
|
126
|
+
"type": "integer",
|
|
127
|
+
"minimum": 1,
|
|
128
|
+
"description": "How many counted statements are needed, counting each vetter once however many DIDs they hold."
|
|
129
|
+
},
|
|
130
|
+
"minByMethod": {
|
|
131
|
+
"type": "object",
|
|
132
|
+
"propertyNames": {
|
|
133
|
+
"$ref": "#/$defs/VettingMethod"
|
|
134
|
+
},
|
|
135
|
+
"additionalProperties": {
|
|
136
|
+
"type": "integer",
|
|
137
|
+
"minimum": 0
|
|
138
|
+
},
|
|
139
|
+
"description": "Per-method floors within `minStatements` — e.g. `{ \"inPerson\": 1 }`. Every method named MUST also be in `acceptedMethods`. Absent: no method floor."
|
|
140
|
+
},
|
|
141
|
+
"acceptedMethods": {
|
|
142
|
+
"type": "array",
|
|
143
|
+
"minItems": 1,
|
|
144
|
+
"uniqueItems": true,
|
|
145
|
+
"items": {
|
|
146
|
+
"$ref": "#/$defs/VettingMethod"
|
|
147
|
+
},
|
|
148
|
+
"description": "Methods whose statements count at all."
|
|
149
|
+
},
|
|
150
|
+
"acceptedDocumentClasses": {
|
|
151
|
+
"type": "array",
|
|
152
|
+
"minItems": 1,
|
|
153
|
+
"uniqueItems": true,
|
|
154
|
+
"items": {
|
|
155
|
+
"$ref": "#/$defs/VettingDocumentation"
|
|
156
|
+
},
|
|
157
|
+
"description": "Documentation a statement must have relied on in order to count. Absent — the expected case — means each vetter decides what documentation they accept, including none for prior acquaintance, and the community counts what they attest."
|
|
158
|
+
},
|
|
159
|
+
"requiredClaims": {
|
|
160
|
+
"type": "array",
|
|
161
|
+
"uniqueItems": true,
|
|
162
|
+
"items": {
|
|
163
|
+
"$ref": "#/$defs/ClaimType"
|
|
164
|
+
},
|
|
165
|
+
"description": "Claim types the applicant's Vetting Card must carry, which the identity commitment is computed over, and which a counted statement must list as verified. Absent: none."
|
|
166
|
+
},
|
|
167
|
+
"optionalClaims": {
|
|
168
|
+
"type": "array",
|
|
169
|
+
"uniqueItems": true,
|
|
170
|
+
"items": {
|
|
171
|
+
"$ref": "#/$defs/ClaimType"
|
|
172
|
+
},
|
|
173
|
+
"description": "Claim types an applicant MAY add to the card and a vetter MAY verify. They never affect whether a statement counts."
|
|
174
|
+
},
|
|
175
|
+
"maxStatementAge": {
|
|
176
|
+
"$ref": "#/$defs/Duration"
|
|
177
|
+
},
|
|
178
|
+
"eligibleVetters": {
|
|
179
|
+
"type": "object",
|
|
180
|
+
"additionalProperties": false,
|
|
181
|
+
"required": [
|
|
182
|
+
"role"
|
|
183
|
+
],
|
|
184
|
+
"properties": {
|
|
185
|
+
"role": {
|
|
186
|
+
"type": "string",
|
|
187
|
+
"minLength": 1,
|
|
188
|
+
"maxLength": 128,
|
|
189
|
+
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
|
|
190
|
+
"description": "The role a statement's issuer must hold, matched as the action `role:<role>` in a Verifiable Authority Credential (`AuthorityCredential`) the community issued to that issuer, whose `authority.scope` is the community's DID (see `vtc/vetting/vetters/grant/0.1`). A statement counts only if its issuer holds such a credential."
|
|
191
|
+
}
|
|
192
|
+
},
|
|
193
|
+
"description": "How a vetter's eligibility is established."
|
|
194
|
+
},
|
|
195
|
+
"independence": {
|
|
196
|
+
"type": "object",
|
|
197
|
+
"additionalProperties": false,
|
|
198
|
+
"properties": {
|
|
199
|
+
"maxByDeclaredRelationship": {
|
|
200
|
+
"type": "object",
|
|
201
|
+
"propertyNames": {
|
|
202
|
+
"$ref": "#/$defs/VettingRelationship"
|
|
203
|
+
},
|
|
204
|
+
"additionalProperties": {
|
|
205
|
+
"type": "integer",
|
|
206
|
+
"minimum": 0
|
|
207
|
+
},
|
|
208
|
+
"description": "The most counted statements that may come from vetters declaring each relationship — e.g. `{ \"family\": 0 }`."
|
|
209
|
+
},
|
|
210
|
+
"requireConsistentIdentityCommitment": {
|
|
211
|
+
"type": "boolean",
|
|
212
|
+
"description": "When true, every counted statement must carry the same identity commitment — all vetters verified the same claimed identity. Absent: false."
|
|
213
|
+
}
|
|
214
|
+
},
|
|
215
|
+
"description": "Caps on how much evidence may come from people close to the applicant. Absent: no caps."
|
|
216
|
+
},
|
|
217
|
+
"invitation": {
|
|
218
|
+
"type": "string",
|
|
219
|
+
"enum": [
|
|
220
|
+
"required",
|
|
221
|
+
"optional",
|
|
222
|
+
"none"
|
|
223
|
+
],
|
|
224
|
+
"description": "Whether an invitation credential must accompany the statements at submission (`required`), may (`optional`), or plays no part (`none`). Absent: the presentation-definition alone governs."
|
|
225
|
+
},
|
|
226
|
+
"decisionSla": {
|
|
227
|
+
"$ref": "#/$defs/Duration"
|
|
228
|
+
},
|
|
229
|
+
"requirementsGrace": {
|
|
230
|
+
"$ref": "#/$defs/Duration"
|
|
231
|
+
},
|
|
232
|
+
"governanceFrameworkUrl": {
|
|
233
|
+
"type": "string",
|
|
234
|
+
"format": "uri",
|
|
235
|
+
"pattern": "^https://",
|
|
236
|
+
"maxLength": 2048,
|
|
237
|
+
"description": "Where the community's vetting governance — including the attestation text vetters sign — is published."
|
|
238
|
+
},
|
|
239
|
+
"ext": {
|
|
240
|
+
"description": "Ecosystem-defined extension members per SPEC.md §4.5.1, for vetting parameters this version does not enumerate. A community publishing an admission mode the base members cannot express — the zero-knowledge parameters an applicant proves against, say — puts them under a namespace it controls, rather than waiting for a version that names them.\n\nThis object is already `additionalProperties: true`, so an unknown member here has always validated. That is not the same as reaching a consumer: a generated type names the members this schema declares and drops the rest, so an undeclared member is parsed and discarded, and it is discarded again on the re-serialization `requirementsDigest` is computed over. `ext` is a declared member, so it survives both.",
|
|
241
|
+
"$ref": "#/$defs/Ext"
|
|
242
|
+
},
|
|
243
|
+
"extCritical": {
|
|
244
|
+
"description": "Namespaces of `ext` an applicant MUST understand or refuse, per SPEC.md §4.5.1.\n\nA community marks a namespace here when applying under this criterion without understanding it would mean something other than what the community requires — an applicant that ignored a hidden-vetting namespace, for instance, would submit named statements to a criterion whose whole point was that it does not receive them. An applicant that does not recognize a marked namespace stops rather than downgrading silently.\n\nAbsent, which is the common case, every namespace under `ext` is advisory and ignorable.",
|
|
245
|
+
"$ref": "#/$defs/ExtCritical"
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
},
|
|
249
|
+
"CommunityBranding": {
|
|
250
|
+
"title": "CommunityBranding",
|
|
251
|
+
"type": "object",
|
|
252
|
+
"additionalProperties": false,
|
|
253
|
+
"description": "OPTIONAL. How the community asks to be shown to a prospective applicant: a name, an accent colour and a logo. Presentation only, self-asserted and unverified — `communityDid` identifies the community, never `branding`. Not part of any criterion, so not covered by a `requirementsDigest`. Every member is optional.",
|
|
254
|
+
"properties": {
|
|
255
|
+
"displayName": {
|
|
256
|
+
"type": "string",
|
|
257
|
+
"minLength": 1,
|
|
258
|
+
"maxLength": 128,
|
|
259
|
+
"description": "The community's name as it asks to be shown."
|
|
260
|
+
},
|
|
261
|
+
"accentColor": {
|
|
262
|
+
"type": "string",
|
|
263
|
+
"pattern": "^#[0-9a-fA-F]{6}$",
|
|
264
|
+
"description": "An sRGB colour as `#rrggbb`, compared case-insensitively. A community SHOULD write it in lower case."
|
|
265
|
+
},
|
|
266
|
+
"logoUrl": {
|
|
267
|
+
"type": "string",
|
|
268
|
+
"format": "uri",
|
|
269
|
+
"pattern": "^https://",
|
|
270
|
+
"maxLength": 2048,
|
|
271
|
+
"description": "An https URL of the community's logo. Fetched by the client, so an untrusted image from wherever it points."
|
|
272
|
+
},
|
|
273
|
+
"ext": {
|
|
274
|
+
"$ref": "#/$defs/Ext"
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
},
|
|
278
|
+
"Response": {
|
|
279
|
+
"$anchor": "response",
|
|
280
|
+
"title": "VTC Join-Requests Manifest — response payload",
|
|
281
|
+
"type": "object",
|
|
282
|
+
"additionalProperties": false,
|
|
283
|
+
"required": [
|
|
284
|
+
"communityDid",
|
|
285
|
+
"criteria"
|
|
286
|
+
],
|
|
287
|
+
"properties": {
|
|
288
|
+
"communityDid": {
|
|
289
|
+
"type": "string",
|
|
290
|
+
"pattern": "^did:"
|
|
291
|
+
},
|
|
292
|
+
"criteria": {
|
|
293
|
+
"type": "array",
|
|
294
|
+
"items": {
|
|
295
|
+
"$ref": "#/$defs/Criterion"
|
|
296
|
+
}
|
|
297
|
+
},
|
|
298
|
+
"requestedAttributes": {
|
|
299
|
+
"type": "array",
|
|
300
|
+
"maxItems": 32,
|
|
301
|
+
"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.",
|
|
302
|
+
"items": {
|
|
303
|
+
"type": "object",
|
|
304
|
+
"additionalProperties": false,
|
|
305
|
+
"required": [
|
|
306
|
+
"type"
|
|
307
|
+
],
|
|
308
|
+
"properties": {
|
|
309
|
+
"type": {
|
|
310
|
+
"type": "string",
|
|
311
|
+
"minLength": 1,
|
|
312
|
+
"maxLength": 128,
|
|
313
|
+
"pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
|
|
314
|
+
"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."
|
|
315
|
+
},
|
|
316
|
+
"required": {
|
|
317
|
+
"type": "boolean",
|
|
318
|
+
"default": true,
|
|
319
|
+
"description": "False for an attribute the applicant may decline. A submission missing a required one is refused with vtc/join-requests/submit:attributesMissing."
|
|
320
|
+
},
|
|
321
|
+
"purpose": {
|
|
322
|
+
"type": "string",
|
|
323
|
+
"maxLength": 256,
|
|
324
|
+
"description": "Why the community asks, in words shown to the applicant before they disclose."
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
}
|
|
328
|
+
},
|
|
329
|
+
"branding": {
|
|
330
|
+
"$ref": "#/$defs/CommunityBranding"
|
|
331
|
+
},
|
|
332
|
+
"directoryDisclosure": {
|
|
333
|
+
"$ref": "#/$defs/DirectoryDisclosure",
|
|
334
|
+
"description": "Present exactly where the community offers a member directory: the statement, generated from its configuration, of what the directory would disclose about a member and to whom — the same statement vtc/directory/disclosure returns. Outside every criterion, so no `requirementsDigest` covers it; it names itself with its own `statementDigest`."
|
|
335
|
+
},
|
|
336
|
+
"ext": {
|
|
337
|
+
"$ref": "#/$defs/Ext"
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
},
|
|
341
|
+
"Ext": {
|
|
342
|
+
"title": "Ext",
|
|
343
|
+
"description": "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.",
|
|
344
|
+
"type": "object",
|
|
345
|
+
"minProperties": 1,
|
|
346
|
+
"additionalProperties": true,
|
|
347
|
+
"propertyNames": {
|
|
348
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
"DirectoryDisclosure": {
|
|
352
|
+
"title": "DirectoryDisclosure",
|
|
353
|
+
"description": "The statement itself. Every member is generated from the community's configuration when the statement is read. `statementDigest` names this exact statement, so an applicant can record which one it was shown.",
|
|
354
|
+
"type": "object",
|
|
355
|
+
"additionalProperties": false,
|
|
356
|
+
"required": [
|
|
357
|
+
"fields",
|
|
358
|
+
"newCard",
|
|
359
|
+
"membershipIdentifiers",
|
|
360
|
+
"adminNotes",
|
|
361
|
+
"externalCards",
|
|
362
|
+
"statementDigest"
|
|
363
|
+
],
|
|
364
|
+
"properties": {
|
|
365
|
+
"fields": {
|
|
366
|
+
"type": "array",
|
|
367
|
+
"maxItems": 128,
|
|
368
|
+
"items": {
|
|
369
|
+
"$ref": "#/$defs/DisclosedField"
|
|
370
|
+
},
|
|
371
|
+
"description": "Every active field, base and community-defined, in display order. A base field the community has disabled is absent, which is how a reader learns it is not collected."
|
|
372
|
+
},
|
|
373
|
+
"newCard": {
|
|
374
|
+
"$ref": "#/$defs/NewCardDefaults"
|
|
375
|
+
},
|
|
376
|
+
"membershipIdentifiers": {
|
|
377
|
+
"$ref": "#/$defs/Audience",
|
|
378
|
+
"description": "The widest audience a member's membership identifier — the DID they joined with — can reach through the directory: the ceiling of the base field `did`, or `admins` where that field is disabled. `members` or `public` means a member may choose to show it that widely; a new card never shows it beyond `admins` (VTI-DIR-042). Administrators always see it."
|
|
379
|
+
},
|
|
380
|
+
"adminNotes": {
|
|
381
|
+
"type": "boolean",
|
|
382
|
+
"description": "Whether administrators keep notes about members. Notes are never on a card and never reach another member; a member may ask for the notes about them."
|
|
383
|
+
},
|
|
384
|
+
"groups": {
|
|
385
|
+
"$ref": "#/$defs/GroupDisclosure"
|
|
386
|
+
},
|
|
387
|
+
"externalCards": {
|
|
388
|
+
"type": "boolean",
|
|
389
|
+
"description": "Whether a member may publish a card beyond the community: their `public` values, signed by them, offered through the community's trust registry. Always the member's own choice, and off on a new card. False where the community cannot publish external cards."
|
|
390
|
+
},
|
|
391
|
+
"statementDigest": {
|
|
392
|
+
"$ref": "#/$defs/DigestMultibase",
|
|
393
|
+
"description": "Digest over the RFC 8785 (JCS) canonicalization of this statement with the `statementDigest` member removed, as a multibase-encoded multihash (SHA-256 and base58btc RECOMMENDED). Changes exactly when what the statement says changes."
|
|
394
|
+
},
|
|
395
|
+
"ext": {
|
|
396
|
+
"$ref": "#/$defs/Ext"
|
|
397
|
+
}
|
|
398
|
+
}
|
|
399
|
+
},
|
|
400
|
+
"GroupDisclosure": {
|
|
401
|
+
"title": "GroupDisclosure",
|
|
402
|
+
"description": "Present when the community has groups. A member of a group holds a credential, issued by the group's own identifier, that evidences their membership, and can present it outside the community — which is why an applicant is told.",
|
|
403
|
+
"type": "object",
|
|
404
|
+
"additionalProperties": false,
|
|
405
|
+
"required": [
|
|
406
|
+
"credentialValidity"
|
|
407
|
+
],
|
|
408
|
+
"properties": {
|
|
409
|
+
"credentialValidity": {
|
|
410
|
+
"type": "string",
|
|
411
|
+
"maxLength": 32,
|
|
412
|
+
"pattern": "^P(([0-9]+W)?([0-9]+D)?T([0-9]+H([0-9]+M)?([0-9]+S)?|[0-9]+M([0-9]+S)?|[0-9]+S)|[0-9]+W([0-9]+D)?|[0-9]+D)$",
|
|
413
|
+
"description": "How long each group membership credential is valid for, as an ISO 8601 duration in weeks, days, hours, minutes and seconds (`P30D`). It is renewed while the member stays in the group, and a credential already issued stays valid until it expires even after its holder leaves."
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
},
|
|
417
|
+
"NewCardDefaults": {
|
|
418
|
+
"title": "NewCardDefaults",
|
|
419
|
+
"description": "The discoverability a card has when the community creates it, before its member chooses. A new card is never published beyond the community (VTI-DIR-042), so there is no member for that here: `externalCards` says whether the member may turn it on.",
|
|
420
|
+
"type": "object",
|
|
421
|
+
"additionalProperties": false,
|
|
422
|
+
"required": [
|
|
423
|
+
"listing",
|
|
424
|
+
"search"
|
|
425
|
+
],
|
|
426
|
+
"properties": {
|
|
427
|
+
"listing": {
|
|
428
|
+
"$ref": "#/$defs/Listing",
|
|
429
|
+
"description": "The listing a new card starts with: the community's `defaultListing` (vtc/directory/fields/list). Every member may always choose `hidden`."
|
|
430
|
+
},
|
|
431
|
+
"search": {
|
|
432
|
+
"type": "string",
|
|
433
|
+
"enum": [
|
|
434
|
+
"byName",
|
|
435
|
+
"exactNickname",
|
|
436
|
+
"off"
|
|
437
|
+
],
|
|
438
|
+
"description": "What a member's search may match, as the card's `discoverability.search`."
|
|
439
|
+
},
|
|
440
|
+
"introductions": {
|
|
441
|
+
"$ref": "#/$defs/Introductions",
|
|
442
|
+
"description": "From whom a new card accepts introductions. Absent where the community does not deliver introductions."
|
|
443
|
+
}
|
|
444
|
+
}
|
|
445
|
+
},
|
|
446
|
+
"Introductions": {
|
|
447
|
+
"title": "Introductions",
|
|
448
|
+
"description": "Who may ask the community to introduce them to this member. `anyone`: any active member who can find the entry. `groups`: only members who share a community group with them. `connections`: only members holding an attributed, in-force verified relationship with them. `off`: nobody. A refused introduction is never reported to its sender.",
|
|
449
|
+
"type": "string",
|
|
450
|
+
"enum": [
|
|
451
|
+
"anyone",
|
|
452
|
+
"groups",
|
|
453
|
+
"connections",
|
|
454
|
+
"off"
|
|
455
|
+
]
|
|
456
|
+
},
|
|
457
|
+
"Listing": {
|
|
458
|
+
"title": "Listing",
|
|
459
|
+
"description": "Whether members can find the entry. `listed`: it appears when members browse. `findable`: it does not appear when browsing, but a search that matches it under `search` returns it. `hidden`: no member finds it by browsing or searching; administrators still see it, and members who share a group that shows its members see it in that group's member list.",
|
|
460
|
+
"type": "string",
|
|
461
|
+
"enum": [
|
|
462
|
+
"listed",
|
|
463
|
+
"findable",
|
|
464
|
+
"hidden"
|
|
465
|
+
]
|
|
466
|
+
},
|
|
467
|
+
"DisclosedField": {
|
|
468
|
+
"title": "DisclosedField",
|
|
469
|
+
"description": "One active field of the community's directory, as an applicant needs to see it: what it is, who writes its value, the widest audience it may ever reach and the audience a new card gives it. Disabled and retired fields are not listed: no projection shows them.",
|
|
470
|
+
"type": "object",
|
|
471
|
+
"additionalProperties": false,
|
|
472
|
+
"required": [
|
|
473
|
+
"key",
|
|
474
|
+
"label",
|
|
475
|
+
"type",
|
|
476
|
+
"source",
|
|
477
|
+
"ceiling",
|
|
478
|
+
"defaultVisibility",
|
|
479
|
+
"searchable"
|
|
480
|
+
],
|
|
481
|
+
"properties": {
|
|
482
|
+
"key": {
|
|
483
|
+
"$ref": "#/$defs/FieldKey"
|
|
484
|
+
},
|
|
485
|
+
"label": {
|
|
486
|
+
"$ref": "#/$defs/FieldLabel"
|
|
487
|
+
},
|
|
488
|
+
"description": {
|
|
489
|
+
"$ref": "#/$defs/FieldDescription"
|
|
490
|
+
},
|
|
491
|
+
"type": {
|
|
492
|
+
"$ref": "#/$defs/FieldType"
|
|
493
|
+
},
|
|
494
|
+
"source": {
|
|
495
|
+
"$ref": "#/$defs/FieldSource",
|
|
496
|
+
"description": "Who writes the value. `admin` and `credential` matter most to an applicant: an `admin` field holds what the community asserts about the member, which the member reads and cannot change."
|
|
497
|
+
},
|
|
498
|
+
"ceiling": {
|
|
499
|
+
"$ref": "#/$defs/Audience",
|
|
500
|
+
"description": "The widest audience the field may ever reach, whatever the member chooses."
|
|
501
|
+
},
|
|
502
|
+
"defaultVisibility": {
|
|
503
|
+
"$ref": "#/$defs/Audience",
|
|
504
|
+
"description": "The audience a new card gives the field until its member chooses. Never wider than `ceiling`."
|
|
505
|
+
},
|
|
506
|
+
"searchable": {
|
|
507
|
+
"type": "boolean",
|
|
508
|
+
"description": "Whether a member's search may match the field, within what the searcher may see."
|
|
509
|
+
},
|
|
510
|
+
"facet": {
|
|
511
|
+
"type": "boolean",
|
|
512
|
+
"description": "Whether members may filter on the field and see counts by its values. Absent: false."
|
|
513
|
+
}
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
"Audience": {
|
|
517
|
+
"title": "Audience",
|
|
518
|
+
"description": "Who may see a directory field, ordered from narrowest to widest. `admins`: holders of `vtc.directory.admin` (and, for derived fields, `vtc.members.manage`). `groups`: members who share at least one community group with the subject (narrowed to the groups the subject names in `groupAudience`, where it names any). `connections`: members holding an attributed, in-force verified relationship with the subject at the community. `members`: every active member. `public`: anyone, and what the member's signed public card carries outside the community.\n\n`groups` and `connections` are not a chain: a viewer sees a field when they satisfy the audience the subject chose for it or any wider audience. Every audience includes the administrators, and the subject always sees their own whole card. There is no `onlyMe`: a value nobody else should see is not directory data.",
|
|
519
|
+
"type": "string",
|
|
520
|
+
"enum": [
|
|
521
|
+
"admins",
|
|
522
|
+
"groups",
|
|
523
|
+
"connections",
|
|
524
|
+
"members",
|
|
525
|
+
"public"
|
|
526
|
+
]
|
|
527
|
+
},
|
|
528
|
+
"FieldSource": {
|
|
529
|
+
"title": "FieldSource",
|
|
530
|
+
"description": "Who writes the value. `member`: self-asserted, through vtc/directory/card/update. `admin`: asserted by the community through vtc/directory/card/assert; the member reads it and cannot change it. `credential`: a claim the member discloses from a credential through vtc/directory/card/present, badged with its issuer. `derived`: a base field read from the community's own records (`role`, `joinedAt`, `did`, `personhood`) and never stored on a card. Each source is written only through its own path.",
|
|
531
|
+
"type": "string",
|
|
532
|
+
"enum": [
|
|
533
|
+
"member",
|
|
534
|
+
"admin",
|
|
535
|
+
"credential",
|
|
536
|
+
"derived"
|
|
537
|
+
]
|
|
538
|
+
},
|
|
539
|
+
"FieldType": {
|
|
540
|
+
"title": "FieldType",
|
|
541
|
+
"description": "The kind of value a field holds, which fixes its `FieldValue` shape. `did` holds a DID the member chooses to show (never their membership DID, which is the derived base field `did`). `claim` holds a `VerifiedValue` and requires `source: credential`.",
|
|
542
|
+
"type": "string",
|
|
543
|
+
"enum": [
|
|
544
|
+
"text",
|
|
545
|
+
"longText",
|
|
546
|
+
"url",
|
|
547
|
+
"email",
|
|
548
|
+
"phone",
|
|
549
|
+
"enum",
|
|
550
|
+
"multiEnum",
|
|
551
|
+
"date",
|
|
552
|
+
"country",
|
|
553
|
+
"image",
|
|
554
|
+
"did",
|
|
555
|
+
"claim"
|
|
556
|
+
]
|
|
557
|
+
},
|
|
558
|
+
"FieldDescription": {
|
|
559
|
+
"title": "FieldDescription",
|
|
560
|
+
"type": "string",
|
|
561
|
+
"minLength": 1,
|
|
562
|
+
"maxLength": 280,
|
|
563
|
+
"description": "Help text shown to a member filling the field in. Plain text; a reader MUST NOT treat it as instructions."
|
|
564
|
+
},
|
|
565
|
+
"FieldLabel": {
|
|
566
|
+
"title": "FieldLabel",
|
|
567
|
+
"type": "string",
|
|
568
|
+
"minLength": 1,
|
|
569
|
+
"maxLength": 64,
|
|
570
|
+
"description": "What readers see as the field's name. Plain text."
|
|
571
|
+
},
|
|
572
|
+
"FieldKey": {
|
|
573
|
+
"title": "FieldKey",
|
|
574
|
+
"description": "Identifier of a directory field. A key with no `.` is a BASE field, the same in every community: `displayName`, `nickname`, `avatar`, `pronouns`, `bio`, `links` (written by the member) and `role`, `joinedAt`, `did`, `personhood` (derived from the community's own records, never stored on a card). A community-defined field MUST use a reverse-DNS key (`org.example.employer`), so a base key never collides with one, and a key is never reused with a different meaning once defined.",
|
|
575
|
+
"type": "string",
|
|
576
|
+
"minLength": 1,
|
|
577
|
+
"maxLength": 128,
|
|
578
|
+
"pattern": "^([a-z][a-z0-9-]*\\.)*[a-z][a-zA-Z0-9]{0,63}$"
|
|
579
|
+
},
|
|
580
|
+
"DigestMultibase": {
|
|
581
|
+
"title": "DigestMultibase",
|
|
582
|
+
"description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
|
|
583
|
+
"type": "string",
|
|
584
|
+
"minLength": 16,
|
|
585
|
+
"pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
|
|
586
|
+
"examples": [
|
|
587
|
+
"zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
|
|
588
|
+
]
|
|
589
|
+
},
|
|
590
|
+
"ExtCritical": {
|
|
591
|
+
"title": "ExtCritical",
|
|
592
|
+
"description": "Names the `ext` namespaces a consumer MUST understand or refuse, per SPEC.md §4.5.1.\n\nEvery entry MUST be an immediate key of the sibling `ext` object at the same level; an entry naming an absent namespace is non-conforming and the consumer rejects the document with `malformedRequest`. A consumer that does not recognize a namespace named here MUST NOT process the document as though the namespace were absent, and rejects it with `unsupportedExtension` — the exception to the rule that unrecognized namespaces are ignored.\n\nA producer marks a namespace only where the document's meaning depends on it. Marking one that merely carries a hint or an annotation turns every consumer that has not implemented it into a failure where it would otherwise have interoperated. JSON Schema cannot check either of those rules: that an entry names a present namespace is checkable only against the sibling `ext`, and whether a namespace is load-bearing is not a schema question at all. Both are consumer-side checks.",
|
|
593
|
+
"type": "array",
|
|
594
|
+
"minItems": 1,
|
|
595
|
+
"uniqueItems": true,
|
|
596
|
+
"items": {
|
|
597
|
+
"type": "string",
|
|
598
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
599
|
+
},
|
|
600
|
+
"examples": [
|
|
601
|
+
[
|
|
602
|
+
"org.openvtc.hidden-vetting"
|
|
603
|
+
]
|
|
604
|
+
]
|
|
605
|
+
},
|
|
606
|
+
"VettingRelationship": {
|
|
607
|
+
"title": "VettingRelationship",
|
|
608
|
+
"type": "string",
|
|
609
|
+
"enum": [
|
|
610
|
+
"none",
|
|
611
|
+
"communityColleague",
|
|
612
|
+
"sameEmployer",
|
|
613
|
+
"family",
|
|
614
|
+
"otherPersonal"
|
|
615
|
+
],
|
|
616
|
+
"description": "The vetter's own declaration of how they relate to the applicant. Declared, not verified: it exists so community policy can cap how much evidence comes from people close to the applicant, and a false declaration is the vetter's attributable act."
|
|
617
|
+
},
|
|
618
|
+
"ClaimType": {
|
|
619
|
+
"title": "ClaimType",
|
|
620
|
+
"description": "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.",
|
|
621
|
+
"type": "string",
|
|
622
|
+
"minLength": 1,
|
|
623
|
+
"maxLength": 128,
|
|
624
|
+
"pattern": "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$"
|
|
625
|
+
},
|
|
626
|
+
"VettingDocumentation": {
|
|
627
|
+
"title": "VettingDocumentation",
|
|
628
|
+
"type": "string",
|
|
629
|
+
"minLength": 1,
|
|
630
|
+
"maxLength": 64,
|
|
631
|
+
"pattern": "^[a-z][a-zA-Z0-9]*$",
|
|
632
|
+
"description": "A class of documentation, named in lowerCamelCase. Open rather than enumerated, because what documentation a vetter accepts is each vetter's own choice. Well-known values: `passport`, `nationalId`, `driverLicence`, and `none` — the vetter will attest without a document, which is the `priorAcquaintance` case. Only the class ever travels — never a document number, an image, an issuing authority or an expiry date. `none` states a policy (what a vetter accepts); a record of what was relied on expresses 'no document' as an empty list instead."
|
|
633
|
+
},
|
|
634
|
+
"VettingMethod": {
|
|
635
|
+
"title": "VettingMethod",
|
|
636
|
+
"type": "string",
|
|
637
|
+
"enum": [
|
|
638
|
+
"inPerson",
|
|
639
|
+
"video",
|
|
640
|
+
"priorAcquaintance"
|
|
641
|
+
],
|
|
642
|
+
"description": "How the vetter established that the person they checked is the person controlling the applicant's DID. `inPerson` — both people were physically together. `video` — a live, two-way video call. `priorAcquaintance` — the vetter has known or worked with this person over a period, and attests from that knowledge rather than from a document. A method is a description of what happened, not an assurance level: which methods count, and how many of each, is community policy."
|
|
643
|
+
}
|
|
644
|
+
}
|
|
645
|
+
};
|
|
646
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
647
|
+
export const RESPONSE_PAYLOAD_SCHEMA = {
|
|
648
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
649
|
+
"$ref": "#/$defs/Response",
|
|
650
|
+
"$defs": {
|
|
651
|
+
"Duration": {
|
|
652
|
+
"title": "Duration",
|
|
653
|
+
"type": "string",
|
|
654
|
+
"maxLength": 32,
|
|
655
|
+
"pattern": "^P(([0-9]+W)?([0-9]+D)?T([0-9]+H([0-9]+M)?([0-9]+S)?|[0-9]+M([0-9]+S)?|[0-9]+S)|[0-9]+W([0-9]+D)?|[0-9]+D)$",
|
|
656
|
+
"description": "An ISO 8601 duration in weeks, days, hours, minutes and seconds only (e.g. `P120D`, `P2W`, `P1DT12H`, `PT15M`). Years and months are refused: their length depends on the calendar, and an age limit that means different things on different days is not a limit."
|
|
657
|
+
},
|
|
658
|
+
"Criterion": {
|
|
659
|
+
"title": "Criterion",
|
|
660
|
+
"type": "object",
|
|
661
|
+
"additionalProperties": false,
|
|
662
|
+
"required": [
|
|
663
|
+
"id",
|
|
664
|
+
"admission",
|
|
665
|
+
"requirementsDigest"
|
|
666
|
+
],
|
|
667
|
+
"properties": {
|
|
668
|
+
"id": {
|
|
669
|
+
"type": "string",
|
|
670
|
+
"minLength": 1,
|
|
671
|
+
"maxLength": 128
|
|
672
|
+
},
|
|
673
|
+
"description": {
|
|
674
|
+
"type": "string",
|
|
675
|
+
"maxLength": 1024,
|
|
676
|
+
"description": "Plain-language summary of the criterion, authored by the community and shown to prospective applicants. Informative: where it and `vetting` disagree, `vetting` governs."
|
|
677
|
+
},
|
|
678
|
+
"admission": {
|
|
679
|
+
"type": "string",
|
|
680
|
+
"enum": [
|
|
681
|
+
"automatic",
|
|
682
|
+
"review"
|
|
683
|
+
],
|
|
684
|
+
"description": "How the community decides a submission that meets this criterion. `automatic`: it admits the applicant without a person deciding. `review`: it refers the submission to an administrator, who decides."
|
|
685
|
+
},
|
|
686
|
+
"presentationDefinition": {
|
|
687
|
+
"type": "object",
|
|
688
|
+
"description": "The credentials an applicant must present for this criterion (opaque here). Absent: the criterion requires no credential."
|
|
689
|
+
},
|
|
690
|
+
"credentialIssuers": {
|
|
691
|
+
"type": "string",
|
|
692
|
+
"enum": [
|
|
693
|
+
"any",
|
|
694
|
+
"community",
|
|
695
|
+
"recognised"
|
|
696
|
+
],
|
|
697
|
+
"description": "Whose credentials meet `presentationDefinition`: `community` (this community's own), `recognised` (this community's, or a community it recognises), or `any` (any issuer whose credential verifies). Present exactly when `presentationDefinition` is."
|
|
698
|
+
},
|
|
699
|
+
"invitationRequired": {
|
|
700
|
+
"type": "boolean",
|
|
701
|
+
"description": "True: the criterion is met only by a submission carrying a valid, unconsumed invitation this community issued to the applicant."
|
|
702
|
+
},
|
|
703
|
+
"vetting": {
|
|
704
|
+
"$ref": "#/$defs/VettingRequirements"
|
|
705
|
+
},
|
|
706
|
+
"requirementsDigest": {
|
|
707
|
+
"$ref": "#/$defs/DigestMultibase",
|
|
708
|
+
"description": "Digest over the RFC 8785 (JCS) canonicalization of this criterion object with the `requirementsDigest` member removed, as a multibase-encoded multihash (SHA-256 and base58btc RECOMMENDED). Names one version of the criterion: an applicant records it when starting an application and echoes it to vetters and at submission."
|
|
709
|
+
}
|
|
710
|
+
},
|
|
711
|
+
"dependentRequired": {
|
|
712
|
+
"presentationDefinition": [
|
|
713
|
+
"credentialIssuers"
|
|
714
|
+
],
|
|
715
|
+
"credentialIssuers": [
|
|
716
|
+
"presentationDefinition"
|
|
717
|
+
]
|
|
718
|
+
}
|
|
719
|
+
},
|
|
720
|
+
"VettingRequirements": {
|
|
721
|
+
"title": "VettingRequirements",
|
|
722
|
+
"type": "object",
|
|
723
|
+
"additionalProperties": true,
|
|
724
|
+
"required": [
|
|
725
|
+
"version",
|
|
726
|
+
"statementType",
|
|
727
|
+
"minStatements",
|
|
728
|
+
"acceptedMethods",
|
|
729
|
+
"eligibleVetters"
|
|
730
|
+
],
|
|
731
|
+
"description": "What identity-vetting evidence a criterion needs, beyond what a presentation-definition can express: distinct eligible vetters, per-method floors, independence caps. Every number is the community's own policy. This schema supplies no defaults — an absent optional member means the community imposes no constraint of that kind, never that some protocol value applies. Deliberately open: a consumer MUST ignore members it does not recognise, so a community publishing a newer shape does not make an older client unable to read the rest. Durations: `maxStatementAge` — a statement older than this at decision time does not count (absent: no limit beyond the statement's own validity); `decisionSla` — how long after submission the community undertakes to decide, including on a referred application; `requirementsGrace` — how long an application started under an earlier `requirementsDigest` is still evaluated under that version.",
|
|
732
|
+
"properties": {
|
|
733
|
+
"version": {
|
|
734
|
+
"type": "string",
|
|
735
|
+
"pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$",
|
|
736
|
+
"description": "Version of this requirements object's shape. `0.1` for the members defined here."
|
|
737
|
+
},
|
|
738
|
+
"statementType": {
|
|
739
|
+
"type": "string",
|
|
740
|
+
"format": "uri",
|
|
741
|
+
"minLength": 1,
|
|
742
|
+
"maxLength": 512,
|
|
743
|
+
"description": "The predicate IRI a counted vetting statement carries in `credentialSubject.predicate` — `https://registry.trustoverip.org/dtg/vsc/vetted/1`, the DTG VSC registry's identity-vetting predicate, or a predicate in a namespace the community controls — registered as one the community accepts via vtc/endorsement-types/register. A statement under any other predicate does not count."
|
|
744
|
+
},
|
|
745
|
+
"minStatements": {
|
|
746
|
+
"type": "integer",
|
|
747
|
+
"minimum": 1,
|
|
748
|
+
"description": "How many counted statements are needed, counting each vetter once however many DIDs they hold."
|
|
749
|
+
},
|
|
750
|
+
"minByMethod": {
|
|
751
|
+
"type": "object",
|
|
752
|
+
"propertyNames": {
|
|
753
|
+
"$ref": "#/$defs/VettingMethod"
|
|
754
|
+
},
|
|
755
|
+
"additionalProperties": {
|
|
756
|
+
"type": "integer",
|
|
757
|
+
"minimum": 0
|
|
758
|
+
},
|
|
759
|
+
"description": "Per-method floors within `minStatements` — e.g. `{ \"inPerson\": 1 }`. Every method named MUST also be in `acceptedMethods`. Absent: no method floor."
|
|
760
|
+
},
|
|
761
|
+
"acceptedMethods": {
|
|
762
|
+
"type": "array",
|
|
763
|
+
"minItems": 1,
|
|
764
|
+
"uniqueItems": true,
|
|
765
|
+
"items": {
|
|
766
|
+
"$ref": "#/$defs/VettingMethod"
|
|
767
|
+
},
|
|
768
|
+
"description": "Methods whose statements count at all."
|
|
769
|
+
},
|
|
770
|
+
"acceptedDocumentClasses": {
|
|
771
|
+
"type": "array",
|
|
772
|
+
"minItems": 1,
|
|
773
|
+
"uniqueItems": true,
|
|
774
|
+
"items": {
|
|
775
|
+
"$ref": "#/$defs/VettingDocumentation"
|
|
776
|
+
},
|
|
777
|
+
"description": "Documentation a statement must have relied on in order to count. Absent — the expected case — means each vetter decides what documentation they accept, including none for prior acquaintance, and the community counts what they attest."
|
|
778
|
+
},
|
|
779
|
+
"requiredClaims": {
|
|
780
|
+
"type": "array",
|
|
781
|
+
"uniqueItems": true,
|
|
782
|
+
"items": {
|
|
783
|
+
"$ref": "#/$defs/ClaimType"
|
|
784
|
+
},
|
|
785
|
+
"description": "Claim types the applicant's Vetting Card must carry, which the identity commitment is computed over, and which a counted statement must list as verified. Absent: none."
|
|
786
|
+
},
|
|
787
|
+
"optionalClaims": {
|
|
788
|
+
"type": "array",
|
|
789
|
+
"uniqueItems": true,
|
|
790
|
+
"items": {
|
|
791
|
+
"$ref": "#/$defs/ClaimType"
|
|
792
|
+
},
|
|
793
|
+
"description": "Claim types an applicant MAY add to the card and a vetter MAY verify. They never affect whether a statement counts."
|
|
794
|
+
},
|
|
795
|
+
"maxStatementAge": {
|
|
796
|
+
"$ref": "#/$defs/Duration"
|
|
797
|
+
},
|
|
798
|
+
"eligibleVetters": {
|
|
799
|
+
"type": "object",
|
|
800
|
+
"additionalProperties": false,
|
|
801
|
+
"required": [
|
|
802
|
+
"role"
|
|
803
|
+
],
|
|
804
|
+
"properties": {
|
|
805
|
+
"role": {
|
|
806
|
+
"type": "string",
|
|
807
|
+
"minLength": 1,
|
|
808
|
+
"maxLength": 128,
|
|
809
|
+
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
|
|
810
|
+
"description": "The role a statement's issuer must hold, matched as the action `role:<role>` in a Verifiable Authority Credential (`AuthorityCredential`) the community issued to that issuer, whose `authority.scope` is the community's DID (see `vtc/vetting/vetters/grant/0.1`). A statement counts only if its issuer holds such a credential."
|
|
811
|
+
}
|
|
812
|
+
},
|
|
813
|
+
"description": "How a vetter's eligibility is established."
|
|
814
|
+
},
|
|
815
|
+
"independence": {
|
|
816
|
+
"type": "object",
|
|
817
|
+
"additionalProperties": false,
|
|
818
|
+
"properties": {
|
|
819
|
+
"maxByDeclaredRelationship": {
|
|
820
|
+
"type": "object",
|
|
821
|
+
"propertyNames": {
|
|
822
|
+
"$ref": "#/$defs/VettingRelationship"
|
|
823
|
+
},
|
|
824
|
+
"additionalProperties": {
|
|
825
|
+
"type": "integer",
|
|
826
|
+
"minimum": 0
|
|
827
|
+
},
|
|
828
|
+
"description": "The most counted statements that may come from vetters declaring each relationship — e.g. `{ \"family\": 0 }`."
|
|
829
|
+
},
|
|
830
|
+
"requireConsistentIdentityCommitment": {
|
|
831
|
+
"type": "boolean",
|
|
832
|
+
"description": "When true, every counted statement must carry the same identity commitment — all vetters verified the same claimed identity. Absent: false."
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"description": "Caps on how much evidence may come from people close to the applicant. Absent: no caps."
|
|
836
|
+
},
|
|
837
|
+
"invitation": {
|
|
838
|
+
"type": "string",
|
|
839
|
+
"enum": [
|
|
840
|
+
"required",
|
|
841
|
+
"optional",
|
|
842
|
+
"none"
|
|
843
|
+
],
|
|
844
|
+
"description": "Whether an invitation credential must accompany the statements at submission (`required`), may (`optional`), or plays no part (`none`). Absent: the presentation-definition alone governs."
|
|
845
|
+
},
|
|
846
|
+
"decisionSla": {
|
|
847
|
+
"$ref": "#/$defs/Duration"
|
|
848
|
+
},
|
|
849
|
+
"requirementsGrace": {
|
|
850
|
+
"$ref": "#/$defs/Duration"
|
|
851
|
+
},
|
|
852
|
+
"governanceFrameworkUrl": {
|
|
853
|
+
"type": "string",
|
|
854
|
+
"format": "uri",
|
|
855
|
+
"pattern": "^https://",
|
|
856
|
+
"maxLength": 2048,
|
|
857
|
+
"description": "Where the community's vetting governance — including the attestation text vetters sign — is published."
|
|
858
|
+
},
|
|
859
|
+
"ext": {
|
|
860
|
+
"description": "Ecosystem-defined extension members per SPEC.md §4.5.1, for vetting parameters this version does not enumerate. A community publishing an admission mode the base members cannot express — the zero-knowledge parameters an applicant proves against, say — puts them under a namespace it controls, rather than waiting for a version that names them.\n\nThis object is already `additionalProperties: true`, so an unknown member here has always validated. That is not the same as reaching a consumer: a generated type names the members this schema declares and drops the rest, so an undeclared member is parsed and discarded, and it is discarded again on the re-serialization `requirementsDigest` is computed over. `ext` is a declared member, so it survives both.",
|
|
861
|
+
"$ref": "#/$defs/Ext"
|
|
862
|
+
},
|
|
863
|
+
"extCritical": {
|
|
864
|
+
"description": "Namespaces of `ext` an applicant MUST understand or refuse, per SPEC.md §4.5.1.\n\nA community marks a namespace here when applying under this criterion without understanding it would mean something other than what the community requires — an applicant that ignored a hidden-vetting namespace, for instance, would submit named statements to a criterion whose whole point was that it does not receive them. An applicant that does not recognize a marked namespace stops rather than downgrading silently.\n\nAbsent, which is the common case, every namespace under `ext` is advisory and ignorable.",
|
|
865
|
+
"$ref": "#/$defs/ExtCritical"
|
|
866
|
+
}
|
|
867
|
+
}
|
|
868
|
+
},
|
|
869
|
+
"CommunityBranding": {
|
|
870
|
+
"title": "CommunityBranding",
|
|
871
|
+
"type": "object",
|
|
872
|
+
"additionalProperties": false,
|
|
873
|
+
"description": "OPTIONAL. How the community asks to be shown to a prospective applicant: a name, an accent colour and a logo. Presentation only, self-asserted and unverified — `communityDid` identifies the community, never `branding`. Not part of any criterion, so not covered by a `requirementsDigest`. Every member is optional.",
|
|
874
|
+
"properties": {
|
|
875
|
+
"displayName": {
|
|
876
|
+
"type": "string",
|
|
877
|
+
"minLength": 1,
|
|
878
|
+
"maxLength": 128,
|
|
879
|
+
"description": "The community's name as it asks to be shown."
|
|
880
|
+
},
|
|
881
|
+
"accentColor": {
|
|
882
|
+
"type": "string",
|
|
883
|
+
"pattern": "^#[0-9a-fA-F]{6}$",
|
|
884
|
+
"description": "An sRGB colour as `#rrggbb`, compared case-insensitively. A community SHOULD write it in lower case."
|
|
885
|
+
},
|
|
886
|
+
"logoUrl": {
|
|
887
|
+
"type": "string",
|
|
888
|
+
"format": "uri",
|
|
889
|
+
"pattern": "^https://",
|
|
890
|
+
"maxLength": 2048,
|
|
891
|
+
"description": "An https URL of the community's logo. Fetched by the client, so an untrusted image from wherever it points."
|
|
892
|
+
},
|
|
893
|
+
"ext": {
|
|
894
|
+
"$ref": "#/$defs/Ext"
|
|
895
|
+
}
|
|
896
|
+
}
|
|
897
|
+
},
|
|
898
|
+
"Response": {
|
|
899
|
+
"$anchor": "response",
|
|
900
|
+
"title": "VTC Join-Requests Manifest — response payload",
|
|
901
|
+
"type": "object",
|
|
902
|
+
"additionalProperties": false,
|
|
903
|
+
"required": [
|
|
904
|
+
"communityDid",
|
|
905
|
+
"criteria"
|
|
906
|
+
],
|
|
907
|
+
"properties": {
|
|
908
|
+
"communityDid": {
|
|
909
|
+
"type": "string",
|
|
910
|
+
"pattern": "^did:"
|
|
911
|
+
},
|
|
912
|
+
"criteria": {
|
|
913
|
+
"type": "array",
|
|
914
|
+
"items": {
|
|
915
|
+
"$ref": "#/$defs/Criterion"
|
|
916
|
+
}
|
|
917
|
+
},
|
|
918
|
+
"requestedAttributes": {
|
|
919
|
+
"type": "array",
|
|
920
|
+
"maxItems": 32,
|
|
921
|
+
"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.",
|
|
922
|
+
"items": {
|
|
923
|
+
"type": "object",
|
|
924
|
+
"additionalProperties": false,
|
|
925
|
+
"required": [
|
|
926
|
+
"type"
|
|
927
|
+
],
|
|
928
|
+
"properties": {
|
|
929
|
+
"type": {
|
|
930
|
+
"type": "string",
|
|
931
|
+
"minLength": 1,
|
|
932
|
+
"maxLength": 128,
|
|
933
|
+
"pattern": "^(x:)?[a-z][A-Za-z0-9]*(\\.[a-z][A-Za-z0-9]*)*$",
|
|
934
|
+
"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."
|
|
935
|
+
},
|
|
936
|
+
"required": {
|
|
937
|
+
"type": "boolean",
|
|
938
|
+
"default": true,
|
|
939
|
+
"description": "False for an attribute the applicant may decline. A submission missing a required one is refused with vtc/join-requests/submit:attributesMissing."
|
|
940
|
+
},
|
|
941
|
+
"purpose": {
|
|
942
|
+
"type": "string",
|
|
943
|
+
"maxLength": 256,
|
|
944
|
+
"description": "Why the community asks, in words shown to the applicant before they disclose."
|
|
945
|
+
}
|
|
946
|
+
}
|
|
947
|
+
}
|
|
948
|
+
},
|
|
949
|
+
"branding": {
|
|
950
|
+
"$ref": "#/$defs/CommunityBranding"
|
|
951
|
+
},
|
|
952
|
+
"directoryDisclosure": {
|
|
953
|
+
"$ref": "#/$defs/DirectoryDisclosure",
|
|
954
|
+
"description": "Present exactly where the community offers a member directory: the statement, generated from its configuration, of what the directory would disclose about a member and to whom — the same statement vtc/directory/disclosure returns. Outside every criterion, so no `requirementsDigest` covers it; it names itself with its own `statementDigest`."
|
|
955
|
+
},
|
|
956
|
+
"ext": {
|
|
957
|
+
"$ref": "#/$defs/Ext"
|
|
958
|
+
}
|
|
959
|
+
}
|
|
960
|
+
},
|
|
961
|
+
"Ext": {
|
|
962
|
+
"title": "Ext",
|
|
963
|
+
"description": "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.",
|
|
964
|
+
"type": "object",
|
|
965
|
+
"minProperties": 1,
|
|
966
|
+
"additionalProperties": true,
|
|
967
|
+
"propertyNames": {
|
|
968
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
969
|
+
}
|
|
970
|
+
},
|
|
971
|
+
"DirectoryDisclosure": {
|
|
972
|
+
"title": "DirectoryDisclosure",
|
|
973
|
+
"description": "The statement itself. Every member is generated from the community's configuration when the statement is read. `statementDigest` names this exact statement, so an applicant can record which one it was shown.",
|
|
974
|
+
"type": "object",
|
|
975
|
+
"additionalProperties": false,
|
|
976
|
+
"required": [
|
|
977
|
+
"fields",
|
|
978
|
+
"newCard",
|
|
979
|
+
"membershipIdentifiers",
|
|
980
|
+
"adminNotes",
|
|
981
|
+
"externalCards",
|
|
982
|
+
"statementDigest"
|
|
983
|
+
],
|
|
984
|
+
"properties": {
|
|
985
|
+
"fields": {
|
|
986
|
+
"type": "array",
|
|
987
|
+
"maxItems": 128,
|
|
988
|
+
"items": {
|
|
989
|
+
"$ref": "#/$defs/DisclosedField"
|
|
990
|
+
},
|
|
991
|
+
"description": "Every active field, base and community-defined, in display order. A base field the community has disabled is absent, which is how a reader learns it is not collected."
|
|
992
|
+
},
|
|
993
|
+
"newCard": {
|
|
994
|
+
"$ref": "#/$defs/NewCardDefaults"
|
|
995
|
+
},
|
|
996
|
+
"membershipIdentifiers": {
|
|
997
|
+
"$ref": "#/$defs/Audience",
|
|
998
|
+
"description": "The widest audience a member's membership identifier — the DID they joined with — can reach through the directory: the ceiling of the base field `did`, or `admins` where that field is disabled. `members` or `public` means a member may choose to show it that widely; a new card never shows it beyond `admins` (VTI-DIR-042). Administrators always see it."
|
|
999
|
+
},
|
|
1000
|
+
"adminNotes": {
|
|
1001
|
+
"type": "boolean",
|
|
1002
|
+
"description": "Whether administrators keep notes about members. Notes are never on a card and never reach another member; a member may ask for the notes about them."
|
|
1003
|
+
},
|
|
1004
|
+
"groups": {
|
|
1005
|
+
"$ref": "#/$defs/GroupDisclosure"
|
|
1006
|
+
},
|
|
1007
|
+
"externalCards": {
|
|
1008
|
+
"type": "boolean",
|
|
1009
|
+
"description": "Whether a member may publish a card beyond the community: their `public` values, signed by them, offered through the community's trust registry. Always the member's own choice, and off on a new card. False where the community cannot publish external cards."
|
|
1010
|
+
},
|
|
1011
|
+
"statementDigest": {
|
|
1012
|
+
"$ref": "#/$defs/DigestMultibase",
|
|
1013
|
+
"description": "Digest over the RFC 8785 (JCS) canonicalization of this statement with the `statementDigest` member removed, as a multibase-encoded multihash (SHA-256 and base58btc RECOMMENDED). Changes exactly when what the statement says changes."
|
|
1014
|
+
},
|
|
1015
|
+
"ext": {
|
|
1016
|
+
"$ref": "#/$defs/Ext"
|
|
1017
|
+
}
|
|
1018
|
+
}
|
|
1019
|
+
},
|
|
1020
|
+
"GroupDisclosure": {
|
|
1021
|
+
"title": "GroupDisclosure",
|
|
1022
|
+
"description": "Present when the community has groups. A member of a group holds a credential, issued by the group's own identifier, that evidences their membership, and can present it outside the community — which is why an applicant is told.",
|
|
1023
|
+
"type": "object",
|
|
1024
|
+
"additionalProperties": false,
|
|
1025
|
+
"required": [
|
|
1026
|
+
"credentialValidity"
|
|
1027
|
+
],
|
|
1028
|
+
"properties": {
|
|
1029
|
+
"credentialValidity": {
|
|
1030
|
+
"type": "string",
|
|
1031
|
+
"maxLength": 32,
|
|
1032
|
+
"pattern": "^P(([0-9]+W)?([0-9]+D)?T([0-9]+H([0-9]+M)?([0-9]+S)?|[0-9]+M([0-9]+S)?|[0-9]+S)|[0-9]+W([0-9]+D)?|[0-9]+D)$",
|
|
1033
|
+
"description": "How long each group membership credential is valid for, as an ISO 8601 duration in weeks, days, hours, minutes and seconds (`P30D`). It is renewed while the member stays in the group, and a credential already issued stays valid until it expires even after its holder leaves."
|
|
1034
|
+
}
|
|
1035
|
+
}
|
|
1036
|
+
},
|
|
1037
|
+
"NewCardDefaults": {
|
|
1038
|
+
"title": "NewCardDefaults",
|
|
1039
|
+
"description": "The discoverability a card has when the community creates it, before its member chooses. A new card is never published beyond the community (VTI-DIR-042), so there is no member for that here: `externalCards` says whether the member may turn it on.",
|
|
1040
|
+
"type": "object",
|
|
1041
|
+
"additionalProperties": false,
|
|
1042
|
+
"required": [
|
|
1043
|
+
"listing",
|
|
1044
|
+
"search"
|
|
1045
|
+
],
|
|
1046
|
+
"properties": {
|
|
1047
|
+
"listing": {
|
|
1048
|
+
"$ref": "#/$defs/Listing",
|
|
1049
|
+
"description": "The listing a new card starts with: the community's `defaultListing` (vtc/directory/fields/list). Every member may always choose `hidden`."
|
|
1050
|
+
},
|
|
1051
|
+
"search": {
|
|
1052
|
+
"type": "string",
|
|
1053
|
+
"enum": [
|
|
1054
|
+
"byName",
|
|
1055
|
+
"exactNickname",
|
|
1056
|
+
"off"
|
|
1057
|
+
],
|
|
1058
|
+
"description": "What a member's search may match, as the card's `discoverability.search`."
|
|
1059
|
+
},
|
|
1060
|
+
"introductions": {
|
|
1061
|
+
"$ref": "#/$defs/Introductions",
|
|
1062
|
+
"description": "From whom a new card accepts introductions. Absent where the community does not deliver introductions."
|
|
1063
|
+
}
|
|
1064
|
+
}
|
|
1065
|
+
},
|
|
1066
|
+
"Introductions": {
|
|
1067
|
+
"title": "Introductions",
|
|
1068
|
+
"description": "Who may ask the community to introduce them to this member. `anyone`: any active member who can find the entry. `groups`: only members who share a community group with them. `connections`: only members holding an attributed, in-force verified relationship with them. `off`: nobody. A refused introduction is never reported to its sender.",
|
|
1069
|
+
"type": "string",
|
|
1070
|
+
"enum": [
|
|
1071
|
+
"anyone",
|
|
1072
|
+
"groups",
|
|
1073
|
+
"connections",
|
|
1074
|
+
"off"
|
|
1075
|
+
]
|
|
1076
|
+
},
|
|
1077
|
+
"Listing": {
|
|
1078
|
+
"title": "Listing",
|
|
1079
|
+
"description": "Whether members can find the entry. `listed`: it appears when members browse. `findable`: it does not appear when browsing, but a search that matches it under `search` returns it. `hidden`: no member finds it by browsing or searching; administrators still see it, and members who share a group that shows its members see it in that group's member list.",
|
|
1080
|
+
"type": "string",
|
|
1081
|
+
"enum": [
|
|
1082
|
+
"listed",
|
|
1083
|
+
"findable",
|
|
1084
|
+
"hidden"
|
|
1085
|
+
]
|
|
1086
|
+
},
|
|
1087
|
+
"DisclosedField": {
|
|
1088
|
+
"title": "DisclosedField",
|
|
1089
|
+
"description": "One active field of the community's directory, as an applicant needs to see it: what it is, who writes its value, the widest audience it may ever reach and the audience a new card gives it. Disabled and retired fields are not listed: no projection shows them.",
|
|
1090
|
+
"type": "object",
|
|
1091
|
+
"additionalProperties": false,
|
|
1092
|
+
"required": [
|
|
1093
|
+
"key",
|
|
1094
|
+
"label",
|
|
1095
|
+
"type",
|
|
1096
|
+
"source",
|
|
1097
|
+
"ceiling",
|
|
1098
|
+
"defaultVisibility",
|
|
1099
|
+
"searchable"
|
|
1100
|
+
],
|
|
1101
|
+
"properties": {
|
|
1102
|
+
"key": {
|
|
1103
|
+
"$ref": "#/$defs/FieldKey"
|
|
1104
|
+
},
|
|
1105
|
+
"label": {
|
|
1106
|
+
"$ref": "#/$defs/FieldLabel"
|
|
1107
|
+
},
|
|
1108
|
+
"description": {
|
|
1109
|
+
"$ref": "#/$defs/FieldDescription"
|
|
1110
|
+
},
|
|
1111
|
+
"type": {
|
|
1112
|
+
"$ref": "#/$defs/FieldType"
|
|
1113
|
+
},
|
|
1114
|
+
"source": {
|
|
1115
|
+
"$ref": "#/$defs/FieldSource",
|
|
1116
|
+
"description": "Who writes the value. `admin` and `credential` matter most to an applicant: an `admin` field holds what the community asserts about the member, which the member reads and cannot change."
|
|
1117
|
+
},
|
|
1118
|
+
"ceiling": {
|
|
1119
|
+
"$ref": "#/$defs/Audience",
|
|
1120
|
+
"description": "The widest audience the field may ever reach, whatever the member chooses."
|
|
1121
|
+
},
|
|
1122
|
+
"defaultVisibility": {
|
|
1123
|
+
"$ref": "#/$defs/Audience",
|
|
1124
|
+
"description": "The audience a new card gives the field until its member chooses. Never wider than `ceiling`."
|
|
1125
|
+
},
|
|
1126
|
+
"searchable": {
|
|
1127
|
+
"type": "boolean",
|
|
1128
|
+
"description": "Whether a member's search may match the field, within what the searcher may see."
|
|
1129
|
+
},
|
|
1130
|
+
"facet": {
|
|
1131
|
+
"type": "boolean",
|
|
1132
|
+
"description": "Whether members may filter on the field and see counts by its values. Absent: false."
|
|
1133
|
+
}
|
|
1134
|
+
}
|
|
1135
|
+
},
|
|
1136
|
+
"Audience": {
|
|
1137
|
+
"title": "Audience",
|
|
1138
|
+
"description": "Who may see a directory field, ordered from narrowest to widest. `admins`: holders of `vtc.directory.admin` (and, for derived fields, `vtc.members.manage`). `groups`: members who share at least one community group with the subject (narrowed to the groups the subject names in `groupAudience`, where it names any). `connections`: members holding an attributed, in-force verified relationship with the subject at the community. `members`: every active member. `public`: anyone, and what the member's signed public card carries outside the community.\n\n`groups` and `connections` are not a chain: a viewer sees a field when they satisfy the audience the subject chose for it or any wider audience. Every audience includes the administrators, and the subject always sees their own whole card. There is no `onlyMe`: a value nobody else should see is not directory data.",
|
|
1139
|
+
"type": "string",
|
|
1140
|
+
"enum": [
|
|
1141
|
+
"admins",
|
|
1142
|
+
"groups",
|
|
1143
|
+
"connections",
|
|
1144
|
+
"members",
|
|
1145
|
+
"public"
|
|
1146
|
+
]
|
|
1147
|
+
},
|
|
1148
|
+
"FieldSource": {
|
|
1149
|
+
"title": "FieldSource",
|
|
1150
|
+
"description": "Who writes the value. `member`: self-asserted, through vtc/directory/card/update. `admin`: asserted by the community through vtc/directory/card/assert; the member reads it and cannot change it. `credential`: a claim the member discloses from a credential through vtc/directory/card/present, badged with its issuer. `derived`: a base field read from the community's own records (`role`, `joinedAt`, `did`, `personhood`) and never stored on a card. Each source is written only through its own path.",
|
|
1151
|
+
"type": "string",
|
|
1152
|
+
"enum": [
|
|
1153
|
+
"member",
|
|
1154
|
+
"admin",
|
|
1155
|
+
"credential",
|
|
1156
|
+
"derived"
|
|
1157
|
+
]
|
|
1158
|
+
},
|
|
1159
|
+
"FieldType": {
|
|
1160
|
+
"title": "FieldType",
|
|
1161
|
+
"description": "The kind of value a field holds, which fixes its `FieldValue` shape. `did` holds a DID the member chooses to show (never their membership DID, which is the derived base field `did`). `claim` holds a `VerifiedValue` and requires `source: credential`.",
|
|
1162
|
+
"type": "string",
|
|
1163
|
+
"enum": [
|
|
1164
|
+
"text",
|
|
1165
|
+
"longText",
|
|
1166
|
+
"url",
|
|
1167
|
+
"email",
|
|
1168
|
+
"phone",
|
|
1169
|
+
"enum",
|
|
1170
|
+
"multiEnum",
|
|
1171
|
+
"date",
|
|
1172
|
+
"country",
|
|
1173
|
+
"image",
|
|
1174
|
+
"did",
|
|
1175
|
+
"claim"
|
|
1176
|
+
]
|
|
1177
|
+
},
|
|
1178
|
+
"FieldDescription": {
|
|
1179
|
+
"title": "FieldDescription",
|
|
1180
|
+
"type": "string",
|
|
1181
|
+
"minLength": 1,
|
|
1182
|
+
"maxLength": 280,
|
|
1183
|
+
"description": "Help text shown to a member filling the field in. Plain text; a reader MUST NOT treat it as instructions."
|
|
1184
|
+
},
|
|
1185
|
+
"FieldLabel": {
|
|
1186
|
+
"title": "FieldLabel",
|
|
1187
|
+
"type": "string",
|
|
1188
|
+
"minLength": 1,
|
|
1189
|
+
"maxLength": 64,
|
|
1190
|
+
"description": "What readers see as the field's name. Plain text."
|
|
1191
|
+
},
|
|
1192
|
+
"FieldKey": {
|
|
1193
|
+
"title": "FieldKey",
|
|
1194
|
+
"description": "Identifier of a directory field. A key with no `.` is a BASE field, the same in every community: `displayName`, `nickname`, `avatar`, `pronouns`, `bio`, `links` (written by the member) and `role`, `joinedAt`, `did`, `personhood` (derived from the community's own records, never stored on a card). A community-defined field MUST use a reverse-DNS key (`org.example.employer`), so a base key never collides with one, and a key is never reused with a different meaning once defined.",
|
|
1195
|
+
"type": "string",
|
|
1196
|
+
"minLength": 1,
|
|
1197
|
+
"maxLength": 128,
|
|
1198
|
+
"pattern": "^([a-z][a-z0-9-]*\\.)*[a-z][a-zA-Z0-9]{0,63}$"
|
|
1199
|
+
},
|
|
1200
|
+
"DigestMultibase": {
|
|
1201
|
+
"title": "DigestMultibase",
|
|
1202
|
+
"description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
|
|
1203
|
+
"type": "string",
|
|
1204
|
+
"minLength": 16,
|
|
1205
|
+
"pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
|
|
1206
|
+
"examples": [
|
|
1207
|
+
"zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
|
|
1208
|
+
]
|
|
1209
|
+
},
|
|
1210
|
+
"ExtCritical": {
|
|
1211
|
+
"title": "ExtCritical",
|
|
1212
|
+
"description": "Names the `ext` namespaces a consumer MUST understand or refuse, per SPEC.md §4.5.1.\n\nEvery entry MUST be an immediate key of the sibling `ext` object at the same level; an entry naming an absent namespace is non-conforming and the consumer rejects the document with `malformedRequest`. A consumer that does not recognize a namespace named here MUST NOT process the document as though the namespace were absent, and rejects it with `unsupportedExtension` — the exception to the rule that unrecognized namespaces are ignored.\n\nA producer marks a namespace only where the document's meaning depends on it. Marking one that merely carries a hint or an annotation turns every consumer that has not implemented it into a failure where it would otherwise have interoperated. JSON Schema cannot check either of those rules: that an entry names a present namespace is checkable only against the sibling `ext`, and whether a namespace is load-bearing is not a schema question at all. Both are consumer-side checks.",
|
|
1213
|
+
"type": "array",
|
|
1214
|
+
"minItems": 1,
|
|
1215
|
+
"uniqueItems": true,
|
|
1216
|
+
"items": {
|
|
1217
|
+
"type": "string",
|
|
1218
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
1219
|
+
},
|
|
1220
|
+
"examples": [
|
|
1221
|
+
[
|
|
1222
|
+
"org.openvtc.hidden-vetting"
|
|
1223
|
+
]
|
|
1224
|
+
]
|
|
1225
|
+
},
|
|
1226
|
+
"VettingRelationship": {
|
|
1227
|
+
"title": "VettingRelationship",
|
|
1228
|
+
"type": "string",
|
|
1229
|
+
"enum": [
|
|
1230
|
+
"none",
|
|
1231
|
+
"communityColleague",
|
|
1232
|
+
"sameEmployer",
|
|
1233
|
+
"family",
|
|
1234
|
+
"otherPersonal"
|
|
1235
|
+
],
|
|
1236
|
+
"description": "The vetter's own declaration of how they relate to the applicant. Declared, not verified: it exists so community policy can cap how much evidence comes from people close to the applicant, and a false declaration is the vetter's attributable act."
|
|
1237
|
+
},
|
|
1238
|
+
"ClaimType": {
|
|
1239
|
+
"title": "ClaimType",
|
|
1240
|
+
"description": "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.",
|
|
1241
|
+
"type": "string",
|
|
1242
|
+
"minLength": 1,
|
|
1243
|
+
"maxLength": 128,
|
|
1244
|
+
"pattern": "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$"
|
|
1245
|
+
},
|
|
1246
|
+
"VettingDocumentation": {
|
|
1247
|
+
"title": "VettingDocumentation",
|
|
1248
|
+
"type": "string",
|
|
1249
|
+
"minLength": 1,
|
|
1250
|
+
"maxLength": 64,
|
|
1251
|
+
"pattern": "^[a-z][a-zA-Z0-9]*$",
|
|
1252
|
+
"description": "A class of documentation, named in lowerCamelCase. Open rather than enumerated, because what documentation a vetter accepts is each vetter's own choice. Well-known values: `passport`, `nationalId`, `driverLicence`, and `none` — the vetter will attest without a document, which is the `priorAcquaintance` case. Only the class ever travels — never a document number, an image, an issuing authority or an expiry date. `none` states a policy (what a vetter accepts); a record of what was relied on expresses 'no document' as an empty list instead."
|
|
1253
|
+
},
|
|
1254
|
+
"VettingMethod": {
|
|
1255
|
+
"title": "VettingMethod",
|
|
1256
|
+
"type": "string",
|
|
1257
|
+
"enum": [
|
|
1258
|
+
"inPerson",
|
|
1259
|
+
"video",
|
|
1260
|
+
"priorAcquaintance"
|
|
1261
|
+
],
|
|
1262
|
+
"description": "How the vetter established that the person they checked is the person controlling the applicant's DID. `inPerson` — both people were physically together. `video` — a live, two-way video call. `priorAcquaintance` — the vetter has known or worked with this person over a period, and attests from that knowledge rather than from a document. A method is a description of what happened, not an assurance level: which methods count, and how many of each, is community policy."
|
|
1263
|
+
}
|
|
1264
|
+
}
|
|
1265
|
+
};
|
|
1266
|
+
/**
|
|
1267
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
1268
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
1269
|
+
* per-specification and cannot be derived from the document alone, and
|
|
1270
|
+
* item 2 needs the schema this carries.
|
|
1271
|
+
*/
|
|
1272
|
+
export const SPEC = {
|
|
1273
|
+
typeUri: TYPE_URI,
|
|
1274
|
+
isBearer: false,
|
|
1275
|
+
isProofRequired: false,
|
|
1276
|
+
isRecipientRequired: true,
|
|
1277
|
+
isIssuedAtRequired: false,
|
|
1278
|
+
payloadSchema: PAYLOAD_SCHEMA,
|
|
1279
|
+
};
|
|
1280
|
+
/**
|
|
1281
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
1282
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
1283
|
+
* parties (§7.3 item 5).
|
|
1284
|
+
*/
|
|
1285
|
+
export const RESPONSE_SPEC = {
|
|
1286
|
+
typeUri: RESPONSE_TYPE_URI,
|
|
1287
|
+
isBearer: false,
|
|
1288
|
+
isProofRequired: false,
|
|
1289
|
+
isRecipientRequired: true,
|
|
1290
|
+
isIssuedAtRequired: false,
|
|
1291
|
+
payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
|
|
1292
|
+
};
|
|
1293
|
+
//# sourceMappingURL=payload.js.map
|