@openvtc/trust-tasks 0.21.11 → 0.21.13
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/_framework/0.4/framework.d.ts +1 -1
- package/dist/_framework/0.4/framework.d.ts.map +1 -1
- package/dist/_shared/components.d.ts +371 -0
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/auth/_shared/0.1/signing-key.d.ts +16 -0
- package/dist/auth/_shared/0.1/signing-key.d.ts.map +1 -0
- package/dist/auth/_shared/0.1/signing-key.js +6 -0
- package/dist/auth/_shared/0.1/signing-key.js.map +1 -0
- package/dist/auth/signing-key/enroll/0.1/payload.d.ts +545 -0
- package/dist/auth/signing-key/enroll/0.1/payload.d.ts.map +1 -0
- package/dist/auth/signing-key/enroll/0.1/payload.js +307 -0
- package/dist/auth/signing-key/enroll/0.1/payload.js.map +1 -0
- package/dist/auth/signing-key/list/0.1/payload.d.ts +509 -0
- package/dist/auth/signing-key/list/0.1/payload.d.ts.map +1 -0
- package/dist/auth/signing-key/list/0.1/payload.js +289 -0
- package/dist/auth/signing-key/list/0.1/payload.js.map +1 -0
- package/dist/auth/signing-key/revoke/0.1/payload.d.ts +292 -0
- package/dist/auth/signing-key/revoke/0.1/payload.d.ts.map +1 -0
- package/dist/auth/signing-key/revoke/0.1/payload.js +167 -0
- package/dist/auth/signing-key/revoke/0.1/payload.js.map +1 -0
- package/dist/index.d.ts +39 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +39 -0
- package/dist/index.js.map +1 -1
- package/dist/vta/contexts/update-did/1.1/payload.d.ts +388 -0
- package/dist/vta/contexts/update-did/1.1/payload.d.ts.map +1 -0
- package/dist/vta/contexts/update-did/1.1/payload.js +227 -0
- package/dist/vta/contexts/update-did/1.1/payload.js.map +1 -0
- package/dist/vtc/_shared/0.1/community-presentation.d.ts +16 -0
- package/dist/vtc/_shared/0.1/community-presentation.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/community-presentation.js +6 -0
- package/dist/vtc/_shared/0.1/community-presentation.js.map +1 -0
- package/dist/vtc/_shared/0.1/relationship-lifecycle.d.ts +16 -0
- package/dist/vtc/_shared/0.1/relationship-lifecycle.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/relationship-lifecycle.js +6 -0
- package/dist/vtc/_shared/0.1/relationship-lifecycle.js.map +1 -0
- package/dist/vtc/_shared/0.1/schema-registry.d.ts +16 -0
- package/dist/vtc/_shared/0.1/schema-registry.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/schema-registry.js +6 -0
- package/dist/vtc/_shared/0.1/schema-registry.js.map +1 -0
- package/dist/vtc/_shared/0.1/vetting-auto-grant.d.ts +16 -0
- package/dist/vtc/_shared/0.1/vetting-auto-grant.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/vetting-auto-grant.js +6 -0
- package/dist/vtc/_shared/0.1/vetting-auto-grant.js.map +1 -0
- package/dist/vtc/_shared/0.1/website-transfer.d.ts +16 -0
- package/dist/vtc/_shared/0.1/website-transfer.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/website-transfer.js +6 -0
- package/dist/vtc/_shared/0.1/website-transfer.js.map +1 -0
- package/dist/vtc/community/branding/show/0.1/payload.d.ts +319 -0
- package/dist/vtc/community/branding/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/branding/show/0.1/payload.js +179 -0
- package/dist/vtc/community/branding/show/0.1/payload.js.map +1 -0
- package/dist/vtc/community/branding/update/0.1/payload.d.ts +328 -0
- package/dist/vtc/community/branding/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/branding/update/0.1/payload.js +185 -0
- package/dist/vtc/community/branding/update/0.1/payload.js.map +1 -0
- package/dist/vtc/community/join-discovery/show/0.1/payload.d.ts +267 -0
- package/dist/vtc/community/join-discovery/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/join-discovery/show/0.1/payload.js +157 -0
- package/dist/vtc/community/join-discovery/show/0.1/payload.js.map +1 -0
- package/dist/vtc/community/join-discovery/update/0.1/payload.d.ts +276 -0
- package/dist/vtc/community/join-discovery/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/join-discovery/update/0.1/payload.js +163 -0
- package/dist/vtc/community/join-discovery/update/0.1/payload.js.map +1 -0
- package/dist/vtc/community/requested-attributes/show/0.1/payload.d.ts +339 -0
- package/dist/vtc/community/requested-attributes/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/requested-attributes/show/0.1/payload.js +193 -0
- package/dist/vtc/community/requested-attributes/show/0.1/payload.js.map +1 -0
- package/dist/vtc/community/requested-attributes/update/0.1/payload.d.ts +348 -0
- package/dist/vtc/community/requested-attributes/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/requested-attributes/update/0.1/payload.js +199 -0
- package/dist/vtc/community/requested-attributes/update/0.1/payload.js.map +1 -0
- package/dist/vtc/join-requests/query/0.1/payload.d.ts +412 -0
- package/dist/vtc/join-requests/query/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/join-requests/query/0.1/payload.js +228 -0
- package/dist/vtc/join-requests/query/0.1/payload.js.map +1 -0
- package/dist/vtc/join-requests/vetting/show/0.1/payload.d.ts +1016 -0
- package/dist/vtc/join-requests/vetting/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/join-requests/vetting/show/0.1/payload.js +509 -0
- package/dist/vtc/join-requests/vetting/show/0.1/payload.js.map +1 -0
- package/dist/vtc/relationships/restore/0.1/payload.d.ts +462 -0
- package/dist/vtc/relationships/restore/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/relationships/restore/0.1/payload.js +270 -0
- package/dist/vtc/relationships/restore/0.1/payload.js.map +1 -0
- package/dist/vtc/relationships/suspend/0.1/payload.d.ts +462 -0
- package/dist/vtc/relationships/suspend/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/relationships/suspend/0.1/payload.js +270 -0
- package/dist/vtc/relationships/suspend/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/list/0.1/payload.d.ts +653 -0
- package/dist/vtc/rooms/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/list/0.1/payload.js +360 -0
- package/dist/vtc/rooms/list/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/accepts/delete/0.1/payload.d.ts +240 -0
- package/dist/vtc/schemas/accepts/delete/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/accepts/delete/0.1/payload.js +141 -0
- package/dist/vtc/schemas/accepts/delete/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/accepts/list/0.1/payload.d.ts +1214 -0
- package/dist/vtc/schemas/accepts/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/accepts/list/0.1/payload.js +681 -0
- package/dist/vtc/schemas/accepts/list/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/accepts/register/0.1/payload.d.ts +1165 -0
- package/dist/vtc/schemas/accepts/register/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/accepts/register/0.1/payload.js +665 -0
- package/dist/vtc/schemas/accepts/register/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/accepts/show/0.1/payload.d.ts +1144 -0
- package/dist/vtc/schemas/accepts/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/accepts/show/0.1/payload.js +655 -0
- package/dist/vtc/schemas/accepts/show/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/delete/0.1/payload.d.ts +240 -0
- package/dist/vtc/schemas/delete/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/delete/0.1/payload.js +141 -0
- package/dist/vtc/schemas/delete/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/list/0.1/payload.d.ts +541 -0
- package/dist/vtc/schemas/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/list/0.1/payload.js +300 -0
- package/dist/vtc/schemas/list/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/register/0.1/payload.d.ts +512 -0
- package/dist/vtc/schemas/register/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/register/0.1/payload.js +292 -0
- package/dist/vtc/schemas/register/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/show/0.1/payload.d.ts +484 -0
- package/dist/vtc/schemas/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/show/0.1/payload.js +279 -0
- package/dist/vtc/schemas/show/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/auto-grant/show/0.1/payload.d.ts +463 -0
- package/dist/vtc/vetting/auto-grant/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/auto-grant/show/0.1/payload.js +269 -0
- package/dist/vtc/vetting/auto-grant/show/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/auto-grant/update/0.1/payload.d.ts +491 -0
- package/dist/vtc/vetting/auto-grant/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/auto-grant/update/0.1/payload.js +282 -0
- package/dist/vtc/vetting/auto-grant/update/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/revocations/list/0.1/payload.d.ts +608 -0
- package/dist/vtc/vetting/revocations/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/revocations/list/0.1/payload.js +332 -0
- package/dist/vtc/vetting/revocations/list/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/vetters/grants/list/0.1/payload.d.ts +992 -0
- package/dist/vtc/vetting/vetters/grants/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/vetters/grants/list/0.1/payload.js +461 -0
- package/dist/vtc/vetting/vetters/grants/list/0.1/payload.js.map +1 -0
- package/dist/vtc/website/deploy/0.1/payload.d.ts +369 -0
- package/dist/vtc/website/deploy/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/deploy/0.1/payload.js +213 -0
- package/dist/vtc/website/deploy/0.1/payload.js.map +1 -0
- package/dist/vtc/website/files/show/0.1/payload.d.ts +455 -0
- package/dist/vtc/website/files/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/files/show/0.1/payload.js +247 -0
- package/dist/vtc/website/files/show/0.1/payload.js.map +1 -0
- package/dist/vtc/website/upload/abort/0.1/payload.d.ts +256 -0
- package/dist/vtc/website/upload/abort/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/upload/abort/0.1/payload.js +149 -0
- package/dist/vtc/website/upload/abort/0.1/payload.js.map +1 -0
- package/dist/vtc/website/upload/begin/0.1/payload.d.ts +658 -0
- package/dist/vtc/website/upload/begin/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/upload/begin/0.1/payload.js +375 -0
- package/dist/vtc/website/upload/begin/0.1/payload.js.map +1 -0
- package/dist/vtc/website/upload/chunk/0.1/payload.d.ts +447 -0
- package/dist/vtc/website/upload/chunk/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/upload/chunk/0.1/payload.js +253 -0
- package/dist/vtc/website/upload/chunk/0.1/payload.js.map +1 -0
- package/dist/vtc/website/upload/commit/0.1/payload.d.ts +603 -0
- package/dist/vtc/website/upload/commit/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/upload/commit/0.1/payload.js +337 -0
- package/dist/vtc/website/upload/commit/0.1/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_framework/0.4/framework.ts +1 -1
- package/src/_shared/components.ts +371 -0
- package/src/auth/_shared/0.1/signing-key.ts +17 -0
- package/src/auth/signing-key/enroll/0.1/payload.ts +349 -0
- package/src/auth/signing-key/list/0.1/payload.ts +323 -0
- package/src/auth/signing-key/revoke/0.1/payload.ts +204 -0
- package/src/index.ts +39 -0
- package/src/vta/contexts/update-did/1.1/payload.ts +256 -0
- package/src/vtc/_shared/0.1/community-presentation.ts +17 -0
- package/src/vtc/_shared/0.1/relationship-lifecycle.ts +17 -0
- package/src/vtc/_shared/0.1/schema-registry.ts +17 -0
- package/src/vtc/_shared/0.1/vetting-auto-grant.ts +17 -0
- package/src/vtc/_shared/0.1/website-transfer.ts +17 -0
- package/src/vtc/community/branding/show/0.1/payload.ts +207 -0
- package/src/vtc/community/branding/update/0.1/payload.ts +214 -0
- package/src/vtc/community/join-discovery/show/0.1/payload.ts +185 -0
- package/src/vtc/community/join-discovery/update/0.1/payload.ts +192 -0
- package/src/vtc/community/requested-attributes/show/0.1/payload.ts +221 -0
- package/src/vtc/community/requested-attributes/update/0.1/payload.ts +228 -0
- package/src/vtc/join-requests/query/0.1/payload.ts +285 -0
- package/src/vtc/join-requests/vetting/show/0.1/payload.ts +740 -0
- package/src/vtc/relationships/restore/0.1/payload.ts +307 -0
- package/src/vtc/relationships/suspend/0.1/payload.ts +307 -0
- package/src/vtc/rooms/list/0.1/payload.ts +449 -0
- package/src/vtc/schemas/accepts/delete/0.1/payload.ts +170 -0
- package/src/vtc/schemas/accepts/list/0.1/payload.ts +724 -0
- package/src/vtc/schemas/accepts/register/0.1/payload.ts +697 -0
- package/src/vtc/schemas/accepts/show/0.1/payload.ts +684 -0
- package/src/vtc/schemas/delete/0.1/payload.ts +170 -0
- package/src/vtc/schemas/list/0.1/payload.ts +344 -0
- package/src/vtc/schemas/register/0.1/payload.ts +325 -0
- package/src/vtc/schemas/show/0.1/payload.ts +308 -0
- package/src/vtc/vetting/auto-grant/show/0.1/payload.ts +297 -0
- package/src/vtc/vetting/auto-grant/update/0.1/payload.ts +316 -0
- package/src/vtc/vetting/revocations/list/0.1/payload.ts +416 -0
- package/src/vtc/vetting/vetters/grants/list/0.1/payload.ts +700 -0
- package/src/vtc/website/deploy/0.1/payload.ts +255 -0
- package/src/vtc/website/files/show/0.1/payload.ts +303 -0
- package/src/vtc/website/upload/abort/0.1/payload.ts +182 -0
- package/src/vtc/website/upload/begin/0.1/payload.ts +408 -0
- package/src/vtc/website/upload/chunk/0.1/payload.ts +295 -0
- package/src/vtc/website/upload/commit/0.1/payload.ts +385 -0
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/website/files/show/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
/** Trust Task type URI. */
|
|
6
|
+
export const TYPE_URI = "https://trusttasks.org/spec/vtc/website/files/show/0.1";
|
|
7
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
8
|
+
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/website/files/show/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/vtc/website/files/show/0.1",
|
|
21
|
+
"title": "VTC Website — Files — Show — payload",
|
|
22
|
+
"description": "Read a range of one website file. The outer document members are owned by the framework — SPEC §6.3.",
|
|
23
|
+
"type": "object",
|
|
24
|
+
"additionalProperties": false,
|
|
25
|
+
"required": [
|
|
26
|
+
"path"
|
|
27
|
+
],
|
|
28
|
+
"properties": {
|
|
29
|
+
"path": {
|
|
30
|
+
"$ref": "#/$defs/WebsitePath"
|
|
31
|
+
},
|
|
32
|
+
"offset": {
|
|
33
|
+
"type": "integer",
|
|
34
|
+
"minimum": 0,
|
|
35
|
+
"description": "Byte offset to read from; 0 when absent."
|
|
36
|
+
},
|
|
37
|
+
"length": {
|
|
38
|
+
"type": "integer",
|
|
39
|
+
"minimum": 1,
|
|
40
|
+
"maximum": 262144,
|
|
41
|
+
"description": "Bytes to read; 262144 when absent."
|
|
42
|
+
},
|
|
43
|
+
"ifMatch": {
|
|
44
|
+
"$ref": "#/$defs/WebsiteEtag"
|
|
45
|
+
},
|
|
46
|
+
"ext": {
|
|
47
|
+
"$ref": "#/$defs/Ext"
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"$defs": {
|
|
51
|
+
"Response": {
|
|
52
|
+
"$anchor": "response",
|
|
53
|
+
"title": "VTC Website — Files — Show — response payload",
|
|
54
|
+
"type": "object",
|
|
55
|
+
"additionalProperties": false,
|
|
56
|
+
"required": [
|
|
57
|
+
"path",
|
|
58
|
+
"etag",
|
|
59
|
+
"sizeBytes",
|
|
60
|
+
"contentType",
|
|
61
|
+
"offset",
|
|
62
|
+
"data",
|
|
63
|
+
"complete"
|
|
64
|
+
],
|
|
65
|
+
"properties": {
|
|
66
|
+
"path": {
|
|
67
|
+
"$ref": "#/$defs/WebsitePath"
|
|
68
|
+
},
|
|
69
|
+
"etag": {
|
|
70
|
+
"$ref": "#/$defs/WebsiteEtag"
|
|
71
|
+
},
|
|
72
|
+
"sizeBytes": {
|
|
73
|
+
"type": "integer",
|
|
74
|
+
"minimum": 0,
|
|
75
|
+
"description": "The whole file's size."
|
|
76
|
+
},
|
|
77
|
+
"contentType": {
|
|
78
|
+
"type": "string",
|
|
79
|
+
"minLength": 1,
|
|
80
|
+
"maxLength": 255,
|
|
81
|
+
"description": "The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown."
|
|
82
|
+
},
|
|
83
|
+
"offset": {
|
|
84
|
+
"type": "integer",
|
|
85
|
+
"minimum": 0,
|
|
86
|
+
"description": "Echoed."
|
|
87
|
+
},
|
|
88
|
+
"data": {
|
|
89
|
+
"$ref": "#/$defs/FileData"
|
|
90
|
+
},
|
|
91
|
+
"complete": {
|
|
92
|
+
"type": "boolean",
|
|
93
|
+
"description": "Whether this range reached the end of the file."
|
|
94
|
+
},
|
|
95
|
+
"ext": {
|
|
96
|
+
"$ref": "#/$defs/Ext"
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
},
|
|
100
|
+
"Ext": {
|
|
101
|
+
"title": "Ext",
|
|
102
|
+
"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.",
|
|
103
|
+
"type": "object",
|
|
104
|
+
"minProperties": 1,
|
|
105
|
+
"additionalProperties": true,
|
|
106
|
+
"propertyNames": {
|
|
107
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
108
|
+
}
|
|
109
|
+
},
|
|
110
|
+
"FileData": {
|
|
111
|
+
"title": "FileData",
|
|
112
|
+
"type": "string",
|
|
113
|
+
"maxLength": 349526,
|
|
114
|
+
"pattern": "^[A-Za-z0-9_-]*$",
|
|
115
|
+
"description": "A range of a file's bytes, base64url-encoded without padding (RFC 4648 §5). Empty for an empty range. Bounded at 349526 characters, the unpadded encoding of the 262144-byte range ceiling."
|
|
116
|
+
},
|
|
117
|
+
"WebsiteEtag": {
|
|
118
|
+
"title": "WebsiteEtag",
|
|
119
|
+
"type": "string",
|
|
120
|
+
"pattern": "^[0-9a-f]{64}$",
|
|
121
|
+
"description": "A file's content hash: the lowercase hex SHA-256 of its bytes — the `etag` vtc/website/files/list reports, and the `ETag` a direct read of the path returns, without the HTTP quotes."
|
|
122
|
+
},
|
|
123
|
+
"WebsitePath": {
|
|
124
|
+
"title": "WebsitePath",
|
|
125
|
+
"type": "string",
|
|
126
|
+
"minLength": 1,
|
|
127
|
+
"maxLength": 1024,
|
|
128
|
+
"pattern": "^[^\\\\]+$",
|
|
129
|
+
"description": "A file's path relative to the site root, `/`-separated, with or without a leading `/`. The community resolves it inside the site root and refuses one that escapes the root (`..`), names a hidden file or directory (a segment beginning `.`), carries a blocklisted extension, or contains a control character — the same rules the public read handler applies, so nothing can be written that the site would refuse to serve, and nothing can be read that it would not."
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
};
|
|
133
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
134
|
+
export const RESPONSE_PAYLOAD_SCHEMA = {
|
|
135
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
136
|
+
"$ref": "#/$defs/Response",
|
|
137
|
+
"$defs": {
|
|
138
|
+
"Response": {
|
|
139
|
+
"$anchor": "response",
|
|
140
|
+
"title": "VTC Website — Files — Show — response payload",
|
|
141
|
+
"type": "object",
|
|
142
|
+
"additionalProperties": false,
|
|
143
|
+
"required": [
|
|
144
|
+
"path",
|
|
145
|
+
"etag",
|
|
146
|
+
"sizeBytes",
|
|
147
|
+
"contentType",
|
|
148
|
+
"offset",
|
|
149
|
+
"data",
|
|
150
|
+
"complete"
|
|
151
|
+
],
|
|
152
|
+
"properties": {
|
|
153
|
+
"path": {
|
|
154
|
+
"$ref": "#/$defs/WebsitePath"
|
|
155
|
+
},
|
|
156
|
+
"etag": {
|
|
157
|
+
"$ref": "#/$defs/WebsiteEtag"
|
|
158
|
+
},
|
|
159
|
+
"sizeBytes": {
|
|
160
|
+
"type": "integer",
|
|
161
|
+
"minimum": 0,
|
|
162
|
+
"description": "The whole file's size."
|
|
163
|
+
},
|
|
164
|
+
"contentType": {
|
|
165
|
+
"type": "string",
|
|
166
|
+
"minLength": 1,
|
|
167
|
+
"maxLength": 255,
|
|
168
|
+
"description": "The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown."
|
|
169
|
+
},
|
|
170
|
+
"offset": {
|
|
171
|
+
"type": "integer",
|
|
172
|
+
"minimum": 0,
|
|
173
|
+
"description": "Echoed."
|
|
174
|
+
},
|
|
175
|
+
"data": {
|
|
176
|
+
"$ref": "#/$defs/FileData"
|
|
177
|
+
},
|
|
178
|
+
"complete": {
|
|
179
|
+
"type": "boolean",
|
|
180
|
+
"description": "Whether this range reached the end of the file."
|
|
181
|
+
},
|
|
182
|
+
"ext": {
|
|
183
|
+
"$ref": "#/$defs/Ext"
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
"Ext": {
|
|
188
|
+
"title": "Ext",
|
|
189
|
+
"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.",
|
|
190
|
+
"type": "object",
|
|
191
|
+
"minProperties": 1,
|
|
192
|
+
"additionalProperties": true,
|
|
193
|
+
"propertyNames": {
|
|
194
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
195
|
+
}
|
|
196
|
+
},
|
|
197
|
+
"FileData": {
|
|
198
|
+
"title": "FileData",
|
|
199
|
+
"type": "string",
|
|
200
|
+
"maxLength": 349526,
|
|
201
|
+
"pattern": "^[A-Za-z0-9_-]*$",
|
|
202
|
+
"description": "A range of a file's bytes, base64url-encoded without padding (RFC 4648 §5). Empty for an empty range. Bounded at 349526 characters, the unpadded encoding of the 262144-byte range ceiling."
|
|
203
|
+
},
|
|
204
|
+
"WebsiteEtag": {
|
|
205
|
+
"title": "WebsiteEtag",
|
|
206
|
+
"type": "string",
|
|
207
|
+
"pattern": "^[0-9a-f]{64}$",
|
|
208
|
+
"description": "A file's content hash: the lowercase hex SHA-256 of its bytes — the `etag` vtc/website/files/list reports, and the `ETag` a direct read of the path returns, without the HTTP quotes."
|
|
209
|
+
},
|
|
210
|
+
"WebsitePath": {
|
|
211
|
+
"title": "WebsitePath",
|
|
212
|
+
"type": "string",
|
|
213
|
+
"minLength": 1,
|
|
214
|
+
"maxLength": 1024,
|
|
215
|
+
"pattern": "^[^\\\\]+$",
|
|
216
|
+
"description": "A file's path relative to the site root, `/`-separated, with or without a leading `/`. The community resolves it inside the site root and refuses one that escapes the root (`..`), names a hidden file or directory (a segment beginning `.`), carries a blocklisted extension, or contains a control character — the same rules the public read handler applies, so nothing can be written that the site would refuse to serve, and nothing can be read that it would not."
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
};
|
|
220
|
+
/**
|
|
221
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
222
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
223
|
+
* per-specification and cannot be derived from the document alone, and
|
|
224
|
+
* item 2 needs the schema this carries.
|
|
225
|
+
*/
|
|
226
|
+
export const SPEC = {
|
|
227
|
+
typeUri: TYPE_URI,
|
|
228
|
+
isBearer: false,
|
|
229
|
+
isProofRequired: false,
|
|
230
|
+
isRecipientRequired: true,
|
|
231
|
+
isIssuedAtRequired: false,
|
|
232
|
+
payloadSchema: PAYLOAD_SCHEMA,
|
|
233
|
+
};
|
|
234
|
+
/**
|
|
235
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
236
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
237
|
+
* parties (§7.3 item 5).
|
|
238
|
+
*/
|
|
239
|
+
export const RESPONSE_SPEC = {
|
|
240
|
+
typeUri: RESPONSE_TYPE_URI,
|
|
241
|
+
isBearer: false,
|
|
242
|
+
isProofRequired: false,
|
|
243
|
+
isRecipientRequired: true,
|
|
244
|
+
isIssuedAtRequired: false,
|
|
245
|
+
payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
|
|
246
|
+
};
|
|
247
|
+
//# sourceMappingURL=payload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vtc/website/files/show/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA+CH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,wDAAiE,CAAC;AAK1F,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,iEAA0E,CAAC;AAK5G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,wDAAwD;IAC/D,OAAO,EAAE,sCAAsC;IAC/C,aAAa,EAAE,sGAAsG;IACrH,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,MAAM;KACP;IACD,YAAY,EAAE;QACZ,MAAM,EAAE;YACN,MAAM,EAAE,qBAAqB;SAC9B;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,0CAA0C;SAC1D;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,MAAM;YACjB,aAAa,EAAE,oCAAoC;SACpD;QACD,SAAS,EAAE;YACT,MAAM,EAAE,qBAAqB;SAC9B;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,+CAA+C;YACxD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,MAAM;gBACN,MAAM;gBACN,WAAW;gBACX,aAAa;gBACb,QAAQ;gBACR,MAAM;gBACN,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,MAAM,EAAE;oBACN,MAAM,EAAE,qBAAqB;iBAC9B;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,qBAAqB;iBAC9B;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,wBAAwB;iBACxC;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,kHAAkH;iBAClI;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,SAAS;iBACzB;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,kBAAkB;iBAC3B;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,iDAAiD;iBACjE;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;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;QACD,UAAU,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE,kBAAkB;YAC7B,aAAa,EAAE,6LAA6L;SAC7M;QACD,aAAa,EAAE;YACb,OAAO,EAAE,aAAa;YACtB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,gBAAgB;YAC3B,aAAa,EAAE,uLAAuL;SACvM;QACD,aAAa,EAAE;YACb,OAAO,EAAE,aAAa;YACtB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,YAAY;YACvB,aAAa,EAAE,8cAA8c;SAC9d;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,+CAA+C;YACxD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,MAAM;gBACN,MAAM;gBACN,WAAW;gBACX,aAAa;gBACb,QAAQ;gBACR,MAAM;gBACN,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,MAAM,EAAE;oBACN,MAAM,EAAE,qBAAqB;iBAC9B;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,qBAAqB;iBAC9B;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,wBAAwB;iBACxC;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,kHAAkH;iBAClI;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,SAAS;iBACzB;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,kBAAkB;iBAC3B;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,iDAAiD;iBACjE;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;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;QACD,UAAU,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE,kBAAkB;YAC7B,aAAa,EAAE,6LAA6L;SAC7M;QACD,aAAa,EAAE;YACb,OAAO,EAAE,aAAa;YACtB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,gBAAgB;YAC3B,aAAa,EAAE,uLAAuL;SACvM;QACD,aAAa,EAAE;YACb,OAAO,EAAE,aAAa;YACtB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,YAAY;YACvB,aAAa,EAAE,8cAA8c;SAC9d;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/website/upload/abort/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext, UploadId } from "../../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* Cancel an upload. The outer document members are owned by the framework — SPEC §6.3.
|
|
8
|
+
*/
|
|
9
|
+
export interface VTCWebsiteUploadAbortPayload {
|
|
10
|
+
uploadId: UploadId;
|
|
11
|
+
ext?: Ext;
|
|
12
|
+
}
|
|
13
|
+
export interface VTCWebsiteUploadAbortResponsePayload {
|
|
14
|
+
uploadId: UploadId;
|
|
15
|
+
/**
|
|
16
|
+
* Whether this request ended the upload. False means it was already aborted — a success, and why abort can be retried safely.
|
|
17
|
+
*/
|
|
18
|
+
aborted: boolean;
|
|
19
|
+
ext?: Ext;
|
|
20
|
+
}
|
|
21
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
22
|
+
export type { Ext, UploadId };
|
|
23
|
+
/** Trust Task type URI. */
|
|
24
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/website/upload/abort/0.1";
|
|
25
|
+
/** Stable alias for this specification's request payload shape. */
|
|
26
|
+
export type Payload = VTCWebsiteUploadAbortPayload;
|
|
27
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
28
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/website/upload/abort/0.1#response";
|
|
29
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
30
|
+
export type Response = VTCWebsiteUploadAbortResponsePayload;
|
|
31
|
+
/**
|
|
32
|
+
* This specification's payload schema, as a value.
|
|
33
|
+
*
|
|
34
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
35
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
36
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
37
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
38
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
39
|
+
*/
|
|
40
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
41
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
42
|
+
readonly $id: "https://trusttasks.org/spec/vtc/website/upload/abort/0.1";
|
|
43
|
+
readonly title: "VTC Website — Upload — Abort — payload";
|
|
44
|
+
readonly description: "Cancel an upload. The outer document members are owned by the framework — SPEC §6.3.";
|
|
45
|
+
readonly type: "object";
|
|
46
|
+
readonly additionalProperties: false;
|
|
47
|
+
readonly required: readonly ["uploadId"];
|
|
48
|
+
readonly properties: {
|
|
49
|
+
readonly uploadId: {
|
|
50
|
+
readonly $ref: "#/$defs/UploadId";
|
|
51
|
+
};
|
|
52
|
+
readonly ext: {
|
|
53
|
+
readonly $ref: "#/$defs/Ext";
|
|
54
|
+
};
|
|
55
|
+
};
|
|
56
|
+
readonly $defs: {
|
|
57
|
+
readonly Response: {
|
|
58
|
+
readonly $anchor: "response";
|
|
59
|
+
readonly title: "VTC Website — Upload — Abort — response payload";
|
|
60
|
+
readonly type: "object";
|
|
61
|
+
readonly additionalProperties: false;
|
|
62
|
+
readonly required: readonly ["uploadId", "aborted"];
|
|
63
|
+
readonly properties: {
|
|
64
|
+
readonly uploadId: {
|
|
65
|
+
readonly $ref: "#/$defs/UploadId";
|
|
66
|
+
};
|
|
67
|
+
readonly aborted: {
|
|
68
|
+
readonly type: "boolean";
|
|
69
|
+
readonly description: "Whether this request ended the upload. False means it was already aborted — a success, and why abort can be retried safely.";
|
|
70
|
+
};
|
|
71
|
+
readonly ext: {
|
|
72
|
+
readonly $ref: "#/$defs/Ext";
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
};
|
|
76
|
+
readonly Ext: {
|
|
77
|
+
readonly title: "Ext";
|
|
78
|
+
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.";
|
|
79
|
+
readonly type: "object";
|
|
80
|
+
readonly minProperties: 1;
|
|
81
|
+
readonly additionalProperties: true;
|
|
82
|
+
readonly propertyNames: {
|
|
83
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
readonly UploadId: {
|
|
87
|
+
readonly title: "UploadId";
|
|
88
|
+
readonly type: "string";
|
|
89
|
+
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}$";
|
|
90
|
+
readonly description: "Handle for one upload across begin, chunk, commit and abort, and — for a bundle — deploy. Recipient-generated and unguessable, which is what lets a reference to somebody else's upload be answered as not-found without confirming it exists. Opaque: a producer quotes what it was given.";
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
95
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
96
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
97
|
+
readonly $ref: "#/$defs/Response";
|
|
98
|
+
readonly $defs: {
|
|
99
|
+
readonly Response: {
|
|
100
|
+
readonly $anchor: "response";
|
|
101
|
+
readonly title: "VTC Website — Upload — Abort — response payload";
|
|
102
|
+
readonly type: "object";
|
|
103
|
+
readonly additionalProperties: false;
|
|
104
|
+
readonly required: readonly ["uploadId", "aborted"];
|
|
105
|
+
readonly properties: {
|
|
106
|
+
readonly uploadId: {
|
|
107
|
+
readonly $ref: "#/$defs/UploadId";
|
|
108
|
+
};
|
|
109
|
+
readonly aborted: {
|
|
110
|
+
readonly type: "boolean";
|
|
111
|
+
readonly description: "Whether this request ended the upload. False means it was already aborted — a success, and why abort can be retried safely.";
|
|
112
|
+
};
|
|
113
|
+
readonly ext: {
|
|
114
|
+
readonly $ref: "#/$defs/Ext";
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
readonly Ext: {
|
|
119
|
+
readonly title: "Ext";
|
|
120
|
+
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.";
|
|
121
|
+
readonly type: "object";
|
|
122
|
+
readonly minProperties: 1;
|
|
123
|
+
readonly additionalProperties: true;
|
|
124
|
+
readonly propertyNames: {
|
|
125
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
readonly UploadId: {
|
|
129
|
+
readonly title: "UploadId";
|
|
130
|
+
readonly type: "string";
|
|
131
|
+
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}$";
|
|
132
|
+
readonly description: "Handle for one upload across begin, chunk, commit and abort, and — for a bundle — deploy. Recipient-generated and unguessable, which is what lets a reference to somebody else's upload be answered as not-found without confirming it exists. Opaque: a producer quotes what it was given.";
|
|
133
|
+
};
|
|
134
|
+
};
|
|
135
|
+
};
|
|
136
|
+
/**
|
|
137
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
138
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
139
|
+
* per-specification and cannot be derived from the document alone, and
|
|
140
|
+
* item 2 needs the schema this carries.
|
|
141
|
+
*/
|
|
142
|
+
export declare const SPEC: {
|
|
143
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/website/upload/abort/0.1";
|
|
144
|
+
readonly isBearer: false;
|
|
145
|
+
readonly isProofRequired: true;
|
|
146
|
+
readonly isRecipientRequired: true;
|
|
147
|
+
readonly isIssuedAtRequired: true;
|
|
148
|
+
readonly payloadSchema: {
|
|
149
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
150
|
+
readonly $id: "https://trusttasks.org/spec/vtc/website/upload/abort/0.1";
|
|
151
|
+
readonly title: "VTC Website — Upload — Abort — payload";
|
|
152
|
+
readonly description: "Cancel an upload. The outer document members are owned by the framework — SPEC §6.3.";
|
|
153
|
+
readonly type: "object";
|
|
154
|
+
readonly additionalProperties: false;
|
|
155
|
+
readonly required: readonly ["uploadId"];
|
|
156
|
+
readonly properties: {
|
|
157
|
+
readonly uploadId: {
|
|
158
|
+
readonly $ref: "#/$defs/UploadId";
|
|
159
|
+
};
|
|
160
|
+
readonly ext: {
|
|
161
|
+
readonly $ref: "#/$defs/Ext";
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
readonly $defs: {
|
|
165
|
+
readonly Response: {
|
|
166
|
+
readonly $anchor: "response";
|
|
167
|
+
readonly title: "VTC Website — Upload — Abort — response payload";
|
|
168
|
+
readonly type: "object";
|
|
169
|
+
readonly additionalProperties: false;
|
|
170
|
+
readonly required: readonly ["uploadId", "aborted"];
|
|
171
|
+
readonly properties: {
|
|
172
|
+
readonly uploadId: {
|
|
173
|
+
readonly $ref: "#/$defs/UploadId";
|
|
174
|
+
};
|
|
175
|
+
readonly aborted: {
|
|
176
|
+
readonly type: "boolean";
|
|
177
|
+
readonly description: "Whether this request ended the upload. False means it was already aborted — a success, and why abort can be retried safely.";
|
|
178
|
+
};
|
|
179
|
+
readonly ext: {
|
|
180
|
+
readonly $ref: "#/$defs/Ext";
|
|
181
|
+
};
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
readonly Ext: {
|
|
185
|
+
readonly title: "Ext";
|
|
186
|
+
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.";
|
|
187
|
+
readonly type: "object";
|
|
188
|
+
readonly minProperties: 1;
|
|
189
|
+
readonly additionalProperties: true;
|
|
190
|
+
readonly propertyNames: {
|
|
191
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
192
|
+
};
|
|
193
|
+
};
|
|
194
|
+
readonly UploadId: {
|
|
195
|
+
readonly title: "UploadId";
|
|
196
|
+
readonly type: "string";
|
|
197
|
+
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}$";
|
|
198
|
+
readonly description: "Handle for one upload across begin, chunk, commit and abort, and — for a bundle — deploy. Recipient-generated and unguessable, which is what lets a reference to somebody else's upload be answered as not-found without confirming it exists. Opaque: a producer quotes what it was given.";
|
|
199
|
+
};
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
};
|
|
203
|
+
/**
|
|
204
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
205
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
206
|
+
* parties (§7.3 item 5).
|
|
207
|
+
*/
|
|
208
|
+
export declare const RESPONSE_SPEC: {
|
|
209
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/website/upload/abort/0.1#response";
|
|
210
|
+
readonly isBearer: false;
|
|
211
|
+
readonly isProofRequired: true;
|
|
212
|
+
readonly isRecipientRequired: true;
|
|
213
|
+
readonly isIssuedAtRequired: true;
|
|
214
|
+
readonly payloadSchema: {
|
|
215
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
216
|
+
readonly $ref: "#/$defs/Response";
|
|
217
|
+
readonly $defs: {
|
|
218
|
+
readonly Response: {
|
|
219
|
+
readonly $anchor: "response";
|
|
220
|
+
readonly title: "VTC Website — Upload — Abort — response payload";
|
|
221
|
+
readonly type: "object";
|
|
222
|
+
readonly additionalProperties: false;
|
|
223
|
+
readonly required: readonly ["uploadId", "aborted"];
|
|
224
|
+
readonly properties: {
|
|
225
|
+
readonly uploadId: {
|
|
226
|
+
readonly $ref: "#/$defs/UploadId";
|
|
227
|
+
};
|
|
228
|
+
readonly aborted: {
|
|
229
|
+
readonly type: "boolean";
|
|
230
|
+
readonly description: "Whether this request ended the upload. False means it was already aborted — a success, and why abort can be retried safely.";
|
|
231
|
+
};
|
|
232
|
+
readonly ext: {
|
|
233
|
+
readonly $ref: "#/$defs/Ext";
|
|
234
|
+
};
|
|
235
|
+
};
|
|
236
|
+
};
|
|
237
|
+
readonly Ext: {
|
|
238
|
+
readonly title: "Ext";
|
|
239
|
+
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.";
|
|
240
|
+
readonly type: "object";
|
|
241
|
+
readonly minProperties: 1;
|
|
242
|
+
readonly additionalProperties: true;
|
|
243
|
+
readonly propertyNames: {
|
|
244
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
245
|
+
};
|
|
246
|
+
};
|
|
247
|
+
readonly UploadId: {
|
|
248
|
+
readonly title: "UploadId";
|
|
249
|
+
readonly type: "string";
|
|
250
|
+
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}$";
|
|
251
|
+
readonly description: "Handle for one upload across begin, chunk, commit and abort, and — for a bundle — deploy. Recipient-generated and unguessable, which is what lets a reference to somebody else's upload be answered as not-found without confirming it exists. Opaque: a producer quotes what it was given.";
|
|
252
|
+
};
|
|
253
|
+
};
|
|
254
|
+
};
|
|
255
|
+
};
|
|
256
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/website/upload/abort/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAG1E;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,QAAQ,CAAC;IACnB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,oCAAoC;IACnD,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC;AAE9B,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,0DAAmE,CAAC;AAE5F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,4BAA4B,CAAC;AAEnD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,mEAA4E,CAAC;AAE9G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,oCAAoC,CAAC;AAE5D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0DjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2C1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/website/upload/abort/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
/** Trust Task type URI. */
|
|
6
|
+
export const TYPE_URI = "https://trusttasks.org/spec/vtc/website/upload/abort/0.1";
|
|
7
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
8
|
+
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/website/upload/abort/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/vtc/website/upload/abort/0.1",
|
|
21
|
+
"title": "VTC Website — Upload — Abort — payload",
|
|
22
|
+
"description": "Cancel an upload. The outer document members are owned by the framework — SPEC §6.3.",
|
|
23
|
+
"type": "object",
|
|
24
|
+
"additionalProperties": false,
|
|
25
|
+
"required": [
|
|
26
|
+
"uploadId"
|
|
27
|
+
],
|
|
28
|
+
"properties": {
|
|
29
|
+
"uploadId": {
|
|
30
|
+
"$ref": "#/$defs/UploadId"
|
|
31
|
+
},
|
|
32
|
+
"ext": {
|
|
33
|
+
"$ref": "#/$defs/Ext"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
"$defs": {
|
|
37
|
+
"Response": {
|
|
38
|
+
"$anchor": "response",
|
|
39
|
+
"title": "VTC Website — Upload — Abort — response payload",
|
|
40
|
+
"type": "object",
|
|
41
|
+
"additionalProperties": false,
|
|
42
|
+
"required": [
|
|
43
|
+
"uploadId",
|
|
44
|
+
"aborted"
|
|
45
|
+
],
|
|
46
|
+
"properties": {
|
|
47
|
+
"uploadId": {
|
|
48
|
+
"$ref": "#/$defs/UploadId"
|
|
49
|
+
},
|
|
50
|
+
"aborted": {
|
|
51
|
+
"type": "boolean",
|
|
52
|
+
"description": "Whether this request ended the upload. False means it was already aborted — a success, and why abort can be retried safely."
|
|
53
|
+
},
|
|
54
|
+
"ext": {
|
|
55
|
+
"$ref": "#/$defs/Ext"
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"Ext": {
|
|
60
|
+
"title": "Ext",
|
|
61
|
+
"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.",
|
|
62
|
+
"type": "object",
|
|
63
|
+
"minProperties": 1,
|
|
64
|
+
"additionalProperties": true,
|
|
65
|
+
"propertyNames": {
|
|
66
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
"UploadId": {
|
|
70
|
+
"title": "UploadId",
|
|
71
|
+
"type": "string",
|
|
72
|
+
"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}$",
|
|
73
|
+
"description": "Handle for one upload across begin, chunk, commit and abort, and — for a bundle — deploy. Recipient-generated and unguessable, which is what lets a reference to somebody else's upload be answered as not-found without confirming it exists. Opaque: a producer quotes what it was given."
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
78
|
+
export const RESPONSE_PAYLOAD_SCHEMA = {
|
|
79
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
80
|
+
"$ref": "#/$defs/Response",
|
|
81
|
+
"$defs": {
|
|
82
|
+
"Response": {
|
|
83
|
+
"$anchor": "response",
|
|
84
|
+
"title": "VTC Website — Upload — Abort — response payload",
|
|
85
|
+
"type": "object",
|
|
86
|
+
"additionalProperties": false,
|
|
87
|
+
"required": [
|
|
88
|
+
"uploadId",
|
|
89
|
+
"aborted"
|
|
90
|
+
],
|
|
91
|
+
"properties": {
|
|
92
|
+
"uploadId": {
|
|
93
|
+
"$ref": "#/$defs/UploadId"
|
|
94
|
+
},
|
|
95
|
+
"aborted": {
|
|
96
|
+
"type": "boolean",
|
|
97
|
+
"description": "Whether this request ended the upload. False means it was already aborted — a success, and why abort can be retried safely."
|
|
98
|
+
},
|
|
99
|
+
"ext": {
|
|
100
|
+
"$ref": "#/$defs/Ext"
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
"Ext": {
|
|
105
|
+
"title": "Ext",
|
|
106
|
+
"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.",
|
|
107
|
+
"type": "object",
|
|
108
|
+
"minProperties": 1,
|
|
109
|
+
"additionalProperties": true,
|
|
110
|
+
"propertyNames": {
|
|
111
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"UploadId": {
|
|
115
|
+
"title": "UploadId",
|
|
116
|
+
"type": "string",
|
|
117
|
+
"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}$",
|
|
118
|
+
"description": "Handle for one upload across begin, chunk, commit and abort, and — for a bundle — deploy. Recipient-generated and unguessable, which is what lets a reference to somebody else's upload be answered as not-found without confirming it exists. Opaque: a producer quotes what it was given."
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
};
|
|
122
|
+
/**
|
|
123
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
124
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
125
|
+
* per-specification and cannot be derived from the document alone, and
|
|
126
|
+
* item 2 needs the schema this carries.
|
|
127
|
+
*/
|
|
128
|
+
export const SPEC = {
|
|
129
|
+
typeUri: TYPE_URI,
|
|
130
|
+
isBearer: false,
|
|
131
|
+
isProofRequired: true,
|
|
132
|
+
isRecipientRequired: true,
|
|
133
|
+
isIssuedAtRequired: true,
|
|
134
|
+
payloadSchema: PAYLOAD_SCHEMA,
|
|
135
|
+
};
|
|
136
|
+
/**
|
|
137
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
138
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
139
|
+
* parties (§7.3 item 5).
|
|
140
|
+
*/
|
|
141
|
+
export const RESPONSE_SPEC = {
|
|
142
|
+
typeUri: RESPONSE_TYPE_URI,
|
|
143
|
+
isBearer: false,
|
|
144
|
+
isProofRequired: true,
|
|
145
|
+
isRecipientRequired: true,
|
|
146
|
+
isIssuedAtRequired: true,
|
|
147
|
+
payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
|
|
148
|
+
};
|
|
149
|
+
//# sourceMappingURL=payload.js.map
|