@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,349 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vta/notifications/deposit/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { ContextId, Ext, NotificationId } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* A client with standing in a trust context hands its VTA a notifications/notify or notifications/relay document it received for a DID the VTA holds keys of in that context — a persona DID whose mediator socket the client holds — exactly as received, proof included. The VTA verifies and holds it exactly as if the document had been delivered to it directly: the same layer-by-layer verification, the same acceptance policy counting the party that delivered the document and never the depositing client, the same one record per originator and notificationId, and the same receipt whatever it did (VTI-NTF-054 – VTI-NTF-056). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
|
|
8
|
+
*/
|
|
9
|
+
export interface VTANotificationsDepositPayload {
|
|
10
|
+
/**
|
|
11
|
+
* The trust context the addressed DID belongs to, in which the VTA holds the notification if it accepts it.
|
|
12
|
+
*/
|
|
13
|
+
contextId: ContextId;
|
|
14
|
+
document: DepositedDocument;
|
|
15
|
+
ext?: Ext;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.
|
|
19
|
+
*/
|
|
20
|
+
export interface DepositedDocument {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).
|
|
24
|
+
*/
|
|
25
|
+
export interface VTANotificationsDepositResponsePayload {
|
|
26
|
+
notificationId: NotificationId;
|
|
27
|
+
/**
|
|
28
|
+
* The revision of the innermost notification, echoed.
|
|
29
|
+
*/
|
|
30
|
+
revision: number;
|
|
31
|
+
}
|
|
32
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
33
|
+
export type { ContextId, Ext, NotificationId };
|
|
34
|
+
/** Trust Task type URI. */
|
|
35
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vta/notifications/deposit/0.1";
|
|
36
|
+
/**
|
|
37
|
+
* The earlier version of this specification that this one declares it
|
|
38
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
39
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
40
|
+
* `extendsChain` / `readForSpec`.
|
|
41
|
+
*/
|
|
42
|
+
export declare const EXTENDS: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
45
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
46
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
47
|
+
* Versions").
|
|
48
|
+
*/
|
|
49
|
+
export declare const DEPRECATION: string | null;
|
|
50
|
+
/** Stable alias for this specification's request payload shape. */
|
|
51
|
+
export type Payload = VTANotificationsDepositPayload;
|
|
52
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
53
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/notifications/deposit/0.1#response";
|
|
54
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
55
|
+
export type Response = VTANotificationsDepositResponsePayload;
|
|
56
|
+
/**
|
|
57
|
+
* This specification's payload schema, as a value.
|
|
58
|
+
*
|
|
59
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
60
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
61
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
62
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
63
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
64
|
+
*/
|
|
65
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
66
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
67
|
+
readonly $id: "https://trusttasks.org/spec/vta/notifications/deposit/0.1";
|
|
68
|
+
readonly title: "VTA Notifications — Deposit — payload";
|
|
69
|
+
readonly description: "A client with standing in a trust context hands its VTA a notifications/notify or notifications/relay document it received for a DID the VTA holds keys of in that context — a persona DID whose mediator socket the client holds — exactly as received, proof included. The VTA verifies and holds it exactly as if the document had been delivered to it directly: the same layer-by-layer verification, the same acceptance policy counting the party that delivered the document and never the depositing client, the same one record per originator and notificationId, and the same receipt whatever it did (VTI-NTF-054 – VTI-NTF-056). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
|
|
70
|
+
readonly type: "object";
|
|
71
|
+
readonly additionalProperties: false;
|
|
72
|
+
readonly required: readonly ["contextId", "document"];
|
|
73
|
+
readonly properties: {
|
|
74
|
+
readonly contextId: {
|
|
75
|
+
readonly $ref: "#/$defs/ContextId";
|
|
76
|
+
readonly description: "The trust context the addressed DID belongs to, in which the VTA holds the notification if it accepts it.";
|
|
77
|
+
};
|
|
78
|
+
readonly document: {
|
|
79
|
+
readonly $ref: "#/$defs/DepositedDocument";
|
|
80
|
+
};
|
|
81
|
+
readonly ext: {
|
|
82
|
+
readonly $ref: "#/$defs/Ext";
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
readonly $defs: {
|
|
86
|
+
readonly DepositedDocument: {
|
|
87
|
+
readonly title: "DepositedDocument";
|
|
88
|
+
readonly description: "The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.";
|
|
89
|
+
readonly type: "object";
|
|
90
|
+
readonly minProperties: 1;
|
|
91
|
+
};
|
|
92
|
+
readonly Response: {
|
|
93
|
+
readonly $anchor: "response";
|
|
94
|
+
readonly title: "VTA Notifications — Deposit — response payload";
|
|
95
|
+
readonly type: "object";
|
|
96
|
+
readonly additionalProperties: false;
|
|
97
|
+
readonly required: readonly ["notificationId", "revision"];
|
|
98
|
+
readonly description: "Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).";
|
|
99
|
+
readonly properties: {
|
|
100
|
+
readonly notificationId: {
|
|
101
|
+
readonly $ref: "#/$defs/NotificationId";
|
|
102
|
+
};
|
|
103
|
+
readonly revision: {
|
|
104
|
+
readonly type: "integer";
|
|
105
|
+
readonly minimum: 1;
|
|
106
|
+
readonly maximum: 1000000;
|
|
107
|
+
readonly description: "The revision of the innermost notification, echoed.";
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
readonly NotificationId: {
|
|
112
|
+
readonly title: "NotificationId";
|
|
113
|
+
readonly description: "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.";
|
|
114
|
+
readonly type: "string";
|
|
115
|
+
readonly minLength: 1;
|
|
116
|
+
readonly maxLength: 256;
|
|
117
|
+
readonly pattern: "^[A-Za-z0-9._~:-]+$";
|
|
118
|
+
};
|
|
119
|
+
readonly Ext: {
|
|
120
|
+
readonly title: "Ext";
|
|
121
|
+
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.";
|
|
122
|
+
readonly type: "object";
|
|
123
|
+
readonly minProperties: 1;
|
|
124
|
+
readonly additionalProperties: true;
|
|
125
|
+
readonly propertyNames: {
|
|
126
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
readonly ContextId: {
|
|
130
|
+
readonly title: "ContextId";
|
|
131
|
+
readonly description: "The trust context the notification is held in: the one the addressed DID belongs to.";
|
|
132
|
+
readonly type: "string";
|
|
133
|
+
readonly minLength: 1;
|
|
134
|
+
readonly maxLength: 256;
|
|
135
|
+
};
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
139
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
140
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
141
|
+
readonly $ref: "#/$defs/Response";
|
|
142
|
+
readonly $defs: {
|
|
143
|
+
readonly DepositedDocument: {
|
|
144
|
+
readonly title: "DepositedDocument";
|
|
145
|
+
readonly description: "The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.";
|
|
146
|
+
readonly type: "object";
|
|
147
|
+
readonly minProperties: 1;
|
|
148
|
+
};
|
|
149
|
+
readonly Response: {
|
|
150
|
+
readonly $anchor: "response";
|
|
151
|
+
readonly title: "VTA Notifications — Deposit — response payload";
|
|
152
|
+
readonly type: "object";
|
|
153
|
+
readonly additionalProperties: false;
|
|
154
|
+
readonly required: readonly ["notificationId", "revision"];
|
|
155
|
+
readonly description: "Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).";
|
|
156
|
+
readonly properties: {
|
|
157
|
+
readonly notificationId: {
|
|
158
|
+
readonly $ref: "#/$defs/NotificationId";
|
|
159
|
+
};
|
|
160
|
+
readonly revision: {
|
|
161
|
+
readonly type: "integer";
|
|
162
|
+
readonly minimum: 1;
|
|
163
|
+
readonly maximum: 1000000;
|
|
164
|
+
readonly description: "The revision of the innermost notification, echoed.";
|
|
165
|
+
};
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
readonly NotificationId: {
|
|
169
|
+
readonly title: "NotificationId";
|
|
170
|
+
readonly description: "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.";
|
|
171
|
+
readonly type: "string";
|
|
172
|
+
readonly minLength: 1;
|
|
173
|
+
readonly maxLength: 256;
|
|
174
|
+
readonly pattern: "^[A-Za-z0-9._~:-]+$";
|
|
175
|
+
};
|
|
176
|
+
readonly Ext: {
|
|
177
|
+
readonly title: "Ext";
|
|
178
|
+
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.";
|
|
179
|
+
readonly type: "object";
|
|
180
|
+
readonly minProperties: 1;
|
|
181
|
+
readonly additionalProperties: true;
|
|
182
|
+
readonly propertyNames: {
|
|
183
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
184
|
+
};
|
|
185
|
+
};
|
|
186
|
+
readonly ContextId: {
|
|
187
|
+
readonly title: "ContextId";
|
|
188
|
+
readonly description: "The trust context the notification is held in: the one the addressed DID belongs to.";
|
|
189
|
+
readonly type: "string";
|
|
190
|
+
readonly minLength: 1;
|
|
191
|
+
readonly maxLength: 256;
|
|
192
|
+
};
|
|
193
|
+
};
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
197
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
198
|
+
* per-specification and cannot be derived from the document alone, and
|
|
199
|
+
* item 2 needs the schema this carries.
|
|
200
|
+
*/
|
|
201
|
+
export declare const SPEC: {
|
|
202
|
+
readonly typeUri: "https://trusttasks.org/spec/vta/notifications/deposit/0.1";
|
|
203
|
+
readonly isBearer: false;
|
|
204
|
+
readonly isProofRequired: false;
|
|
205
|
+
readonly isRecipientRequired: true;
|
|
206
|
+
readonly isIssuedAtRequired: true;
|
|
207
|
+
readonly payloadSchema: {
|
|
208
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
209
|
+
readonly $id: "https://trusttasks.org/spec/vta/notifications/deposit/0.1";
|
|
210
|
+
readonly title: "VTA Notifications — Deposit — payload";
|
|
211
|
+
readonly description: "A client with standing in a trust context hands its VTA a notifications/notify or notifications/relay document it received for a DID the VTA holds keys of in that context — a persona DID whose mediator socket the client holds — exactly as received, proof included. The VTA verifies and holds it exactly as if the document had been delivered to it directly: the same layer-by-layer verification, the same acceptance policy counting the party that delivered the document and never the depositing client, the same one record per originator and notificationId, and the same receipt whatever it did (VTI-NTF-054 – VTI-NTF-056). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
|
|
212
|
+
readonly type: "object";
|
|
213
|
+
readonly additionalProperties: false;
|
|
214
|
+
readonly required: readonly ["contextId", "document"];
|
|
215
|
+
readonly properties: {
|
|
216
|
+
readonly contextId: {
|
|
217
|
+
readonly $ref: "#/$defs/ContextId";
|
|
218
|
+
readonly description: "The trust context the addressed DID belongs to, in which the VTA holds the notification if it accepts it.";
|
|
219
|
+
};
|
|
220
|
+
readonly document: {
|
|
221
|
+
readonly $ref: "#/$defs/DepositedDocument";
|
|
222
|
+
};
|
|
223
|
+
readonly ext: {
|
|
224
|
+
readonly $ref: "#/$defs/Ext";
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
readonly $defs: {
|
|
228
|
+
readonly DepositedDocument: {
|
|
229
|
+
readonly title: "DepositedDocument";
|
|
230
|
+
readonly description: "The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.";
|
|
231
|
+
readonly type: "object";
|
|
232
|
+
readonly minProperties: 1;
|
|
233
|
+
};
|
|
234
|
+
readonly Response: {
|
|
235
|
+
readonly $anchor: "response";
|
|
236
|
+
readonly title: "VTA Notifications — Deposit — response payload";
|
|
237
|
+
readonly type: "object";
|
|
238
|
+
readonly additionalProperties: false;
|
|
239
|
+
readonly required: readonly ["notificationId", "revision"];
|
|
240
|
+
readonly description: "Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).";
|
|
241
|
+
readonly properties: {
|
|
242
|
+
readonly notificationId: {
|
|
243
|
+
readonly $ref: "#/$defs/NotificationId";
|
|
244
|
+
};
|
|
245
|
+
readonly revision: {
|
|
246
|
+
readonly type: "integer";
|
|
247
|
+
readonly minimum: 1;
|
|
248
|
+
readonly maximum: 1000000;
|
|
249
|
+
readonly description: "The revision of the innermost notification, echoed.";
|
|
250
|
+
};
|
|
251
|
+
};
|
|
252
|
+
};
|
|
253
|
+
readonly NotificationId: {
|
|
254
|
+
readonly title: "NotificationId";
|
|
255
|
+
readonly description: "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.";
|
|
256
|
+
readonly type: "string";
|
|
257
|
+
readonly minLength: 1;
|
|
258
|
+
readonly maxLength: 256;
|
|
259
|
+
readonly pattern: "^[A-Za-z0-9._~:-]+$";
|
|
260
|
+
};
|
|
261
|
+
readonly Ext: {
|
|
262
|
+
readonly title: "Ext";
|
|
263
|
+
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.";
|
|
264
|
+
readonly type: "object";
|
|
265
|
+
readonly minProperties: 1;
|
|
266
|
+
readonly additionalProperties: true;
|
|
267
|
+
readonly propertyNames: {
|
|
268
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
269
|
+
};
|
|
270
|
+
};
|
|
271
|
+
readonly ContextId: {
|
|
272
|
+
readonly title: "ContextId";
|
|
273
|
+
readonly description: "The trust context the notification is held in: the one the addressed DID belongs to.";
|
|
274
|
+
readonly type: "string";
|
|
275
|
+
readonly minLength: 1;
|
|
276
|
+
readonly maxLength: 256;
|
|
277
|
+
};
|
|
278
|
+
};
|
|
279
|
+
};
|
|
280
|
+
};
|
|
281
|
+
/**
|
|
282
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
283
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
284
|
+
* parties (§7.3 item 5).
|
|
285
|
+
*/
|
|
286
|
+
export declare const RESPONSE_SPEC: {
|
|
287
|
+
readonly typeUri: "https://trusttasks.org/spec/vta/notifications/deposit/0.1#response";
|
|
288
|
+
readonly isBearer: false;
|
|
289
|
+
readonly isProofRequired: false;
|
|
290
|
+
readonly isRecipientRequired: true;
|
|
291
|
+
readonly isIssuedAtRequired: true;
|
|
292
|
+
readonly payloadSchema: {
|
|
293
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
294
|
+
readonly $ref: "#/$defs/Response";
|
|
295
|
+
readonly $defs: {
|
|
296
|
+
readonly DepositedDocument: {
|
|
297
|
+
readonly title: "DepositedDocument";
|
|
298
|
+
readonly description: "The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.";
|
|
299
|
+
readonly type: "object";
|
|
300
|
+
readonly minProperties: 1;
|
|
301
|
+
};
|
|
302
|
+
readonly Response: {
|
|
303
|
+
readonly $anchor: "response";
|
|
304
|
+
readonly title: "VTA Notifications — Deposit — response payload";
|
|
305
|
+
readonly type: "object";
|
|
306
|
+
readonly additionalProperties: false;
|
|
307
|
+
readonly required: readonly ["notificationId", "revision"];
|
|
308
|
+
readonly description: "Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).";
|
|
309
|
+
readonly properties: {
|
|
310
|
+
readonly notificationId: {
|
|
311
|
+
readonly $ref: "#/$defs/NotificationId";
|
|
312
|
+
};
|
|
313
|
+
readonly revision: {
|
|
314
|
+
readonly type: "integer";
|
|
315
|
+
readonly minimum: 1;
|
|
316
|
+
readonly maximum: 1000000;
|
|
317
|
+
readonly description: "The revision of the innermost notification, echoed.";
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
readonly NotificationId: {
|
|
322
|
+
readonly title: "NotificationId";
|
|
323
|
+
readonly description: "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.";
|
|
324
|
+
readonly type: "string";
|
|
325
|
+
readonly minLength: 1;
|
|
326
|
+
readonly maxLength: 256;
|
|
327
|
+
readonly pattern: "^[A-Za-z0-9._~:-]+$";
|
|
328
|
+
};
|
|
329
|
+
readonly Ext: {
|
|
330
|
+
readonly title: "Ext";
|
|
331
|
+
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.";
|
|
332
|
+
readonly type: "object";
|
|
333
|
+
readonly minProperties: 1;
|
|
334
|
+
readonly additionalProperties: true;
|
|
335
|
+
readonly propertyNames: {
|
|
336
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
337
|
+
};
|
|
338
|
+
};
|
|
339
|
+
readonly ContextId: {
|
|
340
|
+
readonly title: "ContextId";
|
|
341
|
+
readonly description: "The trust context the notification is held in: the one the addressed DID belongs to.";
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly minLength: 1;
|
|
344
|
+
readonly maxLength: 256;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
};
|
|
348
|
+
};
|
|
349
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vta/notifications/deposit/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAGxF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,iBAAiB;CAAG;AACrC;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,cAAc,EAAE,cAAc,CAAC;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,kHAAkH;AAClH,YAAY,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC;AAE/C,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,2DAAoE,CAAC;AAE7F;;;;;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,8BAA8B,CAAC;AAErD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,oEAA6E,CAAC;AAE/G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,sCAAsC,CAAC;AAE9D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8EjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0D1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vta/notifications/deposit/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
/** Trust Task type URI. */
|
|
6
|
+
export const TYPE_URI = "https://trusttasks.org/spec/vta/notifications/deposit/0.1";
|
|
7
|
+
/**
|
|
8
|
+
* The earlier version of this specification that this one declares it
|
|
9
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
10
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
11
|
+
* `extendsChain` / `readForSpec`.
|
|
12
|
+
*/
|
|
13
|
+
export const EXTENDS = null;
|
|
14
|
+
/**
|
|
15
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
16
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
17
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
18
|
+
* Versions").
|
|
19
|
+
*/
|
|
20
|
+
export const DEPRECATION = null;
|
|
21
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
22
|
+
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/notifications/deposit/0.1#response";
|
|
23
|
+
/**
|
|
24
|
+
* This specification's payload schema, as a value.
|
|
25
|
+
*
|
|
26
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
27
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
28
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
29
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
30
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
31
|
+
*/
|
|
32
|
+
export const PAYLOAD_SCHEMA = {
|
|
33
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
34
|
+
"$id": "https://trusttasks.org/spec/vta/notifications/deposit/0.1",
|
|
35
|
+
"title": "VTA Notifications — Deposit — payload",
|
|
36
|
+
"description": "A client with standing in a trust context hands its VTA a notifications/notify or notifications/relay document it received for a DID the VTA holds keys of in that context — a persona DID whose mediator socket the client holds — exactly as received, proof included. The VTA verifies and holds it exactly as if the document had been delivered to it directly: the same layer-by-layer verification, the same acceptance policy counting the party that delivered the document and never the depositing client, the same one record per originator and notificationId, and the same receipt whatever it did (VTI-NTF-054 – VTI-NTF-056). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
|
|
37
|
+
"type": "object",
|
|
38
|
+
"additionalProperties": false,
|
|
39
|
+
"required": [
|
|
40
|
+
"contextId",
|
|
41
|
+
"document"
|
|
42
|
+
],
|
|
43
|
+
"properties": {
|
|
44
|
+
"contextId": {
|
|
45
|
+
"$ref": "#/$defs/ContextId",
|
|
46
|
+
"description": "The trust context the addressed DID belongs to, in which the VTA holds the notification if it accepts it."
|
|
47
|
+
},
|
|
48
|
+
"document": {
|
|
49
|
+
"$ref": "#/$defs/DepositedDocument"
|
|
50
|
+
},
|
|
51
|
+
"ext": {
|
|
52
|
+
"$ref": "#/$defs/Ext"
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
"$defs": {
|
|
56
|
+
"DepositedDocument": {
|
|
57
|
+
"title": "DepositedDocument",
|
|
58
|
+
"description": "The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.",
|
|
59
|
+
"type": "object",
|
|
60
|
+
"minProperties": 1
|
|
61
|
+
},
|
|
62
|
+
"Response": {
|
|
63
|
+
"$anchor": "response",
|
|
64
|
+
"title": "VTA Notifications — Deposit — response payload",
|
|
65
|
+
"type": "object",
|
|
66
|
+
"additionalProperties": false,
|
|
67
|
+
"required": [
|
|
68
|
+
"notificationId",
|
|
69
|
+
"revision"
|
|
70
|
+
],
|
|
71
|
+
"description": "Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).",
|
|
72
|
+
"properties": {
|
|
73
|
+
"notificationId": {
|
|
74
|
+
"$ref": "#/$defs/NotificationId"
|
|
75
|
+
},
|
|
76
|
+
"revision": {
|
|
77
|
+
"type": "integer",
|
|
78
|
+
"minimum": 1,
|
|
79
|
+
"maximum": 1000000,
|
|
80
|
+
"description": "The revision of the innermost notification, echoed."
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"NotificationId": {
|
|
85
|
+
"title": "NotificationId",
|
|
86
|
+
"description": "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.",
|
|
87
|
+
"type": "string",
|
|
88
|
+
"minLength": 1,
|
|
89
|
+
"maxLength": 256,
|
|
90
|
+
"pattern": "^[A-Za-z0-9._~:-]+$"
|
|
91
|
+
},
|
|
92
|
+
"Ext": {
|
|
93
|
+
"title": "Ext",
|
|
94
|
+
"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.",
|
|
95
|
+
"type": "object",
|
|
96
|
+
"minProperties": 1,
|
|
97
|
+
"additionalProperties": true,
|
|
98
|
+
"propertyNames": {
|
|
99
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
100
|
+
}
|
|
101
|
+
},
|
|
102
|
+
"ContextId": {
|
|
103
|
+
"title": "ContextId",
|
|
104
|
+
"description": "The trust context the notification is held in: the one the addressed DID belongs to.",
|
|
105
|
+
"type": "string",
|
|
106
|
+
"minLength": 1,
|
|
107
|
+
"maxLength": 256
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
};
|
|
111
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
112
|
+
export const RESPONSE_PAYLOAD_SCHEMA = {
|
|
113
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
114
|
+
"$ref": "#/$defs/Response",
|
|
115
|
+
"$defs": {
|
|
116
|
+
"DepositedDocument": {
|
|
117
|
+
"title": "DepositedDocument",
|
|
118
|
+
"description": "The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.",
|
|
119
|
+
"type": "object",
|
|
120
|
+
"minProperties": 1
|
|
121
|
+
},
|
|
122
|
+
"Response": {
|
|
123
|
+
"$anchor": "response",
|
|
124
|
+
"title": "VTA Notifications — Deposit — response payload",
|
|
125
|
+
"type": "object",
|
|
126
|
+
"additionalProperties": false,
|
|
127
|
+
"required": [
|
|
128
|
+
"notificationId",
|
|
129
|
+
"revision"
|
|
130
|
+
],
|
|
131
|
+
"description": "Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).",
|
|
132
|
+
"properties": {
|
|
133
|
+
"notificationId": {
|
|
134
|
+
"$ref": "#/$defs/NotificationId"
|
|
135
|
+
},
|
|
136
|
+
"revision": {
|
|
137
|
+
"type": "integer",
|
|
138
|
+
"minimum": 1,
|
|
139
|
+
"maximum": 1000000,
|
|
140
|
+
"description": "The revision of the innermost notification, echoed."
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
},
|
|
144
|
+
"NotificationId": {
|
|
145
|
+
"title": "NotificationId",
|
|
146
|
+
"description": "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.",
|
|
147
|
+
"type": "string",
|
|
148
|
+
"minLength": 1,
|
|
149
|
+
"maxLength": 256,
|
|
150
|
+
"pattern": "^[A-Za-z0-9._~:-]+$"
|
|
151
|
+
},
|
|
152
|
+
"Ext": {
|
|
153
|
+
"title": "Ext",
|
|
154
|
+
"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.",
|
|
155
|
+
"type": "object",
|
|
156
|
+
"minProperties": 1,
|
|
157
|
+
"additionalProperties": true,
|
|
158
|
+
"propertyNames": {
|
|
159
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
"ContextId": {
|
|
163
|
+
"title": "ContextId",
|
|
164
|
+
"description": "The trust context the notification is held in: the one the addressed DID belongs to.",
|
|
165
|
+
"type": "string",
|
|
166
|
+
"minLength": 1,
|
|
167
|
+
"maxLength": 256
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
};
|
|
171
|
+
/**
|
|
172
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
173
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
174
|
+
* per-specification and cannot be derived from the document alone, and
|
|
175
|
+
* item 2 needs the schema this carries.
|
|
176
|
+
*/
|
|
177
|
+
export const SPEC = {
|
|
178
|
+
typeUri: TYPE_URI,
|
|
179
|
+
isBearer: false,
|
|
180
|
+
isProofRequired: false,
|
|
181
|
+
isRecipientRequired: true,
|
|
182
|
+
isIssuedAtRequired: true,
|
|
183
|
+
payloadSchema: PAYLOAD_SCHEMA,
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
187
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
188
|
+
* parties (§7.3 item 5).
|
|
189
|
+
*/
|
|
190
|
+
export const RESPONSE_SPEC = {
|
|
191
|
+
typeUri: RESPONSE_TYPE_URI,
|
|
192
|
+
isBearer: false,
|
|
193
|
+
isProofRequired: false,
|
|
194
|
+
isRecipientRequired: true,
|
|
195
|
+
isIssuedAtRequired: true,
|
|
196
|
+
payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
|
|
197
|
+
};
|
|
198
|
+
//# sourceMappingURL=payload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vta/notifications/deposit/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkCH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,2DAAoE,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAkB,IAAI,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAkB,IAAI,CAAC;AAK/C,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,oEAA6E,CAAC;AAK/G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,2DAA2D;IAClE,OAAO,EAAE,uCAAuC;IAChD,aAAa,EAAE,6uBAA6uB;IAC5vB,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,WAAW;QACX,UAAU;KACX;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,mBAAmB;YAC3B,aAAa,EAAE,2GAA2G;SAC3H;QACD,UAAU,EAAE;YACV,MAAM,EAAE,2BAA2B;SACpC;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,mBAAmB,EAAE;YACnB,OAAO,EAAE,mBAAmB;YAC5B,aAAa,EAAE,scAAsc;YACrd,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;SACnB;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,gDAAgD;YACzD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,gBAAgB;gBAChB,UAAU;aACX;YACD,aAAa,EAAE,kPAAkP;YACjQ,YAAY,EAAE;gBACZ,gBAAgB,EAAE;oBAChB,MAAM,EAAE,wBAAwB;iBACjC;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,OAAO;oBAClB,aAAa,EAAE,qDAAqD;iBACrE;aACF;SACF;QACD,gBAAgB,EAAE;YAChB,OAAO,EAAE,gBAAgB;YACzB,aAAa,EAAE,8ZAA8Z;YAC7a,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,SAAS,EAAE,qBAAqB;SACjC;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,sFAAsF;YACrG,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;SACjB;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,mBAAmB,EAAE;YACnB,OAAO,EAAE,mBAAmB;YAC5B,aAAa,EAAE,scAAsc;YACrd,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;SACnB;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,gDAAgD;YACzD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,gBAAgB;gBAChB,UAAU;aACX;YACD,aAAa,EAAE,kPAAkP;YACjQ,YAAY,EAAE;gBACZ,gBAAgB,EAAE;oBAChB,MAAM,EAAE,wBAAwB;iBACjC;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,OAAO;oBAClB,aAAa,EAAE,qDAAqD;iBACrE;aACF;SACF;QACD,gBAAgB,EAAE;YAChB,OAAO,EAAE,gBAAgB;YACzB,aAAa,EAAE,8ZAA8Z;YAC7a,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,SAAS,EAAE,qBAAqB;SACjC;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,sFAAsF;YACrG,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;SACjB;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}
|