@openvtc/trust-tasks 0.26.11 → 0.26.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 +303 -0
- package/dist/_shared/components.d.ts +18 -0
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +12 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +12 -0
- package/dist/index.js.map +1 -1
- package/dist/rooms/keys/act/0.3/payload.d.ts +546 -0
- package/dist/rooms/keys/act/0.3/payload.d.ts.map +1 -0
- package/dist/rooms/keys/act/0.3/payload.js +305 -0
- package/dist/rooms/keys/act/0.3/payload.js.map +1 -0
- package/dist/rooms/owner/group/add/0.2/payload.d.ts +417 -0
- package/dist/rooms/owner/group/add/0.2/payload.d.ts.map +1 -0
- package/dist/rooms/owner/group/add/0.2/payload.js +218 -0
- package/dist/rooms/owner/group/add/0.2/payload.js.map +1 -0
- package/dist/vta/_shared/0.6/witness-party.d.ts +16 -0
- package/dist/vta/_shared/0.6/witness-party.d.ts.map +1 -0
- package/dist/vta/_shared/0.6/witness-party.js +6 -0
- package/dist/vta/_shared/0.6/witness-party.js.map +1 -0
- package/dist/vta/witness/accept/0.2/payload.d.ts +499 -0
- package/dist/vta/witness/accept/0.2/payload.d.ts.map +1 -0
- package/dist/vta/witness/accept/0.2/payload.js +278 -0
- package/dist/vta/witness/accept/0.2/payload.js.map +1 -0
- package/dist/vta/witness/list/0.1/payload.d.ts +673 -0
- package/dist/vta/witness/list/0.1/payload.d.ts.map +1 -0
- package/dist/vta/witness/list/0.1/payload.js +351 -0
- package/dist/vta/witness/list/0.1/payload.js.map +1 -0
- package/dist/vta/witness/open/0.2/payload.d.ts +500 -0
- package/dist/vta/witness/open/0.2/payload.d.ts.map +1 -0
- package/dist/vta/witness/open/0.2/payload.js +259 -0
- package/dist/vta/witness/open/0.2/payload.js.map +1 -0
- package/dist/vta/witness/present/0.2/payload.d.ts +303 -0
- package/dist/vta/witness/present/0.2/payload.d.ts.map +1 -0
- package/dist/vta/witness/present/0.2/payload.js +170 -0
- package/dist/vta/witness/present/0.2/payload.js.map +1 -0
- package/dist/vtc/members/personhood/assert/0.2/payload.d.ts +536 -0
- package/dist/vtc/members/personhood/assert/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/members/personhood/assert/0.2/payload.js +228 -0
- package/dist/vtc/members/personhood/assert/0.2/payload.js.map +1 -0
- package/dist/vtc/members/registry-consent/0.1/payload.d.ts +311 -0
- package/dist/vtc/members/registry-consent/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/members/registry-consent/0.1/payload.js +183 -0
- package/dist/vtc/members/registry-consent/0.1/payload.js.map +1 -0
- package/dist/vtc/members/update/0.1/payload.d.ts +3 -3
- package/dist/vtc/members/update/0.1/payload.js +1 -1
- package/dist/vtc/members/update/0.1/payload.js.map +1 -1
- package/dist/witness/_shared/0.1/outcome-evidence.d.ts +16 -0
- package/dist/witness/_shared/0.1/outcome-evidence.d.ts.map +1 -0
- package/dist/witness/_shared/0.1/outcome-evidence.js +6 -0
- package/dist/witness/_shared/0.1/outcome-evidence.js.map +1 -0
- package/dist/witness/session/0.2/payload.d.ts +274 -0
- package/dist/witness/session/0.2/payload.d.ts.map +1 -0
- package/dist/witness/session/0.2/payload.js +152 -0
- package/dist/witness/session/0.2/payload.js.map +1 -0
- package/dist/witness/session/submit/0.2/payload.d.ts +295 -0
- package/dist/witness/session/submit/0.2/payload.d.ts.map +1 -0
- package/dist/witness/session/submit/0.2/payload.js +166 -0
- package/dist/witness/session/submit/0.2/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_shared/components.ts +17 -0
- package/src/index.ts +12 -0
- package/src/rooms/keys/act/0.3/payload.ts +380 -0
- package/src/rooms/owner/group/add/0.2/payload.ts +288 -0
- package/src/vta/_shared/0.6/witness-party.ts +17 -0
- package/src/vta/witness/accept/0.2/payload.ts +330 -0
- package/src/vta/witness/list/0.1/payload.ts +441 -0
- package/src/vta/witness/open/0.2/payload.ts +336 -0
- package/src/vta/witness/present/0.2/payload.ts +210 -0
- package/src/vtc/members/personhood/assert/0.2/payload.ts +421 -0
- package/src/vtc/members/registry-consent/0.1/payload.ts +231 -0
- package/src/vtc/members/update/0.1/payload.ts +2 -2
- package/src/witness/_shared/0.1/outcome-evidence.ts +17 -0
- package/src/witness/session/0.2/payload.ts +197 -0
- package/src/witness/session/submit/0.2/payload.ts +212 -0
|
@@ -0,0 +1,546 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/rooms/keys/act/0.3/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* A member's own client asks the member's key holder to complete one host-bound room request — or one of the two requests by which a member takes up a community's offer of admission to a room — as the member: the member's own authority narrowed to the one action the request's type needs, the member as issuer, and the member's signature. The outer document members are owned by the framework — SPEC §6.3.
|
|
8
|
+
*/
|
|
9
|
+
export interface RoomsKeysActPayload {
|
|
10
|
+
document: UnsignedRoomRequest;
|
|
11
|
+
/**
|
|
12
|
+
* Ecosystem-defined extension members per SPEC.md §4.5.1.
|
|
13
|
+
*/
|
|
14
|
+
ext?: Ext;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* The room request to complete, as the client will send it, minus its presentation and its proof.
|
|
18
|
+
*/
|
|
19
|
+
export interface UnsignedRoomRequest {
|
|
20
|
+
/**
|
|
21
|
+
* The request's identifier, set by the client. The host keys duplicate-execution protection on it.
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* The room request's Type URI: a rooms/* request, or vtc/rooms/offers/{list,accept}. Only the types in this task's table are completed; any other is `typeNotActable`.
|
|
26
|
+
*/
|
|
27
|
+
type: string;
|
|
28
|
+
/**
|
|
29
|
+
* The member to act as, and this task's subject (subjectPath /document/issuer). REQUIRED for a type that names no room (rooms/blobs/chunk/0.1, rooms/blobs/upload/{commit,abort}/0.2), where it is the member whose request opened the transfer; REQUIRED for the offer types (vtc/rooms/offers/list/0.1, vtc/rooms/offers/accept/0.1), where it is the DID the community addressed its offer to; REQUIRED where the caller may act as more than one member of the room; optional where it may act as exactly one. A rule over two members this schema does not express: the recipient refuses an absent issuer it needs with principalAmbiguous. Never the client's own identifier.
|
|
30
|
+
*/
|
|
31
|
+
issuer?: string;
|
|
32
|
+
/**
|
|
33
|
+
* The room's host, or for the offer types the community that made the offer: the party the completed document is for. Covered by the member's proof.
|
|
34
|
+
*/
|
|
35
|
+
recipient: string;
|
|
36
|
+
issuedAt: string;
|
|
37
|
+
expiresAt?: string;
|
|
38
|
+
threadId?: string;
|
|
39
|
+
/**
|
|
40
|
+
* The request's payload, as the named type's schema defines it but without `presentation`: the recipient inserts the member's own, narrowed to the table's action, where the type takes one, and refuses a payload that already carries one. For vtc/rooms/offers/accept/0.1 a `keyPackage`, where present, MUST be one the recipient minted (Recipient item 10).
|
|
41
|
+
*/
|
|
42
|
+
payload: {};
|
|
43
|
+
ext?: Ext;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Success response to rooms/keys/act. Type https://trusttasks.org/spec/rooms/keys/act/0.3#response. The request, completed as the member, for the caller to send to its recipient unaltered.
|
|
47
|
+
*/
|
|
48
|
+
export interface RoomsKeysActResponsePayload {
|
|
49
|
+
/**
|
|
50
|
+
* The member the recipient signed as: the completed document's `issuer`.
|
|
51
|
+
*/
|
|
52
|
+
principal: string;
|
|
53
|
+
/**
|
|
54
|
+
* The supplied document with `issuer` set to the member, `payload.presentation` inserted where the type takes one, and the member's Data Integrity `proof` (`proofPurpose: authentication`). Every other member is unchanged.
|
|
55
|
+
*/
|
|
56
|
+
document: {};
|
|
57
|
+
/**
|
|
58
|
+
* When the inserted presentation's leaf lapses. Absent when the type takes no presentation.
|
|
59
|
+
*/
|
|
60
|
+
expiresAt?: string;
|
|
61
|
+
ext?: Ext;
|
|
62
|
+
}
|
|
63
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
64
|
+
export type { Ext };
|
|
65
|
+
/** Trust Task type URI. */
|
|
66
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/rooms/keys/act/0.3";
|
|
67
|
+
/** Stable alias for this specification's request payload shape. */
|
|
68
|
+
export type Payload = RoomsKeysActPayload;
|
|
69
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
70
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/rooms/keys/act/0.3#response";
|
|
71
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
72
|
+
export type Response = RoomsKeysActResponsePayload;
|
|
73
|
+
/**
|
|
74
|
+
* This specification's payload schema, as a value.
|
|
75
|
+
*
|
|
76
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
77
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
78
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
79
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
80
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
81
|
+
*/
|
|
82
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
83
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
84
|
+
readonly $id: "https://trusttasks.org/spec/rooms/keys/act/0.3";
|
|
85
|
+
readonly title: "Rooms Keys Act — payload";
|
|
86
|
+
readonly description: "A member's own client asks the member's key holder to complete one host-bound room request — or one of the two requests by which a member takes up a community's offer of admission to a room — as the member: the member's own authority narrowed to the one action the request's type needs, the member as issuer, and the member's signature. The outer document members are owned by the framework — SPEC §6.3.";
|
|
87
|
+
readonly type: "object";
|
|
88
|
+
readonly additionalProperties: false;
|
|
89
|
+
readonly required: readonly ["document"];
|
|
90
|
+
readonly properties: {
|
|
91
|
+
readonly document: {
|
|
92
|
+
readonly $ref: "#/$defs/UnsignedRoomRequest";
|
|
93
|
+
readonly description: "The room request to complete, as the client will send it, minus its presentation and its proof.";
|
|
94
|
+
};
|
|
95
|
+
readonly ext: {
|
|
96
|
+
readonly $ref: "#/$defs/Ext";
|
|
97
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
readonly $defs: {
|
|
101
|
+
readonly UnsignedRoomRequest: {
|
|
102
|
+
readonly $anchor: "unsigned-room-request";
|
|
103
|
+
readonly title: "Unsigned room request";
|
|
104
|
+
readonly description: "A Trust Task document of a type in the rooms/keys/act table, built by the member's client: no proof, and no presentation in its payload. The recipient validates the payload against the named type's own schema; this one fixes only the envelope.";
|
|
105
|
+
readonly type: "object";
|
|
106
|
+
readonly additionalProperties: false;
|
|
107
|
+
readonly required: readonly ["id", "type", "recipient", "issuedAt", "payload"];
|
|
108
|
+
readonly properties: {
|
|
109
|
+
readonly id: {
|
|
110
|
+
readonly type: "string";
|
|
111
|
+
readonly minLength: 1;
|
|
112
|
+
readonly maxLength: 512;
|
|
113
|
+
readonly description: "The request's identifier, set by the client. The host keys duplicate-execution protection on it.";
|
|
114
|
+
};
|
|
115
|
+
readonly type: {
|
|
116
|
+
readonly type: "string";
|
|
117
|
+
readonly pattern: "^https://trusttasks\\.org/spec/(rooms|vtc/rooms/offers)/";
|
|
118
|
+
readonly maxLength: 2048;
|
|
119
|
+
readonly description: "The room request's Type URI: a rooms/* request, or vtc/rooms/offers/{list,accept}. Only the types in this task's table are completed; any other is `typeNotActable`.";
|
|
120
|
+
};
|
|
121
|
+
readonly issuer: {
|
|
122
|
+
readonly type: "string";
|
|
123
|
+
readonly pattern: "^did:";
|
|
124
|
+
readonly maxLength: 2048;
|
|
125
|
+
readonly description: "The member to act as, and this task's subject (subjectPath /document/issuer). REQUIRED for a type that names no room (rooms/blobs/chunk/0.1, rooms/blobs/upload/{commit,abort}/0.2), where it is the member whose request opened the transfer; REQUIRED for the offer types (vtc/rooms/offers/list/0.1, vtc/rooms/offers/accept/0.1), where it is the DID the community addressed its offer to; REQUIRED where the caller may act as more than one member of the room; optional where it may act as exactly one. A rule over two members this schema does not express: the recipient refuses an absent issuer it needs with principalAmbiguous. Never the client's own identifier.";
|
|
126
|
+
};
|
|
127
|
+
readonly recipient: {
|
|
128
|
+
readonly type: "string";
|
|
129
|
+
readonly pattern: "^did:";
|
|
130
|
+
readonly maxLength: 2048;
|
|
131
|
+
readonly description: "The room's host, or for the offer types the community that made the offer: the party the completed document is for. Covered by the member's proof.";
|
|
132
|
+
};
|
|
133
|
+
readonly issuedAt: {
|
|
134
|
+
readonly type: "string";
|
|
135
|
+
readonly format: "date-time";
|
|
136
|
+
};
|
|
137
|
+
readonly expiresAt: {
|
|
138
|
+
readonly type: "string";
|
|
139
|
+
readonly format: "date-time";
|
|
140
|
+
};
|
|
141
|
+
readonly threadId: {
|
|
142
|
+
readonly type: "string";
|
|
143
|
+
readonly minLength: 1;
|
|
144
|
+
readonly maxLength: 512;
|
|
145
|
+
};
|
|
146
|
+
readonly payload: {
|
|
147
|
+
readonly type: "object";
|
|
148
|
+
readonly description: "The request's payload, as the named type's schema defines it but without `presentation`: the recipient inserts the member's own, narrowed to the table's action, where the type takes one, and refuses a payload that already carries one. For vtc/rooms/offers/accept/0.1 a `keyPackage`, where present, MUST be one the recipient minted (Recipient item 10).";
|
|
149
|
+
};
|
|
150
|
+
readonly ext: {
|
|
151
|
+
readonly $ref: "#/$defs/Ext";
|
|
152
|
+
};
|
|
153
|
+
};
|
|
154
|
+
readonly not: {
|
|
155
|
+
readonly required: readonly ["proof"];
|
|
156
|
+
};
|
|
157
|
+
};
|
|
158
|
+
readonly Response: {
|
|
159
|
+
readonly $anchor: "response";
|
|
160
|
+
readonly title: "Rooms Keys Act — response payload";
|
|
161
|
+
readonly description: "Success response to rooms/keys/act. Type https://trusttasks.org/spec/rooms/keys/act/0.3#response. The request, completed as the member, for the caller to send to its recipient unaltered.";
|
|
162
|
+
readonly type: "object";
|
|
163
|
+
readonly additionalProperties: false;
|
|
164
|
+
readonly required: readonly ["principal", "document"];
|
|
165
|
+
readonly properties: {
|
|
166
|
+
readonly principal: {
|
|
167
|
+
readonly type: "string";
|
|
168
|
+
readonly pattern: "^did:";
|
|
169
|
+
readonly maxLength: 2048;
|
|
170
|
+
readonly description: "The member the recipient signed as: the completed document's `issuer`.";
|
|
171
|
+
};
|
|
172
|
+
readonly document: {
|
|
173
|
+
readonly type: "object";
|
|
174
|
+
readonly required: readonly ["id", "type", "issuer", "recipient", "issuedAt", "payload", "proof"];
|
|
175
|
+
readonly description: "The supplied document with `issuer` set to the member, `payload.presentation` inserted where the type takes one, and the member's Data Integrity `proof` (`proofPurpose: authentication`). Every other member is unchanged.";
|
|
176
|
+
};
|
|
177
|
+
readonly expiresAt: {
|
|
178
|
+
readonly type: "string";
|
|
179
|
+
readonly format: "date-time";
|
|
180
|
+
readonly description: "When the inserted presentation's leaf lapses. Absent when the type takes no presentation.";
|
|
181
|
+
};
|
|
182
|
+
readonly ext: {
|
|
183
|
+
readonly $ref: "#/$defs/Ext";
|
|
184
|
+
};
|
|
185
|
+
};
|
|
186
|
+
};
|
|
187
|
+
readonly Ext: {
|
|
188
|
+
readonly title: "Ext";
|
|
189
|
+
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.";
|
|
190
|
+
readonly type: "object";
|
|
191
|
+
readonly minProperties: 1;
|
|
192
|
+
readonly additionalProperties: true;
|
|
193
|
+
readonly propertyNames: {
|
|
194
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
195
|
+
};
|
|
196
|
+
};
|
|
197
|
+
};
|
|
198
|
+
};
|
|
199
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
200
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
201
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
202
|
+
readonly $ref: "#/$defs/Response";
|
|
203
|
+
readonly $defs: {
|
|
204
|
+
readonly UnsignedRoomRequest: {
|
|
205
|
+
readonly $anchor: "unsigned-room-request";
|
|
206
|
+
readonly title: "Unsigned room request";
|
|
207
|
+
readonly description: "A Trust Task document of a type in the rooms/keys/act table, built by the member's client: no proof, and no presentation in its payload. The recipient validates the payload against the named type's own schema; this one fixes only the envelope.";
|
|
208
|
+
readonly type: "object";
|
|
209
|
+
readonly additionalProperties: false;
|
|
210
|
+
readonly required: readonly ["id", "type", "recipient", "issuedAt", "payload"];
|
|
211
|
+
readonly properties: {
|
|
212
|
+
readonly id: {
|
|
213
|
+
readonly type: "string";
|
|
214
|
+
readonly minLength: 1;
|
|
215
|
+
readonly maxLength: 512;
|
|
216
|
+
readonly description: "The request's identifier, set by the client. The host keys duplicate-execution protection on it.";
|
|
217
|
+
};
|
|
218
|
+
readonly type: {
|
|
219
|
+
readonly type: "string";
|
|
220
|
+
readonly pattern: "^https://trusttasks\\.org/spec/(rooms|vtc/rooms/offers)/";
|
|
221
|
+
readonly maxLength: 2048;
|
|
222
|
+
readonly description: "The room request's Type URI: a rooms/* request, or vtc/rooms/offers/{list,accept}. Only the types in this task's table are completed; any other is `typeNotActable`.";
|
|
223
|
+
};
|
|
224
|
+
readonly issuer: {
|
|
225
|
+
readonly type: "string";
|
|
226
|
+
readonly pattern: "^did:";
|
|
227
|
+
readonly maxLength: 2048;
|
|
228
|
+
readonly description: "The member to act as, and this task's subject (subjectPath /document/issuer). REQUIRED for a type that names no room (rooms/blobs/chunk/0.1, rooms/blobs/upload/{commit,abort}/0.2), where it is the member whose request opened the transfer; REQUIRED for the offer types (vtc/rooms/offers/list/0.1, vtc/rooms/offers/accept/0.1), where it is the DID the community addressed its offer to; REQUIRED where the caller may act as more than one member of the room; optional where it may act as exactly one. A rule over two members this schema does not express: the recipient refuses an absent issuer it needs with principalAmbiguous. Never the client's own identifier.";
|
|
229
|
+
};
|
|
230
|
+
readonly recipient: {
|
|
231
|
+
readonly type: "string";
|
|
232
|
+
readonly pattern: "^did:";
|
|
233
|
+
readonly maxLength: 2048;
|
|
234
|
+
readonly description: "The room's host, or for the offer types the community that made the offer: the party the completed document is for. Covered by the member's proof.";
|
|
235
|
+
};
|
|
236
|
+
readonly issuedAt: {
|
|
237
|
+
readonly type: "string";
|
|
238
|
+
readonly format: "date-time";
|
|
239
|
+
};
|
|
240
|
+
readonly expiresAt: {
|
|
241
|
+
readonly type: "string";
|
|
242
|
+
readonly format: "date-time";
|
|
243
|
+
};
|
|
244
|
+
readonly threadId: {
|
|
245
|
+
readonly type: "string";
|
|
246
|
+
readonly minLength: 1;
|
|
247
|
+
readonly maxLength: 512;
|
|
248
|
+
};
|
|
249
|
+
readonly payload: {
|
|
250
|
+
readonly type: "object";
|
|
251
|
+
readonly description: "The request's payload, as the named type's schema defines it but without `presentation`: the recipient inserts the member's own, narrowed to the table's action, where the type takes one, and refuses a payload that already carries one. For vtc/rooms/offers/accept/0.1 a `keyPackage`, where present, MUST be one the recipient minted (Recipient item 10).";
|
|
252
|
+
};
|
|
253
|
+
readonly ext: {
|
|
254
|
+
readonly $ref: "#/$defs/Ext";
|
|
255
|
+
};
|
|
256
|
+
};
|
|
257
|
+
readonly not: {
|
|
258
|
+
readonly required: readonly ["proof"];
|
|
259
|
+
};
|
|
260
|
+
};
|
|
261
|
+
readonly Response: {
|
|
262
|
+
readonly $anchor: "response";
|
|
263
|
+
readonly title: "Rooms Keys Act — response payload";
|
|
264
|
+
readonly description: "Success response to rooms/keys/act. Type https://trusttasks.org/spec/rooms/keys/act/0.3#response. The request, completed as the member, for the caller to send to its recipient unaltered.";
|
|
265
|
+
readonly type: "object";
|
|
266
|
+
readonly additionalProperties: false;
|
|
267
|
+
readonly required: readonly ["principal", "document"];
|
|
268
|
+
readonly properties: {
|
|
269
|
+
readonly principal: {
|
|
270
|
+
readonly type: "string";
|
|
271
|
+
readonly pattern: "^did:";
|
|
272
|
+
readonly maxLength: 2048;
|
|
273
|
+
readonly description: "The member the recipient signed as: the completed document's `issuer`.";
|
|
274
|
+
};
|
|
275
|
+
readonly document: {
|
|
276
|
+
readonly type: "object";
|
|
277
|
+
readonly required: readonly ["id", "type", "issuer", "recipient", "issuedAt", "payload", "proof"];
|
|
278
|
+
readonly description: "The supplied document with `issuer` set to the member, `payload.presentation` inserted where the type takes one, and the member's Data Integrity `proof` (`proofPurpose: authentication`). Every other member is unchanged.";
|
|
279
|
+
};
|
|
280
|
+
readonly expiresAt: {
|
|
281
|
+
readonly type: "string";
|
|
282
|
+
readonly format: "date-time";
|
|
283
|
+
readonly description: "When the inserted presentation's leaf lapses. Absent when the type takes no presentation.";
|
|
284
|
+
};
|
|
285
|
+
readonly ext: {
|
|
286
|
+
readonly $ref: "#/$defs/Ext";
|
|
287
|
+
};
|
|
288
|
+
};
|
|
289
|
+
};
|
|
290
|
+
readonly Ext: {
|
|
291
|
+
readonly title: "Ext";
|
|
292
|
+
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.";
|
|
293
|
+
readonly type: "object";
|
|
294
|
+
readonly minProperties: 1;
|
|
295
|
+
readonly additionalProperties: true;
|
|
296
|
+
readonly propertyNames: {
|
|
297
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
/**
|
|
303
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
304
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
305
|
+
* per-specification and cannot be derived from the document alone, and
|
|
306
|
+
* item 2 needs the schema this carries.
|
|
307
|
+
*/
|
|
308
|
+
export declare const SPEC: {
|
|
309
|
+
readonly typeUri: "https://trusttasks.org/spec/rooms/keys/act/0.3";
|
|
310
|
+
readonly isBearer: false;
|
|
311
|
+
readonly isProofRequired: true;
|
|
312
|
+
readonly isRecipientRequired: true;
|
|
313
|
+
readonly isIssuedAtRequired: true;
|
|
314
|
+
readonly payloadSchema: {
|
|
315
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
316
|
+
readonly $id: "https://trusttasks.org/spec/rooms/keys/act/0.3";
|
|
317
|
+
readonly title: "Rooms Keys Act — payload";
|
|
318
|
+
readonly description: "A member's own client asks the member's key holder to complete one host-bound room request — or one of the two requests by which a member takes up a community's offer of admission to a room — as the member: the member's own authority narrowed to the one action the request's type needs, the member as issuer, and the member's signature. The outer document members are owned by the framework — SPEC §6.3.";
|
|
319
|
+
readonly type: "object";
|
|
320
|
+
readonly additionalProperties: false;
|
|
321
|
+
readonly required: readonly ["document"];
|
|
322
|
+
readonly properties: {
|
|
323
|
+
readonly document: {
|
|
324
|
+
readonly $ref: "#/$defs/UnsignedRoomRequest";
|
|
325
|
+
readonly description: "The room request to complete, as the client will send it, minus its presentation and its proof.";
|
|
326
|
+
};
|
|
327
|
+
readonly ext: {
|
|
328
|
+
readonly $ref: "#/$defs/Ext";
|
|
329
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
330
|
+
};
|
|
331
|
+
};
|
|
332
|
+
readonly $defs: {
|
|
333
|
+
readonly UnsignedRoomRequest: {
|
|
334
|
+
readonly $anchor: "unsigned-room-request";
|
|
335
|
+
readonly title: "Unsigned room request";
|
|
336
|
+
readonly description: "A Trust Task document of a type in the rooms/keys/act table, built by the member's client: no proof, and no presentation in its payload. The recipient validates the payload against the named type's own schema; this one fixes only the envelope.";
|
|
337
|
+
readonly type: "object";
|
|
338
|
+
readonly additionalProperties: false;
|
|
339
|
+
readonly required: readonly ["id", "type", "recipient", "issuedAt", "payload"];
|
|
340
|
+
readonly properties: {
|
|
341
|
+
readonly id: {
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly minLength: 1;
|
|
344
|
+
readonly maxLength: 512;
|
|
345
|
+
readonly description: "The request's identifier, set by the client. The host keys duplicate-execution protection on it.";
|
|
346
|
+
};
|
|
347
|
+
readonly type: {
|
|
348
|
+
readonly type: "string";
|
|
349
|
+
readonly pattern: "^https://trusttasks\\.org/spec/(rooms|vtc/rooms/offers)/";
|
|
350
|
+
readonly maxLength: 2048;
|
|
351
|
+
readonly description: "The room request's Type URI: a rooms/* request, or vtc/rooms/offers/{list,accept}. Only the types in this task's table are completed; any other is `typeNotActable`.";
|
|
352
|
+
};
|
|
353
|
+
readonly issuer: {
|
|
354
|
+
readonly type: "string";
|
|
355
|
+
readonly pattern: "^did:";
|
|
356
|
+
readonly maxLength: 2048;
|
|
357
|
+
readonly description: "The member to act as, and this task's subject (subjectPath /document/issuer). REQUIRED for a type that names no room (rooms/blobs/chunk/0.1, rooms/blobs/upload/{commit,abort}/0.2), where it is the member whose request opened the transfer; REQUIRED for the offer types (vtc/rooms/offers/list/0.1, vtc/rooms/offers/accept/0.1), where it is the DID the community addressed its offer to; REQUIRED where the caller may act as more than one member of the room; optional where it may act as exactly one. A rule over two members this schema does not express: the recipient refuses an absent issuer it needs with principalAmbiguous. Never the client's own identifier.";
|
|
358
|
+
};
|
|
359
|
+
readonly recipient: {
|
|
360
|
+
readonly type: "string";
|
|
361
|
+
readonly pattern: "^did:";
|
|
362
|
+
readonly maxLength: 2048;
|
|
363
|
+
readonly description: "The room's host, or for the offer types the community that made the offer: the party the completed document is for. Covered by the member's proof.";
|
|
364
|
+
};
|
|
365
|
+
readonly issuedAt: {
|
|
366
|
+
readonly type: "string";
|
|
367
|
+
readonly format: "date-time";
|
|
368
|
+
};
|
|
369
|
+
readonly expiresAt: {
|
|
370
|
+
readonly type: "string";
|
|
371
|
+
readonly format: "date-time";
|
|
372
|
+
};
|
|
373
|
+
readonly threadId: {
|
|
374
|
+
readonly type: "string";
|
|
375
|
+
readonly minLength: 1;
|
|
376
|
+
readonly maxLength: 512;
|
|
377
|
+
};
|
|
378
|
+
readonly payload: {
|
|
379
|
+
readonly type: "object";
|
|
380
|
+
readonly description: "The request's payload, as the named type's schema defines it but without `presentation`: the recipient inserts the member's own, narrowed to the table's action, where the type takes one, and refuses a payload that already carries one. For vtc/rooms/offers/accept/0.1 a `keyPackage`, where present, MUST be one the recipient minted (Recipient item 10).";
|
|
381
|
+
};
|
|
382
|
+
readonly ext: {
|
|
383
|
+
readonly $ref: "#/$defs/Ext";
|
|
384
|
+
};
|
|
385
|
+
};
|
|
386
|
+
readonly not: {
|
|
387
|
+
readonly required: readonly ["proof"];
|
|
388
|
+
};
|
|
389
|
+
};
|
|
390
|
+
readonly Response: {
|
|
391
|
+
readonly $anchor: "response";
|
|
392
|
+
readonly title: "Rooms Keys Act — response payload";
|
|
393
|
+
readonly description: "Success response to rooms/keys/act. Type https://trusttasks.org/spec/rooms/keys/act/0.3#response. The request, completed as the member, for the caller to send to its recipient unaltered.";
|
|
394
|
+
readonly type: "object";
|
|
395
|
+
readonly additionalProperties: false;
|
|
396
|
+
readonly required: readonly ["principal", "document"];
|
|
397
|
+
readonly properties: {
|
|
398
|
+
readonly principal: {
|
|
399
|
+
readonly type: "string";
|
|
400
|
+
readonly pattern: "^did:";
|
|
401
|
+
readonly maxLength: 2048;
|
|
402
|
+
readonly description: "The member the recipient signed as: the completed document's `issuer`.";
|
|
403
|
+
};
|
|
404
|
+
readonly document: {
|
|
405
|
+
readonly type: "object";
|
|
406
|
+
readonly required: readonly ["id", "type", "issuer", "recipient", "issuedAt", "payload", "proof"];
|
|
407
|
+
readonly description: "The supplied document with `issuer` set to the member, `payload.presentation` inserted where the type takes one, and the member's Data Integrity `proof` (`proofPurpose: authentication`). Every other member is unchanged.";
|
|
408
|
+
};
|
|
409
|
+
readonly expiresAt: {
|
|
410
|
+
readonly type: "string";
|
|
411
|
+
readonly format: "date-time";
|
|
412
|
+
readonly description: "When the inserted presentation's leaf lapses. Absent when the type takes no presentation.";
|
|
413
|
+
};
|
|
414
|
+
readonly ext: {
|
|
415
|
+
readonly $ref: "#/$defs/Ext";
|
|
416
|
+
};
|
|
417
|
+
};
|
|
418
|
+
};
|
|
419
|
+
readonly Ext: {
|
|
420
|
+
readonly title: "Ext";
|
|
421
|
+
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.";
|
|
422
|
+
readonly type: "object";
|
|
423
|
+
readonly minProperties: 1;
|
|
424
|
+
readonly additionalProperties: true;
|
|
425
|
+
readonly propertyNames: {
|
|
426
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
};
|
|
432
|
+
/**
|
|
433
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
434
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
435
|
+
* parties (§7.3 item 5).
|
|
436
|
+
*/
|
|
437
|
+
export declare const RESPONSE_SPEC: {
|
|
438
|
+
readonly typeUri: "https://trusttasks.org/spec/rooms/keys/act/0.3#response";
|
|
439
|
+
readonly isBearer: false;
|
|
440
|
+
readonly isProofRequired: true;
|
|
441
|
+
readonly isRecipientRequired: true;
|
|
442
|
+
readonly isIssuedAtRequired: true;
|
|
443
|
+
readonly payloadSchema: {
|
|
444
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
445
|
+
readonly $ref: "#/$defs/Response";
|
|
446
|
+
readonly $defs: {
|
|
447
|
+
readonly UnsignedRoomRequest: {
|
|
448
|
+
readonly $anchor: "unsigned-room-request";
|
|
449
|
+
readonly title: "Unsigned room request";
|
|
450
|
+
readonly description: "A Trust Task document of a type in the rooms/keys/act table, built by the member's client: no proof, and no presentation in its payload. The recipient validates the payload against the named type's own schema; this one fixes only the envelope.";
|
|
451
|
+
readonly type: "object";
|
|
452
|
+
readonly additionalProperties: false;
|
|
453
|
+
readonly required: readonly ["id", "type", "recipient", "issuedAt", "payload"];
|
|
454
|
+
readonly properties: {
|
|
455
|
+
readonly id: {
|
|
456
|
+
readonly type: "string";
|
|
457
|
+
readonly minLength: 1;
|
|
458
|
+
readonly maxLength: 512;
|
|
459
|
+
readonly description: "The request's identifier, set by the client. The host keys duplicate-execution protection on it.";
|
|
460
|
+
};
|
|
461
|
+
readonly type: {
|
|
462
|
+
readonly type: "string";
|
|
463
|
+
readonly pattern: "^https://trusttasks\\.org/spec/(rooms|vtc/rooms/offers)/";
|
|
464
|
+
readonly maxLength: 2048;
|
|
465
|
+
readonly description: "The room request's Type URI: a rooms/* request, or vtc/rooms/offers/{list,accept}. Only the types in this task's table are completed; any other is `typeNotActable`.";
|
|
466
|
+
};
|
|
467
|
+
readonly issuer: {
|
|
468
|
+
readonly type: "string";
|
|
469
|
+
readonly pattern: "^did:";
|
|
470
|
+
readonly maxLength: 2048;
|
|
471
|
+
readonly description: "The member to act as, and this task's subject (subjectPath /document/issuer). REQUIRED for a type that names no room (rooms/blobs/chunk/0.1, rooms/blobs/upload/{commit,abort}/0.2), where it is the member whose request opened the transfer; REQUIRED for the offer types (vtc/rooms/offers/list/0.1, vtc/rooms/offers/accept/0.1), where it is the DID the community addressed its offer to; REQUIRED where the caller may act as more than one member of the room; optional where it may act as exactly one. A rule over two members this schema does not express: the recipient refuses an absent issuer it needs with principalAmbiguous. Never the client's own identifier.";
|
|
472
|
+
};
|
|
473
|
+
readonly recipient: {
|
|
474
|
+
readonly type: "string";
|
|
475
|
+
readonly pattern: "^did:";
|
|
476
|
+
readonly maxLength: 2048;
|
|
477
|
+
readonly description: "The room's host, or for the offer types the community that made the offer: the party the completed document is for. Covered by the member's proof.";
|
|
478
|
+
};
|
|
479
|
+
readonly issuedAt: {
|
|
480
|
+
readonly type: "string";
|
|
481
|
+
readonly format: "date-time";
|
|
482
|
+
};
|
|
483
|
+
readonly expiresAt: {
|
|
484
|
+
readonly type: "string";
|
|
485
|
+
readonly format: "date-time";
|
|
486
|
+
};
|
|
487
|
+
readonly threadId: {
|
|
488
|
+
readonly type: "string";
|
|
489
|
+
readonly minLength: 1;
|
|
490
|
+
readonly maxLength: 512;
|
|
491
|
+
};
|
|
492
|
+
readonly payload: {
|
|
493
|
+
readonly type: "object";
|
|
494
|
+
readonly description: "The request's payload, as the named type's schema defines it but without `presentation`: the recipient inserts the member's own, narrowed to the table's action, where the type takes one, and refuses a payload that already carries one. For vtc/rooms/offers/accept/0.1 a `keyPackage`, where present, MUST be one the recipient minted (Recipient item 10).";
|
|
495
|
+
};
|
|
496
|
+
readonly ext: {
|
|
497
|
+
readonly $ref: "#/$defs/Ext";
|
|
498
|
+
};
|
|
499
|
+
};
|
|
500
|
+
readonly not: {
|
|
501
|
+
readonly required: readonly ["proof"];
|
|
502
|
+
};
|
|
503
|
+
};
|
|
504
|
+
readonly Response: {
|
|
505
|
+
readonly $anchor: "response";
|
|
506
|
+
readonly title: "Rooms Keys Act — response payload";
|
|
507
|
+
readonly description: "Success response to rooms/keys/act. Type https://trusttasks.org/spec/rooms/keys/act/0.3#response. The request, completed as the member, for the caller to send to its recipient unaltered.";
|
|
508
|
+
readonly type: "object";
|
|
509
|
+
readonly additionalProperties: false;
|
|
510
|
+
readonly required: readonly ["principal", "document"];
|
|
511
|
+
readonly properties: {
|
|
512
|
+
readonly principal: {
|
|
513
|
+
readonly type: "string";
|
|
514
|
+
readonly pattern: "^did:";
|
|
515
|
+
readonly maxLength: 2048;
|
|
516
|
+
readonly description: "The member the recipient signed as: the completed document's `issuer`.";
|
|
517
|
+
};
|
|
518
|
+
readonly document: {
|
|
519
|
+
readonly type: "object";
|
|
520
|
+
readonly required: readonly ["id", "type", "issuer", "recipient", "issuedAt", "payload", "proof"];
|
|
521
|
+
readonly description: "The supplied document with `issuer` set to the member, `payload.presentation` inserted where the type takes one, and the member's Data Integrity `proof` (`proofPurpose: authentication`). Every other member is unchanged.";
|
|
522
|
+
};
|
|
523
|
+
readonly expiresAt: {
|
|
524
|
+
readonly type: "string";
|
|
525
|
+
readonly format: "date-time";
|
|
526
|
+
readonly description: "When the inserted presentation's leaf lapses. Absent when the type takes no presentation.";
|
|
527
|
+
};
|
|
528
|
+
readonly ext: {
|
|
529
|
+
readonly $ref: "#/$defs/Ext";
|
|
530
|
+
};
|
|
531
|
+
};
|
|
532
|
+
};
|
|
533
|
+
readonly Ext: {
|
|
534
|
+
readonly title: "Ext";
|
|
535
|
+
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.";
|
|
536
|
+
readonly type: "object";
|
|
537
|
+
readonly minProperties: 1;
|
|
538
|
+
readonly additionalProperties: true;
|
|
539
|
+
readonly propertyNames: {
|
|
540
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
541
|
+
};
|
|
542
|
+
};
|
|
543
|
+
};
|
|
544
|
+
};
|
|
545
|
+
};
|
|
546
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/rooms/keys/act/0.3/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAG7D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,EAAE,CAAC;IACZ,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,EAAE,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,CAAC;AAEpB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,gDAAyD,CAAC;AAElF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAE1C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,yDAAkE,CAAC;AAEpG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,2BAA2B,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyIjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwH1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|