@openvtc/trust-tasks 0.28.10 → 0.28.11
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 +88 -0
- package/dist/_shared/components.d.ts +903 -0
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +144 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +144 -0
- package/dist/index.js.map +1 -1
- package/dist/vta/notifications/deposit/0.1/payload.d.ts +349 -0
- package/dist/vta/notifications/deposit/0.1/payload.d.ts.map +1 -0
- package/dist/vta/notifications/deposit/0.1/payload.js +198 -0
- package/dist/vta/notifications/deposit/0.1/payload.js.map +1 -0
- package/dist/vta/pcs/vetter/recover/0.1/payload.d.ts +667 -0
- package/dist/vta/pcs/vetter/recover/0.1/payload.d.ts.map +1 -0
- package/dist/vta/pcs/vetter/recover/0.1/payload.js +387 -0
- package/dist/vta/pcs/vetter/recover/0.1/payload.js.map +1 -0
- package/dist/vtc/notifications/_shared/0.1/received-notification.d.ts +16 -0
- package/dist/vtc/notifications/_shared/0.1/received-notification.d.ts.map +1 -0
- package/dist/vtc/notifications/_shared/0.1/received-notification.js +6 -0
- package/dist/vtc/notifications/_shared/0.1/received-notification.js.map +1 -0
- package/dist/vtc/notifications/list/0.1/payload.d.ts +1311 -0
- package/dist/vtc/notifications/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/notifications/list/0.1/payload.js +753 -0
- package/dist/vtc/notifications/list/0.1/payload.js.map +1 -0
- package/dist/vtc/notifications/relay/0.1/payload.d.ts +568 -0
- package/dist/vtc/notifications/relay/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/notifications/relay/0.1/payload.js +339 -0
- package/dist/vtc/notifications/relay/0.1/payload.js.map +1 -0
- package/dist/vtc/notifications/show/0.1/payload.d.ts +1229 -0
- package/dist/vtc/notifications/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/notifications/show/0.1/payload.js +727 -0
- package/dist/vtc/notifications/show/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/vetters/pcs-binding/reset/0.1/payload.d.ts +340 -0
- package/dist/vtc/vetting/vetters/pcs-binding/reset/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/vetters/pcs-binding/reset/0.1/payload.js +194 -0
- package/dist/vtc/vetting/vetters/pcs-binding/reset/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/vetters/pcs-binding/show/0.1/payload.d.ts +425 -0
- package/dist/vtc/vetting/vetters/pcs-binding/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/vetters/pcs-binding/show/0.1/payload.js +233 -0
- package/dist/vtc/vetting/vetters/pcs-binding/show/0.1/payload.js.map +1 -0
- package/dist/vtn/_shared/0.1/directory.d.ts +16 -0
- package/dist/vtn/_shared/0.1/directory.d.ts.map +1 -0
- package/dist/vtn/_shared/0.1/directory.js +6 -0
- package/dist/vtn/_shared/0.1/directory.js.map +1 -0
- package/dist/vtn/_shared/0.1/entry.d.ts +16 -0
- package/dist/vtn/_shared/0.1/entry.d.ts.map +1 -0
- package/dist/vtn/_shared/0.1/entry.js +6 -0
- package/dist/vtn/_shared/0.1/entry.js.map +1 -0
- package/dist/vtn/_shared/0.1/graph.d.ts +16 -0
- package/dist/vtn/_shared/0.1/graph.d.ts.map +1 -0
- package/dist/vtn/_shared/0.1/graph.js +6 -0
- package/dist/vtn/_shared/0.1/graph.js.map +1 -0
- package/dist/vtn/_shared/0.1/groups.d.ts +16 -0
- package/dist/vtn/_shared/0.1/groups.d.ts.map +1 -0
- package/dist/vtn/_shared/0.1/groups.js +6 -0
- package/dist/vtn/_shared/0.1/groups.js.map +1 -0
- package/dist/vtn/_shared/0.1/membership.d.ts +16 -0
- package/dist/vtn/_shared/0.1/membership.d.ts.map +1 -0
- package/dist/vtn/_shared/0.1/membership.js +6 -0
- package/dist/vtn/_shared/0.1/membership.js.map +1 -0
- package/dist/vtn/_shared/0.1/relay.d.ts +16 -0
- package/dist/vtn/_shared/0.1/relay.d.ts.map +1 -0
- package/dist/vtn/_shared/0.1/relay.js +6 -0
- package/dist/vtn/_shared/0.1/relay.js.map +1 -0
- package/dist/vtn/_shared/0.1/rooms.d.ts +16 -0
- package/dist/vtn/_shared/0.1/rooms.d.ts.map +1 -0
- package/dist/vtn/_shared/0.1/rooms.js +6 -0
- package/dist/vtn/_shared/0.1/rooms.js.map +1 -0
- package/dist/vtn/audit/list/0.1/payload.d.ts +457 -0
- package/dist/vtn/audit/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/audit/list/0.1/payload.js +292 -0
- package/dist/vtn/audit/list/0.1/payload.js.map +1 -0
- package/dist/vtn/broadcasts/list/0.1/payload.d.ts +687 -0
- package/dist/vtn/broadcasts/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/broadcasts/list/0.1/payload.js +407 -0
- package/dist/vtn/broadcasts/list/0.1/payload.js.map +1 -0
- package/dist/vtn/broadcasts/send/0.1/payload.d.ts +728 -0
- package/dist/vtn/broadcasts/send/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/broadcasts/send/0.1/payload.js +425 -0
- package/dist/vtn/broadcasts/send/0.1/payload.js.map +1 -0
- package/dist/vtn/broadcasts/show/0.1/payload.d.ts +670 -0
- package/dist/vtn/broadcasts/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/broadcasts/show/0.1/payload.js +402 -0
- package/dist/vtn/broadcasts/show/0.1/payload.js.map +1 -0
- package/dist/vtn/directory/federated/0.1/payload.d.ts +939 -0
- package/dist/vtn/directory/federated/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/directory/federated/0.1/payload.js +536 -0
- package/dist/vtn/directory/federated/0.1/payload.js.map +1 -0
- package/dist/vtn/directory/search/0.1/payload.d.ts +643 -0
- package/dist/vtn/directory/search/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/directory/search/0.1/payload.js +368 -0
- package/dist/vtn/directory/search/0.1/payload.js.map +1 -0
- package/dist/vtn/directory/summary/0.1/payload.d.ts +366 -0
- package/dist/vtn/directory/summary/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/directory/summary/0.1/payload.js +216 -0
- package/dist/vtn/directory/summary/0.1/payload.js.map +1 -0
- package/dist/vtn/entries/show/0.1/payload.d.ts +682 -0
- package/dist/vtn/entries/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/entries/show/0.1/payload.js +398 -0
- package/dist/vtn/entries/show/0.1/payload.js.map +1 -0
- package/dist/vtn/graph/member/0.1/payload.d.ts +754 -0
- package/dist/vtn/graph/member/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/graph/member/0.1/payload.js +470 -0
- package/dist/vtn/graph/member/0.1/payload.js.map +1 -0
- package/dist/vtn/graph/show/0.1/payload.d.ts +754 -0
- package/dist/vtn/graph/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/graph/show/0.1/payload.js +468 -0
- package/dist/vtn/graph/show/0.1/payload.js.map +1 -0
- package/dist/vtn/groups/list/0.1/payload.d.ts +489 -0
- package/dist/vtn/groups/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/groups/list/0.1/payload.js +282 -0
- package/dist/vtn/groups/list/0.1/payload.js.map +1 -0
- package/dist/vtn/groups/register/0.1/payload.d.ts +504 -0
- package/dist/vtn/groups/register/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/groups/register/0.1/payload.js +291 -0
- package/dist/vtn/groups/register/0.1/payload.js.map +1 -0
- package/dist/vtn/listings/create/0.1/payload.d.ts +954 -0
- package/dist/vtn/listings/create/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/listings/create/0.1/payload.js +549 -0
- package/dist/vtn/listings/create/0.1/payload.js.map +1 -0
- package/dist/vtn/listings/list/0.1/payload.d.ts +933 -0
- package/dist/vtn/listings/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/listings/list/0.1/payload.js +538 -0
- package/dist/vtn/listings/list/0.1/payload.js.map +1 -0
- package/dist/vtn/listings/reinstate/0.1/payload.d.ts +926 -0
- package/dist/vtn/listings/reinstate/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/listings/reinstate/0.1/payload.js +536 -0
- package/dist/vtn/listings/reinstate/0.1/payload.js.map +1 -0
- package/dist/vtn/listings/remove/0.1/payload.d.ts +926 -0
- package/dist/vtn/listings/remove/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/listings/remove/0.1/payload.js +536 -0
- package/dist/vtn/listings/remove/0.1/payload.js.map +1 -0
- package/dist/vtn/listings/show/0.1/payload.d.ts +914 -0
- package/dist/vtn/listings/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/listings/show/0.1/payload.js +532 -0
- package/dist/vtn/listings/show/0.1/payload.js.map +1 -0
- package/dist/vtn/listings/suspend/0.1/payload.d.ts +926 -0
- package/dist/vtn/listings/suspend/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/listings/suspend/0.1/payload.js +536 -0
- package/dist/vtn/listings/suspend/0.1/payload.js.map +1 -0
- package/dist/vtn/listings/update/0.1/payload.d.ts +966 -0
- package/dist/vtn/listings/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/listings/update/0.1/payload.js +550 -0
- package/dist/vtn/listings/update/0.1/payload.js.map +1 -0
- package/dist/vtn/membership/acknowledge/0.1/payload.d.ts +654 -0
- package/dist/vtn/membership/acknowledge/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/membership/acknowledge/0.1/payload.js +386 -0
- package/dist/vtn/membership/acknowledge/0.1/payload.js.map +1 -0
- package/dist/vtn/membership/offer/0.1/payload.d.ts +247 -0
- package/dist/vtn/membership/offer/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/membership/offer/0.1/payload.js +147 -0
- package/dist/vtn/membership/offer/0.1/payload.js.map +1 -0
- package/dist/vtn/membership/repudiate/0.1/payload.d.ts +654 -0
- package/dist/vtn/membership/repudiate/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/membership/repudiate/0.1/payload.js +386 -0
- package/dist/vtn/membership/repudiate/0.1/payload.js.map +1 -0
- package/dist/vtn/memberships/groups/add/0.1/payload.d.ts +677 -0
- package/dist/vtn/memberships/groups/add/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/memberships/groups/add/0.1/payload.js +394 -0
- package/dist/vtn/memberships/groups/add/0.1/payload.js.map +1 -0
- package/dist/vtn/memberships/join/0.1/payload.d.ts +755 -0
- package/dist/vtn/memberships/join/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/memberships/join/0.1/payload.js +438 -0
- package/dist/vtn/memberships/join/0.1/payload.js.map +1 -0
- package/dist/vtn/memberships/leave/0.1/payload.d.ts +653 -0
- package/dist/vtn/memberships/leave/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/memberships/leave/0.1/payload.js +384 -0
- package/dist/vtn/memberships/leave/0.1/payload.js.map +1 -0
- package/dist/vtn/memberships/list/0.1/payload.d.ts +651 -0
- package/dist/vtn/memberships/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/memberships/list/0.1/payload.js +383 -0
- package/dist/vtn/memberships/list/0.1/payload.js.map +1 -0
- package/dist/vtn/memberships/repudiate/0.1/payload.d.ts +669 -0
- package/dist/vtn/memberships/repudiate/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/memberships/repudiate/0.1/payload.js +391 -0
- package/dist/vtn/memberships/repudiate/0.1/payload.js.map +1 -0
- package/dist/vtn/outbox/list/0.1/payload.d.ts +567 -0
- package/dist/vtn/outbox/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/outbox/list/0.1/payload.js +333 -0
- package/dist/vtn/outbox/list/0.1/payload.js.map +1 -0
- package/dist/vtn/outbox/retry/0.1/payload.d.ts +235 -0
- package/dist/vtn/outbox/retry/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/outbox/retry/0.1/payload.js +141 -0
- package/dist/vtn/outbox/retry/0.1/payload.js.map +1 -0
- package/dist/vtn/relay/deliver/0.1/payload.d.ts +592 -0
- package/dist/vtn/relay/deliver/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/relay/deliver/0.1/payload.js +352 -0
- package/dist/vtn/relay/deliver/0.1/payload.js.map +1 -0
- package/dist/vtn/roles/list/0.1/payload.d.ts +371 -0
- package/dist/vtn/roles/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/roles/list/0.1/payload.js +213 -0
- package/dist/vtn/roles/list/0.1/payload.js.map +1 -0
- package/dist/vtn/rooms/list/0.1/payload.d.ts +447 -0
- package/dist/vtn/rooms/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/rooms/list/0.1/payload.js +255 -0
- package/dist/vtn/rooms/list/0.1/payload.js.map +1 -0
- package/dist/vtn/rooms/pass/0.1/payload.d.ts +674 -0
- package/dist/vtn/rooms/pass/0.1/payload.d.ts.map +1 -0
- package/dist/vtn/rooms/pass/0.1/payload.js +383 -0
- package/dist/vtn/rooms/pass/0.1/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_shared/components.ts +922 -0
- package/src/index.ts +144 -0
- package/src/vta/notifications/deposit/0.1/payload.ts +243 -0
- package/src/vta/pcs/vetter/recover/0.1/payload.ts +437 -0
- package/src/vtc/notifications/_shared/0.1/received-notification.ts +17 -0
- package/src/vtc/notifications/list/0.1/payload.ts +809 -0
- package/src/vtc/notifications/relay/0.1/payload.ts +382 -0
- package/src/vtc/notifications/show/0.1/payload.ts +761 -0
- package/src/vtc/vetting/vetters/pcs-binding/reset/0.1/payload.ts +247 -0
- package/src/vtc/vetting/vetters/pcs-binding/show/0.1/payload.ts +295 -0
- package/src/vtn/_shared/0.1/directory.ts +17 -0
- package/src/vtn/_shared/0.1/entry.ts +17 -0
- package/src/vtn/_shared/0.1/graph.ts +17 -0
- package/src/vtn/_shared/0.1/groups.ts +17 -0
- package/src/vtn/_shared/0.1/membership.ts +17 -0
- package/src/vtn/_shared/0.1/relay.ts +17 -0
- package/src/vtn/_shared/0.1/rooms.ts +17 -0
- package/src/vtn/audit/list/0.1/payload.ts +336 -0
- package/src/vtn/broadcasts/list/0.1/payload.ts +447 -0
- package/src/vtn/broadcasts/send/0.1/payload.ts +478 -0
- package/src/vtn/broadcasts/show/0.1/payload.ts +439 -0
- package/src/vtn/directory/federated/0.1/payload.ts +594 -0
- package/src/vtn/directory/search/0.1/payload.ts +418 -0
- package/src/vtn/directory/summary/0.1/payload.ts +253 -0
- package/src/vtn/entries/show/0.1/payload.ts +439 -0
- package/src/vtn/graph/member/0.1/payload.ts +511 -0
- package/src/vtn/graph/show/0.1/payload.ts +509 -0
- package/src/vtn/groups/list/0.1/payload.ts +322 -0
- package/src/vtn/groups/register/0.1/payload.ts +336 -0
- package/src/vtn/listings/create/0.1/payload.ts +594 -0
- package/src/vtn/listings/list/0.1/payload.ts +578 -0
- package/src/vtn/listings/reinstate/0.1/payload.ts +577 -0
- package/src/vtn/listings/remove/0.1/payload.ts +577 -0
- package/src/vtn/listings/show/0.1/payload.ts +569 -0
- package/src/vtn/listings/suspend/0.1/payload.ts +577 -0
- package/src/vtn/listings/update/0.1/payload.ts +603 -0
- package/src/vtn/membership/acknowledge/0.1/payload.ts +423 -0
- package/src/vtn/membership/offer/0.1/payload.ts +183 -0
- package/src/vtn/membership/repudiate/0.1/payload.ts +423 -0
- package/src/vtn/memberships/groups/add/0.1/payload.ts +442 -0
- package/src/vtn/memberships/join/0.1/payload.ts +488 -0
- package/src/vtn/memberships/leave/0.1/payload.ts +424 -0
- package/src/vtn/memberships/list/0.1/payload.ts +419 -0
- package/src/vtn/memberships/repudiate/0.1/payload.ts +435 -0
- package/src/vtn/outbox/list/0.1/payload.ts +369 -0
- package/src/vtn/outbox/retry/0.1/payload.ts +177 -0
- package/src/vtn/relay/deliver/0.1/payload.ts +397 -0
- package/src/vtn/roles/list/0.1/payload.ts +253 -0
- package/src/vtn/rooms/list/0.1/payload.ts +295 -0
- package/src/vtn/rooms/pass/0.1/payload.ts +439 -0
|
@@ -0,0 +1,667 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vta/pcs/vetter/recover/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext, Multibase_VtaV0_4 as Multibase, TokenDraw, VetterSummary } from "../../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* A vetter's client asks its VTA to restore the vetter key a community has bound the member to, when the vetter engine holds a different key or none. The VTA searches the keys it can derive for the context and, if one matches, makes it the engine's key.
|
|
8
|
+
*/
|
|
9
|
+
export interface VTAPCSVetterRecoverPayload {
|
|
10
|
+
/**
|
|
11
|
+
* The context the engine belongs to. Only keys derived from this context's base are searched.
|
|
12
|
+
*/
|
|
13
|
+
contextId: string;
|
|
14
|
+
/**
|
|
15
|
+
* The community's DID: the helper whose parameters the engine runs under.
|
|
16
|
+
*/
|
|
17
|
+
community: string;
|
|
18
|
+
/**
|
|
19
|
+
* The vetter's member DID in the community.
|
|
20
|
+
*/
|
|
21
|
+
memberDid: string;
|
|
22
|
+
/**
|
|
23
|
+
* The PCS identifier the community has bound to the member, as vtc/vetting/vetters/pcs-binding/show/0.1 returns it.
|
|
24
|
+
*/
|
|
25
|
+
boundId: string;
|
|
26
|
+
ext?: Ext;
|
|
27
|
+
}
|
|
28
|
+
export interface VTAPCSVetterRecoverResponsePayload {
|
|
29
|
+
/**
|
|
30
|
+
* True when the engine's key was replaced by the bound one; false when the engine already held it.
|
|
31
|
+
*/
|
|
32
|
+
recovered: boolean;
|
|
33
|
+
vetter: VetterSummary;
|
|
34
|
+
ext?: Ext;
|
|
35
|
+
}
|
|
36
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
37
|
+
export type { Ext, Multibase, TokenDraw, VetterSummary };
|
|
38
|
+
/** Trust Task type URI. */
|
|
39
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vta/pcs/vetter/recover/0.1";
|
|
40
|
+
/**
|
|
41
|
+
* The earlier version of this specification that this one declares it
|
|
42
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
43
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
44
|
+
* `extendsChain` / `readForSpec`.
|
|
45
|
+
*/
|
|
46
|
+
export declare const EXTENDS: string | null;
|
|
47
|
+
/**
|
|
48
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
49
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
50
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
51
|
+
* Versions").
|
|
52
|
+
*/
|
|
53
|
+
export declare const DEPRECATION: string | null;
|
|
54
|
+
/** Stable alias for this specification's request payload shape. */
|
|
55
|
+
export type Payload = VTAPCSVetterRecoverPayload;
|
|
56
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
57
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/pcs/vetter/recover/0.1#response";
|
|
58
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
59
|
+
export type Response = VTAPCSVetterRecoverResponsePayload;
|
|
60
|
+
/**
|
|
61
|
+
* This specification's payload schema, as a value.
|
|
62
|
+
*
|
|
63
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
64
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
65
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
66
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
67
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
68
|
+
*/
|
|
69
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
70
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
71
|
+
readonly $id: "https://trusttasks.org/spec/vta/pcs/vetter/recover/0.1";
|
|
72
|
+
readonly title: "VTA PCS — Vetter — Recover — payload";
|
|
73
|
+
readonly description: "A vetter's client asks its VTA to restore the vetter key a community has bound the member to, when the vetter engine holds a different key or none. The VTA searches the keys it can derive for the context and, if one matches, makes it the engine's key.";
|
|
74
|
+
readonly type: "object";
|
|
75
|
+
readonly additionalProperties: false;
|
|
76
|
+
readonly required: readonly ["contextId", "community", "memberDid", "boundId"];
|
|
77
|
+
readonly properties: {
|
|
78
|
+
readonly contextId: {
|
|
79
|
+
readonly type: "string";
|
|
80
|
+
readonly minLength: 1;
|
|
81
|
+
readonly description: "The context the engine belongs to. Only keys derived from this context's base are searched.";
|
|
82
|
+
};
|
|
83
|
+
readonly community: {
|
|
84
|
+
readonly type: "string";
|
|
85
|
+
readonly minLength: 1;
|
|
86
|
+
readonly description: "The community's DID: the helper whose parameters the engine runs under.";
|
|
87
|
+
};
|
|
88
|
+
readonly memberDid: {
|
|
89
|
+
readonly type: "string";
|
|
90
|
+
readonly minLength: 1;
|
|
91
|
+
readonly description: "The vetter's member DID in the community.";
|
|
92
|
+
};
|
|
93
|
+
readonly boundId: {
|
|
94
|
+
readonly type: "string";
|
|
95
|
+
readonly pattern: "^z[1-9A-HJ-NP-Za-km-z]+$";
|
|
96
|
+
readonly description: "The PCS identifier the community has bound to the member, as vtc/vetting/vetters/pcs-binding/show/0.1 returns it.";
|
|
97
|
+
};
|
|
98
|
+
readonly ext: {
|
|
99
|
+
readonly $ref: "#/$defs/Ext";
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
readonly $defs: {
|
|
103
|
+
readonly Response: {
|
|
104
|
+
readonly $anchor: "response";
|
|
105
|
+
readonly title: "VTA PCS — Vetter — Recover — response payload";
|
|
106
|
+
readonly type: "object";
|
|
107
|
+
readonly additionalProperties: false;
|
|
108
|
+
readonly required: readonly ["recovered", "vetter"];
|
|
109
|
+
readonly properties: {
|
|
110
|
+
readonly recovered: {
|
|
111
|
+
readonly type: "boolean";
|
|
112
|
+
readonly description: "True when the engine's key was replaced by the bound one; false when the engine already held it.";
|
|
113
|
+
};
|
|
114
|
+
readonly vetter: {
|
|
115
|
+
readonly $ref: "#/$defs/VetterSummary";
|
|
116
|
+
};
|
|
117
|
+
readonly ext: {
|
|
118
|
+
readonly $ref: "#/$defs/Ext";
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
readonly Ext: {
|
|
123
|
+
readonly title: "Ext";
|
|
124
|
+
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.";
|
|
125
|
+
readonly type: "object";
|
|
126
|
+
readonly minProperties: 1;
|
|
127
|
+
readonly additionalProperties: true;
|
|
128
|
+
readonly propertyNames: {
|
|
129
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
130
|
+
};
|
|
131
|
+
};
|
|
132
|
+
readonly VetterSummary: {
|
|
133
|
+
readonly title: "VetterSummary";
|
|
134
|
+
readonly description: "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.";
|
|
135
|
+
readonly type: "object";
|
|
136
|
+
readonly additionalProperties: false;
|
|
137
|
+
readonly required: readonly ["contextId", "community", "memberDid", "suite", "id", "enrolledLabels", "pendingLabels", "tokensFree", "tokensHeld", "drawsInFlight", "attested"];
|
|
138
|
+
readonly properties: {
|
|
139
|
+
readonly contextId: {
|
|
140
|
+
readonly type: "string";
|
|
141
|
+
readonly minLength: 1;
|
|
142
|
+
};
|
|
143
|
+
readonly community: {
|
|
144
|
+
readonly type: "string";
|
|
145
|
+
readonly minLength: 1;
|
|
146
|
+
};
|
|
147
|
+
readonly memberDid: {
|
|
148
|
+
readonly type: "string";
|
|
149
|
+
readonly minLength: 1;
|
|
150
|
+
readonly description: "The member DID the engine draws tokens as. Bound into every token request.";
|
|
151
|
+
};
|
|
152
|
+
readonly suite: {
|
|
153
|
+
readonly type: "string";
|
|
154
|
+
readonly minLength: 1;
|
|
155
|
+
readonly maxLength: 64;
|
|
156
|
+
};
|
|
157
|
+
readonly id: {
|
|
158
|
+
readonly $ref: "#/$defs/Multibase";
|
|
159
|
+
readonly description: "The vetter's PCS identifier for this community.";
|
|
160
|
+
};
|
|
161
|
+
readonly enrolledLabels: {
|
|
162
|
+
readonly type: "array";
|
|
163
|
+
readonly description: "Class labels this vetter holds a credential under, newest first.";
|
|
164
|
+
readonly items: {
|
|
165
|
+
readonly type: "string";
|
|
166
|
+
readonly pattern: "^vetter/[0-9]{4}-[0-9]{2}$";
|
|
167
|
+
};
|
|
168
|
+
};
|
|
169
|
+
readonly pendingLabels: {
|
|
170
|
+
readonly type: "array";
|
|
171
|
+
readonly description: "Class labels requested and not yet accepted.";
|
|
172
|
+
readonly items: {
|
|
173
|
+
readonly type: "string";
|
|
174
|
+
readonly pattern: "^vetter/[0-9]{4}-[0-9]{2}$";
|
|
175
|
+
};
|
|
176
|
+
};
|
|
177
|
+
readonly tokensFree: {
|
|
178
|
+
readonly type: "integer";
|
|
179
|
+
readonly minimum: 0;
|
|
180
|
+
readonly description: "Tokens held and not reserved.";
|
|
181
|
+
};
|
|
182
|
+
readonly tokensHeld: {
|
|
183
|
+
readonly type: "integer";
|
|
184
|
+
readonly minimum: 0;
|
|
185
|
+
readonly description: "Tokens held in all.";
|
|
186
|
+
};
|
|
187
|
+
readonly drawsInFlight: {
|
|
188
|
+
readonly type: "array";
|
|
189
|
+
readonly description: "Draws requested and not yet accepted or abandoned.";
|
|
190
|
+
readonly items: {
|
|
191
|
+
readonly $ref: "#/$defs/TokenDraw";
|
|
192
|
+
};
|
|
193
|
+
};
|
|
194
|
+
readonly attested: {
|
|
195
|
+
readonly type: "integer";
|
|
196
|
+
readonly minimum: 0;
|
|
197
|
+
readonly description: "Attestations made through this engine.";
|
|
198
|
+
};
|
|
199
|
+
};
|
|
200
|
+
};
|
|
201
|
+
readonly TokenDraw: {
|
|
202
|
+
readonly title: "TokenDraw";
|
|
203
|
+
readonly description: "One draw of the token drip: a label and a tick.";
|
|
204
|
+
readonly type: "object";
|
|
205
|
+
readonly additionalProperties: false;
|
|
206
|
+
readonly required: readonly ["label", "tick"];
|
|
207
|
+
readonly properties: {
|
|
208
|
+
readonly label: {
|
|
209
|
+
readonly type: "string";
|
|
210
|
+
readonly minLength: 1;
|
|
211
|
+
readonly maxLength: 128;
|
|
212
|
+
};
|
|
213
|
+
readonly tick: {
|
|
214
|
+
readonly type: "integer";
|
|
215
|
+
readonly minimum: 0;
|
|
216
|
+
};
|
|
217
|
+
};
|
|
218
|
+
};
|
|
219
|
+
readonly Multibase: {
|
|
220
|
+
readonly title: "Multibase";
|
|
221
|
+
readonly description: "A binary value, multibase base58btc over the suite's canonical encoding.";
|
|
222
|
+
readonly type: "string";
|
|
223
|
+
readonly pattern: "^z[1-9A-HJ-NP-Za-km-z]+$";
|
|
224
|
+
};
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
228
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
229
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
230
|
+
readonly $ref: "#/$defs/Response";
|
|
231
|
+
readonly $defs: {
|
|
232
|
+
readonly Response: {
|
|
233
|
+
readonly $anchor: "response";
|
|
234
|
+
readonly title: "VTA PCS — Vetter — Recover — response payload";
|
|
235
|
+
readonly type: "object";
|
|
236
|
+
readonly additionalProperties: false;
|
|
237
|
+
readonly required: readonly ["recovered", "vetter"];
|
|
238
|
+
readonly properties: {
|
|
239
|
+
readonly recovered: {
|
|
240
|
+
readonly type: "boolean";
|
|
241
|
+
readonly description: "True when the engine's key was replaced by the bound one; false when the engine already held it.";
|
|
242
|
+
};
|
|
243
|
+
readonly vetter: {
|
|
244
|
+
readonly $ref: "#/$defs/VetterSummary";
|
|
245
|
+
};
|
|
246
|
+
readonly ext: {
|
|
247
|
+
readonly $ref: "#/$defs/Ext";
|
|
248
|
+
};
|
|
249
|
+
};
|
|
250
|
+
};
|
|
251
|
+
readonly Ext: {
|
|
252
|
+
readonly title: "Ext";
|
|
253
|
+
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.";
|
|
254
|
+
readonly type: "object";
|
|
255
|
+
readonly minProperties: 1;
|
|
256
|
+
readonly additionalProperties: true;
|
|
257
|
+
readonly propertyNames: {
|
|
258
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
259
|
+
};
|
|
260
|
+
};
|
|
261
|
+
readonly VetterSummary: {
|
|
262
|
+
readonly title: "VetterSummary";
|
|
263
|
+
readonly description: "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.";
|
|
264
|
+
readonly type: "object";
|
|
265
|
+
readonly additionalProperties: false;
|
|
266
|
+
readonly required: readonly ["contextId", "community", "memberDid", "suite", "id", "enrolledLabels", "pendingLabels", "tokensFree", "tokensHeld", "drawsInFlight", "attested"];
|
|
267
|
+
readonly properties: {
|
|
268
|
+
readonly contextId: {
|
|
269
|
+
readonly type: "string";
|
|
270
|
+
readonly minLength: 1;
|
|
271
|
+
};
|
|
272
|
+
readonly community: {
|
|
273
|
+
readonly type: "string";
|
|
274
|
+
readonly minLength: 1;
|
|
275
|
+
};
|
|
276
|
+
readonly memberDid: {
|
|
277
|
+
readonly type: "string";
|
|
278
|
+
readonly minLength: 1;
|
|
279
|
+
readonly description: "The member DID the engine draws tokens as. Bound into every token request.";
|
|
280
|
+
};
|
|
281
|
+
readonly suite: {
|
|
282
|
+
readonly type: "string";
|
|
283
|
+
readonly minLength: 1;
|
|
284
|
+
readonly maxLength: 64;
|
|
285
|
+
};
|
|
286
|
+
readonly id: {
|
|
287
|
+
readonly $ref: "#/$defs/Multibase";
|
|
288
|
+
readonly description: "The vetter's PCS identifier for this community.";
|
|
289
|
+
};
|
|
290
|
+
readonly enrolledLabels: {
|
|
291
|
+
readonly type: "array";
|
|
292
|
+
readonly description: "Class labels this vetter holds a credential under, newest first.";
|
|
293
|
+
readonly items: {
|
|
294
|
+
readonly type: "string";
|
|
295
|
+
readonly pattern: "^vetter/[0-9]{4}-[0-9]{2}$";
|
|
296
|
+
};
|
|
297
|
+
};
|
|
298
|
+
readonly pendingLabels: {
|
|
299
|
+
readonly type: "array";
|
|
300
|
+
readonly description: "Class labels requested and not yet accepted.";
|
|
301
|
+
readonly items: {
|
|
302
|
+
readonly type: "string";
|
|
303
|
+
readonly pattern: "^vetter/[0-9]{4}-[0-9]{2}$";
|
|
304
|
+
};
|
|
305
|
+
};
|
|
306
|
+
readonly tokensFree: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 0;
|
|
309
|
+
readonly description: "Tokens held and not reserved.";
|
|
310
|
+
};
|
|
311
|
+
readonly tokensHeld: {
|
|
312
|
+
readonly type: "integer";
|
|
313
|
+
readonly minimum: 0;
|
|
314
|
+
readonly description: "Tokens held in all.";
|
|
315
|
+
};
|
|
316
|
+
readonly drawsInFlight: {
|
|
317
|
+
readonly type: "array";
|
|
318
|
+
readonly description: "Draws requested and not yet accepted or abandoned.";
|
|
319
|
+
readonly items: {
|
|
320
|
+
readonly $ref: "#/$defs/TokenDraw";
|
|
321
|
+
};
|
|
322
|
+
};
|
|
323
|
+
readonly attested: {
|
|
324
|
+
readonly type: "integer";
|
|
325
|
+
readonly minimum: 0;
|
|
326
|
+
readonly description: "Attestations made through this engine.";
|
|
327
|
+
};
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
readonly TokenDraw: {
|
|
331
|
+
readonly title: "TokenDraw";
|
|
332
|
+
readonly description: "One draw of the token drip: a label and a tick.";
|
|
333
|
+
readonly type: "object";
|
|
334
|
+
readonly additionalProperties: false;
|
|
335
|
+
readonly required: readonly ["label", "tick"];
|
|
336
|
+
readonly properties: {
|
|
337
|
+
readonly label: {
|
|
338
|
+
readonly type: "string";
|
|
339
|
+
readonly minLength: 1;
|
|
340
|
+
readonly maxLength: 128;
|
|
341
|
+
};
|
|
342
|
+
readonly tick: {
|
|
343
|
+
readonly type: "integer";
|
|
344
|
+
readonly minimum: 0;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
};
|
|
348
|
+
readonly Multibase: {
|
|
349
|
+
readonly title: "Multibase";
|
|
350
|
+
readonly description: "A binary value, multibase base58btc over the suite's canonical encoding.";
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly pattern: "^z[1-9A-HJ-NP-Za-km-z]+$";
|
|
353
|
+
};
|
|
354
|
+
};
|
|
355
|
+
};
|
|
356
|
+
/**
|
|
357
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
358
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
359
|
+
* per-specification and cannot be derived from the document alone, and
|
|
360
|
+
* item 2 needs the schema this carries.
|
|
361
|
+
*/
|
|
362
|
+
export declare const SPEC: {
|
|
363
|
+
readonly typeUri: "https://trusttasks.org/spec/vta/pcs/vetter/recover/0.1";
|
|
364
|
+
readonly isBearer: false;
|
|
365
|
+
readonly isProofRequired: false;
|
|
366
|
+
readonly isRecipientRequired: true;
|
|
367
|
+
readonly isIssuedAtRequired: true;
|
|
368
|
+
readonly payloadSchema: {
|
|
369
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
370
|
+
readonly $id: "https://trusttasks.org/spec/vta/pcs/vetter/recover/0.1";
|
|
371
|
+
readonly title: "VTA PCS — Vetter — Recover — payload";
|
|
372
|
+
readonly description: "A vetter's client asks its VTA to restore the vetter key a community has bound the member to, when the vetter engine holds a different key or none. The VTA searches the keys it can derive for the context and, if one matches, makes it the engine's key.";
|
|
373
|
+
readonly type: "object";
|
|
374
|
+
readonly additionalProperties: false;
|
|
375
|
+
readonly required: readonly ["contextId", "community", "memberDid", "boundId"];
|
|
376
|
+
readonly properties: {
|
|
377
|
+
readonly contextId: {
|
|
378
|
+
readonly type: "string";
|
|
379
|
+
readonly minLength: 1;
|
|
380
|
+
readonly description: "The context the engine belongs to. Only keys derived from this context's base are searched.";
|
|
381
|
+
};
|
|
382
|
+
readonly community: {
|
|
383
|
+
readonly type: "string";
|
|
384
|
+
readonly minLength: 1;
|
|
385
|
+
readonly description: "The community's DID: the helper whose parameters the engine runs under.";
|
|
386
|
+
};
|
|
387
|
+
readonly memberDid: {
|
|
388
|
+
readonly type: "string";
|
|
389
|
+
readonly minLength: 1;
|
|
390
|
+
readonly description: "The vetter's member DID in the community.";
|
|
391
|
+
};
|
|
392
|
+
readonly boundId: {
|
|
393
|
+
readonly type: "string";
|
|
394
|
+
readonly pattern: "^z[1-9A-HJ-NP-Za-km-z]+$";
|
|
395
|
+
readonly description: "The PCS identifier the community has bound to the member, as vtc/vetting/vetters/pcs-binding/show/0.1 returns it.";
|
|
396
|
+
};
|
|
397
|
+
readonly ext: {
|
|
398
|
+
readonly $ref: "#/$defs/Ext";
|
|
399
|
+
};
|
|
400
|
+
};
|
|
401
|
+
readonly $defs: {
|
|
402
|
+
readonly Response: {
|
|
403
|
+
readonly $anchor: "response";
|
|
404
|
+
readonly title: "VTA PCS — Vetter — Recover — response payload";
|
|
405
|
+
readonly type: "object";
|
|
406
|
+
readonly additionalProperties: false;
|
|
407
|
+
readonly required: readonly ["recovered", "vetter"];
|
|
408
|
+
readonly properties: {
|
|
409
|
+
readonly recovered: {
|
|
410
|
+
readonly type: "boolean";
|
|
411
|
+
readonly description: "True when the engine's key was replaced by the bound one; false when the engine already held it.";
|
|
412
|
+
};
|
|
413
|
+
readonly vetter: {
|
|
414
|
+
readonly $ref: "#/$defs/VetterSummary";
|
|
415
|
+
};
|
|
416
|
+
readonly ext: {
|
|
417
|
+
readonly $ref: "#/$defs/Ext";
|
|
418
|
+
};
|
|
419
|
+
};
|
|
420
|
+
};
|
|
421
|
+
readonly Ext: {
|
|
422
|
+
readonly title: "Ext";
|
|
423
|
+
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.";
|
|
424
|
+
readonly type: "object";
|
|
425
|
+
readonly minProperties: 1;
|
|
426
|
+
readonly additionalProperties: true;
|
|
427
|
+
readonly propertyNames: {
|
|
428
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
readonly VetterSummary: {
|
|
432
|
+
readonly title: "VetterSummary";
|
|
433
|
+
readonly description: "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.";
|
|
434
|
+
readonly type: "object";
|
|
435
|
+
readonly additionalProperties: false;
|
|
436
|
+
readonly required: readonly ["contextId", "community", "memberDid", "suite", "id", "enrolledLabels", "pendingLabels", "tokensFree", "tokensHeld", "drawsInFlight", "attested"];
|
|
437
|
+
readonly properties: {
|
|
438
|
+
readonly contextId: {
|
|
439
|
+
readonly type: "string";
|
|
440
|
+
readonly minLength: 1;
|
|
441
|
+
};
|
|
442
|
+
readonly community: {
|
|
443
|
+
readonly type: "string";
|
|
444
|
+
readonly minLength: 1;
|
|
445
|
+
};
|
|
446
|
+
readonly memberDid: {
|
|
447
|
+
readonly type: "string";
|
|
448
|
+
readonly minLength: 1;
|
|
449
|
+
readonly description: "The member DID the engine draws tokens as. Bound into every token request.";
|
|
450
|
+
};
|
|
451
|
+
readonly suite: {
|
|
452
|
+
readonly type: "string";
|
|
453
|
+
readonly minLength: 1;
|
|
454
|
+
readonly maxLength: 64;
|
|
455
|
+
};
|
|
456
|
+
readonly id: {
|
|
457
|
+
readonly $ref: "#/$defs/Multibase";
|
|
458
|
+
readonly description: "The vetter's PCS identifier for this community.";
|
|
459
|
+
};
|
|
460
|
+
readonly enrolledLabels: {
|
|
461
|
+
readonly type: "array";
|
|
462
|
+
readonly description: "Class labels this vetter holds a credential under, newest first.";
|
|
463
|
+
readonly items: {
|
|
464
|
+
readonly type: "string";
|
|
465
|
+
readonly pattern: "^vetter/[0-9]{4}-[0-9]{2}$";
|
|
466
|
+
};
|
|
467
|
+
};
|
|
468
|
+
readonly pendingLabels: {
|
|
469
|
+
readonly type: "array";
|
|
470
|
+
readonly description: "Class labels requested and not yet accepted.";
|
|
471
|
+
readonly items: {
|
|
472
|
+
readonly type: "string";
|
|
473
|
+
readonly pattern: "^vetter/[0-9]{4}-[0-9]{2}$";
|
|
474
|
+
};
|
|
475
|
+
};
|
|
476
|
+
readonly tokensFree: {
|
|
477
|
+
readonly type: "integer";
|
|
478
|
+
readonly minimum: 0;
|
|
479
|
+
readonly description: "Tokens held and not reserved.";
|
|
480
|
+
};
|
|
481
|
+
readonly tokensHeld: {
|
|
482
|
+
readonly type: "integer";
|
|
483
|
+
readonly minimum: 0;
|
|
484
|
+
readonly description: "Tokens held in all.";
|
|
485
|
+
};
|
|
486
|
+
readonly drawsInFlight: {
|
|
487
|
+
readonly type: "array";
|
|
488
|
+
readonly description: "Draws requested and not yet accepted or abandoned.";
|
|
489
|
+
readonly items: {
|
|
490
|
+
readonly $ref: "#/$defs/TokenDraw";
|
|
491
|
+
};
|
|
492
|
+
};
|
|
493
|
+
readonly attested: {
|
|
494
|
+
readonly type: "integer";
|
|
495
|
+
readonly minimum: 0;
|
|
496
|
+
readonly description: "Attestations made through this engine.";
|
|
497
|
+
};
|
|
498
|
+
};
|
|
499
|
+
};
|
|
500
|
+
readonly TokenDraw: {
|
|
501
|
+
readonly title: "TokenDraw";
|
|
502
|
+
readonly description: "One draw of the token drip: a label and a tick.";
|
|
503
|
+
readonly type: "object";
|
|
504
|
+
readonly additionalProperties: false;
|
|
505
|
+
readonly required: readonly ["label", "tick"];
|
|
506
|
+
readonly properties: {
|
|
507
|
+
readonly label: {
|
|
508
|
+
readonly type: "string";
|
|
509
|
+
readonly minLength: 1;
|
|
510
|
+
readonly maxLength: 128;
|
|
511
|
+
};
|
|
512
|
+
readonly tick: {
|
|
513
|
+
readonly type: "integer";
|
|
514
|
+
readonly minimum: 0;
|
|
515
|
+
};
|
|
516
|
+
};
|
|
517
|
+
};
|
|
518
|
+
readonly Multibase: {
|
|
519
|
+
readonly title: "Multibase";
|
|
520
|
+
readonly description: "A binary value, multibase base58btc over the suite's canonical encoding.";
|
|
521
|
+
readonly type: "string";
|
|
522
|
+
readonly pattern: "^z[1-9A-HJ-NP-Za-km-z]+$";
|
|
523
|
+
};
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
};
|
|
527
|
+
/**
|
|
528
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
529
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
530
|
+
* parties (§7.3 item 5).
|
|
531
|
+
*/
|
|
532
|
+
export declare const RESPONSE_SPEC: {
|
|
533
|
+
readonly typeUri: "https://trusttasks.org/spec/vta/pcs/vetter/recover/0.1#response";
|
|
534
|
+
readonly isBearer: false;
|
|
535
|
+
readonly isProofRequired: false;
|
|
536
|
+
readonly isRecipientRequired: true;
|
|
537
|
+
readonly isIssuedAtRequired: true;
|
|
538
|
+
readonly payloadSchema: {
|
|
539
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
540
|
+
readonly $ref: "#/$defs/Response";
|
|
541
|
+
readonly $defs: {
|
|
542
|
+
readonly Response: {
|
|
543
|
+
readonly $anchor: "response";
|
|
544
|
+
readonly title: "VTA PCS — Vetter — Recover — response payload";
|
|
545
|
+
readonly type: "object";
|
|
546
|
+
readonly additionalProperties: false;
|
|
547
|
+
readonly required: readonly ["recovered", "vetter"];
|
|
548
|
+
readonly properties: {
|
|
549
|
+
readonly recovered: {
|
|
550
|
+
readonly type: "boolean";
|
|
551
|
+
readonly description: "True when the engine's key was replaced by the bound one; false when the engine already held it.";
|
|
552
|
+
};
|
|
553
|
+
readonly vetter: {
|
|
554
|
+
readonly $ref: "#/$defs/VetterSummary";
|
|
555
|
+
};
|
|
556
|
+
readonly ext: {
|
|
557
|
+
readonly $ref: "#/$defs/Ext";
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
};
|
|
561
|
+
readonly Ext: {
|
|
562
|
+
readonly title: "Ext";
|
|
563
|
+
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.";
|
|
564
|
+
readonly type: "object";
|
|
565
|
+
readonly minProperties: 1;
|
|
566
|
+
readonly additionalProperties: true;
|
|
567
|
+
readonly propertyNames: {
|
|
568
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
569
|
+
};
|
|
570
|
+
};
|
|
571
|
+
readonly VetterSummary: {
|
|
572
|
+
readonly title: "VetterSummary";
|
|
573
|
+
readonly description: "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.";
|
|
574
|
+
readonly type: "object";
|
|
575
|
+
readonly additionalProperties: false;
|
|
576
|
+
readonly required: readonly ["contextId", "community", "memberDid", "suite", "id", "enrolledLabels", "pendingLabels", "tokensFree", "tokensHeld", "drawsInFlight", "attested"];
|
|
577
|
+
readonly properties: {
|
|
578
|
+
readonly contextId: {
|
|
579
|
+
readonly type: "string";
|
|
580
|
+
readonly minLength: 1;
|
|
581
|
+
};
|
|
582
|
+
readonly community: {
|
|
583
|
+
readonly type: "string";
|
|
584
|
+
readonly minLength: 1;
|
|
585
|
+
};
|
|
586
|
+
readonly memberDid: {
|
|
587
|
+
readonly type: "string";
|
|
588
|
+
readonly minLength: 1;
|
|
589
|
+
readonly description: "The member DID the engine draws tokens as. Bound into every token request.";
|
|
590
|
+
};
|
|
591
|
+
readonly suite: {
|
|
592
|
+
readonly type: "string";
|
|
593
|
+
readonly minLength: 1;
|
|
594
|
+
readonly maxLength: 64;
|
|
595
|
+
};
|
|
596
|
+
readonly id: {
|
|
597
|
+
readonly $ref: "#/$defs/Multibase";
|
|
598
|
+
readonly description: "The vetter's PCS identifier for this community.";
|
|
599
|
+
};
|
|
600
|
+
readonly enrolledLabels: {
|
|
601
|
+
readonly type: "array";
|
|
602
|
+
readonly description: "Class labels this vetter holds a credential under, newest first.";
|
|
603
|
+
readonly items: {
|
|
604
|
+
readonly type: "string";
|
|
605
|
+
readonly pattern: "^vetter/[0-9]{4}-[0-9]{2}$";
|
|
606
|
+
};
|
|
607
|
+
};
|
|
608
|
+
readonly pendingLabels: {
|
|
609
|
+
readonly type: "array";
|
|
610
|
+
readonly description: "Class labels requested and not yet accepted.";
|
|
611
|
+
readonly items: {
|
|
612
|
+
readonly type: "string";
|
|
613
|
+
readonly pattern: "^vetter/[0-9]{4}-[0-9]{2}$";
|
|
614
|
+
};
|
|
615
|
+
};
|
|
616
|
+
readonly tokensFree: {
|
|
617
|
+
readonly type: "integer";
|
|
618
|
+
readonly minimum: 0;
|
|
619
|
+
readonly description: "Tokens held and not reserved.";
|
|
620
|
+
};
|
|
621
|
+
readonly tokensHeld: {
|
|
622
|
+
readonly type: "integer";
|
|
623
|
+
readonly minimum: 0;
|
|
624
|
+
readonly description: "Tokens held in all.";
|
|
625
|
+
};
|
|
626
|
+
readonly drawsInFlight: {
|
|
627
|
+
readonly type: "array";
|
|
628
|
+
readonly description: "Draws requested and not yet accepted or abandoned.";
|
|
629
|
+
readonly items: {
|
|
630
|
+
readonly $ref: "#/$defs/TokenDraw";
|
|
631
|
+
};
|
|
632
|
+
};
|
|
633
|
+
readonly attested: {
|
|
634
|
+
readonly type: "integer";
|
|
635
|
+
readonly minimum: 0;
|
|
636
|
+
readonly description: "Attestations made through this engine.";
|
|
637
|
+
};
|
|
638
|
+
};
|
|
639
|
+
};
|
|
640
|
+
readonly TokenDraw: {
|
|
641
|
+
readonly title: "TokenDraw";
|
|
642
|
+
readonly description: "One draw of the token drip: a label and a tick.";
|
|
643
|
+
readonly type: "object";
|
|
644
|
+
readonly additionalProperties: false;
|
|
645
|
+
readonly required: readonly ["label", "tick"];
|
|
646
|
+
readonly properties: {
|
|
647
|
+
readonly label: {
|
|
648
|
+
readonly type: "string";
|
|
649
|
+
readonly minLength: 1;
|
|
650
|
+
readonly maxLength: 128;
|
|
651
|
+
};
|
|
652
|
+
readonly tick: {
|
|
653
|
+
readonly type: "integer";
|
|
654
|
+
readonly minimum: 0;
|
|
655
|
+
};
|
|
656
|
+
};
|
|
657
|
+
};
|
|
658
|
+
readonly Multibase: {
|
|
659
|
+
readonly title: "Multibase";
|
|
660
|
+
readonly description: "A binary value, multibase base58btc over the suite's canonical encoding.";
|
|
661
|
+
readonly type: "string";
|
|
662
|
+
readonly pattern: "^z[1-9A-HJ-NP-Za-km-z]+$";
|
|
663
|
+
};
|
|
664
|
+
};
|
|
665
|
+
};
|
|
666
|
+
};
|
|
667
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vta/pcs/vetter/recover/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,IAAI,SAAS,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAG1H;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,aAAa,CAAC;IACtB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC;AAEzD,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,wDAAiE,CAAC;AAE1F;;;;;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,0BAA0B,CAAC;AAEjD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,iEAA0E,CAAC;AAE5G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,kCAAkC,CAAC;AAE1D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoLjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiJ1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|