@openvtc/trust-tasks 0.26.0 → 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 +170 -0
- package/dist/_shared/components.d.ts +107 -1
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +16 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +16 -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/oid4vp/identities/list/0.1/payload.d.ts +938 -0
- package/dist/vtc/oid4vp/identities/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/oid4vp/identities/list/0.1/payload.js +559 -0
- package/dist/vtc/oid4vp/identities/list/0.1/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 +16 -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/oid4vp/identities/list/0.1/payload.ts +706 -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,772 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/rooms/community/list/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { CommunityRoom, Ext, HostedRoom, RetentionPolicy, RoomLabel, StorageConfigId, Visibility } from "../../../../../_shared/components.js";
|
|
6
|
+
export interface VTCRoomsCommunityListPayload {
|
|
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/community/list. Type https://trusttasks.org/spec/vtc/rooms/community/list/0.1#response. One page of the rooms the community owns.
|
|
19
|
+
*/
|
|
20
|
+
export interface VTCRoomsCommunityListResponsePayload {
|
|
21
|
+
/**
|
|
22
|
+
* @maxItems 100
|
|
23
|
+
*/
|
|
24
|
+
items: CommunityRoom[];
|
|
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 { CommunityRoom, Ext, HostedRoom, RetentionPolicy, RoomLabel, StorageConfigId, Visibility };
|
|
33
|
+
/** Trust Task type URI. */
|
|
34
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/rooms/community/list/0.1";
|
|
35
|
+
/** Stable alias for this specification's request payload shape. */
|
|
36
|
+
export type Payload = VTCRoomsCommunityListPayload;
|
|
37
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
38
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/rooms/community/list/0.1#response";
|
|
39
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
40
|
+
export type Response = VTCRoomsCommunityListResponsePayload;
|
|
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/community/list/0.1";
|
|
53
|
+
readonly title: "VTC Rooms Community 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 Community List — response payload";
|
|
77
|
+
readonly description: "Success response to vtc/rooms/community/list. Type https://trusttasks.org/spec/vtc/rooms/community/list/0.1#response. One page of the rooms the community owns.";
|
|
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/CommunityRoom";
|
|
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 CommunityRoom: {
|
|
111
|
+
readonly title: "CommunityRoom";
|
|
112
|
+
readonly type: "object";
|
|
113
|
+
readonly additionalProperties: false;
|
|
114
|
+
readonly required: readonly ["room", "label", "admitted", "offered"];
|
|
115
|
+
readonly description: "One room the community owns, as its administrators see it.";
|
|
116
|
+
readonly properties: {
|
|
117
|
+
readonly room: {
|
|
118
|
+
readonly $ref: "#/$defs/HostedRoom";
|
|
119
|
+
};
|
|
120
|
+
readonly label: {
|
|
121
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
122
|
+
};
|
|
123
|
+
readonly storageConfig: {
|
|
124
|
+
readonly $ref: "#/$defs/StorageConfigId";
|
|
125
|
+
readonly description: "The storage config receiving the room's new uploads.";
|
|
126
|
+
};
|
|
127
|
+
readonly admitted: {
|
|
128
|
+
readonly type: "integer";
|
|
129
|
+
readonly minimum: 0;
|
|
130
|
+
readonly description: "Members in state `admitted`.";
|
|
131
|
+
};
|
|
132
|
+
readonly offered: {
|
|
133
|
+
readonly type: "integer";
|
|
134
|
+
readonly minimum: 0;
|
|
135
|
+
readonly description: "Offers not yet accepted or withdrawn.";
|
|
136
|
+
};
|
|
137
|
+
readonly ownerAuthorityValidUntil: {
|
|
138
|
+
readonly type: "string";
|
|
139
|
+
readonly format: "date-time";
|
|
140
|
+
readonly description: "When the community's own `admin` authority over the room expires. A room whose owner's authority lapses can no longer advance its epoch, admit or remove; a community SHOULD renew it well before.";
|
|
141
|
+
};
|
|
142
|
+
readonly createdBy: {
|
|
143
|
+
readonly type: "string";
|
|
144
|
+
readonly pattern: "^did:";
|
|
145
|
+
readonly maxLength: 2048;
|
|
146
|
+
readonly description: "The administrator who created it.";
|
|
147
|
+
};
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
readonly RoomLabel: {
|
|
151
|
+
readonly title: "RoomLabel";
|
|
152
|
+
readonly type: "string";
|
|
153
|
+
readonly minLength: 1;
|
|
154
|
+
readonly maxLength: 128;
|
|
155
|
+
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.";
|
|
156
|
+
};
|
|
157
|
+
readonly StorageConfigId: {
|
|
158
|
+
readonly title: "StorageConfigId";
|
|
159
|
+
readonly type: "string";
|
|
160
|
+
readonly minLength: 1;
|
|
161
|
+
readonly maxLength: 64;
|
|
162
|
+
readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
|
|
163
|
+
readonly description: "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value.";
|
|
164
|
+
};
|
|
165
|
+
readonly HostedRoom: {
|
|
166
|
+
readonly title: "HostedRoom";
|
|
167
|
+
readonly type: "object";
|
|
168
|
+
readonly additionalProperties: false;
|
|
169
|
+
readonly required: readonly ["roomId", "ownerDid", "visibility", "retentionPolicy", "epoch", "lifecycle", "retentionDays", "createdAt", "updatedAt"];
|
|
170
|
+
readonly description: "One room, as its host holds it — member for member the `HostedRoom` of vtc/rooms/list/0.1, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.";
|
|
171
|
+
readonly properties: {
|
|
172
|
+
readonly roomId: {
|
|
173
|
+
readonly type: "string";
|
|
174
|
+
readonly minLength: 1;
|
|
175
|
+
readonly maxLength: 512;
|
|
176
|
+
};
|
|
177
|
+
readonly ownerDid: {
|
|
178
|
+
readonly type: "string";
|
|
179
|
+
readonly pattern: "^did:";
|
|
180
|
+
readonly maxLength: 2048;
|
|
181
|
+
};
|
|
182
|
+
readonly visibility: {
|
|
183
|
+
readonly $ref: "#/$defs/Visibility";
|
|
184
|
+
};
|
|
185
|
+
readonly retentionPolicy: {
|
|
186
|
+
readonly $ref: "#/$defs/RetentionPolicy";
|
|
187
|
+
};
|
|
188
|
+
readonly epoch: {
|
|
189
|
+
readonly type: "integer";
|
|
190
|
+
readonly minimum: 0;
|
|
191
|
+
};
|
|
192
|
+
readonly lifecycle: {
|
|
193
|
+
readonly type: "string";
|
|
194
|
+
readonly enum: readonly ["live", "lapsed", "dormant", "reclaimable"];
|
|
195
|
+
};
|
|
196
|
+
readonly epochExpiresAt: {
|
|
197
|
+
readonly type: "integer";
|
|
198
|
+
readonly minimum: 0;
|
|
199
|
+
};
|
|
200
|
+
readonly retentionDays: {
|
|
201
|
+
readonly type: "integer";
|
|
202
|
+
readonly minimum: 0;
|
|
203
|
+
};
|
|
204
|
+
readonly mirrorOf: {
|
|
205
|
+
readonly type: "string";
|
|
206
|
+
readonly minLength: 1;
|
|
207
|
+
readonly maxLength: 2048;
|
|
208
|
+
};
|
|
209
|
+
readonly createdAt: {
|
|
210
|
+
readonly type: "integer";
|
|
211
|
+
readonly minimum: 0;
|
|
212
|
+
};
|
|
213
|
+
readonly updatedAt: {
|
|
214
|
+
readonly type: "integer";
|
|
215
|
+
readonly minimum: 0;
|
|
216
|
+
};
|
|
217
|
+
};
|
|
218
|
+
};
|
|
219
|
+
readonly RetentionPolicy: {
|
|
220
|
+
readonly title: "RetentionPolicy";
|
|
221
|
+
readonly type: "string";
|
|
222
|
+
readonly enum: readonly ["chained", "fromJoin"];
|
|
223
|
+
readonly description: "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.";
|
|
224
|
+
readonly $comment: "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it.";
|
|
225
|
+
};
|
|
226
|
+
readonly Visibility: {
|
|
227
|
+
readonly title: "Visibility";
|
|
228
|
+
readonly type: "string";
|
|
229
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
230
|
+
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.";
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
235
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
236
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
237
|
+
readonly $ref: "#/$defs/Response";
|
|
238
|
+
readonly $defs: {
|
|
239
|
+
readonly Response: {
|
|
240
|
+
readonly $anchor: "response";
|
|
241
|
+
readonly title: "VTC Rooms Community List — response payload";
|
|
242
|
+
readonly description: "Success response to vtc/rooms/community/list. Type https://trusttasks.org/spec/vtc/rooms/community/list/0.1#response. One page of the rooms the community owns.";
|
|
243
|
+
readonly type: "object";
|
|
244
|
+
readonly additionalProperties: false;
|
|
245
|
+
readonly required: readonly ["items"];
|
|
246
|
+
readonly properties: {
|
|
247
|
+
readonly items: {
|
|
248
|
+
readonly type: "array";
|
|
249
|
+
readonly maxItems: 100;
|
|
250
|
+
readonly items: {
|
|
251
|
+
readonly $ref: "#/$defs/CommunityRoom";
|
|
252
|
+
};
|
|
253
|
+
};
|
|
254
|
+
readonly nextCursor: {
|
|
255
|
+
readonly type: "string";
|
|
256
|
+
readonly minLength: 1;
|
|
257
|
+
readonly maxLength: 1024;
|
|
258
|
+
readonly description: "Present when more remain; pass it as `cursor`.";
|
|
259
|
+
};
|
|
260
|
+
readonly ext: {
|
|
261
|
+
readonly $ref: "#/$defs/Ext";
|
|
262
|
+
};
|
|
263
|
+
};
|
|
264
|
+
};
|
|
265
|
+
readonly Ext: {
|
|
266
|
+
readonly title: "Ext";
|
|
267
|
+
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.";
|
|
268
|
+
readonly type: "object";
|
|
269
|
+
readonly minProperties: 1;
|
|
270
|
+
readonly additionalProperties: true;
|
|
271
|
+
readonly propertyNames: {
|
|
272
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
273
|
+
};
|
|
274
|
+
};
|
|
275
|
+
readonly CommunityRoom: {
|
|
276
|
+
readonly title: "CommunityRoom";
|
|
277
|
+
readonly type: "object";
|
|
278
|
+
readonly additionalProperties: false;
|
|
279
|
+
readonly required: readonly ["room", "label", "admitted", "offered"];
|
|
280
|
+
readonly description: "One room the community owns, as its administrators see it.";
|
|
281
|
+
readonly properties: {
|
|
282
|
+
readonly room: {
|
|
283
|
+
readonly $ref: "#/$defs/HostedRoom";
|
|
284
|
+
};
|
|
285
|
+
readonly label: {
|
|
286
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
287
|
+
};
|
|
288
|
+
readonly storageConfig: {
|
|
289
|
+
readonly $ref: "#/$defs/StorageConfigId";
|
|
290
|
+
readonly description: "The storage config receiving the room's new uploads.";
|
|
291
|
+
};
|
|
292
|
+
readonly admitted: {
|
|
293
|
+
readonly type: "integer";
|
|
294
|
+
readonly minimum: 0;
|
|
295
|
+
readonly description: "Members in state `admitted`.";
|
|
296
|
+
};
|
|
297
|
+
readonly offered: {
|
|
298
|
+
readonly type: "integer";
|
|
299
|
+
readonly minimum: 0;
|
|
300
|
+
readonly description: "Offers not yet accepted or withdrawn.";
|
|
301
|
+
};
|
|
302
|
+
readonly ownerAuthorityValidUntil: {
|
|
303
|
+
readonly type: "string";
|
|
304
|
+
readonly format: "date-time";
|
|
305
|
+
readonly description: "When the community's own `admin` authority over the room expires. A room whose owner's authority lapses can no longer advance its epoch, admit or remove; a community SHOULD renew it well before.";
|
|
306
|
+
};
|
|
307
|
+
readonly createdBy: {
|
|
308
|
+
readonly type: "string";
|
|
309
|
+
readonly pattern: "^did:";
|
|
310
|
+
readonly maxLength: 2048;
|
|
311
|
+
readonly description: "The administrator who created it.";
|
|
312
|
+
};
|
|
313
|
+
};
|
|
314
|
+
};
|
|
315
|
+
readonly RoomLabel: {
|
|
316
|
+
readonly title: "RoomLabel";
|
|
317
|
+
readonly type: "string";
|
|
318
|
+
readonly minLength: 1;
|
|
319
|
+
readonly maxLength: 128;
|
|
320
|
+
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.";
|
|
321
|
+
};
|
|
322
|
+
readonly StorageConfigId: {
|
|
323
|
+
readonly title: "StorageConfigId";
|
|
324
|
+
readonly type: "string";
|
|
325
|
+
readonly minLength: 1;
|
|
326
|
+
readonly maxLength: 64;
|
|
327
|
+
readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
|
|
328
|
+
readonly description: "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value.";
|
|
329
|
+
};
|
|
330
|
+
readonly HostedRoom: {
|
|
331
|
+
readonly title: "HostedRoom";
|
|
332
|
+
readonly type: "object";
|
|
333
|
+
readonly additionalProperties: false;
|
|
334
|
+
readonly required: readonly ["roomId", "ownerDid", "visibility", "retentionPolicy", "epoch", "lifecycle", "retentionDays", "createdAt", "updatedAt"];
|
|
335
|
+
readonly description: "One room, as its host holds it — member for member the `HostedRoom` of vtc/rooms/list/0.1, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.";
|
|
336
|
+
readonly properties: {
|
|
337
|
+
readonly roomId: {
|
|
338
|
+
readonly type: "string";
|
|
339
|
+
readonly minLength: 1;
|
|
340
|
+
readonly maxLength: 512;
|
|
341
|
+
};
|
|
342
|
+
readonly ownerDid: {
|
|
343
|
+
readonly type: "string";
|
|
344
|
+
readonly pattern: "^did:";
|
|
345
|
+
readonly maxLength: 2048;
|
|
346
|
+
};
|
|
347
|
+
readonly visibility: {
|
|
348
|
+
readonly $ref: "#/$defs/Visibility";
|
|
349
|
+
};
|
|
350
|
+
readonly retentionPolicy: {
|
|
351
|
+
readonly $ref: "#/$defs/RetentionPolicy";
|
|
352
|
+
};
|
|
353
|
+
readonly epoch: {
|
|
354
|
+
readonly type: "integer";
|
|
355
|
+
readonly minimum: 0;
|
|
356
|
+
};
|
|
357
|
+
readonly lifecycle: {
|
|
358
|
+
readonly type: "string";
|
|
359
|
+
readonly enum: readonly ["live", "lapsed", "dormant", "reclaimable"];
|
|
360
|
+
};
|
|
361
|
+
readonly epochExpiresAt: {
|
|
362
|
+
readonly type: "integer";
|
|
363
|
+
readonly minimum: 0;
|
|
364
|
+
};
|
|
365
|
+
readonly retentionDays: {
|
|
366
|
+
readonly type: "integer";
|
|
367
|
+
readonly minimum: 0;
|
|
368
|
+
};
|
|
369
|
+
readonly mirrorOf: {
|
|
370
|
+
readonly type: "string";
|
|
371
|
+
readonly minLength: 1;
|
|
372
|
+
readonly maxLength: 2048;
|
|
373
|
+
};
|
|
374
|
+
readonly createdAt: {
|
|
375
|
+
readonly type: "integer";
|
|
376
|
+
readonly minimum: 0;
|
|
377
|
+
};
|
|
378
|
+
readonly updatedAt: {
|
|
379
|
+
readonly type: "integer";
|
|
380
|
+
readonly minimum: 0;
|
|
381
|
+
};
|
|
382
|
+
};
|
|
383
|
+
};
|
|
384
|
+
readonly RetentionPolicy: {
|
|
385
|
+
readonly title: "RetentionPolicy";
|
|
386
|
+
readonly type: "string";
|
|
387
|
+
readonly enum: readonly ["chained", "fromJoin"];
|
|
388
|
+
readonly description: "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.";
|
|
389
|
+
readonly $comment: "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it.";
|
|
390
|
+
};
|
|
391
|
+
readonly Visibility: {
|
|
392
|
+
readonly title: "Visibility";
|
|
393
|
+
readonly type: "string";
|
|
394
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
395
|
+
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.";
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
};
|
|
399
|
+
/**
|
|
400
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
401
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
402
|
+
* per-specification and cannot be derived from the document alone, and
|
|
403
|
+
* item 2 needs the schema this carries.
|
|
404
|
+
*/
|
|
405
|
+
export declare const SPEC: {
|
|
406
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/rooms/community/list/0.1";
|
|
407
|
+
readonly isBearer: false;
|
|
408
|
+
readonly isProofRequired: false;
|
|
409
|
+
readonly isRecipientRequired: true;
|
|
410
|
+
readonly isIssuedAtRequired: false;
|
|
411
|
+
readonly payloadSchema: {
|
|
412
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
413
|
+
readonly $id: "https://trusttasks.org/spec/vtc/rooms/community/list/0.1";
|
|
414
|
+
readonly title: "VTC Rooms Community List — payload";
|
|
415
|
+
readonly type: "object";
|
|
416
|
+
readonly additionalProperties: false;
|
|
417
|
+
readonly properties: {
|
|
418
|
+
readonly cursor: {
|
|
419
|
+
readonly type: "string";
|
|
420
|
+
readonly minLength: 1;
|
|
421
|
+
readonly maxLength: 1024;
|
|
422
|
+
readonly description: "Opaque continuation token from a previous page's `nextCursor`.";
|
|
423
|
+
};
|
|
424
|
+
readonly limit: {
|
|
425
|
+
readonly type: "integer";
|
|
426
|
+
readonly minimum: 1;
|
|
427
|
+
readonly maximum: 100;
|
|
428
|
+
readonly description: "Page size. The community chooses when absent (50 in the reference implementation).";
|
|
429
|
+
};
|
|
430
|
+
readonly ext: {
|
|
431
|
+
readonly $ref: "#/$defs/Ext";
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
readonly $defs: {
|
|
435
|
+
readonly Response: {
|
|
436
|
+
readonly $anchor: "response";
|
|
437
|
+
readonly title: "VTC Rooms Community List — response payload";
|
|
438
|
+
readonly description: "Success response to vtc/rooms/community/list. Type https://trusttasks.org/spec/vtc/rooms/community/list/0.1#response. One page of the rooms the community owns.";
|
|
439
|
+
readonly type: "object";
|
|
440
|
+
readonly additionalProperties: false;
|
|
441
|
+
readonly required: readonly ["items"];
|
|
442
|
+
readonly properties: {
|
|
443
|
+
readonly items: {
|
|
444
|
+
readonly type: "array";
|
|
445
|
+
readonly maxItems: 100;
|
|
446
|
+
readonly items: {
|
|
447
|
+
readonly $ref: "#/$defs/CommunityRoom";
|
|
448
|
+
};
|
|
449
|
+
};
|
|
450
|
+
readonly nextCursor: {
|
|
451
|
+
readonly type: "string";
|
|
452
|
+
readonly minLength: 1;
|
|
453
|
+
readonly maxLength: 1024;
|
|
454
|
+
readonly description: "Present when more remain; pass it as `cursor`.";
|
|
455
|
+
};
|
|
456
|
+
readonly ext: {
|
|
457
|
+
readonly $ref: "#/$defs/Ext";
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
readonly Ext: {
|
|
462
|
+
readonly title: "Ext";
|
|
463
|
+
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.";
|
|
464
|
+
readonly type: "object";
|
|
465
|
+
readonly minProperties: 1;
|
|
466
|
+
readonly additionalProperties: true;
|
|
467
|
+
readonly propertyNames: {
|
|
468
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
readonly CommunityRoom: {
|
|
472
|
+
readonly title: "CommunityRoom";
|
|
473
|
+
readonly type: "object";
|
|
474
|
+
readonly additionalProperties: false;
|
|
475
|
+
readonly required: readonly ["room", "label", "admitted", "offered"];
|
|
476
|
+
readonly description: "One room the community owns, as its administrators see it.";
|
|
477
|
+
readonly properties: {
|
|
478
|
+
readonly room: {
|
|
479
|
+
readonly $ref: "#/$defs/HostedRoom";
|
|
480
|
+
};
|
|
481
|
+
readonly label: {
|
|
482
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
483
|
+
};
|
|
484
|
+
readonly storageConfig: {
|
|
485
|
+
readonly $ref: "#/$defs/StorageConfigId";
|
|
486
|
+
readonly description: "The storage config receiving the room's new uploads.";
|
|
487
|
+
};
|
|
488
|
+
readonly admitted: {
|
|
489
|
+
readonly type: "integer";
|
|
490
|
+
readonly minimum: 0;
|
|
491
|
+
readonly description: "Members in state `admitted`.";
|
|
492
|
+
};
|
|
493
|
+
readonly offered: {
|
|
494
|
+
readonly type: "integer";
|
|
495
|
+
readonly minimum: 0;
|
|
496
|
+
readonly description: "Offers not yet accepted or withdrawn.";
|
|
497
|
+
};
|
|
498
|
+
readonly ownerAuthorityValidUntil: {
|
|
499
|
+
readonly type: "string";
|
|
500
|
+
readonly format: "date-time";
|
|
501
|
+
readonly description: "When the community's own `admin` authority over the room expires. A room whose owner's authority lapses can no longer advance its epoch, admit or remove; a community SHOULD renew it well before.";
|
|
502
|
+
};
|
|
503
|
+
readonly createdBy: {
|
|
504
|
+
readonly type: "string";
|
|
505
|
+
readonly pattern: "^did:";
|
|
506
|
+
readonly maxLength: 2048;
|
|
507
|
+
readonly description: "The administrator who created it.";
|
|
508
|
+
};
|
|
509
|
+
};
|
|
510
|
+
};
|
|
511
|
+
readonly RoomLabel: {
|
|
512
|
+
readonly title: "RoomLabel";
|
|
513
|
+
readonly type: "string";
|
|
514
|
+
readonly minLength: 1;
|
|
515
|
+
readonly maxLength: 128;
|
|
516
|
+
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.";
|
|
517
|
+
};
|
|
518
|
+
readonly StorageConfigId: {
|
|
519
|
+
readonly title: "StorageConfigId";
|
|
520
|
+
readonly type: "string";
|
|
521
|
+
readonly minLength: 1;
|
|
522
|
+
readonly maxLength: 64;
|
|
523
|
+
readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
|
|
524
|
+
readonly description: "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value.";
|
|
525
|
+
};
|
|
526
|
+
readonly HostedRoom: {
|
|
527
|
+
readonly title: "HostedRoom";
|
|
528
|
+
readonly type: "object";
|
|
529
|
+
readonly additionalProperties: false;
|
|
530
|
+
readonly required: readonly ["roomId", "ownerDid", "visibility", "retentionPolicy", "epoch", "lifecycle", "retentionDays", "createdAt", "updatedAt"];
|
|
531
|
+
readonly description: "One room, as its host holds it — member for member the `HostedRoom` of vtc/rooms/list/0.1, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.";
|
|
532
|
+
readonly properties: {
|
|
533
|
+
readonly roomId: {
|
|
534
|
+
readonly type: "string";
|
|
535
|
+
readonly minLength: 1;
|
|
536
|
+
readonly maxLength: 512;
|
|
537
|
+
};
|
|
538
|
+
readonly ownerDid: {
|
|
539
|
+
readonly type: "string";
|
|
540
|
+
readonly pattern: "^did:";
|
|
541
|
+
readonly maxLength: 2048;
|
|
542
|
+
};
|
|
543
|
+
readonly visibility: {
|
|
544
|
+
readonly $ref: "#/$defs/Visibility";
|
|
545
|
+
};
|
|
546
|
+
readonly retentionPolicy: {
|
|
547
|
+
readonly $ref: "#/$defs/RetentionPolicy";
|
|
548
|
+
};
|
|
549
|
+
readonly epoch: {
|
|
550
|
+
readonly type: "integer";
|
|
551
|
+
readonly minimum: 0;
|
|
552
|
+
};
|
|
553
|
+
readonly lifecycle: {
|
|
554
|
+
readonly type: "string";
|
|
555
|
+
readonly enum: readonly ["live", "lapsed", "dormant", "reclaimable"];
|
|
556
|
+
};
|
|
557
|
+
readonly epochExpiresAt: {
|
|
558
|
+
readonly type: "integer";
|
|
559
|
+
readonly minimum: 0;
|
|
560
|
+
};
|
|
561
|
+
readonly retentionDays: {
|
|
562
|
+
readonly type: "integer";
|
|
563
|
+
readonly minimum: 0;
|
|
564
|
+
};
|
|
565
|
+
readonly mirrorOf: {
|
|
566
|
+
readonly type: "string";
|
|
567
|
+
readonly minLength: 1;
|
|
568
|
+
readonly maxLength: 2048;
|
|
569
|
+
};
|
|
570
|
+
readonly createdAt: {
|
|
571
|
+
readonly type: "integer";
|
|
572
|
+
readonly minimum: 0;
|
|
573
|
+
};
|
|
574
|
+
readonly updatedAt: {
|
|
575
|
+
readonly type: "integer";
|
|
576
|
+
readonly minimum: 0;
|
|
577
|
+
};
|
|
578
|
+
};
|
|
579
|
+
};
|
|
580
|
+
readonly RetentionPolicy: {
|
|
581
|
+
readonly title: "RetentionPolicy";
|
|
582
|
+
readonly type: "string";
|
|
583
|
+
readonly enum: readonly ["chained", "fromJoin"];
|
|
584
|
+
readonly description: "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.";
|
|
585
|
+
readonly $comment: "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it.";
|
|
586
|
+
};
|
|
587
|
+
readonly Visibility: {
|
|
588
|
+
readonly title: "Visibility";
|
|
589
|
+
readonly type: "string";
|
|
590
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
591
|
+
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.";
|
|
592
|
+
};
|
|
593
|
+
};
|
|
594
|
+
};
|
|
595
|
+
};
|
|
596
|
+
/**
|
|
597
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
598
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
599
|
+
* parties (§7.3 item 5).
|
|
600
|
+
*/
|
|
601
|
+
export declare const RESPONSE_SPEC: {
|
|
602
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/rooms/community/list/0.1#response";
|
|
603
|
+
readonly isBearer: false;
|
|
604
|
+
readonly isProofRequired: false;
|
|
605
|
+
readonly isRecipientRequired: true;
|
|
606
|
+
readonly isIssuedAtRequired: false;
|
|
607
|
+
readonly payloadSchema: {
|
|
608
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
609
|
+
readonly $ref: "#/$defs/Response";
|
|
610
|
+
readonly $defs: {
|
|
611
|
+
readonly Response: {
|
|
612
|
+
readonly $anchor: "response";
|
|
613
|
+
readonly title: "VTC Rooms Community List — response payload";
|
|
614
|
+
readonly description: "Success response to vtc/rooms/community/list. Type https://trusttasks.org/spec/vtc/rooms/community/list/0.1#response. One page of the rooms the community owns.";
|
|
615
|
+
readonly type: "object";
|
|
616
|
+
readonly additionalProperties: false;
|
|
617
|
+
readonly required: readonly ["items"];
|
|
618
|
+
readonly properties: {
|
|
619
|
+
readonly items: {
|
|
620
|
+
readonly type: "array";
|
|
621
|
+
readonly maxItems: 100;
|
|
622
|
+
readonly items: {
|
|
623
|
+
readonly $ref: "#/$defs/CommunityRoom";
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
readonly nextCursor: {
|
|
627
|
+
readonly type: "string";
|
|
628
|
+
readonly minLength: 1;
|
|
629
|
+
readonly maxLength: 1024;
|
|
630
|
+
readonly description: "Present when more remain; pass it as `cursor`.";
|
|
631
|
+
};
|
|
632
|
+
readonly ext: {
|
|
633
|
+
readonly $ref: "#/$defs/Ext";
|
|
634
|
+
};
|
|
635
|
+
};
|
|
636
|
+
};
|
|
637
|
+
readonly Ext: {
|
|
638
|
+
readonly title: "Ext";
|
|
639
|
+
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.";
|
|
640
|
+
readonly type: "object";
|
|
641
|
+
readonly minProperties: 1;
|
|
642
|
+
readonly additionalProperties: true;
|
|
643
|
+
readonly propertyNames: {
|
|
644
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
645
|
+
};
|
|
646
|
+
};
|
|
647
|
+
readonly CommunityRoom: {
|
|
648
|
+
readonly title: "CommunityRoom";
|
|
649
|
+
readonly type: "object";
|
|
650
|
+
readonly additionalProperties: false;
|
|
651
|
+
readonly required: readonly ["room", "label", "admitted", "offered"];
|
|
652
|
+
readonly description: "One room the community owns, as its administrators see it.";
|
|
653
|
+
readonly properties: {
|
|
654
|
+
readonly room: {
|
|
655
|
+
readonly $ref: "#/$defs/HostedRoom";
|
|
656
|
+
};
|
|
657
|
+
readonly label: {
|
|
658
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
659
|
+
};
|
|
660
|
+
readonly storageConfig: {
|
|
661
|
+
readonly $ref: "#/$defs/StorageConfigId";
|
|
662
|
+
readonly description: "The storage config receiving the room's new uploads.";
|
|
663
|
+
};
|
|
664
|
+
readonly admitted: {
|
|
665
|
+
readonly type: "integer";
|
|
666
|
+
readonly minimum: 0;
|
|
667
|
+
readonly description: "Members in state `admitted`.";
|
|
668
|
+
};
|
|
669
|
+
readonly offered: {
|
|
670
|
+
readonly type: "integer";
|
|
671
|
+
readonly minimum: 0;
|
|
672
|
+
readonly description: "Offers not yet accepted or withdrawn.";
|
|
673
|
+
};
|
|
674
|
+
readonly ownerAuthorityValidUntil: {
|
|
675
|
+
readonly type: "string";
|
|
676
|
+
readonly format: "date-time";
|
|
677
|
+
readonly description: "When the community's own `admin` authority over the room expires. A room whose owner's authority lapses can no longer advance its epoch, admit or remove; a community SHOULD renew it well before.";
|
|
678
|
+
};
|
|
679
|
+
readonly createdBy: {
|
|
680
|
+
readonly type: "string";
|
|
681
|
+
readonly pattern: "^did:";
|
|
682
|
+
readonly maxLength: 2048;
|
|
683
|
+
readonly description: "The administrator who created it.";
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
};
|
|
687
|
+
readonly RoomLabel: {
|
|
688
|
+
readonly title: "RoomLabel";
|
|
689
|
+
readonly type: "string";
|
|
690
|
+
readonly minLength: 1;
|
|
691
|
+
readonly maxLength: 128;
|
|
692
|
+
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.";
|
|
693
|
+
};
|
|
694
|
+
readonly StorageConfigId: {
|
|
695
|
+
readonly title: "StorageConfigId";
|
|
696
|
+
readonly type: "string";
|
|
697
|
+
readonly minLength: 1;
|
|
698
|
+
readonly maxLength: 64;
|
|
699
|
+
readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
|
|
700
|
+
readonly description: "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value.";
|
|
701
|
+
};
|
|
702
|
+
readonly HostedRoom: {
|
|
703
|
+
readonly title: "HostedRoom";
|
|
704
|
+
readonly type: "object";
|
|
705
|
+
readonly additionalProperties: false;
|
|
706
|
+
readonly required: readonly ["roomId", "ownerDid", "visibility", "retentionPolicy", "epoch", "lifecycle", "retentionDays", "createdAt", "updatedAt"];
|
|
707
|
+
readonly description: "One room, as its host holds it — member for member the `HostedRoom` of vtc/rooms/list/0.1, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.";
|
|
708
|
+
readonly properties: {
|
|
709
|
+
readonly roomId: {
|
|
710
|
+
readonly type: "string";
|
|
711
|
+
readonly minLength: 1;
|
|
712
|
+
readonly maxLength: 512;
|
|
713
|
+
};
|
|
714
|
+
readonly ownerDid: {
|
|
715
|
+
readonly type: "string";
|
|
716
|
+
readonly pattern: "^did:";
|
|
717
|
+
readonly maxLength: 2048;
|
|
718
|
+
};
|
|
719
|
+
readonly visibility: {
|
|
720
|
+
readonly $ref: "#/$defs/Visibility";
|
|
721
|
+
};
|
|
722
|
+
readonly retentionPolicy: {
|
|
723
|
+
readonly $ref: "#/$defs/RetentionPolicy";
|
|
724
|
+
};
|
|
725
|
+
readonly epoch: {
|
|
726
|
+
readonly type: "integer";
|
|
727
|
+
readonly minimum: 0;
|
|
728
|
+
};
|
|
729
|
+
readonly lifecycle: {
|
|
730
|
+
readonly type: "string";
|
|
731
|
+
readonly enum: readonly ["live", "lapsed", "dormant", "reclaimable"];
|
|
732
|
+
};
|
|
733
|
+
readonly epochExpiresAt: {
|
|
734
|
+
readonly type: "integer";
|
|
735
|
+
readonly minimum: 0;
|
|
736
|
+
};
|
|
737
|
+
readonly retentionDays: {
|
|
738
|
+
readonly type: "integer";
|
|
739
|
+
readonly minimum: 0;
|
|
740
|
+
};
|
|
741
|
+
readonly mirrorOf: {
|
|
742
|
+
readonly type: "string";
|
|
743
|
+
readonly minLength: 1;
|
|
744
|
+
readonly maxLength: 2048;
|
|
745
|
+
};
|
|
746
|
+
readonly createdAt: {
|
|
747
|
+
readonly type: "integer";
|
|
748
|
+
readonly minimum: 0;
|
|
749
|
+
};
|
|
750
|
+
readonly updatedAt: {
|
|
751
|
+
readonly type: "integer";
|
|
752
|
+
readonly minimum: 0;
|
|
753
|
+
};
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
readonly RetentionPolicy: {
|
|
757
|
+
readonly title: "RetentionPolicy";
|
|
758
|
+
readonly type: "string";
|
|
759
|
+
readonly enum: readonly ["chained", "fromJoin"];
|
|
760
|
+
readonly description: "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.";
|
|
761
|
+
readonly $comment: "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it.";
|
|
762
|
+
};
|
|
763
|
+
readonly Visibility: {
|
|
764
|
+
readonly title: "Visibility";
|
|
765
|
+
readonly type: "string";
|
|
766
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
767
|
+
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.";
|
|
768
|
+
};
|
|
769
|
+
};
|
|
770
|
+
};
|
|
771
|
+
};
|
|
772
|
+
//# sourceMappingURL=payload.d.ts.map
|