@openvtc/trust-tasks 0.19.11 → 0.19.13
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 +42 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/persona/attribute/put/1.0/payload.d.ts +183 -0
- package/dist/persona/attribute/put/1.0/payload.d.ts.map +1 -1
- package/dist/persona/attribute/put/1.0/payload.js +96 -0
- package/dist/persona/attribute/put/1.0/payload.js.map +1 -1
- package/dist/persona/binding/get/1.0/payload.d.ts +33 -5
- package/dist/persona/binding/get/1.0/payload.d.ts.map +1 -1
- package/dist/persona/binding/get/1.0/payload.js +14 -2
- package/dist/persona/binding/get/1.0/payload.js.map +1 -1
- package/dist/persona/binding/list/1.0/payload.d.ts +33 -5
- package/dist/persona/binding/list/1.0/payload.d.ts.map +1 -1
- package/dist/persona/binding/list/1.0/payload.js +14 -2
- package/dist/persona/binding/list/1.0/payload.js.map +1 -1
- package/dist/persona/binding/set/1.0/payload.d.ts +16 -0
- package/dist/persona/binding/set/1.0/payload.d.ts.map +1 -1
- package/dist/persona/binding/set/1.0/payload.js +6 -0
- package/dist/persona/binding/set/1.0/payload.js.map +1 -1
- package/dist/persona/disclosure/history/1.0/payload.d.ts +42 -0
- package/dist/persona/disclosure/history/1.0/payload.d.ts.map +1 -1
- package/dist/persona/disclosure/history/1.0/payload.js +28 -0
- package/dist/persona/disclosure/history/1.0/payload.js.map +1 -1
- package/dist/persona/local/binding/set/1.0/payload.d.ts +16 -0
- package/dist/persona/local/binding/set/1.0/payload.d.ts.map +1 -1
- package/dist/persona/local/binding/set/1.0/payload.js +6 -0
- package/dist/persona/local/binding/set/1.0/payload.js.map +1 -1
- package/dist/vtc/join-requests/supplement/0.1/payload.d.ts +569 -0
- package/dist/vtc/join-requests/supplement/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/join-requests/supplement/0.1/payload.js +319 -0
- package/dist/vtc/join-requests/supplement/0.1/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/index.ts +1 -0
- package/src/persona/attribute/put/1.0/payload.ts +115 -0
- package/src/persona/binding/get/1.0/payload.ts +19 -3
- package/src/persona/binding/list/1.0/payload.ts +19 -3
- package/src/persona/binding/set/1.0/payload.ts +10 -0
- package/src/persona/disclosure/history/1.0/payload.ts +34 -0
- package/src/persona/local/binding/set/1.0/payload.ts +10 -0
- package/src/vtc/join-requests/supplement/0.1/payload.ts +369 -0
|
@@ -0,0 +1,569 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/join-requests/supplement/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext, Verdict, VerdictEffect, VerdictWith } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* The evidence an applicant offers in answer to a community's request for more, against the join request they already have open. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
|
|
8
|
+
*/
|
|
9
|
+
export interface VTCJoinRequestsSupplementPayload {
|
|
10
|
+
/**
|
|
11
|
+
* The Verifiable Presentation satisfying the `presentationDefinition` the community returned when it deferred. It REPLACES the presentation on the request rather than adding to it, so it carries everything the community requires and not only the shortfall — see the spec's Definitions.
|
|
12
|
+
*/
|
|
13
|
+
vp: {};
|
|
14
|
+
/**
|
|
15
|
+
* The request to supplement. OPTIONAL: an applicant whose submit response was lost never received one, and the consumer then resolves the request from the authenticated applicant. A consumer given this value MUST prefer it over inferring the request from the caller.
|
|
16
|
+
*/
|
|
17
|
+
requestId?: string;
|
|
18
|
+
/**
|
|
19
|
+
* An opaque bag the community stores verbatim and this task does not interpret. Replaces the bag on the request on the same terms as `vp`.
|
|
20
|
+
*/
|
|
21
|
+
extensions?: {};
|
|
22
|
+
ext?: Ext;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* The community's fresh decision on the re-presented evidence. Failures use trust-task-error, not this shape.
|
|
26
|
+
*/
|
|
27
|
+
export interface VTCJoinRequestsSupplementResponsePayload {
|
|
28
|
+
/**
|
|
29
|
+
* The request that was re-decided (a UUID). Returned even when the request omitted it, so an applicant who used the id-less form learns which request they answered.
|
|
30
|
+
*/
|
|
31
|
+
requestId: string;
|
|
32
|
+
/**
|
|
33
|
+
* What the community decided on the new evidence, in the same shape `vtc/join-requests/submit` returns. MAY be any outcome a submission can produce, including a further request for more evidence and including a refusal.
|
|
34
|
+
*/
|
|
35
|
+
verdict: Verdict;
|
|
36
|
+
ext?: Ext;
|
|
37
|
+
}
|
|
38
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
39
|
+
export type { Ext, Verdict, VerdictEffect, VerdictWith };
|
|
40
|
+
/** Trust Task type URI. */
|
|
41
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/join-requests/supplement/0.1";
|
|
42
|
+
/** Stable alias for this specification's request payload shape. */
|
|
43
|
+
export type Payload = VTCJoinRequestsSupplementPayload;
|
|
44
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
45
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/join-requests/supplement/0.1#response";
|
|
46
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
47
|
+
export type Response = VTCJoinRequestsSupplementResponsePayload;
|
|
48
|
+
/**
|
|
49
|
+
* This specification's payload schema, as a value.
|
|
50
|
+
*
|
|
51
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
52
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
53
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
54
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
55
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
56
|
+
*/
|
|
57
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
58
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
59
|
+
readonly $id: "https://trusttasks.org/spec/vtc/join-requests/supplement/0.1";
|
|
60
|
+
readonly title: "VTC Join-Requests Supplement — payload";
|
|
61
|
+
readonly description: "The evidence an applicant offers in answer to a community's request for more, against the join request they already have open. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
|
|
62
|
+
readonly type: "object";
|
|
63
|
+
readonly additionalProperties: false;
|
|
64
|
+
readonly required: readonly ["vp"];
|
|
65
|
+
readonly properties: {
|
|
66
|
+
readonly vp: {
|
|
67
|
+
readonly type: "object";
|
|
68
|
+
readonly description: "The Verifiable Presentation satisfying the `presentationDefinition` the community returned when it deferred. It REPLACES the presentation on the request rather than adding to it, so it carries everything the community requires and not only the shortfall — see the spec's Definitions.";
|
|
69
|
+
};
|
|
70
|
+
readonly requestId: {
|
|
71
|
+
readonly type: "string";
|
|
72
|
+
readonly minLength: 1;
|
|
73
|
+
readonly description: "The request to supplement. OPTIONAL: an applicant whose submit response was lost never received one, and the consumer then resolves the request from the authenticated applicant. A consumer given this value MUST prefer it over inferring the request from the caller.";
|
|
74
|
+
};
|
|
75
|
+
readonly extensions: {
|
|
76
|
+
readonly type: "object";
|
|
77
|
+
readonly description: "An opaque bag the community stores verbatim and this task does not interpret. Replaces the bag on the request on the same terms as `vp`.";
|
|
78
|
+
};
|
|
79
|
+
readonly ext: {
|
|
80
|
+
readonly $ref: "#/$defs/Ext";
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
readonly $defs: {
|
|
84
|
+
readonly Response: {
|
|
85
|
+
readonly $anchor: "response";
|
|
86
|
+
readonly title: "VTC Join-Requests Supplement — response payload";
|
|
87
|
+
readonly type: "object";
|
|
88
|
+
readonly additionalProperties: false;
|
|
89
|
+
readonly required: readonly ["requestId", "verdict"];
|
|
90
|
+
readonly description: "The community's fresh decision on the re-presented evidence. Failures use trust-task-error, not this shape.";
|
|
91
|
+
readonly properties: {
|
|
92
|
+
readonly requestId: {
|
|
93
|
+
readonly type: "string";
|
|
94
|
+
readonly minLength: 1;
|
|
95
|
+
readonly description: "The request that was re-decided (a UUID). Returned even when the request omitted it, so an applicant who used the id-less form learns which request they answered.";
|
|
96
|
+
};
|
|
97
|
+
readonly verdict: {
|
|
98
|
+
readonly $ref: "#/$defs/Verdict";
|
|
99
|
+
readonly description: "What the community decided on the new evidence, in the same shape `vtc/join-requests/submit` returns. MAY be any outcome a submission can produce, including a further request for more evidence and including a refusal.";
|
|
100
|
+
};
|
|
101
|
+
readonly ext: {
|
|
102
|
+
readonly $ref: "#/$defs/Ext";
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
readonly Ext: {
|
|
107
|
+
readonly title: "Ext";
|
|
108
|
+
readonly 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.";
|
|
109
|
+
readonly type: "object";
|
|
110
|
+
readonly minProperties: 1;
|
|
111
|
+
readonly additionalProperties: true;
|
|
112
|
+
readonly propertyNames: {
|
|
113
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
readonly Verdict: {
|
|
117
|
+
readonly $anchor: "verdict";
|
|
118
|
+
readonly title: "Verdict";
|
|
119
|
+
readonly type: "object";
|
|
120
|
+
readonly additionalProperties: false;
|
|
121
|
+
readonly required: readonly ["effect", "with"];
|
|
122
|
+
readonly description: "A ceremony decision: the effect, plus its effect-dependent detail.";
|
|
123
|
+
readonly properties: {
|
|
124
|
+
readonly effect: {
|
|
125
|
+
readonly $ref: "#/$defs/VerdictEffect";
|
|
126
|
+
};
|
|
127
|
+
readonly with: {
|
|
128
|
+
readonly $ref: "#/$defs/VerdictWith";
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
};
|
|
132
|
+
readonly VerdictWith: {
|
|
133
|
+
readonly $anchor: "verdictWith";
|
|
134
|
+
readonly title: "VerdictWith";
|
|
135
|
+
readonly type: "object";
|
|
136
|
+
readonly additionalProperties: false;
|
|
137
|
+
readonly description: "The effect-dependent detail of a verdict.\n\nEvery member is optional at the schema level and which ones are meaningful depends on `effect`: `role` / `obligations` / `bundleRef` on `allow`, `code` / `reason` on `deny`, `queue` / `reason` on `refer`, `needs` / `presentationDefinition` on `requestMore`. The dependency is stated here rather than enforced by `if`/`then` per effect, so that the shape stays a single flat object a generated type can carry without a discriminated union per family — a deliberate trade of schema strictness for implementability, and the reason a consumer MUST branch on `effect` rather than on which members happen to be present.";
|
|
138
|
+
readonly properties: {
|
|
139
|
+
readonly role: {
|
|
140
|
+
readonly type: "string";
|
|
141
|
+
readonly minLength: 1;
|
|
142
|
+
readonly description: "The granted local role. `allow` only.";
|
|
143
|
+
};
|
|
144
|
+
readonly obligations: {
|
|
145
|
+
readonly type: "object";
|
|
146
|
+
readonly description: "Conditions attached to the grant. `allow` only.";
|
|
147
|
+
};
|
|
148
|
+
readonly bundleRef: {
|
|
149
|
+
readonly type: "object";
|
|
150
|
+
readonly description: "Pointer to a sealed credential bundle, added by the community where issuance occurred rather than emitted by the policy. `allow` only.";
|
|
151
|
+
};
|
|
152
|
+
readonly code: {
|
|
153
|
+
readonly type: "string";
|
|
154
|
+
readonly minLength: 1;
|
|
155
|
+
readonly description: "Stable refusal code, safe to branch on. `deny` only.";
|
|
156
|
+
};
|
|
157
|
+
readonly reason: {
|
|
158
|
+
readonly type: readonly ["string", "null"];
|
|
159
|
+
readonly maxLength: 1024;
|
|
160
|
+
readonly description: "Elaboration in prose, when the decider gave one. `deny` and `refer`.";
|
|
161
|
+
};
|
|
162
|
+
readonly queue: {
|
|
163
|
+
readonly type: "string";
|
|
164
|
+
readonly minLength: 1;
|
|
165
|
+
readonly description: "Which review queue the decision was parked in, so an applicant can be told who now holds it. `refer` only.";
|
|
166
|
+
};
|
|
167
|
+
readonly needs: {
|
|
168
|
+
readonly type: "array";
|
|
169
|
+
readonly items: {
|
|
170
|
+
readonly type: "string";
|
|
171
|
+
readonly minLength: 1;
|
|
172
|
+
};
|
|
173
|
+
readonly description: "What further evidence is required, named so the applicant can act without a support conversation. `requestMore` only.";
|
|
174
|
+
};
|
|
175
|
+
readonly presentationDefinition: {
|
|
176
|
+
readonly type: "object";
|
|
177
|
+
readonly description: "A machine-readable statement of the same request, so a wallet can satisfy it without a human reading `needs`. `requestMore` only.";
|
|
178
|
+
};
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
readonly VerdictEffect: {
|
|
182
|
+
readonly $anchor: "verdictEffect";
|
|
183
|
+
readonly title: "VerdictEffect";
|
|
184
|
+
readonly type: "string";
|
|
185
|
+
readonly enum: readonly ["allow", "deny", "refer", "requestMore"];
|
|
186
|
+
readonly description: "What the policy decided.\n\n`allow` — admitted. `deny` — refused, terminally for this submission. `refer` — parked for a human or quorum decision; the applicant is neither in nor out. `requestMore` — the policy cannot decide yet and names what further evidence it needs.\n\nThe four are not reducible to a pending/decided pair. `refer` and `requestMore` are both 'not decided', but they place the next action with different parties: `refer` waits on the community, `requestMore` waits on the applicant. A consumer that cannot tell them apart cannot tell a user whether to wait or to act.";
|
|
187
|
+
};
|
|
188
|
+
};
|
|
189
|
+
};
|
|
190
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
191
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
192
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
193
|
+
readonly $ref: "#/$defs/Response";
|
|
194
|
+
readonly $defs: {
|
|
195
|
+
readonly Response: {
|
|
196
|
+
readonly $anchor: "response";
|
|
197
|
+
readonly title: "VTC Join-Requests Supplement — response payload";
|
|
198
|
+
readonly type: "object";
|
|
199
|
+
readonly additionalProperties: false;
|
|
200
|
+
readonly required: readonly ["requestId", "verdict"];
|
|
201
|
+
readonly description: "The community's fresh decision on the re-presented evidence. Failures use trust-task-error, not this shape.";
|
|
202
|
+
readonly properties: {
|
|
203
|
+
readonly requestId: {
|
|
204
|
+
readonly type: "string";
|
|
205
|
+
readonly minLength: 1;
|
|
206
|
+
readonly description: "The request that was re-decided (a UUID). Returned even when the request omitted it, so an applicant who used the id-less form learns which request they answered.";
|
|
207
|
+
};
|
|
208
|
+
readonly verdict: {
|
|
209
|
+
readonly $ref: "#/$defs/Verdict";
|
|
210
|
+
readonly description: "What the community decided on the new evidence, in the same shape `vtc/join-requests/submit` returns. MAY be any outcome a submission can produce, including a further request for more evidence and including a refusal.";
|
|
211
|
+
};
|
|
212
|
+
readonly ext: {
|
|
213
|
+
readonly $ref: "#/$defs/Ext";
|
|
214
|
+
};
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
readonly Ext: {
|
|
218
|
+
readonly title: "Ext";
|
|
219
|
+
readonly 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.";
|
|
220
|
+
readonly type: "object";
|
|
221
|
+
readonly minProperties: 1;
|
|
222
|
+
readonly additionalProperties: true;
|
|
223
|
+
readonly propertyNames: {
|
|
224
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
readonly Verdict: {
|
|
228
|
+
readonly $anchor: "verdict";
|
|
229
|
+
readonly title: "Verdict";
|
|
230
|
+
readonly type: "object";
|
|
231
|
+
readonly additionalProperties: false;
|
|
232
|
+
readonly required: readonly ["effect", "with"];
|
|
233
|
+
readonly description: "A ceremony decision: the effect, plus its effect-dependent detail.";
|
|
234
|
+
readonly properties: {
|
|
235
|
+
readonly effect: {
|
|
236
|
+
readonly $ref: "#/$defs/VerdictEffect";
|
|
237
|
+
};
|
|
238
|
+
readonly with: {
|
|
239
|
+
readonly $ref: "#/$defs/VerdictWith";
|
|
240
|
+
};
|
|
241
|
+
};
|
|
242
|
+
};
|
|
243
|
+
readonly VerdictWith: {
|
|
244
|
+
readonly $anchor: "verdictWith";
|
|
245
|
+
readonly title: "VerdictWith";
|
|
246
|
+
readonly type: "object";
|
|
247
|
+
readonly additionalProperties: false;
|
|
248
|
+
readonly description: "The effect-dependent detail of a verdict.\n\nEvery member is optional at the schema level and which ones are meaningful depends on `effect`: `role` / `obligations` / `bundleRef` on `allow`, `code` / `reason` on `deny`, `queue` / `reason` on `refer`, `needs` / `presentationDefinition` on `requestMore`. The dependency is stated here rather than enforced by `if`/`then` per effect, so that the shape stays a single flat object a generated type can carry without a discriminated union per family — a deliberate trade of schema strictness for implementability, and the reason a consumer MUST branch on `effect` rather than on which members happen to be present.";
|
|
249
|
+
readonly properties: {
|
|
250
|
+
readonly role: {
|
|
251
|
+
readonly type: "string";
|
|
252
|
+
readonly minLength: 1;
|
|
253
|
+
readonly description: "The granted local role. `allow` only.";
|
|
254
|
+
};
|
|
255
|
+
readonly obligations: {
|
|
256
|
+
readonly type: "object";
|
|
257
|
+
readonly description: "Conditions attached to the grant. `allow` only.";
|
|
258
|
+
};
|
|
259
|
+
readonly bundleRef: {
|
|
260
|
+
readonly type: "object";
|
|
261
|
+
readonly description: "Pointer to a sealed credential bundle, added by the community where issuance occurred rather than emitted by the policy. `allow` only.";
|
|
262
|
+
};
|
|
263
|
+
readonly code: {
|
|
264
|
+
readonly type: "string";
|
|
265
|
+
readonly minLength: 1;
|
|
266
|
+
readonly description: "Stable refusal code, safe to branch on. `deny` only.";
|
|
267
|
+
};
|
|
268
|
+
readonly reason: {
|
|
269
|
+
readonly type: readonly ["string", "null"];
|
|
270
|
+
readonly maxLength: 1024;
|
|
271
|
+
readonly description: "Elaboration in prose, when the decider gave one. `deny` and `refer`.";
|
|
272
|
+
};
|
|
273
|
+
readonly queue: {
|
|
274
|
+
readonly type: "string";
|
|
275
|
+
readonly minLength: 1;
|
|
276
|
+
readonly description: "Which review queue the decision was parked in, so an applicant can be told who now holds it. `refer` only.";
|
|
277
|
+
};
|
|
278
|
+
readonly needs: {
|
|
279
|
+
readonly type: "array";
|
|
280
|
+
readonly items: {
|
|
281
|
+
readonly type: "string";
|
|
282
|
+
readonly minLength: 1;
|
|
283
|
+
};
|
|
284
|
+
readonly description: "What further evidence is required, named so the applicant can act without a support conversation. `requestMore` only.";
|
|
285
|
+
};
|
|
286
|
+
readonly presentationDefinition: {
|
|
287
|
+
readonly type: "object";
|
|
288
|
+
readonly description: "A machine-readable statement of the same request, so a wallet can satisfy it without a human reading `needs`. `requestMore` only.";
|
|
289
|
+
};
|
|
290
|
+
};
|
|
291
|
+
};
|
|
292
|
+
readonly VerdictEffect: {
|
|
293
|
+
readonly $anchor: "verdictEffect";
|
|
294
|
+
readonly title: "VerdictEffect";
|
|
295
|
+
readonly type: "string";
|
|
296
|
+
readonly enum: readonly ["allow", "deny", "refer", "requestMore"];
|
|
297
|
+
readonly description: "What the policy decided.\n\n`allow` — admitted. `deny` — refused, terminally for this submission. `refer` — parked for a human or quorum decision; the applicant is neither in nor out. `requestMore` — the policy cannot decide yet and names what further evidence it needs.\n\nThe four are not reducible to a pending/decided pair. `refer` and `requestMore` are both 'not decided', but they place the next action with different parties: `refer` waits on the community, `requestMore` waits on the applicant. A consumer that cannot tell them apart cannot tell a user whether to wait or to act.";
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
};
|
|
301
|
+
/**
|
|
302
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
303
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
304
|
+
* per-specification and cannot be derived from the document alone, and
|
|
305
|
+
* item 2 needs the schema this carries.
|
|
306
|
+
*/
|
|
307
|
+
export declare const SPEC: {
|
|
308
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/join-requests/supplement/0.1";
|
|
309
|
+
readonly isBearer: false;
|
|
310
|
+
readonly isProofRequired: true;
|
|
311
|
+
readonly isRecipientRequired: true;
|
|
312
|
+
readonly isIssuedAtRequired: true;
|
|
313
|
+
readonly payloadSchema: {
|
|
314
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
315
|
+
readonly $id: "https://trusttasks.org/spec/vtc/join-requests/supplement/0.1";
|
|
316
|
+
readonly title: "VTC Join-Requests Supplement — payload";
|
|
317
|
+
readonly description: "The evidence an applicant offers in answer to a community's request for more, against the join request they already have open. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
|
|
318
|
+
readonly type: "object";
|
|
319
|
+
readonly additionalProperties: false;
|
|
320
|
+
readonly required: readonly ["vp"];
|
|
321
|
+
readonly properties: {
|
|
322
|
+
readonly vp: {
|
|
323
|
+
readonly type: "object";
|
|
324
|
+
readonly description: "The Verifiable Presentation satisfying the `presentationDefinition` the community returned when it deferred. It REPLACES the presentation on the request rather than adding to it, so it carries everything the community requires and not only the shortfall — see the spec's Definitions.";
|
|
325
|
+
};
|
|
326
|
+
readonly requestId: {
|
|
327
|
+
readonly type: "string";
|
|
328
|
+
readonly minLength: 1;
|
|
329
|
+
readonly description: "The request to supplement. OPTIONAL: an applicant whose submit response was lost never received one, and the consumer then resolves the request from the authenticated applicant. A consumer given this value MUST prefer it over inferring the request from the caller.";
|
|
330
|
+
};
|
|
331
|
+
readonly extensions: {
|
|
332
|
+
readonly type: "object";
|
|
333
|
+
readonly description: "An opaque bag the community stores verbatim and this task does not interpret. Replaces the bag on the request on the same terms as `vp`.";
|
|
334
|
+
};
|
|
335
|
+
readonly ext: {
|
|
336
|
+
readonly $ref: "#/$defs/Ext";
|
|
337
|
+
};
|
|
338
|
+
};
|
|
339
|
+
readonly $defs: {
|
|
340
|
+
readonly Response: {
|
|
341
|
+
readonly $anchor: "response";
|
|
342
|
+
readonly title: "VTC Join-Requests Supplement — response payload";
|
|
343
|
+
readonly type: "object";
|
|
344
|
+
readonly additionalProperties: false;
|
|
345
|
+
readonly required: readonly ["requestId", "verdict"];
|
|
346
|
+
readonly description: "The community's fresh decision on the re-presented evidence. Failures use trust-task-error, not this shape.";
|
|
347
|
+
readonly properties: {
|
|
348
|
+
readonly requestId: {
|
|
349
|
+
readonly type: "string";
|
|
350
|
+
readonly minLength: 1;
|
|
351
|
+
readonly description: "The request that was re-decided (a UUID). Returned even when the request omitted it, so an applicant who used the id-less form learns which request they answered.";
|
|
352
|
+
};
|
|
353
|
+
readonly verdict: {
|
|
354
|
+
readonly $ref: "#/$defs/Verdict";
|
|
355
|
+
readonly description: "What the community decided on the new evidence, in the same shape `vtc/join-requests/submit` returns. MAY be any outcome a submission can produce, including a further request for more evidence and including a refusal.";
|
|
356
|
+
};
|
|
357
|
+
readonly ext: {
|
|
358
|
+
readonly $ref: "#/$defs/Ext";
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
};
|
|
362
|
+
readonly Ext: {
|
|
363
|
+
readonly title: "Ext";
|
|
364
|
+
readonly 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.";
|
|
365
|
+
readonly type: "object";
|
|
366
|
+
readonly minProperties: 1;
|
|
367
|
+
readonly additionalProperties: true;
|
|
368
|
+
readonly propertyNames: {
|
|
369
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
370
|
+
};
|
|
371
|
+
};
|
|
372
|
+
readonly Verdict: {
|
|
373
|
+
readonly $anchor: "verdict";
|
|
374
|
+
readonly title: "Verdict";
|
|
375
|
+
readonly type: "object";
|
|
376
|
+
readonly additionalProperties: false;
|
|
377
|
+
readonly required: readonly ["effect", "with"];
|
|
378
|
+
readonly description: "A ceremony decision: the effect, plus its effect-dependent detail.";
|
|
379
|
+
readonly properties: {
|
|
380
|
+
readonly effect: {
|
|
381
|
+
readonly $ref: "#/$defs/VerdictEffect";
|
|
382
|
+
};
|
|
383
|
+
readonly with: {
|
|
384
|
+
readonly $ref: "#/$defs/VerdictWith";
|
|
385
|
+
};
|
|
386
|
+
};
|
|
387
|
+
};
|
|
388
|
+
readonly VerdictWith: {
|
|
389
|
+
readonly $anchor: "verdictWith";
|
|
390
|
+
readonly title: "VerdictWith";
|
|
391
|
+
readonly type: "object";
|
|
392
|
+
readonly additionalProperties: false;
|
|
393
|
+
readonly description: "The effect-dependent detail of a verdict.\n\nEvery member is optional at the schema level and which ones are meaningful depends on `effect`: `role` / `obligations` / `bundleRef` on `allow`, `code` / `reason` on `deny`, `queue` / `reason` on `refer`, `needs` / `presentationDefinition` on `requestMore`. The dependency is stated here rather than enforced by `if`/`then` per effect, so that the shape stays a single flat object a generated type can carry without a discriminated union per family — a deliberate trade of schema strictness for implementability, and the reason a consumer MUST branch on `effect` rather than on which members happen to be present.";
|
|
394
|
+
readonly properties: {
|
|
395
|
+
readonly role: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly minLength: 1;
|
|
398
|
+
readonly description: "The granted local role. `allow` only.";
|
|
399
|
+
};
|
|
400
|
+
readonly obligations: {
|
|
401
|
+
readonly type: "object";
|
|
402
|
+
readonly description: "Conditions attached to the grant. `allow` only.";
|
|
403
|
+
};
|
|
404
|
+
readonly bundleRef: {
|
|
405
|
+
readonly type: "object";
|
|
406
|
+
readonly description: "Pointer to a sealed credential bundle, added by the community where issuance occurred rather than emitted by the policy. `allow` only.";
|
|
407
|
+
};
|
|
408
|
+
readonly code: {
|
|
409
|
+
readonly type: "string";
|
|
410
|
+
readonly minLength: 1;
|
|
411
|
+
readonly description: "Stable refusal code, safe to branch on. `deny` only.";
|
|
412
|
+
};
|
|
413
|
+
readonly reason: {
|
|
414
|
+
readonly type: readonly ["string", "null"];
|
|
415
|
+
readonly maxLength: 1024;
|
|
416
|
+
readonly description: "Elaboration in prose, when the decider gave one. `deny` and `refer`.";
|
|
417
|
+
};
|
|
418
|
+
readonly queue: {
|
|
419
|
+
readonly type: "string";
|
|
420
|
+
readonly minLength: 1;
|
|
421
|
+
readonly description: "Which review queue the decision was parked in, so an applicant can be told who now holds it. `refer` only.";
|
|
422
|
+
};
|
|
423
|
+
readonly needs: {
|
|
424
|
+
readonly type: "array";
|
|
425
|
+
readonly items: {
|
|
426
|
+
readonly type: "string";
|
|
427
|
+
readonly minLength: 1;
|
|
428
|
+
};
|
|
429
|
+
readonly description: "What further evidence is required, named so the applicant can act without a support conversation. `requestMore` only.";
|
|
430
|
+
};
|
|
431
|
+
readonly presentationDefinition: {
|
|
432
|
+
readonly type: "object";
|
|
433
|
+
readonly description: "A machine-readable statement of the same request, so a wallet can satisfy it without a human reading `needs`. `requestMore` only.";
|
|
434
|
+
};
|
|
435
|
+
};
|
|
436
|
+
};
|
|
437
|
+
readonly VerdictEffect: {
|
|
438
|
+
readonly $anchor: "verdictEffect";
|
|
439
|
+
readonly title: "VerdictEffect";
|
|
440
|
+
readonly type: "string";
|
|
441
|
+
readonly enum: readonly ["allow", "deny", "refer", "requestMore"];
|
|
442
|
+
readonly description: "What the policy decided.\n\n`allow` — admitted. `deny` — refused, terminally for this submission. `refer` — parked for a human or quorum decision; the applicant is neither in nor out. `requestMore` — the policy cannot decide yet and names what further evidence it needs.\n\nThe four are not reducible to a pending/decided pair. `refer` and `requestMore` are both 'not decided', but they place the next action with different parties: `refer` waits on the community, `requestMore` waits on the applicant. A consumer that cannot tell them apart cannot tell a user whether to wait or to act.";
|
|
443
|
+
};
|
|
444
|
+
};
|
|
445
|
+
};
|
|
446
|
+
};
|
|
447
|
+
/**
|
|
448
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
449
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
450
|
+
* parties (§7.3 item 5).
|
|
451
|
+
*/
|
|
452
|
+
export declare const RESPONSE_SPEC: {
|
|
453
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/join-requests/supplement/0.1#response";
|
|
454
|
+
readonly isBearer: false;
|
|
455
|
+
readonly isProofRequired: false;
|
|
456
|
+
readonly isRecipientRequired: true;
|
|
457
|
+
readonly isIssuedAtRequired: true;
|
|
458
|
+
readonly payloadSchema: {
|
|
459
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
460
|
+
readonly $ref: "#/$defs/Response";
|
|
461
|
+
readonly $defs: {
|
|
462
|
+
readonly Response: {
|
|
463
|
+
readonly $anchor: "response";
|
|
464
|
+
readonly title: "VTC Join-Requests Supplement — response payload";
|
|
465
|
+
readonly type: "object";
|
|
466
|
+
readonly additionalProperties: false;
|
|
467
|
+
readonly required: readonly ["requestId", "verdict"];
|
|
468
|
+
readonly description: "The community's fresh decision on the re-presented evidence. Failures use trust-task-error, not this shape.";
|
|
469
|
+
readonly properties: {
|
|
470
|
+
readonly requestId: {
|
|
471
|
+
readonly type: "string";
|
|
472
|
+
readonly minLength: 1;
|
|
473
|
+
readonly description: "The request that was re-decided (a UUID). Returned even when the request omitted it, so an applicant who used the id-less form learns which request they answered.";
|
|
474
|
+
};
|
|
475
|
+
readonly verdict: {
|
|
476
|
+
readonly $ref: "#/$defs/Verdict";
|
|
477
|
+
readonly description: "What the community decided on the new evidence, in the same shape `vtc/join-requests/submit` returns. MAY be any outcome a submission can produce, including a further request for more evidence and including a refusal.";
|
|
478
|
+
};
|
|
479
|
+
readonly ext: {
|
|
480
|
+
readonly $ref: "#/$defs/Ext";
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
};
|
|
484
|
+
readonly Ext: {
|
|
485
|
+
readonly title: "Ext";
|
|
486
|
+
readonly 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.";
|
|
487
|
+
readonly type: "object";
|
|
488
|
+
readonly minProperties: 1;
|
|
489
|
+
readonly additionalProperties: true;
|
|
490
|
+
readonly propertyNames: {
|
|
491
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
492
|
+
};
|
|
493
|
+
};
|
|
494
|
+
readonly Verdict: {
|
|
495
|
+
readonly $anchor: "verdict";
|
|
496
|
+
readonly title: "Verdict";
|
|
497
|
+
readonly type: "object";
|
|
498
|
+
readonly additionalProperties: false;
|
|
499
|
+
readonly required: readonly ["effect", "with"];
|
|
500
|
+
readonly description: "A ceremony decision: the effect, plus its effect-dependent detail.";
|
|
501
|
+
readonly properties: {
|
|
502
|
+
readonly effect: {
|
|
503
|
+
readonly $ref: "#/$defs/VerdictEffect";
|
|
504
|
+
};
|
|
505
|
+
readonly with: {
|
|
506
|
+
readonly $ref: "#/$defs/VerdictWith";
|
|
507
|
+
};
|
|
508
|
+
};
|
|
509
|
+
};
|
|
510
|
+
readonly VerdictWith: {
|
|
511
|
+
readonly $anchor: "verdictWith";
|
|
512
|
+
readonly title: "VerdictWith";
|
|
513
|
+
readonly type: "object";
|
|
514
|
+
readonly additionalProperties: false;
|
|
515
|
+
readonly description: "The effect-dependent detail of a verdict.\n\nEvery member is optional at the schema level and which ones are meaningful depends on `effect`: `role` / `obligations` / `bundleRef` on `allow`, `code` / `reason` on `deny`, `queue` / `reason` on `refer`, `needs` / `presentationDefinition` on `requestMore`. The dependency is stated here rather than enforced by `if`/`then` per effect, so that the shape stays a single flat object a generated type can carry without a discriminated union per family — a deliberate trade of schema strictness for implementability, and the reason a consumer MUST branch on `effect` rather than on which members happen to be present.";
|
|
516
|
+
readonly properties: {
|
|
517
|
+
readonly role: {
|
|
518
|
+
readonly type: "string";
|
|
519
|
+
readonly minLength: 1;
|
|
520
|
+
readonly description: "The granted local role. `allow` only.";
|
|
521
|
+
};
|
|
522
|
+
readonly obligations: {
|
|
523
|
+
readonly type: "object";
|
|
524
|
+
readonly description: "Conditions attached to the grant. `allow` only.";
|
|
525
|
+
};
|
|
526
|
+
readonly bundleRef: {
|
|
527
|
+
readonly type: "object";
|
|
528
|
+
readonly description: "Pointer to a sealed credential bundle, added by the community where issuance occurred rather than emitted by the policy. `allow` only.";
|
|
529
|
+
};
|
|
530
|
+
readonly code: {
|
|
531
|
+
readonly type: "string";
|
|
532
|
+
readonly minLength: 1;
|
|
533
|
+
readonly description: "Stable refusal code, safe to branch on. `deny` only.";
|
|
534
|
+
};
|
|
535
|
+
readonly reason: {
|
|
536
|
+
readonly type: readonly ["string", "null"];
|
|
537
|
+
readonly maxLength: 1024;
|
|
538
|
+
readonly description: "Elaboration in prose, when the decider gave one. `deny` and `refer`.";
|
|
539
|
+
};
|
|
540
|
+
readonly queue: {
|
|
541
|
+
readonly type: "string";
|
|
542
|
+
readonly minLength: 1;
|
|
543
|
+
readonly description: "Which review queue the decision was parked in, so an applicant can be told who now holds it. `refer` only.";
|
|
544
|
+
};
|
|
545
|
+
readonly needs: {
|
|
546
|
+
readonly type: "array";
|
|
547
|
+
readonly items: {
|
|
548
|
+
readonly type: "string";
|
|
549
|
+
readonly minLength: 1;
|
|
550
|
+
};
|
|
551
|
+
readonly description: "What further evidence is required, named so the applicant can act without a support conversation. `requestMore` only.";
|
|
552
|
+
};
|
|
553
|
+
readonly presentationDefinition: {
|
|
554
|
+
readonly type: "object";
|
|
555
|
+
readonly description: "A machine-readable statement of the same request, so a wallet can satisfy it without a human reading `needs`. `requestMore` only.";
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
readonly VerdictEffect: {
|
|
560
|
+
readonly $anchor: "verdictEffect";
|
|
561
|
+
readonly title: "VerdictEffect";
|
|
562
|
+
readonly type: "string";
|
|
563
|
+
readonly enum: readonly ["allow", "deny", "refer", "requestMore"];
|
|
564
|
+
readonly description: "What the policy decided.\n\n`allow` — admitted. `deny` — refused, terminally for this submission. `refer` — parked for a human or quorum decision; the applicant is neither in nor out. `requestMore` — the policy cannot decide yet and names what further evidence it needs.\n\nThe four are not reducible to a pending/decided pair. `refer` and `requestMore` are both 'not decided', but they place the next action with different parties: `refer` waits on the community, `requestMore` waits on the applicant. A consumer that cannot tell them apart cannot tell a user whether to wait or to act.";
|
|
565
|
+
};
|
|
566
|
+
};
|
|
567
|
+
};
|
|
568
|
+
};
|
|
569
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vtc/join-requests/supplement/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAGlG;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,EAAE,CAAC;IACP;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACvD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC;AAEzD,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,8DAAuE,CAAC;AAEhG,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,gCAAgC,CAAC;AAEvD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,uEAAgF,CAAC;AAElH,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,wCAAwC,CAAC;AAEhE;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoJjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2H1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|