@openvtc/trust-tasks 0.28.2 → 0.28.4
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 +146 -0
- package/dist/_extends.d.ts.map +1 -1
- package/dist/_extends.js +9 -1
- package/dist/_extends.js.map +1 -1
- package/dist/_shared/components.d.ts +530 -3
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +66 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +66 -0
- package/dist/index.js.map +1 -1
- package/dist/peer-check/ask/0.1/payload.d.ts +397 -0
- package/dist/peer-check/ask/0.1/payload.d.ts.map +1 -0
- package/dist/peer-check/ask/0.1/payload.js +235 -0
- package/dist/peer-check/ask/0.1/payload.js.map +1 -0
- package/dist/rooms/keys/act/0.1/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.1/payload.js +1 -1
- package/dist/rooms/keys/act/0.2/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.2/payload.js +1 -1
- package/dist/rooms/keys/act/0.3/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.3/payload.js +1 -1
- package/dist/rooms/keys/act/0.4/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.4/payload.js +1 -1
- package/dist/rooms/keys/act/0.5/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.5/payload.js +1 -1
- package/dist/rooms/keys/act/0.6/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.6/payload.js +1 -1
- package/dist/rooms/keys/act/0.7/payload.d.ts +4 -4
- package/dist/rooms/keys/act/0.7/payload.js +1 -1
- package/dist/rooms/keys/act/0.8/payload.d.ts +14 -2
- 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 +560 -0
- package/dist/rooms/keys/act/0.9/payload.d.ts.map +1 -0
- package/dist/rooms/keys/act/0.9/payload.js +319 -0
- package/dist/rooms/keys/act/0.9/payload.js.map +1 -0
- package/dist/rooms/records/put/0.1/payload.d.ts +4 -4
- package/dist/rooms/records/put/0.1/payload.js +1 -1
- package/dist/rooms/records/put/0.2/payload.d.ts +4 -4
- package/dist/rooms/records/put/0.2/payload.js +1 -1
- package/dist/rooms/records/put/0.3/payload.d.ts +14 -2
- package/dist/rooms/records/put/0.3/payload.d.ts.map +1 -1
- package/dist/rooms/records/put/0.3/payload.js +1 -1
- package/dist/rooms/records/put/0.3/payload.js.map +1 -1
- package/dist/rooms/records/put/0.4/payload.d.ts +1474 -0
- package/dist/rooms/records/put/0.4/payload.d.ts.map +1 -0
- package/dist/rooms/records/put/0.4/payload.js +804 -0
- package/dist/rooms/records/put/0.4/payload.js.map +1 -0
- package/dist/vta/_shared/0.3/did-key-roles.d.ts +1 -1
- package/dist/vta/_shared/0.9/did-template.d.ts +16 -0
- package/dist/vta/_shared/0.9/did-template.d.ts.map +1 -0
- package/dist/vta/_shared/0.9/did-template.js +6 -0
- package/dist/vta/_shared/0.9/did-template.js.map +1 -0
- package/dist/vta/did-templates/create/2.0/payload.d.ts +3 -3
- package/dist/vta/did-templates/create/2.0/payload.js +1 -1
- package/dist/vta/did-templates/create/3.0/payload.d.ts +3 -3
- package/dist/vta/did-templates/create/3.0/payload.js +1 -1
- package/dist/vta/did-templates/create/3.1/payload.d.ts +12 -2
- package/dist/vta/did-templates/create/3.1/payload.d.ts.map +1 -1
- package/dist/vta/did-templates/create/3.1/payload.js +1 -1
- package/dist/vta/did-templates/create/3.1/payload.js.map +1 -1
- package/dist/vta/did-templates/create/3.2/payload.d.ts +1310 -0
- package/dist/vta/did-templates/create/3.2/payload.d.ts.map +1 -0
- package/dist/vta/did-templates/create/3.2/payload.js +832 -0
- package/dist/vta/did-templates/create/3.2/payload.js.map +1 -0
- package/dist/vta/did-templates/get/2.0/payload.d.ts +3 -3
- package/dist/vta/did-templates/get/2.0/payload.js +1 -1
- package/dist/vta/did-templates/get/3.0/payload.d.ts +3 -3
- package/dist/vta/did-templates/get/3.0/payload.js +1 -1
- package/dist/vta/did-templates/get/3.1/payload.d.ts +12 -2
- package/dist/vta/did-templates/get/3.1/payload.d.ts.map +1 -1
- package/dist/vta/did-templates/get/3.1/payload.js +1 -1
- package/dist/vta/did-templates/get/3.1/payload.js.map +1 -1
- package/dist/vta/did-templates/get/3.2/payload.d.ts +928 -0
- package/dist/vta/did-templates/get/3.2/payload.d.ts.map +1 -0
- package/dist/vta/did-templates/get/3.2/payload.js +593 -0
- package/dist/vta/did-templates/get/3.2/payload.js.map +1 -0
- package/dist/vta/did-templates/list/2.0/payload.d.ts +4 -4
- package/dist/vta/did-templates/list/2.0/payload.js +1 -1
- package/dist/vta/did-templates/list/3.0/payload.d.ts +4 -4
- package/dist/vta/did-templates/list/3.0/payload.js +1 -1
- package/dist/vta/did-templates/list/3.1/payload.d.ts +14 -2
- package/dist/vta/did-templates/list/3.1/payload.d.ts.map +1 -1
- package/dist/vta/did-templates/list/3.1/payload.js +1 -1
- package/dist/vta/did-templates/list/3.1/payload.js.map +1 -1
- package/dist/vta/did-templates/list/3.2/payload.d.ts +985 -0
- package/dist/vta/did-templates/list/3.2/payload.d.ts.map +1 -0
- package/dist/vta/did-templates/list/3.2/payload.js +619 -0
- package/dist/vta/did-templates/list/3.2/payload.js.map +1 -0
- package/dist/vta/did-templates/update/2.0/payload.d.ts +3 -3
- package/dist/vta/did-templates/update/2.0/payload.js +1 -1
- package/dist/vta/did-templates/update/3.0/payload.d.ts +3 -3
- package/dist/vta/did-templates/update/3.0/payload.js +1 -1
- package/dist/vta/did-templates/update/3.1/payload.d.ts +12 -2
- package/dist/vta/did-templates/update/3.1/payload.d.ts.map +1 -1
- package/dist/vta/did-templates/update/3.1/payload.js +1 -1
- package/dist/vta/did-templates/update/3.1/payload.js.map +1 -1
- package/dist/vta/did-templates/update/3.2/payload.d.ts +1324 -0
- package/dist/vta/did-templates/update/3.2/payload.d.ts.map +1 -0
- package/dist/vta/did-templates/update/3.2/payload.js +838 -0
- package/dist/vta/did-templates/update/3.2/payload.js.map +1 -0
- package/dist/vta/dids/_shared/0.1/key-roles.d.ts +16 -0
- package/dist/vta/dids/_shared/0.1/key-roles.d.ts.map +1 -0
- package/dist/vta/dids/_shared/0.1/key-roles.js +6 -0
- package/dist/vta/dids/_shared/0.1/key-roles.js.map +1 -0
- package/dist/vta/dids/_shared/0.1/method-profiles/webvh-parameters.d.ts +11 -0
- package/dist/vta/dids/_shared/0.1/method-profiles/webvh-parameters.d.ts.map +1 -0
- package/dist/vta/dids/_shared/0.1/method-profiles/webvh-parameters.js +6 -0
- package/dist/vta/dids/_shared/0.1/method-profiles/webvh-parameters.js.map +1 -0
- package/dist/vta/dids/create/1.0/payload.d.ts +2613 -0
- package/dist/vta/dids/create/1.0/payload.d.ts.map +1 -0
- package/dist/vta/dids/create/1.0/payload.js +1554 -0
- package/dist/vta/dids/create/1.0/payload.js.map +1 -0
- package/dist/vta/dids/keys/add/1.0/payload.d.ts +2447 -0
- package/dist/vta/dids/keys/add/1.0/payload.d.ts.map +1 -0
- package/dist/vta/dids/keys/add/1.0/payload.js +1469 -0
- package/dist/vta/dids/keys/add/1.0/payload.js.map +1 -0
- package/dist/vta/dids/keys/list/1.0/payload.d.ts +1855 -0
- package/dist/vta/dids/keys/list/1.0/payload.d.ts.map +1 -0
- package/dist/vta/dids/keys/list/1.0/payload.js +1116 -0
- package/dist/vta/dids/keys/list/1.0/payload.js.map +1 -0
- package/dist/vta/dids/keys/retire/1.0/payload.d.ts +2449 -0
- package/dist/vta/dids/keys/retire/1.0/payload.d.ts.map +1 -0
- package/dist/vta/dids/keys/retire/1.0/payload.js +1469 -0
- package/dist/vta/dids/keys/retire/1.0/payload.js.map +1 -0
- package/dist/vta/dids/keys/revoke/1.0/payload.d.ts +2701 -0
- package/dist/vta/dids/keys/revoke/1.0/payload.d.ts.map +1 -0
- package/dist/vta/dids/keys/revoke/1.0/payload.js +1597 -0
- package/dist/vta/dids/keys/revoke/1.0/payload.js.map +1 -0
- package/dist/vta/dids/keys/rotate/1.0/payload.d.ts +2628 -0
- package/dist/vta/dids/keys/rotate/1.0/payload.d.ts.map +1 -0
- package/dist/vta/dids/keys/rotate/1.0/payload.js +1555 -0
- package/dist/vta/dids/keys/rotate/1.0/payload.js.map +1 -0
- package/dist/vta/dids/recover/1.0/payload.d.ts +2702 -0
- package/dist/vta/dids/recover/1.0/payload.d.ts.map +1 -0
- package/dist/vta/dids/recover/1.0/payload.js +1597 -0
- package/dist/vta/dids/recover/1.0/payload.js.map +1 -0
- package/dist/vta/dids/update/1.0/payload.d.ts +1422 -0
- package/dist/vta/dids/update/1.0/payload.d.ts.map +1 -0
- package/dist/vta/dids/update/1.0/payload.js +861 -0
- package/dist/vta/dids/update/1.0/payload.js.map +1 -0
- package/dist/vta/webvh/dids/keys/add/1.0/payload.d.ts +14 -2
- package/dist/vta/webvh/dids/keys/add/1.0/payload.d.ts.map +1 -1
- package/dist/vta/webvh/dids/keys/add/1.0/payload.js +1 -1
- package/dist/vta/webvh/dids/keys/add/1.0/payload.js.map +1 -1
- package/dist/vta/webvh/dids/keys/list/1.0/payload.d.ts +14 -2
- package/dist/vta/webvh/dids/keys/list/1.0/payload.d.ts.map +1 -1
- package/dist/vta/webvh/dids/keys/list/1.0/payload.js +1 -1
- package/dist/vta/webvh/dids/keys/list/1.0/payload.js.map +1 -1
- package/dist/vta/webvh/dids/keys/retire/1.0/payload.d.ts +14 -2
- package/dist/vta/webvh/dids/keys/retire/1.0/payload.d.ts.map +1 -1
- package/dist/vta/webvh/dids/keys/retire/1.0/payload.js +1 -1
- package/dist/vta/webvh/dids/keys/retire/1.0/payload.js.map +1 -1
- package/dist/vta/webvh/dids/keys/revoke/1.0/payload.d.ts +14 -2
- package/dist/vta/webvh/dids/keys/revoke/1.0/payload.d.ts.map +1 -1
- package/dist/vta/webvh/dids/keys/revoke/1.0/payload.js +1 -1
- package/dist/vta/webvh/dids/keys/revoke/1.0/payload.js.map +1 -1
- package/dist/vta/webvh/dids/rotate-keys/1.0/payload.d.ts +2 -14
- package/dist/vta/webvh/dids/rotate-keys/1.0/payload.d.ts.map +1 -1
- package/dist/vta/webvh/dids/rotate-keys/1.0/payload.js +1 -1
- package/dist/vta/webvh/dids/rotate-keys/1.0/payload.js.map +1 -1
- package/dist/vta/webvh/dids/rotate-keys/2.0/payload.d.ts +14 -2
- package/dist/vta/webvh/dids/rotate-keys/2.0/payload.d.ts.map +1 -1
- package/dist/vta/webvh/dids/rotate-keys/2.0/payload.js +1 -1
- package/dist/vta/webvh/dids/rotate-keys/2.0/payload.js.map +1 -1
- package/dist/vta/webvh/dids/update/1.0/payload.d.ts +4 -4
- package/dist/vta/webvh/dids/update/1.0/payload.js +1 -1
- package/dist/vta/webvh/dids/update/1.1/payload.d.ts +511 -0
- package/dist/vta/webvh/dids/update/1.1/payload.d.ts.map +1 -0
- package/dist/vta/webvh/dids/update/1.1/payload.js +251 -0
- package/dist/vta/webvh/dids/update/1.1/payload.js.map +1 -0
- package/dist/vta/webvh/dids/update/2.0/payload.d.ts +4 -4
- package/dist/vta/webvh/dids/update/2.0/payload.d.ts.map +1 -1
- package/dist/vta/webvh/dids/update/2.0/payload.js +1 -1
- package/dist/vta/webvh/dids/update/2.0/payload.js.map +1 -1
- package/dist/vta/webvh/dids/update/2.1/payload.d.ts +14 -2
- package/dist/vta/webvh/dids/update/2.1/payload.d.ts.map +1 -1
- package/dist/vta/webvh/dids/update/2.1/payload.js +1 -1
- package/dist/vta/webvh/dids/update/2.1/payload.js.map +1 -1
- package/dist/vtc/_shared/0.2/invite.d.ts +16 -0
- package/dist/vtc/_shared/0.2/invite.d.ts.map +1 -0
- package/dist/vtc/_shared/0.2/invite.js +6 -0
- package/dist/vtc/_shared/0.2/invite.js.map +1 -0
- package/dist/vtc/admin/invites/create/0.1/payload.d.ts +12 -2
- package/dist/vtc/admin/invites/create/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/admin/invites/create/0.1/payload.js +1 -1
- package/dist/vtc/admin/invites/create/0.1/payload.js.map +1 -1
- package/dist/vtc/admin/invites/create/0.2/payload.d.ts +404 -0
- package/dist/vtc/admin/invites/create/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/admin/invites/create/0.2/payload.js +230 -0
- package/dist/vtc/admin/invites/create/0.2/payload.js.map +1 -0
- package/dist/vtc/admin/invites/list/0.1/payload.d.ts +12 -2
- package/dist/vtc/admin/invites/list/0.1/payload.d.ts.map +1 -1
- package/dist/vtc/admin/invites/list/0.1/payload.js +1 -1
- package/dist/vtc/admin/invites/list/0.1/payload.js.map +1 -1
- package/dist/vtc/admin/invites/list/0.2/payload.d.ts +431 -0
- package/dist/vtc/admin/invites/list/0.2/payload.d.ts.map +1 -0
- package/dist/vtc/admin/invites/list/0.2/payload.js +264 -0
- package/dist/vtc/admin/invites/list/0.2/payload.js.map +1 -0
- package/dist/vtc/credentials/reissue/0.1/payload.d.ts +3 -3
- package/dist/vtc/credentials/reissue/0.1/payload.js +1 -1
- package/dist/vtc/credentials/reissue/0.1/payload.js.map +1 -1
- package/package.json +1 -1
- package/src/_extends.ts +7 -0
- package/src/_shared/components.ts +556 -3
- package/src/index.ts +66 -0
- package/src/peer-check/ask/0.1/payload.ts +301 -0
- package/src/rooms/keys/act/0.1/payload.ts +5 -5
- 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 +15 -3
- package/src/rooms/keys/act/0.9/payload.ts +396 -0
- package/src/rooms/records/put/0.1/payload.ts +5 -5
- package/src/rooms/records/put/0.2/payload.ts +5 -5
- package/src/rooms/records/put/0.3/payload.ts +15 -3
- package/src/rooms/records/put/0.4/payload.ts +905 -0
- package/src/vta/_shared/0.3/did-key-roles.ts +1 -1
- package/src/vta/_shared/0.9/did-template.ts +17 -0
- package/src/vta/did-templates/create/2.0/payload.ts +4 -4
- package/src/vta/did-templates/create/3.0/payload.ts +4 -4
- package/src/vta/did-templates/create/3.1/payload.ts +13 -3
- package/src/vta/did-templates/create/3.2/payload.ts +869 -0
- package/src/vta/did-templates/get/2.0/payload.ts +4 -4
- package/src/vta/did-templates/get/3.0/payload.ts +4 -4
- package/src/vta/did-templates/get/3.1/payload.ts +13 -3
- package/src/vta/did-templates/get/3.2/payload.ts +630 -0
- package/src/vta/did-templates/list/2.0/payload.ts +5 -5
- package/src/vta/did-templates/list/3.0/payload.ts +5 -5
- package/src/vta/did-templates/list/3.1/payload.ts +15 -3
- package/src/vta/did-templates/list/3.2/payload.ts +665 -0
- package/src/vta/did-templates/update/2.0/payload.ts +4 -4
- package/src/vta/did-templates/update/3.0/payload.ts +4 -4
- package/src/vta/did-templates/update/3.1/payload.ts +13 -3
- package/src/vta/did-templates/update/3.2/payload.ts +879 -0
- package/src/vta/dids/_shared/0.1/key-roles.ts +17 -0
- package/src/vta/dids/_shared/0.1/method-profiles/webvh-parameters.ts +11 -0
- package/src/vta/dids/create/1.0/payload.ts +1648 -0
- package/src/vta/dids/keys/add/1.0/payload.ts +1553 -0
- package/src/vta/dids/keys/list/1.0/payload.ts +1178 -0
- package/src/vta/dids/keys/retire/1.0/payload.ts +1553 -0
- package/src/vta/dids/keys/revoke/1.0/payload.ts +1697 -0
- package/src/vta/dids/keys/rotate/1.0/payload.ts +1658 -0
- package/src/vta/dids/recover/1.0/payload.ts +1700 -0
- package/src/vta/dids/update/1.0/payload.ts +940 -0
- package/src/vta/webvh/dids/keys/add/1.0/payload.ts +15 -3
- package/src/vta/webvh/dids/keys/list/1.0/payload.ts +15 -3
- package/src/vta/webvh/dids/keys/retire/1.0/payload.ts +15 -3
- package/src/vta/webvh/dids/keys/revoke/1.0/payload.ts +15 -3
- package/src/vta/webvh/dids/rotate-keys/1.0/payload.ts +3 -15
- package/src/vta/webvh/dids/rotate-keys/2.0/payload.ts +15 -3
- package/src/vta/webvh/dids/update/1.0/payload.ts +5 -5
- package/src/vta/webvh/dids/update/1.1/payload.ts +351 -0
- package/src/vta/webvh/dids/update/2.0/payload.ts +5 -5
- package/src/vta/webvh/dids/update/2.1/payload.ts +15 -3
- package/src/vtc/_shared/0.2/invite.ts +17 -0
- package/src/vtc/admin/invites/create/0.1/payload.ts +13 -3
- package/src/vtc/admin/invites/create/0.2/payload.ts +289 -0
- package/src/vtc/admin/invites/list/0.1/payload.ts +13 -3
- package/src/vtc/admin/invites/list/0.2/payload.ts +294 -0
- package/src/vtc/credentials/reissue/0.1/payload.ts +2 -2
|
@@ -0,0 +1,404 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/admin/invites/create/0.2/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext, InviteKind } from "../../../../../_shared/components.js";
|
|
6
|
+
export interface VTCAdminInvitesCreatePayload {
|
|
7
|
+
/**
|
|
8
|
+
* The DID a **wallet** invitation is for: the invitee claims it by signing as this DID (vtc/install/claim/start and finish 0.3). Absent, the invitation is a **passkey** invitation, and the administrator's DID is derived from the passkey the invitee registers (vtc/install/claim/passkey/start and finish 0.1).
|
|
9
|
+
*/
|
|
10
|
+
did?: string;
|
|
11
|
+
/**
|
|
12
|
+
* Invite lifetime. Capped at 24 hours.
|
|
13
|
+
*/
|
|
14
|
+
ttlSeconds?: number;
|
|
15
|
+
/**
|
|
16
|
+
* Operator-facing note, recorded as the label of the administrator entry the invitation writes.
|
|
17
|
+
*/
|
|
18
|
+
label?: string;
|
|
19
|
+
ext?: Ext;
|
|
20
|
+
}
|
|
21
|
+
export interface VTCAdminInvitesCreateResponsePayload {
|
|
22
|
+
/**
|
|
23
|
+
* Invite identifier; the revoke target.
|
|
24
|
+
*/
|
|
25
|
+
jti: string;
|
|
26
|
+
kind: InviteKind;
|
|
27
|
+
/**
|
|
28
|
+
* One-shot enrolment URL. Returned once and never retrievable again.
|
|
29
|
+
*/
|
|
30
|
+
installUrl: string;
|
|
31
|
+
/**
|
|
32
|
+
* Secret that authorises the enrolment. Returned once.
|
|
33
|
+
*/
|
|
34
|
+
claimCode: string;
|
|
35
|
+
/**
|
|
36
|
+
* When the invite lapses.
|
|
37
|
+
*/
|
|
38
|
+
expiresAt: string;
|
|
39
|
+
/**
|
|
40
|
+
* True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed.
|
|
41
|
+
*/
|
|
42
|
+
aclEntryCreated: boolean;
|
|
43
|
+
ext?: Ext;
|
|
44
|
+
}
|
|
45
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
46
|
+
export type { Ext, InviteKind };
|
|
47
|
+
/** Trust Task type URI. */
|
|
48
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/admin/invites/create/0.2";
|
|
49
|
+
/**
|
|
50
|
+
* The earlier version of this specification that this one declares it
|
|
51
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
52
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
53
|
+
* `extendsChain` / `readForSpec`.
|
|
54
|
+
*/
|
|
55
|
+
export declare const EXTENDS: string | null;
|
|
56
|
+
/**
|
|
57
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
58
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
59
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
60
|
+
* Versions").
|
|
61
|
+
*/
|
|
62
|
+
export declare const DEPRECATION: string | null;
|
|
63
|
+
/** Stable alias for this specification's request payload shape. */
|
|
64
|
+
export type Payload = VTCAdminInvitesCreatePayload;
|
|
65
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
66
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/admin/invites/create/0.2#response";
|
|
67
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
68
|
+
export type Response = VTCAdminInvitesCreateResponsePayload;
|
|
69
|
+
/**
|
|
70
|
+
* This specification's payload schema, as a value.
|
|
71
|
+
*
|
|
72
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
73
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
74
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
75
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
76
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
77
|
+
*/
|
|
78
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
79
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
80
|
+
readonly $id: "https://trusttasks.org/spec/vtc/admin/invites/create/0.2";
|
|
81
|
+
readonly title: "VTC Admin Invites Create — payload";
|
|
82
|
+
readonly type: "object";
|
|
83
|
+
readonly additionalProperties: false;
|
|
84
|
+
readonly properties: {
|
|
85
|
+
readonly did: {
|
|
86
|
+
readonly type: "string";
|
|
87
|
+
readonly minLength: 1;
|
|
88
|
+
readonly pattern: "^did:";
|
|
89
|
+
readonly description: "The DID a **wallet** invitation is for: the invitee claims it by signing as this DID (vtc/install/claim/start and finish 0.3). Absent, the invitation is a **passkey** invitation, and the administrator's DID is derived from the passkey the invitee registers (vtc/install/claim/passkey/start and finish 0.1).";
|
|
90
|
+
};
|
|
91
|
+
readonly ttlSeconds: {
|
|
92
|
+
readonly type: "integer";
|
|
93
|
+
readonly minimum: 1;
|
|
94
|
+
readonly maximum: 86400;
|
|
95
|
+
readonly description: "Invite lifetime. Capped at 24 hours.";
|
|
96
|
+
};
|
|
97
|
+
readonly label: {
|
|
98
|
+
readonly type: "string";
|
|
99
|
+
readonly minLength: 1;
|
|
100
|
+
readonly maxLength: 256;
|
|
101
|
+
readonly description: "Operator-facing note, recorded as the label of the administrator entry the invitation writes.";
|
|
102
|
+
};
|
|
103
|
+
readonly ext: {
|
|
104
|
+
readonly $ref: "#/$defs/Ext";
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
readonly $defs: {
|
|
108
|
+
readonly Response: {
|
|
109
|
+
readonly $anchor: "response";
|
|
110
|
+
readonly title: "VTC Admin Invites Create — response payload";
|
|
111
|
+
readonly type: "object";
|
|
112
|
+
readonly additionalProperties: false;
|
|
113
|
+
readonly required: readonly ["jti", "kind", "installUrl", "claimCode", "expiresAt", "aclEntryCreated"];
|
|
114
|
+
readonly properties: {
|
|
115
|
+
readonly jti: {
|
|
116
|
+
readonly type: "string";
|
|
117
|
+
readonly minLength: 1;
|
|
118
|
+
readonly description: "Invite identifier; the revoke target.";
|
|
119
|
+
};
|
|
120
|
+
readonly kind: {
|
|
121
|
+
readonly $ref: "#/$defs/InviteKind";
|
|
122
|
+
};
|
|
123
|
+
readonly installUrl: {
|
|
124
|
+
readonly type: "string";
|
|
125
|
+
readonly minLength: 1;
|
|
126
|
+
readonly description: "One-shot enrolment URL. Returned once and never retrievable again.";
|
|
127
|
+
};
|
|
128
|
+
readonly claimCode: {
|
|
129
|
+
readonly type: "string";
|
|
130
|
+
readonly minLength: 1;
|
|
131
|
+
readonly description: "Secret that authorises the enrolment. Returned once.";
|
|
132
|
+
};
|
|
133
|
+
readonly expiresAt: {
|
|
134
|
+
readonly type: "string";
|
|
135
|
+
readonly format: "date-time";
|
|
136
|
+
readonly description: "When the invite lapses.";
|
|
137
|
+
};
|
|
138
|
+
readonly aclEntryCreated: {
|
|
139
|
+
readonly type: "boolean";
|
|
140
|
+
readonly description: "True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed.";
|
|
141
|
+
};
|
|
142
|
+
readonly ext: {
|
|
143
|
+
readonly $ref: "#/$defs/Ext";
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
readonly Ext: {
|
|
148
|
+
readonly title: "Ext";
|
|
149
|
+
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.";
|
|
150
|
+
readonly type: "object";
|
|
151
|
+
readonly minProperties: 1;
|
|
152
|
+
readonly additionalProperties: true;
|
|
153
|
+
readonly propertyNames: {
|
|
154
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
155
|
+
};
|
|
156
|
+
};
|
|
157
|
+
readonly InviteKind: {
|
|
158
|
+
readonly $anchor: "inviteKind";
|
|
159
|
+
readonly title: "InviteKind";
|
|
160
|
+
readonly type: "string";
|
|
161
|
+
readonly enum: readonly ["wallet", "passkey"];
|
|
162
|
+
readonly description: "`wallet`: the invitation names a DID, and is claimed by signing as it (vtc/install/claim/start and finish 0.3). `passkey`: it names none, and the administrator's DID is the `did:key` of the passkey registered at its claim (vtc/install/claim/passkey/start and finish 0.1).";
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
};
|
|
166
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
167
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
168
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
169
|
+
readonly $ref: "#/$defs/Response";
|
|
170
|
+
readonly $defs: {
|
|
171
|
+
readonly Response: {
|
|
172
|
+
readonly $anchor: "response";
|
|
173
|
+
readonly title: "VTC Admin Invites Create — response payload";
|
|
174
|
+
readonly type: "object";
|
|
175
|
+
readonly additionalProperties: false;
|
|
176
|
+
readonly required: readonly ["jti", "kind", "installUrl", "claimCode", "expiresAt", "aclEntryCreated"];
|
|
177
|
+
readonly properties: {
|
|
178
|
+
readonly jti: {
|
|
179
|
+
readonly type: "string";
|
|
180
|
+
readonly minLength: 1;
|
|
181
|
+
readonly description: "Invite identifier; the revoke target.";
|
|
182
|
+
};
|
|
183
|
+
readonly kind: {
|
|
184
|
+
readonly $ref: "#/$defs/InviteKind";
|
|
185
|
+
};
|
|
186
|
+
readonly installUrl: {
|
|
187
|
+
readonly type: "string";
|
|
188
|
+
readonly minLength: 1;
|
|
189
|
+
readonly description: "One-shot enrolment URL. Returned once and never retrievable again.";
|
|
190
|
+
};
|
|
191
|
+
readonly claimCode: {
|
|
192
|
+
readonly type: "string";
|
|
193
|
+
readonly minLength: 1;
|
|
194
|
+
readonly description: "Secret that authorises the enrolment. Returned once.";
|
|
195
|
+
};
|
|
196
|
+
readonly expiresAt: {
|
|
197
|
+
readonly type: "string";
|
|
198
|
+
readonly format: "date-time";
|
|
199
|
+
readonly description: "When the invite lapses.";
|
|
200
|
+
};
|
|
201
|
+
readonly aclEntryCreated: {
|
|
202
|
+
readonly type: "boolean";
|
|
203
|
+
readonly description: "True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed.";
|
|
204
|
+
};
|
|
205
|
+
readonly ext: {
|
|
206
|
+
readonly $ref: "#/$defs/Ext";
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
};
|
|
210
|
+
readonly Ext: {
|
|
211
|
+
readonly title: "Ext";
|
|
212
|
+
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.";
|
|
213
|
+
readonly type: "object";
|
|
214
|
+
readonly minProperties: 1;
|
|
215
|
+
readonly additionalProperties: true;
|
|
216
|
+
readonly propertyNames: {
|
|
217
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
218
|
+
};
|
|
219
|
+
};
|
|
220
|
+
readonly InviteKind: {
|
|
221
|
+
readonly $anchor: "inviteKind";
|
|
222
|
+
readonly title: "InviteKind";
|
|
223
|
+
readonly type: "string";
|
|
224
|
+
readonly enum: readonly ["wallet", "passkey"];
|
|
225
|
+
readonly description: "`wallet`: the invitation names a DID, and is claimed by signing as it (vtc/install/claim/start and finish 0.3). `passkey`: it names none, and the administrator's DID is the `did:key` of the passkey registered at its claim (vtc/install/claim/passkey/start and finish 0.1).";
|
|
226
|
+
};
|
|
227
|
+
};
|
|
228
|
+
};
|
|
229
|
+
/**
|
|
230
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
231
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
232
|
+
* per-specification and cannot be derived from the document alone, and
|
|
233
|
+
* item 2 needs the schema this carries.
|
|
234
|
+
*/
|
|
235
|
+
export declare const SPEC: {
|
|
236
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/admin/invites/create/0.2";
|
|
237
|
+
readonly isBearer: false;
|
|
238
|
+
readonly isProofRequired: true;
|
|
239
|
+
readonly isRecipientRequired: true;
|
|
240
|
+
readonly isIssuedAtRequired: true;
|
|
241
|
+
readonly payloadSchema: {
|
|
242
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
243
|
+
readonly $id: "https://trusttasks.org/spec/vtc/admin/invites/create/0.2";
|
|
244
|
+
readonly title: "VTC Admin Invites Create — payload";
|
|
245
|
+
readonly type: "object";
|
|
246
|
+
readonly additionalProperties: false;
|
|
247
|
+
readonly properties: {
|
|
248
|
+
readonly did: {
|
|
249
|
+
readonly type: "string";
|
|
250
|
+
readonly minLength: 1;
|
|
251
|
+
readonly pattern: "^did:";
|
|
252
|
+
readonly description: "The DID a **wallet** invitation is for: the invitee claims it by signing as this DID (vtc/install/claim/start and finish 0.3). Absent, the invitation is a **passkey** invitation, and the administrator's DID is derived from the passkey the invitee registers (vtc/install/claim/passkey/start and finish 0.1).";
|
|
253
|
+
};
|
|
254
|
+
readonly ttlSeconds: {
|
|
255
|
+
readonly type: "integer";
|
|
256
|
+
readonly minimum: 1;
|
|
257
|
+
readonly maximum: 86400;
|
|
258
|
+
readonly description: "Invite lifetime. Capped at 24 hours.";
|
|
259
|
+
};
|
|
260
|
+
readonly label: {
|
|
261
|
+
readonly type: "string";
|
|
262
|
+
readonly minLength: 1;
|
|
263
|
+
readonly maxLength: 256;
|
|
264
|
+
readonly description: "Operator-facing note, recorded as the label of the administrator entry the invitation writes.";
|
|
265
|
+
};
|
|
266
|
+
readonly ext: {
|
|
267
|
+
readonly $ref: "#/$defs/Ext";
|
|
268
|
+
};
|
|
269
|
+
};
|
|
270
|
+
readonly $defs: {
|
|
271
|
+
readonly Response: {
|
|
272
|
+
readonly $anchor: "response";
|
|
273
|
+
readonly title: "VTC Admin Invites Create — response payload";
|
|
274
|
+
readonly type: "object";
|
|
275
|
+
readonly additionalProperties: false;
|
|
276
|
+
readonly required: readonly ["jti", "kind", "installUrl", "claimCode", "expiresAt", "aclEntryCreated"];
|
|
277
|
+
readonly properties: {
|
|
278
|
+
readonly jti: {
|
|
279
|
+
readonly type: "string";
|
|
280
|
+
readonly minLength: 1;
|
|
281
|
+
readonly description: "Invite identifier; the revoke target.";
|
|
282
|
+
};
|
|
283
|
+
readonly kind: {
|
|
284
|
+
readonly $ref: "#/$defs/InviteKind";
|
|
285
|
+
};
|
|
286
|
+
readonly installUrl: {
|
|
287
|
+
readonly type: "string";
|
|
288
|
+
readonly minLength: 1;
|
|
289
|
+
readonly description: "One-shot enrolment URL. Returned once and never retrievable again.";
|
|
290
|
+
};
|
|
291
|
+
readonly claimCode: {
|
|
292
|
+
readonly type: "string";
|
|
293
|
+
readonly minLength: 1;
|
|
294
|
+
readonly description: "Secret that authorises the enrolment. Returned once.";
|
|
295
|
+
};
|
|
296
|
+
readonly expiresAt: {
|
|
297
|
+
readonly type: "string";
|
|
298
|
+
readonly format: "date-time";
|
|
299
|
+
readonly description: "When the invite lapses.";
|
|
300
|
+
};
|
|
301
|
+
readonly aclEntryCreated: {
|
|
302
|
+
readonly type: "boolean";
|
|
303
|
+
readonly description: "True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed.";
|
|
304
|
+
};
|
|
305
|
+
readonly ext: {
|
|
306
|
+
readonly $ref: "#/$defs/Ext";
|
|
307
|
+
};
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
readonly Ext: {
|
|
311
|
+
readonly title: "Ext";
|
|
312
|
+
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.";
|
|
313
|
+
readonly type: "object";
|
|
314
|
+
readonly minProperties: 1;
|
|
315
|
+
readonly additionalProperties: true;
|
|
316
|
+
readonly propertyNames: {
|
|
317
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
readonly InviteKind: {
|
|
321
|
+
readonly $anchor: "inviteKind";
|
|
322
|
+
readonly title: "InviteKind";
|
|
323
|
+
readonly type: "string";
|
|
324
|
+
readonly enum: readonly ["wallet", "passkey"];
|
|
325
|
+
readonly description: "`wallet`: the invitation names a DID, and is claimed by signing as it (vtc/install/claim/start and finish 0.3). `passkey`: it names none, and the administrator's DID is the `did:key` of the passkey registered at its claim (vtc/install/claim/passkey/start and finish 0.1).";
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
/**
|
|
331
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
332
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
333
|
+
* parties (§7.3 item 5).
|
|
334
|
+
*/
|
|
335
|
+
export declare const RESPONSE_SPEC: {
|
|
336
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/admin/invites/create/0.2#response";
|
|
337
|
+
readonly isBearer: false;
|
|
338
|
+
readonly isProofRequired: true;
|
|
339
|
+
readonly isRecipientRequired: true;
|
|
340
|
+
readonly isIssuedAtRequired: true;
|
|
341
|
+
readonly payloadSchema: {
|
|
342
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
343
|
+
readonly $ref: "#/$defs/Response";
|
|
344
|
+
readonly $defs: {
|
|
345
|
+
readonly Response: {
|
|
346
|
+
readonly $anchor: "response";
|
|
347
|
+
readonly title: "VTC Admin Invites Create — response payload";
|
|
348
|
+
readonly type: "object";
|
|
349
|
+
readonly additionalProperties: false;
|
|
350
|
+
readonly required: readonly ["jti", "kind", "installUrl", "claimCode", "expiresAt", "aclEntryCreated"];
|
|
351
|
+
readonly properties: {
|
|
352
|
+
readonly jti: {
|
|
353
|
+
readonly type: "string";
|
|
354
|
+
readonly minLength: 1;
|
|
355
|
+
readonly description: "Invite identifier; the revoke target.";
|
|
356
|
+
};
|
|
357
|
+
readonly kind: {
|
|
358
|
+
readonly $ref: "#/$defs/InviteKind";
|
|
359
|
+
};
|
|
360
|
+
readonly installUrl: {
|
|
361
|
+
readonly type: "string";
|
|
362
|
+
readonly minLength: 1;
|
|
363
|
+
readonly description: "One-shot enrolment URL. Returned once and never retrievable again.";
|
|
364
|
+
};
|
|
365
|
+
readonly claimCode: {
|
|
366
|
+
readonly type: "string";
|
|
367
|
+
readonly minLength: 1;
|
|
368
|
+
readonly description: "Secret that authorises the enrolment. Returned once.";
|
|
369
|
+
};
|
|
370
|
+
readonly expiresAt: {
|
|
371
|
+
readonly type: "string";
|
|
372
|
+
readonly format: "date-time";
|
|
373
|
+
readonly description: "When the invite lapses.";
|
|
374
|
+
};
|
|
375
|
+
readonly aclEntryCreated: {
|
|
376
|
+
readonly type: "boolean";
|
|
377
|
+
readonly description: "True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed.";
|
|
378
|
+
};
|
|
379
|
+
readonly ext: {
|
|
380
|
+
readonly $ref: "#/$defs/Ext";
|
|
381
|
+
};
|
|
382
|
+
};
|
|
383
|
+
};
|
|
384
|
+
readonly Ext: {
|
|
385
|
+
readonly title: "Ext";
|
|
386
|
+
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.";
|
|
387
|
+
readonly type: "object";
|
|
388
|
+
readonly minProperties: 1;
|
|
389
|
+
readonly additionalProperties: true;
|
|
390
|
+
readonly propertyNames: {
|
|
391
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
readonly InviteKind: {
|
|
395
|
+
readonly $anchor: "inviteKind";
|
|
396
|
+
readonly title: "InviteKind";
|
|
397
|
+
readonly type: "string";
|
|
398
|
+
readonly enum: readonly ["wallet", "passkey"];
|
|
399
|
+
readonly description: "`wallet`: the invitation names a DID, and is claimed by signing as it (vtc/install/claim/start and finish 0.3). `passkey`: it names none, and the administrator's DID is the `did:key` of the passkey registered at its claim (vtc/install/claim/passkey/start and finish 0.1).";
|
|
400
|
+
};
|
|
401
|
+
};
|
|
402
|
+
};
|
|
403
|
+
};
|
|
404
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/admin/invites/create/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAG5E,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;AAEhC,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,0DAAmE,CAAC;AAE5F;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,4BAA4B,CAAC;AAEnD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,mEAA4E,CAAC;AAE9G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,oCAAoC,CAAC;AAE5D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiGjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuE1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/admin/invites/create/0.2/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
/** Trust Task type URI. */
|
|
6
|
+
export const TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/create/0.2";
|
|
7
|
+
/**
|
|
8
|
+
* The earlier version of this specification that this one declares it
|
|
9
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
10
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
11
|
+
* `extendsChain` / `readForSpec`.
|
|
12
|
+
*/
|
|
13
|
+
export const EXTENDS = null;
|
|
14
|
+
/**
|
|
15
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
16
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
17
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
18
|
+
* Versions").
|
|
19
|
+
*/
|
|
20
|
+
export const DEPRECATION = null;
|
|
21
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
22
|
+
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/admin/invites/create/0.2#response";
|
|
23
|
+
/**
|
|
24
|
+
* This specification's payload schema, as a value.
|
|
25
|
+
*
|
|
26
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
27
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
28
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
29
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
30
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
31
|
+
*/
|
|
32
|
+
export const PAYLOAD_SCHEMA = {
|
|
33
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
34
|
+
"$id": "https://trusttasks.org/spec/vtc/admin/invites/create/0.2",
|
|
35
|
+
"title": "VTC Admin Invites Create — payload",
|
|
36
|
+
"type": "object",
|
|
37
|
+
"additionalProperties": false,
|
|
38
|
+
"properties": {
|
|
39
|
+
"did": {
|
|
40
|
+
"type": "string",
|
|
41
|
+
"minLength": 1,
|
|
42
|
+
"pattern": "^did:",
|
|
43
|
+
"description": "The DID a **wallet** invitation is for: the invitee claims it by signing as this DID (vtc/install/claim/start and finish 0.3). Absent, the invitation is a **passkey** invitation, and the administrator's DID is derived from the passkey the invitee registers (vtc/install/claim/passkey/start and finish 0.1)."
|
|
44
|
+
},
|
|
45
|
+
"ttlSeconds": {
|
|
46
|
+
"type": "integer",
|
|
47
|
+
"minimum": 1,
|
|
48
|
+
"maximum": 86400,
|
|
49
|
+
"description": "Invite lifetime. Capped at 24 hours."
|
|
50
|
+
},
|
|
51
|
+
"label": {
|
|
52
|
+
"type": "string",
|
|
53
|
+
"minLength": 1,
|
|
54
|
+
"maxLength": 256,
|
|
55
|
+
"description": "Operator-facing note, recorded as the label of the administrator entry the invitation writes."
|
|
56
|
+
},
|
|
57
|
+
"ext": {
|
|
58
|
+
"$ref": "#/$defs/Ext"
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
"$defs": {
|
|
62
|
+
"Response": {
|
|
63
|
+
"$anchor": "response",
|
|
64
|
+
"title": "VTC Admin Invites Create — response payload",
|
|
65
|
+
"type": "object",
|
|
66
|
+
"additionalProperties": false,
|
|
67
|
+
"required": [
|
|
68
|
+
"jti",
|
|
69
|
+
"kind",
|
|
70
|
+
"installUrl",
|
|
71
|
+
"claimCode",
|
|
72
|
+
"expiresAt",
|
|
73
|
+
"aclEntryCreated"
|
|
74
|
+
],
|
|
75
|
+
"properties": {
|
|
76
|
+
"jti": {
|
|
77
|
+
"type": "string",
|
|
78
|
+
"minLength": 1,
|
|
79
|
+
"description": "Invite identifier; the revoke target."
|
|
80
|
+
},
|
|
81
|
+
"kind": {
|
|
82
|
+
"$ref": "#/$defs/InviteKind"
|
|
83
|
+
},
|
|
84
|
+
"installUrl": {
|
|
85
|
+
"type": "string",
|
|
86
|
+
"minLength": 1,
|
|
87
|
+
"description": "One-shot enrolment URL. Returned once and never retrievable again."
|
|
88
|
+
},
|
|
89
|
+
"claimCode": {
|
|
90
|
+
"type": "string",
|
|
91
|
+
"minLength": 1,
|
|
92
|
+
"description": "Secret that authorises the enrolment. Returned once."
|
|
93
|
+
},
|
|
94
|
+
"expiresAt": {
|
|
95
|
+
"type": "string",
|
|
96
|
+
"format": "date-time",
|
|
97
|
+
"description": "When the invite lapses."
|
|
98
|
+
},
|
|
99
|
+
"aclEntryCreated": {
|
|
100
|
+
"type": "boolean",
|
|
101
|
+
"description": "True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed."
|
|
102
|
+
},
|
|
103
|
+
"ext": {
|
|
104
|
+
"$ref": "#/$defs/Ext"
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
},
|
|
108
|
+
"Ext": {
|
|
109
|
+
"title": "Ext",
|
|
110
|
+
"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.",
|
|
111
|
+
"type": "object",
|
|
112
|
+
"minProperties": 1,
|
|
113
|
+
"additionalProperties": true,
|
|
114
|
+
"propertyNames": {
|
|
115
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
"InviteKind": {
|
|
119
|
+
"$anchor": "inviteKind",
|
|
120
|
+
"title": "InviteKind",
|
|
121
|
+
"type": "string",
|
|
122
|
+
"enum": [
|
|
123
|
+
"wallet",
|
|
124
|
+
"passkey"
|
|
125
|
+
],
|
|
126
|
+
"description": "`wallet`: the invitation names a DID, and is claimed by signing as it (vtc/install/claim/start and finish 0.3). `passkey`: it names none, and the administrator's DID is the `did:key` of the passkey registered at its claim (vtc/install/claim/passkey/start and finish 0.1)."
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
};
|
|
130
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
131
|
+
export const RESPONSE_PAYLOAD_SCHEMA = {
|
|
132
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
133
|
+
"$ref": "#/$defs/Response",
|
|
134
|
+
"$defs": {
|
|
135
|
+
"Response": {
|
|
136
|
+
"$anchor": "response",
|
|
137
|
+
"title": "VTC Admin Invites Create — response payload",
|
|
138
|
+
"type": "object",
|
|
139
|
+
"additionalProperties": false,
|
|
140
|
+
"required": [
|
|
141
|
+
"jti",
|
|
142
|
+
"kind",
|
|
143
|
+
"installUrl",
|
|
144
|
+
"claimCode",
|
|
145
|
+
"expiresAt",
|
|
146
|
+
"aclEntryCreated"
|
|
147
|
+
],
|
|
148
|
+
"properties": {
|
|
149
|
+
"jti": {
|
|
150
|
+
"type": "string",
|
|
151
|
+
"minLength": 1,
|
|
152
|
+
"description": "Invite identifier; the revoke target."
|
|
153
|
+
},
|
|
154
|
+
"kind": {
|
|
155
|
+
"$ref": "#/$defs/InviteKind"
|
|
156
|
+
},
|
|
157
|
+
"installUrl": {
|
|
158
|
+
"type": "string",
|
|
159
|
+
"minLength": 1,
|
|
160
|
+
"description": "One-shot enrolment URL. Returned once and never retrievable again."
|
|
161
|
+
},
|
|
162
|
+
"claimCode": {
|
|
163
|
+
"type": "string",
|
|
164
|
+
"minLength": 1,
|
|
165
|
+
"description": "Secret that authorises the enrolment. Returned once."
|
|
166
|
+
},
|
|
167
|
+
"expiresAt": {
|
|
168
|
+
"type": "string",
|
|
169
|
+
"format": "date-time",
|
|
170
|
+
"description": "When the invite lapses."
|
|
171
|
+
},
|
|
172
|
+
"aclEntryCreated": {
|
|
173
|
+
"type": "boolean",
|
|
174
|
+
"description": "True when this call wrote an administrator entry: a wallet invitation for a DID that held none. Always false for a passkey invitation, whose entry is written when it is claimed."
|
|
175
|
+
},
|
|
176
|
+
"ext": {
|
|
177
|
+
"$ref": "#/$defs/Ext"
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
},
|
|
181
|
+
"Ext": {
|
|
182
|
+
"title": "Ext",
|
|
183
|
+
"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.",
|
|
184
|
+
"type": "object",
|
|
185
|
+
"minProperties": 1,
|
|
186
|
+
"additionalProperties": true,
|
|
187
|
+
"propertyNames": {
|
|
188
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
189
|
+
}
|
|
190
|
+
},
|
|
191
|
+
"InviteKind": {
|
|
192
|
+
"$anchor": "inviteKind",
|
|
193
|
+
"title": "InviteKind",
|
|
194
|
+
"type": "string",
|
|
195
|
+
"enum": [
|
|
196
|
+
"wallet",
|
|
197
|
+
"passkey"
|
|
198
|
+
],
|
|
199
|
+
"description": "`wallet`: the invitation names a DID, and is claimed by signing as it (vtc/install/claim/start and finish 0.3). `passkey`: it names none, and the administrator's DID is the `did:key` of the passkey registered at its claim (vtc/install/claim/passkey/start and finish 0.1)."
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
};
|
|
203
|
+
/**
|
|
204
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
205
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
206
|
+
* per-specification and cannot be derived from the document alone, and
|
|
207
|
+
* item 2 needs the schema this carries.
|
|
208
|
+
*/
|
|
209
|
+
export const SPEC = {
|
|
210
|
+
typeUri: TYPE_URI,
|
|
211
|
+
isBearer: false,
|
|
212
|
+
isProofRequired: true,
|
|
213
|
+
isRecipientRequired: true,
|
|
214
|
+
isIssuedAtRequired: true,
|
|
215
|
+
payloadSchema: PAYLOAD_SCHEMA,
|
|
216
|
+
};
|
|
217
|
+
/**
|
|
218
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
219
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
220
|
+
* parties (§7.3 item 5).
|
|
221
|
+
*/
|
|
222
|
+
export const RESPONSE_SPEC = {
|
|
223
|
+
typeUri: RESPONSE_TYPE_URI,
|
|
224
|
+
isBearer: false,
|
|
225
|
+
isProofRequired: true,
|
|
226
|
+
isRecipientRequired: true,
|
|
227
|
+
isIssuedAtRequired: true,
|
|
228
|
+
payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
|
|
229
|
+
};
|
|
230
|
+
//# sourceMappingURL=payload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vtc/admin/invites/create/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAgDH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,0DAAmE,CAAC;AAE5F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAkB,IAAI,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAkB,IAAI,CAAC;AAK/C,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,mEAA4E,CAAC;AAK9G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,0DAA0D;IACjE,OAAO,EAAE,oCAAoC;IAC7C,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,SAAS,EAAE,OAAO;YAClB,aAAa,EAAE,oTAAoT;SACpU;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,KAAK;YAChB,aAAa,EAAE,sCAAsC;SACtD;QACD,OAAO,EAAE;YACP,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,+FAA+F;SAC/G;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,6CAA6C;YACtD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,MAAM;gBACN,YAAY;gBACZ,WAAW;gBACX,WAAW;gBACX,iBAAiB;aAClB;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,uCAAuC;iBACvD;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,oEAAoE;iBACpF;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,sDAAsD;iBACtE;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,yBAAyB;iBACzC;gBACD,iBAAiB,EAAE;oBACjB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,mLAAmL;iBACnM;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,YAAY,EAAE;YACZ,SAAS,EAAE,YAAY;YACvB,OAAO,EAAE,YAAY;YACrB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,QAAQ;gBACR,SAAS;aACV;YACD,aAAa,EAAE,iRAAiR;SACjS;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,6CAA6C;YACtD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,MAAM;gBACN,YAAY;gBACZ,WAAW;gBACX,WAAW;gBACX,iBAAiB;aAClB;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,uCAAuC;iBACvD;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,oEAAoE;iBACpF;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,sDAAsD;iBACtE;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,yBAAyB;iBACzC;gBACD,iBAAiB,EAAE;oBACjB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,mLAAmL;iBACnM;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,YAAY,EAAE;YACZ,SAAS,EAAE,YAAY;YACvB,OAAO,EAAE,YAAY;YACrB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,QAAQ;gBACR,SAAS;aACV;YACD,aAAa,EAAE,iRAAiR;SACjS;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}
|