@openvtc/trust-tasks 0.23.8 → 0.23.9
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 +28 -0
- package/dist/_shared/components.d.ts +2451 -4
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/auth/oob/_shared/0.1/oob.d.ts +16 -0
- package/dist/auth/oob/_shared/0.1/oob.d.ts.map +1 -0
- package/dist/auth/oob/_shared/0.1/oob.js +6 -0
- package/dist/auth/oob/_shared/0.1/oob.js.map +1 -0
- package/dist/auth/oob/cancel/0.1/payload.d.ts +262 -0
- package/dist/auth/oob/cancel/0.1/payload.d.ts.map +1 -0
- package/dist/auth/oob/cancel/0.1/payload.js +153 -0
- package/dist/auth/oob/cancel/0.1/payload.js.map +1 -0
- package/dist/auth/oob/claim/0.1/payload.d.ts +463 -0
- package/dist/auth/oob/claim/0.1/payload.d.ts.map +1 -0
- package/dist/auth/oob/claim/0.1/payload.js +264 -0
- package/dist/auth/oob/claim/0.1/payload.js.map +1 -0
- package/dist/auth/oob/grant/0.1/payload.d.ts +212 -0
- package/dist/auth/oob/grant/0.1/payload.d.ts.map +1 -0
- package/dist/auth/oob/grant/0.1/payload.js +117 -0
- package/dist/auth/oob/grant/0.1/payload.js.map +1 -0
- package/dist/auth/oob/identify/0.1/payload.d.ts +145 -0
- package/dist/auth/oob/identify/0.1/payload.d.ts.map +1 -0
- package/dist/auth/oob/identify/0.1/payload.js +81 -0
- package/dist/auth/oob/identify/0.1/payload.js.map +1 -0
- package/dist/auth/oob/prove/0.1/payload.d.ts +740 -0
- package/dist/auth/oob/prove/0.1/payload.d.ts.map +1 -0
- package/dist/auth/oob/prove/0.1/payload.js +422 -0
- package/dist/auth/oob/prove/0.1/payload.js.map +1 -0
- package/dist/auth/oob/redeem/0.1/payload.d.ts +364 -0
- package/dist/auth/oob/redeem/0.1/payload.d.ts.map +1 -0
- package/dist/auth/oob/redeem/0.1/payload.js +199 -0
- package/dist/auth/oob/redeem/0.1/payload.js.map +1 -0
- package/dist/auth/oob/request/0.1/payload.d.ts +330 -0
- package/dist/auth/oob/request/0.1/payload.d.ts.map +1 -0
- package/dist/auth/oob/request/0.1/payload.js +193 -0
- package/dist/auth/oob/request/0.1/payload.js.map +1 -0
- package/dist/auth/oob/respond/0.1/payload.d.ts +235 -0
- package/dist/auth/oob/respond/0.1/payload.d.ts.map +1 -0
- package/dist/auth/oob/respond/0.1/payload.js +140 -0
- package/dist/auth/oob/respond/0.1/payload.js.map +1 -0
- package/dist/device/list/0.1/payload.d.ts +4 -4
- package/dist/device/list/0.1/payload.d.ts.map +1 -1
- package/dist/device/list/0.1/payload.js +6 -2
- package/dist/device/list/0.1/payload.js.map +1 -1
- package/dist/device/list/0.2/payload.d.ts +4 -4
- package/dist/device/list/0.2/payload.d.ts.map +1 -1
- package/dist/device/list/0.2/payload.js +6 -2
- package/dist/device/list/0.2/payload.js.map +1 -1
- package/dist/device/register/0.1/payload.d.ts +4 -4
- package/dist/device/register/0.1/payload.d.ts.map +1 -1
- package/dist/device/register/0.1/payload.js +6 -2
- package/dist/device/register/0.1/payload.js.map +1 -1
- package/dist/device/register/0.2/payload.d.ts +4 -4
- package/dist/device/register/0.2/payload.d.ts.map +1 -1
- package/dist/device/register/0.2/payload.js +6 -2
- package/dist/device/register/0.2/payload.js.map +1 -1
- package/dist/external/_shared/0.1/accounts.d.ts +18 -0
- package/dist/external/_shared/0.1/accounts.d.ts.map +1 -0
- package/dist/external/_shared/0.1/accounts.js +6 -0
- package/dist/external/_shared/0.1/accounts.js.map +1 -0
- package/dist/external/accounts/archive/0.1/payload.d.ts +2945 -0
- package/dist/external/accounts/archive/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/archive/0.1/payload.js +1736 -0
- package/dist/external/accounts/archive/0.1/payload.js.map +1 -0
- package/dist/external/accounts/bindings/grant/0.1/payload.d.ts +2938 -0
- package/dist/external/accounts/bindings/grant/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/bindings/grant/0.1/payload.js +1735 -0
- package/dist/external/accounts/bindings/grant/0.1/payload.js.map +1 -0
- package/dist/external/accounts/bindings/revoke/0.1/payload.d.ts +2958 -0
- package/dist/external/accounts/bindings/revoke/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/bindings/revoke/0.1/payload.js +1743 -0
- package/dist/external/accounts/bindings/revoke/0.1/payload.js.map +1 -0
- package/dist/external/accounts/create/0.1/payload.d.ts +2954 -0
- package/dist/external/accounts/create/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/create/0.1/payload.js +1742 -0
- package/dist/external/accounts/create/0.1/payload.js.map +1 -0
- package/dist/external/accounts/delete/0.1/payload.d.ts +310 -0
- package/dist/external/accounts/delete/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/delete/0.1/payload.js +176 -0
- package/dist/external/accounts/delete/0.1/payload.js.map +1 -0
- package/dist/external/accounts/get/0.1/payload.d.ts +2931 -0
- package/dist/external/accounts/get/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/get/0.1/payload.js +1731 -0
- package/dist/external/accounts/get/0.1/payload.js.map +1 -0
- package/dist/external/accounts/keys/rotate/0.1/payload.d.ts +3216 -0
- package/dist/external/accounts/keys/rotate/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/keys/rotate/0.1/payload.js +1912 -0
- package/dist/external/accounts/keys/rotate/0.1/payload.js.map +1 -0
- package/dist/external/accounts/list/0.1/payload.d.ts +3034 -0
- package/dist/external/accounts/list/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/list/0.1/payload.js +1791 -0
- package/dist/external/accounts/list/0.1/payload.js.map +1 -0
- package/dist/external/accounts/probe/0.1/payload.d.ts +511 -0
- package/dist/external/accounts/probe/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/probe/0.1/payload.js +307 -0
- package/dist/external/accounts/probe/0.1/payload.js.map +1 -0
- package/dist/external/accounts/restore/0.1/payload.d.ts +2945 -0
- package/dist/external/accounts/restore/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/restore/0.1/payload.js +1736 -0
- package/dist/external/accounts/restore/0.1/payload.js.map +1 -0
- package/dist/external/accounts/resume/0.1/payload.d.ts +2945 -0
- package/dist/external/accounts/resume/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/resume/0.1/payload.js +1736 -0
- package/dist/external/accounts/resume/0.1/payload.js.map +1 -0
- package/dist/external/accounts/secret/set/0.1/payload.d.ts +379 -0
- package/dist/external/accounts/secret/set/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/secret/set/0.1/payload.js +212 -0
- package/dist/external/accounts/secret/set/0.1/payload.js.map +1 -0
- package/dist/external/accounts/setup/0.1/payload.d.ts +535 -0
- package/dist/external/accounts/setup/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/setup/0.1/payload.js +325 -0
- package/dist/external/accounts/setup/0.1/payload.js.map +1 -0
- package/dist/external/accounts/suspend/0.1/payload.d.ts +2945 -0
- package/dist/external/accounts/suspend/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/suspend/0.1/payload.js +1736 -0
- package/dist/external/accounts/suspend/0.1/payload.js.map +1 -0
- package/dist/external/accounts/update/0.1/payload.d.ts +2949 -0
- package/dist/external/accounts/update/0.1/payload.d.ts.map +1 -0
- package/dist/external/accounts/update/0.1/payload.js +1739 -0
- package/dist/external/accounts/update/0.1/payload.js.map +1 -0
- package/dist/external/credentials/issue/0.1/payload.d.ts +586 -0
- package/dist/external/credentials/issue/0.1/payload.d.ts.map +1 -0
- package/dist/external/credentials/issue/0.1/payload.js +322 -0
- package/dist/external/credentials/issue/0.1/payload.js.map +1 -0
- package/dist/external/sign/0.1/payload.d.ts +348 -0
- package/dist/external/sign/0.1/payload.d.ts.map +1 -0
- package/dist/external/sign/0.1/payload.js +193 -0
- package/dist/external/sign/0.1/payload.js.map +1 -0
- package/dist/index.d.ts +53 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +53 -0
- package/dist/index.js.map +1 -1
- package/dist/rooms/_shared/0.1/blobs.d.ts +16 -0
- package/dist/rooms/_shared/0.1/blobs.d.ts.map +1 -0
- package/dist/rooms/_shared/0.1/blobs.js +6 -0
- package/dist/rooms/_shared/0.1/blobs.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/chunk/0.1/payload.d.ts +375 -0
- package/dist/rooms/blobs/chunk/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/blobs/chunk/0.1/payload.js +213 -0
- package/dist/rooms/blobs/chunk/0.1/payload.js.map +1 -0
- package/dist/rooms/blobs/get/0.1/payload.d.ts +743 -0
- package/dist/rooms/blobs/get/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/blobs/get/0.1/payload.js +415 -0
- package/dist/rooms/blobs/get/0.1/payload.js.map +1 -0
- package/dist/rooms/blobs/upload/abort/0.1/payload.d.ts +263 -0
- package/dist/rooms/blobs/upload/abort/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/blobs/upload/abort/0.1/payload.js +151 -0
- package/dist/rooms/blobs/upload/abort/0.1/payload.js.map +1 -0
- package/dist/rooms/blobs/upload/begin/0.1/payload.d.ts +793 -0
- package/dist/rooms/blobs/upload/begin/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/blobs/upload/begin/0.1/payload.js +437 -0
- package/dist/rooms/blobs/upload/begin/0.1/payload.js.map +1 -0
- package/dist/rooms/blobs/upload/chunk/0.1/payload.d.ts +459 -0
- package/dist/rooms/blobs/upload/chunk/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/blobs/upload/chunk/0.1/payload.js +256 -0
- package/dist/rooms/blobs/upload/chunk/0.1/payload.js.map +1 -0
- package/dist/rooms/blobs/upload/commit/0.1/payload.d.ts +326 -0
- package/dist/rooms/blobs/upload/commit/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/blobs/upload/commit/0.1/payload.js +185 -0
- package/dist/rooms/blobs/upload/commit/0.1/payload.js.map +1 -0
- package/dist/rooms/info/0.1/payload.d.ts +897 -0
- package/dist/rooms/info/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/info/0.1/payload.js +498 -0
- package/dist/rooms/info/0.1/payload.js.map +1 -0
- package/dist/rooms/keys/file-key/0.1/payload.d.ts +306 -0
- package/dist/rooms/keys/file-key/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/keys/file-key/0.1/payload.js +167 -0
- package/dist/rooms/keys/file-key/0.1/payload.js.map +1 -0
- package/dist/rooms/records/get/0.2/payload.d.ts +954 -0
- package/dist/rooms/records/get/0.2/payload.d.ts.map +1 -0
- package/dist/rooms/records/get/0.2/payload.js +515 -0
- package/dist/rooms/records/get/0.2/payload.js.map +1 -0
- package/dist/rooms/records/list/0.2/payload.d.ts +854 -0
- package/dist/rooms/records/list/0.2/payload.d.ts.map +1 -0
- package/dist/rooms/records/list/0.2/payload.js +462 -0
- package/dist/rooms/records/list/0.2/payload.js.map +1 -0
- package/dist/rooms/records/put/0.2/payload.d.ts +679 -0
- package/dist/rooms/records/put/0.2/payload.d.ts.map +1 -0
- package/dist/rooms/records/put/0.2/payload.js +357 -0
- package/dist/rooms/records/put/0.2/payload.js.map +1 -0
- package/dist/rooms/usage/0.1/payload.d.ts +795 -0
- package/dist/rooms/usage/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/usage/0.1/payload.js +417 -0
- package/dist/rooms/usage/0.1/payload.js.map +1 -0
- package/dist/vtc/_shared/0.1/room-storage.d.ts +16 -0
- package/dist/vtc/_shared/0.1/room-storage.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/room-storage.js +6 -0
- package/dist/vtc/_shared/0.1/room-storage.js.map +1 -0
- package/dist/vtc/rooms/get/0.1/payload.d.ts +1813 -0
- package/dist/vtc/rooms/get/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/get/0.1/payload.js +892 -0
- package/dist/vtc/rooms/get/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/limits/set/0.1/payload.d.ts +873 -0
- package/dist/vtc/rooms/limits/set/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/limits/set/0.1/payload.js +489 -0
- package/dist/vtc/rooms/limits/set/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/storage/assign/0.1/payload.d.ts +341 -0
- package/dist/vtc/rooms/storage/assign/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/storage/assign/0.1/payload.js +191 -0
- package/dist/vtc/rooms/storage/assign/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/storage/migrate/0.1/payload.d.ts +452 -0
- package/dist/vtc/rooms/storage/migrate/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/storage/migrate/0.1/payload.js +260 -0
- package/dist/vtc/rooms/storage/migrate/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/usage/0.1/payload.d.ts +880 -0
- package/dist/vtc/rooms/usage/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/usage/0.1/payload.js +457 -0
- package/dist/vtc/rooms/usage/0.1/payload.js.map +1 -0
- package/dist/vtc/storage/configs/create/0.1/payload.d.ts +1272 -0
- package/dist/vtc/storage/configs/create/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/storage/configs/create/0.1/payload.js +737 -0
- package/dist/vtc/storage/configs/create/0.1/payload.js.map +1 -0
- package/dist/vtc/storage/configs/get/0.1/payload.d.ts +1750 -0
- package/dist/vtc/storage/configs/get/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/storage/configs/get/0.1/payload.js +1019 -0
- package/dist/vtc/storage/configs/get/0.1/payload.js.map +1 -0
- package/dist/vtc/storage/configs/list/0.1/payload.d.ts +1851 -0
- package/dist/vtc/storage/configs/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/storage/configs/list/0.1/payload.js +1069 -0
- package/dist/vtc/storage/configs/list/0.1/payload.js.map +1 -0
- package/dist/vtc/storage/configs/probe/0.1/payload.d.ts +459 -0
- package/dist/vtc/storage/configs/probe/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/storage/configs/probe/0.1/payload.js +267 -0
- package/dist/vtc/storage/configs/probe/0.1/payload.js.map +1 -0
- package/dist/vtc/storage/configs/retire/0.1/payload.d.ts +294 -0
- package/dist/vtc/storage/configs/retire/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/storage/configs/retire/0.1/payload.js +176 -0
- package/dist/vtc/storage/configs/retire/0.1/payload.js.map +1 -0
- package/dist/vtc/storage/configs/update/0.1/payload.d.ts +1274 -0
- package/dist/vtc/storage/configs/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/storage/configs/update/0.1/payload.js +736 -0
- package/dist/vtc/storage/configs/update/0.1/payload.js.map +1 -0
- package/dist/vtc/storage/credentials/set/0.1/payload.d.ts +511 -0
- package/dist/vtc/storage/credentials/set/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/storage/credentials/set/0.1/payload.js +293 -0
- package/dist/vtc/storage/credentials/set/0.1/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_shared/components.ts +2539 -4
- package/src/auth/oob/_shared/0.1/oob.ts +17 -0
- package/src/auth/oob/cancel/0.1/payload.ts +188 -0
- package/src/auth/oob/claim/0.1/payload.ts +306 -0
- package/src/auth/oob/grant/0.1/payload.ts +159 -0
- package/src/auth/oob/identify/0.1/payload.ts +110 -0
- package/src/auth/oob/prove/0.1/payload.ts +473 -0
- package/src/auth/oob/redeem/0.1/payload.ts +248 -0
- package/src/auth/oob/request/0.1/payload.ts +230 -0
- package/src/auth/oob/respond/0.1/payload.ts +178 -0
- package/src/device/list/0.1/payload.ts +6 -2
- package/src/device/list/0.2/payload.ts +6 -2
- package/src/device/register/0.1/payload.ts +6 -2
- package/src/device/register/0.2/payload.ts +6 -2
- package/src/external/_shared/0.1/accounts.ts +19 -0
- package/src/external/accounts/archive/0.1/payload.ts +1770 -0
- package/src/external/accounts/bindings/grant/0.1/payload.ts +1766 -0
- package/src/external/accounts/bindings/revoke/0.1/payload.ts +1778 -0
- package/src/external/accounts/create/0.1/payload.ts +1777 -0
- package/src/external/accounts/delete/0.1/payload.ts +211 -0
- package/src/external/accounts/get/0.1/payload.ts +1761 -0
- package/src/external/accounts/keys/rotate/0.1/payload.ts +1947 -0
- package/src/external/accounts/list/0.1/payload.ts +1834 -0
- package/src/external/accounts/probe/0.1/payload.ts +337 -0
- package/src/external/accounts/restore/0.1/payload.ts +1770 -0
- package/src/external/accounts/resume/0.1/payload.ts +1770 -0
- package/src/external/accounts/secret/set/0.1/payload.ts +248 -0
- package/src/external/accounts/setup/0.1/payload.ts +355 -0
- package/src/external/accounts/suspend/0.1/payload.ts +1770 -0
- package/src/external/accounts/update/0.1/payload.ts +1771 -0
- package/src/external/credentials/issue/0.1/payload.ts +365 -0
- package/src/external/sign/0.1/payload.ts +234 -0
- package/src/index.ts +53 -0
- package/src/rooms/_shared/0.1/blobs.ts +17 -0
- package/src/rooms/_shared/0.1/room.ts +1 -1
- package/src/rooms/blobs/chunk/0.1/payload.ts +251 -0
- package/src/rooms/blobs/get/0.1/payload.ts +463 -0
- package/src/rooms/blobs/upload/abort/0.1/payload.ts +187 -0
- package/src/rooms/blobs/upload/begin/0.1/payload.ts +491 -0
- package/src/rooms/blobs/upload/chunk/0.1/payload.ts +304 -0
- package/src/rooms/blobs/upload/commit/0.1/payload.ts +224 -0
- package/src/rooms/info/0.1/payload.ts +572 -0
- package/src/rooms/keys/file-key/0.1/payload.ts +224 -0
- package/src/rooms/records/get/0.2/payload.ts +614 -0
- package/src/rooms/records/list/0.2/payload.ts +533 -0
- package/src/rooms/records/put/0.2/payload.ts +441 -0
- package/src/rooms/usage/0.1/payload.ts +499 -0
- package/src/vtc/_shared/0.1/room-storage.ts +17 -0
- package/src/vtc/rooms/get/0.1/payload.ts +1275 -0
- package/src/vtc/rooms/limits/set/0.1/payload.ts +555 -0
- package/src/vtc/rooms/storage/assign/0.1/payload.ts +237 -0
- package/src/vtc/rooms/storage/migrate/0.1/payload.ts +317 -0
- package/src/vtc/rooms/usage/0.1/payload.ts +568 -0
- package/src/vtc/storage/configs/create/0.1/payload.ts +784 -0
- package/src/vtc/storage/configs/get/0.1/payload.ts +1054 -0
- package/src/vtc/storage/configs/list/0.1/payload.ts +1121 -0
- package/src/vtc/storage/configs/probe/0.1/payload.ts +329 -0
- package/src/vtc/storage/configs/retire/0.1/payload.ts +211 -0
- package/src/vtc/storage/configs/update/0.1/payload.ts +783 -0
- package/src/vtc/storage/credentials/set/0.1/payload.ts +339 -0
|
@@ -0,0 +1,795 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/rooms/usage/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { AuthorityPresentation, Ext, ScopeLimits, Usage } from "../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* A room's owner reads how much each member who has added files is using, against their allowance. Authorized by the room's own credentials: a chain conferring `admin` at the room's scope.
|
|
8
|
+
*/
|
|
9
|
+
export interface RoomsUsagePayload {
|
|
10
|
+
/**
|
|
11
|
+
* The room's identifier. The host verifies the presentation against credentials issued by this identifier.
|
|
12
|
+
*/
|
|
13
|
+
roomId: string;
|
|
14
|
+
/**
|
|
15
|
+
* Must confer the `admin` action at this room's scope.
|
|
16
|
+
*/
|
|
17
|
+
presentation: AuthorityPresentation;
|
|
18
|
+
/**
|
|
19
|
+
* Opaque continuation from a previous response's `nextCursor`. Omit for the first page.
|
|
20
|
+
*/
|
|
21
|
+
cursor?: string;
|
|
22
|
+
/**
|
|
23
|
+
* Most entries to return. The host chooses when omitted, and may return fewer.
|
|
24
|
+
*/
|
|
25
|
+
limit?: number;
|
|
26
|
+
/**
|
|
27
|
+
* Ecosystem-defined extension members per SPEC.md §4.5.1.
|
|
28
|
+
*/
|
|
29
|
+
ext?: Ext;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Success response to rooms/usage. Type https://trusttasks.org/spec/rooms/usage/0.1#response.
|
|
33
|
+
*/
|
|
34
|
+
export interface RoomsUsageResponsePayload {
|
|
35
|
+
/**
|
|
36
|
+
* The room this describes.
|
|
37
|
+
*/
|
|
38
|
+
roomId: string;
|
|
39
|
+
/**
|
|
40
|
+
* One entry per member who holds or has reserved storage in the room, or holds an override. Not a roster: a member who has never added a file does not appear, because the host has never been told about them.
|
|
41
|
+
*
|
|
42
|
+
* @maxItems 500
|
|
43
|
+
*/
|
|
44
|
+
members: MemberUsage[];
|
|
45
|
+
/**
|
|
46
|
+
* Present exactly when more entries remain.
|
|
47
|
+
*/
|
|
48
|
+
nextCursor?: string;
|
|
49
|
+
ext?: Ext;
|
|
50
|
+
}
|
|
51
|
+
export interface MemberUsage {
|
|
52
|
+
/**
|
|
53
|
+
* The member's DID: the subject at the room end of the chains they presented when uploading. Uploads by a member's agents are counted here, under the member.
|
|
54
|
+
*/
|
|
55
|
+
member: string;
|
|
56
|
+
usage: Usage;
|
|
57
|
+
/**
|
|
58
|
+
* The limits that apply to this member in this room: their override if one is set, else the room's per-member default.
|
|
59
|
+
*/
|
|
60
|
+
limits: ScopeLimits;
|
|
61
|
+
/**
|
|
62
|
+
* True when `limits` is an override set for this member rather than the room's default.
|
|
63
|
+
*/
|
|
64
|
+
overridden?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
* When this member last committed a blob in the room.
|
|
67
|
+
*/
|
|
68
|
+
lastUploadAt?: string;
|
|
69
|
+
}
|
|
70
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
71
|
+
export type { AuthorityPresentation, Ext, ScopeLimits, Usage };
|
|
72
|
+
/** Trust Task type URI. */
|
|
73
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/rooms/usage/0.1";
|
|
74
|
+
/** Stable alias for this specification's request payload shape. */
|
|
75
|
+
export type Payload = RoomsUsagePayload;
|
|
76
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
77
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/rooms/usage/0.1#response";
|
|
78
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
79
|
+
export type Response = RoomsUsageResponsePayload;
|
|
80
|
+
/**
|
|
81
|
+
* This specification's payload schema, as a value.
|
|
82
|
+
*
|
|
83
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
84
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
85
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
86
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
87
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
88
|
+
*/
|
|
89
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
90
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
91
|
+
readonly $id: "https://trusttasks.org/spec/rooms/usage/0.1";
|
|
92
|
+
readonly title: "Rooms Usage — payload";
|
|
93
|
+
readonly description: "A room's owner reads how much each member who has added files is using, against their allowance. Authorized by the room's own credentials: a chain conferring `admin` at the room's scope.";
|
|
94
|
+
readonly type: "object";
|
|
95
|
+
readonly additionalProperties: false;
|
|
96
|
+
readonly required: readonly ["roomId", "presentation"];
|
|
97
|
+
readonly properties: {
|
|
98
|
+
readonly roomId: {
|
|
99
|
+
readonly type: "string";
|
|
100
|
+
readonly description: "The room's identifier. The host verifies the presentation against credentials issued by this identifier.";
|
|
101
|
+
};
|
|
102
|
+
readonly presentation: {
|
|
103
|
+
readonly $ref: "#/$defs/AuthorityPresentation";
|
|
104
|
+
readonly description: "Must confer the `admin` action at this room's scope.";
|
|
105
|
+
};
|
|
106
|
+
readonly cursor: {
|
|
107
|
+
readonly type: "string";
|
|
108
|
+
readonly maxLength: 512;
|
|
109
|
+
readonly description: "Opaque continuation from a previous response's `nextCursor`. Omit for the first page.";
|
|
110
|
+
};
|
|
111
|
+
readonly limit: {
|
|
112
|
+
readonly type: "integer";
|
|
113
|
+
readonly minimum: 1;
|
|
114
|
+
readonly maximum: 500;
|
|
115
|
+
readonly description: "Most entries to return. The host chooses when omitted, and may return fewer.";
|
|
116
|
+
};
|
|
117
|
+
readonly ext: {
|
|
118
|
+
readonly $ref: "#/$defs/Ext";
|
|
119
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
readonly $defs: {
|
|
123
|
+
readonly MemberUsage: {
|
|
124
|
+
readonly title: "MemberUsage";
|
|
125
|
+
readonly type: "object";
|
|
126
|
+
readonly additionalProperties: false;
|
|
127
|
+
readonly required: readonly ["member", "usage", "limits"];
|
|
128
|
+
readonly properties: {
|
|
129
|
+
readonly member: {
|
|
130
|
+
readonly type: "string";
|
|
131
|
+
readonly pattern: "^did:[a-z0-9]+:.+$";
|
|
132
|
+
readonly maxLength: 2048;
|
|
133
|
+
readonly description: "The member's DID: the subject at the room end of the chains they presented when uploading. Uploads by a member's agents are counted here, under the member.";
|
|
134
|
+
};
|
|
135
|
+
readonly usage: {
|
|
136
|
+
readonly $ref: "#/$defs/Usage";
|
|
137
|
+
};
|
|
138
|
+
readonly limits: {
|
|
139
|
+
readonly $ref: "#/$defs/ScopeLimits";
|
|
140
|
+
readonly description: "The limits that apply to this member in this room: their override if one is set, else the room's per-member default.";
|
|
141
|
+
};
|
|
142
|
+
readonly overridden: {
|
|
143
|
+
readonly type: "boolean";
|
|
144
|
+
readonly description: "True when `limits` is an override set for this member rather than the room's default.";
|
|
145
|
+
};
|
|
146
|
+
readonly lastUploadAt: {
|
|
147
|
+
readonly type: "string";
|
|
148
|
+
readonly format: "date-time";
|
|
149
|
+
readonly description: "When this member last committed a blob in the room.";
|
|
150
|
+
};
|
|
151
|
+
};
|
|
152
|
+
};
|
|
153
|
+
readonly Response: {
|
|
154
|
+
readonly $anchor: "response";
|
|
155
|
+
readonly title: "Rooms Usage — response payload";
|
|
156
|
+
readonly description: "Success response to rooms/usage. Type https://trusttasks.org/spec/rooms/usage/0.1#response.";
|
|
157
|
+
readonly type: "object";
|
|
158
|
+
readonly additionalProperties: false;
|
|
159
|
+
readonly required: readonly ["roomId", "members"];
|
|
160
|
+
readonly properties: {
|
|
161
|
+
readonly roomId: {
|
|
162
|
+
readonly type: "string";
|
|
163
|
+
readonly description: "The room this describes.";
|
|
164
|
+
};
|
|
165
|
+
readonly members: {
|
|
166
|
+
readonly type: "array";
|
|
167
|
+
readonly maxItems: 500;
|
|
168
|
+
readonly items: {
|
|
169
|
+
readonly $ref: "#/$defs/MemberUsage";
|
|
170
|
+
};
|
|
171
|
+
readonly description: "One entry per member who holds or has reserved storage in the room, or holds an override. Not a roster: a member who has never added a file does not appear, because the host has never been told about them.";
|
|
172
|
+
};
|
|
173
|
+
readonly nextCursor: {
|
|
174
|
+
readonly type: "string";
|
|
175
|
+
readonly maxLength: 512;
|
|
176
|
+
readonly description: "Present exactly when more entries remain.";
|
|
177
|
+
};
|
|
178
|
+
readonly ext: {
|
|
179
|
+
readonly $ref: "#/$defs/Ext";
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
};
|
|
183
|
+
readonly Ext: {
|
|
184
|
+
readonly title: "Ext";
|
|
185
|
+
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.";
|
|
186
|
+
readonly type: "object";
|
|
187
|
+
readonly minProperties: 1;
|
|
188
|
+
readonly additionalProperties: true;
|
|
189
|
+
readonly propertyNames: {
|
|
190
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
191
|
+
};
|
|
192
|
+
};
|
|
193
|
+
readonly ScopeLimits: {
|
|
194
|
+
readonly title: "ScopeLimits";
|
|
195
|
+
readonly type: "object";
|
|
196
|
+
readonly additionalProperties: false;
|
|
197
|
+
readonly description: "Limits at one scope. Every member is optional: an absent member means the scope sets no limit of that kind, and the next wider scope's limit, or the host's ceiling, governs. All sizes are ciphertext bytes.";
|
|
198
|
+
readonly properties: {
|
|
199
|
+
readonly maxFiles: {
|
|
200
|
+
readonly type: "integer";
|
|
201
|
+
readonly minimum: 0;
|
|
202
|
+
readonly description: "The number of committed blobs the scope may hold. 0 refuses every upload at this scope.";
|
|
203
|
+
};
|
|
204
|
+
readonly maxFileBytes: {
|
|
205
|
+
readonly type: "integer";
|
|
206
|
+
readonly minimum: 0;
|
|
207
|
+
readonly maximum: 1073741824;
|
|
208
|
+
readonly description: "The largest single blob the scope accepts. Never above 1 GiB, the transfer ceiling (BlobManifest).";
|
|
209
|
+
};
|
|
210
|
+
readonly maxBytes: {
|
|
211
|
+
readonly type: "integer";
|
|
212
|
+
readonly minimum: 0;
|
|
213
|
+
readonly description: "The total size of the committed and reserved blobs the scope may hold.";
|
|
214
|
+
};
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
readonly Usage: {
|
|
218
|
+
readonly title: "Usage";
|
|
219
|
+
readonly type: "object";
|
|
220
|
+
readonly additionalProperties: false;
|
|
221
|
+
readonly required: readonly ["files", "bytes", "reservedBytes"];
|
|
222
|
+
readonly description: "What one scope holds now. Ciphertext bytes throughout.";
|
|
223
|
+
readonly properties: {
|
|
224
|
+
readonly files: {
|
|
225
|
+
readonly type: "integer";
|
|
226
|
+
readonly minimum: 0;
|
|
227
|
+
readonly description: "Committed blobs that are not orphaned.";
|
|
228
|
+
};
|
|
229
|
+
readonly bytes: {
|
|
230
|
+
readonly type: "integer";
|
|
231
|
+
readonly minimum: 0;
|
|
232
|
+
readonly description: "Their total size. A blob stops counting the moment it is orphaned (its last record dropped it or was retracted), not when the host finally deletes it, so a member who deletes a file has the room back at once.";
|
|
233
|
+
};
|
|
234
|
+
readonly reservedBytes: {
|
|
235
|
+
readonly type: "integer";
|
|
236
|
+
readonly minimum: 0;
|
|
237
|
+
readonly description: "Bytes reserved by uploads begun and not yet committed, aborted or expired. Counted against `maxBytes`, so two concurrent uploads cannot both fit under a limit only one of them fits.";
|
|
238
|
+
};
|
|
239
|
+
readonly reservedFiles: {
|
|
240
|
+
readonly type: "integer";
|
|
241
|
+
readonly minimum: 0;
|
|
242
|
+
readonly description: "Uploads begun and not yet committed, aborted or expired. Counted against `maxFiles`.";
|
|
243
|
+
};
|
|
244
|
+
};
|
|
245
|
+
};
|
|
246
|
+
readonly AuthorityPresentation: {
|
|
247
|
+
readonly title: "AuthorityPresentation";
|
|
248
|
+
readonly type: "object";
|
|
249
|
+
readonly additionalProperties: false;
|
|
250
|
+
readonly required: readonly ["membership", "authority"];
|
|
251
|
+
readonly description: "What a party presents to act on a room. Carries the whole authority chain: a host MUST NOT dereference an authority credential's `parent` to fetch a link it was not given. Resolving over the network would make verification depend on availability, turn every identifier into a request the host can be induced to make against an address the holder chooses, and signal credential use to whoever hosts the identifier. A host MUST bind the presenter to the chain's leaf. A chain that verifies is evidence that authority was conferred on somebody; it is not evidence that the party presenting it is that somebody. The leaf's subject MUST equal the party the host authenticated for this request — an identity the transport established or a document `proof` proved, never one named in a payload. A host that omits this check authorizes every captured presentation, and the omission is silent, because the chain still verifies.";
|
|
252
|
+
readonly properties: {
|
|
253
|
+
readonly membership: {
|
|
254
|
+
readonly type: "string";
|
|
255
|
+
readonly description: "The presenter's membership credential for this room, or — on a `private` room — a zero-knowledge presentation of it. Serialized per the governing profile.";
|
|
256
|
+
};
|
|
257
|
+
readonly authority: {
|
|
258
|
+
readonly type: "array";
|
|
259
|
+
readonly minItems: 1;
|
|
260
|
+
readonly maxItems: 8;
|
|
261
|
+
readonly items: {
|
|
262
|
+
readonly type: "string";
|
|
263
|
+
};
|
|
264
|
+
readonly description: "The authority chain, LEAF FIRST: the first element is the credential being relied on and the last MUST be one issued by the room itself. Every link the presenter relies on is present, because the host will not fetch one. Capped at 8: verification is linear in chain length and runs on every operation, so an unbounded chain is a denial-of-service surface against the host. The known uses need 2 to 3 — a person attenuating to an agent, and that agent to a sub-agent.";
|
|
265
|
+
};
|
|
266
|
+
readonly subjectBinding: {
|
|
267
|
+
readonly type: "string";
|
|
268
|
+
readonly description: "REQUIRED on a `private` room, where the subject identifier is withheld: a proof that the membership credential and the authority chain's leaf describe the SAME subject. Without it two parties pool credentials — one contributes membership, the other authority — and the combination verifies as a single party holding both. A host MUST refuse a private-room presentation that omits this.";
|
|
269
|
+
};
|
|
270
|
+
};
|
|
271
|
+
};
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
275
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
276
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
277
|
+
readonly $ref: "#/$defs/Response";
|
|
278
|
+
readonly $defs: {
|
|
279
|
+
readonly MemberUsage: {
|
|
280
|
+
readonly title: "MemberUsage";
|
|
281
|
+
readonly type: "object";
|
|
282
|
+
readonly additionalProperties: false;
|
|
283
|
+
readonly required: readonly ["member", "usage", "limits"];
|
|
284
|
+
readonly properties: {
|
|
285
|
+
readonly member: {
|
|
286
|
+
readonly type: "string";
|
|
287
|
+
readonly pattern: "^did:[a-z0-9]+:.+$";
|
|
288
|
+
readonly maxLength: 2048;
|
|
289
|
+
readonly description: "The member's DID: the subject at the room end of the chains they presented when uploading. Uploads by a member's agents are counted here, under the member.";
|
|
290
|
+
};
|
|
291
|
+
readonly usage: {
|
|
292
|
+
readonly $ref: "#/$defs/Usage";
|
|
293
|
+
};
|
|
294
|
+
readonly limits: {
|
|
295
|
+
readonly $ref: "#/$defs/ScopeLimits";
|
|
296
|
+
readonly description: "The limits that apply to this member in this room: their override if one is set, else the room's per-member default.";
|
|
297
|
+
};
|
|
298
|
+
readonly overridden: {
|
|
299
|
+
readonly type: "boolean";
|
|
300
|
+
readonly description: "True when `limits` is an override set for this member rather than the room's default.";
|
|
301
|
+
};
|
|
302
|
+
readonly lastUploadAt: {
|
|
303
|
+
readonly type: "string";
|
|
304
|
+
readonly format: "date-time";
|
|
305
|
+
readonly description: "When this member last committed a blob in the room.";
|
|
306
|
+
};
|
|
307
|
+
};
|
|
308
|
+
};
|
|
309
|
+
readonly Response: {
|
|
310
|
+
readonly $anchor: "response";
|
|
311
|
+
readonly title: "Rooms Usage — response payload";
|
|
312
|
+
readonly description: "Success response to rooms/usage. Type https://trusttasks.org/spec/rooms/usage/0.1#response.";
|
|
313
|
+
readonly type: "object";
|
|
314
|
+
readonly additionalProperties: false;
|
|
315
|
+
readonly required: readonly ["roomId", "members"];
|
|
316
|
+
readonly properties: {
|
|
317
|
+
readonly roomId: {
|
|
318
|
+
readonly type: "string";
|
|
319
|
+
readonly description: "The room this describes.";
|
|
320
|
+
};
|
|
321
|
+
readonly members: {
|
|
322
|
+
readonly type: "array";
|
|
323
|
+
readonly maxItems: 500;
|
|
324
|
+
readonly items: {
|
|
325
|
+
readonly $ref: "#/$defs/MemberUsage";
|
|
326
|
+
};
|
|
327
|
+
readonly description: "One entry per member who holds or has reserved storage in the room, or holds an override. Not a roster: a member who has never added a file does not appear, because the host has never been told about them.";
|
|
328
|
+
};
|
|
329
|
+
readonly nextCursor: {
|
|
330
|
+
readonly type: "string";
|
|
331
|
+
readonly maxLength: 512;
|
|
332
|
+
readonly description: "Present exactly when more entries remain.";
|
|
333
|
+
};
|
|
334
|
+
readonly ext: {
|
|
335
|
+
readonly $ref: "#/$defs/Ext";
|
|
336
|
+
};
|
|
337
|
+
};
|
|
338
|
+
};
|
|
339
|
+
readonly Ext: {
|
|
340
|
+
readonly title: "Ext";
|
|
341
|
+
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.";
|
|
342
|
+
readonly type: "object";
|
|
343
|
+
readonly minProperties: 1;
|
|
344
|
+
readonly additionalProperties: true;
|
|
345
|
+
readonly propertyNames: {
|
|
346
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
347
|
+
};
|
|
348
|
+
};
|
|
349
|
+
readonly ScopeLimits: {
|
|
350
|
+
readonly title: "ScopeLimits";
|
|
351
|
+
readonly type: "object";
|
|
352
|
+
readonly additionalProperties: false;
|
|
353
|
+
readonly description: "Limits at one scope. Every member is optional: an absent member means the scope sets no limit of that kind, and the next wider scope's limit, or the host's ceiling, governs. All sizes are ciphertext bytes.";
|
|
354
|
+
readonly properties: {
|
|
355
|
+
readonly maxFiles: {
|
|
356
|
+
readonly type: "integer";
|
|
357
|
+
readonly minimum: 0;
|
|
358
|
+
readonly description: "The number of committed blobs the scope may hold. 0 refuses every upload at this scope.";
|
|
359
|
+
};
|
|
360
|
+
readonly maxFileBytes: {
|
|
361
|
+
readonly type: "integer";
|
|
362
|
+
readonly minimum: 0;
|
|
363
|
+
readonly maximum: 1073741824;
|
|
364
|
+
readonly description: "The largest single blob the scope accepts. Never above 1 GiB, the transfer ceiling (BlobManifest).";
|
|
365
|
+
};
|
|
366
|
+
readonly maxBytes: {
|
|
367
|
+
readonly type: "integer";
|
|
368
|
+
readonly minimum: 0;
|
|
369
|
+
readonly description: "The total size of the committed and reserved blobs the scope may hold.";
|
|
370
|
+
};
|
|
371
|
+
};
|
|
372
|
+
};
|
|
373
|
+
readonly Usage: {
|
|
374
|
+
readonly title: "Usage";
|
|
375
|
+
readonly type: "object";
|
|
376
|
+
readonly additionalProperties: false;
|
|
377
|
+
readonly required: readonly ["files", "bytes", "reservedBytes"];
|
|
378
|
+
readonly description: "What one scope holds now. Ciphertext bytes throughout.";
|
|
379
|
+
readonly properties: {
|
|
380
|
+
readonly files: {
|
|
381
|
+
readonly type: "integer";
|
|
382
|
+
readonly minimum: 0;
|
|
383
|
+
readonly description: "Committed blobs that are not orphaned.";
|
|
384
|
+
};
|
|
385
|
+
readonly bytes: {
|
|
386
|
+
readonly type: "integer";
|
|
387
|
+
readonly minimum: 0;
|
|
388
|
+
readonly description: "Their total size. A blob stops counting the moment it is orphaned (its last record dropped it or was retracted), not when the host finally deletes it, so a member who deletes a file has the room back at once.";
|
|
389
|
+
};
|
|
390
|
+
readonly reservedBytes: {
|
|
391
|
+
readonly type: "integer";
|
|
392
|
+
readonly minimum: 0;
|
|
393
|
+
readonly description: "Bytes reserved by uploads begun and not yet committed, aborted or expired. Counted against `maxBytes`, so two concurrent uploads cannot both fit under a limit only one of them fits.";
|
|
394
|
+
};
|
|
395
|
+
readonly reservedFiles: {
|
|
396
|
+
readonly type: "integer";
|
|
397
|
+
readonly minimum: 0;
|
|
398
|
+
readonly description: "Uploads begun and not yet committed, aborted or expired. Counted against `maxFiles`.";
|
|
399
|
+
};
|
|
400
|
+
};
|
|
401
|
+
};
|
|
402
|
+
readonly AuthorityPresentation: {
|
|
403
|
+
readonly title: "AuthorityPresentation";
|
|
404
|
+
readonly type: "object";
|
|
405
|
+
readonly additionalProperties: false;
|
|
406
|
+
readonly required: readonly ["membership", "authority"];
|
|
407
|
+
readonly description: "What a party presents to act on a room. Carries the whole authority chain: a host MUST NOT dereference an authority credential's `parent` to fetch a link it was not given. Resolving over the network would make verification depend on availability, turn every identifier into a request the host can be induced to make against an address the holder chooses, and signal credential use to whoever hosts the identifier. A host MUST bind the presenter to the chain's leaf. A chain that verifies is evidence that authority was conferred on somebody; it is not evidence that the party presenting it is that somebody. The leaf's subject MUST equal the party the host authenticated for this request — an identity the transport established or a document `proof` proved, never one named in a payload. A host that omits this check authorizes every captured presentation, and the omission is silent, because the chain still verifies.";
|
|
408
|
+
readonly properties: {
|
|
409
|
+
readonly membership: {
|
|
410
|
+
readonly type: "string";
|
|
411
|
+
readonly description: "The presenter's membership credential for this room, or — on a `private` room — a zero-knowledge presentation of it. Serialized per the governing profile.";
|
|
412
|
+
};
|
|
413
|
+
readonly authority: {
|
|
414
|
+
readonly type: "array";
|
|
415
|
+
readonly minItems: 1;
|
|
416
|
+
readonly maxItems: 8;
|
|
417
|
+
readonly items: {
|
|
418
|
+
readonly type: "string";
|
|
419
|
+
};
|
|
420
|
+
readonly description: "The authority chain, LEAF FIRST: the first element is the credential being relied on and the last MUST be one issued by the room itself. Every link the presenter relies on is present, because the host will not fetch one. Capped at 8: verification is linear in chain length and runs on every operation, so an unbounded chain is a denial-of-service surface against the host. The known uses need 2 to 3 — a person attenuating to an agent, and that agent to a sub-agent.";
|
|
421
|
+
};
|
|
422
|
+
readonly subjectBinding: {
|
|
423
|
+
readonly type: "string";
|
|
424
|
+
readonly description: "REQUIRED on a `private` room, where the subject identifier is withheld: a proof that the membership credential and the authority chain's leaf describe the SAME subject. Without it two parties pool credentials — one contributes membership, the other authority — and the combination verifies as a single party holding both. A host MUST refuse a private-room presentation that omits this.";
|
|
425
|
+
};
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
};
|
|
430
|
+
/**
|
|
431
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
432
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
433
|
+
* per-specification and cannot be derived from the document alone, and
|
|
434
|
+
* item 2 needs the schema this carries.
|
|
435
|
+
*/
|
|
436
|
+
export declare const SPEC: {
|
|
437
|
+
readonly typeUri: "https://trusttasks.org/spec/rooms/usage/0.1";
|
|
438
|
+
readonly isBearer: false;
|
|
439
|
+
readonly isProofRequired: false;
|
|
440
|
+
readonly isRecipientRequired: true;
|
|
441
|
+
readonly isIssuedAtRequired: false;
|
|
442
|
+
readonly payloadSchema: {
|
|
443
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
444
|
+
readonly $id: "https://trusttasks.org/spec/rooms/usage/0.1";
|
|
445
|
+
readonly title: "Rooms Usage — payload";
|
|
446
|
+
readonly description: "A room's owner reads how much each member who has added files is using, against their allowance. Authorized by the room's own credentials: a chain conferring `admin` at the room's scope.";
|
|
447
|
+
readonly type: "object";
|
|
448
|
+
readonly additionalProperties: false;
|
|
449
|
+
readonly required: readonly ["roomId", "presentation"];
|
|
450
|
+
readonly properties: {
|
|
451
|
+
readonly roomId: {
|
|
452
|
+
readonly type: "string";
|
|
453
|
+
readonly description: "The room's identifier. The host verifies the presentation against credentials issued by this identifier.";
|
|
454
|
+
};
|
|
455
|
+
readonly presentation: {
|
|
456
|
+
readonly $ref: "#/$defs/AuthorityPresentation";
|
|
457
|
+
readonly description: "Must confer the `admin` action at this room's scope.";
|
|
458
|
+
};
|
|
459
|
+
readonly cursor: {
|
|
460
|
+
readonly type: "string";
|
|
461
|
+
readonly maxLength: 512;
|
|
462
|
+
readonly description: "Opaque continuation from a previous response's `nextCursor`. Omit for the first page.";
|
|
463
|
+
};
|
|
464
|
+
readonly limit: {
|
|
465
|
+
readonly type: "integer";
|
|
466
|
+
readonly minimum: 1;
|
|
467
|
+
readonly maximum: 500;
|
|
468
|
+
readonly description: "Most entries to return. The host chooses when omitted, and may return fewer.";
|
|
469
|
+
};
|
|
470
|
+
readonly ext: {
|
|
471
|
+
readonly $ref: "#/$defs/Ext";
|
|
472
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
473
|
+
};
|
|
474
|
+
};
|
|
475
|
+
readonly $defs: {
|
|
476
|
+
readonly MemberUsage: {
|
|
477
|
+
readonly title: "MemberUsage";
|
|
478
|
+
readonly type: "object";
|
|
479
|
+
readonly additionalProperties: false;
|
|
480
|
+
readonly required: readonly ["member", "usage", "limits"];
|
|
481
|
+
readonly properties: {
|
|
482
|
+
readonly member: {
|
|
483
|
+
readonly type: "string";
|
|
484
|
+
readonly pattern: "^did:[a-z0-9]+:.+$";
|
|
485
|
+
readonly maxLength: 2048;
|
|
486
|
+
readonly description: "The member's DID: the subject at the room end of the chains they presented when uploading. Uploads by a member's agents are counted here, under the member.";
|
|
487
|
+
};
|
|
488
|
+
readonly usage: {
|
|
489
|
+
readonly $ref: "#/$defs/Usage";
|
|
490
|
+
};
|
|
491
|
+
readonly limits: {
|
|
492
|
+
readonly $ref: "#/$defs/ScopeLimits";
|
|
493
|
+
readonly description: "The limits that apply to this member in this room: their override if one is set, else the room's per-member default.";
|
|
494
|
+
};
|
|
495
|
+
readonly overridden: {
|
|
496
|
+
readonly type: "boolean";
|
|
497
|
+
readonly description: "True when `limits` is an override set for this member rather than the room's default.";
|
|
498
|
+
};
|
|
499
|
+
readonly lastUploadAt: {
|
|
500
|
+
readonly type: "string";
|
|
501
|
+
readonly format: "date-time";
|
|
502
|
+
readonly description: "When this member last committed a blob in the room.";
|
|
503
|
+
};
|
|
504
|
+
};
|
|
505
|
+
};
|
|
506
|
+
readonly Response: {
|
|
507
|
+
readonly $anchor: "response";
|
|
508
|
+
readonly title: "Rooms Usage — response payload";
|
|
509
|
+
readonly description: "Success response to rooms/usage. Type https://trusttasks.org/spec/rooms/usage/0.1#response.";
|
|
510
|
+
readonly type: "object";
|
|
511
|
+
readonly additionalProperties: false;
|
|
512
|
+
readonly required: readonly ["roomId", "members"];
|
|
513
|
+
readonly properties: {
|
|
514
|
+
readonly roomId: {
|
|
515
|
+
readonly type: "string";
|
|
516
|
+
readonly description: "The room this describes.";
|
|
517
|
+
};
|
|
518
|
+
readonly members: {
|
|
519
|
+
readonly type: "array";
|
|
520
|
+
readonly maxItems: 500;
|
|
521
|
+
readonly items: {
|
|
522
|
+
readonly $ref: "#/$defs/MemberUsage";
|
|
523
|
+
};
|
|
524
|
+
readonly description: "One entry per member who holds or has reserved storage in the room, or holds an override. Not a roster: a member who has never added a file does not appear, because the host has never been told about them.";
|
|
525
|
+
};
|
|
526
|
+
readonly nextCursor: {
|
|
527
|
+
readonly type: "string";
|
|
528
|
+
readonly maxLength: 512;
|
|
529
|
+
readonly description: "Present exactly when more entries remain.";
|
|
530
|
+
};
|
|
531
|
+
readonly ext: {
|
|
532
|
+
readonly $ref: "#/$defs/Ext";
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
};
|
|
536
|
+
readonly Ext: {
|
|
537
|
+
readonly title: "Ext";
|
|
538
|
+
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.";
|
|
539
|
+
readonly type: "object";
|
|
540
|
+
readonly minProperties: 1;
|
|
541
|
+
readonly additionalProperties: true;
|
|
542
|
+
readonly propertyNames: {
|
|
543
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
544
|
+
};
|
|
545
|
+
};
|
|
546
|
+
readonly ScopeLimits: {
|
|
547
|
+
readonly title: "ScopeLimits";
|
|
548
|
+
readonly type: "object";
|
|
549
|
+
readonly additionalProperties: false;
|
|
550
|
+
readonly description: "Limits at one scope. Every member is optional: an absent member means the scope sets no limit of that kind, and the next wider scope's limit, or the host's ceiling, governs. All sizes are ciphertext bytes.";
|
|
551
|
+
readonly properties: {
|
|
552
|
+
readonly maxFiles: {
|
|
553
|
+
readonly type: "integer";
|
|
554
|
+
readonly minimum: 0;
|
|
555
|
+
readonly description: "The number of committed blobs the scope may hold. 0 refuses every upload at this scope.";
|
|
556
|
+
};
|
|
557
|
+
readonly maxFileBytes: {
|
|
558
|
+
readonly type: "integer";
|
|
559
|
+
readonly minimum: 0;
|
|
560
|
+
readonly maximum: 1073741824;
|
|
561
|
+
readonly description: "The largest single blob the scope accepts. Never above 1 GiB, the transfer ceiling (BlobManifest).";
|
|
562
|
+
};
|
|
563
|
+
readonly maxBytes: {
|
|
564
|
+
readonly type: "integer";
|
|
565
|
+
readonly minimum: 0;
|
|
566
|
+
readonly description: "The total size of the committed and reserved blobs the scope may hold.";
|
|
567
|
+
};
|
|
568
|
+
};
|
|
569
|
+
};
|
|
570
|
+
readonly Usage: {
|
|
571
|
+
readonly title: "Usage";
|
|
572
|
+
readonly type: "object";
|
|
573
|
+
readonly additionalProperties: false;
|
|
574
|
+
readonly required: readonly ["files", "bytes", "reservedBytes"];
|
|
575
|
+
readonly description: "What one scope holds now. Ciphertext bytes throughout.";
|
|
576
|
+
readonly properties: {
|
|
577
|
+
readonly files: {
|
|
578
|
+
readonly type: "integer";
|
|
579
|
+
readonly minimum: 0;
|
|
580
|
+
readonly description: "Committed blobs that are not orphaned.";
|
|
581
|
+
};
|
|
582
|
+
readonly bytes: {
|
|
583
|
+
readonly type: "integer";
|
|
584
|
+
readonly minimum: 0;
|
|
585
|
+
readonly description: "Their total size. A blob stops counting the moment it is orphaned (its last record dropped it or was retracted), not when the host finally deletes it, so a member who deletes a file has the room back at once.";
|
|
586
|
+
};
|
|
587
|
+
readonly reservedBytes: {
|
|
588
|
+
readonly type: "integer";
|
|
589
|
+
readonly minimum: 0;
|
|
590
|
+
readonly description: "Bytes reserved by uploads begun and not yet committed, aborted or expired. Counted against `maxBytes`, so two concurrent uploads cannot both fit under a limit only one of them fits.";
|
|
591
|
+
};
|
|
592
|
+
readonly reservedFiles: {
|
|
593
|
+
readonly type: "integer";
|
|
594
|
+
readonly minimum: 0;
|
|
595
|
+
readonly description: "Uploads begun and not yet committed, aborted or expired. Counted against `maxFiles`.";
|
|
596
|
+
};
|
|
597
|
+
};
|
|
598
|
+
};
|
|
599
|
+
readonly AuthorityPresentation: {
|
|
600
|
+
readonly title: "AuthorityPresentation";
|
|
601
|
+
readonly type: "object";
|
|
602
|
+
readonly additionalProperties: false;
|
|
603
|
+
readonly required: readonly ["membership", "authority"];
|
|
604
|
+
readonly description: "What a party presents to act on a room. Carries the whole authority chain: a host MUST NOT dereference an authority credential's `parent` to fetch a link it was not given. Resolving over the network would make verification depend on availability, turn every identifier into a request the host can be induced to make against an address the holder chooses, and signal credential use to whoever hosts the identifier. A host MUST bind the presenter to the chain's leaf. A chain that verifies is evidence that authority was conferred on somebody; it is not evidence that the party presenting it is that somebody. The leaf's subject MUST equal the party the host authenticated for this request — an identity the transport established or a document `proof` proved, never one named in a payload. A host that omits this check authorizes every captured presentation, and the omission is silent, because the chain still verifies.";
|
|
605
|
+
readonly properties: {
|
|
606
|
+
readonly membership: {
|
|
607
|
+
readonly type: "string";
|
|
608
|
+
readonly description: "The presenter's membership credential for this room, or — on a `private` room — a zero-knowledge presentation of it. Serialized per the governing profile.";
|
|
609
|
+
};
|
|
610
|
+
readonly authority: {
|
|
611
|
+
readonly type: "array";
|
|
612
|
+
readonly minItems: 1;
|
|
613
|
+
readonly maxItems: 8;
|
|
614
|
+
readonly items: {
|
|
615
|
+
readonly type: "string";
|
|
616
|
+
};
|
|
617
|
+
readonly description: "The authority chain, LEAF FIRST: the first element is the credential being relied on and the last MUST be one issued by the room itself. Every link the presenter relies on is present, because the host will not fetch one. Capped at 8: verification is linear in chain length and runs on every operation, so an unbounded chain is a denial-of-service surface against the host. The known uses need 2 to 3 — a person attenuating to an agent, and that agent to a sub-agent.";
|
|
618
|
+
};
|
|
619
|
+
readonly subjectBinding: {
|
|
620
|
+
readonly type: "string";
|
|
621
|
+
readonly description: "REQUIRED on a `private` room, where the subject identifier is withheld: a proof that the membership credential and the authority chain's leaf describe the SAME subject. Without it two parties pool credentials — one contributes membership, the other authority — and the combination verifies as a single party holding both. A host MUST refuse a private-room presentation that omits this.";
|
|
622
|
+
};
|
|
623
|
+
};
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
};
|
|
627
|
+
};
|
|
628
|
+
/**
|
|
629
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
630
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
631
|
+
* parties (§7.3 item 5).
|
|
632
|
+
*/
|
|
633
|
+
export declare const RESPONSE_SPEC: {
|
|
634
|
+
readonly typeUri: "https://trusttasks.org/spec/rooms/usage/0.1#response";
|
|
635
|
+
readonly isBearer: false;
|
|
636
|
+
readonly isProofRequired: false;
|
|
637
|
+
readonly isRecipientRequired: true;
|
|
638
|
+
readonly isIssuedAtRequired: false;
|
|
639
|
+
readonly payloadSchema: {
|
|
640
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
641
|
+
readonly $ref: "#/$defs/Response";
|
|
642
|
+
readonly $defs: {
|
|
643
|
+
readonly MemberUsage: {
|
|
644
|
+
readonly title: "MemberUsage";
|
|
645
|
+
readonly type: "object";
|
|
646
|
+
readonly additionalProperties: false;
|
|
647
|
+
readonly required: readonly ["member", "usage", "limits"];
|
|
648
|
+
readonly properties: {
|
|
649
|
+
readonly member: {
|
|
650
|
+
readonly type: "string";
|
|
651
|
+
readonly pattern: "^did:[a-z0-9]+:.+$";
|
|
652
|
+
readonly maxLength: 2048;
|
|
653
|
+
readonly description: "The member's DID: the subject at the room end of the chains they presented when uploading. Uploads by a member's agents are counted here, under the member.";
|
|
654
|
+
};
|
|
655
|
+
readonly usage: {
|
|
656
|
+
readonly $ref: "#/$defs/Usage";
|
|
657
|
+
};
|
|
658
|
+
readonly limits: {
|
|
659
|
+
readonly $ref: "#/$defs/ScopeLimits";
|
|
660
|
+
readonly description: "The limits that apply to this member in this room: their override if one is set, else the room's per-member default.";
|
|
661
|
+
};
|
|
662
|
+
readonly overridden: {
|
|
663
|
+
readonly type: "boolean";
|
|
664
|
+
readonly description: "True when `limits` is an override set for this member rather than the room's default.";
|
|
665
|
+
};
|
|
666
|
+
readonly lastUploadAt: {
|
|
667
|
+
readonly type: "string";
|
|
668
|
+
readonly format: "date-time";
|
|
669
|
+
readonly description: "When this member last committed a blob in the room.";
|
|
670
|
+
};
|
|
671
|
+
};
|
|
672
|
+
};
|
|
673
|
+
readonly Response: {
|
|
674
|
+
readonly $anchor: "response";
|
|
675
|
+
readonly title: "Rooms Usage — response payload";
|
|
676
|
+
readonly description: "Success response to rooms/usage. Type https://trusttasks.org/spec/rooms/usage/0.1#response.";
|
|
677
|
+
readonly type: "object";
|
|
678
|
+
readonly additionalProperties: false;
|
|
679
|
+
readonly required: readonly ["roomId", "members"];
|
|
680
|
+
readonly properties: {
|
|
681
|
+
readonly roomId: {
|
|
682
|
+
readonly type: "string";
|
|
683
|
+
readonly description: "The room this describes.";
|
|
684
|
+
};
|
|
685
|
+
readonly members: {
|
|
686
|
+
readonly type: "array";
|
|
687
|
+
readonly maxItems: 500;
|
|
688
|
+
readonly items: {
|
|
689
|
+
readonly $ref: "#/$defs/MemberUsage";
|
|
690
|
+
};
|
|
691
|
+
readonly description: "One entry per member who holds or has reserved storage in the room, or holds an override. Not a roster: a member who has never added a file does not appear, because the host has never been told about them.";
|
|
692
|
+
};
|
|
693
|
+
readonly nextCursor: {
|
|
694
|
+
readonly type: "string";
|
|
695
|
+
readonly maxLength: 512;
|
|
696
|
+
readonly description: "Present exactly when more entries remain.";
|
|
697
|
+
};
|
|
698
|
+
readonly ext: {
|
|
699
|
+
readonly $ref: "#/$defs/Ext";
|
|
700
|
+
};
|
|
701
|
+
};
|
|
702
|
+
};
|
|
703
|
+
readonly Ext: {
|
|
704
|
+
readonly title: "Ext";
|
|
705
|
+
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.";
|
|
706
|
+
readonly type: "object";
|
|
707
|
+
readonly minProperties: 1;
|
|
708
|
+
readonly additionalProperties: true;
|
|
709
|
+
readonly propertyNames: {
|
|
710
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
711
|
+
};
|
|
712
|
+
};
|
|
713
|
+
readonly ScopeLimits: {
|
|
714
|
+
readonly title: "ScopeLimits";
|
|
715
|
+
readonly type: "object";
|
|
716
|
+
readonly additionalProperties: false;
|
|
717
|
+
readonly description: "Limits at one scope. Every member is optional: an absent member means the scope sets no limit of that kind, and the next wider scope's limit, or the host's ceiling, governs. All sizes are ciphertext bytes.";
|
|
718
|
+
readonly properties: {
|
|
719
|
+
readonly maxFiles: {
|
|
720
|
+
readonly type: "integer";
|
|
721
|
+
readonly minimum: 0;
|
|
722
|
+
readonly description: "The number of committed blobs the scope may hold. 0 refuses every upload at this scope.";
|
|
723
|
+
};
|
|
724
|
+
readonly maxFileBytes: {
|
|
725
|
+
readonly type: "integer";
|
|
726
|
+
readonly minimum: 0;
|
|
727
|
+
readonly maximum: 1073741824;
|
|
728
|
+
readonly description: "The largest single blob the scope accepts. Never above 1 GiB, the transfer ceiling (BlobManifest).";
|
|
729
|
+
};
|
|
730
|
+
readonly maxBytes: {
|
|
731
|
+
readonly type: "integer";
|
|
732
|
+
readonly minimum: 0;
|
|
733
|
+
readonly description: "The total size of the committed and reserved blobs the scope may hold.";
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
};
|
|
737
|
+
readonly Usage: {
|
|
738
|
+
readonly title: "Usage";
|
|
739
|
+
readonly type: "object";
|
|
740
|
+
readonly additionalProperties: false;
|
|
741
|
+
readonly required: readonly ["files", "bytes", "reservedBytes"];
|
|
742
|
+
readonly description: "What one scope holds now. Ciphertext bytes throughout.";
|
|
743
|
+
readonly properties: {
|
|
744
|
+
readonly files: {
|
|
745
|
+
readonly type: "integer";
|
|
746
|
+
readonly minimum: 0;
|
|
747
|
+
readonly description: "Committed blobs that are not orphaned.";
|
|
748
|
+
};
|
|
749
|
+
readonly bytes: {
|
|
750
|
+
readonly type: "integer";
|
|
751
|
+
readonly minimum: 0;
|
|
752
|
+
readonly description: "Their total size. A blob stops counting the moment it is orphaned (its last record dropped it or was retracted), not when the host finally deletes it, so a member who deletes a file has the room back at once.";
|
|
753
|
+
};
|
|
754
|
+
readonly reservedBytes: {
|
|
755
|
+
readonly type: "integer";
|
|
756
|
+
readonly minimum: 0;
|
|
757
|
+
readonly description: "Bytes reserved by uploads begun and not yet committed, aborted or expired. Counted against `maxBytes`, so two concurrent uploads cannot both fit under a limit only one of them fits.";
|
|
758
|
+
};
|
|
759
|
+
readonly reservedFiles: {
|
|
760
|
+
readonly type: "integer";
|
|
761
|
+
readonly minimum: 0;
|
|
762
|
+
readonly description: "Uploads begun and not yet committed, aborted or expired. Counted against `maxFiles`.";
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
};
|
|
766
|
+
readonly AuthorityPresentation: {
|
|
767
|
+
readonly title: "AuthorityPresentation";
|
|
768
|
+
readonly type: "object";
|
|
769
|
+
readonly additionalProperties: false;
|
|
770
|
+
readonly required: readonly ["membership", "authority"];
|
|
771
|
+
readonly description: "What a party presents to act on a room. Carries the whole authority chain: a host MUST NOT dereference an authority credential's `parent` to fetch a link it was not given. Resolving over the network would make verification depend on availability, turn every identifier into a request the host can be induced to make against an address the holder chooses, and signal credential use to whoever hosts the identifier. A host MUST bind the presenter to the chain's leaf. A chain that verifies is evidence that authority was conferred on somebody; it is not evidence that the party presenting it is that somebody. The leaf's subject MUST equal the party the host authenticated for this request — an identity the transport established or a document `proof` proved, never one named in a payload. A host that omits this check authorizes every captured presentation, and the omission is silent, because the chain still verifies.";
|
|
772
|
+
readonly properties: {
|
|
773
|
+
readonly membership: {
|
|
774
|
+
readonly type: "string";
|
|
775
|
+
readonly description: "The presenter's membership credential for this room, or — on a `private` room — a zero-knowledge presentation of it. Serialized per the governing profile.";
|
|
776
|
+
};
|
|
777
|
+
readonly authority: {
|
|
778
|
+
readonly type: "array";
|
|
779
|
+
readonly minItems: 1;
|
|
780
|
+
readonly maxItems: 8;
|
|
781
|
+
readonly items: {
|
|
782
|
+
readonly type: "string";
|
|
783
|
+
};
|
|
784
|
+
readonly description: "The authority chain, LEAF FIRST: the first element is the credential being relied on and the last MUST be one issued by the room itself. Every link the presenter relies on is present, because the host will not fetch one. Capped at 8: verification is linear in chain length and runs on every operation, so an unbounded chain is a denial-of-service surface against the host. The known uses need 2 to 3 — a person attenuating to an agent, and that agent to a sub-agent.";
|
|
785
|
+
};
|
|
786
|
+
readonly subjectBinding: {
|
|
787
|
+
readonly type: "string";
|
|
788
|
+
readonly description: "REQUIRED on a `private` room, where the subject identifier is withheld: a proof that the membership credential and the authority chain's leaf describe the SAME subject. Without it two parties pool credentials — one contributes membership, the other authority — and the combination verifies as a single party holding both. A host MUST refuse a private-room presentation that omits this.";
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
};
|
|
794
|
+
};
|
|
795
|
+
//# sourceMappingURL=payload.d.ts.map
|