@openvtc/trust-tasks 0.28.25 → 0.28.26
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 +84 -0
- package/dist/_extends.d.ts.map +1 -1
- package/dist/_extends.js +9 -0
- package/dist/_extends.js.map +1 -1
- package/dist/_shared/components.d.ts +117 -0
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/acl/_shared/0.3/acl-entry.d.ts +24 -0
- package/dist/acl/_shared/0.3/acl-entry.d.ts.map +1 -0
- package/dist/acl/_shared/0.3/acl-entry.js +6 -0
- package/dist/acl/_shared/0.3/acl-entry.js.map +1 -0
- package/dist/acl/change-role/0.1/payload.d.ts +4 -4
- package/dist/acl/change-role/0.1/payload.js +1 -1
- package/dist/acl/change-role/0.2/payload.d.ts +14 -2
- package/dist/acl/change-role/0.2/payload.d.ts.map +1 -1
- package/dist/acl/change-role/0.2/payload.js +1 -1
- package/dist/acl/change-role/0.2/payload.js.map +1 -1
- package/dist/acl/change-role/0.3/payload.d.ts +1925 -0
- package/dist/acl/change-role/0.3/payload.d.ts.map +1 -0
- package/dist/acl/change-role/0.3/payload.js +1109 -0
- package/dist/acl/change-role/0.3/payload.js.map +1 -0
- package/dist/acl/grant/0.1/payload.d.ts +4 -4
- package/dist/acl/grant/0.1/payload.js +1 -1
- package/dist/acl/grant/0.2/payload.d.ts +14 -2
- package/dist/acl/grant/0.2/payload.d.ts.map +1 -1
- package/dist/acl/grant/0.2/payload.js +1 -1
- package/dist/acl/grant/0.2/payload.js.map +1 -1
- package/dist/acl/grant/0.3/payload.d.ts +1895 -0
- package/dist/acl/grant/0.3/payload.d.ts.map +1 -0
- package/dist/acl/grant/0.3/payload.js +1096 -0
- package/dist/acl/grant/0.3/payload.js.map +1 -0
- package/dist/acl/list/0.1/payload.d.ts +4 -4
- package/dist/acl/list/0.1/payload.js +1 -1
- package/dist/acl/list/0.2/payload.d.ts +4 -4
- package/dist/acl/list/0.2/payload.js +1 -1
- package/dist/acl/list/0.3/payload.d.ts +14 -2
- package/dist/acl/list/0.3/payload.d.ts.map +1 -1
- package/dist/acl/list/0.3/payload.js +1 -1
- package/dist/acl/list/0.3/payload.js.map +1 -1
- package/dist/acl/list/0.4/payload.d.ts +2079 -0
- package/dist/acl/list/0.4/payload.d.ts.map +1 -0
- package/dist/acl/list/0.4/payload.js +1185 -0
- package/dist/acl/list/0.4/payload.js.map +1 -0
- package/dist/acl/revoke/0.1/payload.d.ts +4 -4
- package/dist/acl/revoke/0.1/payload.js +1 -1
- package/dist/acl/revoke/0.2/payload.d.ts +14 -2
- package/dist/acl/revoke/0.2/payload.d.ts.map +1 -1
- package/dist/acl/revoke/0.2/payload.js +1 -1
- package/dist/acl/revoke/0.2/payload.js.map +1 -1
- package/dist/acl/revoke/0.3/payload.d.ts +2090 -0
- package/dist/acl/revoke/0.3/payload.d.ts.map +1 -0
- package/dist/acl/revoke/0.3/payload.js +1206 -0
- package/dist/acl/revoke/0.3/payload.js.map +1 -0
- package/dist/acl/show/0.1/payload.d.ts +4 -4
- package/dist/acl/show/0.1/payload.js +1 -1
- package/dist/acl/show/0.2/payload.d.ts +14 -2
- package/dist/acl/show/0.2/payload.d.ts.map +1 -1
- package/dist/acl/show/0.2/payload.js +1 -1
- package/dist/acl/show/0.2/payload.js.map +1 -1
- package/dist/acl/show/0.3/payload.d.ts +1935 -0
- package/dist/acl/show/0.3/payload.d.ts.map +1 -0
- package/dist/acl/show/0.3/payload.js +1122 -0
- package/dist/acl/show/0.3/payload.js.map +1 -0
- package/dist/acl/update/0.1/payload.d.ts +4 -4
- package/dist/acl/update/0.1/payload.js +1 -1
- package/dist/acl/update/0.2/payload.d.ts +14 -2
- package/dist/acl/update/0.2/payload.d.ts.map +1 -1
- package/dist/acl/update/0.2/payload.js +1 -1
- package/dist/acl/update/0.2/payload.js.map +1 -1
- package/dist/acl/update/0.3/payload.d.ts +2042 -0
- package/dist/acl/update/0.3/payload.d.ts.map +1 -0
- package/dist/acl/update/0.3/payload.js +1163 -0
- package/dist/acl/update/0.3/payload.js.map +1 -0
- package/dist/index.d.ts +48 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +48 -0
- package/dist/index.js.map +1 -1
- package/dist/rooms/_shared/0.2/room.d.ts +1 -1
- package/dist/rooms/_shared/0.2/room.d.ts.map +1 -1
- package/dist/rooms/keys/file-key/0.1/payload.d.ts +4 -4
- package/dist/rooms/keys/file-key/0.1/payload.js +1 -1
- package/dist/rooms/keys/file-key/0.2/payload.d.ts +14 -2
- package/dist/rooms/keys/file-key/0.2/payload.d.ts.map +1 -1
- package/dist/rooms/keys/file-key/0.2/payload.js +1 -1
- package/dist/rooms/keys/file-key/0.2/payload.js.map +1 -1
- package/dist/rooms/keys/file-key/0.3/payload.d.ts +396 -0
- package/dist/rooms/keys/file-key/0.3/payload.d.ts.map +1 -0
- package/dist/rooms/keys/file-key/0.3/payload.js +223 -0
- package/dist/rooms/keys/file-key/0.3/payload.js.map +1 -0
- package/dist/rooms/keys/open/0.1/payload.d.ts +4 -4
- package/dist/rooms/keys/open/0.1/payload.js +1 -1
- package/dist/rooms/keys/open/0.2/payload.d.ts +14 -2
- package/dist/rooms/keys/open/0.2/payload.d.ts.map +1 -1
- package/dist/rooms/keys/open/0.2/payload.js +1 -1
- package/dist/rooms/keys/open/0.2/payload.js.map +1 -1
- package/dist/rooms/keys/open/0.3/payload.d.ts +413 -0
- package/dist/rooms/keys/open/0.3/payload.d.ts.map +1 -0
- package/dist/rooms/keys/open/0.3/payload.js +227 -0
- package/dist/rooms/keys/open/0.3/payload.js.map +1 -0
- package/dist/rooms/keys/read/0.1/payload.d.ts +4 -4
- package/dist/rooms/keys/read/0.1/payload.js +1 -1
- package/dist/rooms/keys/read/0.2/payload.d.ts +14 -2
- package/dist/rooms/keys/read/0.2/payload.d.ts.map +1 -1
- package/dist/rooms/keys/read/0.2/payload.js +1 -1
- package/dist/rooms/keys/read/0.2/payload.js.map +1 -1
- package/dist/rooms/keys/read/0.3/payload.d.ts +1363 -0
- package/dist/rooms/keys/read/0.3/payload.d.ts.map +1 -0
- package/dist/rooms/keys/read/0.3/payload.js +731 -0
- package/dist/rooms/keys/read/0.3/payload.js.map +1 -0
- package/dist/rooms/owner/issue-authority/0.2/payload.d.ts +13 -2
- package/dist/rooms/owner/issue-authority/0.2/payload.d.ts.map +1 -1
- package/dist/rooms/owner/issue-authority/0.2/payload.js +1 -1
- package/dist/rooms/owner/issue-authority/0.2/payload.js.map +1 -1
- package/dist/rooms/owner/issue-authority/0.3/payload.d.ts +557 -0
- package/dist/rooms/owner/issue-authority/0.3/payload.d.ts.map +1 -0
- package/dist/rooms/owner/issue-authority/0.3/payload.js +322 -0
- package/dist/rooms/owner/issue-authority/0.3/payload.js.map +1 -0
- package/dist/rooms/records/get/0.1/payload.d.ts +4 -4
- package/dist/rooms/records/get/0.1/payload.js +1 -1
- package/dist/rooms/records/get/0.2/payload.d.ts +4 -4
- package/dist/rooms/records/get/0.2/payload.js +1 -1
- package/dist/rooms/records/get/0.3/payload.d.ts +13 -2
- package/dist/rooms/records/get/0.3/payload.d.ts.map +1 -1
- package/dist/rooms/records/get/0.3/payload.js +1 -1
- package/dist/rooms/records/get/0.3/payload.js.map +1 -1
- package/dist/rooms/records/get/0.4/payload.d.ts +1140 -0
- package/dist/rooms/records/get/0.4/payload.d.ts.map +1 -0
- package/dist/rooms/records/get/0.4/payload.js +613 -0
- package/dist/rooms/records/get/0.4/payload.js.map +1 -0
- package/dist/vault/sign-trust-task/0.2/payload.d.ts +5 -5
- package/dist/vault/sign-trust-task/0.2/payload.js +2 -2
- package/dist/vta/_shared/0.1/memory-record.d.ts +1 -1
- package/dist/vta/_shared/0.1/memory-record.d.ts.map +1 -1
- package/dist/vta/memory/delete/0.1/payload.d.ts +4 -4
- package/dist/vta/memory/delete/0.1/payload.js +1 -1
- package/dist/vta/memory/delete/0.2/payload.d.ts +14 -2
- package/dist/vta/memory/delete/0.2/payload.d.ts.map +1 -1
- package/dist/vta/memory/delete/0.2/payload.js +1 -1
- package/dist/vta/memory/delete/0.2/payload.js.map +1 -1
- package/dist/vta/memory/delete/0.3/payload.d.ts +491 -0
- package/dist/vta/memory/delete/0.3/payload.d.ts.map +1 -0
- package/dist/vta/memory/delete/0.3/payload.js +266 -0
- package/dist/vta/memory/delete/0.3/payload.js.map +1 -0
- package/dist/vta/memory/get/0.1/payload.d.ts +14 -2
- package/dist/vta/memory/get/0.1/payload.d.ts.map +1 -1
- package/dist/vta/memory/get/0.1/payload.js +1 -1
- package/dist/vta/memory/get/0.1/payload.js.map +1 -1
- package/dist/vta/memory/get/0.2/payload.d.ts +722 -0
- package/dist/vta/memory/get/0.2/payload.d.ts.map +1 -0
- package/dist/vta/memory/get/0.2/payload.js +391 -0
- package/dist/vta/memory/get/0.2/payload.js.map +1 -0
- package/dist/vta/memory/list/0.1/payload.d.ts +4 -4
- package/dist/vta/memory/list/0.1/payload.js +1 -1
- package/dist/vta/memory/list/0.2/payload.d.ts +14 -2
- package/dist/vta/memory/list/0.2/payload.d.ts.map +1 -1
- package/dist/vta/memory/list/0.2/payload.js +1 -1
- package/dist/vta/memory/list/0.2/payload.js.map +1 -1
- package/dist/vta/memory/list/0.3/payload.d.ts +769 -0
- package/dist/vta/memory/list/0.3/payload.d.ts.map +1 -0
- package/dist/vta/memory/list/0.3/payload.js +405 -0
- package/dist/vta/memory/list/0.3/payload.js.map +1 -0
- package/dist/vta/memory/put/0.1/payload.d.ts +4 -4
- package/dist/vta/memory/put/0.1/payload.js +1 -1
- package/dist/vta/memory/put/0.2/payload.d.ts +14 -2
- package/dist/vta/memory/put/0.2/payload.d.ts.map +1 -1
- package/dist/vta/memory/put/0.2/payload.js +1 -1
- package/dist/vta/memory/put/0.2/payload.js.map +1 -1
- package/dist/vta/memory/put/0.3/payload.d.ts +566 -0
- package/dist/vta/memory/put/0.3/payload.d.ts.map +1 -0
- package/dist/vta/memory/put/0.3/payload.js +306 -0
- package/dist/vta/memory/put/0.3/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_extends.ts +9 -0
- package/src/_shared/components.ts +117 -0
- package/src/acl/_shared/0.3/acl-entry.ts +25 -0
- package/src/acl/change-role/0.1/payload.ts +5 -5
- package/src/acl/change-role/0.2/payload.ts +15 -3
- package/src/acl/change-role/0.3/payload.ts +1167 -0
- package/src/acl/grant/0.1/payload.ts +5 -5
- package/src/acl/grant/0.2/payload.ts +15 -3
- package/src/acl/grant/0.3/payload.ts +1146 -0
- package/src/acl/list/0.1/payload.ts +5 -5
- package/src/acl/list/0.2/payload.ts +5 -5
- package/src/acl/list/0.3/payload.ts +15 -3
- package/src/acl/list/0.4/payload.ts +1267 -0
- package/src/acl/revoke/0.1/payload.ts +5 -5
- package/src/acl/revoke/0.2/payload.ts +15 -3
- package/src/acl/revoke/0.3/payload.ts +1278 -0
- package/src/acl/show/0.1/payload.ts +5 -5
- package/src/acl/show/0.2/payload.ts +15 -3
- package/src/acl/show/0.3/payload.ts +1172 -0
- package/src/acl/update/0.1/payload.ts +5 -5
- package/src/acl/update/0.2/payload.ts +15 -3
- package/src/acl/update/0.3/payload.ts +1258 -0
- package/src/index.ts +48 -0
- package/src/rooms/_shared/0.2/room.ts +1 -1
- package/src/rooms/keys/file-key/0.1/payload.ts +5 -5
- package/src/rooms/keys/file-key/0.2/payload.ts +15 -3
- package/src/rooms/keys/file-key/0.3/payload.ts +286 -0
- package/src/rooms/keys/open/0.1/payload.ts +5 -5
- package/src/rooms/keys/open/0.2/payload.ts +15 -3
- package/src/rooms/keys/open/0.3/payload.ts +299 -0
- package/src/rooms/keys/read/0.1/payload.ts +5 -5
- package/src/rooms/keys/read/0.2/payload.ts +15 -3
- package/src/rooms/keys/read/0.3/payload.ts +901 -0
- package/src/rooms/owner/issue-authority/0.2/payload.ts +14 -3
- package/src/rooms/owner/issue-authority/0.3/payload.ts +388 -0
- package/src/rooms/records/get/0.1/payload.ts +5 -5
- package/src/rooms/records/get/0.2/payload.ts +5 -5
- package/src/rooms/records/get/0.3/payload.ts +14 -3
- package/src/rooms/records/get/0.4/payload.ts +730 -0
- package/src/vault/sign-trust-task/0.2/payload.ts +3 -3
- package/src/vta/_shared/0.1/memory-record.ts +1 -1
- package/src/vta/memory/delete/0.1/payload.ts +5 -5
- package/src/vta/memory/delete/0.2/payload.ts +15 -3
- package/src/vta/memory/delete/0.3/payload.ts +334 -0
- package/src/vta/memory/get/0.1/payload.ts +15 -3
- package/src/vta/memory/get/0.2/payload.ts +460 -0
- package/src/vta/memory/list/0.1/payload.ts +5 -5
- package/src/vta/memory/list/0.2/payload.ts +15 -3
- package/src/vta/memory/list/0.3/payload.ts +491 -0
- package/src/vta/memory/put/0.1/payload.ts +5 -5
- package/src/vta/memory/put/0.2/payload.ts +15 -3
- package/src/vta/memory/put/0.3/payload.ts +379 -0
|
@@ -12,5 +12,5 @@ export interface RoomsSharedTypes {
|
|
|
12
12
|
* The definitions this shared schema publishes, hoisted to one declaration each.
|
|
13
13
|
* See "../../../_shared/components.js".
|
|
14
14
|
*/
|
|
15
|
-
export type { AuthorityPresentation, DataCommitment, HeadVersion, PermittedUse, ReadVerification, RecordBasis, RecordConfidence, RecordCount, RecordEditedAt, RecordEvidence, RecordEvidenceCredential, RecordEvidenceList, RecordEvidenceRecord, RecordKind, RecordMetadata, RecordMetadataV2, RecordMetadataV3, RecordPrune_RoomsV0_2 as RecordPrune, RecordReference, RecordRetention, RecordValidUntil, RecordWrittenAt, RetentionPolicy, RoomProfile, RoomProfileStatement, SealedRecordBody, Visibility } from "../../../_shared/components.js";
|
|
15
|
+
export type { AuthorityPresentation, DataCommitment, HeadVersion, PermittedUse, ReadVerification, RecordBasis, RecordConfidence, RecordCount, RecordEditedAt, RecordEvidence, RecordEvidenceCredential, RecordEvidenceList, RecordEvidenceRecord, RecordKind, RecordMetadata, RecordMetadataV2, RecordMetadataV3, RecordPrune_RoomsV0_2 as RecordPrune, RecordPurpose, RecordReference, RecordRetention, RecordValidUntil, RecordWrittenAt, RetentionPolicy, RoomProfile, RoomProfileStatement, SealedRecordBody, Visibility } from "../../../_shared/components.js";
|
|
16
16
|
//# sourceMappingURL=room.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"room.d.ts","sourceRoot":"","sources":["../../../../src/rooms/_shared/0.2/room.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AAED;;;GAGG;AACH,YAAY,EAAE,qBAAqB,EAAE,cAAc,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,gBAAgB,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,UAAU,EAAE,cAAc,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,qBAAqB,IAAI,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC"}
|
|
1
|
+
{"version":3,"file":"room.d.ts","sourceRoot":"","sources":["../../../../src/rooms/_shared/0.2/room.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AAED;;;GAGG;AACH,YAAY,EAAE,qBAAqB,EAAE,cAAc,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,gBAAgB,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,UAAU,EAAE,cAAc,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,qBAAqB,IAAI,WAAW,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC"}
|
|
@@ -6,7 +6,7 @@ import type { Ext } from "../../../../_shared/components.js";
|
|
|
6
6
|
/**
|
|
7
7
|
* A caller asks the party holding its principal's room keys for the key of ONE file in a room: derived from the room's storage key for an epoch, bound to the room, the epoch and the file's identifier, and opening that file and nothing else.
|
|
8
8
|
*
|
|
9
|
-
* @deprecated superseded by rooms/keys/file-key/0.
|
|
9
|
+
* @deprecated superseded by rooms/keys/file-key/0.3
|
|
10
10
|
*/
|
|
11
11
|
export interface RoomsKeysFileKeyPayload {
|
|
12
12
|
/**
|
|
@@ -33,7 +33,7 @@ export interface RoomsKeysFileKeyPayload {
|
|
|
33
33
|
/**
|
|
34
34
|
* Success response to rooms/keys/file-key. Type https://trusttasks.org/spec/rooms/keys/file-key/0.1#response.
|
|
35
35
|
*
|
|
36
|
-
* @deprecated superseded by rooms/keys/file-key/0.
|
|
36
|
+
* @deprecated superseded by rooms/keys/file-key/0.3
|
|
37
37
|
*/
|
|
38
38
|
export interface RoomsKeysFileKeyResponsePayload {
|
|
39
39
|
/**
|
|
@@ -67,7 +67,7 @@ export declare const DEPRECATION: string | null;
|
|
|
67
67
|
/**
|
|
68
68
|
* Stable alias for this specification's request payload shape.
|
|
69
69
|
*
|
|
70
|
-
* @deprecated superseded by rooms/keys/file-key/0.
|
|
70
|
+
* @deprecated superseded by rooms/keys/file-key/0.3
|
|
71
71
|
*/
|
|
72
72
|
export type Payload = RoomsKeysFileKeyPayload;
|
|
73
73
|
/** Trust Task response type URI (request type URI + "#response"). */
|
|
@@ -75,7 +75,7 @@ export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/rooms/keys/
|
|
|
75
75
|
/**
|
|
76
76
|
* Stable alias for this specification's success-response payload shape.
|
|
77
77
|
*
|
|
78
|
-
* @deprecated superseded by rooms/keys/file-key/0.
|
|
78
|
+
* @deprecated superseded by rooms/keys/file-key/0.3
|
|
79
79
|
*/
|
|
80
80
|
export type Response = RoomsKeysFileKeyResponsePayload;
|
|
81
81
|
/**
|
|
@@ -17,7 +17,7 @@ export const EXTENDS = null;
|
|
|
17
17
|
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
18
18
|
* Versions").
|
|
19
19
|
*/
|
|
20
|
-
export const DEPRECATION = "superseded by rooms/keys/file-key/0.
|
|
20
|
+
export const DEPRECATION = "superseded by rooms/keys/file-key/0.3";
|
|
21
21
|
/** Trust Task response type URI (request type URI + "#response"). */
|
|
22
22
|
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/keys/file-key/0.1#response";
|
|
23
23
|
/**
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
import type { Ext } from "../../../../_shared/components.js";
|
|
6
6
|
/**
|
|
7
7
|
* A caller asks the party holding its principal's room keys for the key of ONE file in a room: derived from the room's storage key for an epoch, bound to the room, the epoch and the file's identifier, and opening that file and nothing else.
|
|
8
|
+
*
|
|
9
|
+
* @deprecated superseded by rooms/keys/file-key/0.3
|
|
8
10
|
*/
|
|
9
11
|
export interface RoomsKeysFileKeyPayload {
|
|
10
12
|
/**
|
|
@@ -30,6 +32,8 @@ export interface RoomsKeysFileKeyPayload {
|
|
|
30
32
|
}
|
|
31
33
|
/**
|
|
32
34
|
* Success response to rooms/keys/file-key. Type https://trusttasks.org/spec/rooms/keys/file-key/0.2#response.
|
|
35
|
+
*
|
|
36
|
+
* @deprecated superseded by rooms/keys/file-key/0.3
|
|
33
37
|
*/
|
|
34
38
|
export interface RoomsKeysFileKeyResponsePayload {
|
|
35
39
|
/**
|
|
@@ -60,11 +64,19 @@ export declare const EXTENDS: string | null;
|
|
|
60
64
|
* Versions").
|
|
61
65
|
*/
|
|
62
66
|
export declare const DEPRECATION: string | null;
|
|
63
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Stable alias for this specification's request payload shape.
|
|
69
|
+
*
|
|
70
|
+
* @deprecated superseded by rooms/keys/file-key/0.3
|
|
71
|
+
*/
|
|
64
72
|
export type Payload = RoomsKeysFileKeyPayload;
|
|
65
73
|
/** Trust Task response type URI (request type URI + "#response"). */
|
|
66
74
|
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/rooms/keys/file-key/0.2#response";
|
|
67
|
-
/**
|
|
75
|
+
/**
|
|
76
|
+
* Stable alias for this specification's success-response payload shape.
|
|
77
|
+
*
|
|
78
|
+
* @deprecated superseded by rooms/keys/file-key/0.3
|
|
79
|
+
*/
|
|
68
80
|
export type Response = RoomsKeysFileKeyResponsePayload;
|
|
69
81
|
/**
|
|
70
82
|
* This specification's payload schema, as a value.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/rooms/keys/file-key/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAG7D
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/rooms/keys/file-key/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAG7D;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,CAAC;AAEpB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,qDAA8D,CAAC;AAEvF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAA8C,CAAC;AAElF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,uBAAuB,CAAC;AAE9C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,8DAAuE,CAAC;AAEzG;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,+BAA+B,CAAC;AAEvD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8EjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyC1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|
|
@@ -17,7 +17,7 @@ export const EXTENDS = null;
|
|
|
17
17
|
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
18
18
|
* Versions").
|
|
19
19
|
*/
|
|
20
|
-
export const DEPRECATION =
|
|
20
|
+
export const DEPRECATION = "superseded by rooms/keys/file-key/0.3";
|
|
21
21
|
/** Trust Task response type URI (request type URI + "#response"). */
|
|
22
22
|
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/keys/file-key/0.2#response";
|
|
23
23
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/rooms/keys/file-key/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
1
|
+
{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/rooms/keys/file-key/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAoDH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,qDAA8D,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAkB,IAAI,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAkB,uCAAuC,CAAC;AASlF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,8DAAuE,CAAC;AASzG;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,qDAAqD;IAC5D,OAAO,EAAE,+BAA+B;IACxC,aAAa,EAAE,gPAAgP;IAC/P,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,QAAQ;QACR,QAAQ;QACR,SAAS;KACV;IACD,YAAY,EAAE;QACZ,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,oIAAoI;SACpJ;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,qBAAqB;YAChC,aAAa,EAAE,qPAAqP;SACrQ;QACD,SAAS,EAAE;YACT,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,MAAM;gBACN,MAAM;aACP;YACD,aAAa,EAAE,4MAA4M;SAC5N;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,+ZAA+Z;SAC/a;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,yDAAyD;SACzE;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,wCAAwC;YACjD,aAAa,EAAE,6GAA6G;YAC5H,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,OAAO;aACR;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,qBAAqB;oBAChC,aAAa,EAAE,sNAAsN;iBACtO;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,+JAA+J;iBAC/K;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,wCAAwC;YACjD,aAAa,EAAE,6GAA6G;YAC5H,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,OAAO;aACR;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,qBAAqB;oBAChC,aAAa,EAAE,sNAAsN;iBACtO;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,+JAA+J;iBAC/K;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}
|
|
@@ -0,0 +1,396 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/rooms/keys/file-key/0.3/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext, Purpose_AclV0_3 as Purpose, Purpose_AclV0_31, Purpose_AclV0_32, RecordPurpose } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* A caller asks the party holding its principal's room keys for the key of ONE file in a room: derived from the room's storage key for an epoch, bound to the room, the epoch and the file's identifier, and opening that file and nothing else.
|
|
8
|
+
*/
|
|
9
|
+
export interface RoomsKeysFileKeyPayload {
|
|
10
|
+
/**
|
|
11
|
+
* The room the file belongs to. Bound into the derivation, so a key released for one room cannot open a blob relocated from another.
|
|
12
|
+
*/
|
|
13
|
+
roomId: string;
|
|
14
|
+
/**
|
|
15
|
+
* The file's identifier: 32 random bytes, base64url without padding, as in FileManifest.fileId. The salt of the derivation. For `seal` the caller mints it fresh and MUST NOT reuse it; for `open` it is read from the sealed record's file manifest.
|
|
16
|
+
*/
|
|
17
|
+
fileId: string;
|
|
18
|
+
/**
|
|
19
|
+
* `seal`: a key for a file about to be uploaded, derived under the room's CURRENT epoch, which the response names. `open`: a key for a file already in the room, derived under the epoch its manifest names.
|
|
20
|
+
*/
|
|
21
|
+
purpose: "seal" | "open";
|
|
22
|
+
/**
|
|
23
|
+
* The epoch the file key derives from, as FileManifest.epoch states it. REQUIRED for `open` and forbidden for `seal` — a rule over two members this schema does not express; the custodian refuses a violation with `malformedRequest`. A sealing caller never chooses the epoch: sealing under anything but the current one would produce a file members who joined later could not open, or one a removed member still could.
|
|
24
|
+
*/
|
|
25
|
+
epoch?: number;
|
|
26
|
+
/**
|
|
27
|
+
* Ecosystem-defined extension members per SPEC.md §4.5.1.
|
|
28
|
+
*/
|
|
29
|
+
ext?: Ext;
|
|
30
|
+
/**
|
|
31
|
+
* OPTIONAL. The one purpose the caller will use the file the released key opens for (VTI-ACL-103), as `RecordPurpose` defines it. Named `purposeOfUse` because `purpose` already says which key is asked for. Bound only on `purpose: open`: a `seal` key is for content the caller is about to upload itself. A purpose not granted is refused with `purposeNotGranted`; may be omitted where exactly one purpose is granted, or `any`.
|
|
32
|
+
*/
|
|
33
|
+
purposeOfUse?: RecordPurpose;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Success response to rooms/keys/file-key. Type https://trusttasks.org/spec/rooms/keys/file-key/0.2#response.
|
|
37
|
+
*/
|
|
38
|
+
export interface RoomsKeysFileKeyResponsePayload {
|
|
39
|
+
/**
|
|
40
|
+
* The 32-byte file key, base64url without padding. Opens exactly one file. The caller holds it in memory for as long as the file is being sealed or opened and then discards it; it never stores, logs or forwards it.
|
|
41
|
+
*/
|
|
42
|
+
key: string;
|
|
43
|
+
/**
|
|
44
|
+
* The epoch the key was derived under. For `seal`, the room's current epoch, which the caller writes into the file's manifest; for `open`, the epoch requested.
|
|
45
|
+
*/
|
|
46
|
+
epoch: number;
|
|
47
|
+
ext?: Ext;
|
|
48
|
+
}
|
|
49
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
50
|
+
export type { Ext, Purpose, Purpose_AclV0_31, Purpose_AclV0_32, RecordPurpose };
|
|
51
|
+
/** Trust Task type URI. */
|
|
52
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/rooms/keys/file-key/0.3";
|
|
53
|
+
/**
|
|
54
|
+
* The earlier version of this specification that this one declares it
|
|
55
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
56
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
57
|
+
* `extendsChain` / `readForSpec`.
|
|
58
|
+
*/
|
|
59
|
+
export declare const EXTENDS: string | null;
|
|
60
|
+
/**
|
|
61
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
62
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
63
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
64
|
+
* Versions").
|
|
65
|
+
*/
|
|
66
|
+
export declare const DEPRECATION: string | null;
|
|
67
|
+
/** Stable alias for this specification's request payload shape. */
|
|
68
|
+
export type Payload = RoomsKeysFileKeyPayload;
|
|
69
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
70
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/rooms/keys/file-key/0.3#response";
|
|
71
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
72
|
+
export type Response = RoomsKeysFileKeyResponsePayload;
|
|
73
|
+
/**
|
|
74
|
+
* This specification's payload schema, as a value.
|
|
75
|
+
*
|
|
76
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
77
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
78
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
79
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
80
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
81
|
+
*/
|
|
82
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
83
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
84
|
+
readonly $id: "https://trusttasks.org/spec/rooms/keys/file-key/0.3";
|
|
85
|
+
readonly title: "Rooms Keys File Key — payload";
|
|
86
|
+
readonly description: "A caller asks the party holding its principal's room keys for the key of ONE file in a room: derived from the room's storage key for an epoch, bound to the room, the epoch and the file's identifier, and opening that file and nothing else.";
|
|
87
|
+
readonly type: "object";
|
|
88
|
+
readonly additionalProperties: false;
|
|
89
|
+
readonly required: readonly ["roomId", "fileId", "purpose"];
|
|
90
|
+
readonly properties: {
|
|
91
|
+
readonly roomId: {
|
|
92
|
+
readonly type: "string";
|
|
93
|
+
readonly description: "The room the file belongs to. Bound into the derivation, so a key released for one room cannot open a blob relocated from another.";
|
|
94
|
+
};
|
|
95
|
+
readonly fileId: {
|
|
96
|
+
readonly type: "string";
|
|
97
|
+
readonly pattern: "^[A-Za-z0-9_-]{43}$";
|
|
98
|
+
readonly description: "The file's identifier: 32 random bytes, base64url without padding, as in FileManifest.fileId. The salt of the derivation. For `seal` the caller mints it fresh and MUST NOT reuse it; for `open` it is read from the sealed record's file manifest.";
|
|
99
|
+
};
|
|
100
|
+
readonly purpose: {
|
|
101
|
+
readonly type: "string";
|
|
102
|
+
readonly enum: readonly ["seal", "open"];
|
|
103
|
+
readonly description: "`seal`: a key for a file about to be uploaded, derived under the room's CURRENT epoch, which the response names. `open`: a key for a file already in the room, derived under the epoch its manifest names.";
|
|
104
|
+
};
|
|
105
|
+
readonly epoch: {
|
|
106
|
+
readonly type: "integer";
|
|
107
|
+
readonly minimum: 1;
|
|
108
|
+
readonly description: "The epoch the file key derives from, as FileManifest.epoch states it. REQUIRED for `open` and forbidden for `seal` — a rule over two members this schema does not express; the custodian refuses a violation with `malformedRequest`. A sealing caller never chooses the epoch: sealing under anything but the current one would produce a file members who joined later could not open, or one a removed member still could.";
|
|
109
|
+
};
|
|
110
|
+
readonly ext: {
|
|
111
|
+
readonly $ref: "#/$defs/Ext";
|
|
112
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
113
|
+
};
|
|
114
|
+
readonly purposeOfUse: {
|
|
115
|
+
readonly $ref: "#/$defs/RecordPurpose";
|
|
116
|
+
readonly description: "OPTIONAL. The one purpose the caller will use the file the released key opens for (VTI-ACL-103), as `RecordPurpose` defines it. Named `purposeOfUse` because `purpose` already says which key is asked for. Bound only on `purpose: open`: a `seal` key is for content the caller is about to upload itself. A purpose not granted is refused with `purposeNotGranted`; may be omitted where exactly one purpose is granted, or `any`.";
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
readonly $defs: {
|
|
120
|
+
readonly Response: {
|
|
121
|
+
readonly $anchor: "response";
|
|
122
|
+
readonly title: "Rooms Keys File Key — response payload";
|
|
123
|
+
readonly description: "Success response to rooms/keys/file-key. Type https://trusttasks.org/spec/rooms/keys/file-key/0.2#response.";
|
|
124
|
+
readonly type: "object";
|
|
125
|
+
readonly additionalProperties: false;
|
|
126
|
+
readonly required: readonly ["key", "epoch"];
|
|
127
|
+
readonly properties: {
|
|
128
|
+
readonly key: {
|
|
129
|
+
readonly type: "string";
|
|
130
|
+
readonly pattern: "^[A-Za-z0-9_-]{43}$";
|
|
131
|
+
readonly description: "The 32-byte file key, base64url without padding. Opens exactly one file. The caller holds it in memory for as long as the file is being sealed or opened and then discards it; it never stores, logs or forwards it.";
|
|
132
|
+
};
|
|
133
|
+
readonly epoch: {
|
|
134
|
+
readonly type: "integer";
|
|
135
|
+
readonly minimum: 1;
|
|
136
|
+
readonly description: "The epoch the key was derived under. For `seal`, the room's current epoch, which the caller writes into the file's manifest; for `open`, the epoch requested.";
|
|
137
|
+
};
|
|
138
|
+
readonly ext: {
|
|
139
|
+
readonly $ref: "#/$defs/Ext";
|
|
140
|
+
};
|
|
141
|
+
};
|
|
142
|
+
};
|
|
143
|
+
readonly Ext: {
|
|
144
|
+
readonly title: "Ext";
|
|
145
|
+
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.";
|
|
146
|
+
readonly type: "object";
|
|
147
|
+
readonly minProperties: 1;
|
|
148
|
+
readonly additionalProperties: true;
|
|
149
|
+
readonly propertyNames: {
|
|
150
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
151
|
+
};
|
|
152
|
+
};
|
|
153
|
+
readonly RecordPurpose: {
|
|
154
|
+
readonly title: "RecordPurpose";
|
|
155
|
+
readonly description: "The one purpose for which a caller will use room content a request discloses (VTI-ACL-103): a name registered in the VTI specification's purpose registry (`personalisation`, `taskExecution`, `analytics`, `modelTraining`) or an absolute IRI. Granted only as the caller's authority grants it — `any` grants every purpose but `modelTraining` — refused otherwise (`purposeNotGranted`), and recorded with the read. Distinct from `PermittedUse`, which is what a record's author permits and is a statement, not a grant.";
|
|
156
|
+
readonly $ref: "#/$defs/Purpose";
|
|
157
|
+
};
|
|
158
|
+
readonly Purpose: {
|
|
159
|
+
readonly title: "Purpose";
|
|
160
|
+
readonly description: "What content is used for: a lowerCamelCase name registered in the VTI specification's purpose registry (Appendix H) — `personalisation`, `taskExecution`, `analytics`, `modelTraining` at the time of writing — or an absolute IRI naming a purpose defined elsewhere, such as a purpose of the W3C Data Privacy Vocabulary (`https://w3id.org/dpv#ServicePersonalisation`). Compared by exact string equality: a consumer MUST NOT treat a purpose it does not recognise as equal to any other, and grants only a request naming exactly a listed purpose (VTI-ACL-109). A registered name is never an IRI, because it contains no `:`.";
|
|
161
|
+
readonly type: "string";
|
|
162
|
+
readonly maxLength: 2048;
|
|
163
|
+
readonly anyOf: readonly [{
|
|
164
|
+
readonly pattern: "^[a-z][a-zA-Z0-9]{0,63}$";
|
|
165
|
+
}, {
|
|
166
|
+
readonly pattern: "^[a-zA-Z][a-zA-Z0-9+.-]*:[^\\s]+$";
|
|
167
|
+
}];
|
|
168
|
+
};
|
|
169
|
+
};
|
|
170
|
+
};
|
|
171
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
172
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
173
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
174
|
+
readonly $ref: "#/$defs/Response";
|
|
175
|
+
readonly $defs: {
|
|
176
|
+
readonly Response: {
|
|
177
|
+
readonly $anchor: "response";
|
|
178
|
+
readonly title: "Rooms Keys File Key — response payload";
|
|
179
|
+
readonly description: "Success response to rooms/keys/file-key. Type https://trusttasks.org/spec/rooms/keys/file-key/0.2#response.";
|
|
180
|
+
readonly type: "object";
|
|
181
|
+
readonly additionalProperties: false;
|
|
182
|
+
readonly required: readonly ["key", "epoch"];
|
|
183
|
+
readonly properties: {
|
|
184
|
+
readonly key: {
|
|
185
|
+
readonly type: "string";
|
|
186
|
+
readonly pattern: "^[A-Za-z0-9_-]{43}$";
|
|
187
|
+
readonly description: "The 32-byte file key, base64url without padding. Opens exactly one file. The caller holds it in memory for as long as the file is being sealed or opened and then discards it; it never stores, logs or forwards it.";
|
|
188
|
+
};
|
|
189
|
+
readonly epoch: {
|
|
190
|
+
readonly type: "integer";
|
|
191
|
+
readonly minimum: 1;
|
|
192
|
+
readonly description: "The epoch the key was derived under. For `seal`, the room's current epoch, which the caller writes into the file's manifest; for `open`, the epoch requested.";
|
|
193
|
+
};
|
|
194
|
+
readonly ext: {
|
|
195
|
+
readonly $ref: "#/$defs/Ext";
|
|
196
|
+
};
|
|
197
|
+
};
|
|
198
|
+
};
|
|
199
|
+
readonly Ext: {
|
|
200
|
+
readonly title: "Ext";
|
|
201
|
+
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.";
|
|
202
|
+
readonly type: "object";
|
|
203
|
+
readonly minProperties: 1;
|
|
204
|
+
readonly additionalProperties: true;
|
|
205
|
+
readonly propertyNames: {
|
|
206
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
readonly RecordPurpose: {
|
|
210
|
+
readonly title: "RecordPurpose";
|
|
211
|
+
readonly description: "The one purpose for which a caller will use room content a request discloses (VTI-ACL-103): a name registered in the VTI specification's purpose registry (`personalisation`, `taskExecution`, `analytics`, `modelTraining`) or an absolute IRI. Granted only as the caller's authority grants it — `any` grants every purpose but `modelTraining` — refused otherwise (`purposeNotGranted`), and recorded with the read. Distinct from `PermittedUse`, which is what a record's author permits and is a statement, not a grant.";
|
|
212
|
+
readonly $ref: "#/$defs/Purpose";
|
|
213
|
+
};
|
|
214
|
+
readonly Purpose: {
|
|
215
|
+
readonly title: "Purpose";
|
|
216
|
+
readonly description: "What content is used for: a lowerCamelCase name registered in the VTI specification's purpose registry (Appendix H) — `personalisation`, `taskExecution`, `analytics`, `modelTraining` at the time of writing — or an absolute IRI naming a purpose defined elsewhere, such as a purpose of the W3C Data Privacy Vocabulary (`https://w3id.org/dpv#ServicePersonalisation`). Compared by exact string equality: a consumer MUST NOT treat a purpose it does not recognise as equal to any other, and grants only a request naming exactly a listed purpose (VTI-ACL-109). A registered name is never an IRI, because it contains no `:`.";
|
|
217
|
+
readonly type: "string";
|
|
218
|
+
readonly maxLength: 2048;
|
|
219
|
+
readonly anyOf: readonly [{
|
|
220
|
+
readonly pattern: "^[a-z][a-zA-Z0-9]{0,63}$";
|
|
221
|
+
}, {
|
|
222
|
+
readonly pattern: "^[a-zA-Z][a-zA-Z0-9+.-]*:[^\\s]+$";
|
|
223
|
+
}];
|
|
224
|
+
};
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
/**
|
|
228
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
229
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
230
|
+
* per-specification and cannot be derived from the document alone, and
|
|
231
|
+
* item 2 needs the schema this carries.
|
|
232
|
+
*/
|
|
233
|
+
export declare const SPEC: {
|
|
234
|
+
readonly typeUri: "https://trusttasks.org/spec/rooms/keys/file-key/0.3";
|
|
235
|
+
readonly isBearer: false;
|
|
236
|
+
readonly isProofRequired: true;
|
|
237
|
+
readonly isRecipientRequired: true;
|
|
238
|
+
readonly isIssuedAtRequired: true;
|
|
239
|
+
readonly payloadSchema: {
|
|
240
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
241
|
+
readonly $id: "https://trusttasks.org/spec/rooms/keys/file-key/0.3";
|
|
242
|
+
readonly title: "Rooms Keys File Key — payload";
|
|
243
|
+
readonly description: "A caller asks the party holding its principal's room keys for the key of ONE file in a room: derived from the room's storage key for an epoch, bound to the room, the epoch and the file's identifier, and opening that file and nothing else.";
|
|
244
|
+
readonly type: "object";
|
|
245
|
+
readonly additionalProperties: false;
|
|
246
|
+
readonly required: readonly ["roomId", "fileId", "purpose"];
|
|
247
|
+
readonly properties: {
|
|
248
|
+
readonly roomId: {
|
|
249
|
+
readonly type: "string";
|
|
250
|
+
readonly description: "The room the file belongs to. Bound into the derivation, so a key released for one room cannot open a blob relocated from another.";
|
|
251
|
+
};
|
|
252
|
+
readonly fileId: {
|
|
253
|
+
readonly type: "string";
|
|
254
|
+
readonly pattern: "^[A-Za-z0-9_-]{43}$";
|
|
255
|
+
readonly description: "The file's identifier: 32 random bytes, base64url without padding, as in FileManifest.fileId. The salt of the derivation. For `seal` the caller mints it fresh and MUST NOT reuse it; for `open` it is read from the sealed record's file manifest.";
|
|
256
|
+
};
|
|
257
|
+
readonly purpose: {
|
|
258
|
+
readonly type: "string";
|
|
259
|
+
readonly enum: readonly ["seal", "open"];
|
|
260
|
+
readonly description: "`seal`: a key for a file about to be uploaded, derived under the room's CURRENT epoch, which the response names. `open`: a key for a file already in the room, derived under the epoch its manifest names.";
|
|
261
|
+
};
|
|
262
|
+
readonly epoch: {
|
|
263
|
+
readonly type: "integer";
|
|
264
|
+
readonly minimum: 1;
|
|
265
|
+
readonly description: "The epoch the file key derives from, as FileManifest.epoch states it. REQUIRED for `open` and forbidden for `seal` — a rule over two members this schema does not express; the custodian refuses a violation with `malformedRequest`. A sealing caller never chooses the epoch: sealing under anything but the current one would produce a file members who joined later could not open, or one a removed member still could.";
|
|
266
|
+
};
|
|
267
|
+
readonly ext: {
|
|
268
|
+
readonly $ref: "#/$defs/Ext";
|
|
269
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
270
|
+
};
|
|
271
|
+
readonly purposeOfUse: {
|
|
272
|
+
readonly $ref: "#/$defs/RecordPurpose";
|
|
273
|
+
readonly description: "OPTIONAL. The one purpose the caller will use the file the released key opens for (VTI-ACL-103), as `RecordPurpose` defines it. Named `purposeOfUse` because `purpose` already says which key is asked for. Bound only on `purpose: open`: a `seal` key is for content the caller is about to upload itself. A purpose not granted is refused with `purposeNotGranted`; may be omitted where exactly one purpose is granted, or `any`.";
|
|
274
|
+
};
|
|
275
|
+
};
|
|
276
|
+
readonly $defs: {
|
|
277
|
+
readonly Response: {
|
|
278
|
+
readonly $anchor: "response";
|
|
279
|
+
readonly title: "Rooms Keys File Key — response payload";
|
|
280
|
+
readonly description: "Success response to rooms/keys/file-key. Type https://trusttasks.org/spec/rooms/keys/file-key/0.2#response.";
|
|
281
|
+
readonly type: "object";
|
|
282
|
+
readonly additionalProperties: false;
|
|
283
|
+
readonly required: readonly ["key", "epoch"];
|
|
284
|
+
readonly properties: {
|
|
285
|
+
readonly key: {
|
|
286
|
+
readonly type: "string";
|
|
287
|
+
readonly pattern: "^[A-Za-z0-9_-]{43}$";
|
|
288
|
+
readonly description: "The 32-byte file key, base64url without padding. Opens exactly one file. The caller holds it in memory for as long as the file is being sealed or opened and then discards it; it never stores, logs or forwards it.";
|
|
289
|
+
};
|
|
290
|
+
readonly epoch: {
|
|
291
|
+
readonly type: "integer";
|
|
292
|
+
readonly minimum: 1;
|
|
293
|
+
readonly description: "The epoch the key was derived under. For `seal`, the room's current epoch, which the caller writes into the file's manifest; for `open`, the epoch requested.";
|
|
294
|
+
};
|
|
295
|
+
readonly ext: {
|
|
296
|
+
readonly $ref: "#/$defs/Ext";
|
|
297
|
+
};
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
readonly Ext: {
|
|
301
|
+
readonly title: "Ext";
|
|
302
|
+
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.";
|
|
303
|
+
readonly type: "object";
|
|
304
|
+
readonly minProperties: 1;
|
|
305
|
+
readonly additionalProperties: true;
|
|
306
|
+
readonly propertyNames: {
|
|
307
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
readonly RecordPurpose: {
|
|
311
|
+
readonly title: "RecordPurpose";
|
|
312
|
+
readonly description: "The one purpose for which a caller will use room content a request discloses (VTI-ACL-103): a name registered in the VTI specification's purpose registry (`personalisation`, `taskExecution`, `analytics`, `modelTraining`) or an absolute IRI. Granted only as the caller's authority grants it — `any` grants every purpose but `modelTraining` — refused otherwise (`purposeNotGranted`), and recorded with the read. Distinct from `PermittedUse`, which is what a record's author permits and is a statement, not a grant.";
|
|
313
|
+
readonly $ref: "#/$defs/Purpose";
|
|
314
|
+
};
|
|
315
|
+
readonly Purpose: {
|
|
316
|
+
readonly title: "Purpose";
|
|
317
|
+
readonly description: "What content is used for: a lowerCamelCase name registered in the VTI specification's purpose registry (Appendix H) — `personalisation`, `taskExecution`, `analytics`, `modelTraining` at the time of writing — or an absolute IRI naming a purpose defined elsewhere, such as a purpose of the W3C Data Privacy Vocabulary (`https://w3id.org/dpv#ServicePersonalisation`). Compared by exact string equality: a consumer MUST NOT treat a purpose it does not recognise as equal to any other, and grants only a request naming exactly a listed purpose (VTI-ACL-109). A registered name is never an IRI, because it contains no `:`.";
|
|
318
|
+
readonly type: "string";
|
|
319
|
+
readonly maxLength: 2048;
|
|
320
|
+
readonly anyOf: readonly [{
|
|
321
|
+
readonly pattern: "^[a-z][a-zA-Z0-9]{0,63}$";
|
|
322
|
+
}, {
|
|
323
|
+
readonly pattern: "^[a-zA-Z][a-zA-Z0-9+.-]*:[^\\s]+$";
|
|
324
|
+
}];
|
|
325
|
+
};
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
331
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
332
|
+
* parties (§7.3 item 5).
|
|
333
|
+
*/
|
|
334
|
+
export declare const RESPONSE_SPEC: {
|
|
335
|
+
readonly typeUri: "https://trusttasks.org/spec/rooms/keys/file-key/0.3#response";
|
|
336
|
+
readonly isBearer: false;
|
|
337
|
+
readonly isProofRequired: true;
|
|
338
|
+
readonly isRecipientRequired: true;
|
|
339
|
+
readonly isIssuedAtRequired: true;
|
|
340
|
+
readonly payloadSchema: {
|
|
341
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
342
|
+
readonly $ref: "#/$defs/Response";
|
|
343
|
+
readonly $defs: {
|
|
344
|
+
readonly Response: {
|
|
345
|
+
readonly $anchor: "response";
|
|
346
|
+
readonly title: "Rooms Keys File Key — response payload";
|
|
347
|
+
readonly description: "Success response to rooms/keys/file-key. Type https://trusttasks.org/spec/rooms/keys/file-key/0.2#response.";
|
|
348
|
+
readonly type: "object";
|
|
349
|
+
readonly additionalProperties: false;
|
|
350
|
+
readonly required: readonly ["key", "epoch"];
|
|
351
|
+
readonly properties: {
|
|
352
|
+
readonly key: {
|
|
353
|
+
readonly type: "string";
|
|
354
|
+
readonly pattern: "^[A-Za-z0-9_-]{43}$";
|
|
355
|
+
readonly description: "The 32-byte file key, base64url without padding. Opens exactly one file. The caller holds it in memory for as long as the file is being sealed or opened and then discards it; it never stores, logs or forwards it.";
|
|
356
|
+
};
|
|
357
|
+
readonly epoch: {
|
|
358
|
+
readonly type: "integer";
|
|
359
|
+
readonly minimum: 1;
|
|
360
|
+
readonly description: "The epoch the key was derived under. For `seal`, the room's current epoch, which the caller writes into the file's manifest; for `open`, the epoch requested.";
|
|
361
|
+
};
|
|
362
|
+
readonly ext: {
|
|
363
|
+
readonly $ref: "#/$defs/Ext";
|
|
364
|
+
};
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
readonly Ext: {
|
|
368
|
+
readonly title: "Ext";
|
|
369
|
+
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.";
|
|
370
|
+
readonly type: "object";
|
|
371
|
+
readonly minProperties: 1;
|
|
372
|
+
readonly additionalProperties: true;
|
|
373
|
+
readonly propertyNames: {
|
|
374
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
375
|
+
};
|
|
376
|
+
};
|
|
377
|
+
readonly RecordPurpose: {
|
|
378
|
+
readonly title: "RecordPurpose";
|
|
379
|
+
readonly description: "The one purpose for which a caller will use room content a request discloses (VTI-ACL-103): a name registered in the VTI specification's purpose registry (`personalisation`, `taskExecution`, `analytics`, `modelTraining`) or an absolute IRI. Granted only as the caller's authority grants it — `any` grants every purpose but `modelTraining` — refused otherwise (`purposeNotGranted`), and recorded with the read. Distinct from `PermittedUse`, which is what a record's author permits and is a statement, not a grant.";
|
|
380
|
+
readonly $ref: "#/$defs/Purpose";
|
|
381
|
+
};
|
|
382
|
+
readonly Purpose: {
|
|
383
|
+
readonly title: "Purpose";
|
|
384
|
+
readonly description: "What content is used for: a lowerCamelCase name registered in the VTI specification's purpose registry (Appendix H) — `personalisation`, `taskExecution`, `analytics`, `modelTraining` at the time of writing — or an absolute IRI naming a purpose defined elsewhere, such as a purpose of the W3C Data Privacy Vocabulary (`https://w3id.org/dpv#ServicePersonalisation`). Compared by exact string equality: a consumer MUST NOT treat a purpose it does not recognise as equal to any other, and grants only a request naming exactly a listed purpose (VTI-ACL-109). A registered name is never an IRI, because it contains no `:`.";
|
|
385
|
+
readonly type: "string";
|
|
386
|
+
readonly maxLength: 2048;
|
|
387
|
+
readonly anyOf: readonly [{
|
|
388
|
+
readonly pattern: "^[a-z][a-zA-Z0-9]{0,63}$";
|
|
389
|
+
}, {
|
|
390
|
+
readonly pattern: "^[a-zA-Z][a-zA-Z0-9+.-]*:[^\\s]+$";
|
|
391
|
+
}];
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
};
|
|
395
|
+
};
|
|
396
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/rooms/keys/file-key/0.3/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,eAAe,IAAI,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAG5I;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;IACV;;OAEG;IACH,YAAY,CAAC,EAAE,aAAa,CAAC;CAC9B;AACD;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC;AAEhF,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,qDAA8D,CAAC;AAEvF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAY,CAAC;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,uBAAuB,CAAC;AAE9C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,8DAAuE,CAAC;AAEzG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,+BAA+B,CAAC;AAEvD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqGjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4D1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|