@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,895 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/persona/attribute/list/1.0/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Attribute, ClaimType, Ext, ProofRung, Provenance, Ulid, ValueType, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* Enumerate the holder's attribute pool, optionally narrowed to a vocabulary prefix. Cursor-paginated. Values are omitted unless asked for, so a picker can render the pool without decrypting every fact in it.
|
|
8
|
+
*/
|
|
9
|
+
export interface PersonaAttributeListPayload {
|
|
10
|
+
/**
|
|
11
|
+
* Narrows the result to attributes whose `type` begins with this string, compared over the UTF-8 encoding. Because the vocabulary is dotted most-general-segment-first, `phone` selects every phone number and `name` every name — which is the access pattern a builder actually has. The maintainer MUST NOT interpret the value further; a prefix that ends mid-segment is a byte comparison like any other.
|
|
12
|
+
*/
|
|
13
|
+
typePrefix?: string;
|
|
14
|
+
/**
|
|
15
|
+
* When false (the default), each returned attribute carries its metadata and no `value`. A pool listing is the common case and it does not need plaintext: a picker renders `type` and `label`. Defaulting to false means the expensive, sensitive path is the one a producer has to ask for.
|
|
16
|
+
*/
|
|
17
|
+
includeValues?: boolean;
|
|
18
|
+
/**
|
|
19
|
+
* When true (the default), credential-backed attributes whose backing could not be re-derived are returned carrying `stale` and `staleReason`. Set false to omit them. The default is true because a holder needs to SEE that a credential-backed fact has gone stale — silently dropping it would present a pool that looks smaller than it is, and the holder would not know a claim had stopped being presentable.
|
|
20
|
+
*/
|
|
21
|
+
includeStale?: boolean;
|
|
22
|
+
/**
|
|
23
|
+
* Opaque continuation token from a prior response's `nextCursor`. A producer MUST NOT construct or parse one.
|
|
24
|
+
*/
|
|
25
|
+
cursor?: string;
|
|
26
|
+
/**
|
|
27
|
+
* Maximum attributes to return. The maintainer MAY return fewer for reasons of its own and a producer MUST NOT infer exhaustion from a short page — only an absent `nextCursor` means the end.
|
|
28
|
+
*/
|
|
29
|
+
limit?: number;
|
|
30
|
+
ext?: Ext;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Success response to persona/attribute/list. Type https://trusttasks.org/spec/persona/attribute/list/1.0#response.
|
|
34
|
+
*/
|
|
35
|
+
export interface PersonaAttributeListResponsePayload {
|
|
36
|
+
/**
|
|
37
|
+
* @maxItems 500
|
|
38
|
+
*/
|
|
39
|
+
attributes: Attribute[];
|
|
40
|
+
/**
|
|
41
|
+
* Present when more attributes remain. Absent means the enumeration is complete — that absence is the only exhaustion signal.
|
|
42
|
+
*/
|
|
43
|
+
nextCursor?: string;
|
|
44
|
+
ext?: Ext;
|
|
45
|
+
}
|
|
46
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
47
|
+
export type { Attribute, ClaimType, Ext, ProofRung, Provenance, Ulid, ValueType, Version };
|
|
48
|
+
/** Trust Task type URI. */
|
|
49
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/persona/attribute/list/1.0";
|
|
50
|
+
/** Stable alias for this specification's request payload shape. */
|
|
51
|
+
export type Payload = PersonaAttributeListPayload;
|
|
52
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
53
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/persona/attribute/list/1.0#response";
|
|
54
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
55
|
+
export type Response = PersonaAttributeListResponsePayload;
|
|
56
|
+
/**
|
|
57
|
+
* This specification's payload schema, as a value.
|
|
58
|
+
*
|
|
59
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
60
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
61
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
62
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
63
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
64
|
+
*/
|
|
65
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
66
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
67
|
+
readonly $id: "https://trusttasks.org/spec/persona/attribute/list/1.0";
|
|
68
|
+
readonly title: "Persona Attribute List — payload";
|
|
69
|
+
readonly description: "Enumerate the holder's attribute pool, optionally narrowed to a vocabulary prefix. Cursor-paginated. Values are omitted unless asked for, so a picker can render the pool without decrypting every fact in it.";
|
|
70
|
+
readonly type: "object";
|
|
71
|
+
readonly additionalProperties: false;
|
|
72
|
+
readonly properties: {
|
|
73
|
+
readonly typePrefix: {
|
|
74
|
+
readonly type: "string";
|
|
75
|
+
readonly maxLength: 128;
|
|
76
|
+
readonly description: "Narrows the result to attributes whose `type` begins with this string, compared over the UTF-8 encoding. Because the vocabulary is dotted most-general-segment-first, `phone` selects every phone number and `name` every name — which is the access pattern a builder actually has. The maintainer MUST NOT interpret the value further; a prefix that ends mid-segment is a byte comparison like any other.";
|
|
77
|
+
};
|
|
78
|
+
readonly includeValues: {
|
|
79
|
+
readonly type: "boolean";
|
|
80
|
+
readonly default: false;
|
|
81
|
+
readonly description: "When false (the default), each returned attribute carries its metadata and no `value`. A pool listing is the common case and it does not need plaintext: a picker renders `type` and `label`. Defaulting to false means the expensive, sensitive path is the one a producer has to ask for.";
|
|
82
|
+
};
|
|
83
|
+
readonly includeStale: {
|
|
84
|
+
readonly type: "boolean";
|
|
85
|
+
readonly default: true;
|
|
86
|
+
readonly description: "When true (the default), credential-backed attributes whose backing could not be re-derived are returned carrying `stale` and `staleReason`. Set false to omit them. The default is true because a holder needs to SEE that a credential-backed fact has gone stale — silently dropping it would present a pool that looks smaller than it is, and the holder would not know a claim had stopped being presentable.";
|
|
87
|
+
};
|
|
88
|
+
readonly cursor: {
|
|
89
|
+
readonly type: "string";
|
|
90
|
+
readonly maxLength: 4096;
|
|
91
|
+
readonly description: "Opaque continuation token from a prior response's `nextCursor`. A producer MUST NOT construct or parse one.";
|
|
92
|
+
};
|
|
93
|
+
readonly limit: {
|
|
94
|
+
readonly type: "integer";
|
|
95
|
+
readonly minimum: 1;
|
|
96
|
+
readonly maximum: 500;
|
|
97
|
+
readonly default: 100;
|
|
98
|
+
readonly description: "Maximum attributes to return. The maintainer MAY return fewer for reasons of its own and a producer MUST NOT infer exhaustion from a short page — only an absent `nextCursor` means the end.";
|
|
99
|
+
};
|
|
100
|
+
readonly ext: {
|
|
101
|
+
readonly $ref: "#/$defs/Ext";
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
readonly $defs: {
|
|
105
|
+
readonly Response: {
|
|
106
|
+
readonly $anchor: "response";
|
|
107
|
+
readonly title: "Persona Attribute List — response payload";
|
|
108
|
+
readonly description: "Success response to persona/attribute/list. Type https://trusttasks.org/spec/persona/attribute/list/1.0#response.";
|
|
109
|
+
readonly type: "object";
|
|
110
|
+
readonly additionalProperties: false;
|
|
111
|
+
readonly required: readonly ["attributes"];
|
|
112
|
+
readonly properties: {
|
|
113
|
+
readonly attributes: {
|
|
114
|
+
readonly type: "array";
|
|
115
|
+
readonly maxItems: 500;
|
|
116
|
+
readonly items: {
|
|
117
|
+
readonly $ref: "#/$defs/Attribute";
|
|
118
|
+
};
|
|
119
|
+
};
|
|
120
|
+
readonly nextCursor: {
|
|
121
|
+
readonly type: "string";
|
|
122
|
+
readonly maxLength: 4096;
|
|
123
|
+
readonly description: "Present when more attributes remain. Absent means the enumeration is complete — that absence is the only exhaustion signal.";
|
|
124
|
+
};
|
|
125
|
+
readonly ext: {
|
|
126
|
+
readonly $ref: "#/$defs/Ext";
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
readonly Ext: {
|
|
131
|
+
readonly title: "Ext";
|
|
132
|
+
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.";
|
|
133
|
+
readonly type: "object";
|
|
134
|
+
readonly minProperties: 1;
|
|
135
|
+
readonly additionalProperties: true;
|
|
136
|
+
readonly propertyNames: {
|
|
137
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
138
|
+
};
|
|
139
|
+
};
|
|
140
|
+
readonly Attribute: {
|
|
141
|
+
readonly title: "Attribute";
|
|
142
|
+
readonly description: "One atomic fact a holder keeps about themselves. Several attributes MAY share a `type` — three phone numbers, a legal name and a preferred name — which is why `attributeId` is the identity of a fact and `type` is not. The pool is flat and unordered; ordering is a profile's concern.";
|
|
143
|
+
readonly type: "object";
|
|
144
|
+
readonly additionalProperties: false;
|
|
145
|
+
readonly required: readonly ["attributeId", "type", "valueType", "value", "provenance", "version", "updatedAt"];
|
|
146
|
+
readonly properties: {
|
|
147
|
+
readonly attributeId: {
|
|
148
|
+
readonly $ref: "#/$defs/Ulid";
|
|
149
|
+
};
|
|
150
|
+
readonly type: {
|
|
151
|
+
readonly $ref: "#/$defs/ClaimType";
|
|
152
|
+
};
|
|
153
|
+
readonly valueType: {
|
|
154
|
+
readonly $ref: "#/$defs/ValueType";
|
|
155
|
+
};
|
|
156
|
+
readonly value: {
|
|
157
|
+
readonly description: "The fact itself, agreeing with `valueType`. Encrypted at rest by the maintainer. Absent when the caller asked for a metadata-only view, and absent when a credential-backed value could not be re-derived — a consumer MUST NOT conflate the two and MUST read `stale` to tell them apart.";
|
|
158
|
+
};
|
|
159
|
+
readonly label: {
|
|
160
|
+
readonly type: "string";
|
|
161
|
+
readonly maxLength: 128;
|
|
162
|
+
readonly description: "The holder's own words for this attribute, shown in a picker. Never disclosed to a verifier; it is a note to self.";
|
|
163
|
+
};
|
|
164
|
+
readonly provenance: {
|
|
165
|
+
readonly $ref: "#/$defs/Provenance";
|
|
166
|
+
};
|
|
167
|
+
readonly stale: {
|
|
168
|
+
readonly type: "boolean";
|
|
169
|
+
readonly description: "Present and true when a `credentialBacked` value could not be re-derived. `staleReason` says why. A maintainer MUST refuse to disclose a stale attribute.";
|
|
170
|
+
};
|
|
171
|
+
readonly staleReason: {
|
|
172
|
+
readonly type: "string";
|
|
173
|
+
readonly enum: readonly ["revoked", "expired", "archived", "deleted", "notFound"];
|
|
174
|
+
readonly description: "Why re-derivation failed. Present only alongside `stale`.";
|
|
175
|
+
};
|
|
176
|
+
readonly version: {
|
|
177
|
+
readonly $ref: "#/$defs/Version";
|
|
178
|
+
};
|
|
179
|
+
readonly createdAt: {
|
|
180
|
+
readonly type: "string";
|
|
181
|
+
readonly format: "date-time";
|
|
182
|
+
};
|
|
183
|
+
readonly updatedAt: {
|
|
184
|
+
readonly type: "string";
|
|
185
|
+
readonly format: "date-time";
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
};
|
|
189
|
+
readonly Version: {
|
|
190
|
+
readonly title: "Version";
|
|
191
|
+
readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
|
|
192
|
+
readonly type: "integer";
|
|
193
|
+
readonly minimum: 1;
|
|
194
|
+
};
|
|
195
|
+
readonly Provenance: {
|
|
196
|
+
readonly title: "Provenance";
|
|
197
|
+
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.";
|
|
198
|
+
readonly type: "object";
|
|
199
|
+
readonly required: readonly ["kind"];
|
|
200
|
+
readonly oneOf: readonly [{
|
|
201
|
+
readonly additionalProperties: false;
|
|
202
|
+
readonly required: readonly ["kind"];
|
|
203
|
+
readonly properties: {
|
|
204
|
+
readonly kind: {
|
|
205
|
+
readonly const: "selfAsserted";
|
|
206
|
+
};
|
|
207
|
+
};
|
|
208
|
+
}, {
|
|
209
|
+
readonly additionalProperties: false;
|
|
210
|
+
readonly required: readonly ["kind", "credentialId", "claimPath"];
|
|
211
|
+
readonly properties: {
|
|
212
|
+
readonly kind: {
|
|
213
|
+
readonly const: "credentialBacked";
|
|
214
|
+
};
|
|
215
|
+
readonly credentialId: {
|
|
216
|
+
readonly type: "string";
|
|
217
|
+
readonly minLength: 1;
|
|
218
|
+
readonly description: "Vault identifier of the backing credential.";
|
|
219
|
+
};
|
|
220
|
+
readonly claimPath: {
|
|
221
|
+
readonly type: "string";
|
|
222
|
+
readonly pattern: "^(/[^/~]*(~[01][^/~]*)*)*$";
|
|
223
|
+
readonly description: "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`.";
|
|
224
|
+
};
|
|
225
|
+
readonly issuerDid: {
|
|
226
|
+
readonly type: "string";
|
|
227
|
+
readonly minLength: 1;
|
|
228
|
+
readonly description: "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member.";
|
|
229
|
+
};
|
|
230
|
+
readonly proof: {
|
|
231
|
+
readonly $ref: "#/$defs/ProofRung";
|
|
232
|
+
readonly description: "The disclosure rung this claim was, or will be, presented at.";
|
|
233
|
+
};
|
|
234
|
+
};
|
|
235
|
+
}, {
|
|
236
|
+
readonly additionalProperties: false;
|
|
237
|
+
readonly required: readonly ["kind", "generator"];
|
|
238
|
+
readonly properties: {
|
|
239
|
+
readonly kind: {
|
|
240
|
+
readonly const: "generated";
|
|
241
|
+
};
|
|
242
|
+
readonly generator: {
|
|
243
|
+
readonly type: "string";
|
|
244
|
+
readonly minLength: 1;
|
|
245
|
+
readonly maxLength: 64;
|
|
246
|
+
readonly description: "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined.";
|
|
247
|
+
};
|
|
248
|
+
readonly perVerifier: {
|
|
249
|
+
readonly type: "boolean";
|
|
250
|
+
readonly default: true;
|
|
251
|
+
readonly description: "When true (the default and the only useful setting), a distinct value is minted for each verifier.";
|
|
252
|
+
};
|
|
253
|
+
};
|
|
254
|
+
}];
|
|
255
|
+
};
|
|
256
|
+
readonly ProofRung: {
|
|
257
|
+
readonly title: "ProofRung";
|
|
258
|
+
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.";
|
|
259
|
+
readonly type: "string";
|
|
260
|
+
readonly enum: readonly ["predicate", "derived", "selectiveDisclosure", "whole"];
|
|
261
|
+
};
|
|
262
|
+
readonly ValueType: {
|
|
263
|
+
readonly title: "ValueType";
|
|
264
|
+
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.";
|
|
265
|
+
readonly type: "string";
|
|
266
|
+
readonly enum: readonly ["string", "number", "boolean", "date", "object"];
|
|
267
|
+
};
|
|
268
|
+
readonly ClaimType: {
|
|
269
|
+
readonly title: "ClaimType";
|
|
270
|
+
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.";
|
|
271
|
+
readonly type: "string";
|
|
272
|
+
readonly minLength: 1;
|
|
273
|
+
readonly maxLength: 128;
|
|
274
|
+
readonly pattern: "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$";
|
|
275
|
+
};
|
|
276
|
+
readonly Ulid: {
|
|
277
|
+
readonly title: "Ulid";
|
|
278
|
+
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.";
|
|
279
|
+
readonly type: "string";
|
|
280
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
281
|
+
};
|
|
282
|
+
};
|
|
283
|
+
};
|
|
284
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
285
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
286
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
287
|
+
readonly $ref: "#/$defs/Response";
|
|
288
|
+
readonly $defs: {
|
|
289
|
+
readonly Response: {
|
|
290
|
+
readonly $anchor: "response";
|
|
291
|
+
readonly title: "Persona Attribute List — response payload";
|
|
292
|
+
readonly description: "Success response to persona/attribute/list. Type https://trusttasks.org/spec/persona/attribute/list/1.0#response.";
|
|
293
|
+
readonly type: "object";
|
|
294
|
+
readonly additionalProperties: false;
|
|
295
|
+
readonly required: readonly ["attributes"];
|
|
296
|
+
readonly properties: {
|
|
297
|
+
readonly attributes: {
|
|
298
|
+
readonly type: "array";
|
|
299
|
+
readonly maxItems: 500;
|
|
300
|
+
readonly items: {
|
|
301
|
+
readonly $ref: "#/$defs/Attribute";
|
|
302
|
+
};
|
|
303
|
+
};
|
|
304
|
+
readonly nextCursor: {
|
|
305
|
+
readonly type: "string";
|
|
306
|
+
readonly maxLength: 4096;
|
|
307
|
+
readonly description: "Present when more attributes remain. Absent means the enumeration is complete — that absence is the only exhaustion signal.";
|
|
308
|
+
};
|
|
309
|
+
readonly ext: {
|
|
310
|
+
readonly $ref: "#/$defs/Ext";
|
|
311
|
+
};
|
|
312
|
+
};
|
|
313
|
+
};
|
|
314
|
+
readonly Ext: {
|
|
315
|
+
readonly title: "Ext";
|
|
316
|
+
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.";
|
|
317
|
+
readonly type: "object";
|
|
318
|
+
readonly minProperties: 1;
|
|
319
|
+
readonly additionalProperties: true;
|
|
320
|
+
readonly propertyNames: {
|
|
321
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
322
|
+
};
|
|
323
|
+
};
|
|
324
|
+
readonly Attribute: {
|
|
325
|
+
readonly title: "Attribute";
|
|
326
|
+
readonly description: "One atomic fact a holder keeps about themselves. Several attributes MAY share a `type` — three phone numbers, a legal name and a preferred name — which is why `attributeId` is the identity of a fact and `type` is not. The pool is flat and unordered; ordering is a profile's concern.";
|
|
327
|
+
readonly type: "object";
|
|
328
|
+
readonly additionalProperties: false;
|
|
329
|
+
readonly required: readonly ["attributeId", "type", "valueType", "value", "provenance", "version", "updatedAt"];
|
|
330
|
+
readonly properties: {
|
|
331
|
+
readonly attributeId: {
|
|
332
|
+
readonly $ref: "#/$defs/Ulid";
|
|
333
|
+
};
|
|
334
|
+
readonly type: {
|
|
335
|
+
readonly $ref: "#/$defs/ClaimType";
|
|
336
|
+
};
|
|
337
|
+
readonly valueType: {
|
|
338
|
+
readonly $ref: "#/$defs/ValueType";
|
|
339
|
+
};
|
|
340
|
+
readonly value: {
|
|
341
|
+
readonly description: "The fact itself, agreeing with `valueType`. Encrypted at rest by the maintainer. Absent when the caller asked for a metadata-only view, and absent when a credential-backed value could not be re-derived — a consumer MUST NOT conflate the two and MUST read `stale` to tell them apart.";
|
|
342
|
+
};
|
|
343
|
+
readonly label: {
|
|
344
|
+
readonly type: "string";
|
|
345
|
+
readonly maxLength: 128;
|
|
346
|
+
readonly description: "The holder's own words for this attribute, shown in a picker. Never disclosed to a verifier; it is a note to self.";
|
|
347
|
+
};
|
|
348
|
+
readonly provenance: {
|
|
349
|
+
readonly $ref: "#/$defs/Provenance";
|
|
350
|
+
};
|
|
351
|
+
readonly stale: {
|
|
352
|
+
readonly type: "boolean";
|
|
353
|
+
readonly description: "Present and true when a `credentialBacked` value could not be re-derived. `staleReason` says why. A maintainer MUST refuse to disclose a stale attribute.";
|
|
354
|
+
};
|
|
355
|
+
readonly staleReason: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly enum: readonly ["revoked", "expired", "archived", "deleted", "notFound"];
|
|
358
|
+
readonly description: "Why re-derivation failed. Present only alongside `stale`.";
|
|
359
|
+
};
|
|
360
|
+
readonly version: {
|
|
361
|
+
readonly $ref: "#/$defs/Version";
|
|
362
|
+
};
|
|
363
|
+
readonly createdAt: {
|
|
364
|
+
readonly type: "string";
|
|
365
|
+
readonly format: "date-time";
|
|
366
|
+
};
|
|
367
|
+
readonly updatedAt: {
|
|
368
|
+
readonly type: "string";
|
|
369
|
+
readonly format: "date-time";
|
|
370
|
+
};
|
|
371
|
+
};
|
|
372
|
+
};
|
|
373
|
+
readonly Version: {
|
|
374
|
+
readonly title: "Version";
|
|
375
|
+
readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
|
|
376
|
+
readonly type: "integer";
|
|
377
|
+
readonly minimum: 1;
|
|
378
|
+
};
|
|
379
|
+
readonly Provenance: {
|
|
380
|
+
readonly title: "Provenance";
|
|
381
|
+
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.";
|
|
382
|
+
readonly type: "object";
|
|
383
|
+
readonly required: readonly ["kind"];
|
|
384
|
+
readonly oneOf: readonly [{
|
|
385
|
+
readonly additionalProperties: false;
|
|
386
|
+
readonly required: readonly ["kind"];
|
|
387
|
+
readonly properties: {
|
|
388
|
+
readonly kind: {
|
|
389
|
+
readonly const: "selfAsserted";
|
|
390
|
+
};
|
|
391
|
+
};
|
|
392
|
+
}, {
|
|
393
|
+
readonly additionalProperties: false;
|
|
394
|
+
readonly required: readonly ["kind", "credentialId", "claimPath"];
|
|
395
|
+
readonly properties: {
|
|
396
|
+
readonly kind: {
|
|
397
|
+
readonly const: "credentialBacked";
|
|
398
|
+
};
|
|
399
|
+
readonly credentialId: {
|
|
400
|
+
readonly type: "string";
|
|
401
|
+
readonly minLength: 1;
|
|
402
|
+
readonly description: "Vault identifier of the backing credential.";
|
|
403
|
+
};
|
|
404
|
+
readonly claimPath: {
|
|
405
|
+
readonly type: "string";
|
|
406
|
+
readonly pattern: "^(/[^/~]*(~[01][^/~]*)*)*$";
|
|
407
|
+
readonly description: "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`.";
|
|
408
|
+
};
|
|
409
|
+
readonly issuerDid: {
|
|
410
|
+
readonly type: "string";
|
|
411
|
+
readonly minLength: 1;
|
|
412
|
+
readonly description: "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member.";
|
|
413
|
+
};
|
|
414
|
+
readonly proof: {
|
|
415
|
+
readonly $ref: "#/$defs/ProofRung";
|
|
416
|
+
readonly description: "The disclosure rung this claim was, or will be, presented at.";
|
|
417
|
+
};
|
|
418
|
+
};
|
|
419
|
+
}, {
|
|
420
|
+
readonly additionalProperties: false;
|
|
421
|
+
readonly required: readonly ["kind", "generator"];
|
|
422
|
+
readonly properties: {
|
|
423
|
+
readonly kind: {
|
|
424
|
+
readonly const: "generated";
|
|
425
|
+
};
|
|
426
|
+
readonly generator: {
|
|
427
|
+
readonly type: "string";
|
|
428
|
+
readonly minLength: 1;
|
|
429
|
+
readonly maxLength: 64;
|
|
430
|
+
readonly description: "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined.";
|
|
431
|
+
};
|
|
432
|
+
readonly perVerifier: {
|
|
433
|
+
readonly type: "boolean";
|
|
434
|
+
readonly default: true;
|
|
435
|
+
readonly description: "When true (the default and the only useful setting), a distinct value is minted for each verifier.";
|
|
436
|
+
};
|
|
437
|
+
};
|
|
438
|
+
}];
|
|
439
|
+
};
|
|
440
|
+
readonly ProofRung: {
|
|
441
|
+
readonly title: "ProofRung";
|
|
442
|
+
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.";
|
|
443
|
+
readonly type: "string";
|
|
444
|
+
readonly enum: readonly ["predicate", "derived", "selectiveDisclosure", "whole"];
|
|
445
|
+
};
|
|
446
|
+
readonly ValueType: {
|
|
447
|
+
readonly title: "ValueType";
|
|
448
|
+
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.";
|
|
449
|
+
readonly type: "string";
|
|
450
|
+
readonly enum: readonly ["string", "number", "boolean", "date", "object"];
|
|
451
|
+
};
|
|
452
|
+
readonly ClaimType: {
|
|
453
|
+
readonly title: "ClaimType";
|
|
454
|
+
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.";
|
|
455
|
+
readonly type: "string";
|
|
456
|
+
readonly minLength: 1;
|
|
457
|
+
readonly maxLength: 128;
|
|
458
|
+
readonly pattern: "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$";
|
|
459
|
+
};
|
|
460
|
+
readonly Ulid: {
|
|
461
|
+
readonly title: "Ulid";
|
|
462
|
+
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.";
|
|
463
|
+
readonly type: "string";
|
|
464
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
465
|
+
};
|
|
466
|
+
};
|
|
467
|
+
};
|
|
468
|
+
/**
|
|
469
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
470
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
471
|
+
* per-specification and cannot be derived from the document alone, and
|
|
472
|
+
* item 2 needs the schema this carries.
|
|
473
|
+
*/
|
|
474
|
+
export declare const SPEC: {
|
|
475
|
+
readonly typeUri: "https://trusttasks.org/spec/persona/attribute/list/1.0";
|
|
476
|
+
readonly isBearer: false;
|
|
477
|
+
readonly isProofRequired: true;
|
|
478
|
+
readonly isRecipientRequired: true;
|
|
479
|
+
readonly isIssuedAtRequired: false;
|
|
480
|
+
readonly payloadSchema: {
|
|
481
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
482
|
+
readonly $id: "https://trusttasks.org/spec/persona/attribute/list/1.0";
|
|
483
|
+
readonly title: "Persona Attribute List — payload";
|
|
484
|
+
readonly description: "Enumerate the holder's attribute pool, optionally narrowed to a vocabulary prefix. Cursor-paginated. Values are omitted unless asked for, so a picker can render the pool without decrypting every fact in it.";
|
|
485
|
+
readonly type: "object";
|
|
486
|
+
readonly additionalProperties: false;
|
|
487
|
+
readonly properties: {
|
|
488
|
+
readonly typePrefix: {
|
|
489
|
+
readonly type: "string";
|
|
490
|
+
readonly maxLength: 128;
|
|
491
|
+
readonly description: "Narrows the result to attributes whose `type` begins with this string, compared over the UTF-8 encoding. Because the vocabulary is dotted most-general-segment-first, `phone` selects every phone number and `name` every name — which is the access pattern a builder actually has. The maintainer MUST NOT interpret the value further; a prefix that ends mid-segment is a byte comparison like any other.";
|
|
492
|
+
};
|
|
493
|
+
readonly includeValues: {
|
|
494
|
+
readonly type: "boolean";
|
|
495
|
+
readonly default: false;
|
|
496
|
+
readonly description: "When false (the default), each returned attribute carries its metadata and no `value`. A pool listing is the common case and it does not need plaintext: a picker renders `type` and `label`. Defaulting to false means the expensive, sensitive path is the one a producer has to ask for.";
|
|
497
|
+
};
|
|
498
|
+
readonly includeStale: {
|
|
499
|
+
readonly type: "boolean";
|
|
500
|
+
readonly default: true;
|
|
501
|
+
readonly description: "When true (the default), credential-backed attributes whose backing could not be re-derived are returned carrying `stale` and `staleReason`. Set false to omit them. The default is true because a holder needs to SEE that a credential-backed fact has gone stale — silently dropping it would present a pool that looks smaller than it is, and the holder would not know a claim had stopped being presentable.";
|
|
502
|
+
};
|
|
503
|
+
readonly cursor: {
|
|
504
|
+
readonly type: "string";
|
|
505
|
+
readonly maxLength: 4096;
|
|
506
|
+
readonly description: "Opaque continuation token from a prior response's `nextCursor`. A producer MUST NOT construct or parse one.";
|
|
507
|
+
};
|
|
508
|
+
readonly limit: {
|
|
509
|
+
readonly type: "integer";
|
|
510
|
+
readonly minimum: 1;
|
|
511
|
+
readonly maximum: 500;
|
|
512
|
+
readonly default: 100;
|
|
513
|
+
readonly description: "Maximum attributes to return. The maintainer MAY return fewer for reasons of its own and a producer MUST NOT infer exhaustion from a short page — only an absent `nextCursor` means the end.";
|
|
514
|
+
};
|
|
515
|
+
readonly ext: {
|
|
516
|
+
readonly $ref: "#/$defs/Ext";
|
|
517
|
+
};
|
|
518
|
+
};
|
|
519
|
+
readonly $defs: {
|
|
520
|
+
readonly Response: {
|
|
521
|
+
readonly $anchor: "response";
|
|
522
|
+
readonly title: "Persona Attribute List — response payload";
|
|
523
|
+
readonly description: "Success response to persona/attribute/list. Type https://trusttasks.org/spec/persona/attribute/list/1.0#response.";
|
|
524
|
+
readonly type: "object";
|
|
525
|
+
readonly additionalProperties: false;
|
|
526
|
+
readonly required: readonly ["attributes"];
|
|
527
|
+
readonly properties: {
|
|
528
|
+
readonly attributes: {
|
|
529
|
+
readonly type: "array";
|
|
530
|
+
readonly maxItems: 500;
|
|
531
|
+
readonly items: {
|
|
532
|
+
readonly $ref: "#/$defs/Attribute";
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
readonly nextCursor: {
|
|
536
|
+
readonly type: "string";
|
|
537
|
+
readonly maxLength: 4096;
|
|
538
|
+
readonly description: "Present when more attributes remain. Absent means the enumeration is complete — that absence is the only exhaustion signal.";
|
|
539
|
+
};
|
|
540
|
+
readonly ext: {
|
|
541
|
+
readonly $ref: "#/$defs/Ext";
|
|
542
|
+
};
|
|
543
|
+
};
|
|
544
|
+
};
|
|
545
|
+
readonly Ext: {
|
|
546
|
+
readonly title: "Ext";
|
|
547
|
+
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.";
|
|
548
|
+
readonly type: "object";
|
|
549
|
+
readonly minProperties: 1;
|
|
550
|
+
readonly additionalProperties: true;
|
|
551
|
+
readonly propertyNames: {
|
|
552
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
553
|
+
};
|
|
554
|
+
};
|
|
555
|
+
readonly Attribute: {
|
|
556
|
+
readonly title: "Attribute";
|
|
557
|
+
readonly description: "One atomic fact a holder keeps about themselves. Several attributes MAY share a `type` — three phone numbers, a legal name and a preferred name — which is why `attributeId` is the identity of a fact and `type` is not. The pool is flat and unordered; ordering is a profile's concern.";
|
|
558
|
+
readonly type: "object";
|
|
559
|
+
readonly additionalProperties: false;
|
|
560
|
+
readonly required: readonly ["attributeId", "type", "valueType", "value", "provenance", "version", "updatedAt"];
|
|
561
|
+
readonly properties: {
|
|
562
|
+
readonly attributeId: {
|
|
563
|
+
readonly $ref: "#/$defs/Ulid";
|
|
564
|
+
};
|
|
565
|
+
readonly type: {
|
|
566
|
+
readonly $ref: "#/$defs/ClaimType";
|
|
567
|
+
};
|
|
568
|
+
readonly valueType: {
|
|
569
|
+
readonly $ref: "#/$defs/ValueType";
|
|
570
|
+
};
|
|
571
|
+
readonly value: {
|
|
572
|
+
readonly description: "The fact itself, agreeing with `valueType`. Encrypted at rest by the maintainer. Absent when the caller asked for a metadata-only view, and absent when a credential-backed value could not be re-derived — a consumer MUST NOT conflate the two and MUST read `stale` to tell them apart.";
|
|
573
|
+
};
|
|
574
|
+
readonly label: {
|
|
575
|
+
readonly type: "string";
|
|
576
|
+
readonly maxLength: 128;
|
|
577
|
+
readonly description: "The holder's own words for this attribute, shown in a picker. Never disclosed to a verifier; it is a note to self.";
|
|
578
|
+
};
|
|
579
|
+
readonly provenance: {
|
|
580
|
+
readonly $ref: "#/$defs/Provenance";
|
|
581
|
+
};
|
|
582
|
+
readonly stale: {
|
|
583
|
+
readonly type: "boolean";
|
|
584
|
+
readonly description: "Present and true when a `credentialBacked` value could not be re-derived. `staleReason` says why. A maintainer MUST refuse to disclose a stale attribute.";
|
|
585
|
+
};
|
|
586
|
+
readonly staleReason: {
|
|
587
|
+
readonly type: "string";
|
|
588
|
+
readonly enum: readonly ["revoked", "expired", "archived", "deleted", "notFound"];
|
|
589
|
+
readonly description: "Why re-derivation failed. Present only alongside `stale`.";
|
|
590
|
+
};
|
|
591
|
+
readonly version: {
|
|
592
|
+
readonly $ref: "#/$defs/Version";
|
|
593
|
+
};
|
|
594
|
+
readonly createdAt: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
readonly format: "date-time";
|
|
597
|
+
};
|
|
598
|
+
readonly updatedAt: {
|
|
599
|
+
readonly type: "string";
|
|
600
|
+
readonly format: "date-time";
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
};
|
|
604
|
+
readonly Version: {
|
|
605
|
+
readonly title: "Version";
|
|
606
|
+
readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
|
|
607
|
+
readonly type: "integer";
|
|
608
|
+
readonly minimum: 1;
|
|
609
|
+
};
|
|
610
|
+
readonly Provenance: {
|
|
611
|
+
readonly title: "Provenance";
|
|
612
|
+
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.";
|
|
613
|
+
readonly type: "object";
|
|
614
|
+
readonly required: readonly ["kind"];
|
|
615
|
+
readonly oneOf: readonly [{
|
|
616
|
+
readonly additionalProperties: false;
|
|
617
|
+
readonly required: readonly ["kind"];
|
|
618
|
+
readonly properties: {
|
|
619
|
+
readonly kind: {
|
|
620
|
+
readonly const: "selfAsserted";
|
|
621
|
+
};
|
|
622
|
+
};
|
|
623
|
+
}, {
|
|
624
|
+
readonly additionalProperties: false;
|
|
625
|
+
readonly required: readonly ["kind", "credentialId", "claimPath"];
|
|
626
|
+
readonly properties: {
|
|
627
|
+
readonly kind: {
|
|
628
|
+
readonly const: "credentialBacked";
|
|
629
|
+
};
|
|
630
|
+
readonly credentialId: {
|
|
631
|
+
readonly type: "string";
|
|
632
|
+
readonly minLength: 1;
|
|
633
|
+
readonly description: "Vault identifier of the backing credential.";
|
|
634
|
+
};
|
|
635
|
+
readonly claimPath: {
|
|
636
|
+
readonly type: "string";
|
|
637
|
+
readonly pattern: "^(/[^/~]*(~[01][^/~]*)*)*$";
|
|
638
|
+
readonly description: "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`.";
|
|
639
|
+
};
|
|
640
|
+
readonly issuerDid: {
|
|
641
|
+
readonly type: "string";
|
|
642
|
+
readonly minLength: 1;
|
|
643
|
+
readonly description: "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member.";
|
|
644
|
+
};
|
|
645
|
+
readonly proof: {
|
|
646
|
+
readonly $ref: "#/$defs/ProofRung";
|
|
647
|
+
readonly description: "The disclosure rung this claim was, or will be, presented at.";
|
|
648
|
+
};
|
|
649
|
+
};
|
|
650
|
+
}, {
|
|
651
|
+
readonly additionalProperties: false;
|
|
652
|
+
readonly required: readonly ["kind", "generator"];
|
|
653
|
+
readonly properties: {
|
|
654
|
+
readonly kind: {
|
|
655
|
+
readonly const: "generated";
|
|
656
|
+
};
|
|
657
|
+
readonly generator: {
|
|
658
|
+
readonly type: "string";
|
|
659
|
+
readonly minLength: 1;
|
|
660
|
+
readonly maxLength: 64;
|
|
661
|
+
readonly description: "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined.";
|
|
662
|
+
};
|
|
663
|
+
readonly perVerifier: {
|
|
664
|
+
readonly type: "boolean";
|
|
665
|
+
readonly default: true;
|
|
666
|
+
readonly description: "When true (the default and the only useful setting), a distinct value is minted for each verifier.";
|
|
667
|
+
};
|
|
668
|
+
};
|
|
669
|
+
}];
|
|
670
|
+
};
|
|
671
|
+
readonly ProofRung: {
|
|
672
|
+
readonly title: "ProofRung";
|
|
673
|
+
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.";
|
|
674
|
+
readonly type: "string";
|
|
675
|
+
readonly enum: readonly ["predicate", "derived", "selectiveDisclosure", "whole"];
|
|
676
|
+
};
|
|
677
|
+
readonly ValueType: {
|
|
678
|
+
readonly title: "ValueType";
|
|
679
|
+
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.";
|
|
680
|
+
readonly type: "string";
|
|
681
|
+
readonly enum: readonly ["string", "number", "boolean", "date", "object"];
|
|
682
|
+
};
|
|
683
|
+
readonly ClaimType: {
|
|
684
|
+
readonly title: "ClaimType";
|
|
685
|
+
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.";
|
|
686
|
+
readonly type: "string";
|
|
687
|
+
readonly minLength: 1;
|
|
688
|
+
readonly maxLength: 128;
|
|
689
|
+
readonly pattern: "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$";
|
|
690
|
+
};
|
|
691
|
+
readonly Ulid: {
|
|
692
|
+
readonly title: "Ulid";
|
|
693
|
+
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.";
|
|
694
|
+
readonly type: "string";
|
|
695
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
696
|
+
};
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
};
|
|
700
|
+
/**
|
|
701
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
702
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
703
|
+
* parties (§7.3 item 5).
|
|
704
|
+
*/
|
|
705
|
+
export declare const RESPONSE_SPEC: {
|
|
706
|
+
readonly typeUri: "https://trusttasks.org/spec/persona/attribute/list/1.0#response";
|
|
707
|
+
readonly isBearer: false;
|
|
708
|
+
readonly isProofRequired: true;
|
|
709
|
+
readonly isRecipientRequired: true;
|
|
710
|
+
readonly isIssuedAtRequired: false;
|
|
711
|
+
readonly payloadSchema: {
|
|
712
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
713
|
+
readonly $ref: "#/$defs/Response";
|
|
714
|
+
readonly $defs: {
|
|
715
|
+
readonly Response: {
|
|
716
|
+
readonly $anchor: "response";
|
|
717
|
+
readonly title: "Persona Attribute List — response payload";
|
|
718
|
+
readonly description: "Success response to persona/attribute/list. Type https://trusttasks.org/spec/persona/attribute/list/1.0#response.";
|
|
719
|
+
readonly type: "object";
|
|
720
|
+
readonly additionalProperties: false;
|
|
721
|
+
readonly required: readonly ["attributes"];
|
|
722
|
+
readonly properties: {
|
|
723
|
+
readonly attributes: {
|
|
724
|
+
readonly type: "array";
|
|
725
|
+
readonly maxItems: 500;
|
|
726
|
+
readonly items: {
|
|
727
|
+
readonly $ref: "#/$defs/Attribute";
|
|
728
|
+
};
|
|
729
|
+
};
|
|
730
|
+
readonly nextCursor: {
|
|
731
|
+
readonly type: "string";
|
|
732
|
+
readonly maxLength: 4096;
|
|
733
|
+
readonly description: "Present when more attributes remain. Absent means the enumeration is complete — that absence is the only exhaustion signal.";
|
|
734
|
+
};
|
|
735
|
+
readonly ext: {
|
|
736
|
+
readonly $ref: "#/$defs/Ext";
|
|
737
|
+
};
|
|
738
|
+
};
|
|
739
|
+
};
|
|
740
|
+
readonly Ext: {
|
|
741
|
+
readonly title: "Ext";
|
|
742
|
+
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.";
|
|
743
|
+
readonly type: "object";
|
|
744
|
+
readonly minProperties: 1;
|
|
745
|
+
readonly additionalProperties: true;
|
|
746
|
+
readonly propertyNames: {
|
|
747
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
748
|
+
};
|
|
749
|
+
};
|
|
750
|
+
readonly Attribute: {
|
|
751
|
+
readonly title: "Attribute";
|
|
752
|
+
readonly description: "One atomic fact a holder keeps about themselves. Several attributes MAY share a `type` — three phone numbers, a legal name and a preferred name — which is why `attributeId` is the identity of a fact and `type` is not. The pool is flat and unordered; ordering is a profile's concern.";
|
|
753
|
+
readonly type: "object";
|
|
754
|
+
readonly additionalProperties: false;
|
|
755
|
+
readonly required: readonly ["attributeId", "type", "valueType", "value", "provenance", "version", "updatedAt"];
|
|
756
|
+
readonly properties: {
|
|
757
|
+
readonly attributeId: {
|
|
758
|
+
readonly $ref: "#/$defs/Ulid";
|
|
759
|
+
};
|
|
760
|
+
readonly type: {
|
|
761
|
+
readonly $ref: "#/$defs/ClaimType";
|
|
762
|
+
};
|
|
763
|
+
readonly valueType: {
|
|
764
|
+
readonly $ref: "#/$defs/ValueType";
|
|
765
|
+
};
|
|
766
|
+
readonly value: {
|
|
767
|
+
readonly description: "The fact itself, agreeing with `valueType`. Encrypted at rest by the maintainer. Absent when the caller asked for a metadata-only view, and absent when a credential-backed value could not be re-derived — a consumer MUST NOT conflate the two and MUST read `stale` to tell them apart.";
|
|
768
|
+
};
|
|
769
|
+
readonly label: {
|
|
770
|
+
readonly type: "string";
|
|
771
|
+
readonly maxLength: 128;
|
|
772
|
+
readonly description: "The holder's own words for this attribute, shown in a picker. Never disclosed to a verifier; it is a note to self.";
|
|
773
|
+
};
|
|
774
|
+
readonly provenance: {
|
|
775
|
+
readonly $ref: "#/$defs/Provenance";
|
|
776
|
+
};
|
|
777
|
+
readonly stale: {
|
|
778
|
+
readonly type: "boolean";
|
|
779
|
+
readonly description: "Present and true when a `credentialBacked` value could not be re-derived. `staleReason` says why. A maintainer MUST refuse to disclose a stale attribute.";
|
|
780
|
+
};
|
|
781
|
+
readonly staleReason: {
|
|
782
|
+
readonly type: "string";
|
|
783
|
+
readonly enum: readonly ["revoked", "expired", "archived", "deleted", "notFound"];
|
|
784
|
+
readonly description: "Why re-derivation failed. Present only alongside `stale`.";
|
|
785
|
+
};
|
|
786
|
+
readonly version: {
|
|
787
|
+
readonly $ref: "#/$defs/Version";
|
|
788
|
+
};
|
|
789
|
+
readonly createdAt: {
|
|
790
|
+
readonly type: "string";
|
|
791
|
+
readonly format: "date-time";
|
|
792
|
+
};
|
|
793
|
+
readonly updatedAt: {
|
|
794
|
+
readonly type: "string";
|
|
795
|
+
readonly format: "date-time";
|
|
796
|
+
};
|
|
797
|
+
};
|
|
798
|
+
};
|
|
799
|
+
readonly Version: {
|
|
800
|
+
readonly title: "Version";
|
|
801
|
+
readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
|
|
802
|
+
readonly type: "integer";
|
|
803
|
+
readonly minimum: 1;
|
|
804
|
+
};
|
|
805
|
+
readonly Provenance: {
|
|
806
|
+
readonly title: "Provenance";
|
|
807
|
+
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.";
|
|
808
|
+
readonly type: "object";
|
|
809
|
+
readonly required: readonly ["kind"];
|
|
810
|
+
readonly oneOf: readonly [{
|
|
811
|
+
readonly additionalProperties: false;
|
|
812
|
+
readonly required: readonly ["kind"];
|
|
813
|
+
readonly properties: {
|
|
814
|
+
readonly kind: {
|
|
815
|
+
readonly const: "selfAsserted";
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
}, {
|
|
819
|
+
readonly additionalProperties: false;
|
|
820
|
+
readonly required: readonly ["kind", "credentialId", "claimPath"];
|
|
821
|
+
readonly properties: {
|
|
822
|
+
readonly kind: {
|
|
823
|
+
readonly const: "credentialBacked";
|
|
824
|
+
};
|
|
825
|
+
readonly credentialId: {
|
|
826
|
+
readonly type: "string";
|
|
827
|
+
readonly minLength: 1;
|
|
828
|
+
readonly description: "Vault identifier of the backing credential.";
|
|
829
|
+
};
|
|
830
|
+
readonly claimPath: {
|
|
831
|
+
readonly type: "string";
|
|
832
|
+
readonly pattern: "^(/[^/~]*(~[01][^/~]*)*)*$";
|
|
833
|
+
readonly description: "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`.";
|
|
834
|
+
};
|
|
835
|
+
readonly issuerDid: {
|
|
836
|
+
readonly type: "string";
|
|
837
|
+
readonly minLength: 1;
|
|
838
|
+
readonly description: "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member.";
|
|
839
|
+
};
|
|
840
|
+
readonly proof: {
|
|
841
|
+
readonly $ref: "#/$defs/ProofRung";
|
|
842
|
+
readonly description: "The disclosure rung this claim was, or will be, presented at.";
|
|
843
|
+
};
|
|
844
|
+
};
|
|
845
|
+
}, {
|
|
846
|
+
readonly additionalProperties: false;
|
|
847
|
+
readonly required: readonly ["kind", "generator"];
|
|
848
|
+
readonly properties: {
|
|
849
|
+
readonly kind: {
|
|
850
|
+
readonly const: "generated";
|
|
851
|
+
};
|
|
852
|
+
readonly generator: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
readonly minLength: 1;
|
|
855
|
+
readonly maxLength: 64;
|
|
856
|
+
readonly description: "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined.";
|
|
857
|
+
};
|
|
858
|
+
readonly perVerifier: {
|
|
859
|
+
readonly type: "boolean";
|
|
860
|
+
readonly default: true;
|
|
861
|
+
readonly description: "When true (the default and the only useful setting), a distinct value is minted for each verifier.";
|
|
862
|
+
};
|
|
863
|
+
};
|
|
864
|
+
}];
|
|
865
|
+
};
|
|
866
|
+
readonly ProofRung: {
|
|
867
|
+
readonly title: "ProofRung";
|
|
868
|
+
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.";
|
|
869
|
+
readonly type: "string";
|
|
870
|
+
readonly enum: readonly ["predicate", "derived", "selectiveDisclosure", "whole"];
|
|
871
|
+
};
|
|
872
|
+
readonly ValueType: {
|
|
873
|
+
readonly title: "ValueType";
|
|
874
|
+
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.";
|
|
875
|
+
readonly type: "string";
|
|
876
|
+
readonly enum: readonly ["string", "number", "boolean", "date", "object"];
|
|
877
|
+
};
|
|
878
|
+
readonly ClaimType: {
|
|
879
|
+
readonly title: "ClaimType";
|
|
880
|
+
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.";
|
|
881
|
+
readonly type: "string";
|
|
882
|
+
readonly minLength: 1;
|
|
883
|
+
readonly maxLength: 128;
|
|
884
|
+
readonly pattern: "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$";
|
|
885
|
+
};
|
|
886
|
+
readonly Ulid: {
|
|
887
|
+
readonly title: "Ulid";
|
|
888
|
+
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.";
|
|
889
|
+
readonly type: "string";
|
|
890
|
+
readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
|
|
891
|
+
};
|
|
892
|
+
};
|
|
893
|
+
};
|
|
894
|
+
};
|
|
895
|
+
//# sourceMappingURL=payload.d.ts.map
|