@openvtc/trust-tasks 0.28.6 → 0.28.8
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 +73 -0
- package/dist/_extends.d.ts.map +1 -1
- package/dist/_extends.js +1 -0
- package/dist/_extends.js.map +1 -1
- package/dist/_shared/components.d.ts +249 -0
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +75 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +75 -0
- package/dist/index.js.map +1 -1
- package/dist/rooms/keys/act/0.1/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.1/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.1/payload.js +1 -1
- package/dist/rooms/keys/act/0.1/payload.js.map +1 -1
- package/dist/rooms/keys/act/0.10/payload.d.ts +560 -0
- package/dist/rooms/keys/act/0.10/payload.d.ts.map +1 -0
- package/dist/rooms/keys/act/0.10/payload.js +319 -0
- package/dist/rooms/keys/act/0.10/payload.js.map +1 -0
- package/dist/rooms/keys/act/0.2/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.2/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.2/payload.js +1 -1
- package/dist/rooms/keys/act/0.2/payload.js.map +1 -1
- package/dist/rooms/keys/act/0.3/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.3/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.3/payload.js +1 -1
- package/dist/rooms/keys/act/0.3/payload.js.map +1 -1
- package/dist/rooms/keys/act/0.4/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.4/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.4/payload.js +1 -1
- package/dist/rooms/keys/act/0.4/payload.js.map +1 -1
- package/dist/rooms/keys/act/0.5/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.5/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.5/payload.js +1 -1
- package/dist/rooms/keys/act/0.5/payload.js.map +1 -1
- package/dist/rooms/keys/act/0.6/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.6/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.6/payload.js +1 -1
- package/dist/rooms/keys/act/0.6/payload.js.map +1 -1
- package/dist/rooms/keys/act/0.7/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.7/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.7/payload.js +1 -1
- package/dist/rooms/keys/act/0.7/payload.js.map +1 -1
- package/dist/rooms/keys/act/0.8/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.8/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.8/payload.js +1 -1
- package/dist/rooms/keys/act/0.8/payload.js.map +1 -1
- package/dist/rooms/keys/act/0.9/payload.d.ts +14 -2
- package/dist/rooms/keys/act/0.9/payload.d.ts.map +1 -1
- package/dist/rooms/keys/act/0.9/payload.js +1 -1
- package/dist/rooms/keys/act/0.9/payload.js.map +1 -1
- package/dist/voting/_shared/0.3/voting.d.ts +16 -0
- package/dist/voting/_shared/0.3/voting.d.ts.map +1 -0
- package/dist/voting/_shared/0.3/voting.js +6 -0
- package/dist/voting/_shared/0.3/voting.js.map +1 -0
- package/dist/voting/election/register/0.1/payload.d.ts +4 -4
- package/dist/voting/election/register/0.1/payload.js +1 -1
- package/dist/voting/election/register/0.2/payload.d.ts +13 -2
- package/dist/voting/election/register/0.2/payload.d.ts.map +1 -1
- package/dist/voting/election/register/0.2/payload.js +1 -1
- package/dist/voting/election/register/0.2/payload.js.map +1 -1
- package/dist/voting/election/register/0.3/payload.d.ts +1934 -0
- package/dist/voting/election/register/0.3/payload.d.ts.map +1 -0
- package/dist/voting/election/register/0.3/payload.js +1180 -0
- package/dist/voting/election/register/0.3/payload.js.map +1 -0
- package/dist/voting/election/show/0.1/payload.d.ts +4 -4
- package/dist/voting/election/show/0.1/payload.js +1 -1
- package/dist/voting/election/show/0.2/payload.d.ts +13 -2
- package/dist/voting/election/show/0.2/payload.d.ts.map +1 -1
- package/dist/voting/election/show/0.2/payload.js +1 -1
- package/dist/voting/election/show/0.2/payload.js.map +1 -1
- package/dist/voting/election/show/0.3/payload.d.ts +1838 -0
- package/dist/voting/election/show/0.3/payload.d.ts.map +1 -0
- package/dist/voting/election/show/0.3/payload.js +1126 -0
- package/dist/voting/election/show/0.3/payload.js.map +1 -0
- package/dist/vta/pcs/trustee/deal/0.2/payload.d.ts +4 -4
- package/dist/vta/pcs/trustee/deal/0.2/payload.js +1 -1
- package/dist/vta/pcs/trustee/deal/0.3/payload.d.ts +13 -2
- package/dist/vta/pcs/trustee/deal/0.3/payload.d.ts.map +1 -1
- package/dist/vta/pcs/trustee/deal/0.3/payload.js +1 -1
- package/dist/vta/pcs/trustee/deal/0.3/payload.js.map +1 -1
- package/dist/vta/pcs/trustee/deal/0.4/payload.d.ts +1846 -0
- package/dist/vta/pcs/trustee/deal/0.4/payload.d.ts.map +1 -0
- package/dist/vta/pcs/trustee/deal/0.4/payload.js +1091 -0
- package/dist/vta/pcs/trustee/deal/0.4/payload.js.map +1 -0
- package/dist/vta/pcs/trustee/enrol/0.1/payload.d.ts +4 -4
- package/dist/vta/pcs/trustee/enrol/0.1/payload.js +1 -1
- package/dist/vta/pcs/trustee/enrol/0.2/payload.d.ts +13 -2
- package/dist/vta/pcs/trustee/enrol/0.2/payload.d.ts.map +1 -1
- package/dist/vta/pcs/trustee/enrol/0.2/payload.js +1 -1
- package/dist/vta/pcs/trustee/enrol/0.2/payload.js.map +1 -1
- package/dist/vta/pcs/trustee/enrol/0.3/payload.d.ts +1770 -0
- package/dist/vta/pcs/trustee/enrol/0.3/payload.d.ts.map +1 -0
- package/dist/vta/pcs/trustee/enrol/0.3/payload.js +1054 -0
- package/dist/vta/pcs/trustee/enrol/0.3/payload.js.map +1 -0
- package/dist/vta/pcs/trustee/justify/0.2/payload.d.ts +4 -4
- package/dist/vta/pcs/trustee/justify/0.2/payload.js +1 -1
- package/dist/vta/pcs/trustee/justify/0.3/payload.d.ts +13 -2
- package/dist/vta/pcs/trustee/justify/0.3/payload.d.ts.map +1 -1
- package/dist/vta/pcs/trustee/justify/0.3/payload.js +1 -1
- package/dist/vta/pcs/trustee/justify/0.3/payload.js.map +1 -1
- package/dist/vta/pcs/trustee/justify/0.4/payload.d.ts +1881 -0
- package/dist/vta/pcs/trustee/justify/0.4/payload.d.ts.map +1 -0
- package/dist/vta/pcs/trustee/justify/0.4/payload.js +1109 -0
- package/dist/vta/pcs/trustee/justify/0.4/payload.js.map +1 -0
- package/dist/vta/pcs/trustee/keys/0.2/payload.d.ts +4 -4
- package/dist/vta/pcs/trustee/keys/0.2/payload.js +1 -1
- package/dist/vta/pcs/trustee/keys/0.3/payload.d.ts +13 -2
- package/dist/vta/pcs/trustee/keys/0.3/payload.d.ts.map +1 -1
- package/dist/vta/pcs/trustee/keys/0.3/payload.js +1 -1
- package/dist/vta/pcs/trustee/keys/0.3/payload.js.map +1 -1
- package/dist/vta/pcs/trustee/keys/0.4/payload.d.ts +1926 -0
- package/dist/vta/pcs/trustee/keys/0.4/payload.d.ts.map +1 -0
- package/dist/vta/pcs/trustee/keys/0.4/payload.js +1129 -0
- package/dist/vta/pcs/trustee/keys/0.4/payload.js.map +1 -0
- package/dist/vta/pcs/trustee/read/0.1/payload.d.ts +4 -4
- package/dist/vta/pcs/trustee/read/0.1/payload.js +1 -1
- package/dist/vta/pcs/trustee/read/0.2/payload.d.ts +14 -2
- package/dist/vta/pcs/trustee/read/0.2/payload.d.ts.map +1 -1
- package/dist/vta/pcs/trustee/read/0.2/payload.js +1 -1
- package/dist/vta/pcs/trustee/read/0.2/payload.js.map +1 -1
- package/dist/vta/pcs/trustee/read/0.3/payload.d.ts +540 -0
- package/dist/vta/pcs/trustee/read/0.3/payload.d.ts.map +1 -0
- package/dist/vta/pcs/trustee/read/0.3/payload.js +304 -0
- package/dist/vta/pcs/trustee/read/0.3/payload.js.map +1 -0
- package/dist/vta/pcs/vote/0.1/payload.d.ts +4 -4
- package/dist/vta/pcs/vote/0.1/payload.js +1 -1
- package/dist/vta/pcs/vote/0.2/payload.d.ts +13 -2
- package/dist/vta/pcs/vote/0.2/payload.d.ts.map +1 -1
- package/dist/vta/pcs/vote/0.2/payload.js +1 -1
- package/dist/vta/pcs/vote/0.2/payload.js.map +1 -1
- package/dist/vta/pcs/vote/0.3/payload.d.ts +2222 -0
- package/dist/vta/pcs/vote/0.3/payload.d.ts.map +1 -0
- package/dist/vta/pcs/vote/0.3/payload.js +1296 -0
- package/dist/vta/pcs/vote/0.3/payload.js.map +1 -0
- package/dist/vta/pcs/vote-encrypted/0.2/payload.d.ts +4 -4
- package/dist/vta/pcs/vote-encrypted/0.2/payload.js +1 -1
- package/dist/vta/pcs/vote-encrypted/0.3/payload.d.ts +13 -2
- package/dist/vta/pcs/vote-encrypted/0.3/payload.d.ts.map +1 -1
- package/dist/vta/pcs/vote-encrypted/0.3/payload.js +1 -1
- package/dist/vta/pcs/vote-encrypted/0.3/payload.js.map +1 -1
- package/dist/vta/pcs/vote-encrypted/0.4/payload.d.ts +2242 -0
- package/dist/vta/pcs/vote-encrypted/0.4/payload.d.ts.map +1 -0
- package/dist/vta/pcs/vote-encrypted/0.4/payload.js +1314 -0
- package/dist/vta/pcs/vote-encrypted/0.4/payload.js.map +1 -0
- package/dist/vta/pcs/voter/read/0.1/payload.d.ts +4 -4
- package/dist/vta/pcs/voter/read/0.1/payload.js +1 -1
- package/dist/vta/pcs/voter/read/0.2/payload.d.ts +14 -2
- package/dist/vta/pcs/voter/read/0.2/payload.d.ts.map +1 -1
- package/dist/vta/pcs/voter/read/0.2/payload.js +1 -1
- package/dist/vta/pcs/voter/read/0.2/payload.js.map +1 -1
- package/dist/vta/pcs/voter/read/0.3/payload.d.ts +503 -0
- package/dist/vta/pcs/voter/read/0.3/payload.d.ts.map +1 -0
- package/dist/vta/pcs/voter/read/0.3/payload.js +285 -0
- package/dist/vta/pcs/voter/read/0.3/payload.js.map +1 -0
- package/dist/vta/pcs/voter/register/0.1/payload.d.ts +4 -4
- package/dist/vta/pcs/voter/register/0.1/payload.js +1 -1
- package/dist/vta/pcs/voter/register/0.2/payload.d.ts +14 -2
- package/dist/vta/pcs/voter/register/0.2/payload.d.ts.map +1 -1
- package/dist/vta/pcs/voter/register/0.2/payload.js +1 -1
- package/dist/vta/pcs/voter/register/0.2/payload.js.map +1 -1
- package/dist/vta/pcs/voter/register/0.3/payload.d.ts +2176 -0
- package/dist/vta/pcs/voter/register/0.3/payload.d.ts.map +1 -0
- package/dist/vta/pcs/voter/register/0.3/payload.js +1262 -0
- package/dist/vta/pcs/voter/register/0.3/payload.js.map +1 -0
- package/dist/vtc/_shared/0.5/community-room.d.ts +16 -0
- package/dist/vtc/_shared/0.5/community-room.d.ts.map +1 -0
- package/dist/vtc/_shared/0.5/community-room.js +6 -0
- package/dist/vtc/_shared/0.5/community-room.js.map +1 -0
- package/dist/vtc/elections/create/0.1/payload.d.ts +4 -4
- package/dist/vtc/elections/create/0.1/payload.js +1 -1
- package/dist/vtc/elections/create/0.2/payload.d.ts +4 -4
- package/dist/vtc/elections/create/0.2/payload.js +1 -1
- package/dist/vtc/elections/create/0.3/payload.d.ts +14 -2
- package/dist/vtc/elections/create/0.3/payload.d.ts.map +1 -1
- package/dist/vtc/elections/create/0.3/payload.js +1 -1
- package/dist/vtc/elections/create/0.3/payload.js.map +1 -1
- package/dist/vtc/elections/create/0.4/payload.d.ts +1670 -0
- package/dist/vtc/elections/create/0.4/payload.d.ts.map +1 -0
- package/dist/vtc/elections/create/0.4/payload.js +1008 -0
- package/dist/vtc/elections/create/0.4/payload.js.map +1 -0
- package/dist/vtc/elections/show/0.1/payload.d.ts +4 -4
- package/dist/vtc/elections/show/0.1/payload.js +1 -1
- package/dist/vtc/elections/show/0.2/payload.d.ts +14 -2
- package/dist/vtc/elections/show/0.2/payload.d.ts.map +1 -1
- package/dist/vtc/elections/show/0.2/payload.js +1 -1
- package/dist/vtc/elections/show/0.2/payload.js.map +1 -1
- package/dist/vtc/elections/show/0.3/payload.d.ts +3022 -0
- package/dist/vtc/elections/show/0.3/payload.d.ts.map +1 -0
- package/dist/vtc/elections/show/0.3/payload.js +1765 -0
- package/dist/vtc/elections/show/0.3/payload.js.map +1 -0
- package/dist/vtc/rooms/community/archive/0.1/payload.d.ts +1644 -0
- package/dist/vtc/rooms/community/archive/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/archive/0.1/payload.js +940 -0
- package/dist/vtc/rooms/community/archive/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/get/0.1/payload.d.ts +4 -4
- package/dist/vtc/rooms/community/get/0.1/payload.js +1 -1
- package/dist/vtc/rooms/community/get/0.2/payload.d.ts +4 -4
- package/dist/vtc/rooms/community/get/0.2/payload.js +1 -1
- package/dist/vtc/rooms/community/get/0.3/payload.d.ts +13 -2
- package/dist/vtc/rooms/community/get/0.3/payload.d.ts.map +1 -1
- package/dist/vtc/rooms/community/get/0.3/payload.js +1 -1
- package/dist/vtc/rooms/community/get/0.3/payload.js.map +1 -1
- package/dist/vtc/rooms/community/get/0.4/payload.d.ts +1405 -0
- package/dist/vtc/rooms/community/get/0.4/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/get/0.4/payload.js +817 -0
- package/dist/vtc/rooms/community/get/0.4/payload.js.map +1 -0
- package/dist/vtc/rooms/community/list/0.1/payload.d.ts +4 -4
- package/dist/vtc/rooms/community/list/0.1/payload.js +1 -1
- package/dist/vtc/rooms/community/list/0.2/payload.d.ts +4 -4
- package/dist/vtc/rooms/community/list/0.2/payload.js +1 -1
- package/dist/vtc/rooms/community/list/0.3/payload.d.ts +13 -2
- package/dist/vtc/rooms/community/list/0.3/payload.d.ts.map +1 -1
- package/dist/vtc/rooms/community/list/0.3/payload.js +1 -1
- package/dist/vtc/rooms/community/list/0.3/payload.js.map +1 -1
- package/dist/vtc/rooms/community/list/0.4/payload.d.ts +1505 -0
- package/dist/vtc/rooms/community/list/0.4/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/list/0.4/payload.js +854 -0
- package/dist/vtc/rooms/community/list/0.4/payload.js.map +1 -0
- package/dist/vtc/rooms/community/members/add/0.1/payload.d.ts +13 -2
- package/dist/vtc/rooms/community/members/add/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/rooms/community/members/add/0.1/payload.js +1 -1
- package/dist/vtc/rooms/community/members/add/0.1/payload.js.map +1 -1
- package/dist/vtc/rooms/community/members/add/0.2/payload.d.ts +569 -0
- package/dist/vtc/rooms/community/members/add/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/members/add/0.2/payload.js +340 -0
- package/dist/vtc/rooms/community/members/add/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/community/members/list/0.1/payload.d.ts +13 -2
- package/dist/vtc/rooms/community/members/list/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/rooms/community/members/list/0.1/payload.js +1 -1
- package/dist/vtc/rooms/community/members/list/0.1/payload.js.map +1 -1
- package/dist/vtc/rooms/community/members/list/0.2/payload.d.ts +588 -0
- package/dist/vtc/rooms/community/members/list/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/members/list/0.2/payload.js +341 -0
- package/dist/vtc/rooms/community/members/list/0.2/payload.js.map +1 -0
- package/dist/vtc/rooms/community/removal/cancel/0.1/payload.d.ts +1440 -0
- package/dist/vtc/rooms/community/removal/cancel/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/removal/cancel/0.1/payload.js +835 -0
- package/dist/vtc/rooms/community/removal/cancel/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/remove/0.1/payload.d.ts +1604 -0
- package/dist/vtc/rooms/community/remove/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/remove/0.1/payload.js +921 -0
- package/dist/vtc/rooms/community/remove/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/community/unarchive/0.1/payload.d.ts +1460 -0
- package/dist/vtc/rooms/community/unarchive/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/community/unarchive/0.1/payload.js +845 -0
- package/dist/vtc/rooms/community/unarchive/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/memberships/list/0.1/payload.d.ts +13 -2
- package/dist/vtc/rooms/memberships/list/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/rooms/memberships/list/0.1/payload.js +1 -1
- package/dist/vtc/rooms/memberships/list/0.1/payload.js.map +1 -1
- package/dist/vtc/rooms/memberships/list/0.2/payload.d.ts +830 -0
- package/dist/vtc/rooms/memberships/list/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/memberships/list/0.2/payload.js +498 -0
- package/dist/vtc/rooms/memberships/list/0.2/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_extends.ts +1 -0
- package/src/_shared/components.ts +249 -0
- package/src/index.ts +75 -0
- package/src/rooms/keys/act/0.1/payload.ts +5 -5
- package/src/rooms/keys/act/0.10/payload.ts +396 -0
- package/src/rooms/keys/act/0.2/payload.ts +5 -5
- package/src/rooms/keys/act/0.3/payload.ts +5 -5
- package/src/rooms/keys/act/0.4/payload.ts +5 -5
- package/src/rooms/keys/act/0.5/payload.ts +5 -5
- package/src/rooms/keys/act/0.6/payload.ts +5 -5
- package/src/rooms/keys/act/0.7/payload.ts +5 -5
- package/src/rooms/keys/act/0.8/payload.ts +5 -5
- package/src/rooms/keys/act/0.9/payload.ts +15 -3
- package/src/voting/_shared/0.3/voting.ts +17 -0
- package/src/voting/election/register/0.1/payload.ts +5 -5
- package/src/voting/election/register/0.2/payload.ts +14 -3
- package/src/voting/election/register/0.3/payload.ts +1223 -0
- package/src/voting/election/show/0.1/payload.ts +5 -5
- package/src/voting/election/show/0.2/payload.ts +14 -3
- package/src/voting/election/show/0.3/payload.ts +1165 -0
- package/src/vta/pcs/trustee/deal/0.2/payload.ts +5 -5
- package/src/vta/pcs/trustee/deal/0.3/payload.ts +14 -3
- package/src/vta/pcs/trustee/deal/0.4/payload.ts +1164 -0
- package/src/vta/pcs/trustee/enrol/0.1/payload.ts +5 -5
- package/src/vta/pcs/trustee/enrol/0.2/payload.ts +14 -3
- package/src/vta/pcs/trustee/enrol/0.3/payload.ts +1123 -0
- package/src/vta/pcs/trustee/justify/0.2/payload.ts +5 -5
- package/src/vta/pcs/trustee/justify/0.3/payload.ts +14 -3
- package/src/vta/pcs/trustee/justify/0.4/payload.ts +1183 -0
- package/src/vta/pcs/trustee/keys/0.2/payload.ts +5 -5
- package/src/vta/pcs/trustee/keys/0.3/payload.ts +14 -3
- package/src/vta/pcs/trustee/keys/0.4/payload.ts +1210 -0
- package/src/vta/pcs/trustee/read/0.1/payload.ts +5 -5
- package/src/vta/pcs/trustee/read/0.2/payload.ts +15 -3
- package/src/vta/pcs/trustee/read/0.3/payload.ts +385 -0
- package/src/vta/pcs/vote/0.1/payload.ts +5 -5
- package/src/vta/pcs/vote/0.2/payload.ts +14 -3
- package/src/vta/pcs/vote/0.3/payload.ts +1381 -0
- package/src/vta/pcs/vote-encrypted/0.2/payload.ts +5 -5
- package/src/vta/pcs/vote-encrypted/0.3/payload.ts +14 -3
- package/src/vta/pcs/vote-encrypted/0.4/payload.ts +1385 -0
- package/src/vta/pcs/voter/read/0.1/payload.ts +5 -5
- package/src/vta/pcs/voter/read/0.2/payload.ts +15 -3
- package/src/vta/pcs/voter/read/0.3/payload.ts +363 -0
- package/src/vta/pcs/voter/register/0.1/payload.ts +5 -5
- package/src/vta/pcs/voter/register/0.2/payload.ts +15 -3
- package/src/vta/pcs/voter/register/0.3/payload.ts +1372 -0
- package/src/vtc/_shared/0.5/community-room.ts +17 -0
- package/src/vtc/elections/create/0.1/payload.ts +5 -5
- package/src/vtc/elections/create/0.2/payload.ts +5 -5
- package/src/vtc/elections/create/0.3/payload.ts +15 -3
- package/src/vtc/elections/create/0.4/payload.ts +1057 -0
- package/src/vtc/elections/show/0.1/payload.ts +5 -5
- package/src/vtc/elections/show/0.2/payload.ts +15 -3
- package/src/vtc/elections/show/0.3/payload.ts +1865 -0
- package/src/vtc/rooms/community/archive/0.1/payload.ts +995 -0
- package/src/vtc/rooms/community/get/0.1/payload.ts +5 -5
- package/src/vtc/rooms/community/get/0.2/payload.ts +5 -5
- package/src/vtc/rooms/community/get/0.3/payload.ts +14 -3
- package/src/vtc/rooms/community/get/0.4/payload.ts +851 -0
- package/src/vtc/rooms/community/list/0.1/payload.ts +5 -5
- package/src/vtc/rooms/community/list/0.2/payload.ts +5 -5
- package/src/vtc/rooms/community/list/0.3/payload.ts +14 -3
- package/src/vtc/rooms/community/list/0.4/payload.ts +915 -0
- package/src/vtc/rooms/community/members/add/0.1/payload.ts +14 -3
- package/src/vtc/rooms/community/members/add/0.2/payload.ts +384 -0
- package/src/vtc/rooms/community/members/list/0.1/payload.ts +14 -3
- package/src/vtc/rooms/community/members/list/0.2/payload.ts +394 -0
- package/src/vtc/rooms/community/removal/cancel/0.1/payload.ts +870 -0
- package/src/vtc/rooms/community/remove/0.1/payload.ts +968 -0
- package/src/vtc/rooms/community/unarchive/0.1/payload.ts +884 -0
- package/src/vtc/rooms/memberships/list/0.1/payload.ts +14 -3
- package/src/vtc/rooms/memberships/list/0.2/payload.ts +543 -0
|
@@ -0,0 +1,1405 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/rooms/community/get/0.4/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { ArchiveAccess, CommunityRoomV3, Ext, HostedRoom_VtcV0_3 as HostedRoom, PendingChange, PurgeProgress, RetentionPolicy, RoomDescription, RoomLabel, RoomState, RoomStatus, RoomTag, RoomTags, StorageConfigId, Visibility } from "../../../../../_shared/components.js";
|
|
6
|
+
export interface VTCRoomsCommunityGetPayload {
|
|
7
|
+
/**
|
|
8
|
+
* The room's identifier: its DID.
|
|
9
|
+
*/
|
|
10
|
+
roomId: string;
|
|
11
|
+
ext?: Ext;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Success response to vtc/rooms/community/get. Type https://trusttasks.org/spec/vtc/rooms/community/get/0.4#response. One room the community owns, in any state of its owner's lifecycle, with its counts. Its members are vtc/rooms/community/members/list's.
|
|
15
|
+
*/
|
|
16
|
+
export interface VTCRoomsCommunityGetResponsePayload {
|
|
17
|
+
room: CommunityRoomV3;
|
|
18
|
+
ext?: Ext;
|
|
19
|
+
}
|
|
20
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
21
|
+
export type { ArchiveAccess, CommunityRoomV3, Ext, HostedRoom, PendingChange, PurgeProgress, RetentionPolicy, RoomDescription, RoomLabel, RoomState, RoomStatus, RoomTag, RoomTags, StorageConfigId, Visibility };
|
|
22
|
+
/** Trust Task type URI. */
|
|
23
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/rooms/community/get/0.4";
|
|
24
|
+
/**
|
|
25
|
+
* The earlier version of this specification that this one declares it
|
|
26
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
27
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
28
|
+
* `extendsChain` / `readForSpec`.
|
|
29
|
+
*/
|
|
30
|
+
export declare const EXTENDS: string | null;
|
|
31
|
+
/**
|
|
32
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
33
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
34
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
35
|
+
* Versions").
|
|
36
|
+
*/
|
|
37
|
+
export declare const DEPRECATION: string | null;
|
|
38
|
+
/** Stable alias for this specification's request payload shape. */
|
|
39
|
+
export type Payload = VTCRoomsCommunityGetPayload;
|
|
40
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
41
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/rooms/community/get/0.4#response";
|
|
42
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
43
|
+
export type Response = VTCRoomsCommunityGetResponsePayload;
|
|
44
|
+
/**
|
|
45
|
+
* This specification's payload schema, as a value.
|
|
46
|
+
*
|
|
47
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
48
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
49
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
50
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
51
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
52
|
+
*/
|
|
53
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
54
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
55
|
+
readonly $id: "https://trusttasks.org/spec/vtc/rooms/community/get/0.4";
|
|
56
|
+
readonly title: "VTC Rooms Community Get — payload";
|
|
57
|
+
readonly type: "object";
|
|
58
|
+
readonly additionalProperties: false;
|
|
59
|
+
readonly required: readonly ["roomId"];
|
|
60
|
+
readonly properties: {
|
|
61
|
+
readonly roomId: {
|
|
62
|
+
readonly type: "string";
|
|
63
|
+
readonly minLength: 1;
|
|
64
|
+
readonly maxLength: 512;
|
|
65
|
+
readonly description: "The room's identifier: its DID.";
|
|
66
|
+
};
|
|
67
|
+
readonly ext: {
|
|
68
|
+
readonly $ref: "#/$defs/Ext";
|
|
69
|
+
};
|
|
70
|
+
};
|
|
71
|
+
readonly $defs: {
|
|
72
|
+
readonly Response: {
|
|
73
|
+
readonly $anchor: "response";
|
|
74
|
+
readonly title: "VTC Rooms Community Get — response payload";
|
|
75
|
+
readonly description: "Success response to vtc/rooms/community/get. Type https://trusttasks.org/spec/vtc/rooms/community/get/0.4#response. One room the community owns, in any state of its owner's lifecycle, with its counts. Its members are vtc/rooms/community/members/list's.";
|
|
76
|
+
readonly type: "object";
|
|
77
|
+
readonly additionalProperties: false;
|
|
78
|
+
readonly required: readonly ["room"];
|
|
79
|
+
readonly properties: {
|
|
80
|
+
readonly room: {
|
|
81
|
+
readonly $ref: "#/$defs/CommunityRoomV3";
|
|
82
|
+
};
|
|
83
|
+
readonly ext: {
|
|
84
|
+
readonly $ref: "#/$defs/Ext";
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
readonly Ext: {
|
|
89
|
+
readonly title: "Ext";
|
|
90
|
+
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.";
|
|
91
|
+
readonly type: "object";
|
|
92
|
+
readonly minProperties: 1;
|
|
93
|
+
readonly additionalProperties: true;
|
|
94
|
+
readonly propertyNames: {
|
|
95
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
readonly CommunityRoomV3: {
|
|
99
|
+
readonly title: "CommunityRoomV3";
|
|
100
|
+
readonly type: "object";
|
|
101
|
+
readonly additionalProperties: false;
|
|
102
|
+
readonly required: readonly ["room", "label", "admitted", "offered", "status"];
|
|
103
|
+
readonly description: "What vtc/rooms/community/{get,list}/0.4 and vtc/rooms/community/{archive,unarchive,remove,removal/cancel}/0.1 return: `CommunityRoomV2` plus the room's `status` in its owner's lifecycle and the count of `suspended` admissions. A separate definition, not a change to `CommunityRoomV2`, so that the versions returning that keep the exact shape they published. For a room in state `purging` or `removed`, whose host record a purge deletes, `room` is the host record as it last stood before the purge began — the community keeps that snapshot with the room's record when the purge starts — and its `lifecycle` is what was computed then.";
|
|
104
|
+
readonly properties: {
|
|
105
|
+
readonly room: {
|
|
106
|
+
readonly $ref: "#/$defs/HostedRoom";
|
|
107
|
+
};
|
|
108
|
+
readonly label: {
|
|
109
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
110
|
+
};
|
|
111
|
+
readonly status: {
|
|
112
|
+
readonly $ref: "#/$defs/RoomStatus";
|
|
113
|
+
};
|
|
114
|
+
readonly description: {
|
|
115
|
+
readonly $ref: "#/$defs/RoomDescription";
|
|
116
|
+
readonly description: "Absent when the room has none.";
|
|
117
|
+
};
|
|
118
|
+
readonly tags: {
|
|
119
|
+
readonly $ref: "#/$defs/RoomTags";
|
|
120
|
+
readonly description: "Absent or empty when the room has none.";
|
|
121
|
+
};
|
|
122
|
+
readonly storageConfig: {
|
|
123
|
+
readonly $ref: "#/$defs/StorageConfigId";
|
|
124
|
+
readonly description: "The storage config receiving the room's new uploads.";
|
|
125
|
+
};
|
|
126
|
+
readonly admitted: {
|
|
127
|
+
readonly type: "integer";
|
|
128
|
+
readonly minimum: 0;
|
|
129
|
+
readonly description: "Members in state `admitted`.";
|
|
130
|
+
};
|
|
131
|
+
readonly offered: {
|
|
132
|
+
readonly type: "integer";
|
|
133
|
+
readonly minimum: 0;
|
|
134
|
+
readonly description: "Offers not yet accepted or withdrawn.";
|
|
135
|
+
};
|
|
136
|
+
readonly suspended: {
|
|
137
|
+
readonly type: "integer";
|
|
138
|
+
readonly minimum: 0;
|
|
139
|
+
readonly description: "Admissions in state `suspended`: withdrawn while the room was archived with `noAccess`, and restored when it leaves that state. Absent when zero.";
|
|
140
|
+
};
|
|
141
|
+
readonly ownerAuthorityValidUntil: {
|
|
142
|
+
readonly type: "string";
|
|
143
|
+
readonly format: "date-time";
|
|
144
|
+
readonly description: "When the community's own `admin` authority over the room expires. A room whose owner's authority lapses can no longer advance its epoch, admit or remove; a community SHOULD renew it well before.";
|
|
145
|
+
};
|
|
146
|
+
readonly createdBy: {
|
|
147
|
+
readonly type: "string";
|
|
148
|
+
readonly pattern: "^did:";
|
|
149
|
+
readonly maxLength: 2048;
|
|
150
|
+
readonly description: "The administrator who created it.";
|
|
151
|
+
};
|
|
152
|
+
readonly detailsUpdatedAt: {
|
|
153
|
+
readonly type: "string";
|
|
154
|
+
readonly format: "date-time";
|
|
155
|
+
readonly description: "When `label`, `description` or `tags` last changed. Absent until the first change after creation. Distinct from `room.updatedAt`, which is the host record's and moves with the room's epoch and lifecycle.";
|
|
156
|
+
};
|
|
157
|
+
readonly detailsUpdatedBy: {
|
|
158
|
+
readonly type: "string";
|
|
159
|
+
readonly pattern: "^did:";
|
|
160
|
+
readonly maxLength: 2048;
|
|
161
|
+
readonly description: "The administrator who made that change. Present exactly when `detailsUpdatedAt` is. The earlier values and who set them are in the community's audit trail, not here.";
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
readonly RoomTags: {
|
|
166
|
+
readonly title: "RoomTags";
|
|
167
|
+
readonly type: "array";
|
|
168
|
+
readonly maxItems: 8;
|
|
169
|
+
readonly uniqueItems: true;
|
|
170
|
+
readonly items: {
|
|
171
|
+
readonly $ref: "#/$defs/RoomTag";
|
|
172
|
+
};
|
|
173
|
+
readonly description: "The room's tags, at most eight, as a set: order carries no meaning. An empty list means the room has none — a tag grants nothing, so empty has no more dangerous reading.";
|
|
174
|
+
};
|
|
175
|
+
readonly RoomTag: {
|
|
176
|
+
readonly title: "RoomTag";
|
|
177
|
+
readonly type: "string";
|
|
178
|
+
readonly minLength: 1;
|
|
179
|
+
readonly maxLength: 32;
|
|
180
|
+
readonly pattern: "^[a-z0-9][a-z0-9-]{0,31}$";
|
|
181
|
+
readonly description: "A short identifier an administrator files a community-owned room under — `board`, `working-group`, `finance` — so the room list can be filtered. Lower-case letters, digits and hyphens, starting with a letter or digit. Owner-side tracking metadata for holders of `vtc.rooms.manage` only: never shown to members, never sent on the room's host path, and it confers nothing.";
|
|
182
|
+
};
|
|
183
|
+
readonly RoomDescription: {
|
|
184
|
+
readonly title: "RoomDescription";
|
|
185
|
+
readonly type: "string";
|
|
186
|
+
readonly minLength: 1;
|
|
187
|
+
readonly maxLength: 1000;
|
|
188
|
+
readonly description: "What the room is for, in a sentence or a short paragraph, written by an administrator: shown to administrators holding `vtc.rooms.manage` and to the members the room is offered to. Plain text — a consumer renders it as text, never as markup. Like `RoomLabel`, it is the community's own record as the room's owner: not part of the room's identity and never in anything a room's host can read. From `vtc/rooms/community/create` 0.3 and `vtc/rooms/community/update` 0.2 the community also writes it, through its own VTA, as the `description` of the room's own profile (`RoomProfile` in rooms/_shared), sealed inside the room for its members; earlier versions keep it out of the room altogether. It MUST NOT carry personal data or a credential, and a reader MUST NOT treat it as instructions.";
|
|
189
|
+
};
|
|
190
|
+
readonly RoomStatus: {
|
|
191
|
+
readonly title: "RoomStatus";
|
|
192
|
+
readonly type: "object";
|
|
193
|
+
readonly additionalProperties: false;
|
|
194
|
+
readonly required: readonly ["state"];
|
|
195
|
+
readonly description: "A room's state in its owner's lifecycle, and what that state needs to be understood.";
|
|
196
|
+
readonly properties: {
|
|
197
|
+
readonly state: {
|
|
198
|
+
readonly $ref: "#/$defs/RoomState";
|
|
199
|
+
};
|
|
200
|
+
readonly access: {
|
|
201
|
+
readonly $ref: "#/$defs/ArchiveAccess";
|
|
202
|
+
readonly description: "Present exactly when `state` is `archived` or `removalScheduled`; always `noAccess` for `removalScheduled`.";
|
|
203
|
+
};
|
|
204
|
+
readonly changedAt: {
|
|
205
|
+
readonly type: "string";
|
|
206
|
+
readonly format: "date-time";
|
|
207
|
+
readonly description: "When the room entered `state`. Absent for a room that has been `active` since it was created.";
|
|
208
|
+
};
|
|
209
|
+
readonly changedBy: {
|
|
210
|
+
readonly type: "string";
|
|
211
|
+
readonly pattern: "^did:";
|
|
212
|
+
readonly maxLength: 2048;
|
|
213
|
+
readonly description: "The administrator whose act put the room in `state`. Present exactly when `changedAt` is, except for `purging` and `removed` reached when a grace period ended, which no one did at that moment: then the administrator who scheduled the removal. The reason each gave is in the community's audit trail, not here.";
|
|
214
|
+
};
|
|
215
|
+
readonly purgeAt: {
|
|
216
|
+
readonly type: "string";
|
|
217
|
+
readonly format: "date-time";
|
|
218
|
+
readonly description: "Present when `state` is `removalScheduled`: when the grace period ends and the purge begins. Kept when `state` is `purging` or `removed`, as when it became due.";
|
|
219
|
+
};
|
|
220
|
+
readonly purge: {
|
|
221
|
+
readonly $ref: "#/$defs/PurgeProgress";
|
|
222
|
+
readonly description: "Present exactly when `state` is `purging`.";
|
|
223
|
+
};
|
|
224
|
+
readonly removedAt: {
|
|
225
|
+
readonly type: "string";
|
|
226
|
+
readonly format: "date-time";
|
|
227
|
+
readonly description: "Present exactly when `state` is `removed`: when the last of the room's content was deleted.";
|
|
228
|
+
};
|
|
229
|
+
readonly restoring: {
|
|
230
|
+
readonly type: "integer";
|
|
231
|
+
readonly minimum: 1;
|
|
232
|
+
readonly description: "Admissions still `suspended` that the community is restoring, after the room left `noAccess` — the room re-issues each member's credentials and the member collects them as a renewal. Absent when there are none.";
|
|
233
|
+
};
|
|
234
|
+
readonly pendingChange: {
|
|
235
|
+
readonly $ref: "#/$defs/PendingChange";
|
|
236
|
+
readonly description: "Present while a change of state is begun and not finished.";
|
|
237
|
+
};
|
|
238
|
+
};
|
|
239
|
+
};
|
|
240
|
+
readonly PendingChange: {
|
|
241
|
+
readonly title: "PendingChange";
|
|
242
|
+
readonly type: "object";
|
|
243
|
+
readonly additionalProperties: false;
|
|
244
|
+
readonly required: readonly ["state", "beganAt"];
|
|
245
|
+
readonly description: "A change of state the community began and has not finished, because a step at its VTA did not complete — most often a room reset the host accepted, after which the community's own credentials must be re-issued before it can act on the room again. `RoomStatus.state` stays what it was until the change finishes, but what the room's host enforces may already be the new state's: a pending move to `noAccess` means members' credentials may already be refused. The community finishes it by itself, retrying with backoff, and repeating the request that began it finishes it too; nothing else changes the room until it is finished.";
|
|
246
|
+
readonly properties: {
|
|
247
|
+
readonly state: {
|
|
248
|
+
readonly $ref: "#/$defs/RoomState";
|
|
249
|
+
readonly description: "The state the change leads to.";
|
|
250
|
+
};
|
|
251
|
+
readonly access: {
|
|
252
|
+
readonly $ref: "#/$defs/ArchiveAccess";
|
|
253
|
+
readonly description: "The access it leads to, where `state` has one.";
|
|
254
|
+
};
|
|
255
|
+
readonly beganAt: {
|
|
256
|
+
readonly type: "string";
|
|
257
|
+
readonly format: "date-time";
|
|
258
|
+
};
|
|
259
|
+
readonly lastError: {
|
|
260
|
+
readonly type: "string";
|
|
261
|
+
readonly minLength: 1;
|
|
262
|
+
readonly maxLength: 500;
|
|
263
|
+
readonly description: "What stopped the last attempt, for an administrator. Plain text; it names no member and carries no credential.";
|
|
264
|
+
};
|
|
265
|
+
};
|
|
266
|
+
};
|
|
267
|
+
readonly ArchiveAccess: {
|
|
268
|
+
readonly title: "ArchiveAccess";
|
|
269
|
+
readonly type: "string";
|
|
270
|
+
readonly enum: readonly ["readOnly", "noAccess"];
|
|
271
|
+
readonly description: "What an archived room's members may still do. `readOnly`: their credentials stand and they keep reading what the room holds; the room's host refuses every write, upload and curation from a member. `noAccess`: every credential the room issued before the archival is withdrawn at its host — a room reset — so the host refuses every member's every task; the content is kept intact, and each withdrawn admission is `suspended`, restored when the room is unarchived or made `readOnly`. Neither recalls what a member already read or saved, and on a sealed tier neither removes anyone from the room's group.";
|
|
272
|
+
};
|
|
273
|
+
readonly RoomState: {
|
|
274
|
+
readonly title: "RoomState";
|
|
275
|
+
readonly type: "string";
|
|
276
|
+
readonly enum: readonly ["active", "archived", "removalScheduled", "purging", "removed"];
|
|
277
|
+
readonly description: "Where a room the community owns stands in its owner's lifecycle — distinct from `HostedRoom.lifecycle`, which is the host's clock (`live`, `lapsed`, `dormant`, `reclaimable`) and is computed from the room's epoch, never set. `active`: open to change. `archived`: closed to change by an administrator — no admissions, and the room's host accepts no writes from its members; what members may still do is `ArchiveAccess`. Reversible with vtc/rooms/community/unarchive. `removalScheduled`: an administrator removed the room with a grace period; it admits nobody and its content is kept until `purgeAt`, and vtc/rooms/community/removal/cancel returns it to `archived`. `purging`: the grace period ended (or there was none) and the community is deleting the room's content from its host and storage; not reversible. `removed`: the content is gone; the community keeps only this record of the room, for its history.";
|
|
278
|
+
};
|
|
279
|
+
readonly PurgeProgress: {
|
|
280
|
+
readonly title: "PurgeProgress";
|
|
281
|
+
readonly type: "object";
|
|
282
|
+
readonly additionalProperties: false;
|
|
283
|
+
readonly required: readonly ["attempts"];
|
|
284
|
+
readonly description: "How a purge is going. A purge deletes at the room's host and at each storage config holding its files, and some of those are remote; a step that fails is retried with backoff until it succeeds, and nothing is reported removed until every step has.";
|
|
285
|
+
readonly properties: {
|
|
286
|
+
readonly attempts: {
|
|
287
|
+
readonly type: "integer";
|
|
288
|
+
readonly minimum: 0;
|
|
289
|
+
readonly description: "Passes made so far; 0 until the first.";
|
|
290
|
+
};
|
|
291
|
+
readonly lastAttemptAt: {
|
|
292
|
+
readonly type: "string";
|
|
293
|
+
readonly format: "date-time";
|
|
294
|
+
};
|
|
295
|
+
readonly nextAttemptAt: {
|
|
296
|
+
readonly type: "string";
|
|
297
|
+
readonly format: "date-time";
|
|
298
|
+
readonly description: "When the next pass is due. Absent while one runs.";
|
|
299
|
+
};
|
|
300
|
+
readonly lastError: {
|
|
301
|
+
readonly type: "string";
|
|
302
|
+
readonly minLength: 1;
|
|
303
|
+
readonly maxLength: 500;
|
|
304
|
+
readonly description: "What stopped the last pass, for an administrator. Present only after a pass failed. Plain text, written by the community; it names no member and carries no credential.";
|
|
305
|
+
};
|
|
306
|
+
};
|
|
307
|
+
};
|
|
308
|
+
readonly RoomLabel: {
|
|
309
|
+
readonly title: "RoomLabel";
|
|
310
|
+
readonly type: "string";
|
|
311
|
+
readonly minLength: 1;
|
|
312
|
+
readonly maxLength: 128;
|
|
313
|
+
readonly description: "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and never in anything a room's host can read. From `vtc/rooms/community/create` 0.3 and `vtc/rooms/community/update` 0.2 the community also writes it, through its own VTA, as the `name` of the room's own profile (`RoomProfile` in rooms/_shared), sealed inside the room for its members; earlier versions keep it out of the room altogether. MUST NOT carry personal data.";
|
|
314
|
+
};
|
|
315
|
+
readonly StorageConfigId: {
|
|
316
|
+
readonly title: "StorageConfigId";
|
|
317
|
+
readonly type: "string";
|
|
318
|
+
readonly minLength: 1;
|
|
319
|
+
readonly maxLength: 64;
|
|
320
|
+
readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
|
|
321
|
+
readonly description: "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value.";
|
|
322
|
+
};
|
|
323
|
+
readonly HostedRoom: {
|
|
324
|
+
readonly title: "HostedRoom";
|
|
325
|
+
readonly type: "object";
|
|
326
|
+
readonly additionalProperties: false;
|
|
327
|
+
readonly required: readonly ["roomId", "ownerDid", "visibility", "retentionPolicy", "epoch", "lifecycle", "retentionDays", "createdAt", "updatedAt"];
|
|
328
|
+
readonly description: "One room, as its host holds it — member for member the `HostedRoom` of vtc/rooms/list/0.2, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.";
|
|
329
|
+
readonly properties: {
|
|
330
|
+
readonly roomId: {
|
|
331
|
+
readonly type: "string";
|
|
332
|
+
readonly minLength: 1;
|
|
333
|
+
readonly maxLength: 512;
|
|
334
|
+
};
|
|
335
|
+
readonly ownerDid: {
|
|
336
|
+
readonly type: "string";
|
|
337
|
+
readonly pattern: "^did:";
|
|
338
|
+
readonly maxLength: 2048;
|
|
339
|
+
};
|
|
340
|
+
readonly visibility: {
|
|
341
|
+
readonly $ref: "#/$defs/Visibility";
|
|
342
|
+
};
|
|
343
|
+
readonly retentionPolicy: {
|
|
344
|
+
readonly $ref: "#/$defs/RetentionPolicy";
|
|
345
|
+
};
|
|
346
|
+
readonly epoch: {
|
|
347
|
+
readonly type: "integer";
|
|
348
|
+
readonly minimum: 0;
|
|
349
|
+
};
|
|
350
|
+
readonly lifecycle: {
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly enum: readonly ["live", "lapsed", "dormant", "reclaimable"];
|
|
353
|
+
};
|
|
354
|
+
readonly epochExpiresAt: {
|
|
355
|
+
readonly type: "string";
|
|
356
|
+
readonly format: "date-time";
|
|
357
|
+
};
|
|
358
|
+
readonly retentionDays: {
|
|
359
|
+
readonly type: "integer";
|
|
360
|
+
readonly minimum: 0;
|
|
361
|
+
};
|
|
362
|
+
readonly mirrorOf: {
|
|
363
|
+
readonly type: "string";
|
|
364
|
+
readonly minLength: 1;
|
|
365
|
+
readonly maxLength: 2048;
|
|
366
|
+
};
|
|
367
|
+
readonly createdAt: {
|
|
368
|
+
readonly type: "string";
|
|
369
|
+
readonly format: "date-time";
|
|
370
|
+
};
|
|
371
|
+
readonly updatedAt: {
|
|
372
|
+
readonly type: "string";
|
|
373
|
+
readonly format: "date-time";
|
|
374
|
+
};
|
|
375
|
+
};
|
|
376
|
+
};
|
|
377
|
+
readonly RetentionPolicy: {
|
|
378
|
+
readonly title: "RetentionPolicy";
|
|
379
|
+
readonly type: "string";
|
|
380
|
+
readonly enum: readonly ["chained", "fromJoin"];
|
|
381
|
+
readonly description: "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.";
|
|
382
|
+
readonly $comment: "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it.";
|
|
383
|
+
};
|
|
384
|
+
readonly Visibility: {
|
|
385
|
+
readonly title: "Visibility";
|
|
386
|
+
readonly type: "string";
|
|
387
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
388
|
+
readonly description: "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything.";
|
|
389
|
+
};
|
|
390
|
+
};
|
|
391
|
+
};
|
|
392
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
393
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
394
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
395
|
+
readonly $ref: "#/$defs/Response";
|
|
396
|
+
readonly $defs: {
|
|
397
|
+
readonly Response: {
|
|
398
|
+
readonly $anchor: "response";
|
|
399
|
+
readonly title: "VTC Rooms Community Get — response payload";
|
|
400
|
+
readonly description: "Success response to vtc/rooms/community/get. Type https://trusttasks.org/spec/vtc/rooms/community/get/0.4#response. One room the community owns, in any state of its owner's lifecycle, with its counts. Its members are vtc/rooms/community/members/list's.";
|
|
401
|
+
readonly type: "object";
|
|
402
|
+
readonly additionalProperties: false;
|
|
403
|
+
readonly required: readonly ["room"];
|
|
404
|
+
readonly properties: {
|
|
405
|
+
readonly room: {
|
|
406
|
+
readonly $ref: "#/$defs/CommunityRoomV3";
|
|
407
|
+
};
|
|
408
|
+
readonly ext: {
|
|
409
|
+
readonly $ref: "#/$defs/Ext";
|
|
410
|
+
};
|
|
411
|
+
};
|
|
412
|
+
};
|
|
413
|
+
readonly Ext: {
|
|
414
|
+
readonly title: "Ext";
|
|
415
|
+
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.";
|
|
416
|
+
readonly type: "object";
|
|
417
|
+
readonly minProperties: 1;
|
|
418
|
+
readonly additionalProperties: true;
|
|
419
|
+
readonly propertyNames: {
|
|
420
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
421
|
+
};
|
|
422
|
+
};
|
|
423
|
+
readonly CommunityRoomV3: {
|
|
424
|
+
readonly title: "CommunityRoomV3";
|
|
425
|
+
readonly type: "object";
|
|
426
|
+
readonly additionalProperties: false;
|
|
427
|
+
readonly required: readonly ["room", "label", "admitted", "offered", "status"];
|
|
428
|
+
readonly description: "What vtc/rooms/community/{get,list}/0.4 and vtc/rooms/community/{archive,unarchive,remove,removal/cancel}/0.1 return: `CommunityRoomV2` plus the room's `status` in its owner's lifecycle and the count of `suspended` admissions. A separate definition, not a change to `CommunityRoomV2`, so that the versions returning that keep the exact shape they published. For a room in state `purging` or `removed`, whose host record a purge deletes, `room` is the host record as it last stood before the purge began — the community keeps that snapshot with the room's record when the purge starts — and its `lifecycle` is what was computed then.";
|
|
429
|
+
readonly properties: {
|
|
430
|
+
readonly room: {
|
|
431
|
+
readonly $ref: "#/$defs/HostedRoom";
|
|
432
|
+
};
|
|
433
|
+
readonly label: {
|
|
434
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
435
|
+
};
|
|
436
|
+
readonly status: {
|
|
437
|
+
readonly $ref: "#/$defs/RoomStatus";
|
|
438
|
+
};
|
|
439
|
+
readonly description: {
|
|
440
|
+
readonly $ref: "#/$defs/RoomDescription";
|
|
441
|
+
readonly description: "Absent when the room has none.";
|
|
442
|
+
};
|
|
443
|
+
readonly tags: {
|
|
444
|
+
readonly $ref: "#/$defs/RoomTags";
|
|
445
|
+
readonly description: "Absent or empty when the room has none.";
|
|
446
|
+
};
|
|
447
|
+
readonly storageConfig: {
|
|
448
|
+
readonly $ref: "#/$defs/StorageConfigId";
|
|
449
|
+
readonly description: "The storage config receiving the room's new uploads.";
|
|
450
|
+
};
|
|
451
|
+
readonly admitted: {
|
|
452
|
+
readonly type: "integer";
|
|
453
|
+
readonly minimum: 0;
|
|
454
|
+
readonly description: "Members in state `admitted`.";
|
|
455
|
+
};
|
|
456
|
+
readonly offered: {
|
|
457
|
+
readonly type: "integer";
|
|
458
|
+
readonly minimum: 0;
|
|
459
|
+
readonly description: "Offers not yet accepted or withdrawn.";
|
|
460
|
+
};
|
|
461
|
+
readonly suspended: {
|
|
462
|
+
readonly type: "integer";
|
|
463
|
+
readonly minimum: 0;
|
|
464
|
+
readonly description: "Admissions in state `suspended`: withdrawn while the room was archived with `noAccess`, and restored when it leaves that state. Absent when zero.";
|
|
465
|
+
};
|
|
466
|
+
readonly ownerAuthorityValidUntil: {
|
|
467
|
+
readonly type: "string";
|
|
468
|
+
readonly format: "date-time";
|
|
469
|
+
readonly description: "When the community's own `admin` authority over the room expires. A room whose owner's authority lapses can no longer advance its epoch, admit or remove; a community SHOULD renew it well before.";
|
|
470
|
+
};
|
|
471
|
+
readonly createdBy: {
|
|
472
|
+
readonly type: "string";
|
|
473
|
+
readonly pattern: "^did:";
|
|
474
|
+
readonly maxLength: 2048;
|
|
475
|
+
readonly description: "The administrator who created it.";
|
|
476
|
+
};
|
|
477
|
+
readonly detailsUpdatedAt: {
|
|
478
|
+
readonly type: "string";
|
|
479
|
+
readonly format: "date-time";
|
|
480
|
+
readonly description: "When `label`, `description` or `tags` last changed. Absent until the first change after creation. Distinct from `room.updatedAt`, which is the host record's and moves with the room's epoch and lifecycle.";
|
|
481
|
+
};
|
|
482
|
+
readonly detailsUpdatedBy: {
|
|
483
|
+
readonly type: "string";
|
|
484
|
+
readonly pattern: "^did:";
|
|
485
|
+
readonly maxLength: 2048;
|
|
486
|
+
readonly description: "The administrator who made that change. Present exactly when `detailsUpdatedAt` is. The earlier values and who set them are in the community's audit trail, not here.";
|
|
487
|
+
};
|
|
488
|
+
};
|
|
489
|
+
};
|
|
490
|
+
readonly RoomTags: {
|
|
491
|
+
readonly title: "RoomTags";
|
|
492
|
+
readonly type: "array";
|
|
493
|
+
readonly maxItems: 8;
|
|
494
|
+
readonly uniqueItems: true;
|
|
495
|
+
readonly items: {
|
|
496
|
+
readonly $ref: "#/$defs/RoomTag";
|
|
497
|
+
};
|
|
498
|
+
readonly description: "The room's tags, at most eight, as a set: order carries no meaning. An empty list means the room has none — a tag grants nothing, so empty has no more dangerous reading.";
|
|
499
|
+
};
|
|
500
|
+
readonly RoomTag: {
|
|
501
|
+
readonly title: "RoomTag";
|
|
502
|
+
readonly type: "string";
|
|
503
|
+
readonly minLength: 1;
|
|
504
|
+
readonly maxLength: 32;
|
|
505
|
+
readonly pattern: "^[a-z0-9][a-z0-9-]{0,31}$";
|
|
506
|
+
readonly description: "A short identifier an administrator files a community-owned room under — `board`, `working-group`, `finance` — so the room list can be filtered. Lower-case letters, digits and hyphens, starting with a letter or digit. Owner-side tracking metadata for holders of `vtc.rooms.manage` only: never shown to members, never sent on the room's host path, and it confers nothing.";
|
|
507
|
+
};
|
|
508
|
+
readonly RoomDescription: {
|
|
509
|
+
readonly title: "RoomDescription";
|
|
510
|
+
readonly type: "string";
|
|
511
|
+
readonly minLength: 1;
|
|
512
|
+
readonly maxLength: 1000;
|
|
513
|
+
readonly description: "What the room is for, in a sentence or a short paragraph, written by an administrator: shown to administrators holding `vtc.rooms.manage` and to the members the room is offered to. Plain text — a consumer renders it as text, never as markup. Like `RoomLabel`, it is the community's own record as the room's owner: not part of the room's identity and never in anything a room's host can read. From `vtc/rooms/community/create` 0.3 and `vtc/rooms/community/update` 0.2 the community also writes it, through its own VTA, as the `description` of the room's own profile (`RoomProfile` in rooms/_shared), sealed inside the room for its members; earlier versions keep it out of the room altogether. It MUST NOT carry personal data or a credential, and a reader MUST NOT treat it as instructions.";
|
|
514
|
+
};
|
|
515
|
+
readonly RoomStatus: {
|
|
516
|
+
readonly title: "RoomStatus";
|
|
517
|
+
readonly type: "object";
|
|
518
|
+
readonly additionalProperties: false;
|
|
519
|
+
readonly required: readonly ["state"];
|
|
520
|
+
readonly description: "A room's state in its owner's lifecycle, and what that state needs to be understood.";
|
|
521
|
+
readonly properties: {
|
|
522
|
+
readonly state: {
|
|
523
|
+
readonly $ref: "#/$defs/RoomState";
|
|
524
|
+
};
|
|
525
|
+
readonly access: {
|
|
526
|
+
readonly $ref: "#/$defs/ArchiveAccess";
|
|
527
|
+
readonly description: "Present exactly when `state` is `archived` or `removalScheduled`; always `noAccess` for `removalScheduled`.";
|
|
528
|
+
};
|
|
529
|
+
readonly changedAt: {
|
|
530
|
+
readonly type: "string";
|
|
531
|
+
readonly format: "date-time";
|
|
532
|
+
readonly description: "When the room entered `state`. Absent for a room that has been `active` since it was created.";
|
|
533
|
+
};
|
|
534
|
+
readonly changedBy: {
|
|
535
|
+
readonly type: "string";
|
|
536
|
+
readonly pattern: "^did:";
|
|
537
|
+
readonly maxLength: 2048;
|
|
538
|
+
readonly description: "The administrator whose act put the room in `state`. Present exactly when `changedAt` is, except for `purging` and `removed` reached when a grace period ended, which no one did at that moment: then the administrator who scheduled the removal. The reason each gave is in the community's audit trail, not here.";
|
|
539
|
+
};
|
|
540
|
+
readonly purgeAt: {
|
|
541
|
+
readonly type: "string";
|
|
542
|
+
readonly format: "date-time";
|
|
543
|
+
readonly description: "Present when `state` is `removalScheduled`: when the grace period ends and the purge begins. Kept when `state` is `purging` or `removed`, as when it became due.";
|
|
544
|
+
};
|
|
545
|
+
readonly purge: {
|
|
546
|
+
readonly $ref: "#/$defs/PurgeProgress";
|
|
547
|
+
readonly description: "Present exactly when `state` is `purging`.";
|
|
548
|
+
};
|
|
549
|
+
readonly removedAt: {
|
|
550
|
+
readonly type: "string";
|
|
551
|
+
readonly format: "date-time";
|
|
552
|
+
readonly description: "Present exactly when `state` is `removed`: when the last of the room's content was deleted.";
|
|
553
|
+
};
|
|
554
|
+
readonly restoring: {
|
|
555
|
+
readonly type: "integer";
|
|
556
|
+
readonly minimum: 1;
|
|
557
|
+
readonly description: "Admissions still `suspended` that the community is restoring, after the room left `noAccess` — the room re-issues each member's credentials and the member collects them as a renewal. Absent when there are none.";
|
|
558
|
+
};
|
|
559
|
+
readonly pendingChange: {
|
|
560
|
+
readonly $ref: "#/$defs/PendingChange";
|
|
561
|
+
readonly description: "Present while a change of state is begun and not finished.";
|
|
562
|
+
};
|
|
563
|
+
};
|
|
564
|
+
};
|
|
565
|
+
readonly PendingChange: {
|
|
566
|
+
readonly title: "PendingChange";
|
|
567
|
+
readonly type: "object";
|
|
568
|
+
readonly additionalProperties: false;
|
|
569
|
+
readonly required: readonly ["state", "beganAt"];
|
|
570
|
+
readonly description: "A change of state the community began and has not finished, because a step at its VTA did not complete — most often a room reset the host accepted, after which the community's own credentials must be re-issued before it can act on the room again. `RoomStatus.state` stays what it was until the change finishes, but what the room's host enforces may already be the new state's: a pending move to `noAccess` means members' credentials may already be refused. The community finishes it by itself, retrying with backoff, and repeating the request that began it finishes it too; nothing else changes the room until it is finished.";
|
|
571
|
+
readonly properties: {
|
|
572
|
+
readonly state: {
|
|
573
|
+
readonly $ref: "#/$defs/RoomState";
|
|
574
|
+
readonly description: "The state the change leads to.";
|
|
575
|
+
};
|
|
576
|
+
readonly access: {
|
|
577
|
+
readonly $ref: "#/$defs/ArchiveAccess";
|
|
578
|
+
readonly description: "The access it leads to, where `state` has one.";
|
|
579
|
+
};
|
|
580
|
+
readonly beganAt: {
|
|
581
|
+
readonly type: "string";
|
|
582
|
+
readonly format: "date-time";
|
|
583
|
+
};
|
|
584
|
+
readonly lastError: {
|
|
585
|
+
readonly type: "string";
|
|
586
|
+
readonly minLength: 1;
|
|
587
|
+
readonly maxLength: 500;
|
|
588
|
+
readonly description: "What stopped the last attempt, for an administrator. Plain text; it names no member and carries no credential.";
|
|
589
|
+
};
|
|
590
|
+
};
|
|
591
|
+
};
|
|
592
|
+
readonly ArchiveAccess: {
|
|
593
|
+
readonly title: "ArchiveAccess";
|
|
594
|
+
readonly type: "string";
|
|
595
|
+
readonly enum: readonly ["readOnly", "noAccess"];
|
|
596
|
+
readonly description: "What an archived room's members may still do. `readOnly`: their credentials stand and they keep reading what the room holds; the room's host refuses every write, upload and curation from a member. `noAccess`: every credential the room issued before the archival is withdrawn at its host — a room reset — so the host refuses every member's every task; the content is kept intact, and each withdrawn admission is `suspended`, restored when the room is unarchived or made `readOnly`. Neither recalls what a member already read or saved, and on a sealed tier neither removes anyone from the room's group.";
|
|
597
|
+
};
|
|
598
|
+
readonly RoomState: {
|
|
599
|
+
readonly title: "RoomState";
|
|
600
|
+
readonly type: "string";
|
|
601
|
+
readonly enum: readonly ["active", "archived", "removalScheduled", "purging", "removed"];
|
|
602
|
+
readonly description: "Where a room the community owns stands in its owner's lifecycle — distinct from `HostedRoom.lifecycle`, which is the host's clock (`live`, `lapsed`, `dormant`, `reclaimable`) and is computed from the room's epoch, never set. `active`: open to change. `archived`: closed to change by an administrator — no admissions, and the room's host accepts no writes from its members; what members may still do is `ArchiveAccess`. Reversible with vtc/rooms/community/unarchive. `removalScheduled`: an administrator removed the room with a grace period; it admits nobody and its content is kept until `purgeAt`, and vtc/rooms/community/removal/cancel returns it to `archived`. `purging`: the grace period ended (or there was none) and the community is deleting the room's content from its host and storage; not reversible. `removed`: the content is gone; the community keeps only this record of the room, for its history.";
|
|
603
|
+
};
|
|
604
|
+
readonly PurgeProgress: {
|
|
605
|
+
readonly title: "PurgeProgress";
|
|
606
|
+
readonly type: "object";
|
|
607
|
+
readonly additionalProperties: false;
|
|
608
|
+
readonly required: readonly ["attempts"];
|
|
609
|
+
readonly description: "How a purge is going. A purge deletes at the room's host and at each storage config holding its files, and some of those are remote; a step that fails is retried with backoff until it succeeds, and nothing is reported removed until every step has.";
|
|
610
|
+
readonly properties: {
|
|
611
|
+
readonly attempts: {
|
|
612
|
+
readonly type: "integer";
|
|
613
|
+
readonly minimum: 0;
|
|
614
|
+
readonly description: "Passes made so far; 0 until the first.";
|
|
615
|
+
};
|
|
616
|
+
readonly lastAttemptAt: {
|
|
617
|
+
readonly type: "string";
|
|
618
|
+
readonly format: "date-time";
|
|
619
|
+
};
|
|
620
|
+
readonly nextAttemptAt: {
|
|
621
|
+
readonly type: "string";
|
|
622
|
+
readonly format: "date-time";
|
|
623
|
+
readonly description: "When the next pass is due. Absent while one runs.";
|
|
624
|
+
};
|
|
625
|
+
readonly lastError: {
|
|
626
|
+
readonly type: "string";
|
|
627
|
+
readonly minLength: 1;
|
|
628
|
+
readonly maxLength: 500;
|
|
629
|
+
readonly description: "What stopped the last pass, for an administrator. Present only after a pass failed. Plain text, written by the community; it names no member and carries no credential.";
|
|
630
|
+
};
|
|
631
|
+
};
|
|
632
|
+
};
|
|
633
|
+
readonly RoomLabel: {
|
|
634
|
+
readonly title: "RoomLabel";
|
|
635
|
+
readonly type: "string";
|
|
636
|
+
readonly minLength: 1;
|
|
637
|
+
readonly maxLength: 128;
|
|
638
|
+
readonly description: "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and never in anything a room's host can read. From `vtc/rooms/community/create` 0.3 and `vtc/rooms/community/update` 0.2 the community also writes it, through its own VTA, as the `name` of the room's own profile (`RoomProfile` in rooms/_shared), sealed inside the room for its members; earlier versions keep it out of the room altogether. MUST NOT carry personal data.";
|
|
639
|
+
};
|
|
640
|
+
readonly StorageConfigId: {
|
|
641
|
+
readonly title: "StorageConfigId";
|
|
642
|
+
readonly type: "string";
|
|
643
|
+
readonly minLength: 1;
|
|
644
|
+
readonly maxLength: 64;
|
|
645
|
+
readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
|
|
646
|
+
readonly description: "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value.";
|
|
647
|
+
};
|
|
648
|
+
readonly HostedRoom: {
|
|
649
|
+
readonly title: "HostedRoom";
|
|
650
|
+
readonly type: "object";
|
|
651
|
+
readonly additionalProperties: false;
|
|
652
|
+
readonly required: readonly ["roomId", "ownerDid", "visibility", "retentionPolicy", "epoch", "lifecycle", "retentionDays", "createdAt", "updatedAt"];
|
|
653
|
+
readonly description: "One room, as its host holds it — member for member the `HostedRoom` of vtc/rooms/list/0.2, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.";
|
|
654
|
+
readonly properties: {
|
|
655
|
+
readonly roomId: {
|
|
656
|
+
readonly type: "string";
|
|
657
|
+
readonly minLength: 1;
|
|
658
|
+
readonly maxLength: 512;
|
|
659
|
+
};
|
|
660
|
+
readonly ownerDid: {
|
|
661
|
+
readonly type: "string";
|
|
662
|
+
readonly pattern: "^did:";
|
|
663
|
+
readonly maxLength: 2048;
|
|
664
|
+
};
|
|
665
|
+
readonly visibility: {
|
|
666
|
+
readonly $ref: "#/$defs/Visibility";
|
|
667
|
+
};
|
|
668
|
+
readonly retentionPolicy: {
|
|
669
|
+
readonly $ref: "#/$defs/RetentionPolicy";
|
|
670
|
+
};
|
|
671
|
+
readonly epoch: {
|
|
672
|
+
readonly type: "integer";
|
|
673
|
+
readonly minimum: 0;
|
|
674
|
+
};
|
|
675
|
+
readonly lifecycle: {
|
|
676
|
+
readonly type: "string";
|
|
677
|
+
readonly enum: readonly ["live", "lapsed", "dormant", "reclaimable"];
|
|
678
|
+
};
|
|
679
|
+
readonly epochExpiresAt: {
|
|
680
|
+
readonly type: "string";
|
|
681
|
+
readonly format: "date-time";
|
|
682
|
+
};
|
|
683
|
+
readonly retentionDays: {
|
|
684
|
+
readonly type: "integer";
|
|
685
|
+
readonly minimum: 0;
|
|
686
|
+
};
|
|
687
|
+
readonly mirrorOf: {
|
|
688
|
+
readonly type: "string";
|
|
689
|
+
readonly minLength: 1;
|
|
690
|
+
readonly maxLength: 2048;
|
|
691
|
+
};
|
|
692
|
+
readonly createdAt: {
|
|
693
|
+
readonly type: "string";
|
|
694
|
+
readonly format: "date-time";
|
|
695
|
+
};
|
|
696
|
+
readonly updatedAt: {
|
|
697
|
+
readonly type: "string";
|
|
698
|
+
readonly format: "date-time";
|
|
699
|
+
};
|
|
700
|
+
};
|
|
701
|
+
};
|
|
702
|
+
readonly RetentionPolicy: {
|
|
703
|
+
readonly title: "RetentionPolicy";
|
|
704
|
+
readonly type: "string";
|
|
705
|
+
readonly enum: readonly ["chained", "fromJoin"];
|
|
706
|
+
readonly description: "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.";
|
|
707
|
+
readonly $comment: "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it.";
|
|
708
|
+
};
|
|
709
|
+
readonly Visibility: {
|
|
710
|
+
readonly title: "Visibility";
|
|
711
|
+
readonly type: "string";
|
|
712
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
713
|
+
readonly description: "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything.";
|
|
714
|
+
};
|
|
715
|
+
};
|
|
716
|
+
};
|
|
717
|
+
/**
|
|
718
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
719
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
720
|
+
* per-specification and cannot be derived from the document alone, and
|
|
721
|
+
* item 2 needs the schema this carries.
|
|
722
|
+
*/
|
|
723
|
+
export declare const SPEC: {
|
|
724
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/rooms/community/get/0.4";
|
|
725
|
+
readonly isBearer: false;
|
|
726
|
+
readonly isProofRequired: false;
|
|
727
|
+
readonly isRecipientRequired: true;
|
|
728
|
+
readonly isIssuedAtRequired: false;
|
|
729
|
+
readonly payloadSchema: {
|
|
730
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
731
|
+
readonly $id: "https://trusttasks.org/spec/vtc/rooms/community/get/0.4";
|
|
732
|
+
readonly title: "VTC Rooms Community Get — payload";
|
|
733
|
+
readonly type: "object";
|
|
734
|
+
readonly additionalProperties: false;
|
|
735
|
+
readonly required: readonly ["roomId"];
|
|
736
|
+
readonly properties: {
|
|
737
|
+
readonly roomId: {
|
|
738
|
+
readonly type: "string";
|
|
739
|
+
readonly minLength: 1;
|
|
740
|
+
readonly maxLength: 512;
|
|
741
|
+
readonly description: "The room's identifier: its DID.";
|
|
742
|
+
};
|
|
743
|
+
readonly ext: {
|
|
744
|
+
readonly $ref: "#/$defs/Ext";
|
|
745
|
+
};
|
|
746
|
+
};
|
|
747
|
+
readonly $defs: {
|
|
748
|
+
readonly Response: {
|
|
749
|
+
readonly $anchor: "response";
|
|
750
|
+
readonly title: "VTC Rooms Community Get — response payload";
|
|
751
|
+
readonly description: "Success response to vtc/rooms/community/get. Type https://trusttasks.org/spec/vtc/rooms/community/get/0.4#response. One room the community owns, in any state of its owner's lifecycle, with its counts. Its members are vtc/rooms/community/members/list's.";
|
|
752
|
+
readonly type: "object";
|
|
753
|
+
readonly additionalProperties: false;
|
|
754
|
+
readonly required: readonly ["room"];
|
|
755
|
+
readonly properties: {
|
|
756
|
+
readonly room: {
|
|
757
|
+
readonly $ref: "#/$defs/CommunityRoomV3";
|
|
758
|
+
};
|
|
759
|
+
readonly ext: {
|
|
760
|
+
readonly $ref: "#/$defs/Ext";
|
|
761
|
+
};
|
|
762
|
+
};
|
|
763
|
+
};
|
|
764
|
+
readonly Ext: {
|
|
765
|
+
readonly title: "Ext";
|
|
766
|
+
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.";
|
|
767
|
+
readonly type: "object";
|
|
768
|
+
readonly minProperties: 1;
|
|
769
|
+
readonly additionalProperties: true;
|
|
770
|
+
readonly propertyNames: {
|
|
771
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
readonly CommunityRoomV3: {
|
|
775
|
+
readonly title: "CommunityRoomV3";
|
|
776
|
+
readonly type: "object";
|
|
777
|
+
readonly additionalProperties: false;
|
|
778
|
+
readonly required: readonly ["room", "label", "admitted", "offered", "status"];
|
|
779
|
+
readonly description: "What vtc/rooms/community/{get,list}/0.4 and vtc/rooms/community/{archive,unarchive,remove,removal/cancel}/0.1 return: `CommunityRoomV2` plus the room's `status` in its owner's lifecycle and the count of `suspended` admissions. A separate definition, not a change to `CommunityRoomV2`, so that the versions returning that keep the exact shape they published. For a room in state `purging` or `removed`, whose host record a purge deletes, `room` is the host record as it last stood before the purge began — the community keeps that snapshot with the room's record when the purge starts — and its `lifecycle` is what was computed then.";
|
|
780
|
+
readonly properties: {
|
|
781
|
+
readonly room: {
|
|
782
|
+
readonly $ref: "#/$defs/HostedRoom";
|
|
783
|
+
};
|
|
784
|
+
readonly label: {
|
|
785
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
786
|
+
};
|
|
787
|
+
readonly status: {
|
|
788
|
+
readonly $ref: "#/$defs/RoomStatus";
|
|
789
|
+
};
|
|
790
|
+
readonly description: {
|
|
791
|
+
readonly $ref: "#/$defs/RoomDescription";
|
|
792
|
+
readonly description: "Absent when the room has none.";
|
|
793
|
+
};
|
|
794
|
+
readonly tags: {
|
|
795
|
+
readonly $ref: "#/$defs/RoomTags";
|
|
796
|
+
readonly description: "Absent or empty when the room has none.";
|
|
797
|
+
};
|
|
798
|
+
readonly storageConfig: {
|
|
799
|
+
readonly $ref: "#/$defs/StorageConfigId";
|
|
800
|
+
readonly description: "The storage config receiving the room's new uploads.";
|
|
801
|
+
};
|
|
802
|
+
readonly admitted: {
|
|
803
|
+
readonly type: "integer";
|
|
804
|
+
readonly minimum: 0;
|
|
805
|
+
readonly description: "Members in state `admitted`.";
|
|
806
|
+
};
|
|
807
|
+
readonly offered: {
|
|
808
|
+
readonly type: "integer";
|
|
809
|
+
readonly minimum: 0;
|
|
810
|
+
readonly description: "Offers not yet accepted or withdrawn.";
|
|
811
|
+
};
|
|
812
|
+
readonly suspended: {
|
|
813
|
+
readonly type: "integer";
|
|
814
|
+
readonly minimum: 0;
|
|
815
|
+
readonly description: "Admissions in state `suspended`: withdrawn while the room was archived with `noAccess`, and restored when it leaves that state. Absent when zero.";
|
|
816
|
+
};
|
|
817
|
+
readonly ownerAuthorityValidUntil: {
|
|
818
|
+
readonly type: "string";
|
|
819
|
+
readonly format: "date-time";
|
|
820
|
+
readonly description: "When the community's own `admin` authority over the room expires. A room whose owner's authority lapses can no longer advance its epoch, admit or remove; a community SHOULD renew it well before.";
|
|
821
|
+
};
|
|
822
|
+
readonly createdBy: {
|
|
823
|
+
readonly type: "string";
|
|
824
|
+
readonly pattern: "^did:";
|
|
825
|
+
readonly maxLength: 2048;
|
|
826
|
+
readonly description: "The administrator who created it.";
|
|
827
|
+
};
|
|
828
|
+
readonly detailsUpdatedAt: {
|
|
829
|
+
readonly type: "string";
|
|
830
|
+
readonly format: "date-time";
|
|
831
|
+
readonly description: "When `label`, `description` or `tags` last changed. Absent until the first change after creation. Distinct from `room.updatedAt`, which is the host record's and moves with the room's epoch and lifecycle.";
|
|
832
|
+
};
|
|
833
|
+
readonly detailsUpdatedBy: {
|
|
834
|
+
readonly type: "string";
|
|
835
|
+
readonly pattern: "^did:";
|
|
836
|
+
readonly maxLength: 2048;
|
|
837
|
+
readonly description: "The administrator who made that change. Present exactly when `detailsUpdatedAt` is. The earlier values and who set them are in the community's audit trail, not here.";
|
|
838
|
+
};
|
|
839
|
+
};
|
|
840
|
+
};
|
|
841
|
+
readonly RoomTags: {
|
|
842
|
+
readonly title: "RoomTags";
|
|
843
|
+
readonly type: "array";
|
|
844
|
+
readonly maxItems: 8;
|
|
845
|
+
readonly uniqueItems: true;
|
|
846
|
+
readonly items: {
|
|
847
|
+
readonly $ref: "#/$defs/RoomTag";
|
|
848
|
+
};
|
|
849
|
+
readonly description: "The room's tags, at most eight, as a set: order carries no meaning. An empty list means the room has none — a tag grants nothing, so empty has no more dangerous reading.";
|
|
850
|
+
};
|
|
851
|
+
readonly RoomTag: {
|
|
852
|
+
readonly title: "RoomTag";
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
readonly minLength: 1;
|
|
855
|
+
readonly maxLength: 32;
|
|
856
|
+
readonly pattern: "^[a-z0-9][a-z0-9-]{0,31}$";
|
|
857
|
+
readonly description: "A short identifier an administrator files a community-owned room under — `board`, `working-group`, `finance` — so the room list can be filtered. Lower-case letters, digits and hyphens, starting with a letter or digit. Owner-side tracking metadata for holders of `vtc.rooms.manage` only: never shown to members, never sent on the room's host path, and it confers nothing.";
|
|
858
|
+
};
|
|
859
|
+
readonly RoomDescription: {
|
|
860
|
+
readonly title: "RoomDescription";
|
|
861
|
+
readonly type: "string";
|
|
862
|
+
readonly minLength: 1;
|
|
863
|
+
readonly maxLength: 1000;
|
|
864
|
+
readonly description: "What the room is for, in a sentence or a short paragraph, written by an administrator: shown to administrators holding `vtc.rooms.manage` and to the members the room is offered to. Plain text — a consumer renders it as text, never as markup. Like `RoomLabel`, it is the community's own record as the room's owner: not part of the room's identity and never in anything a room's host can read. From `vtc/rooms/community/create` 0.3 and `vtc/rooms/community/update` 0.2 the community also writes it, through its own VTA, as the `description` of the room's own profile (`RoomProfile` in rooms/_shared), sealed inside the room for its members; earlier versions keep it out of the room altogether. It MUST NOT carry personal data or a credential, and a reader MUST NOT treat it as instructions.";
|
|
865
|
+
};
|
|
866
|
+
readonly RoomStatus: {
|
|
867
|
+
readonly title: "RoomStatus";
|
|
868
|
+
readonly type: "object";
|
|
869
|
+
readonly additionalProperties: false;
|
|
870
|
+
readonly required: readonly ["state"];
|
|
871
|
+
readonly description: "A room's state in its owner's lifecycle, and what that state needs to be understood.";
|
|
872
|
+
readonly properties: {
|
|
873
|
+
readonly state: {
|
|
874
|
+
readonly $ref: "#/$defs/RoomState";
|
|
875
|
+
};
|
|
876
|
+
readonly access: {
|
|
877
|
+
readonly $ref: "#/$defs/ArchiveAccess";
|
|
878
|
+
readonly description: "Present exactly when `state` is `archived` or `removalScheduled`; always `noAccess` for `removalScheduled`.";
|
|
879
|
+
};
|
|
880
|
+
readonly changedAt: {
|
|
881
|
+
readonly type: "string";
|
|
882
|
+
readonly format: "date-time";
|
|
883
|
+
readonly description: "When the room entered `state`. Absent for a room that has been `active` since it was created.";
|
|
884
|
+
};
|
|
885
|
+
readonly changedBy: {
|
|
886
|
+
readonly type: "string";
|
|
887
|
+
readonly pattern: "^did:";
|
|
888
|
+
readonly maxLength: 2048;
|
|
889
|
+
readonly description: "The administrator whose act put the room in `state`. Present exactly when `changedAt` is, except for `purging` and `removed` reached when a grace period ended, which no one did at that moment: then the administrator who scheduled the removal. The reason each gave is in the community's audit trail, not here.";
|
|
890
|
+
};
|
|
891
|
+
readonly purgeAt: {
|
|
892
|
+
readonly type: "string";
|
|
893
|
+
readonly format: "date-time";
|
|
894
|
+
readonly description: "Present when `state` is `removalScheduled`: when the grace period ends and the purge begins. Kept when `state` is `purging` or `removed`, as when it became due.";
|
|
895
|
+
};
|
|
896
|
+
readonly purge: {
|
|
897
|
+
readonly $ref: "#/$defs/PurgeProgress";
|
|
898
|
+
readonly description: "Present exactly when `state` is `purging`.";
|
|
899
|
+
};
|
|
900
|
+
readonly removedAt: {
|
|
901
|
+
readonly type: "string";
|
|
902
|
+
readonly format: "date-time";
|
|
903
|
+
readonly description: "Present exactly when `state` is `removed`: when the last of the room's content was deleted.";
|
|
904
|
+
};
|
|
905
|
+
readonly restoring: {
|
|
906
|
+
readonly type: "integer";
|
|
907
|
+
readonly minimum: 1;
|
|
908
|
+
readonly description: "Admissions still `suspended` that the community is restoring, after the room left `noAccess` — the room re-issues each member's credentials and the member collects them as a renewal. Absent when there are none.";
|
|
909
|
+
};
|
|
910
|
+
readonly pendingChange: {
|
|
911
|
+
readonly $ref: "#/$defs/PendingChange";
|
|
912
|
+
readonly description: "Present while a change of state is begun and not finished.";
|
|
913
|
+
};
|
|
914
|
+
};
|
|
915
|
+
};
|
|
916
|
+
readonly PendingChange: {
|
|
917
|
+
readonly title: "PendingChange";
|
|
918
|
+
readonly type: "object";
|
|
919
|
+
readonly additionalProperties: false;
|
|
920
|
+
readonly required: readonly ["state", "beganAt"];
|
|
921
|
+
readonly description: "A change of state the community began and has not finished, because a step at its VTA did not complete — most often a room reset the host accepted, after which the community's own credentials must be re-issued before it can act on the room again. `RoomStatus.state` stays what it was until the change finishes, but what the room's host enforces may already be the new state's: a pending move to `noAccess` means members' credentials may already be refused. The community finishes it by itself, retrying with backoff, and repeating the request that began it finishes it too; nothing else changes the room until it is finished.";
|
|
922
|
+
readonly properties: {
|
|
923
|
+
readonly state: {
|
|
924
|
+
readonly $ref: "#/$defs/RoomState";
|
|
925
|
+
readonly description: "The state the change leads to.";
|
|
926
|
+
};
|
|
927
|
+
readonly access: {
|
|
928
|
+
readonly $ref: "#/$defs/ArchiveAccess";
|
|
929
|
+
readonly description: "The access it leads to, where `state` has one.";
|
|
930
|
+
};
|
|
931
|
+
readonly beganAt: {
|
|
932
|
+
readonly type: "string";
|
|
933
|
+
readonly format: "date-time";
|
|
934
|
+
};
|
|
935
|
+
readonly lastError: {
|
|
936
|
+
readonly type: "string";
|
|
937
|
+
readonly minLength: 1;
|
|
938
|
+
readonly maxLength: 500;
|
|
939
|
+
readonly description: "What stopped the last attempt, for an administrator. Plain text; it names no member and carries no credential.";
|
|
940
|
+
};
|
|
941
|
+
};
|
|
942
|
+
};
|
|
943
|
+
readonly ArchiveAccess: {
|
|
944
|
+
readonly title: "ArchiveAccess";
|
|
945
|
+
readonly type: "string";
|
|
946
|
+
readonly enum: readonly ["readOnly", "noAccess"];
|
|
947
|
+
readonly description: "What an archived room's members may still do. `readOnly`: their credentials stand and they keep reading what the room holds; the room's host refuses every write, upload and curation from a member. `noAccess`: every credential the room issued before the archival is withdrawn at its host — a room reset — so the host refuses every member's every task; the content is kept intact, and each withdrawn admission is `suspended`, restored when the room is unarchived or made `readOnly`. Neither recalls what a member already read or saved, and on a sealed tier neither removes anyone from the room's group.";
|
|
948
|
+
};
|
|
949
|
+
readonly RoomState: {
|
|
950
|
+
readonly title: "RoomState";
|
|
951
|
+
readonly type: "string";
|
|
952
|
+
readonly enum: readonly ["active", "archived", "removalScheduled", "purging", "removed"];
|
|
953
|
+
readonly description: "Where a room the community owns stands in its owner's lifecycle — distinct from `HostedRoom.lifecycle`, which is the host's clock (`live`, `lapsed`, `dormant`, `reclaimable`) and is computed from the room's epoch, never set. `active`: open to change. `archived`: closed to change by an administrator — no admissions, and the room's host accepts no writes from its members; what members may still do is `ArchiveAccess`. Reversible with vtc/rooms/community/unarchive. `removalScheduled`: an administrator removed the room with a grace period; it admits nobody and its content is kept until `purgeAt`, and vtc/rooms/community/removal/cancel returns it to `archived`. `purging`: the grace period ended (or there was none) and the community is deleting the room's content from its host and storage; not reversible. `removed`: the content is gone; the community keeps only this record of the room, for its history.";
|
|
954
|
+
};
|
|
955
|
+
readonly PurgeProgress: {
|
|
956
|
+
readonly title: "PurgeProgress";
|
|
957
|
+
readonly type: "object";
|
|
958
|
+
readonly additionalProperties: false;
|
|
959
|
+
readonly required: readonly ["attempts"];
|
|
960
|
+
readonly description: "How a purge is going. A purge deletes at the room's host and at each storage config holding its files, and some of those are remote; a step that fails is retried with backoff until it succeeds, and nothing is reported removed until every step has.";
|
|
961
|
+
readonly properties: {
|
|
962
|
+
readonly attempts: {
|
|
963
|
+
readonly type: "integer";
|
|
964
|
+
readonly minimum: 0;
|
|
965
|
+
readonly description: "Passes made so far; 0 until the first.";
|
|
966
|
+
};
|
|
967
|
+
readonly lastAttemptAt: {
|
|
968
|
+
readonly type: "string";
|
|
969
|
+
readonly format: "date-time";
|
|
970
|
+
};
|
|
971
|
+
readonly nextAttemptAt: {
|
|
972
|
+
readonly type: "string";
|
|
973
|
+
readonly format: "date-time";
|
|
974
|
+
readonly description: "When the next pass is due. Absent while one runs.";
|
|
975
|
+
};
|
|
976
|
+
readonly lastError: {
|
|
977
|
+
readonly type: "string";
|
|
978
|
+
readonly minLength: 1;
|
|
979
|
+
readonly maxLength: 500;
|
|
980
|
+
readonly description: "What stopped the last pass, for an administrator. Present only after a pass failed. Plain text, written by the community; it names no member and carries no credential.";
|
|
981
|
+
};
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
readonly RoomLabel: {
|
|
985
|
+
readonly title: "RoomLabel";
|
|
986
|
+
readonly type: "string";
|
|
987
|
+
readonly minLength: 1;
|
|
988
|
+
readonly maxLength: 128;
|
|
989
|
+
readonly description: "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and never in anything a room's host can read. From `vtc/rooms/community/create` 0.3 and `vtc/rooms/community/update` 0.2 the community also writes it, through its own VTA, as the `name` of the room's own profile (`RoomProfile` in rooms/_shared), sealed inside the room for its members; earlier versions keep it out of the room altogether. MUST NOT carry personal data.";
|
|
990
|
+
};
|
|
991
|
+
readonly StorageConfigId: {
|
|
992
|
+
readonly title: "StorageConfigId";
|
|
993
|
+
readonly type: "string";
|
|
994
|
+
readonly minLength: 1;
|
|
995
|
+
readonly maxLength: 64;
|
|
996
|
+
readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
|
|
997
|
+
readonly description: "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value.";
|
|
998
|
+
};
|
|
999
|
+
readonly HostedRoom: {
|
|
1000
|
+
readonly title: "HostedRoom";
|
|
1001
|
+
readonly type: "object";
|
|
1002
|
+
readonly additionalProperties: false;
|
|
1003
|
+
readonly required: readonly ["roomId", "ownerDid", "visibility", "retentionPolicy", "epoch", "lifecycle", "retentionDays", "createdAt", "updatedAt"];
|
|
1004
|
+
readonly description: "One room, as its host holds it — member for member the `HostedRoom` of vtc/rooms/list/0.2, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.";
|
|
1005
|
+
readonly properties: {
|
|
1006
|
+
readonly roomId: {
|
|
1007
|
+
readonly type: "string";
|
|
1008
|
+
readonly minLength: 1;
|
|
1009
|
+
readonly maxLength: 512;
|
|
1010
|
+
};
|
|
1011
|
+
readonly ownerDid: {
|
|
1012
|
+
readonly type: "string";
|
|
1013
|
+
readonly pattern: "^did:";
|
|
1014
|
+
readonly maxLength: 2048;
|
|
1015
|
+
};
|
|
1016
|
+
readonly visibility: {
|
|
1017
|
+
readonly $ref: "#/$defs/Visibility";
|
|
1018
|
+
};
|
|
1019
|
+
readonly retentionPolicy: {
|
|
1020
|
+
readonly $ref: "#/$defs/RetentionPolicy";
|
|
1021
|
+
};
|
|
1022
|
+
readonly epoch: {
|
|
1023
|
+
readonly type: "integer";
|
|
1024
|
+
readonly minimum: 0;
|
|
1025
|
+
};
|
|
1026
|
+
readonly lifecycle: {
|
|
1027
|
+
readonly type: "string";
|
|
1028
|
+
readonly enum: readonly ["live", "lapsed", "dormant", "reclaimable"];
|
|
1029
|
+
};
|
|
1030
|
+
readonly epochExpiresAt: {
|
|
1031
|
+
readonly type: "string";
|
|
1032
|
+
readonly format: "date-time";
|
|
1033
|
+
};
|
|
1034
|
+
readonly retentionDays: {
|
|
1035
|
+
readonly type: "integer";
|
|
1036
|
+
readonly minimum: 0;
|
|
1037
|
+
};
|
|
1038
|
+
readonly mirrorOf: {
|
|
1039
|
+
readonly type: "string";
|
|
1040
|
+
readonly minLength: 1;
|
|
1041
|
+
readonly maxLength: 2048;
|
|
1042
|
+
};
|
|
1043
|
+
readonly createdAt: {
|
|
1044
|
+
readonly type: "string";
|
|
1045
|
+
readonly format: "date-time";
|
|
1046
|
+
};
|
|
1047
|
+
readonly updatedAt: {
|
|
1048
|
+
readonly type: "string";
|
|
1049
|
+
readonly format: "date-time";
|
|
1050
|
+
};
|
|
1051
|
+
};
|
|
1052
|
+
};
|
|
1053
|
+
readonly RetentionPolicy: {
|
|
1054
|
+
readonly title: "RetentionPolicy";
|
|
1055
|
+
readonly type: "string";
|
|
1056
|
+
readonly enum: readonly ["chained", "fromJoin"];
|
|
1057
|
+
readonly description: "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.";
|
|
1058
|
+
readonly $comment: "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it.";
|
|
1059
|
+
};
|
|
1060
|
+
readonly Visibility: {
|
|
1061
|
+
readonly title: "Visibility";
|
|
1062
|
+
readonly type: "string";
|
|
1063
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
1064
|
+
readonly description: "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything.";
|
|
1065
|
+
};
|
|
1066
|
+
};
|
|
1067
|
+
};
|
|
1068
|
+
};
|
|
1069
|
+
/**
|
|
1070
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
1071
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
1072
|
+
* parties (§7.3 item 5).
|
|
1073
|
+
*/
|
|
1074
|
+
export declare const RESPONSE_SPEC: {
|
|
1075
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/rooms/community/get/0.4#response";
|
|
1076
|
+
readonly isBearer: false;
|
|
1077
|
+
readonly isProofRequired: false;
|
|
1078
|
+
readonly isRecipientRequired: true;
|
|
1079
|
+
readonly isIssuedAtRequired: false;
|
|
1080
|
+
readonly payloadSchema: {
|
|
1081
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
1082
|
+
readonly $ref: "#/$defs/Response";
|
|
1083
|
+
readonly $defs: {
|
|
1084
|
+
readonly Response: {
|
|
1085
|
+
readonly $anchor: "response";
|
|
1086
|
+
readonly title: "VTC Rooms Community Get — response payload";
|
|
1087
|
+
readonly description: "Success response to vtc/rooms/community/get. Type https://trusttasks.org/spec/vtc/rooms/community/get/0.4#response. One room the community owns, in any state of its owner's lifecycle, with its counts. Its members are vtc/rooms/community/members/list's.";
|
|
1088
|
+
readonly type: "object";
|
|
1089
|
+
readonly additionalProperties: false;
|
|
1090
|
+
readonly required: readonly ["room"];
|
|
1091
|
+
readonly properties: {
|
|
1092
|
+
readonly room: {
|
|
1093
|
+
readonly $ref: "#/$defs/CommunityRoomV3";
|
|
1094
|
+
};
|
|
1095
|
+
readonly ext: {
|
|
1096
|
+
readonly $ref: "#/$defs/Ext";
|
|
1097
|
+
};
|
|
1098
|
+
};
|
|
1099
|
+
};
|
|
1100
|
+
readonly Ext: {
|
|
1101
|
+
readonly title: "Ext";
|
|
1102
|
+
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.";
|
|
1103
|
+
readonly type: "object";
|
|
1104
|
+
readonly minProperties: 1;
|
|
1105
|
+
readonly additionalProperties: true;
|
|
1106
|
+
readonly propertyNames: {
|
|
1107
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
1108
|
+
};
|
|
1109
|
+
};
|
|
1110
|
+
readonly CommunityRoomV3: {
|
|
1111
|
+
readonly title: "CommunityRoomV3";
|
|
1112
|
+
readonly type: "object";
|
|
1113
|
+
readonly additionalProperties: false;
|
|
1114
|
+
readonly required: readonly ["room", "label", "admitted", "offered", "status"];
|
|
1115
|
+
readonly description: "What vtc/rooms/community/{get,list}/0.4 and vtc/rooms/community/{archive,unarchive,remove,removal/cancel}/0.1 return: `CommunityRoomV2` plus the room's `status` in its owner's lifecycle and the count of `suspended` admissions. A separate definition, not a change to `CommunityRoomV2`, so that the versions returning that keep the exact shape they published. For a room in state `purging` or `removed`, whose host record a purge deletes, `room` is the host record as it last stood before the purge began — the community keeps that snapshot with the room's record when the purge starts — and its `lifecycle` is what was computed then.";
|
|
1116
|
+
readonly properties: {
|
|
1117
|
+
readonly room: {
|
|
1118
|
+
readonly $ref: "#/$defs/HostedRoom";
|
|
1119
|
+
};
|
|
1120
|
+
readonly label: {
|
|
1121
|
+
readonly $ref: "#/$defs/RoomLabel";
|
|
1122
|
+
};
|
|
1123
|
+
readonly status: {
|
|
1124
|
+
readonly $ref: "#/$defs/RoomStatus";
|
|
1125
|
+
};
|
|
1126
|
+
readonly description: {
|
|
1127
|
+
readonly $ref: "#/$defs/RoomDescription";
|
|
1128
|
+
readonly description: "Absent when the room has none.";
|
|
1129
|
+
};
|
|
1130
|
+
readonly tags: {
|
|
1131
|
+
readonly $ref: "#/$defs/RoomTags";
|
|
1132
|
+
readonly description: "Absent or empty when the room has none.";
|
|
1133
|
+
};
|
|
1134
|
+
readonly storageConfig: {
|
|
1135
|
+
readonly $ref: "#/$defs/StorageConfigId";
|
|
1136
|
+
readonly description: "The storage config receiving the room's new uploads.";
|
|
1137
|
+
};
|
|
1138
|
+
readonly admitted: {
|
|
1139
|
+
readonly type: "integer";
|
|
1140
|
+
readonly minimum: 0;
|
|
1141
|
+
readonly description: "Members in state `admitted`.";
|
|
1142
|
+
};
|
|
1143
|
+
readonly offered: {
|
|
1144
|
+
readonly type: "integer";
|
|
1145
|
+
readonly minimum: 0;
|
|
1146
|
+
readonly description: "Offers not yet accepted or withdrawn.";
|
|
1147
|
+
};
|
|
1148
|
+
readonly suspended: {
|
|
1149
|
+
readonly type: "integer";
|
|
1150
|
+
readonly minimum: 0;
|
|
1151
|
+
readonly description: "Admissions in state `suspended`: withdrawn while the room was archived with `noAccess`, and restored when it leaves that state. Absent when zero.";
|
|
1152
|
+
};
|
|
1153
|
+
readonly ownerAuthorityValidUntil: {
|
|
1154
|
+
readonly type: "string";
|
|
1155
|
+
readonly format: "date-time";
|
|
1156
|
+
readonly description: "When the community's own `admin` authority over the room expires. A room whose owner's authority lapses can no longer advance its epoch, admit or remove; a community SHOULD renew it well before.";
|
|
1157
|
+
};
|
|
1158
|
+
readonly createdBy: {
|
|
1159
|
+
readonly type: "string";
|
|
1160
|
+
readonly pattern: "^did:";
|
|
1161
|
+
readonly maxLength: 2048;
|
|
1162
|
+
readonly description: "The administrator who created it.";
|
|
1163
|
+
};
|
|
1164
|
+
readonly detailsUpdatedAt: {
|
|
1165
|
+
readonly type: "string";
|
|
1166
|
+
readonly format: "date-time";
|
|
1167
|
+
readonly description: "When `label`, `description` or `tags` last changed. Absent until the first change after creation. Distinct from `room.updatedAt`, which is the host record's and moves with the room's epoch and lifecycle.";
|
|
1168
|
+
};
|
|
1169
|
+
readonly detailsUpdatedBy: {
|
|
1170
|
+
readonly type: "string";
|
|
1171
|
+
readonly pattern: "^did:";
|
|
1172
|
+
readonly maxLength: 2048;
|
|
1173
|
+
readonly description: "The administrator who made that change. Present exactly when `detailsUpdatedAt` is. The earlier values and who set them are in the community's audit trail, not here.";
|
|
1174
|
+
};
|
|
1175
|
+
};
|
|
1176
|
+
};
|
|
1177
|
+
readonly RoomTags: {
|
|
1178
|
+
readonly title: "RoomTags";
|
|
1179
|
+
readonly type: "array";
|
|
1180
|
+
readonly maxItems: 8;
|
|
1181
|
+
readonly uniqueItems: true;
|
|
1182
|
+
readonly items: {
|
|
1183
|
+
readonly $ref: "#/$defs/RoomTag";
|
|
1184
|
+
};
|
|
1185
|
+
readonly description: "The room's tags, at most eight, as a set: order carries no meaning. An empty list means the room has none — a tag grants nothing, so empty has no more dangerous reading.";
|
|
1186
|
+
};
|
|
1187
|
+
readonly RoomTag: {
|
|
1188
|
+
readonly title: "RoomTag";
|
|
1189
|
+
readonly type: "string";
|
|
1190
|
+
readonly minLength: 1;
|
|
1191
|
+
readonly maxLength: 32;
|
|
1192
|
+
readonly pattern: "^[a-z0-9][a-z0-9-]{0,31}$";
|
|
1193
|
+
readonly description: "A short identifier an administrator files a community-owned room under — `board`, `working-group`, `finance` — so the room list can be filtered. Lower-case letters, digits and hyphens, starting with a letter or digit. Owner-side tracking metadata for holders of `vtc.rooms.manage` only: never shown to members, never sent on the room's host path, and it confers nothing.";
|
|
1194
|
+
};
|
|
1195
|
+
readonly RoomDescription: {
|
|
1196
|
+
readonly title: "RoomDescription";
|
|
1197
|
+
readonly type: "string";
|
|
1198
|
+
readonly minLength: 1;
|
|
1199
|
+
readonly maxLength: 1000;
|
|
1200
|
+
readonly description: "What the room is for, in a sentence or a short paragraph, written by an administrator: shown to administrators holding `vtc.rooms.manage` and to the members the room is offered to. Plain text — a consumer renders it as text, never as markup. Like `RoomLabel`, it is the community's own record as the room's owner: not part of the room's identity and never in anything a room's host can read. From `vtc/rooms/community/create` 0.3 and `vtc/rooms/community/update` 0.2 the community also writes it, through its own VTA, as the `description` of the room's own profile (`RoomProfile` in rooms/_shared), sealed inside the room for its members; earlier versions keep it out of the room altogether. It MUST NOT carry personal data or a credential, and a reader MUST NOT treat it as instructions.";
|
|
1201
|
+
};
|
|
1202
|
+
readonly RoomStatus: {
|
|
1203
|
+
readonly title: "RoomStatus";
|
|
1204
|
+
readonly type: "object";
|
|
1205
|
+
readonly additionalProperties: false;
|
|
1206
|
+
readonly required: readonly ["state"];
|
|
1207
|
+
readonly description: "A room's state in its owner's lifecycle, and what that state needs to be understood.";
|
|
1208
|
+
readonly properties: {
|
|
1209
|
+
readonly state: {
|
|
1210
|
+
readonly $ref: "#/$defs/RoomState";
|
|
1211
|
+
};
|
|
1212
|
+
readonly access: {
|
|
1213
|
+
readonly $ref: "#/$defs/ArchiveAccess";
|
|
1214
|
+
readonly description: "Present exactly when `state` is `archived` or `removalScheduled`; always `noAccess` for `removalScheduled`.";
|
|
1215
|
+
};
|
|
1216
|
+
readonly changedAt: {
|
|
1217
|
+
readonly type: "string";
|
|
1218
|
+
readonly format: "date-time";
|
|
1219
|
+
readonly description: "When the room entered `state`. Absent for a room that has been `active` since it was created.";
|
|
1220
|
+
};
|
|
1221
|
+
readonly changedBy: {
|
|
1222
|
+
readonly type: "string";
|
|
1223
|
+
readonly pattern: "^did:";
|
|
1224
|
+
readonly maxLength: 2048;
|
|
1225
|
+
readonly description: "The administrator whose act put the room in `state`. Present exactly when `changedAt` is, except for `purging` and `removed` reached when a grace period ended, which no one did at that moment: then the administrator who scheduled the removal. The reason each gave is in the community's audit trail, not here.";
|
|
1226
|
+
};
|
|
1227
|
+
readonly purgeAt: {
|
|
1228
|
+
readonly type: "string";
|
|
1229
|
+
readonly format: "date-time";
|
|
1230
|
+
readonly description: "Present when `state` is `removalScheduled`: when the grace period ends and the purge begins. Kept when `state` is `purging` or `removed`, as when it became due.";
|
|
1231
|
+
};
|
|
1232
|
+
readonly purge: {
|
|
1233
|
+
readonly $ref: "#/$defs/PurgeProgress";
|
|
1234
|
+
readonly description: "Present exactly when `state` is `purging`.";
|
|
1235
|
+
};
|
|
1236
|
+
readonly removedAt: {
|
|
1237
|
+
readonly type: "string";
|
|
1238
|
+
readonly format: "date-time";
|
|
1239
|
+
readonly description: "Present exactly when `state` is `removed`: when the last of the room's content was deleted.";
|
|
1240
|
+
};
|
|
1241
|
+
readonly restoring: {
|
|
1242
|
+
readonly type: "integer";
|
|
1243
|
+
readonly minimum: 1;
|
|
1244
|
+
readonly description: "Admissions still `suspended` that the community is restoring, after the room left `noAccess` — the room re-issues each member's credentials and the member collects them as a renewal. Absent when there are none.";
|
|
1245
|
+
};
|
|
1246
|
+
readonly pendingChange: {
|
|
1247
|
+
readonly $ref: "#/$defs/PendingChange";
|
|
1248
|
+
readonly description: "Present while a change of state is begun and not finished.";
|
|
1249
|
+
};
|
|
1250
|
+
};
|
|
1251
|
+
};
|
|
1252
|
+
readonly PendingChange: {
|
|
1253
|
+
readonly title: "PendingChange";
|
|
1254
|
+
readonly type: "object";
|
|
1255
|
+
readonly additionalProperties: false;
|
|
1256
|
+
readonly required: readonly ["state", "beganAt"];
|
|
1257
|
+
readonly description: "A change of state the community began and has not finished, because a step at its VTA did not complete — most often a room reset the host accepted, after which the community's own credentials must be re-issued before it can act on the room again. `RoomStatus.state` stays what it was until the change finishes, but what the room's host enforces may already be the new state's: a pending move to `noAccess` means members' credentials may already be refused. The community finishes it by itself, retrying with backoff, and repeating the request that began it finishes it too; nothing else changes the room until it is finished.";
|
|
1258
|
+
readonly properties: {
|
|
1259
|
+
readonly state: {
|
|
1260
|
+
readonly $ref: "#/$defs/RoomState";
|
|
1261
|
+
readonly description: "The state the change leads to.";
|
|
1262
|
+
};
|
|
1263
|
+
readonly access: {
|
|
1264
|
+
readonly $ref: "#/$defs/ArchiveAccess";
|
|
1265
|
+
readonly description: "The access it leads to, where `state` has one.";
|
|
1266
|
+
};
|
|
1267
|
+
readonly beganAt: {
|
|
1268
|
+
readonly type: "string";
|
|
1269
|
+
readonly format: "date-time";
|
|
1270
|
+
};
|
|
1271
|
+
readonly lastError: {
|
|
1272
|
+
readonly type: "string";
|
|
1273
|
+
readonly minLength: 1;
|
|
1274
|
+
readonly maxLength: 500;
|
|
1275
|
+
readonly description: "What stopped the last attempt, for an administrator. Plain text; it names no member and carries no credential.";
|
|
1276
|
+
};
|
|
1277
|
+
};
|
|
1278
|
+
};
|
|
1279
|
+
readonly ArchiveAccess: {
|
|
1280
|
+
readonly title: "ArchiveAccess";
|
|
1281
|
+
readonly type: "string";
|
|
1282
|
+
readonly enum: readonly ["readOnly", "noAccess"];
|
|
1283
|
+
readonly description: "What an archived room's members may still do. `readOnly`: their credentials stand and they keep reading what the room holds; the room's host refuses every write, upload and curation from a member. `noAccess`: every credential the room issued before the archival is withdrawn at its host — a room reset — so the host refuses every member's every task; the content is kept intact, and each withdrawn admission is `suspended`, restored when the room is unarchived or made `readOnly`. Neither recalls what a member already read or saved, and on a sealed tier neither removes anyone from the room's group.";
|
|
1284
|
+
};
|
|
1285
|
+
readonly RoomState: {
|
|
1286
|
+
readonly title: "RoomState";
|
|
1287
|
+
readonly type: "string";
|
|
1288
|
+
readonly enum: readonly ["active", "archived", "removalScheduled", "purging", "removed"];
|
|
1289
|
+
readonly description: "Where a room the community owns stands in its owner's lifecycle — distinct from `HostedRoom.lifecycle`, which is the host's clock (`live`, `lapsed`, `dormant`, `reclaimable`) and is computed from the room's epoch, never set. `active`: open to change. `archived`: closed to change by an administrator — no admissions, and the room's host accepts no writes from its members; what members may still do is `ArchiveAccess`. Reversible with vtc/rooms/community/unarchive. `removalScheduled`: an administrator removed the room with a grace period; it admits nobody and its content is kept until `purgeAt`, and vtc/rooms/community/removal/cancel returns it to `archived`. `purging`: the grace period ended (or there was none) and the community is deleting the room's content from its host and storage; not reversible. `removed`: the content is gone; the community keeps only this record of the room, for its history.";
|
|
1290
|
+
};
|
|
1291
|
+
readonly PurgeProgress: {
|
|
1292
|
+
readonly title: "PurgeProgress";
|
|
1293
|
+
readonly type: "object";
|
|
1294
|
+
readonly additionalProperties: false;
|
|
1295
|
+
readonly required: readonly ["attempts"];
|
|
1296
|
+
readonly description: "How a purge is going. A purge deletes at the room's host and at each storage config holding its files, and some of those are remote; a step that fails is retried with backoff until it succeeds, and nothing is reported removed until every step has.";
|
|
1297
|
+
readonly properties: {
|
|
1298
|
+
readonly attempts: {
|
|
1299
|
+
readonly type: "integer";
|
|
1300
|
+
readonly minimum: 0;
|
|
1301
|
+
readonly description: "Passes made so far; 0 until the first.";
|
|
1302
|
+
};
|
|
1303
|
+
readonly lastAttemptAt: {
|
|
1304
|
+
readonly type: "string";
|
|
1305
|
+
readonly format: "date-time";
|
|
1306
|
+
};
|
|
1307
|
+
readonly nextAttemptAt: {
|
|
1308
|
+
readonly type: "string";
|
|
1309
|
+
readonly format: "date-time";
|
|
1310
|
+
readonly description: "When the next pass is due. Absent while one runs.";
|
|
1311
|
+
};
|
|
1312
|
+
readonly lastError: {
|
|
1313
|
+
readonly type: "string";
|
|
1314
|
+
readonly minLength: 1;
|
|
1315
|
+
readonly maxLength: 500;
|
|
1316
|
+
readonly description: "What stopped the last pass, for an administrator. Present only after a pass failed. Plain text, written by the community; it names no member and carries no credential.";
|
|
1317
|
+
};
|
|
1318
|
+
};
|
|
1319
|
+
};
|
|
1320
|
+
readonly RoomLabel: {
|
|
1321
|
+
readonly title: "RoomLabel";
|
|
1322
|
+
readonly type: "string";
|
|
1323
|
+
readonly minLength: 1;
|
|
1324
|
+
readonly maxLength: 128;
|
|
1325
|
+
readonly description: "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and never in anything a room's host can read. From `vtc/rooms/community/create` 0.3 and `vtc/rooms/community/update` 0.2 the community also writes it, through its own VTA, as the `name` of the room's own profile (`RoomProfile` in rooms/_shared), sealed inside the room for its members; earlier versions keep it out of the room altogether. MUST NOT carry personal data.";
|
|
1326
|
+
};
|
|
1327
|
+
readonly StorageConfigId: {
|
|
1328
|
+
readonly title: "StorageConfigId";
|
|
1329
|
+
readonly type: "string";
|
|
1330
|
+
readonly minLength: 1;
|
|
1331
|
+
readonly maxLength: 64;
|
|
1332
|
+
readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
|
|
1333
|
+
readonly description: "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value.";
|
|
1334
|
+
};
|
|
1335
|
+
readonly HostedRoom: {
|
|
1336
|
+
readonly title: "HostedRoom";
|
|
1337
|
+
readonly type: "object";
|
|
1338
|
+
readonly additionalProperties: false;
|
|
1339
|
+
readonly required: readonly ["roomId", "ownerDid", "visibility", "retentionPolicy", "epoch", "lifecycle", "retentionDays", "createdAt", "updatedAt"];
|
|
1340
|
+
readonly description: "One room, as its host holds it — member for member the `HostedRoom` of vtc/rooms/list/0.2, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.";
|
|
1341
|
+
readonly properties: {
|
|
1342
|
+
readonly roomId: {
|
|
1343
|
+
readonly type: "string";
|
|
1344
|
+
readonly minLength: 1;
|
|
1345
|
+
readonly maxLength: 512;
|
|
1346
|
+
};
|
|
1347
|
+
readonly ownerDid: {
|
|
1348
|
+
readonly type: "string";
|
|
1349
|
+
readonly pattern: "^did:";
|
|
1350
|
+
readonly maxLength: 2048;
|
|
1351
|
+
};
|
|
1352
|
+
readonly visibility: {
|
|
1353
|
+
readonly $ref: "#/$defs/Visibility";
|
|
1354
|
+
};
|
|
1355
|
+
readonly retentionPolicy: {
|
|
1356
|
+
readonly $ref: "#/$defs/RetentionPolicy";
|
|
1357
|
+
};
|
|
1358
|
+
readonly epoch: {
|
|
1359
|
+
readonly type: "integer";
|
|
1360
|
+
readonly minimum: 0;
|
|
1361
|
+
};
|
|
1362
|
+
readonly lifecycle: {
|
|
1363
|
+
readonly type: "string";
|
|
1364
|
+
readonly enum: readonly ["live", "lapsed", "dormant", "reclaimable"];
|
|
1365
|
+
};
|
|
1366
|
+
readonly epochExpiresAt: {
|
|
1367
|
+
readonly type: "string";
|
|
1368
|
+
readonly format: "date-time";
|
|
1369
|
+
};
|
|
1370
|
+
readonly retentionDays: {
|
|
1371
|
+
readonly type: "integer";
|
|
1372
|
+
readonly minimum: 0;
|
|
1373
|
+
};
|
|
1374
|
+
readonly mirrorOf: {
|
|
1375
|
+
readonly type: "string";
|
|
1376
|
+
readonly minLength: 1;
|
|
1377
|
+
readonly maxLength: 2048;
|
|
1378
|
+
};
|
|
1379
|
+
readonly createdAt: {
|
|
1380
|
+
readonly type: "string";
|
|
1381
|
+
readonly format: "date-time";
|
|
1382
|
+
};
|
|
1383
|
+
readonly updatedAt: {
|
|
1384
|
+
readonly type: "string";
|
|
1385
|
+
readonly format: "date-time";
|
|
1386
|
+
};
|
|
1387
|
+
};
|
|
1388
|
+
};
|
|
1389
|
+
readonly RetentionPolicy: {
|
|
1390
|
+
readonly title: "RetentionPolicy";
|
|
1391
|
+
readonly type: "string";
|
|
1392
|
+
readonly enum: readonly ["chained", "fromJoin"];
|
|
1393
|
+
readonly description: "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.";
|
|
1394
|
+
readonly $comment: "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it.";
|
|
1395
|
+
};
|
|
1396
|
+
readonly Visibility: {
|
|
1397
|
+
readonly title: "Visibility";
|
|
1398
|
+
readonly type: "string";
|
|
1399
|
+
readonly enum: readonly ["open", "attributed", "private"];
|
|
1400
|
+
readonly description: "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything.";
|
|
1401
|
+
};
|
|
1402
|
+
};
|
|
1403
|
+
};
|
|
1404
|
+
};
|
|
1405
|
+
//# sourceMappingURL=payload.d.ts.map
|