@openvtc/trust-tasks 0.26.1 → 0.26.2
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 +142 -0
- package/dist/_shared/components.d.ts +107 -1
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +15 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -1
- package/dist/rooms/owner/group/add/0.1/payload.d.ts +417 -0
- package/dist/rooms/owner/group/add/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/owner/group/add/0.1/payload.js +218 -0
- package/dist/rooms/owner/group/add/0.1/payload.js.map +1 -0
- package/dist/rooms/owner/group/create/0.1/payload.d.ts +299 -0
- package/dist/rooms/owner/group/create/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/owner/group/create/0.1/payload.js +163 -0
- package/dist/rooms/owner/group/create/0.1/payload.js.map +1 -0
- package/dist/rooms/owner/group/remove/0.1/payload.d.ts +343 -0
- package/dist/rooms/owner/group/remove/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/owner/group/remove/0.1/payload.js +184 -0
- package/dist/rooms/owner/group/remove/0.1/payload.js.map +1 -0
- package/dist/rooms/owner/register/0.1/payload.d.ts +3 -3
- package/dist/rooms/owner/register/0.1/payload.js +1 -1
- package/dist/rooms/owner/register/0.1/payload.js.map +1 -1
- package/dist/vtc/_shared/0.1/community-room.d.ts +16 -0
- package/dist/vtc/_shared/0.1/community-room.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/community-room.js +6 -0
- package/dist/vtc/_shared/0.1/community-room.js.map +1 -0
- package/dist/vtc/admin/events/_shared/0.1/topic.d.ts +1 -1
- package/dist/vtc/admin/events/_shared/0.1/topic.d.ts.map +1 -1
- package/dist/vtc/admin/events/_shared/0.2/topic.d.ts +28 -0
- package/dist/vtc/admin/events/_shared/0.2/topic.d.ts.map +1 -0
- package/dist/vtc/admin/events/_shared/0.2/topic.js +6 -0
- package/dist/vtc/admin/events/_shared/0.2/topic.js.map +1 -0
- package/dist/vtc/admin/events/event/0.1/payload.d.ts +1 -1
- package/dist/vtc/admin/events/event/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/admin/events/event/0.2/payload.d.ts +172 -0
- package/dist/vtc/admin/events/event/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/admin/events/event/0.2/payload.js +100 -0
- package/dist/vtc/admin/events/event/0.2/payload.js.map +1 -0
- package/dist/vtc/admin/events/subscribe/0.1/payload.d.ts +1 -1
- package/dist/vtc/admin/events/subscribe/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/admin/events/subscribe/0.2/payload.d.ts +409 -0
- package/dist/vtc/admin/events/subscribe/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/admin/events/subscribe/0.2/payload.js +232 -0
- package/dist/vtc/admin/events/subscribe/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/community/create/0.1/payload.d.ts +789 -0
- package/dist/vtc/rooms/community/create/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/create/0.1/payload.js +463 -0
- package/dist/vtc/rooms/community/create/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/get/0.1/payload.d.ts +711 -0
- package/dist/vtc/rooms/community/get/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/get/0.1/payload.js +429 -0
- package/dist/vtc/rooms/community/get/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/list/0.1/payload.d.ts +772 -0
- package/dist/vtc/rooms/community/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/list/0.1/payload.js +452 -0
- package/dist/vtc/rooms/community/list/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/members/add/0.1/payload.d.ts +535 -0
- package/dist/vtc/rooms/community/members/add/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/members/add/0.1/payload.js +314 -0
- package/dist/vtc/rooms/community/members/add/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/members/list/0.1/payload.d.ts +554 -0
- package/dist/vtc/rooms/community/members/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/members/list/0.1/payload.js +315 -0
- package/dist/vtc/rooms/community/members/list/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/members/remove/0.1/payload.d.ts +533 -0
- package/dist/vtc/rooms/community/members/remove/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/members/remove/0.1/payload.js +313 -0
- package/dist/vtc/rooms/community/members/remove/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/offers/accept/0.1/payload.d.ts +349 -0
- package/dist/vtc/rooms/offers/accept/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/offers/accept/0.1/payload.js +188 -0
- package/dist/vtc/rooms/offers/accept/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/offers/list/0.1/payload.d.ts +692 -0
- package/dist/vtc/rooms/offers/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/offers/list/0.1/payload.js +408 -0
- package/dist/vtc/rooms/offers/list/0.1/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_shared/components.ts +120 -1
- package/src/index.ts +15 -0
- package/src/rooms/owner/group/add/0.1/payload.ts +288 -0
- package/src/rooms/owner/group/create/0.1/payload.ts +213 -0
- package/src/rooms/owner/group/remove/0.1/payload.ts +242 -0
- package/src/rooms/owner/register/0.1/payload.ts +2 -2
- package/src/vtc/_shared/0.1/community-room.ts +17 -0
- package/src/vtc/admin/events/_shared/0.1/topic.ts +1 -1
- package/src/vtc/admin/events/_shared/0.2/topic.ts +29 -0
- package/src/vtc/admin/events/event/0.1/payload.ts +1 -1
- package/src/vtc/admin/events/event/0.2/payload.ts +134 -0
- package/src/vtc/admin/events/subscribe/0.1/payload.ts +1 -1
- package/src/vtc/admin/events/subscribe/0.2/payload.ts +306 -0
- package/src/vtc/rooms/community/create/0.1/payload.ts +509 -0
- package/src/vtc/rooms/community/get/0.1/payload.ts +461 -0
- package/src/vtc/rooms/community/list/0.1/payload.ts +495 -0
- package/src/vtc/rooms/community/members/add/0.1/payload.ts +356 -0
- package/src/vtc/rooms/community/members/list/0.1/payload.ts +366 -0
- package/src/vtc/rooms/community/members/remove/0.1/payload.ts +351 -0
- package/src/vtc/rooms/offers/accept/0.1/payload.ts +240 -0
- package/src/vtc/rooms/offers/list/0.1/payload.ts +451 -0
|
@@ -0,0 +1,692 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/rooms/offers/list/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext, MemberAction, MemberActions, Offer, OfferCredentials, RoomLabel, Visibility } from "../../../../../_shared/components.js";
|
|
6
|
+
export interface VTCRoomsOffersListPayload {
|
|
7
|
+
/**
|
|
8
|
+
* Opaque continuation token from a previous page's `nextCursor`.
|
|
9
|
+
*/
|
|
10
|
+
cursor?: string;
|
|
11
|
+
/**
|
|
12
|
+
* Page size. The community chooses when absent (50 in the reference implementation).
|
|
13
|
+
*/
|
|
14
|
+
limit?: number;
|
|
15
|
+
ext?: Ext;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Success response to vtc/rooms/offers/list. Type https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response. The offers addressed to the caller, and no one else's.
|
|
19
|
+
*/
|
|
20
|
+
export interface VTCRoomsOffersListResponsePayload {
|
|
21
|
+
/**
|
|
22
|
+
* @maxItems 100
|
|
23
|
+
*/
|
|
24
|
+
items: Offer[];
|
|
25
|
+
/**
|
|
26
|
+
* Present when more remain; pass it as `cursor`.
|
|
27
|
+
*/
|
|
28
|
+
nextCursor?: string;
|
|
29
|
+
ext?: Ext;
|
|
30
|
+
}
|
|
31
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
32
|
+
export type { Ext, MemberAction, MemberActions, Offer, OfferCredentials, RoomLabel, Visibility };
|
|
33
|
+
/** Trust Task type URI. */
|
|
34
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/rooms/offers/list/0.1";
|
|
35
|
+
/** Stable alias for this specification's request payload shape. */
|
|
36
|
+
export type Payload = VTCRoomsOffersListPayload;
|
|
37
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
38
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response";
|
|
39
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
40
|
+
export type Response = VTCRoomsOffersListResponsePayload;
|
|
41
|
+
/**
|
|
42
|
+
* This specification's payload schema, as a value.
|
|
43
|
+
*
|
|
44
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
45
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
46
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
47
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
48
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
49
|
+
*/
|
|
50
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
51
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
52
|
+
readonly $id: "https://trusttasks.org/spec/vtc/rooms/offers/list/0.1";
|
|
53
|
+
readonly title: "VTC Rooms Offers List — payload";
|
|
54
|
+
readonly type: "object";
|
|
55
|
+
readonly additionalProperties: false;
|
|
56
|
+
readonly properties: {
|
|
57
|
+
readonly cursor: {
|
|
58
|
+
readonly type: "string";
|
|
59
|
+
readonly minLength: 1;
|
|
60
|
+
readonly maxLength: 1024;
|
|
61
|
+
readonly description: "Opaque continuation token from a previous page's `nextCursor`.";
|
|
62
|
+
};
|
|
63
|
+
readonly limit: {
|
|
64
|
+
readonly type: "integer";
|
|
65
|
+
readonly minimum: 1;
|
|
66
|
+
readonly maximum: 100;
|
|
67
|
+
readonly description: "Page size. The community chooses when absent (50 in the reference implementation).";
|
|
68
|
+
};
|
|
69
|
+
readonly ext: {
|
|
70
|
+
readonly $ref: "#/$defs/Ext";
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
readonly $defs: {
|
|
74
|
+
readonly Response: {
|
|
75
|
+
readonly $anchor: "response";
|
|
76
|
+
readonly title: "VTC Rooms Offers List — response payload";
|
|
77
|
+
readonly description: "Success response to vtc/rooms/offers/list. Type https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response. The offers addressed to the caller, and no one else's.";
|
|
78
|
+
readonly type: "object";
|
|
79
|
+
readonly additionalProperties: false;
|
|
80
|
+
readonly required: readonly ["items"];
|
|
81
|
+
readonly properties: {
|
|
82
|
+
readonly items: {
|
|
83
|
+
readonly type: "array";
|
|
84
|
+
readonly maxItems: 100;
|
|
85
|
+
readonly items: {
|
|
86
|
+
readonly $ref: "#/$defs/Offer";
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
readonly nextCursor: {
|
|
90
|
+
readonly type: "string";
|
|
91
|
+
readonly minLength: 1;
|
|
92
|
+
readonly maxLength: 1024;
|
|
93
|
+
readonly description: "Present when more remain; pass it as `cursor`.";
|
|
94
|
+
};
|
|
95
|
+
readonly ext: {
|
|
96
|
+
readonly $ref: "#/$defs/Ext";
|
|
97
|
+
};
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
readonly Ext: {
|
|
101
|
+
readonly title: "Ext";
|
|
102
|
+
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.";
|
|
103
|
+
readonly type: "object";
|
|
104
|
+
readonly minProperties: 1;
|
|
105
|
+
readonly additionalProperties: true;
|
|
106
|
+
readonly propertyNames: {
|
|
107
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
readonly Offer: {
|
|
111
|
+
readonly title: "Offer";
|
|
112
|
+
readonly type: "object";
|
|
113
|
+
readonly additionalProperties: false;
|
|
114
|
+
readonly required: readonly ["roomId", "host", "label", "visibility", "actions", "validUntil", "offeredAt", "state", "credentials"];
|
|
115
|
+
readonly description: "A community's offer of admission to a room it owns, as the member it is addressed to sees it.";
|
|
116
|
+
readonly properties: {
|
|
117
|
+
readonly roomId: {
|
|
118
|
+
readonly type: "string";
|
|
119
|
+
readonly minLength: 1;
|
|
120
|
+
readonly maxLength: 512;
|
|
121
|
+
};
|
|
122
|
+
readonly host: {
|
|
123
|
+
readonly type: "string";
|
|
124
|
+
readonly pattern: "^did:";
|
|
125
|
+
readonly maxLength: 2048;
|
|
126
|
+
readonly description: "The room's host: this community.";
|
|
127
|
+
};
|
|
128
|
+
readonly label: {
|
|
129
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
130
|
+
};
|
|
131
|
+
readonly visibility: {
|
|
132
|
+
readonly $ref: "#/$defs/Visibility";
|
|
133
|
+
};
|
|
134
|
+
readonly actions: {
|
|
135
|
+
readonly $ref: "#/$defs/MemberActions";
|
|
136
|
+
};
|
|
137
|
+
readonly validUntil: {
|
|
138
|
+
readonly type: "string";
|
|
139
|
+
readonly format: "date-time";
|
|
140
|
+
};
|
|
141
|
+
readonly offeredAt: {
|
|
142
|
+
readonly type: "string";
|
|
143
|
+
readonly format: "date-time";
|
|
144
|
+
};
|
|
145
|
+
readonly state: {
|
|
146
|
+
readonly type: "string";
|
|
147
|
+
readonly enum: readonly ["open", "accepted"];
|
|
148
|
+
readonly description: "`open`: not yet accepted. `accepted`: accepted, kept listed while a repeated accept can still be answered.";
|
|
149
|
+
};
|
|
150
|
+
readonly credentials: {
|
|
151
|
+
readonly $ref: "#/$defs/OfferCredentials";
|
|
152
|
+
};
|
|
153
|
+
};
|
|
154
|
+
};
|
|
155
|
+
readonly OfferCredentials: {
|
|
156
|
+
readonly title: "OfferCredentials";
|
|
157
|
+
readonly type: "object";
|
|
158
|
+
readonly additionalProperties: false;
|
|
159
|
+
readonly required: readonly ["invitation", "membership", "authority"];
|
|
160
|
+
readonly description: "The three credentials the room issued to the member, serialized as rooms/owner/{invite,issue-membership,issue-authority} return them. None is a secret: each names its subject, and a presentation of it must be signed by that subject. The member stores them in their own key holder's vault.";
|
|
161
|
+
readonly properties: {
|
|
162
|
+
readonly invitation: {
|
|
163
|
+
readonly type: "string";
|
|
164
|
+
readonly minLength: 1;
|
|
165
|
+
readonly maxLength: 65536;
|
|
166
|
+
readonly description: "The Verifiable Invitation Credential. On a sealed tier the member's key holder needs it to mint a KeyPackage (rooms/keys/key-package) and to accept the Welcome (rooms/keys/welcome).";
|
|
167
|
+
};
|
|
168
|
+
readonly membership: {
|
|
169
|
+
readonly type: "string";
|
|
170
|
+
readonly minLength: 1;
|
|
171
|
+
readonly maxLength: 65536;
|
|
172
|
+
readonly description: "The Verifiable Membership Credential.";
|
|
173
|
+
};
|
|
174
|
+
readonly authority: {
|
|
175
|
+
readonly type: "string";
|
|
176
|
+
readonly minLength: 1;
|
|
177
|
+
readonly maxLength: 65536;
|
|
178
|
+
readonly description: "The Verifiable Authority Credential granting `actions` until `validUntil`.";
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
readonly MemberActions: {
|
|
183
|
+
readonly title: "MemberActions";
|
|
184
|
+
readonly type: "array";
|
|
185
|
+
readonly minItems: 1;
|
|
186
|
+
readonly maxItems: 3;
|
|
187
|
+
readonly uniqueItems: true;
|
|
188
|
+
readonly items: {
|
|
189
|
+
readonly $ref: "#/$defs/MemberAction";
|
|
190
|
+
};
|
|
191
|
+
readonly description: "The actions granted, at least one. An empty list confers nothing rather than everything, and a schema that allowed it would make the more dangerous reading available to a careless consumer.";
|
|
192
|
+
};
|
|
193
|
+
readonly MemberAction: {
|
|
194
|
+
readonly title: "MemberAction";
|
|
195
|
+
readonly type: "string";
|
|
196
|
+
readonly enum: readonly ["read", "write", "curate"];
|
|
197
|
+
readonly description: "What a member of a community-owned room may do there. `admin` is not among them: minting epochs, admitting and removing members are the community's, as the room's owner, and are exercised through the vtc/rooms/community/* tasks rather than by any member's credential. `curate` is not implied by `write`.";
|
|
198
|
+
};
|
|
199
|
+
readonly RoomLabel: {
|
|
200
|
+
readonly title: "RoomLabel";
|
|
201
|
+
readonly type: "string";
|
|
202
|
+
readonly minLength: 1;
|
|
203
|
+
readonly maxLength: 128;
|
|
204
|
+
readonly description: "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and not sent to the room's host path. MUST NOT carry personal data.";
|
|
205
|
+
};
|
|
206
|
+
readonly Visibility: {
|
|
207
|
+
readonly title: "Visibility";
|
|
208
|
+
readonly type: "string";
|
|
209
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
210
|
+
readonly description: "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything.";
|
|
211
|
+
};
|
|
212
|
+
};
|
|
213
|
+
};
|
|
214
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
215
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
216
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
217
|
+
readonly $ref: "#/$defs/Response";
|
|
218
|
+
readonly $defs: {
|
|
219
|
+
readonly Response: {
|
|
220
|
+
readonly $anchor: "response";
|
|
221
|
+
readonly title: "VTC Rooms Offers List — response payload";
|
|
222
|
+
readonly description: "Success response to vtc/rooms/offers/list. Type https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response. The offers addressed to the caller, and no one else's.";
|
|
223
|
+
readonly type: "object";
|
|
224
|
+
readonly additionalProperties: false;
|
|
225
|
+
readonly required: readonly ["items"];
|
|
226
|
+
readonly properties: {
|
|
227
|
+
readonly items: {
|
|
228
|
+
readonly type: "array";
|
|
229
|
+
readonly maxItems: 100;
|
|
230
|
+
readonly items: {
|
|
231
|
+
readonly $ref: "#/$defs/Offer";
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
readonly nextCursor: {
|
|
235
|
+
readonly type: "string";
|
|
236
|
+
readonly minLength: 1;
|
|
237
|
+
readonly maxLength: 1024;
|
|
238
|
+
readonly description: "Present when more remain; pass it as `cursor`.";
|
|
239
|
+
};
|
|
240
|
+
readonly ext: {
|
|
241
|
+
readonly $ref: "#/$defs/Ext";
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
};
|
|
245
|
+
readonly Ext: {
|
|
246
|
+
readonly title: "Ext";
|
|
247
|
+
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.";
|
|
248
|
+
readonly type: "object";
|
|
249
|
+
readonly minProperties: 1;
|
|
250
|
+
readonly additionalProperties: true;
|
|
251
|
+
readonly propertyNames: {
|
|
252
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
253
|
+
};
|
|
254
|
+
};
|
|
255
|
+
readonly Offer: {
|
|
256
|
+
readonly title: "Offer";
|
|
257
|
+
readonly type: "object";
|
|
258
|
+
readonly additionalProperties: false;
|
|
259
|
+
readonly required: readonly ["roomId", "host", "label", "visibility", "actions", "validUntil", "offeredAt", "state", "credentials"];
|
|
260
|
+
readonly description: "A community's offer of admission to a room it owns, as the member it is addressed to sees it.";
|
|
261
|
+
readonly properties: {
|
|
262
|
+
readonly roomId: {
|
|
263
|
+
readonly type: "string";
|
|
264
|
+
readonly minLength: 1;
|
|
265
|
+
readonly maxLength: 512;
|
|
266
|
+
};
|
|
267
|
+
readonly host: {
|
|
268
|
+
readonly type: "string";
|
|
269
|
+
readonly pattern: "^did:";
|
|
270
|
+
readonly maxLength: 2048;
|
|
271
|
+
readonly description: "The room's host: this community.";
|
|
272
|
+
};
|
|
273
|
+
readonly label: {
|
|
274
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
275
|
+
};
|
|
276
|
+
readonly visibility: {
|
|
277
|
+
readonly $ref: "#/$defs/Visibility";
|
|
278
|
+
};
|
|
279
|
+
readonly actions: {
|
|
280
|
+
readonly $ref: "#/$defs/MemberActions";
|
|
281
|
+
};
|
|
282
|
+
readonly validUntil: {
|
|
283
|
+
readonly type: "string";
|
|
284
|
+
readonly format: "date-time";
|
|
285
|
+
};
|
|
286
|
+
readonly offeredAt: {
|
|
287
|
+
readonly type: "string";
|
|
288
|
+
readonly format: "date-time";
|
|
289
|
+
};
|
|
290
|
+
readonly state: {
|
|
291
|
+
readonly type: "string";
|
|
292
|
+
readonly enum: readonly ["open", "accepted"];
|
|
293
|
+
readonly description: "`open`: not yet accepted. `accepted`: accepted, kept listed while a repeated accept can still be answered.";
|
|
294
|
+
};
|
|
295
|
+
readonly credentials: {
|
|
296
|
+
readonly $ref: "#/$defs/OfferCredentials";
|
|
297
|
+
};
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
readonly OfferCredentials: {
|
|
301
|
+
readonly title: "OfferCredentials";
|
|
302
|
+
readonly type: "object";
|
|
303
|
+
readonly additionalProperties: false;
|
|
304
|
+
readonly required: readonly ["invitation", "membership", "authority"];
|
|
305
|
+
readonly description: "The three credentials the room issued to the member, serialized as rooms/owner/{invite,issue-membership,issue-authority} return them. None is a secret: each names its subject, and a presentation of it must be signed by that subject. The member stores them in their own key holder's vault.";
|
|
306
|
+
readonly properties: {
|
|
307
|
+
readonly invitation: {
|
|
308
|
+
readonly type: "string";
|
|
309
|
+
readonly minLength: 1;
|
|
310
|
+
readonly maxLength: 65536;
|
|
311
|
+
readonly description: "The Verifiable Invitation Credential. On a sealed tier the member's key holder needs it to mint a KeyPackage (rooms/keys/key-package) and to accept the Welcome (rooms/keys/welcome).";
|
|
312
|
+
};
|
|
313
|
+
readonly membership: {
|
|
314
|
+
readonly type: "string";
|
|
315
|
+
readonly minLength: 1;
|
|
316
|
+
readonly maxLength: 65536;
|
|
317
|
+
readonly description: "The Verifiable Membership Credential.";
|
|
318
|
+
};
|
|
319
|
+
readonly authority: {
|
|
320
|
+
readonly type: "string";
|
|
321
|
+
readonly minLength: 1;
|
|
322
|
+
readonly maxLength: 65536;
|
|
323
|
+
readonly description: "The Verifiable Authority Credential granting `actions` until `validUntil`.";
|
|
324
|
+
};
|
|
325
|
+
};
|
|
326
|
+
};
|
|
327
|
+
readonly MemberActions: {
|
|
328
|
+
readonly title: "MemberActions";
|
|
329
|
+
readonly type: "array";
|
|
330
|
+
readonly minItems: 1;
|
|
331
|
+
readonly maxItems: 3;
|
|
332
|
+
readonly uniqueItems: true;
|
|
333
|
+
readonly items: {
|
|
334
|
+
readonly $ref: "#/$defs/MemberAction";
|
|
335
|
+
};
|
|
336
|
+
readonly description: "The actions granted, at least one. An empty list confers nothing rather than everything, and a schema that allowed it would make the more dangerous reading available to a careless consumer.";
|
|
337
|
+
};
|
|
338
|
+
readonly MemberAction: {
|
|
339
|
+
readonly title: "MemberAction";
|
|
340
|
+
readonly type: "string";
|
|
341
|
+
readonly enum: readonly ["read", "write", "curate"];
|
|
342
|
+
readonly description: "What a member of a community-owned room may do there. `admin` is not among them: minting epochs, admitting and removing members are the community's, as the room's owner, and are exercised through the vtc/rooms/community/* tasks rather than by any member's credential. `curate` is not implied by `write`.";
|
|
343
|
+
};
|
|
344
|
+
readonly RoomLabel: {
|
|
345
|
+
readonly title: "RoomLabel";
|
|
346
|
+
readonly type: "string";
|
|
347
|
+
readonly minLength: 1;
|
|
348
|
+
readonly maxLength: 128;
|
|
349
|
+
readonly description: "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and not sent to the room's host path. MUST NOT carry personal data.";
|
|
350
|
+
};
|
|
351
|
+
readonly Visibility: {
|
|
352
|
+
readonly title: "Visibility";
|
|
353
|
+
readonly type: "string";
|
|
354
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
355
|
+
readonly description: "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything.";
|
|
356
|
+
};
|
|
357
|
+
};
|
|
358
|
+
};
|
|
359
|
+
/**
|
|
360
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
361
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
362
|
+
* per-specification and cannot be derived from the document alone, and
|
|
363
|
+
* item 2 needs the schema this carries.
|
|
364
|
+
*/
|
|
365
|
+
export declare const SPEC: {
|
|
366
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/rooms/offers/list/0.1";
|
|
367
|
+
readonly isBearer: false;
|
|
368
|
+
readonly isProofRequired: true;
|
|
369
|
+
readonly isRecipientRequired: true;
|
|
370
|
+
readonly isIssuedAtRequired: true;
|
|
371
|
+
readonly payloadSchema: {
|
|
372
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
373
|
+
readonly $id: "https://trusttasks.org/spec/vtc/rooms/offers/list/0.1";
|
|
374
|
+
readonly title: "VTC Rooms Offers List — payload";
|
|
375
|
+
readonly type: "object";
|
|
376
|
+
readonly additionalProperties: false;
|
|
377
|
+
readonly properties: {
|
|
378
|
+
readonly cursor: {
|
|
379
|
+
readonly type: "string";
|
|
380
|
+
readonly minLength: 1;
|
|
381
|
+
readonly maxLength: 1024;
|
|
382
|
+
readonly description: "Opaque continuation token from a previous page's `nextCursor`.";
|
|
383
|
+
};
|
|
384
|
+
readonly limit: {
|
|
385
|
+
readonly type: "integer";
|
|
386
|
+
readonly minimum: 1;
|
|
387
|
+
readonly maximum: 100;
|
|
388
|
+
readonly description: "Page size. The community chooses when absent (50 in the reference implementation).";
|
|
389
|
+
};
|
|
390
|
+
readonly ext: {
|
|
391
|
+
readonly $ref: "#/$defs/Ext";
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
readonly $defs: {
|
|
395
|
+
readonly Response: {
|
|
396
|
+
readonly $anchor: "response";
|
|
397
|
+
readonly title: "VTC Rooms Offers List — response payload";
|
|
398
|
+
readonly description: "Success response to vtc/rooms/offers/list. Type https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response. The offers addressed to the caller, and no one else's.";
|
|
399
|
+
readonly type: "object";
|
|
400
|
+
readonly additionalProperties: false;
|
|
401
|
+
readonly required: readonly ["items"];
|
|
402
|
+
readonly properties: {
|
|
403
|
+
readonly items: {
|
|
404
|
+
readonly type: "array";
|
|
405
|
+
readonly maxItems: 100;
|
|
406
|
+
readonly items: {
|
|
407
|
+
readonly $ref: "#/$defs/Offer";
|
|
408
|
+
};
|
|
409
|
+
};
|
|
410
|
+
readonly nextCursor: {
|
|
411
|
+
readonly type: "string";
|
|
412
|
+
readonly minLength: 1;
|
|
413
|
+
readonly maxLength: 1024;
|
|
414
|
+
readonly description: "Present when more remain; pass it as `cursor`.";
|
|
415
|
+
};
|
|
416
|
+
readonly ext: {
|
|
417
|
+
readonly $ref: "#/$defs/Ext";
|
|
418
|
+
};
|
|
419
|
+
};
|
|
420
|
+
};
|
|
421
|
+
readonly Ext: {
|
|
422
|
+
readonly title: "Ext";
|
|
423
|
+
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.";
|
|
424
|
+
readonly type: "object";
|
|
425
|
+
readonly minProperties: 1;
|
|
426
|
+
readonly additionalProperties: true;
|
|
427
|
+
readonly propertyNames: {
|
|
428
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
readonly Offer: {
|
|
432
|
+
readonly title: "Offer";
|
|
433
|
+
readonly type: "object";
|
|
434
|
+
readonly additionalProperties: false;
|
|
435
|
+
readonly required: readonly ["roomId", "host", "label", "visibility", "actions", "validUntil", "offeredAt", "state", "credentials"];
|
|
436
|
+
readonly description: "A community's offer of admission to a room it owns, as the member it is addressed to sees it.";
|
|
437
|
+
readonly properties: {
|
|
438
|
+
readonly roomId: {
|
|
439
|
+
readonly type: "string";
|
|
440
|
+
readonly minLength: 1;
|
|
441
|
+
readonly maxLength: 512;
|
|
442
|
+
};
|
|
443
|
+
readonly host: {
|
|
444
|
+
readonly type: "string";
|
|
445
|
+
readonly pattern: "^did:";
|
|
446
|
+
readonly maxLength: 2048;
|
|
447
|
+
readonly description: "The room's host: this community.";
|
|
448
|
+
};
|
|
449
|
+
readonly label: {
|
|
450
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
451
|
+
};
|
|
452
|
+
readonly visibility: {
|
|
453
|
+
readonly $ref: "#/$defs/Visibility";
|
|
454
|
+
};
|
|
455
|
+
readonly actions: {
|
|
456
|
+
readonly $ref: "#/$defs/MemberActions";
|
|
457
|
+
};
|
|
458
|
+
readonly validUntil: {
|
|
459
|
+
readonly type: "string";
|
|
460
|
+
readonly format: "date-time";
|
|
461
|
+
};
|
|
462
|
+
readonly offeredAt: {
|
|
463
|
+
readonly type: "string";
|
|
464
|
+
readonly format: "date-time";
|
|
465
|
+
};
|
|
466
|
+
readonly state: {
|
|
467
|
+
readonly type: "string";
|
|
468
|
+
readonly enum: readonly ["open", "accepted"];
|
|
469
|
+
readonly description: "`open`: not yet accepted. `accepted`: accepted, kept listed while a repeated accept can still be answered.";
|
|
470
|
+
};
|
|
471
|
+
readonly credentials: {
|
|
472
|
+
readonly $ref: "#/$defs/OfferCredentials";
|
|
473
|
+
};
|
|
474
|
+
};
|
|
475
|
+
};
|
|
476
|
+
readonly OfferCredentials: {
|
|
477
|
+
readonly title: "OfferCredentials";
|
|
478
|
+
readonly type: "object";
|
|
479
|
+
readonly additionalProperties: false;
|
|
480
|
+
readonly required: readonly ["invitation", "membership", "authority"];
|
|
481
|
+
readonly description: "The three credentials the room issued to the member, serialized as rooms/owner/{invite,issue-membership,issue-authority} return them. None is a secret: each names its subject, and a presentation of it must be signed by that subject. The member stores them in their own key holder's vault.";
|
|
482
|
+
readonly properties: {
|
|
483
|
+
readonly invitation: {
|
|
484
|
+
readonly type: "string";
|
|
485
|
+
readonly minLength: 1;
|
|
486
|
+
readonly maxLength: 65536;
|
|
487
|
+
readonly description: "The Verifiable Invitation Credential. On a sealed tier the member's key holder needs it to mint a KeyPackage (rooms/keys/key-package) and to accept the Welcome (rooms/keys/welcome).";
|
|
488
|
+
};
|
|
489
|
+
readonly membership: {
|
|
490
|
+
readonly type: "string";
|
|
491
|
+
readonly minLength: 1;
|
|
492
|
+
readonly maxLength: 65536;
|
|
493
|
+
readonly description: "The Verifiable Membership Credential.";
|
|
494
|
+
};
|
|
495
|
+
readonly authority: {
|
|
496
|
+
readonly type: "string";
|
|
497
|
+
readonly minLength: 1;
|
|
498
|
+
readonly maxLength: 65536;
|
|
499
|
+
readonly description: "The Verifiable Authority Credential granting `actions` until `validUntil`.";
|
|
500
|
+
};
|
|
501
|
+
};
|
|
502
|
+
};
|
|
503
|
+
readonly MemberActions: {
|
|
504
|
+
readonly title: "MemberActions";
|
|
505
|
+
readonly type: "array";
|
|
506
|
+
readonly minItems: 1;
|
|
507
|
+
readonly maxItems: 3;
|
|
508
|
+
readonly uniqueItems: true;
|
|
509
|
+
readonly items: {
|
|
510
|
+
readonly $ref: "#/$defs/MemberAction";
|
|
511
|
+
};
|
|
512
|
+
readonly description: "The actions granted, at least one. An empty list confers nothing rather than everything, and a schema that allowed it would make the more dangerous reading available to a careless consumer.";
|
|
513
|
+
};
|
|
514
|
+
readonly MemberAction: {
|
|
515
|
+
readonly title: "MemberAction";
|
|
516
|
+
readonly type: "string";
|
|
517
|
+
readonly enum: readonly ["read", "write", "curate"];
|
|
518
|
+
readonly description: "What a member of a community-owned room may do there. `admin` is not among them: minting epochs, admitting and removing members are the community's, as the room's owner, and are exercised through the vtc/rooms/community/* tasks rather than by any member's credential. `curate` is not implied by `write`.";
|
|
519
|
+
};
|
|
520
|
+
readonly RoomLabel: {
|
|
521
|
+
readonly title: "RoomLabel";
|
|
522
|
+
readonly type: "string";
|
|
523
|
+
readonly minLength: 1;
|
|
524
|
+
readonly maxLength: 128;
|
|
525
|
+
readonly description: "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and not sent to the room's host path. MUST NOT carry personal data.";
|
|
526
|
+
};
|
|
527
|
+
readonly Visibility: {
|
|
528
|
+
readonly title: "Visibility";
|
|
529
|
+
readonly type: "string";
|
|
530
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
531
|
+
readonly description: "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything.";
|
|
532
|
+
};
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
};
|
|
536
|
+
/**
|
|
537
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
538
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
539
|
+
* parties (§7.3 item 5).
|
|
540
|
+
*/
|
|
541
|
+
export declare const RESPONSE_SPEC: {
|
|
542
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response";
|
|
543
|
+
readonly isBearer: false;
|
|
544
|
+
readonly isProofRequired: true;
|
|
545
|
+
readonly isRecipientRequired: true;
|
|
546
|
+
readonly isIssuedAtRequired: true;
|
|
547
|
+
readonly payloadSchema: {
|
|
548
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
549
|
+
readonly $ref: "#/$defs/Response";
|
|
550
|
+
readonly $defs: {
|
|
551
|
+
readonly Response: {
|
|
552
|
+
readonly $anchor: "response";
|
|
553
|
+
readonly title: "VTC Rooms Offers List — response payload";
|
|
554
|
+
readonly description: "Success response to vtc/rooms/offers/list. Type https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response. The offers addressed to the caller, and no one else's.";
|
|
555
|
+
readonly type: "object";
|
|
556
|
+
readonly additionalProperties: false;
|
|
557
|
+
readonly required: readonly ["items"];
|
|
558
|
+
readonly properties: {
|
|
559
|
+
readonly items: {
|
|
560
|
+
readonly type: "array";
|
|
561
|
+
readonly maxItems: 100;
|
|
562
|
+
readonly items: {
|
|
563
|
+
readonly $ref: "#/$defs/Offer";
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
readonly nextCursor: {
|
|
567
|
+
readonly type: "string";
|
|
568
|
+
readonly minLength: 1;
|
|
569
|
+
readonly maxLength: 1024;
|
|
570
|
+
readonly description: "Present when more remain; pass it as `cursor`.";
|
|
571
|
+
};
|
|
572
|
+
readonly ext: {
|
|
573
|
+
readonly $ref: "#/$defs/Ext";
|
|
574
|
+
};
|
|
575
|
+
};
|
|
576
|
+
};
|
|
577
|
+
readonly Ext: {
|
|
578
|
+
readonly title: "Ext";
|
|
579
|
+
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.";
|
|
580
|
+
readonly type: "object";
|
|
581
|
+
readonly minProperties: 1;
|
|
582
|
+
readonly additionalProperties: true;
|
|
583
|
+
readonly propertyNames: {
|
|
584
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
readonly Offer: {
|
|
588
|
+
readonly title: "Offer";
|
|
589
|
+
readonly type: "object";
|
|
590
|
+
readonly additionalProperties: false;
|
|
591
|
+
readonly required: readonly ["roomId", "host", "label", "visibility", "actions", "validUntil", "offeredAt", "state", "credentials"];
|
|
592
|
+
readonly description: "A community's offer of admission to a room it owns, as the member it is addressed to sees it.";
|
|
593
|
+
readonly properties: {
|
|
594
|
+
readonly roomId: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
readonly minLength: 1;
|
|
597
|
+
readonly maxLength: 512;
|
|
598
|
+
};
|
|
599
|
+
readonly host: {
|
|
600
|
+
readonly type: "string";
|
|
601
|
+
readonly pattern: "^did:";
|
|
602
|
+
readonly maxLength: 2048;
|
|
603
|
+
readonly description: "The room's host: this community.";
|
|
604
|
+
};
|
|
605
|
+
readonly label: {
|
|
606
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
607
|
+
};
|
|
608
|
+
readonly visibility: {
|
|
609
|
+
readonly $ref: "#/$defs/Visibility";
|
|
610
|
+
};
|
|
611
|
+
readonly actions: {
|
|
612
|
+
readonly $ref: "#/$defs/MemberActions";
|
|
613
|
+
};
|
|
614
|
+
readonly validUntil: {
|
|
615
|
+
readonly type: "string";
|
|
616
|
+
readonly format: "date-time";
|
|
617
|
+
};
|
|
618
|
+
readonly offeredAt: {
|
|
619
|
+
readonly type: "string";
|
|
620
|
+
readonly format: "date-time";
|
|
621
|
+
};
|
|
622
|
+
readonly state: {
|
|
623
|
+
readonly type: "string";
|
|
624
|
+
readonly enum: readonly ["open", "accepted"];
|
|
625
|
+
readonly description: "`open`: not yet accepted. `accepted`: accepted, kept listed while a repeated accept can still be answered.";
|
|
626
|
+
};
|
|
627
|
+
readonly credentials: {
|
|
628
|
+
readonly $ref: "#/$defs/OfferCredentials";
|
|
629
|
+
};
|
|
630
|
+
};
|
|
631
|
+
};
|
|
632
|
+
readonly OfferCredentials: {
|
|
633
|
+
readonly title: "OfferCredentials";
|
|
634
|
+
readonly type: "object";
|
|
635
|
+
readonly additionalProperties: false;
|
|
636
|
+
readonly required: readonly ["invitation", "membership", "authority"];
|
|
637
|
+
readonly description: "The three credentials the room issued to the member, serialized as rooms/owner/{invite,issue-membership,issue-authority} return them. None is a secret: each names its subject, and a presentation of it must be signed by that subject. The member stores them in their own key holder's vault.";
|
|
638
|
+
readonly properties: {
|
|
639
|
+
readonly invitation: {
|
|
640
|
+
readonly type: "string";
|
|
641
|
+
readonly minLength: 1;
|
|
642
|
+
readonly maxLength: 65536;
|
|
643
|
+
readonly description: "The Verifiable Invitation Credential. On a sealed tier the member's key holder needs it to mint a KeyPackage (rooms/keys/key-package) and to accept the Welcome (rooms/keys/welcome).";
|
|
644
|
+
};
|
|
645
|
+
readonly membership: {
|
|
646
|
+
readonly type: "string";
|
|
647
|
+
readonly minLength: 1;
|
|
648
|
+
readonly maxLength: 65536;
|
|
649
|
+
readonly description: "The Verifiable Membership Credential.";
|
|
650
|
+
};
|
|
651
|
+
readonly authority: {
|
|
652
|
+
readonly type: "string";
|
|
653
|
+
readonly minLength: 1;
|
|
654
|
+
readonly maxLength: 65536;
|
|
655
|
+
readonly description: "The Verifiable Authority Credential granting `actions` until `validUntil`.";
|
|
656
|
+
};
|
|
657
|
+
};
|
|
658
|
+
};
|
|
659
|
+
readonly MemberActions: {
|
|
660
|
+
readonly title: "MemberActions";
|
|
661
|
+
readonly type: "array";
|
|
662
|
+
readonly minItems: 1;
|
|
663
|
+
readonly maxItems: 3;
|
|
664
|
+
readonly uniqueItems: true;
|
|
665
|
+
readonly items: {
|
|
666
|
+
readonly $ref: "#/$defs/MemberAction";
|
|
667
|
+
};
|
|
668
|
+
readonly description: "The actions granted, at least one. An empty list confers nothing rather than everything, and a schema that allowed it would make the more dangerous reading available to a careless consumer.";
|
|
669
|
+
};
|
|
670
|
+
readonly MemberAction: {
|
|
671
|
+
readonly title: "MemberAction";
|
|
672
|
+
readonly type: "string";
|
|
673
|
+
readonly enum: readonly ["read", "write", "curate"];
|
|
674
|
+
readonly description: "What a member of a community-owned room may do there. `admin` is not among them: minting epochs, admitting and removing members are the community's, as the room's owner, and are exercised through the vtc/rooms/community/* tasks rather than by any member's credential. `curate` is not implied by `write`.";
|
|
675
|
+
};
|
|
676
|
+
readonly RoomLabel: {
|
|
677
|
+
readonly title: "RoomLabel";
|
|
678
|
+
readonly type: "string";
|
|
679
|
+
readonly minLength: 1;
|
|
680
|
+
readonly maxLength: 128;
|
|
681
|
+
readonly description: "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and not sent to the room's host path. MUST NOT carry personal data.";
|
|
682
|
+
};
|
|
683
|
+
readonly Visibility: {
|
|
684
|
+
readonly title: "Visibility";
|
|
685
|
+
readonly type: "string";
|
|
686
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
687
|
+
readonly description: "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything.";
|
|
688
|
+
};
|
|
689
|
+
};
|
|
690
|
+
};
|
|
691
|
+
};
|
|
692
|
+
//# sourceMappingURL=payload.d.ts.map
|