@openvtc/trust-tasks 0.16.9 → 0.16.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 +220 -0
- package/dist/_shared/components.d.ts +206 -5
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/index.d.ts +27 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +27 -0
- package/dist/index.js.map +1 -1
- package/dist/persona/_shared/0.1/persona-record.d.ts +22 -0
- package/dist/persona/_shared/0.1/persona-record.d.ts.map +1 -0
- package/dist/persona/_shared/0.1/persona-record.js +6 -0
- package/dist/persona/_shared/0.1/persona-record.js.map +1 -0
- package/dist/persona/attribute/delete/1.0/payload.d.ts +351 -0
- package/dist/persona/attribute/delete/1.0/payload.d.ts.map +1 -0
- package/dist/persona/attribute/delete/1.0/payload.js +188 -0
- package/dist/persona/attribute/delete/1.0/payload.js.map +1 -0
- package/dist/persona/attribute/list/1.0/payload.d.ts +895 -0
- package/dist/persona/attribute/list/1.0/payload.d.ts.map +1 -0
- package/dist/persona/attribute/list/1.0/payload.js +530 -0
- package/dist/persona/attribute/list/1.0/payload.js.map +1 -0
- package/dist/persona/attribute/put/1.0/payload.d.ts +829 -0
- package/dist/persona/attribute/put/1.0/payload.d.ts.map +1 -0
- package/dist/persona/attribute/put/1.0/payload.js +487 -0
- package/dist/persona/attribute/put/1.0/payload.js.map +1 -0
- package/dist/persona/binding/get/1.0/payload.d.ts +382 -0
- package/dist/persona/binding/get/1.0/payload.d.ts.map +1 -0
- package/dist/persona/binding/get/1.0/payload.js +206 -0
- package/dist/persona/binding/get/1.0/payload.js.map +1 -0
- package/dist/persona/binding/list/1.0/payload.d.ts +387 -0
- package/dist/persona/binding/list/1.0/payload.d.ts.map +1 -0
- package/dist/persona/binding/list/1.0/payload.js +210 -0
- package/dist/persona/binding/list/1.0/payload.js.map +1 -0
- package/dist/persona/binding/set/1.0/payload.d.ts +545 -0
- package/dist/persona/binding/set/1.0/payload.d.ts.map +1 -0
- package/dist/persona/binding/set/1.0/payload.js +302 -0
- package/dist/persona/binding/set/1.0/payload.js.map +1 -0
- package/dist/persona/contact/delete/1.0/payload.d.ts +313 -0
- package/dist/persona/contact/delete/1.0/payload.d.ts.map +1 -0
- package/dist/persona/contact/delete/1.0/payload.js +174 -0
- package/dist/persona/contact/delete/1.0/payload.js.map +1 -0
- package/dist/persona/contact/get/1.0/payload.d.ts +1027 -0
- package/dist/persona/contact/get/1.0/payload.d.ts.map +1 -0
- package/dist/persona/contact/get/1.0/payload.js +606 -0
- package/dist/persona/contact/get/1.0/payload.js.map +1 -0
- package/dist/persona/contact/list/1.0/payload.d.ts +490 -0
- package/dist/persona/contact/list/1.0/payload.d.ts.map +1 -0
- package/dist/persona/contact/list/1.0/payload.js +262 -0
- package/dist/persona/contact/list/1.0/payload.js.map +1 -0
- package/dist/persona/contact/put/1.0/payload.d.ts +885 -0
- package/dist/persona/contact/put/1.0/payload.d.ts.map +1 -0
- package/dist/persona/contact/put/1.0/payload.js +518 -0
- package/dist/persona/contact/put/1.0/payload.js.map +1 -0
- package/dist/persona/correlation/analyze/1.0/payload.d.ts +648 -0
- package/dist/persona/correlation/analyze/1.0/payload.d.ts.map +1 -0
- package/dist/persona/correlation/analyze/1.0/payload.js +338 -0
- package/dist/persona/correlation/analyze/1.0/payload.js.map +1 -0
- package/dist/persona/disclosure/history/1.0/payload.d.ts +639 -0
- package/dist/persona/disclosure/history/1.0/payload.d.ts.map +1 -0
- package/dist/persona/disclosure/history/1.0/payload.js +339 -0
- package/dist/persona/disclosure/history/1.0/payload.js.map +1 -0
- package/dist/persona/disclosure/present/1.0/payload.d.ts +400 -0
- package/dist/persona/disclosure/present/1.0/payload.d.ts.map +1 -0
- package/dist/persona/disclosure/present/1.0/payload.js +211 -0
- package/dist/persona/disclosure/present/1.0/payload.js.map +1 -0
- package/dist/persona/disclosure/preview/1.0/payload.d.ts +858 -0
- package/dist/persona/disclosure/preview/1.0/payload.d.ts.map +1 -0
- package/dist/persona/disclosure/preview/1.0/payload.js +480 -0
- package/dist/persona/disclosure/preview/1.0/payload.js.map +1 -0
- package/dist/persona/local/binding/set/1.0/payload.d.ts +394 -0
- package/dist/persona/local/binding/set/1.0/payload.d.ts.map +1 -0
- package/dist/persona/local/binding/set/1.0/payload.js +226 -0
- package/dist/persona/local/binding/set/1.0/payload.js.map +1 -0
- package/dist/persona/local/profile/delete/1.0/payload.d.ts +311 -0
- package/dist/persona/local/profile/delete/1.0/payload.d.ts.map +1 -0
- package/dist/persona/local/profile/delete/1.0/payload.js +173 -0
- package/dist/persona/local/profile/delete/1.0/payload.js.map +1 -0
- package/dist/persona/local/profile/get/1.0/payload.d.ts +368 -0
- package/dist/persona/local/profile/get/1.0/payload.d.ts.map +1 -0
- package/dist/persona/local/profile/get/1.0/payload.js +210 -0
- package/dist/persona/local/profile/get/1.0/payload.js.map +1 -0
- package/dist/persona/local/profile/list/1.0/payload.d.ts +387 -0
- package/dist/persona/local/profile/list/1.0/payload.d.ts.map +1 -0
- package/dist/persona/local/profile/list/1.0/payload.js +214 -0
- package/dist/persona/local/profile/list/1.0/payload.js.map +1 -0
- package/dist/persona/local/profile/put/1.0/payload.d.ts +545 -0
- package/dist/persona/local/profile/put/1.0/payload.d.ts.map +1 -0
- package/dist/persona/local/profile/put/1.0/payload.js +315 -0
- package/dist/persona/local/profile/put/1.0/payload.js.map +1 -0
- package/dist/persona/profile/delete/1.0/payload.d.ts +350 -0
- package/dist/persona/profile/delete/1.0/payload.d.ts.map +1 -0
- package/dist/persona/profile/delete/1.0/payload.js +189 -0
- package/dist/persona/profile/delete/1.0/payload.js.map +1 -0
- package/dist/persona/profile/get/1.0/payload.d.ts +1307 -0
- package/dist/persona/profile/get/1.0/payload.d.ts.map +1 -0
- package/dist/persona/profile/get/1.0/payload.js +802 -0
- package/dist/persona/profile/get/1.0/payload.js.map +1 -0
- package/dist/persona/profile/list/1.0/payload.d.ts +1120 -0
- package/dist/persona/profile/list/1.0/payload.d.ts.map +1 -0
- package/dist/persona/profile/list/1.0/payload.js +680 -0
- package/dist/persona/profile/list/1.0/payload.js.map +1 -0
- package/dist/persona/profile/put/1.0/payload.d.ts +1115 -0
- package/dist/persona/profile/put/1.0/payload.d.ts.map +1 -0
- package/dist/persona/profile/put/1.0/payload.js +675 -0
- package/dist/persona/profile/put/1.0/payload.js.map +1 -0
- package/dist/persona/renderers/list/1.0/payload.d.ts +362 -0
- package/dist/persona/renderers/list/1.0/payload.d.ts.map +1 -0
- package/dist/persona/renderers/list/1.0/payload.js +197 -0
- package/dist/persona/renderers/list/1.0/payload.js.map +1 -0
- package/dist/rooms/owner/claim/0.1/payload.d.ts +391 -0
- package/dist/rooms/owner/claim/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/owner/claim/0.1/payload.js +214 -0
- package/dist/rooms/owner/claim/0.1/payload.js.map +1 -0
- package/dist/rooms/owner/transfer/0.1/payload.d.ts +391 -0
- package/dist/rooms/owner/transfer/0.1/payload.d.ts.map +1 -0
- package/dist/rooms/owner/transfer/0.1/payload.js +214 -0
- package/dist/rooms/owner/transfer/0.1/payload.js.map +1 -0
- package/dist/vta/_shared/0.1/app-state-record.d.ts +1 -1
- package/dist/vta/_shared/0.1/app-state-record.d.ts.map +1 -1
- package/dist/vta/app-state/delete/1.0/payload.d.ts +1 -1
- package/dist/vta/app-state/delete/1.0/payload.d.ts.map +1 -1
- package/dist/vta/app-state/get/1.0/payload.d.ts +1 -1
- package/dist/vta/app-state/get/1.0/payload.d.ts.map +1 -1
- package/dist/vta/app-state/get-many/1.0/payload.d.ts +1 -1
- package/dist/vta/app-state/get-many/1.0/payload.d.ts.map +1 -1
- package/dist/vta/app-state/list/1.0/payload.d.ts +1 -1
- package/dist/vta/app-state/list/1.0/payload.d.ts.map +1 -1
- package/dist/vta/app-state/put/1.0/payload.d.ts +1 -1
- package/dist/vta/app-state/put/1.0/payload.d.ts.map +1 -1
- package/dist/vta/app-state/put-many/1.0/payload.d.ts +1 -1
- package/dist/vta/app-state/put-many/1.0/payload.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/_shared/components.ts +213 -5
- package/src/index.ts +27 -0
- package/src/persona/_shared/0.1/persona-record.ts +23 -0
- package/src/persona/attribute/delete/1.0/payload.ts +238 -0
- package/src/persona/attribute/list/1.0/payload.ts +588 -0
- package/src/persona/attribute/put/1.0/payload.ts +559 -0
- package/src/persona/binding/get/1.0/payload.ts +257 -0
- package/src/persona/binding/list/1.0/payload.ts +260 -0
- package/src/persona/binding/set/1.0/payload.ts +370 -0
- package/src/persona/contact/delete/1.0/payload.ts +216 -0
- package/src/persona/contact/get/1.0/payload.ts +662 -0
- package/src/persona/contact/list/1.0/payload.ts +323 -0
- package/src/persona/contact/put/1.0/payload.ts +580 -0
- package/src/persona/correlation/analyze/1.0/payload.ts +466 -0
- package/src/persona/disclosure/history/1.0/payload.ts +415 -0
- package/src/persona/disclosure/present/1.0/payload.ts +274 -0
- package/src/persona/disclosure/preview/1.0/payload.ts +597 -0
- package/src/persona/local/binding/set/1.0/payload.ts +267 -0
- package/src/persona/local/profile/delete/1.0/payload.ts +215 -0
- package/src/persona/local/profile/get/1.0/payload.ts +251 -0
- package/src/persona/local/profile/list/1.0/payload.ts +260 -0
- package/src/persona/local/profile/put/1.0/payload.ts +373 -0
- package/src/persona/profile/delete/1.0/payload.ts +236 -0
- package/src/persona/profile/get/1.0/payload.ts +844 -0
- package/src/persona/profile/list/1.0/payload.ts +723 -0
- package/src/persona/profile/put/1.0/payload.ts +741 -0
- package/src/persona/renderers/list/1.0/payload.ts +248 -0
- package/src/rooms/owner/claim/0.1/payload.ts +268 -0
- package/src/rooms/owner/transfer/0.1/payload.ts +268 -0
- package/src/vta/_shared/0.1/app-state-record.ts +1 -1
- package/src/vta/app-state/delete/1.0/payload.ts +1 -1
- package/src/vta/app-state/get/1.0/payload.ts +1 -1
- package/src/vta/app-state/get-many/1.0/payload.ts +1 -1
- package/src/vta/app-state/list/1.0/payload.ts +1 -1
- package/src/vta/app-state/put/1.0/payload.ts +1 -1
- package/src/vta/app-state/put-many/1.0/payload.ts +1 -1
|
@@ -0,0 +1,490 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/persona/contact/list/1.0/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext, Ulid } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* Enumerate contacts in a context, optionally narrowed to those known by one persona. Summaries only; documents are fetched one at a time.
|
|
8
|
+
*/
|
|
9
|
+
export interface PersonaContactListPayload {
|
|
10
|
+
contextId: string;
|
|
11
|
+
/**
|
|
12
|
+
* Narrow to contacts known by this persona. Omitting it lists the context's contacts across every persona in it, which a producer SHOULD offer deliberately rather than by default — the unfiltered view is the one that shows the holder's personas side by side.
|
|
13
|
+
*/
|
|
14
|
+
knownByPersona?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Return only contacts whose current revision was received after this instant. The cheap way to answer "what changed while I was away", which is the question the revision history exists to make answerable.
|
|
17
|
+
*/
|
|
18
|
+
changedSince?: string;
|
|
19
|
+
cursor?: string;
|
|
20
|
+
limit?: number;
|
|
21
|
+
ext?: Ext;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Success response to persona/contact/list. Type https://trusttasks.org/spec/persona/contact/list/1.0#response. Summaries carry no claim values: a list is for finding a contact, and finding one does not require disclosing every contact's details.
|
|
25
|
+
*/
|
|
26
|
+
export interface PersonaContactListResponsePayload {
|
|
27
|
+
/**
|
|
28
|
+
* @maxItems 500
|
|
29
|
+
*/
|
|
30
|
+
contacts: {
|
|
31
|
+
contactId: Ulid;
|
|
32
|
+
subjectDid: string;
|
|
33
|
+
knownByPersona: string;
|
|
34
|
+
rev: number;
|
|
35
|
+
/**
|
|
36
|
+
* A rendering hint drawn from the contact's own disclosed display-name claim, so a list is legible. Absent when they disclosed none; a producer MUST NOT substitute the DID silently as though it were a name.
|
|
37
|
+
*/
|
|
38
|
+
displayName?: string;
|
|
39
|
+
claimCount?: number;
|
|
40
|
+
receivedAt: string;
|
|
41
|
+
/**
|
|
42
|
+
* True when the current revision superseded another and the holder has not yet acknowledged the difference. This is what lets a producer badge a contact whose payment address moved — the whole point of keeping revisions.
|
|
43
|
+
*/
|
|
44
|
+
hasUnreviewedChange?: boolean;
|
|
45
|
+
}[];
|
|
46
|
+
nextCursor?: string;
|
|
47
|
+
ext?: Ext;
|
|
48
|
+
}
|
|
49
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
50
|
+
export type { Ext, Ulid };
|
|
51
|
+
/** Trust Task type URI. */
|
|
52
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/persona/contact/list/1.0";
|
|
53
|
+
/** Stable alias for this specification's request payload shape. */
|
|
54
|
+
export type Payload = PersonaContactListPayload;
|
|
55
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
56
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/persona/contact/list/1.0#response";
|
|
57
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
58
|
+
export type Response = PersonaContactListResponsePayload;
|
|
59
|
+
/**
|
|
60
|
+
* This specification's payload schema, as a value.
|
|
61
|
+
*
|
|
62
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
63
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
64
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
65
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
66
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
67
|
+
*/
|
|
68
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
69
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
70
|
+
readonly $id: "https://trusttasks.org/spec/persona/contact/list/1.0";
|
|
71
|
+
readonly title: "Persona Contact List — payload";
|
|
72
|
+
readonly description: "Enumerate contacts in a context, optionally narrowed to those known by one persona. Summaries only; documents are fetched one at a time.";
|
|
73
|
+
readonly type: "object";
|
|
74
|
+
readonly additionalProperties: false;
|
|
75
|
+
readonly required: readonly ["contextId"];
|
|
76
|
+
readonly properties: {
|
|
77
|
+
readonly contextId: {
|
|
78
|
+
readonly type: "string";
|
|
79
|
+
readonly minLength: 1;
|
|
80
|
+
};
|
|
81
|
+
readonly knownByPersona: {
|
|
82
|
+
readonly type: "string";
|
|
83
|
+
readonly maxLength: 2048;
|
|
84
|
+
readonly description: "Narrow to contacts known by this persona. Omitting it lists the context's contacts across every persona in it, which a producer SHOULD offer deliberately rather than by default — the unfiltered view is the one that shows the holder's personas side by side.";
|
|
85
|
+
};
|
|
86
|
+
readonly changedSince: {
|
|
87
|
+
readonly type: "string";
|
|
88
|
+
readonly format: "date-time";
|
|
89
|
+
readonly description: "Return only contacts whose current revision was received after this instant. The cheap way to answer \"what changed while I was away\", which is the question the revision history exists to make answerable.";
|
|
90
|
+
};
|
|
91
|
+
readonly cursor: {
|
|
92
|
+
readonly type: "string";
|
|
93
|
+
readonly maxLength: 4096;
|
|
94
|
+
};
|
|
95
|
+
readonly limit: {
|
|
96
|
+
readonly type: "integer";
|
|
97
|
+
readonly minimum: 1;
|
|
98
|
+
readonly maximum: 500;
|
|
99
|
+
readonly default: 100;
|
|
100
|
+
};
|
|
101
|
+
readonly ext: {
|
|
102
|
+
readonly $ref: "#/$defs/Ext";
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
readonly $defs: {
|
|
106
|
+
readonly Response: {
|
|
107
|
+
readonly $anchor: "response";
|
|
108
|
+
readonly title: "Persona Contact List — response payload";
|
|
109
|
+
readonly description: "Success response to persona/contact/list. Type https://trusttasks.org/spec/persona/contact/list/1.0#response. Summaries carry no claim values: a list is for finding a contact, and finding one does not require disclosing every contact's details.";
|
|
110
|
+
readonly type: "object";
|
|
111
|
+
readonly additionalProperties: false;
|
|
112
|
+
readonly required: readonly ["contacts"];
|
|
113
|
+
readonly properties: {
|
|
114
|
+
readonly contacts: {
|
|
115
|
+
readonly type: "array";
|
|
116
|
+
readonly maxItems: 500;
|
|
117
|
+
readonly items: {
|
|
118
|
+
readonly type: "object";
|
|
119
|
+
readonly additionalProperties: false;
|
|
120
|
+
readonly required: readonly ["contactId", "subjectDid", "knownByPersona", "rev", "receivedAt"];
|
|
121
|
+
readonly properties: {
|
|
122
|
+
readonly contactId: {
|
|
123
|
+
readonly $ref: "#/$defs/Ulid";
|
|
124
|
+
};
|
|
125
|
+
readonly subjectDid: {
|
|
126
|
+
readonly type: "string";
|
|
127
|
+
readonly minLength: 1;
|
|
128
|
+
};
|
|
129
|
+
readonly knownByPersona: {
|
|
130
|
+
readonly type: "string";
|
|
131
|
+
readonly minLength: 1;
|
|
132
|
+
};
|
|
133
|
+
readonly rev: {
|
|
134
|
+
readonly type: "integer";
|
|
135
|
+
readonly minimum: 1;
|
|
136
|
+
};
|
|
137
|
+
readonly displayName: {
|
|
138
|
+
readonly type: "string";
|
|
139
|
+
readonly maxLength: 256;
|
|
140
|
+
readonly description: "A rendering hint drawn from the contact's own disclosed display-name claim, so a list is legible. Absent when they disclosed none; a producer MUST NOT substitute the DID silently as though it were a name.";
|
|
141
|
+
};
|
|
142
|
+
readonly claimCount: {
|
|
143
|
+
readonly type: "integer";
|
|
144
|
+
readonly minimum: 0;
|
|
145
|
+
};
|
|
146
|
+
readonly receivedAt: {
|
|
147
|
+
readonly type: "string";
|
|
148
|
+
readonly format: "date-time";
|
|
149
|
+
};
|
|
150
|
+
readonly hasUnreviewedChange: {
|
|
151
|
+
readonly type: "boolean";
|
|
152
|
+
readonly description: "True when the current revision superseded another and the holder has not yet acknowledged the difference. This is what lets a producer badge a contact whose payment address moved — the whole point of keeping revisions.";
|
|
153
|
+
};
|
|
154
|
+
};
|
|
155
|
+
};
|
|
156
|
+
};
|
|
157
|
+
readonly nextCursor: {
|
|
158
|
+
readonly type: "string";
|
|
159
|
+
readonly maxLength: 4096;
|
|
160
|
+
};
|
|
161
|
+
readonly ext: {
|
|
162
|
+
readonly $ref: "#/$defs/Ext";
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
};
|
|
166
|
+
readonly Ext: {
|
|
167
|
+
readonly title: "Ext";
|
|
168
|
+
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.";
|
|
169
|
+
readonly type: "object";
|
|
170
|
+
readonly minProperties: 1;
|
|
171
|
+
readonly additionalProperties: true;
|
|
172
|
+
readonly propertyNames: {
|
|
173
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
174
|
+
};
|
|
175
|
+
};
|
|
176
|
+
readonly Ulid: {
|
|
177
|
+
readonly title: "Ulid";
|
|
178
|
+
readonly description: "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.";
|
|
179
|
+
readonly type: "string";
|
|
180
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
181
|
+
};
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
185
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
186
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
187
|
+
readonly $ref: "#/$defs/Response";
|
|
188
|
+
readonly $defs: {
|
|
189
|
+
readonly Response: {
|
|
190
|
+
readonly $anchor: "response";
|
|
191
|
+
readonly title: "Persona Contact List — response payload";
|
|
192
|
+
readonly description: "Success response to persona/contact/list. Type https://trusttasks.org/spec/persona/contact/list/1.0#response. Summaries carry no claim values: a list is for finding a contact, and finding one does not require disclosing every contact's details.";
|
|
193
|
+
readonly type: "object";
|
|
194
|
+
readonly additionalProperties: false;
|
|
195
|
+
readonly required: readonly ["contacts"];
|
|
196
|
+
readonly properties: {
|
|
197
|
+
readonly contacts: {
|
|
198
|
+
readonly type: "array";
|
|
199
|
+
readonly maxItems: 500;
|
|
200
|
+
readonly items: {
|
|
201
|
+
readonly type: "object";
|
|
202
|
+
readonly additionalProperties: false;
|
|
203
|
+
readonly required: readonly ["contactId", "subjectDid", "knownByPersona", "rev", "receivedAt"];
|
|
204
|
+
readonly properties: {
|
|
205
|
+
readonly contactId: {
|
|
206
|
+
readonly $ref: "#/$defs/Ulid";
|
|
207
|
+
};
|
|
208
|
+
readonly subjectDid: {
|
|
209
|
+
readonly type: "string";
|
|
210
|
+
readonly minLength: 1;
|
|
211
|
+
};
|
|
212
|
+
readonly knownByPersona: {
|
|
213
|
+
readonly type: "string";
|
|
214
|
+
readonly minLength: 1;
|
|
215
|
+
};
|
|
216
|
+
readonly rev: {
|
|
217
|
+
readonly type: "integer";
|
|
218
|
+
readonly minimum: 1;
|
|
219
|
+
};
|
|
220
|
+
readonly displayName: {
|
|
221
|
+
readonly type: "string";
|
|
222
|
+
readonly maxLength: 256;
|
|
223
|
+
readonly description: "A rendering hint drawn from the contact's own disclosed display-name claim, so a list is legible. Absent when they disclosed none; a producer MUST NOT substitute the DID silently as though it were a name.";
|
|
224
|
+
};
|
|
225
|
+
readonly claimCount: {
|
|
226
|
+
readonly type: "integer";
|
|
227
|
+
readonly minimum: 0;
|
|
228
|
+
};
|
|
229
|
+
readonly receivedAt: {
|
|
230
|
+
readonly type: "string";
|
|
231
|
+
readonly format: "date-time";
|
|
232
|
+
};
|
|
233
|
+
readonly hasUnreviewedChange: {
|
|
234
|
+
readonly type: "boolean";
|
|
235
|
+
readonly description: "True when the current revision superseded another and the holder has not yet acknowledged the difference. This is what lets a producer badge a contact whose payment address moved — the whole point of keeping revisions.";
|
|
236
|
+
};
|
|
237
|
+
};
|
|
238
|
+
};
|
|
239
|
+
};
|
|
240
|
+
readonly nextCursor: {
|
|
241
|
+
readonly type: "string";
|
|
242
|
+
readonly maxLength: 4096;
|
|
243
|
+
};
|
|
244
|
+
readonly ext: {
|
|
245
|
+
readonly $ref: "#/$defs/Ext";
|
|
246
|
+
};
|
|
247
|
+
};
|
|
248
|
+
};
|
|
249
|
+
readonly Ext: {
|
|
250
|
+
readonly title: "Ext";
|
|
251
|
+
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.";
|
|
252
|
+
readonly type: "object";
|
|
253
|
+
readonly minProperties: 1;
|
|
254
|
+
readonly additionalProperties: true;
|
|
255
|
+
readonly propertyNames: {
|
|
256
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
257
|
+
};
|
|
258
|
+
};
|
|
259
|
+
readonly Ulid: {
|
|
260
|
+
readonly title: "Ulid";
|
|
261
|
+
readonly description: "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.";
|
|
262
|
+
readonly type: "string";
|
|
263
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
264
|
+
};
|
|
265
|
+
};
|
|
266
|
+
};
|
|
267
|
+
/**
|
|
268
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
269
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
270
|
+
* per-specification and cannot be derived from the document alone, and
|
|
271
|
+
* item 2 needs the schema this carries.
|
|
272
|
+
*/
|
|
273
|
+
export declare const SPEC: {
|
|
274
|
+
readonly typeUri: "https://trusttasks.org/spec/persona/contact/list/1.0";
|
|
275
|
+
readonly isBearer: false;
|
|
276
|
+
readonly isProofRequired: true;
|
|
277
|
+
readonly isRecipientRequired: true;
|
|
278
|
+
readonly isIssuedAtRequired: false;
|
|
279
|
+
readonly payloadSchema: {
|
|
280
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
281
|
+
readonly $id: "https://trusttasks.org/spec/persona/contact/list/1.0";
|
|
282
|
+
readonly title: "Persona Contact List — payload";
|
|
283
|
+
readonly description: "Enumerate contacts in a context, optionally narrowed to those known by one persona. Summaries only; documents are fetched one at a time.";
|
|
284
|
+
readonly type: "object";
|
|
285
|
+
readonly additionalProperties: false;
|
|
286
|
+
readonly required: readonly ["contextId"];
|
|
287
|
+
readonly properties: {
|
|
288
|
+
readonly contextId: {
|
|
289
|
+
readonly type: "string";
|
|
290
|
+
readonly minLength: 1;
|
|
291
|
+
};
|
|
292
|
+
readonly knownByPersona: {
|
|
293
|
+
readonly type: "string";
|
|
294
|
+
readonly maxLength: 2048;
|
|
295
|
+
readonly description: "Narrow to contacts known by this persona. Omitting it lists the context's contacts across every persona in it, which a producer SHOULD offer deliberately rather than by default — the unfiltered view is the one that shows the holder's personas side by side.";
|
|
296
|
+
};
|
|
297
|
+
readonly changedSince: {
|
|
298
|
+
readonly type: "string";
|
|
299
|
+
readonly format: "date-time";
|
|
300
|
+
readonly description: "Return only contacts whose current revision was received after this instant. The cheap way to answer \"what changed while I was away\", which is the question the revision history exists to make answerable.";
|
|
301
|
+
};
|
|
302
|
+
readonly cursor: {
|
|
303
|
+
readonly type: "string";
|
|
304
|
+
readonly maxLength: 4096;
|
|
305
|
+
};
|
|
306
|
+
readonly limit: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 1;
|
|
309
|
+
readonly maximum: 500;
|
|
310
|
+
readonly default: 100;
|
|
311
|
+
};
|
|
312
|
+
readonly ext: {
|
|
313
|
+
readonly $ref: "#/$defs/Ext";
|
|
314
|
+
};
|
|
315
|
+
};
|
|
316
|
+
readonly $defs: {
|
|
317
|
+
readonly Response: {
|
|
318
|
+
readonly $anchor: "response";
|
|
319
|
+
readonly title: "Persona Contact List — response payload";
|
|
320
|
+
readonly description: "Success response to persona/contact/list. Type https://trusttasks.org/spec/persona/contact/list/1.0#response. Summaries carry no claim values: a list is for finding a contact, and finding one does not require disclosing every contact's details.";
|
|
321
|
+
readonly type: "object";
|
|
322
|
+
readonly additionalProperties: false;
|
|
323
|
+
readonly required: readonly ["contacts"];
|
|
324
|
+
readonly properties: {
|
|
325
|
+
readonly contacts: {
|
|
326
|
+
readonly type: "array";
|
|
327
|
+
readonly maxItems: 500;
|
|
328
|
+
readonly items: {
|
|
329
|
+
readonly type: "object";
|
|
330
|
+
readonly additionalProperties: false;
|
|
331
|
+
readonly required: readonly ["contactId", "subjectDid", "knownByPersona", "rev", "receivedAt"];
|
|
332
|
+
readonly properties: {
|
|
333
|
+
readonly contactId: {
|
|
334
|
+
readonly $ref: "#/$defs/Ulid";
|
|
335
|
+
};
|
|
336
|
+
readonly subjectDid: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly minLength: 1;
|
|
339
|
+
};
|
|
340
|
+
readonly knownByPersona: {
|
|
341
|
+
readonly type: "string";
|
|
342
|
+
readonly minLength: 1;
|
|
343
|
+
};
|
|
344
|
+
readonly rev: {
|
|
345
|
+
readonly type: "integer";
|
|
346
|
+
readonly minimum: 1;
|
|
347
|
+
};
|
|
348
|
+
readonly displayName: {
|
|
349
|
+
readonly type: "string";
|
|
350
|
+
readonly maxLength: 256;
|
|
351
|
+
readonly description: "A rendering hint drawn from the contact's own disclosed display-name claim, so a list is legible. Absent when they disclosed none; a producer MUST NOT substitute the DID silently as though it were a name.";
|
|
352
|
+
};
|
|
353
|
+
readonly claimCount: {
|
|
354
|
+
readonly type: "integer";
|
|
355
|
+
readonly minimum: 0;
|
|
356
|
+
};
|
|
357
|
+
readonly receivedAt: {
|
|
358
|
+
readonly type: "string";
|
|
359
|
+
readonly format: "date-time";
|
|
360
|
+
};
|
|
361
|
+
readonly hasUnreviewedChange: {
|
|
362
|
+
readonly type: "boolean";
|
|
363
|
+
readonly description: "True when the current revision superseded another and the holder has not yet acknowledged the difference. This is what lets a producer badge a contact whose payment address moved — the whole point of keeping revisions.";
|
|
364
|
+
};
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
};
|
|
368
|
+
readonly nextCursor: {
|
|
369
|
+
readonly type: "string";
|
|
370
|
+
readonly maxLength: 4096;
|
|
371
|
+
};
|
|
372
|
+
readonly ext: {
|
|
373
|
+
readonly $ref: "#/$defs/Ext";
|
|
374
|
+
};
|
|
375
|
+
};
|
|
376
|
+
};
|
|
377
|
+
readonly Ext: {
|
|
378
|
+
readonly title: "Ext";
|
|
379
|
+
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.";
|
|
380
|
+
readonly type: "object";
|
|
381
|
+
readonly minProperties: 1;
|
|
382
|
+
readonly additionalProperties: true;
|
|
383
|
+
readonly propertyNames: {
|
|
384
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
385
|
+
};
|
|
386
|
+
};
|
|
387
|
+
readonly Ulid: {
|
|
388
|
+
readonly title: "Ulid";
|
|
389
|
+
readonly description: "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.";
|
|
390
|
+
readonly type: "string";
|
|
391
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
};
|
|
395
|
+
};
|
|
396
|
+
/**
|
|
397
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
398
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
399
|
+
* parties (§7.3 item 5).
|
|
400
|
+
*/
|
|
401
|
+
export declare const RESPONSE_SPEC: {
|
|
402
|
+
readonly typeUri: "https://trusttasks.org/spec/persona/contact/list/1.0#response";
|
|
403
|
+
readonly isBearer: false;
|
|
404
|
+
readonly isProofRequired: true;
|
|
405
|
+
readonly isRecipientRequired: true;
|
|
406
|
+
readonly isIssuedAtRequired: false;
|
|
407
|
+
readonly payloadSchema: {
|
|
408
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
409
|
+
readonly $ref: "#/$defs/Response";
|
|
410
|
+
readonly $defs: {
|
|
411
|
+
readonly Response: {
|
|
412
|
+
readonly $anchor: "response";
|
|
413
|
+
readonly title: "Persona Contact List — response payload";
|
|
414
|
+
readonly description: "Success response to persona/contact/list. Type https://trusttasks.org/spec/persona/contact/list/1.0#response. Summaries carry no claim values: a list is for finding a contact, and finding one does not require disclosing every contact's details.";
|
|
415
|
+
readonly type: "object";
|
|
416
|
+
readonly additionalProperties: false;
|
|
417
|
+
readonly required: readonly ["contacts"];
|
|
418
|
+
readonly properties: {
|
|
419
|
+
readonly contacts: {
|
|
420
|
+
readonly type: "array";
|
|
421
|
+
readonly maxItems: 500;
|
|
422
|
+
readonly items: {
|
|
423
|
+
readonly type: "object";
|
|
424
|
+
readonly additionalProperties: false;
|
|
425
|
+
readonly required: readonly ["contactId", "subjectDid", "knownByPersona", "rev", "receivedAt"];
|
|
426
|
+
readonly properties: {
|
|
427
|
+
readonly contactId: {
|
|
428
|
+
readonly $ref: "#/$defs/Ulid";
|
|
429
|
+
};
|
|
430
|
+
readonly subjectDid: {
|
|
431
|
+
readonly type: "string";
|
|
432
|
+
readonly minLength: 1;
|
|
433
|
+
};
|
|
434
|
+
readonly knownByPersona: {
|
|
435
|
+
readonly type: "string";
|
|
436
|
+
readonly minLength: 1;
|
|
437
|
+
};
|
|
438
|
+
readonly rev: {
|
|
439
|
+
readonly type: "integer";
|
|
440
|
+
readonly minimum: 1;
|
|
441
|
+
};
|
|
442
|
+
readonly displayName: {
|
|
443
|
+
readonly type: "string";
|
|
444
|
+
readonly maxLength: 256;
|
|
445
|
+
readonly description: "A rendering hint drawn from the contact's own disclosed display-name claim, so a list is legible. Absent when they disclosed none; a producer MUST NOT substitute the DID silently as though it were a name.";
|
|
446
|
+
};
|
|
447
|
+
readonly claimCount: {
|
|
448
|
+
readonly type: "integer";
|
|
449
|
+
readonly minimum: 0;
|
|
450
|
+
};
|
|
451
|
+
readonly receivedAt: {
|
|
452
|
+
readonly type: "string";
|
|
453
|
+
readonly format: "date-time";
|
|
454
|
+
};
|
|
455
|
+
readonly hasUnreviewedChange: {
|
|
456
|
+
readonly type: "boolean";
|
|
457
|
+
readonly description: "True when the current revision superseded another and the holder has not yet acknowledged the difference. This is what lets a producer badge a contact whose payment address moved — the whole point of keeping revisions.";
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
readonly nextCursor: {
|
|
463
|
+
readonly type: "string";
|
|
464
|
+
readonly maxLength: 4096;
|
|
465
|
+
};
|
|
466
|
+
readonly ext: {
|
|
467
|
+
readonly $ref: "#/$defs/Ext";
|
|
468
|
+
};
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
readonly Ext: {
|
|
472
|
+
readonly title: "Ext";
|
|
473
|
+
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.";
|
|
474
|
+
readonly type: "object";
|
|
475
|
+
readonly minProperties: 1;
|
|
476
|
+
readonly additionalProperties: true;
|
|
477
|
+
readonly propertyNames: {
|
|
478
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
479
|
+
};
|
|
480
|
+
};
|
|
481
|
+
readonly Ulid: {
|
|
482
|
+
readonly title: "Ulid";
|
|
483
|
+
readonly description: "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.";
|
|
484
|
+
readonly type: "string";
|
|
485
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
486
|
+
};
|
|
487
|
+
};
|
|
488
|
+
};
|
|
489
|
+
};
|
|
490
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/persona/contact/list/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AAGnE;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,QAAQ,EAAE;QACR,SAAS,EAAE,IAAI,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,MAAM,CAAC;QACvB,GAAG,EAAE,MAAM,CAAC;QACZ;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;KAC/B,EAAE,CAAC;IACJ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAE1B,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,sDAA+D,CAAC;AAExF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,yBAAyB,CAAC;AAEhD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,+DAAwE,CAAC;AAE1G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,iCAAiC,CAAC;AAEzD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6HjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyF1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|