@openvtc/trust-tasks 0.26.13 → 0.26.15
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 +131 -0
- package/dist/_shared/components.d.ts +392 -1
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +18 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +18 -0
- package/dist/index.js.map +1 -1
- package/dist/rooms/_shared/0.1/personal-label.d.ts +16 -0
- package/dist/rooms/_shared/0.1/personal-label.d.ts.map +1 -0
- package/dist/rooms/_shared/0.1/personal-label.js +6 -0
- package/dist/rooms/_shared/0.1/personal-label.js.map +1 -0
- package/dist/rooms/_shared/0.1/room.d.ts +1 -1
- package/dist/rooms/_shared/0.1/room.d.ts.map +1 -1
- package/dist/rooms/blobs/get/0.1/payload.d.ts +4 -4
- package/dist/rooms/blobs/get/0.1/payload.js +2 -2
- package/dist/rooms/blobs/get/0.1/payload.js.map +1 -1
- package/dist/rooms/blobs/get/0.2/payload.d.ts +4 -4
- package/dist/rooms/blobs/get/0.2/payload.js +2 -2
- package/dist/rooms/blobs/get/0.2/payload.js.map +1 -1
- package/dist/rooms/blobs/upload/begin/0.1/payload.d.ts +4 -4
- package/dist/rooms/blobs/upload/begin/0.1/payload.js +2 -2
- package/dist/rooms/blobs/upload/begin/0.1/payload.js.map +1 -1
- package/dist/rooms/blobs/upload/begin/0.2/payload.d.ts +4 -4
- package/dist/rooms/blobs/upload/begin/0.2/payload.js +2 -2
- package/dist/rooms/blobs/upload/begin/0.2/payload.js.map +1 -1
- package/dist/rooms/epoch/chain/0.1/payload.d.ts +4 -4
- package/dist/rooms/epoch/chain/0.1/payload.js +2 -2
- package/dist/rooms/epoch/chain/0.1/payload.js.map +1 -1
- package/dist/rooms/epoch/commits/0.1/payload.d.ts +4 -4
- package/dist/rooms/epoch/commits/0.1/payload.js +2 -2
- package/dist/rooms/epoch/commits/0.1/payload.js.map +1 -1
- package/dist/rooms/epoch/mint/0.1/payload.d.ts +4 -4
- package/dist/rooms/epoch/mint/0.1/payload.js +2 -2
- package/dist/rooms/epoch/mint/0.1/payload.js.map +1 -1
- package/dist/rooms/epoch/prune/0.1/payload.d.ts +4 -4
- package/dist/rooms/epoch/prune/0.1/payload.js +2 -2
- package/dist/rooms/epoch/prune/0.1/payload.js.map +1 -1
- package/dist/rooms/info/0.1/payload.d.ts +4 -4
- package/dist/rooms/info/0.1/payload.js +2 -2
- package/dist/rooms/info/0.1/payload.js.map +1 -1
- package/dist/rooms/keys/label/0.1/payload.d.ts +757 -0
- package/dist/rooms/keys/label/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/keys/label/0.1/payload.js +388 -0
- package/dist/rooms/keys/label/0.1/payload.js.map +1 -0
- package/dist/rooms/keys/list/0.2/payload.d.ts +667 -0
- package/dist/rooms/keys/list/0.2/payload.d.ts.map +1 -0
- package/dist/rooms/keys/list/0.2/payload.js +350 -0
- package/dist/rooms/keys/list/0.2/payload.js.map +1 -0
- package/dist/rooms/keys/present/0.2/payload.d.ts +4 -4
- package/dist/rooms/keys/present/0.2/payload.js +2 -2
- package/dist/rooms/keys/present/0.2/payload.js.map +1 -1
- package/dist/rooms/keys/profile/read/0.1/payload.d.ts +1652 -0
- package/dist/rooms/keys/profile/read/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/keys/profile/read/0.1/payload.js +649 -0
- package/dist/rooms/keys/profile/read/0.1/payload.js.map +1 -0
- package/dist/rooms/keys/profile/write/0.1/payload.d.ts +583 -0
- package/dist/rooms/keys/profile/write/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/keys/profile/write/0.1/payload.js +319 -0
- package/dist/rooms/keys/profile/write/0.1/payload.js.map +1 -0
- package/dist/rooms/owner/claim/0.1/payload.d.ts +4 -4
- package/dist/rooms/owner/claim/0.1/payload.js +2 -2
- package/dist/rooms/owner/claim/0.1/payload.js.map +1 -1
- package/dist/rooms/owner/group/remove/0.2/payload.d.ts +600 -0
- package/dist/rooms/owner/group/remove/0.2/payload.d.ts.map +1 -0
- package/dist/rooms/owner/group/remove/0.2/payload.js +310 -0
- package/dist/rooms/owner/group/remove/0.2/payload.js.map +1 -0
- package/dist/rooms/owner/revoke/0.1/payload.d.ts +1481 -0
- package/dist/rooms/owner/revoke/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/owner/revoke/0.1/payload.js +811 -0
- package/dist/rooms/owner/revoke/0.1/payload.js.map +1 -0
- package/dist/rooms/owner/transfer/0.1/payload.d.ts +4 -4
- package/dist/rooms/owner/transfer/0.1/payload.js +2 -2
- package/dist/rooms/owner/transfer/0.1/payload.js.map +1 -1
- package/dist/rooms/records/curate/0.1/payload.d.ts +4 -4
- package/dist/rooms/records/curate/0.1/payload.js +2 -2
- package/dist/rooms/records/curate/0.1/payload.js.map +1 -1
- package/dist/rooms/records/get/0.1/payload.d.ts +4 -4
- package/dist/rooms/records/get/0.1/payload.js +2 -2
- package/dist/rooms/records/get/0.1/payload.js.map +1 -1
- package/dist/rooms/records/get/0.2/payload.d.ts +4 -4
- package/dist/rooms/records/get/0.2/payload.js +2 -2
- package/dist/rooms/records/get/0.2/payload.js.map +1 -1
- package/dist/rooms/records/list/0.1/payload.d.ts +4 -4
- package/dist/rooms/records/list/0.1/payload.js +2 -2
- package/dist/rooms/records/list/0.1/payload.js.map +1 -1
- package/dist/rooms/records/list/0.2/payload.d.ts +4 -4
- package/dist/rooms/records/list/0.2/payload.js +2 -2
- package/dist/rooms/records/list/0.2/payload.js.map +1 -1
- package/dist/rooms/records/put/0.1/payload.d.ts +4 -4
- package/dist/rooms/records/put/0.1/payload.js +2 -2
- package/dist/rooms/records/put/0.1/payload.js.map +1 -1
- package/dist/rooms/records/put/0.2/payload.d.ts +4 -4
- package/dist/rooms/records/put/0.2/payload.js +2 -2
- package/dist/rooms/records/put/0.2/payload.js.map +1 -1
- package/dist/rooms/revocations/get/0.1/payload.d.ts +905 -0
- package/dist/rooms/revocations/get/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/revocations/get/0.1/payload.js +512 -0
- package/dist/rooms/revocations/get/0.1/payload.js.map +1 -0
- package/dist/rooms/revocations/put/0.1/payload.d.ts +1021 -0
- package/dist/rooms/revocations/put/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/revocations/put/0.1/payload.js +583 -0
- package/dist/rooms/revocations/put/0.1/payload.js.map +1 -0
- package/dist/rooms/usage/0.1/payload.d.ts +4 -4
- package/dist/rooms/usage/0.1/payload.js +2 -2
- package/dist/rooms/usage/0.1/payload.js.map +1 -1
- package/dist/vtc/_shared/0.1/community-room.d.ts +1 -1
- package/dist/vtc/_shared/0.1/community-room.d.ts.map +1 -1
- package/dist/vtc/registry/sync-jobs/retry/0.2/payload.d.ts +546 -0
- package/dist/vtc/registry/sync-jobs/retry/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/registry/sync-jobs/retry/0.2/payload.js +331 -0
- package/dist/vtc/registry/sync-jobs/retry/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/community/create/0.1/payload.d.ts +4 -4
- package/dist/vtc/rooms/community/create/0.1/payload.js +2 -2
- package/dist/vtc/rooms/community/create/0.1/payload.js.map +1 -1
- package/dist/vtc/rooms/community/create/0.2/payload.d.ts +989 -0
- package/dist/vtc/rooms/community/create/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/create/0.2/payload.js +559 -0
- package/dist/vtc/rooms/community/create/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/community/create/0.3/payload.d.ts +1013 -0
- package/dist/vtc/rooms/community/create/0.3/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/create/0.3/payload.js +577 -0
- package/dist/vtc/rooms/community/create/0.3/payload.js.map +1 -0
- package/dist/vtc/rooms/community/get/0.1/payload.d.ts +4 -4
- package/dist/vtc/rooms/community/get/0.1/payload.js +2 -2
- package/dist/vtc/rooms/community/get/0.1/payload.js.map +1 -1
- package/dist/vtc/rooms/community/get/0.2/payload.d.ts +887 -0
- package/dist/vtc/rooms/community/get/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/get/0.2/payload.js +517 -0
- package/dist/vtc/rooms/community/get/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/community/list/0.1/payload.d.ts +4 -4
- package/dist/vtc/rooms/community/list/0.1/payload.js +2 -2
- package/dist/vtc/rooms/community/list/0.1/payload.js.map +1 -1
- package/dist/vtc/rooms/community/list/0.2/payload.d.ts +960 -0
- package/dist/vtc/rooms/community/list/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/list/0.2/payload.js +544 -0
- package/dist/vtc/rooms/community/list/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/community/members/remove/0.2/payload.d.ts +681 -0
- package/dist/vtc/rooms/community/members/remove/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/members/remove/0.2/payload.js +393 -0
- package/dist/vtc/rooms/community/members/remove/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/community/update/0.1/payload.d.ts +1013 -0
- package/dist/vtc/rooms/community/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/update/0.1/payload.js +573 -0
- package/dist/vtc/rooms/community/update/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/update/0.2/payload.d.ts +1037 -0
- package/dist/vtc/rooms/community/update/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/update/0.2/payload.js +593 -0
- package/dist/vtc/rooms/community/update/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/offers/list/0.1/payload.d.ts +4 -4
- package/dist/vtc/rooms/offers/list/0.1/payload.js +2 -2
- package/dist/vtc/rooms/offers/list/0.1/payload.js.map +1 -1
- package/dist/vtc/rooms/offers/list/0.2/payload.d.ts +736 -0
- package/dist/vtc/rooms/offers/list/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/offers/list/0.2/payload.js +430 -0
- package/dist/vtc/rooms/offers/list/0.2/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_shared/components.ts +426 -1
- package/src/index.ts +18 -0
- package/src/rooms/_shared/0.1/personal-label.ts +17 -0
- package/src/rooms/_shared/0.1/room.ts +1 -1
- package/src/rooms/blobs/get/0.1/payload.ts +2 -2
- package/src/rooms/blobs/get/0.2/payload.ts +2 -2
- package/src/rooms/blobs/upload/begin/0.1/payload.ts +2 -2
- package/src/rooms/blobs/upload/begin/0.2/payload.ts +2 -2
- package/src/rooms/epoch/chain/0.1/payload.ts +2 -2
- package/src/rooms/epoch/commits/0.1/payload.ts +2 -2
- package/src/rooms/epoch/mint/0.1/payload.ts +2 -2
- package/src/rooms/epoch/prune/0.1/payload.ts +2 -2
- package/src/rooms/info/0.1/payload.ts +2 -2
- package/src/rooms/keys/label/0.1/payload.ts +474 -0
- package/src/rooms/keys/list/0.2/payload.ts +412 -0
- package/src/rooms/keys/present/0.2/payload.ts +2 -2
- package/src/rooms/keys/profile/read/0.1/payload.ts +1617 -0
- package/src/rooms/keys/profile/write/0.1/payload.ts +388 -0
- package/src/rooms/owner/claim/0.1/payload.ts +2 -2
- package/src/rooms/owner/group/remove/0.2/payload.ts +415 -0
- package/src/rooms/owner/revoke/0.1/payload.ts +954 -0
- package/src/rooms/owner/transfer/0.1/payload.ts +2 -2
- package/src/rooms/records/curate/0.1/payload.ts +2 -2
- package/src/rooms/records/get/0.1/payload.ts +2 -2
- package/src/rooms/records/get/0.2/payload.ts +2 -2
- package/src/rooms/records/list/0.1/payload.ts +2 -2
- package/src/rooms/records/list/0.2/payload.ts +2 -2
- package/src/rooms/records/put/0.1/payload.ts +2 -2
- package/src/rooms/records/put/0.2/payload.ts +2 -2
- package/src/rooms/revocations/get/0.1/payload.ts +562 -0
- package/src/rooms/revocations/put/0.1/payload.ts +637 -0
- package/src/rooms/usage/0.1/payload.ts +2 -2
- package/src/vtc/_shared/0.1/community-room.ts +1 -1
- package/src/vtc/registry/sync-jobs/retry/0.2/payload.ts +401 -0
- package/src/vtc/rooms/community/create/0.1/payload.ts +2 -2
- package/src/vtc/rooms/community/create/0.2/payload.ts +613 -0
- package/src/vtc/rooms/community/create/0.3/payload.ts +635 -0
- package/src/vtc/rooms/community/get/0.1/payload.ts +2 -2
- package/src/vtc/rooms/community/get/0.2/payload.ts +549 -0
- package/src/vtc/rooms/community/list/0.1/payload.ts +2 -2
- package/src/vtc/rooms/community/list/0.2/payload.ts +591 -0
- package/src/vtc/rooms/community/members/remove/0.2/payload.ts +439 -0
- package/src/vtc/rooms/community/update/0.1/payload.ts +629 -0
- package/src/vtc/rooms/community/update/0.2/payload.ts +653 -0
- package/src/vtc/rooms/offers/list/0.1/payload.ts +2 -2
- package/src/vtc/rooms/offers/list/0.2/payload.ts +473 -0
|
@@ -0,0 +1,667 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/rooms/keys/list/0.2/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext, PersonalLabel, PersonalLabelDescription, PersonalLabelName, PersonalLabelNotes, PersonalLabelTag, PersonalLabelTags } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* List the rooms the key holder can open for members the caller may act as. `includePersonal` asks for each entry's personal label as well; absent, none is returned. Carries no filter: the recipient answers for the members its caller acts as, and there is nothing to ask it about. The outer document members are owned by the framework — SPEC §6.3.
|
|
8
|
+
*/
|
|
9
|
+
export interface RoomsKeysListPayload {
|
|
10
|
+
/**
|
|
11
|
+
* `true` asks for each entry's personal label (rooms/keys/label) in `personal`. Absent or `false`: no entry carries one. A request option, not a filter — it changes which members of an entry are returned, never which entries — and off by default so that a caller that has no use for the member's own names, or will pass the list on, never receives them.
|
|
12
|
+
*/
|
|
13
|
+
includePersonal?: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* Ecosystem-defined extension members per SPEC.md §4.5.1.
|
|
16
|
+
*/
|
|
17
|
+
ext?: Ext;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.
|
|
21
|
+
*/
|
|
22
|
+
export interface RoomsKeysListResponsePayload {
|
|
23
|
+
/**
|
|
24
|
+
* One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.
|
|
25
|
+
*/
|
|
26
|
+
rooms: {
|
|
27
|
+
/**
|
|
28
|
+
* The room's identifier.
|
|
29
|
+
*/
|
|
30
|
+
roomId: string;
|
|
31
|
+
/**
|
|
32
|
+
* The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.
|
|
33
|
+
*/
|
|
34
|
+
member: string;
|
|
35
|
+
/**
|
|
36
|
+
* The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.
|
|
37
|
+
*/
|
|
38
|
+
epoch: number;
|
|
39
|
+
/**
|
|
40
|
+
* The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.
|
|
41
|
+
*/
|
|
42
|
+
earliestReadableEpoch: number;
|
|
43
|
+
/**
|
|
44
|
+
* The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.
|
|
45
|
+
*/
|
|
46
|
+
personal?: PersonalLabel;
|
|
47
|
+
}[];
|
|
48
|
+
ext?: Ext;
|
|
49
|
+
}
|
|
50
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
51
|
+
export type { Ext, PersonalLabel, PersonalLabelDescription, PersonalLabelName, PersonalLabelNotes, PersonalLabelTag, PersonalLabelTags };
|
|
52
|
+
/** Trust Task type URI. */
|
|
53
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/rooms/keys/list/0.2";
|
|
54
|
+
/** Stable alias for this specification's request payload shape. */
|
|
55
|
+
export type Payload = RoomsKeysListPayload;
|
|
56
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
57
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/rooms/keys/list/0.2#response";
|
|
58
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
59
|
+
export type Response = RoomsKeysListResponsePayload;
|
|
60
|
+
/**
|
|
61
|
+
* This specification's payload schema, as a value.
|
|
62
|
+
*
|
|
63
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
64
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
65
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
66
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
67
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
68
|
+
*/
|
|
69
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
70
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
71
|
+
readonly $id: "https://trusttasks.org/spec/rooms/keys/list/0.2";
|
|
72
|
+
readonly title: "Rooms Keys List — payload";
|
|
73
|
+
readonly description: "List the rooms the key holder can open for members the caller may act as. `includePersonal` asks for each entry's personal label as well; absent, none is returned. Carries no filter: the recipient answers for the members its caller acts as, and there is nothing to ask it about. The outer document members are owned by the framework — SPEC §6.3.";
|
|
74
|
+
readonly type: "object";
|
|
75
|
+
readonly additionalProperties: false;
|
|
76
|
+
readonly properties: {
|
|
77
|
+
readonly includePersonal: {
|
|
78
|
+
readonly type: "boolean";
|
|
79
|
+
readonly description: "`true` asks for each entry's personal label (rooms/keys/label) in `personal`. Absent or `false`: no entry carries one. A request option, not a filter — it changes which members of an entry are returned, never which entries — and off by default so that a caller that has no use for the member's own names, or will pass the list on, never receives them.";
|
|
80
|
+
};
|
|
81
|
+
readonly ext: {
|
|
82
|
+
readonly $ref: "#/$defs/Ext";
|
|
83
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
readonly $defs: {
|
|
87
|
+
readonly Response: {
|
|
88
|
+
readonly $anchor: "response";
|
|
89
|
+
readonly title: "Rooms Keys List — response payload";
|
|
90
|
+
readonly description: "Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.";
|
|
91
|
+
readonly type: "object";
|
|
92
|
+
readonly additionalProperties: false;
|
|
93
|
+
readonly required: readonly ["rooms"];
|
|
94
|
+
readonly properties: {
|
|
95
|
+
readonly rooms: {
|
|
96
|
+
readonly type: "array";
|
|
97
|
+
readonly description: "One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.";
|
|
98
|
+
readonly items: {
|
|
99
|
+
readonly type: "object";
|
|
100
|
+
readonly additionalProperties: false;
|
|
101
|
+
readonly required: readonly ["roomId", "member", "epoch", "earliestReadableEpoch"];
|
|
102
|
+
readonly properties: {
|
|
103
|
+
readonly roomId: {
|
|
104
|
+
readonly type: "string";
|
|
105
|
+
readonly minLength: 1;
|
|
106
|
+
readonly maxLength: 512;
|
|
107
|
+
readonly description: "The room's identifier.";
|
|
108
|
+
};
|
|
109
|
+
readonly member: {
|
|
110
|
+
readonly type: "string";
|
|
111
|
+
readonly pattern: "^did:";
|
|
112
|
+
readonly maxLength: 2048;
|
|
113
|
+
readonly description: "The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.";
|
|
114
|
+
};
|
|
115
|
+
readonly epoch: {
|
|
116
|
+
readonly type: "integer";
|
|
117
|
+
readonly minimum: 1;
|
|
118
|
+
readonly description: "The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.";
|
|
119
|
+
};
|
|
120
|
+
readonly earliestReadableEpoch: {
|
|
121
|
+
readonly type: "integer";
|
|
122
|
+
readonly minimum: 1;
|
|
123
|
+
readonly description: "The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.";
|
|
124
|
+
};
|
|
125
|
+
readonly personal: {
|
|
126
|
+
readonly $ref: "#/$defs/PersonalLabel";
|
|
127
|
+
readonly description: "The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.";
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
};
|
|
132
|
+
readonly ext: {
|
|
133
|
+
readonly $ref: "#/$defs/Ext";
|
|
134
|
+
};
|
|
135
|
+
};
|
|
136
|
+
};
|
|
137
|
+
readonly Ext: {
|
|
138
|
+
readonly title: "Ext";
|
|
139
|
+
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.";
|
|
140
|
+
readonly type: "object";
|
|
141
|
+
readonly minProperties: 1;
|
|
142
|
+
readonly additionalProperties: true;
|
|
143
|
+
readonly propertyNames: {
|
|
144
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
readonly PersonalLabel: {
|
|
148
|
+
readonly title: "PersonalLabel";
|
|
149
|
+
readonly type: "object";
|
|
150
|
+
readonly additionalProperties: false;
|
|
151
|
+
readonly required: readonly ["updatedAt"];
|
|
152
|
+
readonly minProperties: 2;
|
|
153
|
+
readonly description: "A member's personal label for one room, as their key holder keeps it: at least one detail (`minProperties` counts `updatedAt`), and when it last changed. A key holder that holds no detail for the room holds no label, and returns none — there is no empty label.";
|
|
154
|
+
readonly properties: {
|
|
155
|
+
readonly label: {
|
|
156
|
+
readonly $ref: "#/$defs/PersonalLabelName";
|
|
157
|
+
};
|
|
158
|
+
readonly description: {
|
|
159
|
+
readonly $ref: "#/$defs/PersonalLabelDescription";
|
|
160
|
+
};
|
|
161
|
+
readonly notes: {
|
|
162
|
+
readonly $ref: "#/$defs/PersonalLabelNotes";
|
|
163
|
+
};
|
|
164
|
+
readonly tags: {
|
|
165
|
+
readonly $ref: "#/$defs/PersonalLabelTags";
|
|
166
|
+
};
|
|
167
|
+
readonly updatedAt: {
|
|
168
|
+
readonly type: "string";
|
|
169
|
+
readonly format: "date-time";
|
|
170
|
+
readonly description: "When the label last changed, as the key holder recorded it. A request that changed nothing does not move it.";
|
|
171
|
+
};
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
readonly PersonalLabelTags: {
|
|
175
|
+
readonly title: "PersonalLabelTags";
|
|
176
|
+
readonly type: "array";
|
|
177
|
+
readonly minItems: 1;
|
|
178
|
+
readonly maxItems: 16;
|
|
179
|
+
readonly uniqueItems: true;
|
|
180
|
+
readonly items: {
|
|
181
|
+
readonly $ref: "#/$defs/PersonalLabelTag";
|
|
182
|
+
};
|
|
183
|
+
readonly description: "The member's tags for the room, one to sixteen, as a set: order carries no meaning. A room with no tags has no `tags` member, never an empty list, so there is one way to say \"none\".";
|
|
184
|
+
};
|
|
185
|
+
readonly PersonalLabelTag: {
|
|
186
|
+
readonly title: "PersonalLabelTag";
|
|
187
|
+
readonly type: "string";
|
|
188
|
+
readonly minLength: 1;
|
|
189
|
+
readonly maxLength: 32;
|
|
190
|
+
readonly pattern: "^[^\\u0000-\\u001F\\u007F]+$";
|
|
191
|
+
readonly description: "A word or short phrase the member files the room under, in any script, so their own surfaces can group and filter their rooms. Compared exactly, as a string: a key holder does not case-fold or normalise it.";
|
|
192
|
+
};
|
|
193
|
+
readonly PersonalLabelNotes: {
|
|
194
|
+
readonly title: "PersonalLabelNotes";
|
|
195
|
+
readonly type: "string";
|
|
196
|
+
readonly minLength: 1;
|
|
197
|
+
readonly maxLength: 4000;
|
|
198
|
+
readonly pattern: "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$";
|
|
199
|
+
readonly description: "Longer free-form notes the member keeps about the room: who introduced them, what to look for in it, what they agreed there. Line breaks and tabs are allowed; other control characters are not.";
|
|
200
|
+
};
|
|
201
|
+
readonly PersonalLabelDescription: {
|
|
202
|
+
readonly title: "PersonalLabelDescription";
|
|
203
|
+
readonly type: "string";
|
|
204
|
+
readonly minLength: 1;
|
|
205
|
+
readonly maxLength: 1000;
|
|
206
|
+
readonly pattern: "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$";
|
|
207
|
+
readonly description: "What the room is to the member, in a sentence or a short paragraph. Line breaks and tabs are allowed; other control characters are not.";
|
|
208
|
+
};
|
|
209
|
+
readonly PersonalLabelName: {
|
|
210
|
+
readonly title: "PersonalLabelName";
|
|
211
|
+
readonly type: "string";
|
|
212
|
+
readonly minLength: 1;
|
|
213
|
+
readonly maxLength: 128;
|
|
214
|
+
readonly pattern: "^[^\\u0000-\\u001F\\u007F]+$";
|
|
215
|
+
readonly description: "The member's own name for the room, on one line: no control characters, line breaks included. Shown before every name a third party gave the room, because it is the only one nobody else wrote.";
|
|
216
|
+
};
|
|
217
|
+
};
|
|
218
|
+
};
|
|
219
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
220
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
221
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
222
|
+
readonly $ref: "#/$defs/Response";
|
|
223
|
+
readonly $defs: {
|
|
224
|
+
readonly Response: {
|
|
225
|
+
readonly $anchor: "response";
|
|
226
|
+
readonly title: "Rooms Keys List — response payload";
|
|
227
|
+
readonly description: "Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.";
|
|
228
|
+
readonly type: "object";
|
|
229
|
+
readonly additionalProperties: false;
|
|
230
|
+
readonly required: readonly ["rooms"];
|
|
231
|
+
readonly properties: {
|
|
232
|
+
readonly rooms: {
|
|
233
|
+
readonly type: "array";
|
|
234
|
+
readonly description: "One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.";
|
|
235
|
+
readonly items: {
|
|
236
|
+
readonly type: "object";
|
|
237
|
+
readonly additionalProperties: false;
|
|
238
|
+
readonly required: readonly ["roomId", "member", "epoch", "earliestReadableEpoch"];
|
|
239
|
+
readonly properties: {
|
|
240
|
+
readonly roomId: {
|
|
241
|
+
readonly type: "string";
|
|
242
|
+
readonly minLength: 1;
|
|
243
|
+
readonly maxLength: 512;
|
|
244
|
+
readonly description: "The room's identifier.";
|
|
245
|
+
};
|
|
246
|
+
readonly member: {
|
|
247
|
+
readonly type: "string";
|
|
248
|
+
readonly pattern: "^did:";
|
|
249
|
+
readonly maxLength: 2048;
|
|
250
|
+
readonly description: "The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.";
|
|
251
|
+
};
|
|
252
|
+
readonly epoch: {
|
|
253
|
+
readonly type: "integer";
|
|
254
|
+
readonly minimum: 1;
|
|
255
|
+
readonly description: "The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.";
|
|
256
|
+
};
|
|
257
|
+
readonly earliestReadableEpoch: {
|
|
258
|
+
readonly type: "integer";
|
|
259
|
+
readonly minimum: 1;
|
|
260
|
+
readonly description: "The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.";
|
|
261
|
+
};
|
|
262
|
+
readonly personal: {
|
|
263
|
+
readonly $ref: "#/$defs/PersonalLabel";
|
|
264
|
+
readonly description: "The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.";
|
|
265
|
+
};
|
|
266
|
+
};
|
|
267
|
+
};
|
|
268
|
+
};
|
|
269
|
+
readonly ext: {
|
|
270
|
+
readonly $ref: "#/$defs/Ext";
|
|
271
|
+
};
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
readonly Ext: {
|
|
275
|
+
readonly title: "Ext";
|
|
276
|
+
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.";
|
|
277
|
+
readonly type: "object";
|
|
278
|
+
readonly minProperties: 1;
|
|
279
|
+
readonly additionalProperties: true;
|
|
280
|
+
readonly propertyNames: {
|
|
281
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
282
|
+
};
|
|
283
|
+
};
|
|
284
|
+
readonly PersonalLabel: {
|
|
285
|
+
readonly title: "PersonalLabel";
|
|
286
|
+
readonly type: "object";
|
|
287
|
+
readonly additionalProperties: false;
|
|
288
|
+
readonly required: readonly ["updatedAt"];
|
|
289
|
+
readonly minProperties: 2;
|
|
290
|
+
readonly description: "A member's personal label for one room, as their key holder keeps it: at least one detail (`minProperties` counts `updatedAt`), and when it last changed. A key holder that holds no detail for the room holds no label, and returns none — there is no empty label.";
|
|
291
|
+
readonly properties: {
|
|
292
|
+
readonly label: {
|
|
293
|
+
readonly $ref: "#/$defs/PersonalLabelName";
|
|
294
|
+
};
|
|
295
|
+
readonly description: {
|
|
296
|
+
readonly $ref: "#/$defs/PersonalLabelDescription";
|
|
297
|
+
};
|
|
298
|
+
readonly notes: {
|
|
299
|
+
readonly $ref: "#/$defs/PersonalLabelNotes";
|
|
300
|
+
};
|
|
301
|
+
readonly tags: {
|
|
302
|
+
readonly $ref: "#/$defs/PersonalLabelTags";
|
|
303
|
+
};
|
|
304
|
+
readonly updatedAt: {
|
|
305
|
+
readonly type: "string";
|
|
306
|
+
readonly format: "date-time";
|
|
307
|
+
readonly description: "When the label last changed, as the key holder recorded it. A request that changed nothing does not move it.";
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
};
|
|
311
|
+
readonly PersonalLabelTags: {
|
|
312
|
+
readonly title: "PersonalLabelTags";
|
|
313
|
+
readonly type: "array";
|
|
314
|
+
readonly minItems: 1;
|
|
315
|
+
readonly maxItems: 16;
|
|
316
|
+
readonly uniqueItems: true;
|
|
317
|
+
readonly items: {
|
|
318
|
+
readonly $ref: "#/$defs/PersonalLabelTag";
|
|
319
|
+
};
|
|
320
|
+
readonly description: "The member's tags for the room, one to sixteen, as a set: order carries no meaning. A room with no tags has no `tags` member, never an empty list, so there is one way to say \"none\".";
|
|
321
|
+
};
|
|
322
|
+
readonly PersonalLabelTag: {
|
|
323
|
+
readonly title: "PersonalLabelTag";
|
|
324
|
+
readonly type: "string";
|
|
325
|
+
readonly minLength: 1;
|
|
326
|
+
readonly maxLength: 32;
|
|
327
|
+
readonly pattern: "^[^\\u0000-\\u001F\\u007F]+$";
|
|
328
|
+
readonly description: "A word or short phrase the member files the room under, in any script, so their own surfaces can group and filter their rooms. Compared exactly, as a string: a key holder does not case-fold or normalise it.";
|
|
329
|
+
};
|
|
330
|
+
readonly PersonalLabelNotes: {
|
|
331
|
+
readonly title: "PersonalLabelNotes";
|
|
332
|
+
readonly type: "string";
|
|
333
|
+
readonly minLength: 1;
|
|
334
|
+
readonly maxLength: 4000;
|
|
335
|
+
readonly pattern: "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$";
|
|
336
|
+
readonly description: "Longer free-form notes the member keeps about the room: who introduced them, what to look for in it, what they agreed there. Line breaks and tabs are allowed; other control characters are not.";
|
|
337
|
+
};
|
|
338
|
+
readonly PersonalLabelDescription: {
|
|
339
|
+
readonly title: "PersonalLabelDescription";
|
|
340
|
+
readonly type: "string";
|
|
341
|
+
readonly minLength: 1;
|
|
342
|
+
readonly maxLength: 1000;
|
|
343
|
+
readonly pattern: "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$";
|
|
344
|
+
readonly description: "What the room is to the member, in a sentence or a short paragraph. Line breaks and tabs are allowed; other control characters are not.";
|
|
345
|
+
};
|
|
346
|
+
readonly PersonalLabelName: {
|
|
347
|
+
readonly title: "PersonalLabelName";
|
|
348
|
+
readonly type: "string";
|
|
349
|
+
readonly minLength: 1;
|
|
350
|
+
readonly maxLength: 128;
|
|
351
|
+
readonly pattern: "^[^\\u0000-\\u001F\\u007F]+$";
|
|
352
|
+
readonly description: "The member's own name for the room, on one line: no control characters, line breaks included. Shown before every name a third party gave the room, because it is the only one nobody else wrote.";
|
|
353
|
+
};
|
|
354
|
+
};
|
|
355
|
+
};
|
|
356
|
+
/**
|
|
357
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
358
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
359
|
+
* per-specification and cannot be derived from the document alone, and
|
|
360
|
+
* item 2 needs the schema this carries.
|
|
361
|
+
*/
|
|
362
|
+
export declare const SPEC: {
|
|
363
|
+
readonly typeUri: "https://trusttasks.org/spec/rooms/keys/list/0.2";
|
|
364
|
+
readonly isBearer: false;
|
|
365
|
+
readonly isProofRequired: true;
|
|
366
|
+
readonly isRecipientRequired: true;
|
|
367
|
+
readonly isIssuedAtRequired: true;
|
|
368
|
+
readonly payloadSchema: {
|
|
369
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
370
|
+
readonly $id: "https://trusttasks.org/spec/rooms/keys/list/0.2";
|
|
371
|
+
readonly title: "Rooms Keys List — payload";
|
|
372
|
+
readonly description: "List the rooms the key holder can open for members the caller may act as. `includePersonal` asks for each entry's personal label as well; absent, none is returned. Carries no filter: the recipient answers for the members its caller acts as, and there is nothing to ask it about. The outer document members are owned by the framework — SPEC §6.3.";
|
|
373
|
+
readonly type: "object";
|
|
374
|
+
readonly additionalProperties: false;
|
|
375
|
+
readonly properties: {
|
|
376
|
+
readonly includePersonal: {
|
|
377
|
+
readonly type: "boolean";
|
|
378
|
+
readonly description: "`true` asks for each entry's personal label (rooms/keys/label) in `personal`. Absent or `false`: no entry carries one. A request option, not a filter — it changes which members of an entry are returned, never which entries — and off by default so that a caller that has no use for the member's own names, or will pass the list on, never receives them.";
|
|
379
|
+
};
|
|
380
|
+
readonly ext: {
|
|
381
|
+
readonly $ref: "#/$defs/Ext";
|
|
382
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
383
|
+
};
|
|
384
|
+
};
|
|
385
|
+
readonly $defs: {
|
|
386
|
+
readonly Response: {
|
|
387
|
+
readonly $anchor: "response";
|
|
388
|
+
readonly title: "Rooms Keys List — response payload";
|
|
389
|
+
readonly description: "Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.";
|
|
390
|
+
readonly type: "object";
|
|
391
|
+
readonly additionalProperties: false;
|
|
392
|
+
readonly required: readonly ["rooms"];
|
|
393
|
+
readonly properties: {
|
|
394
|
+
readonly rooms: {
|
|
395
|
+
readonly type: "array";
|
|
396
|
+
readonly description: "One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.";
|
|
397
|
+
readonly items: {
|
|
398
|
+
readonly type: "object";
|
|
399
|
+
readonly additionalProperties: false;
|
|
400
|
+
readonly required: readonly ["roomId", "member", "epoch", "earliestReadableEpoch"];
|
|
401
|
+
readonly properties: {
|
|
402
|
+
readonly roomId: {
|
|
403
|
+
readonly type: "string";
|
|
404
|
+
readonly minLength: 1;
|
|
405
|
+
readonly maxLength: 512;
|
|
406
|
+
readonly description: "The room's identifier.";
|
|
407
|
+
};
|
|
408
|
+
readonly member: {
|
|
409
|
+
readonly type: "string";
|
|
410
|
+
readonly pattern: "^did:";
|
|
411
|
+
readonly maxLength: 2048;
|
|
412
|
+
readonly description: "The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.";
|
|
413
|
+
};
|
|
414
|
+
readonly epoch: {
|
|
415
|
+
readonly type: "integer";
|
|
416
|
+
readonly minimum: 1;
|
|
417
|
+
readonly description: "The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.";
|
|
418
|
+
};
|
|
419
|
+
readonly earliestReadableEpoch: {
|
|
420
|
+
readonly type: "integer";
|
|
421
|
+
readonly minimum: 1;
|
|
422
|
+
readonly description: "The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.";
|
|
423
|
+
};
|
|
424
|
+
readonly personal: {
|
|
425
|
+
readonly $ref: "#/$defs/PersonalLabel";
|
|
426
|
+
readonly description: "The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.";
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
readonly ext: {
|
|
432
|
+
readonly $ref: "#/$defs/Ext";
|
|
433
|
+
};
|
|
434
|
+
};
|
|
435
|
+
};
|
|
436
|
+
readonly Ext: {
|
|
437
|
+
readonly title: "Ext";
|
|
438
|
+
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.";
|
|
439
|
+
readonly type: "object";
|
|
440
|
+
readonly minProperties: 1;
|
|
441
|
+
readonly additionalProperties: true;
|
|
442
|
+
readonly propertyNames: {
|
|
443
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
444
|
+
};
|
|
445
|
+
};
|
|
446
|
+
readonly PersonalLabel: {
|
|
447
|
+
readonly title: "PersonalLabel";
|
|
448
|
+
readonly type: "object";
|
|
449
|
+
readonly additionalProperties: false;
|
|
450
|
+
readonly required: readonly ["updatedAt"];
|
|
451
|
+
readonly minProperties: 2;
|
|
452
|
+
readonly description: "A member's personal label for one room, as their key holder keeps it: at least one detail (`minProperties` counts `updatedAt`), and when it last changed. A key holder that holds no detail for the room holds no label, and returns none — there is no empty label.";
|
|
453
|
+
readonly properties: {
|
|
454
|
+
readonly label: {
|
|
455
|
+
readonly $ref: "#/$defs/PersonalLabelName";
|
|
456
|
+
};
|
|
457
|
+
readonly description: {
|
|
458
|
+
readonly $ref: "#/$defs/PersonalLabelDescription";
|
|
459
|
+
};
|
|
460
|
+
readonly notes: {
|
|
461
|
+
readonly $ref: "#/$defs/PersonalLabelNotes";
|
|
462
|
+
};
|
|
463
|
+
readonly tags: {
|
|
464
|
+
readonly $ref: "#/$defs/PersonalLabelTags";
|
|
465
|
+
};
|
|
466
|
+
readonly updatedAt: {
|
|
467
|
+
readonly type: "string";
|
|
468
|
+
readonly format: "date-time";
|
|
469
|
+
readonly description: "When the label last changed, as the key holder recorded it. A request that changed nothing does not move it.";
|
|
470
|
+
};
|
|
471
|
+
};
|
|
472
|
+
};
|
|
473
|
+
readonly PersonalLabelTags: {
|
|
474
|
+
readonly title: "PersonalLabelTags";
|
|
475
|
+
readonly type: "array";
|
|
476
|
+
readonly minItems: 1;
|
|
477
|
+
readonly maxItems: 16;
|
|
478
|
+
readonly uniqueItems: true;
|
|
479
|
+
readonly items: {
|
|
480
|
+
readonly $ref: "#/$defs/PersonalLabelTag";
|
|
481
|
+
};
|
|
482
|
+
readonly description: "The member's tags for the room, one to sixteen, as a set: order carries no meaning. A room with no tags has no `tags` member, never an empty list, so there is one way to say \"none\".";
|
|
483
|
+
};
|
|
484
|
+
readonly PersonalLabelTag: {
|
|
485
|
+
readonly title: "PersonalLabelTag";
|
|
486
|
+
readonly type: "string";
|
|
487
|
+
readonly minLength: 1;
|
|
488
|
+
readonly maxLength: 32;
|
|
489
|
+
readonly pattern: "^[^\\u0000-\\u001F\\u007F]+$";
|
|
490
|
+
readonly description: "A word or short phrase the member files the room under, in any script, so their own surfaces can group and filter their rooms. Compared exactly, as a string: a key holder does not case-fold or normalise it.";
|
|
491
|
+
};
|
|
492
|
+
readonly PersonalLabelNotes: {
|
|
493
|
+
readonly title: "PersonalLabelNotes";
|
|
494
|
+
readonly type: "string";
|
|
495
|
+
readonly minLength: 1;
|
|
496
|
+
readonly maxLength: 4000;
|
|
497
|
+
readonly pattern: "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$";
|
|
498
|
+
readonly description: "Longer free-form notes the member keeps about the room: who introduced them, what to look for in it, what they agreed there. Line breaks and tabs are allowed; other control characters are not.";
|
|
499
|
+
};
|
|
500
|
+
readonly PersonalLabelDescription: {
|
|
501
|
+
readonly title: "PersonalLabelDescription";
|
|
502
|
+
readonly type: "string";
|
|
503
|
+
readonly minLength: 1;
|
|
504
|
+
readonly maxLength: 1000;
|
|
505
|
+
readonly pattern: "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$";
|
|
506
|
+
readonly description: "What the room is to the member, in a sentence or a short paragraph. Line breaks and tabs are allowed; other control characters are not.";
|
|
507
|
+
};
|
|
508
|
+
readonly PersonalLabelName: {
|
|
509
|
+
readonly title: "PersonalLabelName";
|
|
510
|
+
readonly type: "string";
|
|
511
|
+
readonly minLength: 1;
|
|
512
|
+
readonly maxLength: 128;
|
|
513
|
+
readonly pattern: "^[^\\u0000-\\u001F\\u007F]+$";
|
|
514
|
+
readonly description: "The member's own name for the room, on one line: no control characters, line breaks included. Shown before every name a third party gave the room, because it is the only one nobody else wrote.";
|
|
515
|
+
};
|
|
516
|
+
};
|
|
517
|
+
};
|
|
518
|
+
};
|
|
519
|
+
/**
|
|
520
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
521
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
522
|
+
* parties (§7.3 item 5).
|
|
523
|
+
*/
|
|
524
|
+
export declare const RESPONSE_SPEC: {
|
|
525
|
+
readonly typeUri: "https://trusttasks.org/spec/rooms/keys/list/0.2#response";
|
|
526
|
+
readonly isBearer: false;
|
|
527
|
+
readonly isProofRequired: true;
|
|
528
|
+
readonly isRecipientRequired: true;
|
|
529
|
+
readonly isIssuedAtRequired: true;
|
|
530
|
+
readonly payloadSchema: {
|
|
531
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
532
|
+
readonly $ref: "#/$defs/Response";
|
|
533
|
+
readonly $defs: {
|
|
534
|
+
readonly Response: {
|
|
535
|
+
readonly $anchor: "response";
|
|
536
|
+
readonly title: "Rooms Keys List — response payload";
|
|
537
|
+
readonly description: "Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.";
|
|
538
|
+
readonly type: "object";
|
|
539
|
+
readonly additionalProperties: false;
|
|
540
|
+
readonly required: readonly ["rooms"];
|
|
541
|
+
readonly properties: {
|
|
542
|
+
readonly rooms: {
|
|
543
|
+
readonly type: "array";
|
|
544
|
+
readonly description: "One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.";
|
|
545
|
+
readonly items: {
|
|
546
|
+
readonly type: "object";
|
|
547
|
+
readonly additionalProperties: false;
|
|
548
|
+
readonly required: readonly ["roomId", "member", "epoch", "earliestReadableEpoch"];
|
|
549
|
+
readonly properties: {
|
|
550
|
+
readonly roomId: {
|
|
551
|
+
readonly type: "string";
|
|
552
|
+
readonly minLength: 1;
|
|
553
|
+
readonly maxLength: 512;
|
|
554
|
+
readonly description: "The room's identifier.";
|
|
555
|
+
};
|
|
556
|
+
readonly member: {
|
|
557
|
+
readonly type: "string";
|
|
558
|
+
readonly pattern: "^did:";
|
|
559
|
+
readonly maxLength: 2048;
|
|
560
|
+
readonly description: "The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.";
|
|
561
|
+
};
|
|
562
|
+
readonly epoch: {
|
|
563
|
+
readonly type: "integer";
|
|
564
|
+
readonly minimum: 1;
|
|
565
|
+
readonly description: "The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.";
|
|
566
|
+
};
|
|
567
|
+
readonly earliestReadableEpoch: {
|
|
568
|
+
readonly type: "integer";
|
|
569
|
+
readonly minimum: 1;
|
|
570
|
+
readonly description: "The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.";
|
|
571
|
+
};
|
|
572
|
+
readonly personal: {
|
|
573
|
+
readonly $ref: "#/$defs/PersonalLabel";
|
|
574
|
+
readonly description: "The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.";
|
|
575
|
+
};
|
|
576
|
+
};
|
|
577
|
+
};
|
|
578
|
+
};
|
|
579
|
+
readonly ext: {
|
|
580
|
+
readonly $ref: "#/$defs/Ext";
|
|
581
|
+
};
|
|
582
|
+
};
|
|
583
|
+
};
|
|
584
|
+
readonly Ext: {
|
|
585
|
+
readonly title: "Ext";
|
|
586
|
+
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.";
|
|
587
|
+
readonly type: "object";
|
|
588
|
+
readonly minProperties: 1;
|
|
589
|
+
readonly additionalProperties: true;
|
|
590
|
+
readonly propertyNames: {
|
|
591
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
592
|
+
};
|
|
593
|
+
};
|
|
594
|
+
readonly PersonalLabel: {
|
|
595
|
+
readonly title: "PersonalLabel";
|
|
596
|
+
readonly type: "object";
|
|
597
|
+
readonly additionalProperties: false;
|
|
598
|
+
readonly required: readonly ["updatedAt"];
|
|
599
|
+
readonly minProperties: 2;
|
|
600
|
+
readonly description: "A member's personal label for one room, as their key holder keeps it: at least one detail (`minProperties` counts `updatedAt`), and when it last changed. A key holder that holds no detail for the room holds no label, and returns none — there is no empty label.";
|
|
601
|
+
readonly properties: {
|
|
602
|
+
readonly label: {
|
|
603
|
+
readonly $ref: "#/$defs/PersonalLabelName";
|
|
604
|
+
};
|
|
605
|
+
readonly description: {
|
|
606
|
+
readonly $ref: "#/$defs/PersonalLabelDescription";
|
|
607
|
+
};
|
|
608
|
+
readonly notes: {
|
|
609
|
+
readonly $ref: "#/$defs/PersonalLabelNotes";
|
|
610
|
+
};
|
|
611
|
+
readonly tags: {
|
|
612
|
+
readonly $ref: "#/$defs/PersonalLabelTags";
|
|
613
|
+
};
|
|
614
|
+
readonly updatedAt: {
|
|
615
|
+
readonly type: "string";
|
|
616
|
+
readonly format: "date-time";
|
|
617
|
+
readonly description: "When the label last changed, as the key holder recorded it. A request that changed nothing does not move it.";
|
|
618
|
+
};
|
|
619
|
+
};
|
|
620
|
+
};
|
|
621
|
+
readonly PersonalLabelTags: {
|
|
622
|
+
readonly title: "PersonalLabelTags";
|
|
623
|
+
readonly type: "array";
|
|
624
|
+
readonly minItems: 1;
|
|
625
|
+
readonly maxItems: 16;
|
|
626
|
+
readonly uniqueItems: true;
|
|
627
|
+
readonly items: {
|
|
628
|
+
readonly $ref: "#/$defs/PersonalLabelTag";
|
|
629
|
+
};
|
|
630
|
+
readonly description: "The member's tags for the room, one to sixteen, as a set: order carries no meaning. A room with no tags has no `tags` member, never an empty list, so there is one way to say \"none\".";
|
|
631
|
+
};
|
|
632
|
+
readonly PersonalLabelTag: {
|
|
633
|
+
readonly title: "PersonalLabelTag";
|
|
634
|
+
readonly type: "string";
|
|
635
|
+
readonly minLength: 1;
|
|
636
|
+
readonly maxLength: 32;
|
|
637
|
+
readonly pattern: "^[^\\u0000-\\u001F\\u007F]+$";
|
|
638
|
+
readonly description: "A word or short phrase the member files the room under, in any script, so their own surfaces can group and filter their rooms. Compared exactly, as a string: a key holder does not case-fold or normalise it.";
|
|
639
|
+
};
|
|
640
|
+
readonly PersonalLabelNotes: {
|
|
641
|
+
readonly title: "PersonalLabelNotes";
|
|
642
|
+
readonly type: "string";
|
|
643
|
+
readonly minLength: 1;
|
|
644
|
+
readonly maxLength: 4000;
|
|
645
|
+
readonly pattern: "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$";
|
|
646
|
+
readonly description: "Longer free-form notes the member keeps about the room: who introduced them, what to look for in it, what they agreed there. Line breaks and tabs are allowed; other control characters are not.";
|
|
647
|
+
};
|
|
648
|
+
readonly PersonalLabelDescription: {
|
|
649
|
+
readonly title: "PersonalLabelDescription";
|
|
650
|
+
readonly type: "string";
|
|
651
|
+
readonly minLength: 1;
|
|
652
|
+
readonly maxLength: 1000;
|
|
653
|
+
readonly pattern: "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$";
|
|
654
|
+
readonly description: "What the room is to the member, in a sentence or a short paragraph. Line breaks and tabs are allowed; other control characters are not.";
|
|
655
|
+
};
|
|
656
|
+
readonly PersonalLabelName: {
|
|
657
|
+
readonly title: "PersonalLabelName";
|
|
658
|
+
readonly type: "string";
|
|
659
|
+
readonly minLength: 1;
|
|
660
|
+
readonly maxLength: 128;
|
|
661
|
+
readonly pattern: "^[^\\u0000-\\u001F\\u007F]+$";
|
|
662
|
+
readonly description: "The member's own name for the room, on one line: no control characters, line breaks included. Shown before every name a third party gave the room, because it is the only one nobody else wrote.";
|
|
663
|
+
};
|
|
664
|
+
};
|
|
665
|
+
};
|
|
666
|
+
};
|
|
667
|
+
//# sourceMappingURL=payload.d.ts.map
|