@openvtc/trust-tasks 0.16.2 → 0.16.4
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 +76 -0
- package/dist/consent/approve-request/0.1/payload.d.ts +267 -0
- package/dist/consent/approve-request/0.1/payload.d.ts.map +1 -0
- package/dist/consent/approve-request/0.1/payload.js +138 -0
- package/dist/consent/approve-request/0.1/payload.js.map +1 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -0
- package/dist/index.js.map +1 -1
- package/dist/vault/credentials/archive/0.1/payload.d.ts +297 -0
- package/dist/vault/credentials/archive/0.1/payload.d.ts.map +1 -0
- package/dist/vault/credentials/archive/0.1/payload.js +171 -0
- package/dist/vault/credentials/archive/0.1/payload.js.map +1 -0
- package/dist/vault/credentials/delete/0.1/payload.d.ts +333 -0
- package/dist/vault/credentials/delete/0.1/payload.d.ts.map +1 -0
- package/dist/vault/credentials/delete/0.1/payload.js +185 -0
- package/dist/vault/credentials/delete/0.1/payload.js.map +1 -0
- package/dist/vault/credentials/get/0.1/payload.d.ts +244 -0
- package/dist/vault/credentials/get/0.1/payload.d.ts.map +1 -0
- package/dist/vault/credentials/get/0.1/payload.js +137 -0
- package/dist/vault/credentials/get/0.1/payload.js.map +1 -0
- package/dist/vault/credentials/purge/0.1/payload.d.ts +297 -0
- package/dist/vault/credentials/purge/0.1/payload.d.ts.map +1 -0
- package/dist/vault/credentials/purge/0.1/payload.js +171 -0
- package/dist/vault/credentials/purge/0.1/payload.js.map +1 -0
- package/dist/vault/credentials/query/0.1/payload.d.ts +689 -0
- package/dist/vault/credentials/query/0.1/payload.d.ts.map +1 -0
- package/dist/vault/credentials/query/0.1/payload.js +350 -0
- package/dist/vault/credentials/query/0.1/payload.js.map +1 -0
- package/dist/vault/credentials/receive/0.1/payload.d.ts +414 -0
- package/dist/vault/credentials/receive/0.1/payload.d.ts.map +1 -0
- package/dist/vault/credentials/receive/0.1/payload.js +226 -0
- package/dist/vault/credentials/receive/0.1/payload.js.map +1 -0
- package/dist/vault/credentials/restore/0.1/payload.d.ts +297 -0
- package/dist/vault/credentials/restore/0.1/payload.d.ts.map +1 -0
- package/dist/vault/credentials/restore/0.1/payload.js +171 -0
- package/dist/vault/credentials/restore/0.1/payload.js.map +1 -0
- package/dist/vault/credentials/unarchive/0.1/payload.d.ts +297 -0
- package/dist/vault/credentials/unarchive/0.1/payload.d.ts.map +1 -0
- package/dist/vault/credentials/unarchive/0.1/payload.js +171 -0
- package/dist/vault/credentials/unarchive/0.1/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/consent/approve-request/0.1/payload.ts +200 -0
- package/src/index.ts +9 -0
- package/src/vault/credentials/archive/0.1/payload.ts +217 -0
- package/src/vault/credentials/delete/0.1/payload.ts +239 -0
- package/src/vault/credentials/get/0.1/payload.ts +178 -0
- package/src/vault/credentials/purge/0.1/payload.ts +217 -0
- package/src/vault/credentials/query/0.1/payload.ts +459 -0
- package/src/vault/credentials/receive/0.1/payload.ts +298 -0
- package/src/vault/credentials/restore/0.1/payload.ts +217 -0
- package/src/vault/credentials/unarchive/0.1/payload.ts +217 -0
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vault/credentials/unarchive/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* Return an archived credential to the active state.
|
|
8
|
+
*/
|
|
9
|
+
export interface VaultCredentialsUnarchive {
|
|
10
|
+
/**
|
|
11
|
+
* Local handle from a query descriptor. Opaque; consumers must not derive or guess one.
|
|
12
|
+
*/
|
|
13
|
+
id: string;
|
|
14
|
+
/**
|
|
15
|
+
* Free text recorded with the transition. Must not carry credential contents.
|
|
16
|
+
*/
|
|
17
|
+
reason?: string;
|
|
18
|
+
/**
|
|
19
|
+
* Ecosystem-defined extension members per SPEC.md §4.5.1.
|
|
20
|
+
*/
|
|
21
|
+
ext?: Ext;
|
|
22
|
+
}
|
|
23
|
+
export interface VaultCredentialsUnarchiveResponsePayload {
|
|
24
|
+
id: string;
|
|
25
|
+
/**
|
|
26
|
+
* State after the transition, echoed rather than left to be inferred from the verb.
|
|
27
|
+
*/
|
|
28
|
+
lifecycle: "active" | "archived" | "deleted";
|
|
29
|
+
/**
|
|
30
|
+
* Ecosystem-defined extension members per SPEC.md §4.5.1.
|
|
31
|
+
*/
|
|
32
|
+
ext?: Ext;
|
|
33
|
+
}
|
|
34
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
35
|
+
export type { Ext };
|
|
36
|
+
/** Trust Task type URI. */
|
|
37
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vault/credentials/unarchive/0.1";
|
|
38
|
+
/** Stable alias for this specification's request payload shape. */
|
|
39
|
+
export type Payload = VaultCredentialsUnarchive;
|
|
40
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
41
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vault/credentials/unarchive/0.1#response";
|
|
42
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
43
|
+
export type Response = VaultCredentialsUnarchiveResponsePayload;
|
|
44
|
+
/**
|
|
45
|
+
* This specification's payload schema, as a value.
|
|
46
|
+
*
|
|
47
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
48
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
49
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
50
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
51
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
52
|
+
*/
|
|
53
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
54
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
55
|
+
readonly $id: "https://trusttasks.org/spec/vault/credentials/unarchive/0.1";
|
|
56
|
+
readonly title: "Vault Credentials — Unarchive";
|
|
57
|
+
readonly description: "Return an archived credential to the active state.";
|
|
58
|
+
readonly type: "object";
|
|
59
|
+
readonly additionalProperties: false;
|
|
60
|
+
readonly required: readonly ["id"];
|
|
61
|
+
readonly properties: {
|
|
62
|
+
readonly id: {
|
|
63
|
+
readonly type: "string";
|
|
64
|
+
readonly minLength: 1;
|
|
65
|
+
readonly maxLength: 256;
|
|
66
|
+
readonly description: "Local handle from a query descriptor. Opaque; consumers must not derive or guess one.";
|
|
67
|
+
};
|
|
68
|
+
readonly reason: {
|
|
69
|
+
readonly type: "string";
|
|
70
|
+
readonly minLength: 1;
|
|
71
|
+
readonly maxLength: 512;
|
|
72
|
+
readonly description: "Free text recorded with the transition. Must not carry credential contents.";
|
|
73
|
+
};
|
|
74
|
+
readonly ext: {
|
|
75
|
+
readonly $ref: "#/$defs/Ext";
|
|
76
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
readonly $defs: {
|
|
80
|
+
readonly Response: {
|
|
81
|
+
readonly $anchor: "response";
|
|
82
|
+
readonly title: "Vault Credentials Unarchive — response payload";
|
|
83
|
+
readonly type: "object";
|
|
84
|
+
readonly additionalProperties: false;
|
|
85
|
+
readonly required: readonly ["id", "lifecycle"];
|
|
86
|
+
readonly properties: {
|
|
87
|
+
readonly id: {
|
|
88
|
+
readonly type: "string";
|
|
89
|
+
readonly minLength: 1;
|
|
90
|
+
readonly maxLength: 256;
|
|
91
|
+
};
|
|
92
|
+
readonly lifecycle: {
|
|
93
|
+
readonly $ref: "#/$defs/VaultLifecycle";
|
|
94
|
+
readonly description: "State after the transition, echoed rather than left to be inferred from the verb.";
|
|
95
|
+
};
|
|
96
|
+
readonly ext: {
|
|
97
|
+
readonly $ref: "#/$defs/Ext";
|
|
98
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
readonly VaultLifecycle: {
|
|
103
|
+
readonly type: "string";
|
|
104
|
+
readonly enum: readonly ["active", "archived", "deleted"];
|
|
105
|
+
readonly description: "Archival state. Orthogonal to validity.";
|
|
106
|
+
};
|
|
107
|
+
readonly Ext: {
|
|
108
|
+
readonly title: "Ext";
|
|
109
|
+
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.";
|
|
110
|
+
readonly type: "object";
|
|
111
|
+
readonly minProperties: 1;
|
|
112
|
+
readonly additionalProperties: true;
|
|
113
|
+
readonly propertyNames: {
|
|
114
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
120
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
121
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
122
|
+
readonly $ref: "#/$defs/Response";
|
|
123
|
+
readonly $defs: {
|
|
124
|
+
readonly Response: {
|
|
125
|
+
readonly $anchor: "response";
|
|
126
|
+
readonly title: "Vault Credentials Unarchive — response payload";
|
|
127
|
+
readonly type: "object";
|
|
128
|
+
readonly additionalProperties: false;
|
|
129
|
+
readonly required: readonly ["id", "lifecycle"];
|
|
130
|
+
readonly properties: {
|
|
131
|
+
readonly id: {
|
|
132
|
+
readonly type: "string";
|
|
133
|
+
readonly minLength: 1;
|
|
134
|
+
readonly maxLength: 256;
|
|
135
|
+
};
|
|
136
|
+
readonly lifecycle: {
|
|
137
|
+
readonly $ref: "#/$defs/VaultLifecycle";
|
|
138
|
+
readonly description: "State after the transition, echoed rather than left to be inferred from the verb.";
|
|
139
|
+
};
|
|
140
|
+
readonly ext: {
|
|
141
|
+
readonly $ref: "#/$defs/Ext";
|
|
142
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
143
|
+
};
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
readonly VaultLifecycle: {
|
|
147
|
+
readonly type: "string";
|
|
148
|
+
readonly enum: readonly ["active", "archived", "deleted"];
|
|
149
|
+
readonly description: "Archival state. Orthogonal to validity.";
|
|
150
|
+
};
|
|
151
|
+
readonly Ext: {
|
|
152
|
+
readonly title: "Ext";
|
|
153
|
+
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.";
|
|
154
|
+
readonly type: "object";
|
|
155
|
+
readonly minProperties: 1;
|
|
156
|
+
readonly additionalProperties: true;
|
|
157
|
+
readonly propertyNames: {
|
|
158
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
159
|
+
};
|
|
160
|
+
};
|
|
161
|
+
};
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
165
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
166
|
+
* per-specification and cannot be derived from the document alone, and
|
|
167
|
+
* item 2 needs the schema this carries.
|
|
168
|
+
*/
|
|
169
|
+
export declare const SPEC: {
|
|
170
|
+
readonly typeUri: "https://trusttasks.org/spec/vault/credentials/unarchive/0.1";
|
|
171
|
+
readonly isBearer: false;
|
|
172
|
+
readonly isProofRequired: true;
|
|
173
|
+
readonly isRecipientRequired: true;
|
|
174
|
+
readonly isIssuedAtRequired: true;
|
|
175
|
+
readonly payloadSchema: {
|
|
176
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
177
|
+
readonly $id: "https://trusttasks.org/spec/vault/credentials/unarchive/0.1";
|
|
178
|
+
readonly title: "Vault Credentials — Unarchive";
|
|
179
|
+
readonly description: "Return an archived credential to the active state.";
|
|
180
|
+
readonly type: "object";
|
|
181
|
+
readonly additionalProperties: false;
|
|
182
|
+
readonly required: readonly ["id"];
|
|
183
|
+
readonly properties: {
|
|
184
|
+
readonly id: {
|
|
185
|
+
readonly type: "string";
|
|
186
|
+
readonly minLength: 1;
|
|
187
|
+
readonly maxLength: 256;
|
|
188
|
+
readonly description: "Local handle from a query descriptor. Opaque; consumers must not derive or guess one.";
|
|
189
|
+
};
|
|
190
|
+
readonly reason: {
|
|
191
|
+
readonly type: "string";
|
|
192
|
+
readonly minLength: 1;
|
|
193
|
+
readonly maxLength: 512;
|
|
194
|
+
readonly description: "Free text recorded with the transition. Must not carry credential contents.";
|
|
195
|
+
};
|
|
196
|
+
readonly ext: {
|
|
197
|
+
readonly $ref: "#/$defs/Ext";
|
|
198
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
199
|
+
};
|
|
200
|
+
};
|
|
201
|
+
readonly $defs: {
|
|
202
|
+
readonly Response: {
|
|
203
|
+
readonly $anchor: "response";
|
|
204
|
+
readonly title: "Vault Credentials Unarchive — response payload";
|
|
205
|
+
readonly type: "object";
|
|
206
|
+
readonly additionalProperties: false;
|
|
207
|
+
readonly required: readonly ["id", "lifecycle"];
|
|
208
|
+
readonly properties: {
|
|
209
|
+
readonly id: {
|
|
210
|
+
readonly type: "string";
|
|
211
|
+
readonly minLength: 1;
|
|
212
|
+
readonly maxLength: 256;
|
|
213
|
+
};
|
|
214
|
+
readonly lifecycle: {
|
|
215
|
+
readonly $ref: "#/$defs/VaultLifecycle";
|
|
216
|
+
readonly description: "State after the transition, echoed rather than left to be inferred from the verb.";
|
|
217
|
+
};
|
|
218
|
+
readonly ext: {
|
|
219
|
+
readonly $ref: "#/$defs/Ext";
|
|
220
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
221
|
+
};
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
readonly VaultLifecycle: {
|
|
225
|
+
readonly type: "string";
|
|
226
|
+
readonly enum: readonly ["active", "archived", "deleted"];
|
|
227
|
+
readonly description: "Archival state. Orthogonal to validity.";
|
|
228
|
+
};
|
|
229
|
+
readonly Ext: {
|
|
230
|
+
readonly title: "Ext";
|
|
231
|
+
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.";
|
|
232
|
+
readonly type: "object";
|
|
233
|
+
readonly minProperties: 1;
|
|
234
|
+
readonly additionalProperties: true;
|
|
235
|
+
readonly propertyNames: {
|
|
236
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
237
|
+
};
|
|
238
|
+
};
|
|
239
|
+
};
|
|
240
|
+
};
|
|
241
|
+
};
|
|
242
|
+
/**
|
|
243
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
244
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
245
|
+
* parties (§7.3 item 5).
|
|
246
|
+
*/
|
|
247
|
+
export declare const RESPONSE_SPEC: {
|
|
248
|
+
readonly typeUri: "https://trusttasks.org/spec/vault/credentials/unarchive/0.1#response";
|
|
249
|
+
readonly isBearer: false;
|
|
250
|
+
readonly isProofRequired: true;
|
|
251
|
+
readonly isRecipientRequired: true;
|
|
252
|
+
readonly isIssuedAtRequired: true;
|
|
253
|
+
readonly payloadSchema: {
|
|
254
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
255
|
+
readonly $ref: "#/$defs/Response";
|
|
256
|
+
readonly $defs: {
|
|
257
|
+
readonly Response: {
|
|
258
|
+
readonly $anchor: "response";
|
|
259
|
+
readonly title: "Vault Credentials Unarchive — response payload";
|
|
260
|
+
readonly type: "object";
|
|
261
|
+
readonly additionalProperties: false;
|
|
262
|
+
readonly required: readonly ["id", "lifecycle"];
|
|
263
|
+
readonly properties: {
|
|
264
|
+
readonly id: {
|
|
265
|
+
readonly type: "string";
|
|
266
|
+
readonly minLength: 1;
|
|
267
|
+
readonly maxLength: 256;
|
|
268
|
+
};
|
|
269
|
+
readonly lifecycle: {
|
|
270
|
+
readonly $ref: "#/$defs/VaultLifecycle";
|
|
271
|
+
readonly description: "State after the transition, echoed rather than left to be inferred from the verb.";
|
|
272
|
+
};
|
|
273
|
+
readonly ext: {
|
|
274
|
+
readonly $ref: "#/$defs/Ext";
|
|
275
|
+
readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
|
|
276
|
+
};
|
|
277
|
+
};
|
|
278
|
+
};
|
|
279
|
+
readonly VaultLifecycle: {
|
|
280
|
+
readonly type: "string";
|
|
281
|
+
readonly enum: readonly ["active", "archived", "deleted"];
|
|
282
|
+
readonly description: "Archival state. Orthogonal to validity.";
|
|
283
|
+
};
|
|
284
|
+
readonly Ext: {
|
|
285
|
+
readonly title: "Ext";
|
|
286
|
+
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.";
|
|
287
|
+
readonly type: "object";
|
|
288
|
+
readonly minProperties: 1;
|
|
289
|
+
readonly additionalProperties: true;
|
|
290
|
+
readonly propertyNames: {
|
|
291
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
};
|
|
297
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vault/credentials/unarchive/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAG7D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,wCAAwC;IACvD,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,CAAC;AAEpB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,6DAAsE,CAAC;AAE/F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,yBAAyB,CAAC;AAEhD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,sEAA+E,CAAC;AAEjH,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,wCAAwC,CAAC;AAEhE;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0EjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiD1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vault/credentials/unarchive/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
/** Trust Task type URI. */
|
|
6
|
+
export const TYPE_URI = "https://trusttasks.org/spec/vault/credentials/unarchive/0.1";
|
|
7
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
8
|
+
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vault/credentials/unarchive/0.1#response";
|
|
9
|
+
/**
|
|
10
|
+
* This specification's payload schema, as a value.
|
|
11
|
+
*
|
|
12
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
13
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
14
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
15
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
16
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
17
|
+
*/
|
|
18
|
+
export const PAYLOAD_SCHEMA = {
|
|
19
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
20
|
+
"$id": "https://trusttasks.org/spec/vault/credentials/unarchive/0.1",
|
|
21
|
+
"title": "Vault Credentials — Unarchive",
|
|
22
|
+
"description": "Return an archived credential to the active state.",
|
|
23
|
+
"type": "object",
|
|
24
|
+
"additionalProperties": false,
|
|
25
|
+
"required": [
|
|
26
|
+
"id"
|
|
27
|
+
],
|
|
28
|
+
"properties": {
|
|
29
|
+
"id": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"minLength": 1,
|
|
32
|
+
"maxLength": 256,
|
|
33
|
+
"description": "Local handle from a query descriptor. Opaque; consumers must not derive or guess one."
|
|
34
|
+
},
|
|
35
|
+
"reason": {
|
|
36
|
+
"type": "string",
|
|
37
|
+
"minLength": 1,
|
|
38
|
+
"maxLength": 512,
|
|
39
|
+
"description": "Free text recorded with the transition. Must not carry credential contents."
|
|
40
|
+
},
|
|
41
|
+
"ext": {
|
|
42
|
+
"$ref": "#/$defs/Ext",
|
|
43
|
+
"description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"$defs": {
|
|
47
|
+
"Response": {
|
|
48
|
+
"$anchor": "response",
|
|
49
|
+
"title": "Vault Credentials Unarchive — response payload",
|
|
50
|
+
"type": "object",
|
|
51
|
+
"additionalProperties": false,
|
|
52
|
+
"required": [
|
|
53
|
+
"id",
|
|
54
|
+
"lifecycle"
|
|
55
|
+
],
|
|
56
|
+
"properties": {
|
|
57
|
+
"id": {
|
|
58
|
+
"type": "string",
|
|
59
|
+
"minLength": 1,
|
|
60
|
+
"maxLength": 256
|
|
61
|
+
},
|
|
62
|
+
"lifecycle": {
|
|
63
|
+
"$ref": "#/$defs/VaultLifecycle",
|
|
64
|
+
"description": "State after the transition, echoed rather than left to be inferred from the verb."
|
|
65
|
+
},
|
|
66
|
+
"ext": {
|
|
67
|
+
"$ref": "#/$defs/Ext",
|
|
68
|
+
"description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"VaultLifecycle": {
|
|
73
|
+
"type": "string",
|
|
74
|
+
"enum": [
|
|
75
|
+
"active",
|
|
76
|
+
"archived",
|
|
77
|
+
"deleted"
|
|
78
|
+
],
|
|
79
|
+
"description": "Archival state. Orthogonal to validity."
|
|
80
|
+
},
|
|
81
|
+
"Ext": {
|
|
82
|
+
"title": "Ext",
|
|
83
|
+
"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.",
|
|
84
|
+
"type": "object",
|
|
85
|
+
"minProperties": 1,
|
|
86
|
+
"additionalProperties": true,
|
|
87
|
+
"propertyNames": {
|
|
88
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
};
|
|
93
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
94
|
+
export const RESPONSE_PAYLOAD_SCHEMA = {
|
|
95
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
96
|
+
"$ref": "#/$defs/Response",
|
|
97
|
+
"$defs": {
|
|
98
|
+
"Response": {
|
|
99
|
+
"$anchor": "response",
|
|
100
|
+
"title": "Vault Credentials Unarchive — response payload",
|
|
101
|
+
"type": "object",
|
|
102
|
+
"additionalProperties": false,
|
|
103
|
+
"required": [
|
|
104
|
+
"id",
|
|
105
|
+
"lifecycle"
|
|
106
|
+
],
|
|
107
|
+
"properties": {
|
|
108
|
+
"id": {
|
|
109
|
+
"type": "string",
|
|
110
|
+
"minLength": 1,
|
|
111
|
+
"maxLength": 256
|
|
112
|
+
},
|
|
113
|
+
"lifecycle": {
|
|
114
|
+
"$ref": "#/$defs/VaultLifecycle",
|
|
115
|
+
"description": "State after the transition, echoed rather than left to be inferred from the verb."
|
|
116
|
+
},
|
|
117
|
+
"ext": {
|
|
118
|
+
"$ref": "#/$defs/Ext",
|
|
119
|
+
"description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
},
|
|
123
|
+
"VaultLifecycle": {
|
|
124
|
+
"type": "string",
|
|
125
|
+
"enum": [
|
|
126
|
+
"active",
|
|
127
|
+
"archived",
|
|
128
|
+
"deleted"
|
|
129
|
+
],
|
|
130
|
+
"description": "Archival state. Orthogonal to validity."
|
|
131
|
+
},
|
|
132
|
+
"Ext": {
|
|
133
|
+
"title": "Ext",
|
|
134
|
+
"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.",
|
|
135
|
+
"type": "object",
|
|
136
|
+
"minProperties": 1,
|
|
137
|
+
"additionalProperties": true,
|
|
138
|
+
"propertyNames": {
|
|
139
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
146
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
147
|
+
* per-specification and cannot be derived from the document alone, and
|
|
148
|
+
* item 2 needs the schema this carries.
|
|
149
|
+
*/
|
|
150
|
+
export const SPEC = {
|
|
151
|
+
typeUri: TYPE_URI,
|
|
152
|
+
isBearer: false,
|
|
153
|
+
isProofRequired: true,
|
|
154
|
+
isRecipientRequired: true,
|
|
155
|
+
isIssuedAtRequired: true,
|
|
156
|
+
payloadSchema: PAYLOAD_SCHEMA,
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
160
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
161
|
+
* parties (§7.3 item 5).
|
|
162
|
+
*/
|
|
163
|
+
export const RESPONSE_SPEC = {
|
|
164
|
+
typeUri: RESPONSE_TYPE_URI,
|
|
165
|
+
isBearer: false,
|
|
166
|
+
isProofRequired: true,
|
|
167
|
+
isRecipientRequired: true,
|
|
168
|
+
isIssuedAtRequired: true,
|
|
169
|
+
payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
|
|
170
|
+
};
|
|
171
|
+
//# sourceMappingURL=payload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vault/credentials/unarchive/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAqCH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,6DAAsE,CAAC;AAK/F,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,sEAA+E,CAAC;AAKjH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,6DAA6D;IACpE,OAAO,EAAE,+BAA+B;IACxC,aAAa,EAAE,oDAAoD;IACnE,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,IAAI;KACL;IACD,YAAY,EAAE;QACZ,IAAI,EAAE;YACJ,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,uFAAuF;SACvG;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,6EAA6E;SAC7F;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,yDAAyD;SACzE;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,gDAAgD;YACzD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,IAAI;gBACJ,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE;oBACJ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;iBACjB;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,wBAAwB;oBAChC,aAAa,EAAE,mFAAmF;iBACnG;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,yDAAyD;iBACzE;aACF;SACF;QACD,gBAAgB,EAAE;YAChB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,QAAQ;gBACR,UAAU;gBACV,SAAS;aACV;YACD,aAAa,EAAE,yCAAyC;SACzD;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,gDAAgD;YACzD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,IAAI;gBACJ,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE;oBACJ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;iBACjB;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,wBAAwB;oBAChC,aAAa,EAAE,mFAAmF;iBACnG;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,yDAAyD;iBACzE;aACF;SACF;QACD,gBAAgB,EAAE;YAChB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,QAAQ;gBACR,UAAU;gBACV,SAAS;aACV;YACD,aAAa,EAAE,yCAAyC;SACzD;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}
|