@openvtc/trust-tasks 0.28.10 → 0.28.12
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 +136 -0
- package/dist/_shared/components.d.ts +941 -0
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +156 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +156 -0
- package/dist/index.js.map +1 -1
- package/dist/vta/collection/_shared/0.1/collection.d.ts +16 -0
- package/dist/vta/collection/_shared/0.1/collection.d.ts.map +1 -0
- package/dist/vta/collection/_shared/0.1/collection.js +6 -0
- package/dist/vta/collection/_shared/0.1/collection.js.map +1 -0
- package/dist/vta/collection/claim/0.1/payload.d.ts +352 -0
- package/dist/vta/collection/claim/0.1/payload.d.ts.map +1 -0
- package/dist/vta/collection/claim/0.1/payload.js +198 -0
- package/dist/vta/collection/claim/0.1/payload.js.map +1 -0
- package/dist/vta/collection/list/0.1/payload.d.ts +740 -0
- package/dist/vta/collection/list/0.1/payload.d.ts.map +1 -0
- package/dist/vta/collection/list/0.1/payload.js +447 -0
- package/dist/vta/collection/list/0.1/payload.js.map +1 -0
- package/dist/vta/collection/release/0.1/payload.d.ts +316 -0
- package/dist/vta/collection/release/0.1/payload.d.ts.map +1 -0
- package/dist/vta/collection/release/0.1/payload.js +182 -0
- package/dist/vta/collection/release/0.1/payload.js.map +1 -0
- 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 +960 -0
- package/src/index.ts +156 -0
- package/src/vta/collection/_shared/0.1/collection.ts +17 -0
- package/src/vta/collection/claim/0.1/payload.ts +247 -0
- package/src/vta/collection/list/0.1/payload.ts +500 -0
- package/src/vta/collection/release/0.1/payload.ts +223 -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,687 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtn/broadcasts/list/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { BroadcastRecord, Credential, DeliveryStatus, Did_VtnV0_1 as Did, Ext, Receipt, RoleName_VtnV0_1 as RoleName } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* An administrator's request for the broadcasts this network sent or relayed, newest first. The outer document members are owned by the framework — SPEC §6.3.
|
|
8
|
+
*/
|
|
9
|
+
export interface VTNBroadcastsListPayload {
|
|
10
|
+
/**
|
|
11
|
+
* The most records to return. Absent: all of them.
|
|
12
|
+
*/
|
|
13
|
+
limit?: number;
|
|
14
|
+
ext?: Ext;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* The broadcast records, newest first.
|
|
18
|
+
*/
|
|
19
|
+
export interface VTNBroadcastsListResponsePayload {
|
|
20
|
+
/**
|
|
21
|
+
* Sent and received broadcasts, newest first.
|
|
22
|
+
*/
|
|
23
|
+
broadcasts: BroadcastRecord[];
|
|
24
|
+
ext?: Ext;
|
|
25
|
+
}
|
|
26
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
27
|
+
export type { BroadcastRecord, Credential, DeliveryStatus, Did, Ext, Receipt, RoleName };
|
|
28
|
+
/** Trust Task type URI. */
|
|
29
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vtn/broadcasts/list/0.1";
|
|
30
|
+
/**
|
|
31
|
+
* The earlier version of this specification that this one declares it
|
|
32
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
33
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
34
|
+
* `extendsChain` / `readForSpec`.
|
|
35
|
+
*/
|
|
36
|
+
export declare const EXTENDS: string | null;
|
|
37
|
+
/**
|
|
38
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
39
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
40
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
41
|
+
* Versions").
|
|
42
|
+
*/
|
|
43
|
+
export declare const DEPRECATION: string | null;
|
|
44
|
+
/** Stable alias for this specification's request payload shape. */
|
|
45
|
+
export type Payload = VTNBroadcastsListPayload;
|
|
46
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
47
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtn/broadcasts/list/0.1#response";
|
|
48
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
49
|
+
export type Response = VTNBroadcastsListResponsePayload;
|
|
50
|
+
/**
|
|
51
|
+
* This specification's payload schema, as a value.
|
|
52
|
+
*
|
|
53
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
54
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
55
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
56
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
57
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
58
|
+
*/
|
|
59
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
60
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
61
|
+
readonly $id: "https://trusttasks.org/spec/vtn/broadcasts/list/0.1";
|
|
62
|
+
readonly title: "VTN Broadcasts — List — payload";
|
|
63
|
+
readonly description: "An administrator's request for the broadcasts this network sent or relayed, newest first. The outer document members are owned by the framework — SPEC §6.3.";
|
|
64
|
+
readonly type: "object";
|
|
65
|
+
readonly additionalProperties: false;
|
|
66
|
+
readonly properties: {
|
|
67
|
+
readonly limit: {
|
|
68
|
+
readonly type: "integer";
|
|
69
|
+
readonly minimum: 1;
|
|
70
|
+
readonly maximum: 1000;
|
|
71
|
+
readonly description: "The most records to return. Absent: all of them.";
|
|
72
|
+
};
|
|
73
|
+
readonly ext: {
|
|
74
|
+
readonly $ref: "#/$defs/Ext";
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
readonly $defs: {
|
|
78
|
+
readonly Response: {
|
|
79
|
+
readonly $anchor: "response";
|
|
80
|
+
readonly title: "VTN Broadcasts — List — response payload";
|
|
81
|
+
readonly description: "The broadcast records, newest first.";
|
|
82
|
+
readonly type: "object";
|
|
83
|
+
readonly additionalProperties: false;
|
|
84
|
+
readonly required: readonly ["broadcasts"];
|
|
85
|
+
readonly properties: {
|
|
86
|
+
readonly broadcasts: {
|
|
87
|
+
readonly type: "array";
|
|
88
|
+
readonly items: {
|
|
89
|
+
readonly $ref: "#/$defs/BroadcastRecord";
|
|
90
|
+
};
|
|
91
|
+
readonly description: "Sent and received broadcasts, newest first.";
|
|
92
|
+
};
|
|
93
|
+
readonly ext: {
|
|
94
|
+
readonly $ref: "#/$defs/Ext";
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
readonly Ext: {
|
|
99
|
+
readonly title: "Ext";
|
|
100
|
+
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.";
|
|
101
|
+
readonly type: "object";
|
|
102
|
+
readonly minProperties: 1;
|
|
103
|
+
readonly additionalProperties: true;
|
|
104
|
+
readonly propertyNames: {
|
|
105
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
readonly BroadcastRecord: {
|
|
109
|
+
readonly description: "A broadcast as this network sent or relayed it.";
|
|
110
|
+
readonly type: "object";
|
|
111
|
+
readonly additionalProperties: false;
|
|
112
|
+
readonly required: readonly ["id", "direction", "role", "message", "recordedAt", "receipts", "reached"];
|
|
113
|
+
readonly properties: {
|
|
114
|
+
readonly id: {
|
|
115
|
+
readonly type: "string";
|
|
116
|
+
readonly maxLength: 2048;
|
|
117
|
+
readonly description: "The message id.";
|
|
118
|
+
};
|
|
119
|
+
readonly direction: {
|
|
120
|
+
readonly type: "string";
|
|
121
|
+
readonly enum: readonly ["sent", "received"];
|
|
122
|
+
readonly description: "Whether this network sent it or received it to relay.";
|
|
123
|
+
};
|
|
124
|
+
readonly role: {
|
|
125
|
+
readonly $ref: "#/$defs/RoleName";
|
|
126
|
+
readonly description: "The role it was addressed to.";
|
|
127
|
+
};
|
|
128
|
+
readonly message: {
|
|
129
|
+
readonly $ref: "#/$defs/Credential";
|
|
130
|
+
readonly description: "The signed message.";
|
|
131
|
+
};
|
|
132
|
+
readonly from: {
|
|
133
|
+
readonly $ref: "#/$defs/Did";
|
|
134
|
+
readonly description: "For a received message, the network that delivered it.";
|
|
135
|
+
};
|
|
136
|
+
readonly actor: {
|
|
137
|
+
readonly $ref: "#/$defs/Did";
|
|
138
|
+
readonly description: "For a sent message, the administrator that sent it.";
|
|
139
|
+
};
|
|
140
|
+
readonly recordedAt: {
|
|
141
|
+
readonly type: "string";
|
|
142
|
+
readonly format: "date-time";
|
|
143
|
+
readonly description: "When.";
|
|
144
|
+
};
|
|
145
|
+
readonly receipts: {
|
|
146
|
+
readonly type: "array";
|
|
147
|
+
readonly items: {
|
|
148
|
+
readonly $ref: "#/$defs/Receipt";
|
|
149
|
+
};
|
|
150
|
+
readonly description: "Per group.";
|
|
151
|
+
};
|
|
152
|
+
readonly reached: {
|
|
153
|
+
readonly type: "integer";
|
|
154
|
+
readonly minimum: 0;
|
|
155
|
+
readonly description: "Groups delivered to, counting relays.";
|
|
156
|
+
};
|
|
157
|
+
};
|
|
158
|
+
};
|
|
159
|
+
readonly Receipt: {
|
|
160
|
+
readonly description: "The outcome of one delivery.";
|
|
161
|
+
readonly type: "object";
|
|
162
|
+
readonly additionalProperties: false;
|
|
163
|
+
readonly required: readonly ["group", "member", "status"];
|
|
164
|
+
readonly properties: {
|
|
165
|
+
readonly group: {
|
|
166
|
+
readonly type: "string";
|
|
167
|
+
readonly maxLength: 2048;
|
|
168
|
+
readonly description: "The group delivered to.";
|
|
169
|
+
};
|
|
170
|
+
readonly member: {
|
|
171
|
+
readonly $ref: "#/$defs/Did";
|
|
172
|
+
readonly description: "The member that owns it.";
|
|
173
|
+
};
|
|
174
|
+
readonly status: {
|
|
175
|
+
readonly $ref: "#/$defs/DeliveryStatus";
|
|
176
|
+
};
|
|
177
|
+
readonly detail: {
|
|
178
|
+
readonly type: "string";
|
|
179
|
+
readonly maxLength: 1000;
|
|
180
|
+
readonly description: "Why, for anything but `delivered`.";
|
|
181
|
+
};
|
|
182
|
+
readonly network: {
|
|
183
|
+
readonly type: "boolean";
|
|
184
|
+
readonly description: "Whether the group is a network group, which relays further.";
|
|
185
|
+
};
|
|
186
|
+
readonly relayed: {
|
|
187
|
+
readonly type: "array";
|
|
188
|
+
readonly items: {
|
|
189
|
+
readonly $ref: "#/$defs/Receipt";
|
|
190
|
+
};
|
|
191
|
+
readonly description: "The receipts the network group's own relay returned.";
|
|
192
|
+
};
|
|
193
|
+
};
|
|
194
|
+
};
|
|
195
|
+
readonly DeliveryStatus: {
|
|
196
|
+
readonly type: "string";
|
|
197
|
+
readonly enum: readonly ["delivered", "duplicate", "refused", "queued", "failed"];
|
|
198
|
+
readonly description: "What happened to one delivery. `queued` will be retried.";
|
|
199
|
+
};
|
|
200
|
+
readonly Did: {
|
|
201
|
+
readonly type: "string";
|
|
202
|
+
readonly pattern: "^did:[a-z0-9]+:.+$";
|
|
203
|
+
readonly maxLength: 2048;
|
|
204
|
+
readonly description: "A DID.";
|
|
205
|
+
};
|
|
206
|
+
readonly Credential: {
|
|
207
|
+
readonly type: "object";
|
|
208
|
+
readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
|
|
209
|
+
};
|
|
210
|
+
readonly RoleName: {
|
|
211
|
+
readonly type: "string";
|
|
212
|
+
readonly pattern: "^[a-z0-9_-]{1,64}$";
|
|
213
|
+
readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
|
|
214
|
+
};
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
218
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
219
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
220
|
+
readonly $ref: "#/$defs/Response";
|
|
221
|
+
readonly $defs: {
|
|
222
|
+
readonly Response: {
|
|
223
|
+
readonly $anchor: "response";
|
|
224
|
+
readonly title: "VTN Broadcasts — List — response payload";
|
|
225
|
+
readonly description: "The broadcast records, newest first.";
|
|
226
|
+
readonly type: "object";
|
|
227
|
+
readonly additionalProperties: false;
|
|
228
|
+
readonly required: readonly ["broadcasts"];
|
|
229
|
+
readonly properties: {
|
|
230
|
+
readonly broadcasts: {
|
|
231
|
+
readonly type: "array";
|
|
232
|
+
readonly items: {
|
|
233
|
+
readonly $ref: "#/$defs/BroadcastRecord";
|
|
234
|
+
};
|
|
235
|
+
readonly description: "Sent and received broadcasts, newest first.";
|
|
236
|
+
};
|
|
237
|
+
readonly ext: {
|
|
238
|
+
readonly $ref: "#/$defs/Ext";
|
|
239
|
+
};
|
|
240
|
+
};
|
|
241
|
+
};
|
|
242
|
+
readonly Ext: {
|
|
243
|
+
readonly title: "Ext";
|
|
244
|
+
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.";
|
|
245
|
+
readonly type: "object";
|
|
246
|
+
readonly minProperties: 1;
|
|
247
|
+
readonly additionalProperties: true;
|
|
248
|
+
readonly propertyNames: {
|
|
249
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
250
|
+
};
|
|
251
|
+
};
|
|
252
|
+
readonly BroadcastRecord: {
|
|
253
|
+
readonly description: "A broadcast as this network sent or relayed it.";
|
|
254
|
+
readonly type: "object";
|
|
255
|
+
readonly additionalProperties: false;
|
|
256
|
+
readonly required: readonly ["id", "direction", "role", "message", "recordedAt", "receipts", "reached"];
|
|
257
|
+
readonly properties: {
|
|
258
|
+
readonly id: {
|
|
259
|
+
readonly type: "string";
|
|
260
|
+
readonly maxLength: 2048;
|
|
261
|
+
readonly description: "The message id.";
|
|
262
|
+
};
|
|
263
|
+
readonly direction: {
|
|
264
|
+
readonly type: "string";
|
|
265
|
+
readonly enum: readonly ["sent", "received"];
|
|
266
|
+
readonly description: "Whether this network sent it or received it to relay.";
|
|
267
|
+
};
|
|
268
|
+
readonly role: {
|
|
269
|
+
readonly $ref: "#/$defs/RoleName";
|
|
270
|
+
readonly description: "The role it was addressed to.";
|
|
271
|
+
};
|
|
272
|
+
readonly message: {
|
|
273
|
+
readonly $ref: "#/$defs/Credential";
|
|
274
|
+
readonly description: "The signed message.";
|
|
275
|
+
};
|
|
276
|
+
readonly from: {
|
|
277
|
+
readonly $ref: "#/$defs/Did";
|
|
278
|
+
readonly description: "For a received message, the network that delivered it.";
|
|
279
|
+
};
|
|
280
|
+
readonly actor: {
|
|
281
|
+
readonly $ref: "#/$defs/Did";
|
|
282
|
+
readonly description: "For a sent message, the administrator that sent it.";
|
|
283
|
+
};
|
|
284
|
+
readonly recordedAt: {
|
|
285
|
+
readonly type: "string";
|
|
286
|
+
readonly format: "date-time";
|
|
287
|
+
readonly description: "When.";
|
|
288
|
+
};
|
|
289
|
+
readonly receipts: {
|
|
290
|
+
readonly type: "array";
|
|
291
|
+
readonly items: {
|
|
292
|
+
readonly $ref: "#/$defs/Receipt";
|
|
293
|
+
};
|
|
294
|
+
readonly description: "Per group.";
|
|
295
|
+
};
|
|
296
|
+
readonly reached: {
|
|
297
|
+
readonly type: "integer";
|
|
298
|
+
readonly minimum: 0;
|
|
299
|
+
readonly description: "Groups delivered to, counting relays.";
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
};
|
|
303
|
+
readonly Receipt: {
|
|
304
|
+
readonly description: "The outcome of one delivery.";
|
|
305
|
+
readonly type: "object";
|
|
306
|
+
readonly additionalProperties: false;
|
|
307
|
+
readonly required: readonly ["group", "member", "status"];
|
|
308
|
+
readonly properties: {
|
|
309
|
+
readonly group: {
|
|
310
|
+
readonly type: "string";
|
|
311
|
+
readonly maxLength: 2048;
|
|
312
|
+
readonly description: "The group delivered to.";
|
|
313
|
+
};
|
|
314
|
+
readonly member: {
|
|
315
|
+
readonly $ref: "#/$defs/Did";
|
|
316
|
+
readonly description: "The member that owns it.";
|
|
317
|
+
};
|
|
318
|
+
readonly status: {
|
|
319
|
+
readonly $ref: "#/$defs/DeliveryStatus";
|
|
320
|
+
};
|
|
321
|
+
readonly detail: {
|
|
322
|
+
readonly type: "string";
|
|
323
|
+
readonly maxLength: 1000;
|
|
324
|
+
readonly description: "Why, for anything but `delivered`.";
|
|
325
|
+
};
|
|
326
|
+
readonly network: {
|
|
327
|
+
readonly type: "boolean";
|
|
328
|
+
readonly description: "Whether the group is a network group, which relays further.";
|
|
329
|
+
};
|
|
330
|
+
readonly relayed: {
|
|
331
|
+
readonly type: "array";
|
|
332
|
+
readonly items: {
|
|
333
|
+
readonly $ref: "#/$defs/Receipt";
|
|
334
|
+
};
|
|
335
|
+
readonly description: "The receipts the network group's own relay returned.";
|
|
336
|
+
};
|
|
337
|
+
};
|
|
338
|
+
};
|
|
339
|
+
readonly DeliveryStatus: {
|
|
340
|
+
readonly type: "string";
|
|
341
|
+
readonly enum: readonly ["delivered", "duplicate", "refused", "queued", "failed"];
|
|
342
|
+
readonly description: "What happened to one delivery. `queued` will be retried.";
|
|
343
|
+
};
|
|
344
|
+
readonly Did: {
|
|
345
|
+
readonly type: "string";
|
|
346
|
+
readonly pattern: "^did:[a-z0-9]+:.+$";
|
|
347
|
+
readonly maxLength: 2048;
|
|
348
|
+
readonly description: "A DID.";
|
|
349
|
+
};
|
|
350
|
+
readonly Credential: {
|
|
351
|
+
readonly type: "object";
|
|
352
|
+
readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
|
|
353
|
+
};
|
|
354
|
+
readonly RoleName: {
|
|
355
|
+
readonly type: "string";
|
|
356
|
+
readonly pattern: "^[a-z0-9_-]{1,64}$";
|
|
357
|
+
readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
|
|
358
|
+
};
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
/**
|
|
362
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
363
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
364
|
+
* per-specification and cannot be derived from the document alone, and
|
|
365
|
+
* item 2 needs the schema this carries.
|
|
366
|
+
*/
|
|
367
|
+
export declare const SPEC: {
|
|
368
|
+
readonly typeUri: "https://trusttasks.org/spec/vtn/broadcasts/list/0.1";
|
|
369
|
+
readonly isBearer: false;
|
|
370
|
+
readonly isProofRequired: true;
|
|
371
|
+
readonly isRecipientRequired: true;
|
|
372
|
+
readonly isIssuedAtRequired: false;
|
|
373
|
+
readonly payloadSchema: {
|
|
374
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
375
|
+
readonly $id: "https://trusttasks.org/spec/vtn/broadcasts/list/0.1";
|
|
376
|
+
readonly title: "VTN Broadcasts — List — payload";
|
|
377
|
+
readonly description: "An administrator's request for the broadcasts this network sent or relayed, newest first. The outer document members are owned by the framework — SPEC §6.3.";
|
|
378
|
+
readonly type: "object";
|
|
379
|
+
readonly additionalProperties: false;
|
|
380
|
+
readonly properties: {
|
|
381
|
+
readonly limit: {
|
|
382
|
+
readonly type: "integer";
|
|
383
|
+
readonly minimum: 1;
|
|
384
|
+
readonly maximum: 1000;
|
|
385
|
+
readonly description: "The most records to return. Absent: all of them.";
|
|
386
|
+
};
|
|
387
|
+
readonly ext: {
|
|
388
|
+
readonly $ref: "#/$defs/Ext";
|
|
389
|
+
};
|
|
390
|
+
};
|
|
391
|
+
readonly $defs: {
|
|
392
|
+
readonly Response: {
|
|
393
|
+
readonly $anchor: "response";
|
|
394
|
+
readonly title: "VTN Broadcasts — List — response payload";
|
|
395
|
+
readonly description: "The broadcast records, newest first.";
|
|
396
|
+
readonly type: "object";
|
|
397
|
+
readonly additionalProperties: false;
|
|
398
|
+
readonly required: readonly ["broadcasts"];
|
|
399
|
+
readonly properties: {
|
|
400
|
+
readonly broadcasts: {
|
|
401
|
+
readonly type: "array";
|
|
402
|
+
readonly items: {
|
|
403
|
+
readonly $ref: "#/$defs/BroadcastRecord";
|
|
404
|
+
};
|
|
405
|
+
readonly description: "Sent and received broadcasts, newest first.";
|
|
406
|
+
};
|
|
407
|
+
readonly ext: {
|
|
408
|
+
readonly $ref: "#/$defs/Ext";
|
|
409
|
+
};
|
|
410
|
+
};
|
|
411
|
+
};
|
|
412
|
+
readonly Ext: {
|
|
413
|
+
readonly title: "Ext";
|
|
414
|
+
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.";
|
|
415
|
+
readonly type: "object";
|
|
416
|
+
readonly minProperties: 1;
|
|
417
|
+
readonly additionalProperties: true;
|
|
418
|
+
readonly propertyNames: {
|
|
419
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
420
|
+
};
|
|
421
|
+
};
|
|
422
|
+
readonly BroadcastRecord: {
|
|
423
|
+
readonly description: "A broadcast as this network sent or relayed it.";
|
|
424
|
+
readonly type: "object";
|
|
425
|
+
readonly additionalProperties: false;
|
|
426
|
+
readonly required: readonly ["id", "direction", "role", "message", "recordedAt", "receipts", "reached"];
|
|
427
|
+
readonly properties: {
|
|
428
|
+
readonly id: {
|
|
429
|
+
readonly type: "string";
|
|
430
|
+
readonly maxLength: 2048;
|
|
431
|
+
readonly description: "The message id.";
|
|
432
|
+
};
|
|
433
|
+
readonly direction: {
|
|
434
|
+
readonly type: "string";
|
|
435
|
+
readonly enum: readonly ["sent", "received"];
|
|
436
|
+
readonly description: "Whether this network sent it or received it to relay.";
|
|
437
|
+
};
|
|
438
|
+
readonly role: {
|
|
439
|
+
readonly $ref: "#/$defs/RoleName";
|
|
440
|
+
readonly description: "The role it was addressed to.";
|
|
441
|
+
};
|
|
442
|
+
readonly message: {
|
|
443
|
+
readonly $ref: "#/$defs/Credential";
|
|
444
|
+
readonly description: "The signed message.";
|
|
445
|
+
};
|
|
446
|
+
readonly from: {
|
|
447
|
+
readonly $ref: "#/$defs/Did";
|
|
448
|
+
readonly description: "For a received message, the network that delivered it.";
|
|
449
|
+
};
|
|
450
|
+
readonly actor: {
|
|
451
|
+
readonly $ref: "#/$defs/Did";
|
|
452
|
+
readonly description: "For a sent message, the administrator that sent it.";
|
|
453
|
+
};
|
|
454
|
+
readonly recordedAt: {
|
|
455
|
+
readonly type: "string";
|
|
456
|
+
readonly format: "date-time";
|
|
457
|
+
readonly description: "When.";
|
|
458
|
+
};
|
|
459
|
+
readonly receipts: {
|
|
460
|
+
readonly type: "array";
|
|
461
|
+
readonly items: {
|
|
462
|
+
readonly $ref: "#/$defs/Receipt";
|
|
463
|
+
};
|
|
464
|
+
readonly description: "Per group.";
|
|
465
|
+
};
|
|
466
|
+
readonly reached: {
|
|
467
|
+
readonly type: "integer";
|
|
468
|
+
readonly minimum: 0;
|
|
469
|
+
readonly description: "Groups delivered to, counting relays.";
|
|
470
|
+
};
|
|
471
|
+
};
|
|
472
|
+
};
|
|
473
|
+
readonly Receipt: {
|
|
474
|
+
readonly description: "The outcome of one delivery.";
|
|
475
|
+
readonly type: "object";
|
|
476
|
+
readonly additionalProperties: false;
|
|
477
|
+
readonly required: readonly ["group", "member", "status"];
|
|
478
|
+
readonly properties: {
|
|
479
|
+
readonly group: {
|
|
480
|
+
readonly type: "string";
|
|
481
|
+
readonly maxLength: 2048;
|
|
482
|
+
readonly description: "The group delivered to.";
|
|
483
|
+
};
|
|
484
|
+
readonly member: {
|
|
485
|
+
readonly $ref: "#/$defs/Did";
|
|
486
|
+
readonly description: "The member that owns it.";
|
|
487
|
+
};
|
|
488
|
+
readonly status: {
|
|
489
|
+
readonly $ref: "#/$defs/DeliveryStatus";
|
|
490
|
+
};
|
|
491
|
+
readonly detail: {
|
|
492
|
+
readonly type: "string";
|
|
493
|
+
readonly maxLength: 1000;
|
|
494
|
+
readonly description: "Why, for anything but `delivered`.";
|
|
495
|
+
};
|
|
496
|
+
readonly network: {
|
|
497
|
+
readonly type: "boolean";
|
|
498
|
+
readonly description: "Whether the group is a network group, which relays further.";
|
|
499
|
+
};
|
|
500
|
+
readonly relayed: {
|
|
501
|
+
readonly type: "array";
|
|
502
|
+
readonly items: {
|
|
503
|
+
readonly $ref: "#/$defs/Receipt";
|
|
504
|
+
};
|
|
505
|
+
readonly description: "The receipts the network group's own relay returned.";
|
|
506
|
+
};
|
|
507
|
+
};
|
|
508
|
+
};
|
|
509
|
+
readonly DeliveryStatus: {
|
|
510
|
+
readonly type: "string";
|
|
511
|
+
readonly enum: readonly ["delivered", "duplicate", "refused", "queued", "failed"];
|
|
512
|
+
readonly description: "What happened to one delivery. `queued` will be retried.";
|
|
513
|
+
};
|
|
514
|
+
readonly Did: {
|
|
515
|
+
readonly type: "string";
|
|
516
|
+
readonly pattern: "^did:[a-z0-9]+:.+$";
|
|
517
|
+
readonly maxLength: 2048;
|
|
518
|
+
readonly description: "A DID.";
|
|
519
|
+
};
|
|
520
|
+
readonly Credential: {
|
|
521
|
+
readonly type: "object";
|
|
522
|
+
readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
|
|
523
|
+
};
|
|
524
|
+
readonly RoleName: {
|
|
525
|
+
readonly type: "string";
|
|
526
|
+
readonly pattern: "^[a-z0-9_-]{1,64}$";
|
|
527
|
+
readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
|
|
528
|
+
};
|
|
529
|
+
};
|
|
530
|
+
};
|
|
531
|
+
};
|
|
532
|
+
/**
|
|
533
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
534
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
535
|
+
* parties (§7.3 item 5).
|
|
536
|
+
*/
|
|
537
|
+
export declare const RESPONSE_SPEC: {
|
|
538
|
+
readonly typeUri: "https://trusttasks.org/spec/vtn/broadcasts/list/0.1#response";
|
|
539
|
+
readonly isBearer: false;
|
|
540
|
+
readonly isProofRequired: true;
|
|
541
|
+
readonly isRecipientRequired: true;
|
|
542
|
+
readonly isIssuedAtRequired: false;
|
|
543
|
+
readonly payloadSchema: {
|
|
544
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
545
|
+
readonly $ref: "#/$defs/Response";
|
|
546
|
+
readonly $defs: {
|
|
547
|
+
readonly Response: {
|
|
548
|
+
readonly $anchor: "response";
|
|
549
|
+
readonly title: "VTN Broadcasts — List — response payload";
|
|
550
|
+
readonly description: "The broadcast records, newest first.";
|
|
551
|
+
readonly type: "object";
|
|
552
|
+
readonly additionalProperties: false;
|
|
553
|
+
readonly required: readonly ["broadcasts"];
|
|
554
|
+
readonly properties: {
|
|
555
|
+
readonly broadcasts: {
|
|
556
|
+
readonly type: "array";
|
|
557
|
+
readonly items: {
|
|
558
|
+
readonly $ref: "#/$defs/BroadcastRecord";
|
|
559
|
+
};
|
|
560
|
+
readonly description: "Sent and received broadcasts, newest first.";
|
|
561
|
+
};
|
|
562
|
+
readonly ext: {
|
|
563
|
+
readonly $ref: "#/$defs/Ext";
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
};
|
|
567
|
+
readonly Ext: {
|
|
568
|
+
readonly title: "Ext";
|
|
569
|
+
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.";
|
|
570
|
+
readonly type: "object";
|
|
571
|
+
readonly minProperties: 1;
|
|
572
|
+
readonly additionalProperties: true;
|
|
573
|
+
readonly propertyNames: {
|
|
574
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
575
|
+
};
|
|
576
|
+
};
|
|
577
|
+
readonly BroadcastRecord: {
|
|
578
|
+
readonly description: "A broadcast as this network sent or relayed it.";
|
|
579
|
+
readonly type: "object";
|
|
580
|
+
readonly additionalProperties: false;
|
|
581
|
+
readonly required: readonly ["id", "direction", "role", "message", "recordedAt", "receipts", "reached"];
|
|
582
|
+
readonly properties: {
|
|
583
|
+
readonly id: {
|
|
584
|
+
readonly type: "string";
|
|
585
|
+
readonly maxLength: 2048;
|
|
586
|
+
readonly description: "The message id.";
|
|
587
|
+
};
|
|
588
|
+
readonly direction: {
|
|
589
|
+
readonly type: "string";
|
|
590
|
+
readonly enum: readonly ["sent", "received"];
|
|
591
|
+
readonly description: "Whether this network sent it or received it to relay.";
|
|
592
|
+
};
|
|
593
|
+
readonly role: {
|
|
594
|
+
readonly $ref: "#/$defs/RoleName";
|
|
595
|
+
readonly description: "The role it was addressed to.";
|
|
596
|
+
};
|
|
597
|
+
readonly message: {
|
|
598
|
+
readonly $ref: "#/$defs/Credential";
|
|
599
|
+
readonly description: "The signed message.";
|
|
600
|
+
};
|
|
601
|
+
readonly from: {
|
|
602
|
+
readonly $ref: "#/$defs/Did";
|
|
603
|
+
readonly description: "For a received message, the network that delivered it.";
|
|
604
|
+
};
|
|
605
|
+
readonly actor: {
|
|
606
|
+
readonly $ref: "#/$defs/Did";
|
|
607
|
+
readonly description: "For a sent message, the administrator that sent it.";
|
|
608
|
+
};
|
|
609
|
+
readonly recordedAt: {
|
|
610
|
+
readonly type: "string";
|
|
611
|
+
readonly format: "date-time";
|
|
612
|
+
readonly description: "When.";
|
|
613
|
+
};
|
|
614
|
+
readonly receipts: {
|
|
615
|
+
readonly type: "array";
|
|
616
|
+
readonly items: {
|
|
617
|
+
readonly $ref: "#/$defs/Receipt";
|
|
618
|
+
};
|
|
619
|
+
readonly description: "Per group.";
|
|
620
|
+
};
|
|
621
|
+
readonly reached: {
|
|
622
|
+
readonly type: "integer";
|
|
623
|
+
readonly minimum: 0;
|
|
624
|
+
readonly description: "Groups delivered to, counting relays.";
|
|
625
|
+
};
|
|
626
|
+
};
|
|
627
|
+
};
|
|
628
|
+
readonly Receipt: {
|
|
629
|
+
readonly description: "The outcome of one delivery.";
|
|
630
|
+
readonly type: "object";
|
|
631
|
+
readonly additionalProperties: false;
|
|
632
|
+
readonly required: readonly ["group", "member", "status"];
|
|
633
|
+
readonly properties: {
|
|
634
|
+
readonly group: {
|
|
635
|
+
readonly type: "string";
|
|
636
|
+
readonly maxLength: 2048;
|
|
637
|
+
readonly description: "The group delivered to.";
|
|
638
|
+
};
|
|
639
|
+
readonly member: {
|
|
640
|
+
readonly $ref: "#/$defs/Did";
|
|
641
|
+
readonly description: "The member that owns it.";
|
|
642
|
+
};
|
|
643
|
+
readonly status: {
|
|
644
|
+
readonly $ref: "#/$defs/DeliveryStatus";
|
|
645
|
+
};
|
|
646
|
+
readonly detail: {
|
|
647
|
+
readonly type: "string";
|
|
648
|
+
readonly maxLength: 1000;
|
|
649
|
+
readonly description: "Why, for anything but `delivered`.";
|
|
650
|
+
};
|
|
651
|
+
readonly network: {
|
|
652
|
+
readonly type: "boolean";
|
|
653
|
+
readonly description: "Whether the group is a network group, which relays further.";
|
|
654
|
+
};
|
|
655
|
+
readonly relayed: {
|
|
656
|
+
readonly type: "array";
|
|
657
|
+
readonly items: {
|
|
658
|
+
readonly $ref: "#/$defs/Receipt";
|
|
659
|
+
};
|
|
660
|
+
readonly description: "The receipts the network group's own relay returned.";
|
|
661
|
+
};
|
|
662
|
+
};
|
|
663
|
+
};
|
|
664
|
+
readonly DeliveryStatus: {
|
|
665
|
+
readonly type: "string";
|
|
666
|
+
readonly enum: readonly ["delivered", "duplicate", "refused", "queued", "failed"];
|
|
667
|
+
readonly description: "What happened to one delivery. `queued` will be retried.";
|
|
668
|
+
};
|
|
669
|
+
readonly Did: {
|
|
670
|
+
readonly type: "string";
|
|
671
|
+
readonly pattern: "^did:[a-z0-9]+:.+$";
|
|
672
|
+
readonly maxLength: 2048;
|
|
673
|
+
readonly description: "A DID.";
|
|
674
|
+
};
|
|
675
|
+
readonly Credential: {
|
|
676
|
+
readonly type: "object";
|
|
677
|
+
readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
|
|
678
|
+
};
|
|
679
|
+
readonly RoleName: {
|
|
680
|
+
readonly type: "string";
|
|
681
|
+
readonly pattern: "^[a-z0-9_-]{1,64}$";
|
|
682
|
+
readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
};
|
|
687
|
+
//# sourceMappingURL=payload.d.ts.map
|