@openvtc/trust-tasks 0.16.9 → 0.16.10
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 +149 -0
- package/dist/_shared/components.d.ts +204 -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 +532 -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 +804 -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 +211 -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 +590 -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 +846 -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,1115 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/persona/profile/put/1.0/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { ClaimType, ExpectedVersion_PersonaV0_1 as ExpectedVersion, Ext, ProfileEntry, ProofRung, Provenance, Ulid, ValueType, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* Create or replace one profile: a named, ordered projection over the holder's attribute pool. Entries reference pool attributes rather than copying them, so a fact edited once is edited everywhere it appears.
|
|
8
|
+
*/
|
|
9
|
+
export interface PersonaProfilePutPayload {
|
|
10
|
+
/**
|
|
11
|
+
* Omit to create; supply to replace. A producer that means to create and wants the write to be safe under retry SHOULD supply a generated id together with `expectedVersion: 0`.
|
|
12
|
+
*/
|
|
13
|
+
profileId?: Ulid;
|
|
14
|
+
/**
|
|
15
|
+
* The holder's name for the profile — "Work", "Gaming". Never disclosed to a verifier; it is how the holder finds it again.
|
|
16
|
+
*/
|
|
17
|
+
name: string;
|
|
18
|
+
/**
|
|
19
|
+
* Ordered; the order is display order. An empty array is legal and means a profile that discloses nothing — useful as a starting point, and not the same as no profile at all.
|
|
20
|
+
*
|
|
21
|
+
* @maxItems 256
|
|
22
|
+
*/
|
|
23
|
+
entries: ProfileEntry[];
|
|
24
|
+
/**
|
|
25
|
+
* Vault identifiers of credentials associated with this profile as inventory — what this persona can prove — as distinct from the evidence relationship a credentialBacked attribute expresses. The two answer different questions and a consumer MUST NOT read one as the other.
|
|
26
|
+
*
|
|
27
|
+
* @maxItems 256
|
|
28
|
+
*/
|
|
29
|
+
credentialRefs?: string[];
|
|
30
|
+
expectedVersion?: ExpectedVersion;
|
|
31
|
+
ext?: Ext;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Success response to persona/profile/put. Type https://trusttasks.org/spec/persona/profile/put/1.0#response.
|
|
35
|
+
*/
|
|
36
|
+
export interface PersonaProfilePutResponsePayload {
|
|
37
|
+
profileId: Ulid;
|
|
38
|
+
version: Version;
|
|
39
|
+
created: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Advisory correlation result for the composition as a whole, returned on the write so a builder can warn while the holder is still composing. Advisory only: the write has applied, and a maintainer MUST NOT refuse a composition on correlation grounds.
|
|
42
|
+
*/
|
|
43
|
+
correlation?: {
|
|
44
|
+
severity: "none" | "low" | "high";
|
|
45
|
+
/**
|
|
46
|
+
* How many of this profile's entries present a value that another profile also presents. A count rather than a list; identifiers come from persona/correlation/analyze.
|
|
47
|
+
*/
|
|
48
|
+
sharedAttributeCount?: number;
|
|
49
|
+
};
|
|
50
|
+
createdAt?: string;
|
|
51
|
+
updatedAt: string;
|
|
52
|
+
ext?: Ext;
|
|
53
|
+
}
|
|
54
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
55
|
+
export type { ClaimType, ExpectedVersion, Ext, ProfileEntry, ProofRung, Provenance, Ulid, ValueType, Version };
|
|
56
|
+
/** Trust Task type URI. */
|
|
57
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/persona/profile/put/1.0";
|
|
58
|
+
/** Stable alias for this specification's request payload shape. */
|
|
59
|
+
export type Payload = PersonaProfilePutPayload;
|
|
60
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
61
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/persona/profile/put/1.0#response";
|
|
62
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
63
|
+
export type Response = PersonaProfilePutResponsePayload;
|
|
64
|
+
/**
|
|
65
|
+
* This specification's payload schema, as a value.
|
|
66
|
+
*
|
|
67
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
68
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
69
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
70
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
71
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
72
|
+
*/
|
|
73
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
74
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
75
|
+
readonly $id: "https://trusttasks.org/spec/persona/profile/put/1.0";
|
|
76
|
+
readonly title: "Persona Profile Put — payload";
|
|
77
|
+
readonly description: "Create or replace one profile: a named, ordered projection over the holder's attribute pool. Entries reference pool attributes rather than copying them, so a fact edited once is edited everywhere it appears.";
|
|
78
|
+
readonly type: "object";
|
|
79
|
+
readonly additionalProperties: false;
|
|
80
|
+
readonly required: readonly ["name", "entries"];
|
|
81
|
+
readonly properties: {
|
|
82
|
+
readonly profileId: {
|
|
83
|
+
readonly $ref: "#/$defs/Ulid";
|
|
84
|
+
readonly description: "Omit to create; supply to replace. A producer that means to create and wants the write to be safe under retry SHOULD supply a generated id together with `expectedVersion: 0`.";
|
|
85
|
+
};
|
|
86
|
+
readonly name: {
|
|
87
|
+
readonly type: "string";
|
|
88
|
+
readonly minLength: 1;
|
|
89
|
+
readonly maxLength: 128;
|
|
90
|
+
readonly description: "The holder's name for the profile — \"Work\", \"Gaming\". Never disclosed to a verifier; it is how the holder finds it again.";
|
|
91
|
+
};
|
|
92
|
+
readonly entries: {
|
|
93
|
+
readonly type: "array";
|
|
94
|
+
readonly maxItems: 256;
|
|
95
|
+
readonly items: {
|
|
96
|
+
readonly $ref: "#/$defs/ProfileEntry";
|
|
97
|
+
};
|
|
98
|
+
readonly description: "Ordered; the order is display order. An empty array is legal and means a profile that discloses nothing — useful as a starting point, and not the same as no profile at all.";
|
|
99
|
+
};
|
|
100
|
+
readonly credentialRefs: {
|
|
101
|
+
readonly type: "array";
|
|
102
|
+
readonly maxItems: 256;
|
|
103
|
+
readonly items: {
|
|
104
|
+
readonly type: "string";
|
|
105
|
+
readonly minLength: 1;
|
|
106
|
+
};
|
|
107
|
+
readonly description: "Vault identifiers of credentials associated with this profile as inventory — what this persona can prove — as distinct from the evidence relationship a credentialBacked attribute expresses. The two answer different questions and a consumer MUST NOT read one as the other.";
|
|
108
|
+
};
|
|
109
|
+
readonly expectedVersion: {
|
|
110
|
+
readonly $ref: "#/$defs/ExpectedVersion";
|
|
111
|
+
};
|
|
112
|
+
readonly ext: {
|
|
113
|
+
readonly $ref: "#/$defs/Ext";
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
readonly $defs: {
|
|
117
|
+
readonly Response: {
|
|
118
|
+
readonly $anchor: "response";
|
|
119
|
+
readonly title: "Persona Profile Put — response payload";
|
|
120
|
+
readonly description: "Success response to persona/profile/put. Type https://trusttasks.org/spec/persona/profile/put/1.0#response.";
|
|
121
|
+
readonly type: "object";
|
|
122
|
+
readonly additionalProperties: false;
|
|
123
|
+
readonly required: readonly ["profileId", "version", "created", "updatedAt"];
|
|
124
|
+
readonly properties: {
|
|
125
|
+
readonly profileId: {
|
|
126
|
+
readonly $ref: "#/$defs/Ulid";
|
|
127
|
+
};
|
|
128
|
+
readonly version: {
|
|
129
|
+
readonly $ref: "#/$defs/Version";
|
|
130
|
+
};
|
|
131
|
+
readonly created: {
|
|
132
|
+
readonly type: "boolean";
|
|
133
|
+
};
|
|
134
|
+
readonly correlation: {
|
|
135
|
+
readonly type: "object";
|
|
136
|
+
readonly additionalProperties: false;
|
|
137
|
+
readonly required: readonly ["severity"];
|
|
138
|
+
readonly description: "Advisory correlation result for the composition as a whole, returned on the write so a builder can warn while the holder is still composing. Advisory only: the write has applied, and a maintainer MUST NOT refuse a composition on correlation grounds.";
|
|
139
|
+
readonly properties: {
|
|
140
|
+
readonly severity: {
|
|
141
|
+
readonly type: "string";
|
|
142
|
+
readonly enum: readonly ["none", "low", "high"];
|
|
143
|
+
};
|
|
144
|
+
readonly sharedAttributeCount: {
|
|
145
|
+
readonly type: "integer";
|
|
146
|
+
readonly minimum: 0;
|
|
147
|
+
readonly description: "How many of this profile's entries present a value that another profile also presents. A count rather than a list; identifiers come from persona/correlation/analyze.";
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
readonly createdAt: {
|
|
152
|
+
readonly type: "string";
|
|
153
|
+
readonly format: "date-time";
|
|
154
|
+
};
|
|
155
|
+
readonly updatedAt: {
|
|
156
|
+
readonly type: "string";
|
|
157
|
+
readonly format: "date-time";
|
|
158
|
+
};
|
|
159
|
+
readonly ext: {
|
|
160
|
+
readonly $ref: "#/$defs/Ext";
|
|
161
|
+
};
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
readonly Ext: {
|
|
165
|
+
readonly title: "Ext";
|
|
166
|
+
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.";
|
|
167
|
+
readonly type: "object";
|
|
168
|
+
readonly minProperties: 1;
|
|
169
|
+
readonly additionalProperties: true;
|
|
170
|
+
readonly propertyNames: {
|
|
171
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
readonly Version: {
|
|
175
|
+
readonly title: "Version";
|
|
176
|
+
readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
|
|
177
|
+
readonly type: "integer";
|
|
178
|
+
readonly minimum: 1;
|
|
179
|
+
};
|
|
180
|
+
readonly Ulid: {
|
|
181
|
+
readonly title: "Ulid";
|
|
182
|
+
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.";
|
|
183
|
+
readonly type: "string";
|
|
184
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
185
|
+
};
|
|
186
|
+
readonly ExpectedVersion: {
|
|
187
|
+
readonly title: "ExpectedVersion";
|
|
188
|
+
readonly description: "Optimistic-concurrency precondition. A positive value requires the record's current `version` to equal it exactly; zero means create-only and applies only when no live record exists at the address.";
|
|
189
|
+
readonly type: "integer";
|
|
190
|
+
readonly minimum: 0;
|
|
191
|
+
};
|
|
192
|
+
readonly ProfileEntry: {
|
|
193
|
+
readonly title: "ProfileEntry";
|
|
194
|
+
readonly description: "One line of a profile, in exactly one of four forms. Together they are the whole of a profile's flexibility, and each exists for a case the others handle badly.\n\n`{ref}` — use the pool attribute, live. Editing the pool updates every profile that references it, which is the point.\n\n`{ref, pinVersion}` — use the value as it was at that version. For a profile that must keep presenting the value a counterparty already verified.\n\n`{ref, override}` — the same fact, a different value here. (\"In the gaming profile my display name is different.\")\n\n`{inline}` — a value that never enters the pool, and so never leaks into another profile.\n\nOmission is exclusion; there is no removal marker.";
|
|
195
|
+
readonly type: "object";
|
|
196
|
+
readonly oneOf: readonly [{
|
|
197
|
+
readonly additionalProperties: false;
|
|
198
|
+
readonly required: readonly ["ref"];
|
|
199
|
+
readonly properties: {
|
|
200
|
+
readonly ref: {
|
|
201
|
+
readonly $ref: "#/$defs/Ulid";
|
|
202
|
+
};
|
|
203
|
+
};
|
|
204
|
+
}, {
|
|
205
|
+
readonly additionalProperties: false;
|
|
206
|
+
readonly required: readonly ["ref", "pinVersion"];
|
|
207
|
+
readonly properties: {
|
|
208
|
+
readonly ref: {
|
|
209
|
+
readonly $ref: "#/$defs/Ulid";
|
|
210
|
+
};
|
|
211
|
+
readonly pinVersion: {
|
|
212
|
+
readonly $ref: "#/$defs/Version";
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
}, {
|
|
216
|
+
readonly additionalProperties: false;
|
|
217
|
+
readonly required: readonly ["ref", "override"];
|
|
218
|
+
readonly properties: {
|
|
219
|
+
readonly ref: {
|
|
220
|
+
readonly $ref: "#/$defs/Ulid";
|
|
221
|
+
};
|
|
222
|
+
readonly override: {
|
|
223
|
+
readonly type: "object";
|
|
224
|
+
readonly additionalProperties: false;
|
|
225
|
+
readonly required: readonly ["value"];
|
|
226
|
+
readonly properties: {
|
|
227
|
+
readonly value: {};
|
|
228
|
+
readonly label: {
|
|
229
|
+
readonly type: "string";
|
|
230
|
+
readonly maxLength: 128;
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
readonly description: "Replaces the pool attribute's value for this profile only. `type`, `valueType` and `provenance` are inherited from the referenced attribute and MUST NOT be overridden — an override that changed provenance would let a self-asserted value present as attested.";
|
|
234
|
+
};
|
|
235
|
+
};
|
|
236
|
+
}, {
|
|
237
|
+
readonly additionalProperties: false;
|
|
238
|
+
readonly required: readonly ["inline"];
|
|
239
|
+
readonly properties: {
|
|
240
|
+
readonly inline: {
|
|
241
|
+
readonly type: "object";
|
|
242
|
+
readonly additionalProperties: false;
|
|
243
|
+
readonly required: readonly ["type", "valueType", "value", "provenance"];
|
|
244
|
+
readonly properties: {
|
|
245
|
+
readonly type: {
|
|
246
|
+
readonly $ref: "#/$defs/ClaimType";
|
|
247
|
+
};
|
|
248
|
+
readonly valueType: {
|
|
249
|
+
readonly $ref: "#/$defs/ValueType";
|
|
250
|
+
};
|
|
251
|
+
readonly value: {};
|
|
252
|
+
readonly label: {
|
|
253
|
+
readonly type: "string";
|
|
254
|
+
readonly maxLength: 128;
|
|
255
|
+
};
|
|
256
|
+
readonly provenance: {
|
|
257
|
+
readonly $ref: "#/$defs/Provenance";
|
|
258
|
+
};
|
|
259
|
+
};
|
|
260
|
+
};
|
|
261
|
+
};
|
|
262
|
+
}];
|
|
263
|
+
};
|
|
264
|
+
readonly Provenance: {
|
|
265
|
+
readonly title: "Provenance";
|
|
266
|
+
readonly description: "Where a value comes from, and the member that makes this family worth building on a trust stack rather than in an address book. It survives to the verifier, so a recipient can tell — per field — what the holder typed from what an issuer attested.\n\n`selfAsserted` — the holder supplied it.\n\n`credentialBacked` — the value is derived from a credential in the vault at `claimPath`. The stored value is a CACHE FOR DISPLAY; the credential is the truth. A maintainer MUST re-derive it on read and MUST fail closed (never presenting a stale value) when the credential has been revoked, has expired, or has been archived or deleted.\n\n`generated` — the value is minted per verifier at disclosure time and recorded against that verifier, so every relying party receives a different one that routes back to the holder. This is the shape of the most widely adopted consumer privacy feature in this space; a maintainer need not operate a relay to conform, but the shape must exist, because retrofitting per-verifier values into a pool-of-values model is a migration rather than an addition.";
|
|
267
|
+
readonly type: "object";
|
|
268
|
+
readonly required: readonly ["kind"];
|
|
269
|
+
readonly oneOf: readonly [{
|
|
270
|
+
readonly additionalProperties: false;
|
|
271
|
+
readonly required: readonly ["kind"];
|
|
272
|
+
readonly properties: {
|
|
273
|
+
readonly kind: {
|
|
274
|
+
readonly const: "selfAsserted";
|
|
275
|
+
};
|
|
276
|
+
};
|
|
277
|
+
}, {
|
|
278
|
+
readonly additionalProperties: false;
|
|
279
|
+
readonly required: readonly ["kind", "credentialId", "claimPath"];
|
|
280
|
+
readonly properties: {
|
|
281
|
+
readonly kind: {
|
|
282
|
+
readonly const: "credentialBacked";
|
|
283
|
+
};
|
|
284
|
+
readonly credentialId: {
|
|
285
|
+
readonly type: "string";
|
|
286
|
+
readonly minLength: 1;
|
|
287
|
+
readonly description: "Vault identifier of the backing credential.";
|
|
288
|
+
};
|
|
289
|
+
readonly claimPath: {
|
|
290
|
+
readonly type: "string";
|
|
291
|
+
readonly pattern: "^(/[^/~]*(~[01][^/~]*)*)*$";
|
|
292
|
+
readonly description: "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`.";
|
|
293
|
+
};
|
|
294
|
+
readonly issuerDid: {
|
|
295
|
+
readonly type: "string";
|
|
296
|
+
readonly minLength: 1;
|
|
297
|
+
readonly description: "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member.";
|
|
298
|
+
};
|
|
299
|
+
readonly proof: {
|
|
300
|
+
readonly $ref: "#/$defs/ProofRung";
|
|
301
|
+
readonly description: "The disclosure rung this claim was, or will be, presented at.";
|
|
302
|
+
};
|
|
303
|
+
};
|
|
304
|
+
}, {
|
|
305
|
+
readonly additionalProperties: false;
|
|
306
|
+
readonly required: readonly ["kind", "generator"];
|
|
307
|
+
readonly properties: {
|
|
308
|
+
readonly kind: {
|
|
309
|
+
readonly const: "generated";
|
|
310
|
+
};
|
|
311
|
+
readonly generator: {
|
|
312
|
+
readonly type: "string";
|
|
313
|
+
readonly minLength: 1;
|
|
314
|
+
readonly maxLength: 64;
|
|
315
|
+
readonly description: "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined.";
|
|
316
|
+
};
|
|
317
|
+
readonly perVerifier: {
|
|
318
|
+
readonly type: "boolean";
|
|
319
|
+
readonly default: true;
|
|
320
|
+
readonly description: "When true (the default and the only useful setting), a distinct value is minted for each verifier.";
|
|
321
|
+
};
|
|
322
|
+
};
|
|
323
|
+
}];
|
|
324
|
+
};
|
|
325
|
+
readonly ProofRung: {
|
|
326
|
+
readonly title: "ProofRung";
|
|
327
|
+
readonly description: "How strongly a credential-backed claim is hidden when presented, ordered most private first. `predicate` proves a statement over a claim without disclosing the claim. `derived` discloses exactly the claims needed via an unlinkable derived proof, so two presentations cannot be joined. `selectiveDisclosure` discloses exactly the claims needed but carries the issuer's signature unchanged, so two presentations ARE linkable. `whole` discloses the entire credential.\n\nThe distinction between the first two and the last two is of kind, not degree: only `predicate` and `derived` avoid handing two verifiers a join key. A maintainer MUST default to the highest rung the credential's format supports, and MUST NOT silently fall to a lower one — a request that cannot be satisfied at the rung a producer asked for is refused, because a silent privacy downgrade discloses material the holder believed was hidden.";
|
|
328
|
+
readonly type: "string";
|
|
329
|
+
readonly enum: readonly ["predicate", "derived", "selectiveDisclosure", "whole"];
|
|
330
|
+
};
|
|
331
|
+
readonly ValueType: {
|
|
332
|
+
readonly title: "ValueType";
|
|
333
|
+
readonly description: "The JSON shape of `value`, declared so that a consumer can render and compare without guessing. The maintainer validates that `value` agrees with this member and does nothing further: it does NOT validate a phone number against a phone-number grammar. That is a producer's affordance, and a store that grows opinions about the contents of its records eventually blocks its consumer's release.";
|
|
334
|
+
readonly type: "string";
|
|
335
|
+
readonly enum: readonly ["string", "number", "boolean", "date", "object"];
|
|
336
|
+
};
|
|
337
|
+
readonly ClaimType: {
|
|
338
|
+
readonly title: "ClaimType";
|
|
339
|
+
readonly description: "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.";
|
|
340
|
+
readonly type: "string";
|
|
341
|
+
readonly minLength: 1;
|
|
342
|
+
readonly maxLength: 128;
|
|
343
|
+
readonly pattern: "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$";
|
|
344
|
+
};
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
348
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
349
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
350
|
+
readonly $ref: "#/$defs/Response";
|
|
351
|
+
readonly $defs: {
|
|
352
|
+
readonly Response: {
|
|
353
|
+
readonly $anchor: "response";
|
|
354
|
+
readonly title: "Persona Profile Put — response payload";
|
|
355
|
+
readonly description: "Success response to persona/profile/put. Type https://trusttasks.org/spec/persona/profile/put/1.0#response.";
|
|
356
|
+
readonly type: "object";
|
|
357
|
+
readonly additionalProperties: false;
|
|
358
|
+
readonly required: readonly ["profileId", "version", "created", "updatedAt"];
|
|
359
|
+
readonly properties: {
|
|
360
|
+
readonly profileId: {
|
|
361
|
+
readonly $ref: "#/$defs/Ulid";
|
|
362
|
+
};
|
|
363
|
+
readonly version: {
|
|
364
|
+
readonly $ref: "#/$defs/Version";
|
|
365
|
+
};
|
|
366
|
+
readonly created: {
|
|
367
|
+
readonly type: "boolean";
|
|
368
|
+
};
|
|
369
|
+
readonly correlation: {
|
|
370
|
+
readonly type: "object";
|
|
371
|
+
readonly additionalProperties: false;
|
|
372
|
+
readonly required: readonly ["severity"];
|
|
373
|
+
readonly description: "Advisory correlation result for the composition as a whole, returned on the write so a builder can warn while the holder is still composing. Advisory only: the write has applied, and a maintainer MUST NOT refuse a composition on correlation grounds.";
|
|
374
|
+
readonly properties: {
|
|
375
|
+
readonly severity: {
|
|
376
|
+
readonly type: "string";
|
|
377
|
+
readonly enum: readonly ["none", "low", "high"];
|
|
378
|
+
};
|
|
379
|
+
readonly sharedAttributeCount: {
|
|
380
|
+
readonly type: "integer";
|
|
381
|
+
readonly minimum: 0;
|
|
382
|
+
readonly description: "How many of this profile's entries present a value that another profile also presents. A count rather than a list; identifiers come from persona/correlation/analyze.";
|
|
383
|
+
};
|
|
384
|
+
};
|
|
385
|
+
};
|
|
386
|
+
readonly createdAt: {
|
|
387
|
+
readonly type: "string";
|
|
388
|
+
readonly format: "date-time";
|
|
389
|
+
};
|
|
390
|
+
readonly updatedAt: {
|
|
391
|
+
readonly type: "string";
|
|
392
|
+
readonly format: "date-time";
|
|
393
|
+
};
|
|
394
|
+
readonly ext: {
|
|
395
|
+
readonly $ref: "#/$defs/Ext";
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
};
|
|
399
|
+
readonly Ext: {
|
|
400
|
+
readonly title: "Ext";
|
|
401
|
+
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.";
|
|
402
|
+
readonly type: "object";
|
|
403
|
+
readonly minProperties: 1;
|
|
404
|
+
readonly additionalProperties: true;
|
|
405
|
+
readonly propertyNames: {
|
|
406
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
407
|
+
};
|
|
408
|
+
};
|
|
409
|
+
readonly Version: {
|
|
410
|
+
readonly title: "Version";
|
|
411
|
+
readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
|
|
412
|
+
readonly type: "integer";
|
|
413
|
+
readonly minimum: 1;
|
|
414
|
+
};
|
|
415
|
+
readonly Ulid: {
|
|
416
|
+
readonly title: "Ulid";
|
|
417
|
+
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.";
|
|
418
|
+
readonly type: "string";
|
|
419
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
420
|
+
};
|
|
421
|
+
readonly ExpectedVersion: {
|
|
422
|
+
readonly title: "ExpectedVersion";
|
|
423
|
+
readonly description: "Optimistic-concurrency precondition. A positive value requires the record's current `version` to equal it exactly; zero means create-only and applies only when no live record exists at the address.";
|
|
424
|
+
readonly type: "integer";
|
|
425
|
+
readonly minimum: 0;
|
|
426
|
+
};
|
|
427
|
+
readonly ProfileEntry: {
|
|
428
|
+
readonly title: "ProfileEntry";
|
|
429
|
+
readonly description: "One line of a profile, in exactly one of four forms. Together they are the whole of a profile's flexibility, and each exists for a case the others handle badly.\n\n`{ref}` — use the pool attribute, live. Editing the pool updates every profile that references it, which is the point.\n\n`{ref, pinVersion}` — use the value as it was at that version. For a profile that must keep presenting the value a counterparty already verified.\n\n`{ref, override}` — the same fact, a different value here. (\"In the gaming profile my display name is different.\")\n\n`{inline}` — a value that never enters the pool, and so never leaks into another profile.\n\nOmission is exclusion; there is no removal marker.";
|
|
430
|
+
readonly type: "object";
|
|
431
|
+
readonly oneOf: readonly [{
|
|
432
|
+
readonly additionalProperties: false;
|
|
433
|
+
readonly required: readonly ["ref"];
|
|
434
|
+
readonly properties: {
|
|
435
|
+
readonly ref: {
|
|
436
|
+
readonly $ref: "#/$defs/Ulid";
|
|
437
|
+
};
|
|
438
|
+
};
|
|
439
|
+
}, {
|
|
440
|
+
readonly additionalProperties: false;
|
|
441
|
+
readonly required: readonly ["ref", "pinVersion"];
|
|
442
|
+
readonly properties: {
|
|
443
|
+
readonly ref: {
|
|
444
|
+
readonly $ref: "#/$defs/Ulid";
|
|
445
|
+
};
|
|
446
|
+
readonly pinVersion: {
|
|
447
|
+
readonly $ref: "#/$defs/Version";
|
|
448
|
+
};
|
|
449
|
+
};
|
|
450
|
+
}, {
|
|
451
|
+
readonly additionalProperties: false;
|
|
452
|
+
readonly required: readonly ["ref", "override"];
|
|
453
|
+
readonly properties: {
|
|
454
|
+
readonly ref: {
|
|
455
|
+
readonly $ref: "#/$defs/Ulid";
|
|
456
|
+
};
|
|
457
|
+
readonly override: {
|
|
458
|
+
readonly type: "object";
|
|
459
|
+
readonly additionalProperties: false;
|
|
460
|
+
readonly required: readonly ["value"];
|
|
461
|
+
readonly properties: {
|
|
462
|
+
readonly value: {};
|
|
463
|
+
readonly label: {
|
|
464
|
+
readonly type: "string";
|
|
465
|
+
readonly maxLength: 128;
|
|
466
|
+
};
|
|
467
|
+
};
|
|
468
|
+
readonly description: "Replaces the pool attribute's value for this profile only. `type`, `valueType` and `provenance` are inherited from the referenced attribute and MUST NOT be overridden — an override that changed provenance would let a self-asserted value present as attested.";
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
}, {
|
|
472
|
+
readonly additionalProperties: false;
|
|
473
|
+
readonly required: readonly ["inline"];
|
|
474
|
+
readonly properties: {
|
|
475
|
+
readonly inline: {
|
|
476
|
+
readonly type: "object";
|
|
477
|
+
readonly additionalProperties: false;
|
|
478
|
+
readonly required: readonly ["type", "valueType", "value", "provenance"];
|
|
479
|
+
readonly properties: {
|
|
480
|
+
readonly type: {
|
|
481
|
+
readonly $ref: "#/$defs/ClaimType";
|
|
482
|
+
};
|
|
483
|
+
readonly valueType: {
|
|
484
|
+
readonly $ref: "#/$defs/ValueType";
|
|
485
|
+
};
|
|
486
|
+
readonly value: {};
|
|
487
|
+
readonly label: {
|
|
488
|
+
readonly type: "string";
|
|
489
|
+
readonly maxLength: 128;
|
|
490
|
+
};
|
|
491
|
+
readonly provenance: {
|
|
492
|
+
readonly $ref: "#/$defs/Provenance";
|
|
493
|
+
};
|
|
494
|
+
};
|
|
495
|
+
};
|
|
496
|
+
};
|
|
497
|
+
}];
|
|
498
|
+
};
|
|
499
|
+
readonly Provenance: {
|
|
500
|
+
readonly title: "Provenance";
|
|
501
|
+
readonly description: "Where a value comes from, and the member that makes this family worth building on a trust stack rather than in an address book. It survives to the verifier, so a recipient can tell — per field — what the holder typed from what an issuer attested.\n\n`selfAsserted` — the holder supplied it.\n\n`credentialBacked` — the value is derived from a credential in the vault at `claimPath`. The stored value is a CACHE FOR DISPLAY; the credential is the truth. A maintainer MUST re-derive it on read and MUST fail closed (never presenting a stale value) when the credential has been revoked, has expired, or has been archived or deleted.\n\n`generated` — the value is minted per verifier at disclosure time and recorded against that verifier, so every relying party receives a different one that routes back to the holder. This is the shape of the most widely adopted consumer privacy feature in this space; a maintainer need not operate a relay to conform, but the shape must exist, because retrofitting per-verifier values into a pool-of-values model is a migration rather than an addition.";
|
|
502
|
+
readonly type: "object";
|
|
503
|
+
readonly required: readonly ["kind"];
|
|
504
|
+
readonly oneOf: readonly [{
|
|
505
|
+
readonly additionalProperties: false;
|
|
506
|
+
readonly required: readonly ["kind"];
|
|
507
|
+
readonly properties: {
|
|
508
|
+
readonly kind: {
|
|
509
|
+
readonly const: "selfAsserted";
|
|
510
|
+
};
|
|
511
|
+
};
|
|
512
|
+
}, {
|
|
513
|
+
readonly additionalProperties: false;
|
|
514
|
+
readonly required: readonly ["kind", "credentialId", "claimPath"];
|
|
515
|
+
readonly properties: {
|
|
516
|
+
readonly kind: {
|
|
517
|
+
readonly const: "credentialBacked";
|
|
518
|
+
};
|
|
519
|
+
readonly credentialId: {
|
|
520
|
+
readonly type: "string";
|
|
521
|
+
readonly minLength: 1;
|
|
522
|
+
readonly description: "Vault identifier of the backing credential.";
|
|
523
|
+
};
|
|
524
|
+
readonly claimPath: {
|
|
525
|
+
readonly type: "string";
|
|
526
|
+
readonly pattern: "^(/[^/~]*(~[01][^/~]*)*)*$";
|
|
527
|
+
readonly description: "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`.";
|
|
528
|
+
};
|
|
529
|
+
readonly issuerDid: {
|
|
530
|
+
readonly type: "string";
|
|
531
|
+
readonly minLength: 1;
|
|
532
|
+
readonly description: "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member.";
|
|
533
|
+
};
|
|
534
|
+
readonly proof: {
|
|
535
|
+
readonly $ref: "#/$defs/ProofRung";
|
|
536
|
+
readonly description: "The disclosure rung this claim was, or will be, presented at.";
|
|
537
|
+
};
|
|
538
|
+
};
|
|
539
|
+
}, {
|
|
540
|
+
readonly additionalProperties: false;
|
|
541
|
+
readonly required: readonly ["kind", "generator"];
|
|
542
|
+
readonly properties: {
|
|
543
|
+
readonly kind: {
|
|
544
|
+
readonly const: "generated";
|
|
545
|
+
};
|
|
546
|
+
readonly generator: {
|
|
547
|
+
readonly type: "string";
|
|
548
|
+
readonly minLength: 1;
|
|
549
|
+
readonly maxLength: 64;
|
|
550
|
+
readonly description: "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined.";
|
|
551
|
+
};
|
|
552
|
+
readonly perVerifier: {
|
|
553
|
+
readonly type: "boolean";
|
|
554
|
+
readonly default: true;
|
|
555
|
+
readonly description: "When true (the default and the only useful setting), a distinct value is minted for each verifier.";
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
}];
|
|
559
|
+
};
|
|
560
|
+
readonly ProofRung: {
|
|
561
|
+
readonly title: "ProofRung";
|
|
562
|
+
readonly description: "How strongly a credential-backed claim is hidden when presented, ordered most private first. `predicate` proves a statement over a claim without disclosing the claim. `derived` discloses exactly the claims needed via an unlinkable derived proof, so two presentations cannot be joined. `selectiveDisclosure` discloses exactly the claims needed but carries the issuer's signature unchanged, so two presentations ARE linkable. `whole` discloses the entire credential.\n\nThe distinction between the first two and the last two is of kind, not degree: only `predicate` and `derived` avoid handing two verifiers a join key. A maintainer MUST default to the highest rung the credential's format supports, and MUST NOT silently fall to a lower one — a request that cannot be satisfied at the rung a producer asked for is refused, because a silent privacy downgrade discloses material the holder believed was hidden.";
|
|
563
|
+
readonly type: "string";
|
|
564
|
+
readonly enum: readonly ["predicate", "derived", "selectiveDisclosure", "whole"];
|
|
565
|
+
};
|
|
566
|
+
readonly ValueType: {
|
|
567
|
+
readonly title: "ValueType";
|
|
568
|
+
readonly description: "The JSON shape of `value`, declared so that a consumer can render and compare without guessing. The maintainer validates that `value` agrees with this member and does nothing further: it does NOT validate a phone number against a phone-number grammar. That is a producer's affordance, and a store that grows opinions about the contents of its records eventually blocks its consumer's release.";
|
|
569
|
+
readonly type: "string";
|
|
570
|
+
readonly enum: readonly ["string", "number", "boolean", "date", "object"];
|
|
571
|
+
};
|
|
572
|
+
readonly ClaimType: {
|
|
573
|
+
readonly title: "ClaimType";
|
|
574
|
+
readonly description: "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.";
|
|
575
|
+
readonly type: "string";
|
|
576
|
+
readonly minLength: 1;
|
|
577
|
+
readonly maxLength: 128;
|
|
578
|
+
readonly pattern: "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$";
|
|
579
|
+
};
|
|
580
|
+
};
|
|
581
|
+
};
|
|
582
|
+
/**
|
|
583
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
584
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
585
|
+
* per-specification and cannot be derived from the document alone, and
|
|
586
|
+
* item 2 needs the schema this carries.
|
|
587
|
+
*/
|
|
588
|
+
export declare const SPEC: {
|
|
589
|
+
readonly typeUri: "https://trusttasks.org/spec/persona/profile/put/1.0";
|
|
590
|
+
readonly isBearer: false;
|
|
591
|
+
readonly isProofRequired: true;
|
|
592
|
+
readonly isRecipientRequired: true;
|
|
593
|
+
readonly isIssuedAtRequired: true;
|
|
594
|
+
readonly payloadSchema: {
|
|
595
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
596
|
+
readonly $id: "https://trusttasks.org/spec/persona/profile/put/1.0";
|
|
597
|
+
readonly title: "Persona Profile Put — payload";
|
|
598
|
+
readonly description: "Create or replace one profile: a named, ordered projection over the holder's attribute pool. Entries reference pool attributes rather than copying them, so a fact edited once is edited everywhere it appears.";
|
|
599
|
+
readonly type: "object";
|
|
600
|
+
readonly additionalProperties: false;
|
|
601
|
+
readonly required: readonly ["name", "entries"];
|
|
602
|
+
readonly properties: {
|
|
603
|
+
readonly profileId: {
|
|
604
|
+
readonly $ref: "#/$defs/Ulid";
|
|
605
|
+
readonly description: "Omit to create; supply to replace. A producer that means to create and wants the write to be safe under retry SHOULD supply a generated id together with `expectedVersion: 0`.";
|
|
606
|
+
};
|
|
607
|
+
readonly name: {
|
|
608
|
+
readonly type: "string";
|
|
609
|
+
readonly minLength: 1;
|
|
610
|
+
readonly maxLength: 128;
|
|
611
|
+
readonly description: "The holder's name for the profile — \"Work\", \"Gaming\". Never disclosed to a verifier; it is how the holder finds it again.";
|
|
612
|
+
};
|
|
613
|
+
readonly entries: {
|
|
614
|
+
readonly type: "array";
|
|
615
|
+
readonly maxItems: 256;
|
|
616
|
+
readonly items: {
|
|
617
|
+
readonly $ref: "#/$defs/ProfileEntry";
|
|
618
|
+
};
|
|
619
|
+
readonly description: "Ordered; the order is display order. An empty array is legal and means a profile that discloses nothing — useful as a starting point, and not the same as no profile at all.";
|
|
620
|
+
};
|
|
621
|
+
readonly credentialRefs: {
|
|
622
|
+
readonly type: "array";
|
|
623
|
+
readonly maxItems: 256;
|
|
624
|
+
readonly items: {
|
|
625
|
+
readonly type: "string";
|
|
626
|
+
readonly minLength: 1;
|
|
627
|
+
};
|
|
628
|
+
readonly description: "Vault identifiers of credentials associated with this profile as inventory — what this persona can prove — as distinct from the evidence relationship a credentialBacked attribute expresses. The two answer different questions and a consumer MUST NOT read one as the other.";
|
|
629
|
+
};
|
|
630
|
+
readonly expectedVersion: {
|
|
631
|
+
readonly $ref: "#/$defs/ExpectedVersion";
|
|
632
|
+
};
|
|
633
|
+
readonly ext: {
|
|
634
|
+
readonly $ref: "#/$defs/Ext";
|
|
635
|
+
};
|
|
636
|
+
};
|
|
637
|
+
readonly $defs: {
|
|
638
|
+
readonly Response: {
|
|
639
|
+
readonly $anchor: "response";
|
|
640
|
+
readonly title: "Persona Profile Put — response payload";
|
|
641
|
+
readonly description: "Success response to persona/profile/put. Type https://trusttasks.org/spec/persona/profile/put/1.0#response.";
|
|
642
|
+
readonly type: "object";
|
|
643
|
+
readonly additionalProperties: false;
|
|
644
|
+
readonly required: readonly ["profileId", "version", "created", "updatedAt"];
|
|
645
|
+
readonly properties: {
|
|
646
|
+
readonly profileId: {
|
|
647
|
+
readonly $ref: "#/$defs/Ulid";
|
|
648
|
+
};
|
|
649
|
+
readonly version: {
|
|
650
|
+
readonly $ref: "#/$defs/Version";
|
|
651
|
+
};
|
|
652
|
+
readonly created: {
|
|
653
|
+
readonly type: "boolean";
|
|
654
|
+
};
|
|
655
|
+
readonly correlation: {
|
|
656
|
+
readonly type: "object";
|
|
657
|
+
readonly additionalProperties: false;
|
|
658
|
+
readonly required: readonly ["severity"];
|
|
659
|
+
readonly description: "Advisory correlation result for the composition as a whole, returned on the write so a builder can warn while the holder is still composing. Advisory only: the write has applied, and a maintainer MUST NOT refuse a composition on correlation grounds.";
|
|
660
|
+
readonly properties: {
|
|
661
|
+
readonly severity: {
|
|
662
|
+
readonly type: "string";
|
|
663
|
+
readonly enum: readonly ["none", "low", "high"];
|
|
664
|
+
};
|
|
665
|
+
readonly sharedAttributeCount: {
|
|
666
|
+
readonly type: "integer";
|
|
667
|
+
readonly minimum: 0;
|
|
668
|
+
readonly description: "How many of this profile's entries present a value that another profile also presents. A count rather than a list; identifiers come from persona/correlation/analyze.";
|
|
669
|
+
};
|
|
670
|
+
};
|
|
671
|
+
};
|
|
672
|
+
readonly createdAt: {
|
|
673
|
+
readonly type: "string";
|
|
674
|
+
readonly format: "date-time";
|
|
675
|
+
};
|
|
676
|
+
readonly updatedAt: {
|
|
677
|
+
readonly type: "string";
|
|
678
|
+
readonly format: "date-time";
|
|
679
|
+
};
|
|
680
|
+
readonly ext: {
|
|
681
|
+
readonly $ref: "#/$defs/Ext";
|
|
682
|
+
};
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
readonly Ext: {
|
|
686
|
+
readonly title: "Ext";
|
|
687
|
+
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.";
|
|
688
|
+
readonly type: "object";
|
|
689
|
+
readonly minProperties: 1;
|
|
690
|
+
readonly additionalProperties: true;
|
|
691
|
+
readonly propertyNames: {
|
|
692
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
693
|
+
};
|
|
694
|
+
};
|
|
695
|
+
readonly Version: {
|
|
696
|
+
readonly title: "Version";
|
|
697
|
+
readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
|
|
698
|
+
readonly type: "integer";
|
|
699
|
+
readonly minimum: 1;
|
|
700
|
+
};
|
|
701
|
+
readonly Ulid: {
|
|
702
|
+
readonly title: "Ulid";
|
|
703
|
+
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.";
|
|
704
|
+
readonly type: "string";
|
|
705
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
706
|
+
};
|
|
707
|
+
readonly ExpectedVersion: {
|
|
708
|
+
readonly title: "ExpectedVersion";
|
|
709
|
+
readonly description: "Optimistic-concurrency precondition. A positive value requires the record's current `version` to equal it exactly; zero means create-only and applies only when no live record exists at the address.";
|
|
710
|
+
readonly type: "integer";
|
|
711
|
+
readonly minimum: 0;
|
|
712
|
+
};
|
|
713
|
+
readonly ProfileEntry: {
|
|
714
|
+
readonly title: "ProfileEntry";
|
|
715
|
+
readonly description: "One line of a profile, in exactly one of four forms. Together they are the whole of a profile's flexibility, and each exists for a case the others handle badly.\n\n`{ref}` — use the pool attribute, live. Editing the pool updates every profile that references it, which is the point.\n\n`{ref, pinVersion}` — use the value as it was at that version. For a profile that must keep presenting the value a counterparty already verified.\n\n`{ref, override}` — the same fact, a different value here. (\"In the gaming profile my display name is different.\")\n\n`{inline}` — a value that never enters the pool, and so never leaks into another profile.\n\nOmission is exclusion; there is no removal marker.";
|
|
716
|
+
readonly type: "object";
|
|
717
|
+
readonly oneOf: readonly [{
|
|
718
|
+
readonly additionalProperties: false;
|
|
719
|
+
readonly required: readonly ["ref"];
|
|
720
|
+
readonly properties: {
|
|
721
|
+
readonly ref: {
|
|
722
|
+
readonly $ref: "#/$defs/Ulid";
|
|
723
|
+
};
|
|
724
|
+
};
|
|
725
|
+
}, {
|
|
726
|
+
readonly additionalProperties: false;
|
|
727
|
+
readonly required: readonly ["ref", "pinVersion"];
|
|
728
|
+
readonly properties: {
|
|
729
|
+
readonly ref: {
|
|
730
|
+
readonly $ref: "#/$defs/Ulid";
|
|
731
|
+
};
|
|
732
|
+
readonly pinVersion: {
|
|
733
|
+
readonly $ref: "#/$defs/Version";
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
}, {
|
|
737
|
+
readonly additionalProperties: false;
|
|
738
|
+
readonly required: readonly ["ref", "override"];
|
|
739
|
+
readonly properties: {
|
|
740
|
+
readonly ref: {
|
|
741
|
+
readonly $ref: "#/$defs/Ulid";
|
|
742
|
+
};
|
|
743
|
+
readonly override: {
|
|
744
|
+
readonly type: "object";
|
|
745
|
+
readonly additionalProperties: false;
|
|
746
|
+
readonly required: readonly ["value"];
|
|
747
|
+
readonly properties: {
|
|
748
|
+
readonly value: {};
|
|
749
|
+
readonly label: {
|
|
750
|
+
readonly type: "string";
|
|
751
|
+
readonly maxLength: 128;
|
|
752
|
+
};
|
|
753
|
+
};
|
|
754
|
+
readonly description: "Replaces the pool attribute's value for this profile only. `type`, `valueType` and `provenance` are inherited from the referenced attribute and MUST NOT be overridden — an override that changed provenance would let a self-asserted value present as attested.";
|
|
755
|
+
};
|
|
756
|
+
};
|
|
757
|
+
}, {
|
|
758
|
+
readonly additionalProperties: false;
|
|
759
|
+
readonly required: readonly ["inline"];
|
|
760
|
+
readonly properties: {
|
|
761
|
+
readonly inline: {
|
|
762
|
+
readonly type: "object";
|
|
763
|
+
readonly additionalProperties: false;
|
|
764
|
+
readonly required: readonly ["type", "valueType", "value", "provenance"];
|
|
765
|
+
readonly properties: {
|
|
766
|
+
readonly type: {
|
|
767
|
+
readonly $ref: "#/$defs/ClaimType";
|
|
768
|
+
};
|
|
769
|
+
readonly valueType: {
|
|
770
|
+
readonly $ref: "#/$defs/ValueType";
|
|
771
|
+
};
|
|
772
|
+
readonly value: {};
|
|
773
|
+
readonly label: {
|
|
774
|
+
readonly type: "string";
|
|
775
|
+
readonly maxLength: 128;
|
|
776
|
+
};
|
|
777
|
+
readonly provenance: {
|
|
778
|
+
readonly $ref: "#/$defs/Provenance";
|
|
779
|
+
};
|
|
780
|
+
};
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
}];
|
|
784
|
+
};
|
|
785
|
+
readonly Provenance: {
|
|
786
|
+
readonly title: "Provenance";
|
|
787
|
+
readonly description: "Where a value comes from, and the member that makes this family worth building on a trust stack rather than in an address book. It survives to the verifier, so a recipient can tell — per field — what the holder typed from what an issuer attested.\n\n`selfAsserted` — the holder supplied it.\n\n`credentialBacked` — the value is derived from a credential in the vault at `claimPath`. The stored value is a CACHE FOR DISPLAY; the credential is the truth. A maintainer MUST re-derive it on read and MUST fail closed (never presenting a stale value) when the credential has been revoked, has expired, or has been archived or deleted.\n\n`generated` — the value is minted per verifier at disclosure time and recorded against that verifier, so every relying party receives a different one that routes back to the holder. This is the shape of the most widely adopted consumer privacy feature in this space; a maintainer need not operate a relay to conform, but the shape must exist, because retrofitting per-verifier values into a pool-of-values model is a migration rather than an addition.";
|
|
788
|
+
readonly type: "object";
|
|
789
|
+
readonly required: readonly ["kind"];
|
|
790
|
+
readonly oneOf: readonly [{
|
|
791
|
+
readonly additionalProperties: false;
|
|
792
|
+
readonly required: readonly ["kind"];
|
|
793
|
+
readonly properties: {
|
|
794
|
+
readonly kind: {
|
|
795
|
+
readonly const: "selfAsserted";
|
|
796
|
+
};
|
|
797
|
+
};
|
|
798
|
+
}, {
|
|
799
|
+
readonly additionalProperties: false;
|
|
800
|
+
readonly required: readonly ["kind", "credentialId", "claimPath"];
|
|
801
|
+
readonly properties: {
|
|
802
|
+
readonly kind: {
|
|
803
|
+
readonly const: "credentialBacked";
|
|
804
|
+
};
|
|
805
|
+
readonly credentialId: {
|
|
806
|
+
readonly type: "string";
|
|
807
|
+
readonly minLength: 1;
|
|
808
|
+
readonly description: "Vault identifier of the backing credential.";
|
|
809
|
+
};
|
|
810
|
+
readonly claimPath: {
|
|
811
|
+
readonly type: "string";
|
|
812
|
+
readonly pattern: "^(/[^/~]*(~[01][^/~]*)*)*$";
|
|
813
|
+
readonly description: "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`.";
|
|
814
|
+
};
|
|
815
|
+
readonly issuerDid: {
|
|
816
|
+
readonly type: "string";
|
|
817
|
+
readonly minLength: 1;
|
|
818
|
+
readonly description: "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member.";
|
|
819
|
+
};
|
|
820
|
+
readonly proof: {
|
|
821
|
+
readonly $ref: "#/$defs/ProofRung";
|
|
822
|
+
readonly description: "The disclosure rung this claim was, or will be, presented at.";
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
}, {
|
|
826
|
+
readonly additionalProperties: false;
|
|
827
|
+
readonly required: readonly ["kind", "generator"];
|
|
828
|
+
readonly properties: {
|
|
829
|
+
readonly kind: {
|
|
830
|
+
readonly const: "generated";
|
|
831
|
+
};
|
|
832
|
+
readonly generator: {
|
|
833
|
+
readonly type: "string";
|
|
834
|
+
readonly minLength: 1;
|
|
835
|
+
readonly maxLength: 64;
|
|
836
|
+
readonly description: "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined.";
|
|
837
|
+
};
|
|
838
|
+
readonly perVerifier: {
|
|
839
|
+
readonly type: "boolean";
|
|
840
|
+
readonly default: true;
|
|
841
|
+
readonly description: "When true (the default and the only useful setting), a distinct value is minted for each verifier.";
|
|
842
|
+
};
|
|
843
|
+
};
|
|
844
|
+
}];
|
|
845
|
+
};
|
|
846
|
+
readonly ProofRung: {
|
|
847
|
+
readonly title: "ProofRung";
|
|
848
|
+
readonly description: "How strongly a credential-backed claim is hidden when presented, ordered most private first. `predicate` proves a statement over a claim without disclosing the claim. `derived` discloses exactly the claims needed via an unlinkable derived proof, so two presentations cannot be joined. `selectiveDisclosure` discloses exactly the claims needed but carries the issuer's signature unchanged, so two presentations ARE linkable. `whole` discloses the entire credential.\n\nThe distinction between the first two and the last two is of kind, not degree: only `predicate` and `derived` avoid handing two verifiers a join key. A maintainer MUST default to the highest rung the credential's format supports, and MUST NOT silently fall to a lower one — a request that cannot be satisfied at the rung a producer asked for is refused, because a silent privacy downgrade discloses material the holder believed was hidden.";
|
|
849
|
+
readonly type: "string";
|
|
850
|
+
readonly enum: readonly ["predicate", "derived", "selectiveDisclosure", "whole"];
|
|
851
|
+
};
|
|
852
|
+
readonly ValueType: {
|
|
853
|
+
readonly title: "ValueType";
|
|
854
|
+
readonly description: "The JSON shape of `value`, declared so that a consumer can render and compare without guessing. The maintainer validates that `value` agrees with this member and does nothing further: it does NOT validate a phone number against a phone-number grammar. That is a producer's affordance, and a store that grows opinions about the contents of its records eventually blocks its consumer's release.";
|
|
855
|
+
readonly type: "string";
|
|
856
|
+
readonly enum: readonly ["string", "number", "boolean", "date", "object"];
|
|
857
|
+
};
|
|
858
|
+
readonly ClaimType: {
|
|
859
|
+
readonly title: "ClaimType";
|
|
860
|
+
readonly description: "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.";
|
|
861
|
+
readonly type: "string";
|
|
862
|
+
readonly minLength: 1;
|
|
863
|
+
readonly maxLength: 128;
|
|
864
|
+
readonly pattern: "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$";
|
|
865
|
+
};
|
|
866
|
+
};
|
|
867
|
+
};
|
|
868
|
+
};
|
|
869
|
+
/**
|
|
870
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
871
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
872
|
+
* parties (§7.3 item 5).
|
|
873
|
+
*/
|
|
874
|
+
export declare const RESPONSE_SPEC: {
|
|
875
|
+
readonly typeUri: "https://trusttasks.org/spec/persona/profile/put/1.0#response";
|
|
876
|
+
readonly isBearer: false;
|
|
877
|
+
readonly isProofRequired: true;
|
|
878
|
+
readonly isRecipientRequired: true;
|
|
879
|
+
readonly isIssuedAtRequired: true;
|
|
880
|
+
readonly payloadSchema: {
|
|
881
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
882
|
+
readonly $ref: "#/$defs/Response";
|
|
883
|
+
readonly $defs: {
|
|
884
|
+
readonly Response: {
|
|
885
|
+
readonly $anchor: "response";
|
|
886
|
+
readonly title: "Persona Profile Put — response payload";
|
|
887
|
+
readonly description: "Success response to persona/profile/put. Type https://trusttasks.org/spec/persona/profile/put/1.0#response.";
|
|
888
|
+
readonly type: "object";
|
|
889
|
+
readonly additionalProperties: false;
|
|
890
|
+
readonly required: readonly ["profileId", "version", "created", "updatedAt"];
|
|
891
|
+
readonly properties: {
|
|
892
|
+
readonly profileId: {
|
|
893
|
+
readonly $ref: "#/$defs/Ulid";
|
|
894
|
+
};
|
|
895
|
+
readonly version: {
|
|
896
|
+
readonly $ref: "#/$defs/Version";
|
|
897
|
+
};
|
|
898
|
+
readonly created: {
|
|
899
|
+
readonly type: "boolean";
|
|
900
|
+
};
|
|
901
|
+
readonly correlation: {
|
|
902
|
+
readonly type: "object";
|
|
903
|
+
readonly additionalProperties: false;
|
|
904
|
+
readonly required: readonly ["severity"];
|
|
905
|
+
readonly description: "Advisory correlation result for the composition as a whole, returned on the write so a builder can warn while the holder is still composing. Advisory only: the write has applied, and a maintainer MUST NOT refuse a composition on correlation grounds.";
|
|
906
|
+
readonly properties: {
|
|
907
|
+
readonly severity: {
|
|
908
|
+
readonly type: "string";
|
|
909
|
+
readonly enum: readonly ["none", "low", "high"];
|
|
910
|
+
};
|
|
911
|
+
readonly sharedAttributeCount: {
|
|
912
|
+
readonly type: "integer";
|
|
913
|
+
readonly minimum: 0;
|
|
914
|
+
readonly description: "How many of this profile's entries present a value that another profile also presents. A count rather than a list; identifiers come from persona/correlation/analyze.";
|
|
915
|
+
};
|
|
916
|
+
};
|
|
917
|
+
};
|
|
918
|
+
readonly createdAt: {
|
|
919
|
+
readonly type: "string";
|
|
920
|
+
readonly format: "date-time";
|
|
921
|
+
};
|
|
922
|
+
readonly updatedAt: {
|
|
923
|
+
readonly type: "string";
|
|
924
|
+
readonly format: "date-time";
|
|
925
|
+
};
|
|
926
|
+
readonly ext: {
|
|
927
|
+
readonly $ref: "#/$defs/Ext";
|
|
928
|
+
};
|
|
929
|
+
};
|
|
930
|
+
};
|
|
931
|
+
readonly Ext: {
|
|
932
|
+
readonly title: "Ext";
|
|
933
|
+
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.";
|
|
934
|
+
readonly type: "object";
|
|
935
|
+
readonly minProperties: 1;
|
|
936
|
+
readonly additionalProperties: true;
|
|
937
|
+
readonly propertyNames: {
|
|
938
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
939
|
+
};
|
|
940
|
+
};
|
|
941
|
+
readonly Version: {
|
|
942
|
+
readonly title: "Version";
|
|
943
|
+
readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
|
|
944
|
+
readonly type: "integer";
|
|
945
|
+
readonly minimum: 1;
|
|
946
|
+
};
|
|
947
|
+
readonly Ulid: {
|
|
948
|
+
readonly title: "Ulid";
|
|
949
|
+
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.";
|
|
950
|
+
readonly type: "string";
|
|
951
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
952
|
+
};
|
|
953
|
+
readonly ExpectedVersion: {
|
|
954
|
+
readonly title: "ExpectedVersion";
|
|
955
|
+
readonly description: "Optimistic-concurrency precondition. A positive value requires the record's current `version` to equal it exactly; zero means create-only and applies only when no live record exists at the address.";
|
|
956
|
+
readonly type: "integer";
|
|
957
|
+
readonly minimum: 0;
|
|
958
|
+
};
|
|
959
|
+
readonly ProfileEntry: {
|
|
960
|
+
readonly title: "ProfileEntry";
|
|
961
|
+
readonly description: "One line of a profile, in exactly one of four forms. Together they are the whole of a profile's flexibility, and each exists for a case the others handle badly.\n\n`{ref}` — use the pool attribute, live. Editing the pool updates every profile that references it, which is the point.\n\n`{ref, pinVersion}` — use the value as it was at that version. For a profile that must keep presenting the value a counterparty already verified.\n\n`{ref, override}` — the same fact, a different value here. (\"In the gaming profile my display name is different.\")\n\n`{inline}` — a value that never enters the pool, and so never leaks into another profile.\n\nOmission is exclusion; there is no removal marker.";
|
|
962
|
+
readonly type: "object";
|
|
963
|
+
readonly oneOf: readonly [{
|
|
964
|
+
readonly additionalProperties: false;
|
|
965
|
+
readonly required: readonly ["ref"];
|
|
966
|
+
readonly properties: {
|
|
967
|
+
readonly ref: {
|
|
968
|
+
readonly $ref: "#/$defs/Ulid";
|
|
969
|
+
};
|
|
970
|
+
};
|
|
971
|
+
}, {
|
|
972
|
+
readonly additionalProperties: false;
|
|
973
|
+
readonly required: readonly ["ref", "pinVersion"];
|
|
974
|
+
readonly properties: {
|
|
975
|
+
readonly ref: {
|
|
976
|
+
readonly $ref: "#/$defs/Ulid";
|
|
977
|
+
};
|
|
978
|
+
readonly pinVersion: {
|
|
979
|
+
readonly $ref: "#/$defs/Version";
|
|
980
|
+
};
|
|
981
|
+
};
|
|
982
|
+
}, {
|
|
983
|
+
readonly additionalProperties: false;
|
|
984
|
+
readonly required: readonly ["ref", "override"];
|
|
985
|
+
readonly properties: {
|
|
986
|
+
readonly ref: {
|
|
987
|
+
readonly $ref: "#/$defs/Ulid";
|
|
988
|
+
};
|
|
989
|
+
readonly override: {
|
|
990
|
+
readonly type: "object";
|
|
991
|
+
readonly additionalProperties: false;
|
|
992
|
+
readonly required: readonly ["value"];
|
|
993
|
+
readonly properties: {
|
|
994
|
+
readonly value: {};
|
|
995
|
+
readonly label: {
|
|
996
|
+
readonly type: "string";
|
|
997
|
+
readonly maxLength: 128;
|
|
998
|
+
};
|
|
999
|
+
};
|
|
1000
|
+
readonly description: "Replaces the pool attribute's value for this profile only. `type`, `valueType` and `provenance` are inherited from the referenced attribute and MUST NOT be overridden — an override that changed provenance would let a self-asserted value present as attested.";
|
|
1001
|
+
};
|
|
1002
|
+
};
|
|
1003
|
+
}, {
|
|
1004
|
+
readonly additionalProperties: false;
|
|
1005
|
+
readonly required: readonly ["inline"];
|
|
1006
|
+
readonly properties: {
|
|
1007
|
+
readonly inline: {
|
|
1008
|
+
readonly type: "object";
|
|
1009
|
+
readonly additionalProperties: false;
|
|
1010
|
+
readonly required: readonly ["type", "valueType", "value", "provenance"];
|
|
1011
|
+
readonly properties: {
|
|
1012
|
+
readonly type: {
|
|
1013
|
+
readonly $ref: "#/$defs/ClaimType";
|
|
1014
|
+
};
|
|
1015
|
+
readonly valueType: {
|
|
1016
|
+
readonly $ref: "#/$defs/ValueType";
|
|
1017
|
+
};
|
|
1018
|
+
readonly value: {};
|
|
1019
|
+
readonly label: {
|
|
1020
|
+
readonly type: "string";
|
|
1021
|
+
readonly maxLength: 128;
|
|
1022
|
+
};
|
|
1023
|
+
readonly provenance: {
|
|
1024
|
+
readonly $ref: "#/$defs/Provenance";
|
|
1025
|
+
};
|
|
1026
|
+
};
|
|
1027
|
+
};
|
|
1028
|
+
};
|
|
1029
|
+
}];
|
|
1030
|
+
};
|
|
1031
|
+
readonly Provenance: {
|
|
1032
|
+
readonly title: "Provenance";
|
|
1033
|
+
readonly description: "Where a value comes from, and the member that makes this family worth building on a trust stack rather than in an address book. It survives to the verifier, so a recipient can tell — per field — what the holder typed from what an issuer attested.\n\n`selfAsserted` — the holder supplied it.\n\n`credentialBacked` — the value is derived from a credential in the vault at `claimPath`. The stored value is a CACHE FOR DISPLAY; the credential is the truth. A maintainer MUST re-derive it on read and MUST fail closed (never presenting a stale value) when the credential has been revoked, has expired, or has been archived or deleted.\n\n`generated` — the value is minted per verifier at disclosure time and recorded against that verifier, so every relying party receives a different one that routes back to the holder. This is the shape of the most widely adopted consumer privacy feature in this space; a maintainer need not operate a relay to conform, but the shape must exist, because retrofitting per-verifier values into a pool-of-values model is a migration rather than an addition.";
|
|
1034
|
+
readonly type: "object";
|
|
1035
|
+
readonly required: readonly ["kind"];
|
|
1036
|
+
readonly oneOf: readonly [{
|
|
1037
|
+
readonly additionalProperties: false;
|
|
1038
|
+
readonly required: readonly ["kind"];
|
|
1039
|
+
readonly properties: {
|
|
1040
|
+
readonly kind: {
|
|
1041
|
+
readonly const: "selfAsserted";
|
|
1042
|
+
};
|
|
1043
|
+
};
|
|
1044
|
+
}, {
|
|
1045
|
+
readonly additionalProperties: false;
|
|
1046
|
+
readonly required: readonly ["kind", "credentialId", "claimPath"];
|
|
1047
|
+
readonly properties: {
|
|
1048
|
+
readonly kind: {
|
|
1049
|
+
readonly const: "credentialBacked";
|
|
1050
|
+
};
|
|
1051
|
+
readonly credentialId: {
|
|
1052
|
+
readonly type: "string";
|
|
1053
|
+
readonly minLength: 1;
|
|
1054
|
+
readonly description: "Vault identifier of the backing credential.";
|
|
1055
|
+
};
|
|
1056
|
+
readonly claimPath: {
|
|
1057
|
+
readonly type: "string";
|
|
1058
|
+
readonly pattern: "^(/[^/~]*(~[01][^/~]*)*)*$";
|
|
1059
|
+
readonly description: "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`.";
|
|
1060
|
+
};
|
|
1061
|
+
readonly issuerDid: {
|
|
1062
|
+
readonly type: "string";
|
|
1063
|
+
readonly minLength: 1;
|
|
1064
|
+
readonly description: "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member.";
|
|
1065
|
+
};
|
|
1066
|
+
readonly proof: {
|
|
1067
|
+
readonly $ref: "#/$defs/ProofRung";
|
|
1068
|
+
readonly description: "The disclosure rung this claim was, or will be, presented at.";
|
|
1069
|
+
};
|
|
1070
|
+
};
|
|
1071
|
+
}, {
|
|
1072
|
+
readonly additionalProperties: false;
|
|
1073
|
+
readonly required: readonly ["kind", "generator"];
|
|
1074
|
+
readonly properties: {
|
|
1075
|
+
readonly kind: {
|
|
1076
|
+
readonly const: "generated";
|
|
1077
|
+
};
|
|
1078
|
+
readonly generator: {
|
|
1079
|
+
readonly type: "string";
|
|
1080
|
+
readonly minLength: 1;
|
|
1081
|
+
readonly maxLength: 64;
|
|
1082
|
+
readonly description: "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined.";
|
|
1083
|
+
};
|
|
1084
|
+
readonly perVerifier: {
|
|
1085
|
+
readonly type: "boolean";
|
|
1086
|
+
readonly default: true;
|
|
1087
|
+
readonly description: "When true (the default and the only useful setting), a distinct value is minted for each verifier.";
|
|
1088
|
+
};
|
|
1089
|
+
};
|
|
1090
|
+
}];
|
|
1091
|
+
};
|
|
1092
|
+
readonly ProofRung: {
|
|
1093
|
+
readonly title: "ProofRung";
|
|
1094
|
+
readonly description: "How strongly a credential-backed claim is hidden when presented, ordered most private first. `predicate` proves a statement over a claim without disclosing the claim. `derived` discloses exactly the claims needed via an unlinkable derived proof, so two presentations cannot be joined. `selectiveDisclosure` discloses exactly the claims needed but carries the issuer's signature unchanged, so two presentations ARE linkable. `whole` discloses the entire credential.\n\nThe distinction between the first two and the last two is of kind, not degree: only `predicate` and `derived` avoid handing two verifiers a join key. A maintainer MUST default to the highest rung the credential's format supports, and MUST NOT silently fall to a lower one — a request that cannot be satisfied at the rung a producer asked for is refused, because a silent privacy downgrade discloses material the holder believed was hidden.";
|
|
1095
|
+
readonly type: "string";
|
|
1096
|
+
readonly enum: readonly ["predicate", "derived", "selectiveDisclosure", "whole"];
|
|
1097
|
+
};
|
|
1098
|
+
readonly ValueType: {
|
|
1099
|
+
readonly title: "ValueType";
|
|
1100
|
+
readonly description: "The JSON shape of `value`, declared so that a consumer can render and compare without guessing. The maintainer validates that `value` agrees with this member and does nothing further: it does NOT validate a phone number against a phone-number grammar. That is a producer's affordance, and a store that grows opinions about the contents of its records eventually blocks its consumer's release.";
|
|
1101
|
+
readonly type: "string";
|
|
1102
|
+
readonly enum: readonly ["string", "number", "boolean", "date", "object"];
|
|
1103
|
+
};
|
|
1104
|
+
readonly ClaimType: {
|
|
1105
|
+
readonly title: "ClaimType";
|
|
1106
|
+
readonly description: "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.";
|
|
1107
|
+
readonly type: "string";
|
|
1108
|
+
readonly minLength: 1;
|
|
1109
|
+
readonly maxLength: 128;
|
|
1110
|
+
readonly pattern: "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$";
|
|
1111
|
+
};
|
|
1112
|
+
};
|
|
1113
|
+
};
|
|
1114
|
+
};
|
|
1115
|
+
//# sourceMappingURL=payload.d.ts.map
|