@openvtc/trust-tasks 0.28.19 → 0.28.21

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 (78) hide show
  1. package/CHANGELOG.md +71 -0
  2. package/dist/_shared/components.d.ts +16 -1
  3. package/dist/_shared/components.d.ts.map +1 -1
  4. package/dist/auth/step-up/requests/show/0.1/payload.d.ts +458 -0
  5. package/dist/auth/step-up/requests/show/0.1/payload.d.ts.map +1 -0
  6. package/dist/auth/step-up/requests/show/0.1/payload.js +261 -0
  7. package/dist/auth/step-up/requests/show/0.1/payload.js.map +1 -0
  8. package/dist/index.d.ts +9 -0
  9. package/dist/index.d.ts.map +1 -1
  10. package/dist/index.js +9 -0
  11. package/dist/index.js.map +1 -1
  12. package/dist/vtc/badges/_shared/0.1/badge.d.ts +1 -1
  13. package/dist/vtc/badges/_shared/0.1/badge.d.ts.map +1 -1
  14. package/dist/vtc/badges/awards/list/0.1/payload.d.ts +118 -6
  15. package/dist/vtc/badges/awards/list/0.1/payload.d.ts.map +1 -1
  16. package/dist/vtc/badges/awards/list/0.1/payload.js +64 -2
  17. package/dist/vtc/badges/awards/list/0.1/payload.js.map +1 -1
  18. package/dist/vtc/badges/awards/offer/0.1/payload.d.ts +118 -6
  19. package/dist/vtc/badges/awards/offer/0.1/payload.d.ts.map +1 -1
  20. package/dist/vtc/badges/awards/offer/0.1/payload.js +64 -2
  21. package/dist/vtc/badges/awards/offer/0.1/payload.js.map +1 -1
  22. package/dist/vtc/badges/awards/revoke/0.1/payload.d.ts +118 -6
  23. package/dist/vtc/badges/awards/revoke/0.1/payload.d.ts.map +1 -1
  24. package/dist/vtc/badges/awards/revoke/0.1/payload.js +64 -2
  25. package/dist/vtc/badges/awards/revoke/0.1/payload.js.map +1 -1
  26. package/dist/vtc/badges/awards/share/0.1/payload.d.ts +701 -0
  27. package/dist/vtc/badges/awards/share/0.1/payload.d.ts.map +1 -0
  28. package/dist/vtc/badges/awards/share/0.1/payload.js +406 -0
  29. package/dist/vtc/badges/awards/share/0.1/payload.js.map +1 -0
  30. package/dist/vtc/badges/awards/unshare/0.1/payload.d.ts +701 -0
  31. package/dist/vtc/badges/awards/unshare/0.1/payload.d.ts.map +1 -0
  32. package/dist/vtc/badges/awards/unshare/0.1/payload.js +406 -0
  33. package/dist/vtc/badges/awards/unshare/0.1/payload.js.map +1 -0
  34. package/dist/vtc/badges/awards/withdraw/0.1/payload.d.ts +118 -6
  35. package/dist/vtc/badges/awards/withdraw/0.1/payload.d.ts.map +1 -1
  36. package/dist/vtc/badges/awards/withdraw/0.1/payload.js +64 -2
  37. package/dist/vtc/badges/awards/withdraw/0.1/payload.js.map +1 -1
  38. package/dist/vtc/badges/kudos/give/0.1/payload.d.ts +118 -6
  39. package/dist/vtc/badges/kudos/give/0.1/payload.d.ts.map +1 -1
  40. package/dist/vtc/badges/kudos/give/0.1/payload.js +64 -2
  41. package/dist/vtc/badges/kudos/give/0.1/payload.js.map +1 -1
  42. package/dist/vtc/badges/kudos/list/0.1/payload.d.ts +118 -6
  43. package/dist/vtc/badges/kudos/list/0.1/payload.d.ts.map +1 -1
  44. package/dist/vtc/badges/kudos/list/0.1/payload.js +64 -2
  45. package/dist/vtc/badges/kudos/list/0.1/payload.js.map +1 -1
  46. package/dist/vtc/badges/mine/accept/0.1/payload.d.ts +118 -6
  47. package/dist/vtc/badges/mine/accept/0.1/payload.d.ts.map +1 -1
  48. package/dist/vtc/badges/mine/accept/0.1/payload.js +64 -2
  49. package/dist/vtc/badges/mine/accept/0.1/payload.js.map +1 -1
  50. package/dist/vtc/badges/mine/decline/0.1/payload.d.ts +118 -6
  51. package/dist/vtc/badges/mine/decline/0.1/payload.d.ts.map +1 -1
  52. package/dist/vtc/badges/mine/decline/0.1/payload.js +64 -2
  53. package/dist/vtc/badges/mine/decline/0.1/payload.js.map +1 -1
  54. package/dist/vtc/badges/mine/list/0.1/payload.d.ts +118 -6
  55. package/dist/vtc/badges/mine/list/0.1/payload.d.ts.map +1 -1
  56. package/dist/vtc/badges/mine/list/0.1/payload.js +64 -2
  57. package/dist/vtc/badges/mine/list/0.1/payload.js.map +1 -1
  58. package/dist/vtc/badges/show/0.1/payload.d.ts +472 -26
  59. package/dist/vtc/badges/show/0.1/payload.d.ts.map +1 -1
  60. package/dist/vtc/badges/show/0.1/payload.js +264 -12
  61. package/dist/vtc/badges/show/0.1/payload.js.map +1 -1
  62. package/package.json +1 -1
  63. package/src/_shared/components.ts +16 -1
  64. package/src/auth/step-up/requests/show/0.1/payload.ts +317 -0
  65. package/src/index.ts +9 -0
  66. package/src/vtc/badges/_shared/0.1/badge.ts +1 -1
  67. package/src/vtc/badges/awards/list/0.1/payload.ts +66 -4
  68. package/src/vtc/badges/awards/offer/0.1/payload.ts +66 -4
  69. package/src/vtc/badges/awards/revoke/0.1/payload.ts +66 -4
  70. package/src/vtc/badges/awards/share/0.1/payload.ts +446 -0
  71. package/src/vtc/badges/awards/unshare/0.1/payload.ts +446 -0
  72. package/src/vtc/badges/awards/withdraw/0.1/payload.ts +66 -4
  73. package/src/vtc/badges/kudos/give/0.1/payload.ts +66 -4
  74. package/src/vtc/badges/kudos/list/0.1/payload.ts +66 -4
  75. package/src/vtc/badges/mine/accept/0.1/payload.ts +66 -4
  76. package/src/vtc/badges/mine/decline/0.1/payload.ts +66 -4
  77. package/src/vtc/badges/mine/list/0.1/payload.ts +66 -4
  78. package/src/vtc/badges/show/0.1/payload.ts +272 -14
@@ -0,0 +1,317 @@
1
+ /**
2
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
3
+ * Source: specs/auth/step-up/requests/show/0.1/payload.schema.json
4
+ */
5
+
6
+ import type { Ext } from "../../../../../_shared/components.js";
7
+
8
+
9
+ /**
10
+ * A single-use reference to one pending step-up, minted by the relying party with at least 128 bits of entropy and carried as base64url without padding. It names the request; it is not the request's challenge, and knowing it authorizes nothing but this one read.
11
+ */
12
+ export type Handle = string;
13
+
14
+ /**
15
+ * The approver's agent asks the relying party for a pending step-up bound to one operation, named by the hand-off handle the relying party gave the operation's producer. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
16
+ */
17
+ export interface AuthStepUpRequestShowPayload {
18
+ handle: Handle;
19
+ ext?: Ext;
20
+ }
21
+ /**
22
+ * The pending step-up and the operation it is bound to. Failures use trust-task-error, not this shape.
23
+ */
24
+ export interface AuthStepUpRequestShowResponsePayload {
25
+ /**
26
+ * A complete auth/step-up/approve-request/0.5 Trust Task document, issued and signed by the relying party, whose recipient is the step-up's subject and whose payload is the request the operation's producer received inline — the same challenge, boundTo, accepts and approvers. The agent verifies it as a document in its own right — envelope, proof and payload against that specification's schema — over the members exactly as received: its proof covers every member, so it is deliberately an open object here rather than a typed one a binding could narrow.
27
+ */
28
+ request: {};
29
+ operation: Operation;
30
+ ext?: Ext;
31
+ }
32
+ /**
33
+ * The operation the step-up is bound to, exactly as the relying party received it.
34
+ */
35
+ export interface Operation {
36
+ /**
37
+ * The operation's Type URI, as the document the relying party refused named it.
38
+ */
39
+ type: string;
40
+ /**
41
+ * The operation's payload, member for member as received, so that the approver's agent can show it and — where it knows how the relying party derives `boundTo` — recompute the binding.
42
+ */
43
+ payload: {};
44
+ }
45
+
46
+ /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
47
+ export type { Ext };
48
+
49
+ /** Trust Task type URI. */
50
+ export const TYPE_URI = "https://trusttasks.org/spec/auth/step-up/requests/show/0.1" as const;
51
+
52
+ /**
53
+ * The earlier version of this specification that this one declares it
54
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
55
+ * `null`. Only the direct declaration — follow the chain with
56
+ * `extendsChain` / `readForSpec`.
57
+ */
58
+ export const EXTENDS: string | null = null;
59
+
60
+ /**
61
+ * Why this version is deprecated, or `null` while it is current. A
62
+ * superseded or retired version is still supported, and is withdrawn from
63
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
64
+ * Versions").
65
+ */
66
+ export const DEPRECATION: string | null = null;
67
+
68
+ /** Stable alias for this specification's request payload shape. */
69
+ export type Payload = AuthStepUpRequestShowPayload;
70
+
71
+ /** Trust Task response type URI (request type URI + "#response"). */
72
+ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/step-up/requests/show/0.1#response" as const;
73
+
74
+ /** Stable alias for this specification's success-response payload shape. */
75
+ export type Response = AuthStepUpRequestShowResponsePayload;
76
+
77
+ /**
78
+ * This specification's payload schema, as a value.
79
+ *
80
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
81
+ * rather than only as a `.json` file because TypeScript types are erased
82
+ * at runtime: without a schema a consumer has nothing to validate, and
83
+ * every REQUIRED payload member is optional in practice. Cross-file
84
+ * `$ref`s are already inlined, so it needs no resolver.
85
+ */
86
+ export const PAYLOAD_SCHEMA = {
87
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
88
+ "$id": "https://trusttasks.org/spec/auth/step-up/requests/show/0.1",
89
+ "title": "Auth — Step-up Request Show — payload",
90
+ "description": "The approver's agent asks the relying party for a pending step-up bound to one operation, named by the hand-off handle the relying party gave the operation's producer. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
91
+ "type": "object",
92
+ "additionalProperties": false,
93
+ "required": [
94
+ "handle"
95
+ ],
96
+ "properties": {
97
+ "handle": {
98
+ "$ref": "#/$defs/Handle"
99
+ },
100
+ "ext": {
101
+ "$ref": "#/$defs/Ext"
102
+ }
103
+ },
104
+ "$defs": {
105
+ "Handle": {
106
+ "title": "Handle",
107
+ "description": "A single-use reference to one pending step-up, minted by the relying party with at least 128 bits of entropy and carried as base64url without padding. It names the request; it is not the request's challenge, and knowing it authorizes nothing but this one read.",
108
+ "type": "string",
109
+ "pattern": "^[A-Za-z0-9_-]{22,86}$"
110
+ },
111
+ "Handoff": {
112
+ "title": "Handoff",
113
+ "description": "What a relying party MAY carry as `details.stepUpHandoff` beside an inline `details.stepUpRequest` (auth/step-up/approve-request/0.5, Inline delivery), so that a producer which cannot obtain the evidence itself can hand the step-up to the subject's approver agent. Not a payload of this task: defined here so producers and consumers share one shape.",
114
+ "type": "object",
115
+ "additionalProperties": false,
116
+ "required": [
117
+ "handle",
118
+ "expiresAt",
119
+ "show"
120
+ ],
121
+ "properties": {
122
+ "handle": {
123
+ "$ref": "#/$defs/Handle"
124
+ },
125
+ "expiresAt": {
126
+ "type": "string",
127
+ "format": "date-time",
128
+ "description": "The instant after which the relying party answers the handle with `notFound`: no later than the pending step-up's own expiry."
129
+ },
130
+ "show": {
131
+ "type": "string",
132
+ "const": "https://trusttasks.org/spec/auth/step-up/requests/show/0.1",
133
+ "description": "The Type URI the approver's agent sends with the handle."
134
+ }
135
+ }
136
+ },
137
+ "Operation": {
138
+ "title": "Operation",
139
+ "description": "The operation the step-up is bound to, exactly as the relying party received it.",
140
+ "type": "object",
141
+ "additionalProperties": false,
142
+ "required": [
143
+ "type",
144
+ "payload"
145
+ ],
146
+ "properties": {
147
+ "type": {
148
+ "type": "string",
149
+ "minLength": 1,
150
+ "maxLength": 2048,
151
+ "description": "The operation's Type URI, as the document the relying party refused named it."
152
+ },
153
+ "payload": {
154
+ "type": "object",
155
+ "description": "The operation's payload, member for member as received, so that the approver's agent can show it and — where it knows how the relying party derives `boundTo` — recompute the binding."
156
+ }
157
+ }
158
+ },
159
+ "Response": {
160
+ "$anchor": "response",
161
+ "title": "Auth — Step-up Request Show — response payload",
162
+ "type": "object",
163
+ "additionalProperties": false,
164
+ "required": [
165
+ "request",
166
+ "operation"
167
+ ],
168
+ "description": "The pending step-up and the operation it is bound to. Failures use trust-task-error, not this shape.",
169
+ "properties": {
170
+ "request": {
171
+ "type": "object",
172
+ "description": "A complete auth/step-up/approve-request/0.5 Trust Task document, issued and signed by the relying party, whose recipient is the step-up's subject and whose payload is the request the operation's producer received inline — the same challenge, boundTo, accepts and approvers. The agent verifies it as a document in its own right — envelope, proof and payload against that specification's schema — over the members exactly as received: its proof covers every member, so it is deliberately an open object here rather than a typed one a binding could narrow."
173
+ },
174
+ "operation": {
175
+ "$ref": "#/$defs/Operation"
176
+ },
177
+ "ext": {
178
+ "$ref": "#/$defs/Ext"
179
+ }
180
+ }
181
+ },
182
+ "Ext": {
183
+ "title": "Ext",
184
+ "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.",
185
+ "type": "object",
186
+ "minProperties": 1,
187
+ "additionalProperties": true,
188
+ "propertyNames": {
189
+ "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
190
+ }
191
+ }
192
+ }
193
+ } as const;
194
+
195
+ /** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
196
+ export const RESPONSE_PAYLOAD_SCHEMA = {
197
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
198
+ "$ref": "#/$defs/Response",
199
+ "$defs": {
200
+ "Handle": {
201
+ "title": "Handle",
202
+ "description": "A single-use reference to one pending step-up, minted by the relying party with at least 128 bits of entropy and carried as base64url without padding. It names the request; it is not the request's challenge, and knowing it authorizes nothing but this one read.",
203
+ "type": "string",
204
+ "pattern": "^[A-Za-z0-9_-]{22,86}$"
205
+ },
206
+ "Handoff": {
207
+ "title": "Handoff",
208
+ "description": "What a relying party MAY carry as `details.stepUpHandoff` beside an inline `details.stepUpRequest` (auth/step-up/approve-request/0.5, Inline delivery), so that a producer which cannot obtain the evidence itself can hand the step-up to the subject's approver agent. Not a payload of this task: defined here so producers and consumers share one shape.",
209
+ "type": "object",
210
+ "additionalProperties": false,
211
+ "required": [
212
+ "handle",
213
+ "expiresAt",
214
+ "show"
215
+ ],
216
+ "properties": {
217
+ "handle": {
218
+ "$ref": "#/$defs/Handle"
219
+ },
220
+ "expiresAt": {
221
+ "type": "string",
222
+ "format": "date-time",
223
+ "description": "The instant after which the relying party answers the handle with `notFound`: no later than the pending step-up's own expiry."
224
+ },
225
+ "show": {
226
+ "type": "string",
227
+ "const": "https://trusttasks.org/spec/auth/step-up/requests/show/0.1",
228
+ "description": "The Type URI the approver's agent sends with the handle."
229
+ }
230
+ }
231
+ },
232
+ "Operation": {
233
+ "title": "Operation",
234
+ "description": "The operation the step-up is bound to, exactly as the relying party received it.",
235
+ "type": "object",
236
+ "additionalProperties": false,
237
+ "required": [
238
+ "type",
239
+ "payload"
240
+ ],
241
+ "properties": {
242
+ "type": {
243
+ "type": "string",
244
+ "minLength": 1,
245
+ "maxLength": 2048,
246
+ "description": "The operation's Type URI, as the document the relying party refused named it."
247
+ },
248
+ "payload": {
249
+ "type": "object",
250
+ "description": "The operation's payload, member for member as received, so that the approver's agent can show it and — where it knows how the relying party derives `boundTo` — recompute the binding."
251
+ }
252
+ }
253
+ },
254
+ "Response": {
255
+ "$anchor": "response",
256
+ "title": "Auth — Step-up Request Show — response payload",
257
+ "type": "object",
258
+ "additionalProperties": false,
259
+ "required": [
260
+ "request",
261
+ "operation"
262
+ ],
263
+ "description": "The pending step-up and the operation it is bound to. Failures use trust-task-error, not this shape.",
264
+ "properties": {
265
+ "request": {
266
+ "type": "object",
267
+ "description": "A complete auth/step-up/approve-request/0.5 Trust Task document, issued and signed by the relying party, whose recipient is the step-up's subject and whose payload is the request the operation's producer received inline — the same challenge, boundTo, accepts and approvers. The agent verifies it as a document in its own right — envelope, proof and payload against that specification's schema — over the members exactly as received: its proof covers every member, so it is deliberately an open object here rather than a typed one a binding could narrow."
268
+ },
269
+ "operation": {
270
+ "$ref": "#/$defs/Operation"
271
+ },
272
+ "ext": {
273
+ "$ref": "#/$defs/Ext"
274
+ }
275
+ }
276
+ },
277
+ "Ext": {
278
+ "title": "Ext",
279
+ "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.",
280
+ "type": "object",
281
+ "minProperties": 1,
282
+ "additionalProperties": true,
283
+ "propertyNames": {
284
+ "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
285
+ }
286
+ }
287
+ }
288
+ } as const;
289
+
290
+ /**
291
+ * SPEC.md §7.2 policy for the request variant, from this specification's
292
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
293
+ * per-specification and cannot be derived from the document alone, and
294
+ * item 2 needs the schema this carries.
295
+ */
296
+ export const SPEC = {
297
+ typeUri: TYPE_URI,
298
+ isBearer: false,
299
+ isProofRequired: true,
300
+ isRecipientRequired: true,
301
+ isIssuedAtRequired: true,
302
+ payloadSchema: PAYLOAD_SCHEMA,
303
+ } as const;
304
+
305
+ /**
306
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
307
+ * tracks the *issuer* party's requirement because a response swaps the
308
+ * parties (§7.3 item 5).
309
+ */
310
+ export const RESPONSE_SPEC = {
311
+ typeUri: RESPONSE_TYPE_URI,
312
+ isBearer: false,
313
+ isProofRequired: true,
314
+ isRecipientRequired: true,
315
+ isIssuedAtRequired: true,
316
+ payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
317
+ } as const;
package/src/index.ts CHANGED
@@ -328,6 +328,9 @@ export import AuthStepUpPolicy_v0_1 = _AuthStepUpPolicy_v0_1;
328
328
  import * as _AuthStepUpPolicy_v0_2 from "./auth/step-up/policy/0.2/payload.js";
329
329
  /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
330
330
  export import AuthStepUpPolicy_v0_2 = _AuthStepUpPolicy_v0_2;
331
+ import * as _AuthStepUpRequestsShow_v0_1 from "./auth/step-up/requests/show/0.1/payload.js";
332
+ /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
333
+ export import AuthStepUpRequestsShow_v0_1 = _AuthStepUpRequestsShow_v0_1;
331
334
  import * as _AuthStepUpStart_v0_1 from "./auth/step-up/start/0.1/payload.js";
332
335
  /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
333
336
  export import AuthStepUpStart_v0_1 = _AuthStepUpStart_v0_1;
@@ -3216,6 +3219,12 @@ export import VtcBadgesAwardsOffer_v0_1 = _VtcBadgesAwardsOffer_v0_1;
3216
3219
  import * as _VtcBadgesAwardsRevoke_v0_1 from "./vtc/badges/awards/revoke/0.1/payload.js";
3217
3220
  /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
3218
3221
  export import VtcBadgesAwardsRevoke_v0_1 = _VtcBadgesAwardsRevoke_v0_1;
3222
+ import * as _VtcBadgesAwardsShare_v0_1 from "./vtc/badges/awards/share/0.1/payload.js";
3223
+ /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
3224
+ export import VtcBadgesAwardsShare_v0_1 = _VtcBadgesAwardsShare_v0_1;
3225
+ import * as _VtcBadgesAwardsUnshare_v0_1 from "./vtc/badges/awards/unshare/0.1/payload.js";
3226
+ /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
3227
+ export import VtcBadgesAwardsUnshare_v0_1 = _VtcBadgesAwardsUnshare_v0_1;
3219
3228
  import * as _VtcBadgesAwardsWithdraw_v0_1 from "./vtc/badges/awards/withdraw/0.1/payload.js";
3220
3229
  /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
3221
3230
  export import VtcBadgesAwardsWithdraw_v0_1 = _VtcBadgesAwardsWithdraw_v0_1;
@@ -20,4 +20,4 @@ export interface BadgeSharedDefinitionsForTheVtcBadgesSpecFamily {
20
20
  * The definitions this shared schema publishes, hoisted to one declaration each.
21
21
  * See "../../../../_shared/components.js".
22
22
  */
23
- export type { Award, AwardId, AwardNote, AwardState, Badge, BadgeCriteria, BadgeDescription, BadgeId, BadgeKind, BadgeLimits, BadgeName, BadgeSettings, BadgeState, KudosMakers, MyBadge, WallEntry, WallVisibility } from "../../../../_shared/components.js";
23
+ export type { Award, AwardId, AwardNote, AwardShare, AwardState, Badge, BadgeCriteria, BadgeDescription, BadgeId, BadgeKind, BadgeLimits, BadgeName, BadgeSettings, BadgeState, KudosMakers, MyBadge, WallEntry, WallVisibility } from "../../../../_shared/components.js";
@@ -3,7 +3,7 @@
3
3
  * Source: specs/vtc/badges/awards/list/0.1/payload.schema.json
4
4
  */
5
5
 
6
- import type { Award, AwardId, AwardNote, AwardState, BadgeId, CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, VerifiedValue } from "../../../../../_shared/components.js";
6
+ import type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, VerifiedValue } from "../../../../../_shared/components.js";
7
7
 
8
8
 
9
9
  /**
@@ -57,7 +57,7 @@ export interface VTCBadgesAwardsListResponsePayload {
57
57
  }
58
58
 
59
59
  /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
60
- export type { Award, AwardId, AwardNote, AwardState, BadgeId, CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, VerifiedValue };
60
+ export type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, VerifiedValue };
61
61
 
62
62
  /** Trust Task type URI. */
63
63
  export const TYPE_URI = "https://trusttasks.org/spec/vtc/badges/awards/list/0.1" as const;
@@ -334,7 +334,7 @@ export const PAYLOAD_SCHEMA = {
334
334
  },
335
335
  "Award": {
336
336
  "title": "Award",
337
- "description": "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires.",
337
+ "description": "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires. `shared` is present on an accepted award of a badge its holders may show outside while its holder shares it (vtc/badges/awards/share).",
338
338
  "type": "object",
339
339
  "additionalProperties": false,
340
340
  "required": [
@@ -381,11 +381,42 @@ export const PAYLOAD_SCHEMA = {
381
381
  "credentialId": {
382
382
  "$ref": "#/$defs/GroupCredentialId"
383
383
  },
384
+ "shared": {
385
+ "$ref": "#/$defs/AwardShare"
386
+ },
384
387
  "ext": {
385
388
  "$ref": "#/$defs/Ext"
386
389
  }
387
390
  }
388
391
  },
392
+ "AwardShare": {
393
+ "title": "AwardShare",
394
+ "description": "Where an accepted award is shown outside the community, by its holder's choice (VTI-BDG-070): the public location that answers a verification of exactly what the credential says, the baked image where the community serves one, and since when. Present only while the holder shares the award; absent once they stop, the award is taken back, the badge is retired or the holder departs. The locations are unguessable and name no other holder (VTI-BDG-071).",
395
+ "type": "object",
396
+ "additionalProperties": false,
397
+ "required": [
398
+ "verificationUrl",
399
+ "since"
400
+ ],
401
+ "properties": {
402
+ "verificationUrl": {
403
+ "type": "string",
404
+ "format": "uri",
405
+ "maxLength": 2048,
406
+ "description": "The public location that answers the credential and a verification of it."
407
+ },
408
+ "bakedImageUrl": {
409
+ "type": "string",
410
+ "format": "uri",
411
+ "maxLength": 2048,
412
+ "description": "The badge's picture with the credential baked into it, for a website or an email signature. Absent where the community serves no baked image."
413
+ },
414
+ "since": {
415
+ "type": "string",
416
+ "format": "date-time"
417
+ }
418
+ }
419
+ },
389
420
  "AwardState": {
390
421
  "title": "AwardState",
391
422
  "description": "`offered`: waiting for the recipient. `accepted`: the recipient took it; for a community badge the credential was issued and the membership recorded. `declined`: the recipient declined; nothing was recorded in the group and nothing issued. `withdrawn`: the giver withdrew the offer before a decision. `expired`: the offer lapsed unanswered. `revoked`: taken back after acceptance (VTI-BDG-023).",
@@ -638,7 +669,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
638
669
  },
639
670
  "Award": {
640
671
  "title": "Award",
641
- "description": "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires.",
672
+ "description": "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires. `shared` is present on an accepted award of a badge its holders may show outside while its holder shares it (vtc/badges/awards/share).",
642
673
  "type": "object",
643
674
  "additionalProperties": false,
644
675
  "required": [
@@ -685,11 +716,42 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
685
716
  "credentialId": {
686
717
  "$ref": "#/$defs/GroupCredentialId"
687
718
  },
719
+ "shared": {
720
+ "$ref": "#/$defs/AwardShare"
721
+ },
688
722
  "ext": {
689
723
  "$ref": "#/$defs/Ext"
690
724
  }
691
725
  }
692
726
  },
727
+ "AwardShare": {
728
+ "title": "AwardShare",
729
+ "description": "Where an accepted award is shown outside the community, by its holder's choice (VTI-BDG-070): the public location that answers a verification of exactly what the credential says, the baked image where the community serves one, and since when. Present only while the holder shares the award; absent once they stop, the award is taken back, the badge is retired or the holder departs. The locations are unguessable and name no other holder (VTI-BDG-071).",
730
+ "type": "object",
731
+ "additionalProperties": false,
732
+ "required": [
733
+ "verificationUrl",
734
+ "since"
735
+ ],
736
+ "properties": {
737
+ "verificationUrl": {
738
+ "type": "string",
739
+ "format": "uri",
740
+ "maxLength": 2048,
741
+ "description": "The public location that answers the credential and a verification of it."
742
+ },
743
+ "bakedImageUrl": {
744
+ "type": "string",
745
+ "format": "uri",
746
+ "maxLength": 2048,
747
+ "description": "The badge's picture with the credential baked into it, for a website or an email signature. Absent where the community serves no baked image."
748
+ },
749
+ "since": {
750
+ "type": "string",
751
+ "format": "date-time"
752
+ }
753
+ }
754
+ },
693
755
  "AwardState": {
694
756
  "title": "AwardState",
695
757
  "description": "`offered`: waiting for the recipient. `accepted`: the recipient took it; for a community badge the credential was issued and the membership recorded. `declined`: the recipient declined; nothing was recorded in the group and nothing issued. `withdrawn`: the giver withdrew the offer before a decision. `expired`: the offer lapsed unanswered. `revoked`: taken back after acceptance (VTI-BDG-023).",
@@ -3,7 +3,7 @@
3
3
  * Source: specs/vtc/badges/awards/offer/0.1/payload.schema.json
4
4
  */
5
5
 
6
- import type { Award, AwardId, AwardNote, AwardState, BadgeId, EntryId, Ext, GroupCredentialId, GroupId } from "../../../../../_shared/components.js";
6
+ import type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, EntryId, Ext, GroupCredentialId, GroupId } from "../../../../../_shared/components.js";
7
7
 
8
8
 
9
9
  /**
@@ -57,7 +57,7 @@ export interface VTCBadgesAwardsOfferResponsePayload {
57
57
  }
58
58
 
59
59
  /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
60
- export type { Award, AwardId, AwardNote, AwardState, BadgeId, EntryId, Ext, GroupCredentialId, GroupId };
60
+ export type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, EntryId, Ext, GroupCredentialId, GroupId };
61
61
 
62
62
  /** Trust Task type URI. */
63
63
  export const TYPE_URI = "https://trusttasks.org/spec/vtc/badges/awards/offer/0.1" as const;
@@ -225,7 +225,7 @@ export const PAYLOAD_SCHEMA = {
225
225
  },
226
226
  "Award": {
227
227
  "title": "Award",
228
- "description": "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires.",
228
+ "description": "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires. `shared` is present on an accepted award of a badge its holders may show outside while its holder shares it (vtc/badges/awards/share).",
229
229
  "type": "object",
230
230
  "additionalProperties": false,
231
231
  "required": [
@@ -272,11 +272,42 @@ export const PAYLOAD_SCHEMA = {
272
272
  "credentialId": {
273
273
  "$ref": "#/$defs/GroupCredentialId"
274
274
  },
275
+ "shared": {
276
+ "$ref": "#/$defs/AwardShare"
277
+ },
275
278
  "ext": {
276
279
  "$ref": "#/$defs/Ext"
277
280
  }
278
281
  }
279
282
  },
283
+ "AwardShare": {
284
+ "title": "AwardShare",
285
+ "description": "Where an accepted award is shown outside the community, by its holder's choice (VTI-BDG-070): the public location that answers a verification of exactly what the credential says, the baked image where the community serves one, and since when. Present only while the holder shares the award; absent once they stop, the award is taken back, the badge is retired or the holder departs. The locations are unguessable and name no other holder (VTI-BDG-071).",
286
+ "type": "object",
287
+ "additionalProperties": false,
288
+ "required": [
289
+ "verificationUrl",
290
+ "since"
291
+ ],
292
+ "properties": {
293
+ "verificationUrl": {
294
+ "type": "string",
295
+ "format": "uri",
296
+ "maxLength": 2048,
297
+ "description": "The public location that answers the credential and a verification of it."
298
+ },
299
+ "bakedImageUrl": {
300
+ "type": "string",
301
+ "format": "uri",
302
+ "maxLength": 2048,
303
+ "description": "The badge's picture with the credential baked into it, for a website or an email signature. Absent where the community serves no baked image."
304
+ },
305
+ "since": {
306
+ "type": "string",
307
+ "format": "date-time"
308
+ }
309
+ }
310
+ },
280
311
  "AwardState": {
281
312
  "title": "AwardState",
282
313
  "description": "`offered`: waiting for the recipient. `accepted`: the recipient took it; for a community badge the credential was issued and the membership recorded. `declined`: the recipient declined; nothing was recorded in the group and nothing issued. `withdrawn`: the giver withdrew the offer before a decision. `expired`: the offer lapsed unanswered. `revoked`: taken back after acceptance (VTI-BDG-023).",
@@ -400,7 +431,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
400
431
  },
401
432
  "Award": {
402
433
  "title": "Award",
403
- "description": "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires.",
434
+ "description": "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires. `shared` is present on an accepted award of a badge its holders may show outside while its holder shares it (vtc/badges/awards/share).",
404
435
  "type": "object",
405
436
  "additionalProperties": false,
406
437
  "required": [
@@ -447,11 +478,42 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
447
478
  "credentialId": {
448
479
  "$ref": "#/$defs/GroupCredentialId"
449
480
  },
481
+ "shared": {
482
+ "$ref": "#/$defs/AwardShare"
483
+ },
450
484
  "ext": {
451
485
  "$ref": "#/$defs/Ext"
452
486
  }
453
487
  }
454
488
  },
489
+ "AwardShare": {
490
+ "title": "AwardShare",
491
+ "description": "Where an accepted award is shown outside the community, by its holder's choice (VTI-BDG-070): the public location that answers a verification of exactly what the credential says, the baked image where the community serves one, and since when. Present only while the holder shares the award; absent once they stop, the award is taken back, the badge is retired or the holder departs. The locations are unguessable and name no other holder (VTI-BDG-071).",
492
+ "type": "object",
493
+ "additionalProperties": false,
494
+ "required": [
495
+ "verificationUrl",
496
+ "since"
497
+ ],
498
+ "properties": {
499
+ "verificationUrl": {
500
+ "type": "string",
501
+ "format": "uri",
502
+ "maxLength": 2048,
503
+ "description": "The public location that answers the credential and a verification of it."
504
+ },
505
+ "bakedImageUrl": {
506
+ "type": "string",
507
+ "format": "uri",
508
+ "maxLength": 2048,
509
+ "description": "The badge's picture with the credential baked into it, for a website or an email signature. Absent where the community serves no baked image."
510
+ },
511
+ "since": {
512
+ "type": "string",
513
+ "format": "date-time"
514
+ }
515
+ }
516
+ },
455
517
  "AwardState": {
456
518
  "title": "AwardState",
457
519
  "description": "`offered`: waiting for the recipient. `accepted`: the recipient took it; for a community badge the credential was issued and the membership recorded. `declined`: the recipient declined; nothing was recorded in the group and nothing issued. `withdrawn`: the giver withdrew the offer before a decision. `expired`: the offer lapsed unanswered. `revoked`: taken back after acceptance (VTI-BDG-023).",