@openvtc/trust-tasks 0.16.7 → 0.16.9

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.
Files changed (90) hide show
  1. package/CHANGELOG.md +144 -0
  2. package/dist/_shared/components.d.ts +2 -2
  3. package/dist/_shared/components.d.ts.map +1 -1
  4. package/dist/device/list/0.1/payload.d.ts +4 -4
  5. package/dist/device/list/0.1/payload.d.ts.map +1 -1
  6. package/dist/device/list/0.1/payload.js +6 -2
  7. package/dist/device/list/0.1/payload.js.map +1 -1
  8. package/dist/device/list/0.2/payload.d.ts +4 -4
  9. package/dist/device/list/0.2/payload.d.ts.map +1 -1
  10. package/dist/device/list/0.2/payload.js +6 -2
  11. package/dist/device/list/0.2/payload.js.map +1 -1
  12. package/dist/device/register/0.1/payload.d.ts +4 -4
  13. package/dist/device/register/0.1/payload.d.ts.map +1 -1
  14. package/dist/device/register/0.1/payload.js +6 -2
  15. package/dist/device/register/0.1/payload.js.map +1 -1
  16. package/dist/device/register/0.2/payload.d.ts +4 -4
  17. package/dist/device/register/0.2/payload.d.ts.map +1 -1
  18. package/dist/device/register/0.2/payload.js +6 -2
  19. package/dist/device/register/0.2/payload.js.map +1 -1
  20. package/dist/index.d.ts +12 -0
  21. package/dist/index.d.ts.map +1 -1
  22. package/dist/index.js +12 -0
  23. package/dist/index.js.map +1 -1
  24. package/dist/rooms/keys/commit/0.1/payload.d.ts +266 -0
  25. package/dist/rooms/keys/commit/0.1/payload.d.ts.map +1 -0
  26. package/dist/rooms/keys/commit/0.1/payload.js +146 -0
  27. package/dist/rooms/keys/commit/0.1/payload.js.map +1 -0
  28. package/dist/rooms/keys/key-package/0.1/payload.d.ts +272 -0
  29. package/dist/rooms/keys/key-package/0.1/payload.d.ts.map +1 -0
  30. package/dist/rooms/keys/key-package/0.1/payload.js +147 -0
  31. package/dist/rooms/keys/key-package/0.1/payload.js.map +1 -0
  32. package/dist/rooms/keys/open/0.1/payload.d.ts +323 -0
  33. package/dist/rooms/keys/open/0.1/payload.d.ts.map +1 -0
  34. package/dist/rooms/keys/open/0.1/payload.js +171 -0
  35. package/dist/rooms/keys/open/0.1/payload.js.map +1 -0
  36. package/dist/rooms/keys/present/0.1/payload.d.ts +306 -0
  37. package/dist/rooms/keys/present/0.1/payload.d.ts.map +1 -0
  38. package/dist/rooms/keys/present/0.1/payload.js +165 -0
  39. package/dist/rooms/keys/present/0.1/payload.js.map +1 -0
  40. package/dist/rooms/keys/welcome/0.1/payload.d.ts +276 -0
  41. package/dist/rooms/keys/welcome/0.1/payload.d.ts.map +1 -0
  42. package/dist/rooms/keys/welcome/0.1/payload.js +148 -0
  43. package/dist/rooms/keys/welcome/0.1/payload.js.map +1 -0
  44. package/dist/rooms/records/curate/0.1/payload.d.ts +500 -0
  45. package/dist/rooms/records/curate/0.1/payload.d.ts.map +1 -0
  46. package/dist/rooms/records/curate/0.1/payload.js +277 -0
  47. package/dist/rooms/records/curate/0.1/payload.js.map +1 -0
  48. package/dist/vta/backup/abort/1.0/payload.d.ts +262 -0
  49. package/dist/vta/backup/abort/1.0/payload.d.ts.map +1 -0
  50. package/dist/vta/backup/abort/1.0/payload.js +146 -0
  51. package/dist/vta/backup/abort/1.0/payload.js.map +1 -0
  52. package/dist/vta/backup/complete-export/1.0/payload.d.ts +262 -0
  53. package/dist/vta/backup/complete-export/1.0/payload.d.ts.map +1 -0
  54. package/dist/vta/backup/complete-export/1.0/payload.js +146 -0
  55. package/dist/vta/backup/complete-export/1.0/payload.js.map +1 -0
  56. package/dist/vta/backup/finalize-import/1.0/payload.d.ts +477 -0
  57. package/dist/vta/backup/finalize-import/1.0/payload.d.ts.map +1 -0
  58. package/dist/vta/backup/finalize-import/1.0/payload.js +249 -0
  59. package/dist/vta/backup/finalize-import/1.0/payload.js.map +1 -0
  60. package/dist/vta/backup/initiate-export/1.0/payload.d.ts +514 -0
  61. package/dist/vta/backup/initiate-export/1.0/payload.d.ts.map +1 -0
  62. package/dist/vta/backup/initiate-export/1.0/payload.js +267 -0
  63. package/dist/vta/backup/initiate-export/1.0/payload.js.map +1 -0
  64. package/dist/vta/backup/initiate-import/1.0/payload.d.ts +510 -0
  65. package/dist/vta/backup/initiate-import/1.0/payload.d.ts.map +1 -0
  66. package/dist/vta/backup/initiate-import/1.0/payload.js +266 -0
  67. package/dist/vta/backup/initiate-import/1.0/payload.js.map +1 -0
  68. package/dist/vta/management/reload-services/1.0/payload.d.ts +230 -0
  69. package/dist/vta/management/reload-services/1.0/payload.d.ts.map +1 -0
  70. package/dist/vta/management/reload-services/1.0/payload.js +130 -0
  71. package/dist/vta/management/reload-services/1.0/payload.js.map +1 -0
  72. package/package.json +1 -1
  73. package/src/_shared/components.ts +6 -2
  74. package/src/device/list/0.1/payload.ts +6 -2
  75. package/src/device/list/0.2/payload.ts +6 -2
  76. package/src/device/register/0.1/payload.ts +6 -2
  77. package/src/device/register/0.2/payload.ts +6 -2
  78. package/src/index.ts +12 -0
  79. package/src/rooms/keys/commit/0.1/payload.ts +195 -0
  80. package/src/rooms/keys/key-package/0.1/payload.ts +196 -0
  81. package/src/rooms/keys/open/0.1/payload.ts +237 -0
  82. package/src/rooms/keys/present/0.1/payload.ts +224 -0
  83. package/src/rooms/keys/welcome/0.1/payload.ts +201 -0
  84. package/src/rooms/records/curate/0.1/payload.ts +357 -0
  85. package/src/vta/backup/abort/1.0/payload.ts +191 -0
  86. package/src/vta/backup/complete-export/1.0/payload.ts +191 -0
  87. package/src/vta/backup/finalize-import/1.0/payload.ts +333 -0
  88. package/src/vta/backup/initiate-export/1.0/payload.ts +350 -0
  89. package/src/vta/backup/initiate-import/1.0/payload.ts +349 -0
  90. package/src/vta/management/reload-services/1.0/payload.ts +167 -0
@@ -0,0 +1,477 @@
1
+ /**
2
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
3
+ * Source: specs/vta/backup/finalize-import/1.0/payload.schema.json
4
+ */
5
+ import type { Ext } from "../../../../_shared/components.js";
6
+ /**
7
+ * Supplies the password for an uploaded bundle and asks the recipient to decrypt it and adopt what is inside, or to rehearse that without committing. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
8
+ */
9
+ export interface VTABackupFinalizeImportPayload {
10
+ /**
11
+ * Handle from the initiate-import descriptor. Opaque: a producer quotes what it was given and must not derive, guess or enumerate one.
12
+ */
13
+ bundleId: string;
14
+ /**
15
+ * Key-derivation input that unlocks the bundle. Supplied here rather than at initiate-import so the key never travels alongside the slot holding the ciphertext. `writeOnly` is the machine-readable form of the rule in Data carried: this member goes in and never comes back, so a generated client must not surface it in a response type, and a recipient must never log, echo or persist it.
16
+ */
17
+ password: string;
18
+ /**
19
+ * True commits and replaces the agent's state; false rehearses and mutates nothing. Absent means true — stated in prose rather than as a schema `default` on purpose, because a materialised default makes an omitted member indistinguishable from a deliberate one, and this is the member separating a rehearsal from an irreversible replacement. See Defaulting.
20
+ */
21
+ confirm?: boolean;
22
+ /**
23
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
24
+ */
25
+ ext?: Ext;
26
+ }
27
+ /**
28
+ * Counts and a status, never contents. This document is the operator-held record of a replacement the agent's own trail no longer describes.
29
+ */
30
+ export interface VTABackupFinalizeImportResponsePayload {
31
+ /**
32
+ * Echoed so the response stands alone as a record.
33
+ */
34
+ bundleId: string;
35
+ /**
36
+ * Which the recipient did. Reported rather than left to be inferred from the request, so that a response is complete evidence on its own: `committed` says the agent was replaced, `preview` says it was not.
37
+ */
38
+ status: "preview" | "committed";
39
+ /**
40
+ * Identifier of the agent the bundle was exported from. The one identifier a preview returns, because the common import error is a valid bundle from the wrong agent and this is what shows it. Absent where the bundle does not record one.
41
+ */
42
+ sourceDid?: string;
43
+ /**
44
+ * How many keys the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.
45
+ */
46
+ keyCount: number;
47
+ /**
48
+ * How many access-control entries the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.
49
+ */
50
+ aclCount: number;
51
+ /**
52
+ * How many trust contexts the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.
53
+ */
54
+ contextCount: number;
55
+ /**
56
+ * How many audit entries the bundle holds. Zero for a bundle exported without its trail, which is a legitimate outcome and not a sign of a truncated bundle.
57
+ */
58
+ auditCount: number;
59
+ /**
60
+ * How many secrets the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.
61
+ */
62
+ importedSecretCount?: number;
63
+ /**
64
+ * Operator-facing text elaborating on the outcome. Advisory: a producer must not parse it or derive behaviour from it, and a recipient must not put bundle contents or a secret in it.
65
+ */
66
+ message?: string;
67
+ /**
68
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
69
+ */
70
+ ext?: Ext;
71
+ }
72
+ /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
73
+ export type { Ext };
74
+ /** Trust Task type URI. */
75
+ export declare const TYPE_URI: "https://trusttasks.org/spec/vta/backup/finalize-import/1.0";
76
+ /** Stable alias for this specification's request payload shape. */
77
+ export type Payload = VTABackupFinalizeImportPayload;
78
+ /** Trust Task response type URI (request type URI + "#response"). */
79
+ export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/backup/finalize-import/1.0#response";
80
+ /** Stable alias for this specification's success-response payload shape. */
81
+ export type Response = VTABackupFinalizeImportResponsePayload;
82
+ /**
83
+ * This specification's payload schema, as a value.
84
+ *
85
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
86
+ * rather than only as a `.json` file because TypeScript types are erased
87
+ * at runtime: without a schema a consumer has nothing to validate, and
88
+ * every REQUIRED payload member is optional in practice. Cross-file
89
+ * `$ref`s are already inlined, so it needs no resolver.
90
+ */
91
+ export declare const PAYLOAD_SCHEMA: {
92
+ readonly $schema: "https://json-schema.org/draft/2020-12/schema";
93
+ readonly $id: "https://trusttasks.org/spec/vta/backup/finalize-import/1.0";
94
+ readonly title: "VTA Backup — Finalize Import — payload";
95
+ readonly description: "Supplies the password for an uploaded bundle and asks the recipient to decrypt it and adopt what is inside, or to rehearse that without committing. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
96
+ readonly type: "object";
97
+ readonly additionalProperties: false;
98
+ readonly required: readonly ["bundleId", "password"];
99
+ readonly properties: {
100
+ readonly bundleId: {
101
+ readonly type: "string";
102
+ readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
103
+ readonly description: "Handle from the initiate-import descriptor. Opaque: a producer quotes what it was given and must not derive, guess or enumerate one.";
104
+ };
105
+ readonly password: {
106
+ readonly type: "string";
107
+ readonly minLength: 15;
108
+ readonly maxLength: 1024;
109
+ readonly writeOnly: true;
110
+ readonly description: "Key-derivation input that unlocks the bundle. Supplied here rather than at initiate-import so the key never travels alongside the slot holding the ciphertext. `writeOnly` is the machine-readable form of the rule in Data carried: this member goes in and never comes back, so a generated client must not surface it in a response type, and a recipient must never log, echo or persist it.";
111
+ readonly $comment: "No example value anywhere in this directory: a specimen password is the one thing implementers copy. minLength mirrors the export floor so a bundle that could be created can be read back.";
112
+ };
113
+ readonly confirm: {
114
+ readonly type: "boolean";
115
+ readonly description: "True commits and replaces the agent's state; false rehearses and mutates nothing. Absent means true — stated in prose rather than as a schema `default` on purpose, because a materialised default makes an omitted member indistinguishable from a deliberate one, and this is the member separating a rehearsal from an irreversible replacement. See Defaulting.";
116
+ };
117
+ readonly ext: {
118
+ readonly $ref: "#/$defs/Ext";
119
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
120
+ };
121
+ };
122
+ readonly $defs: {
123
+ readonly Response: {
124
+ readonly $anchor: "response";
125
+ readonly title: "VTA Backup Finalize Import — response payload";
126
+ readonly type: "object";
127
+ readonly additionalProperties: false;
128
+ readonly description: "Counts and a status, never contents. This document is the operator-held record of a replacement the agent's own trail no longer describes.";
129
+ readonly required: readonly ["bundleId", "status", "keyCount", "aclCount", "contextCount", "auditCount"];
130
+ readonly properties: {
131
+ readonly bundleId: {
132
+ readonly type: "string";
133
+ readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
134
+ readonly description: "Echoed so the response stands alone as a record.";
135
+ };
136
+ readonly status: {
137
+ readonly type: "string";
138
+ readonly enum: readonly ["preview", "committed"];
139
+ readonly description: "Which the recipient did. Reported rather than left to be inferred from the request, so that a response is complete evidence on its own: `committed` says the agent was replaced, `preview` says it was not.";
140
+ };
141
+ readonly sourceDid: {
142
+ readonly type: "string";
143
+ readonly minLength: 1;
144
+ readonly maxLength: 2048;
145
+ readonly description: "Identifier of the agent the bundle was exported from. The one identifier a preview returns, because the common import error is a valid bundle from the wrong agent and this is what shows it. Absent where the bundle does not record one.";
146
+ };
147
+ readonly keyCount: {
148
+ readonly type: "integer";
149
+ readonly minimum: 0;
150
+ readonly description: "How many keys the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
151
+ };
152
+ readonly aclCount: {
153
+ readonly type: "integer";
154
+ readonly minimum: 0;
155
+ readonly description: "How many access-control entries the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
156
+ };
157
+ readonly contextCount: {
158
+ readonly type: "integer";
159
+ readonly minimum: 0;
160
+ readonly description: "How many trust contexts the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
161
+ };
162
+ readonly auditCount: {
163
+ readonly type: "integer";
164
+ readonly minimum: 0;
165
+ readonly description: "How many audit entries the bundle holds. Zero for a bundle exported without its trail, which is a legitimate outcome and not a sign of a truncated bundle.";
166
+ };
167
+ readonly importedSecretCount: {
168
+ readonly type: "integer";
169
+ readonly minimum: 0;
170
+ readonly description: "How many secrets the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
171
+ };
172
+ readonly message: {
173
+ readonly type: "string";
174
+ readonly maxLength: 1024;
175
+ readonly description: "Operator-facing text elaborating on the outcome. Advisory: a producer must not parse it or derive behaviour from it, and a recipient must not put bundle contents or a secret in it.";
176
+ };
177
+ readonly ext: {
178
+ readonly $ref: "#/$defs/Ext";
179
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
180
+ };
181
+ };
182
+ };
183
+ readonly Ext: {
184
+ readonly title: "Ext";
185
+ 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.";
186
+ readonly type: "object";
187
+ readonly minProperties: 1;
188
+ readonly additionalProperties: true;
189
+ readonly propertyNames: {
190
+ readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
191
+ };
192
+ };
193
+ };
194
+ };
195
+ /** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
196
+ export declare const RESPONSE_PAYLOAD_SCHEMA: {
197
+ readonly $schema: "https://json-schema.org/draft/2020-12/schema";
198
+ readonly $ref: "#/$defs/Response";
199
+ readonly $defs: {
200
+ readonly Response: {
201
+ readonly $anchor: "response";
202
+ readonly title: "VTA Backup Finalize Import — response payload";
203
+ readonly type: "object";
204
+ readonly additionalProperties: false;
205
+ readonly description: "Counts and a status, never contents. This document is the operator-held record of a replacement the agent's own trail no longer describes.";
206
+ readonly required: readonly ["bundleId", "status", "keyCount", "aclCount", "contextCount", "auditCount"];
207
+ readonly properties: {
208
+ readonly bundleId: {
209
+ readonly type: "string";
210
+ readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
211
+ readonly description: "Echoed so the response stands alone as a record.";
212
+ };
213
+ readonly status: {
214
+ readonly type: "string";
215
+ readonly enum: readonly ["preview", "committed"];
216
+ readonly description: "Which the recipient did. Reported rather than left to be inferred from the request, so that a response is complete evidence on its own: `committed` says the agent was replaced, `preview` says it was not.";
217
+ };
218
+ readonly sourceDid: {
219
+ readonly type: "string";
220
+ readonly minLength: 1;
221
+ readonly maxLength: 2048;
222
+ readonly description: "Identifier of the agent the bundle was exported from. The one identifier a preview returns, because the common import error is a valid bundle from the wrong agent and this is what shows it. Absent where the bundle does not record one.";
223
+ };
224
+ readonly keyCount: {
225
+ readonly type: "integer";
226
+ readonly minimum: 0;
227
+ readonly description: "How many keys the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
228
+ };
229
+ readonly aclCount: {
230
+ readonly type: "integer";
231
+ readonly minimum: 0;
232
+ readonly description: "How many access-control entries the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
233
+ };
234
+ readonly contextCount: {
235
+ readonly type: "integer";
236
+ readonly minimum: 0;
237
+ readonly description: "How many trust contexts the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
238
+ };
239
+ readonly auditCount: {
240
+ readonly type: "integer";
241
+ readonly minimum: 0;
242
+ readonly description: "How many audit entries the bundle holds. Zero for a bundle exported without its trail, which is a legitimate outcome and not a sign of a truncated bundle.";
243
+ };
244
+ readonly importedSecretCount: {
245
+ readonly type: "integer";
246
+ readonly minimum: 0;
247
+ readonly description: "How many secrets the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
248
+ };
249
+ readonly message: {
250
+ readonly type: "string";
251
+ readonly maxLength: 1024;
252
+ readonly description: "Operator-facing text elaborating on the outcome. Advisory: a producer must not parse it or derive behaviour from it, and a recipient must not put bundle contents or a secret in it.";
253
+ };
254
+ readonly ext: {
255
+ readonly $ref: "#/$defs/Ext";
256
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
257
+ };
258
+ };
259
+ };
260
+ readonly Ext: {
261
+ readonly title: "Ext";
262
+ 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.";
263
+ readonly type: "object";
264
+ readonly minProperties: 1;
265
+ readonly additionalProperties: true;
266
+ readonly propertyNames: {
267
+ readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
268
+ };
269
+ };
270
+ };
271
+ };
272
+ /**
273
+ * SPEC.md §7.2 policy for the request variant, from this specification's
274
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
275
+ * per-specification and cannot be derived from the document alone, and
276
+ * item 2 needs the schema this carries.
277
+ */
278
+ export declare const SPEC: {
279
+ readonly typeUri: "https://trusttasks.org/spec/vta/backup/finalize-import/1.0";
280
+ readonly isBearer: false;
281
+ readonly isProofRequired: true;
282
+ readonly isRecipientRequired: true;
283
+ readonly isIssuedAtRequired: true;
284
+ readonly payloadSchema: {
285
+ readonly $schema: "https://json-schema.org/draft/2020-12/schema";
286
+ readonly $id: "https://trusttasks.org/spec/vta/backup/finalize-import/1.0";
287
+ readonly title: "VTA Backup — Finalize Import — payload";
288
+ readonly description: "Supplies the password for an uploaded bundle and asks the recipient to decrypt it and adopt what is inside, or to rehearse that without committing. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
289
+ readonly type: "object";
290
+ readonly additionalProperties: false;
291
+ readonly required: readonly ["bundleId", "password"];
292
+ readonly properties: {
293
+ readonly bundleId: {
294
+ readonly type: "string";
295
+ readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
296
+ readonly description: "Handle from the initiate-import descriptor. Opaque: a producer quotes what it was given and must not derive, guess or enumerate one.";
297
+ };
298
+ readonly password: {
299
+ readonly type: "string";
300
+ readonly minLength: 15;
301
+ readonly maxLength: 1024;
302
+ readonly writeOnly: true;
303
+ readonly description: "Key-derivation input that unlocks the bundle. Supplied here rather than at initiate-import so the key never travels alongside the slot holding the ciphertext. `writeOnly` is the machine-readable form of the rule in Data carried: this member goes in and never comes back, so a generated client must not surface it in a response type, and a recipient must never log, echo or persist it.";
304
+ readonly $comment: "No example value anywhere in this directory: a specimen password is the one thing implementers copy. minLength mirrors the export floor so a bundle that could be created can be read back.";
305
+ };
306
+ readonly confirm: {
307
+ readonly type: "boolean";
308
+ readonly description: "True commits and replaces the agent's state; false rehearses and mutates nothing. Absent means true — stated in prose rather than as a schema `default` on purpose, because a materialised default makes an omitted member indistinguishable from a deliberate one, and this is the member separating a rehearsal from an irreversible replacement. See Defaulting.";
309
+ };
310
+ readonly ext: {
311
+ readonly $ref: "#/$defs/Ext";
312
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
313
+ };
314
+ };
315
+ readonly $defs: {
316
+ readonly Response: {
317
+ readonly $anchor: "response";
318
+ readonly title: "VTA Backup Finalize Import — response payload";
319
+ readonly type: "object";
320
+ readonly additionalProperties: false;
321
+ readonly description: "Counts and a status, never contents. This document is the operator-held record of a replacement the agent's own trail no longer describes.";
322
+ readonly required: readonly ["bundleId", "status", "keyCount", "aclCount", "contextCount", "auditCount"];
323
+ readonly properties: {
324
+ readonly bundleId: {
325
+ readonly type: "string";
326
+ readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
327
+ readonly description: "Echoed so the response stands alone as a record.";
328
+ };
329
+ readonly status: {
330
+ readonly type: "string";
331
+ readonly enum: readonly ["preview", "committed"];
332
+ readonly description: "Which the recipient did. Reported rather than left to be inferred from the request, so that a response is complete evidence on its own: `committed` says the agent was replaced, `preview` says it was not.";
333
+ };
334
+ readonly sourceDid: {
335
+ readonly type: "string";
336
+ readonly minLength: 1;
337
+ readonly maxLength: 2048;
338
+ readonly description: "Identifier of the agent the bundle was exported from. The one identifier a preview returns, because the common import error is a valid bundle from the wrong agent and this is what shows it. Absent where the bundle does not record one.";
339
+ };
340
+ readonly keyCount: {
341
+ readonly type: "integer";
342
+ readonly minimum: 0;
343
+ readonly description: "How many keys the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
344
+ };
345
+ readonly aclCount: {
346
+ readonly type: "integer";
347
+ readonly minimum: 0;
348
+ readonly description: "How many access-control entries the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
349
+ };
350
+ readonly contextCount: {
351
+ readonly type: "integer";
352
+ readonly minimum: 0;
353
+ readonly description: "How many trust contexts the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
354
+ };
355
+ readonly auditCount: {
356
+ readonly type: "integer";
357
+ readonly minimum: 0;
358
+ readonly description: "How many audit entries the bundle holds. Zero for a bundle exported without its trail, which is a legitimate outcome and not a sign of a truncated bundle.";
359
+ };
360
+ readonly importedSecretCount: {
361
+ readonly type: "integer";
362
+ readonly minimum: 0;
363
+ readonly description: "How many secrets the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
364
+ };
365
+ readonly message: {
366
+ readonly type: "string";
367
+ readonly maxLength: 1024;
368
+ readonly description: "Operator-facing text elaborating on the outcome. Advisory: a producer must not parse it or derive behaviour from it, and a recipient must not put bundle contents or a secret in it.";
369
+ };
370
+ readonly ext: {
371
+ readonly $ref: "#/$defs/Ext";
372
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
373
+ };
374
+ };
375
+ };
376
+ readonly Ext: {
377
+ readonly title: "Ext";
378
+ 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.";
379
+ readonly type: "object";
380
+ readonly minProperties: 1;
381
+ readonly additionalProperties: true;
382
+ readonly propertyNames: {
383
+ readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
384
+ };
385
+ };
386
+ };
387
+ };
388
+ };
389
+ /**
390
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
391
+ * tracks the *issuer* party's requirement because a response swaps the
392
+ * parties (§7.3 item 5).
393
+ */
394
+ export declare const RESPONSE_SPEC: {
395
+ readonly typeUri: "https://trusttasks.org/spec/vta/backup/finalize-import/1.0#response";
396
+ readonly isBearer: false;
397
+ readonly isProofRequired: true;
398
+ readonly isRecipientRequired: true;
399
+ readonly isIssuedAtRequired: true;
400
+ readonly payloadSchema: {
401
+ readonly $schema: "https://json-schema.org/draft/2020-12/schema";
402
+ readonly $ref: "#/$defs/Response";
403
+ readonly $defs: {
404
+ readonly Response: {
405
+ readonly $anchor: "response";
406
+ readonly title: "VTA Backup Finalize Import — response payload";
407
+ readonly type: "object";
408
+ readonly additionalProperties: false;
409
+ readonly description: "Counts and a status, never contents. This document is the operator-held record of a replacement the agent's own trail no longer describes.";
410
+ readonly required: readonly ["bundleId", "status", "keyCount", "aclCount", "contextCount", "auditCount"];
411
+ readonly properties: {
412
+ readonly bundleId: {
413
+ readonly type: "string";
414
+ readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
415
+ readonly description: "Echoed so the response stands alone as a record.";
416
+ };
417
+ readonly status: {
418
+ readonly type: "string";
419
+ readonly enum: readonly ["preview", "committed"];
420
+ readonly description: "Which the recipient did. Reported rather than left to be inferred from the request, so that a response is complete evidence on its own: `committed` says the agent was replaced, `preview` says it was not.";
421
+ };
422
+ readonly sourceDid: {
423
+ readonly type: "string";
424
+ readonly minLength: 1;
425
+ readonly maxLength: 2048;
426
+ readonly description: "Identifier of the agent the bundle was exported from. The one identifier a preview returns, because the common import error is a valid bundle from the wrong agent and this is what shows it. Absent where the bundle does not record one.";
427
+ };
428
+ readonly keyCount: {
429
+ readonly type: "integer";
430
+ readonly minimum: 0;
431
+ readonly description: "How many keys the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
432
+ };
433
+ readonly aclCount: {
434
+ readonly type: "integer";
435
+ readonly minimum: 0;
436
+ readonly description: "How many access-control entries the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
437
+ };
438
+ readonly contextCount: {
439
+ readonly type: "integer";
440
+ readonly minimum: 0;
441
+ readonly description: "How many trust contexts the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
442
+ };
443
+ readonly auditCount: {
444
+ readonly type: "integer";
445
+ readonly minimum: 0;
446
+ readonly description: "How many audit entries the bundle holds. Zero for a bundle exported without its trail, which is a legitimate outcome and not a sign of a truncated bundle.";
447
+ };
448
+ readonly importedSecretCount: {
449
+ readonly type: "integer";
450
+ readonly minimum: 0;
451
+ readonly description: "How many secrets the bundle holds. A count, not an inventory — enough to recognise a bundle as plausibly the right one, and not enough to learn what is in it.";
452
+ };
453
+ readonly message: {
454
+ readonly type: "string";
455
+ readonly maxLength: 1024;
456
+ readonly description: "Operator-facing text elaborating on the outcome. Advisory: a producer must not parse it or derive behaviour from it, and a recipient must not put bundle contents or a secret in it.";
457
+ };
458
+ readonly ext: {
459
+ readonly $ref: "#/$defs/Ext";
460
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
461
+ };
462
+ };
463
+ };
464
+ readonly Ext: {
465
+ readonly title: "Ext";
466
+ 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.";
467
+ readonly type: "object";
468
+ readonly minProperties: 1;
469
+ readonly additionalProperties: true;
470
+ readonly propertyNames: {
471
+ readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
472
+ };
473
+ };
474
+ };
475
+ };
476
+ };
477
+ //# sourceMappingURL=payload.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vta/backup/finalize-import/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAG7D;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,CAAC;AAEpB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,4DAAqE,CAAC;AAE9F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,8BAA8B,CAAC;AAErD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,qEAA8E,CAAC;AAEhH,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,sCAAsC,CAAC;AAE9D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqF1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}