@openvtc/trust-tasks 0.21.11 → 0.21.12

package/dist/vtc/website/upload/begin/0.1/payload.d.ts

@@ -0,0 +1,658 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/website/upload/begin/0.1/payload.schema.json
+ */
+import type { ChunkCount, ChunkManifest, ChunkSize, DigestMultibase, ExpectedSha256, ExpectedSizeBytes, ExpiresAt, Ext, UploadId, UploadTarget, WebsiteEtag, WebsitePath } from "../../../../../_shared/components.js";
+/**
+ * Open an upload of one website file or a whole-site bundle, committing to its size, SHA-256 and chunk digests. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCWebsiteUploadBeginPayload {
+    target: UploadTarget;
+    expectedSha256: ExpectedSha256;
+    expectedSizeBytes: ExpectedSizeBytes;
+    chunks: ChunkManifest;
+    ext?: Ext;
+}
+export interface VTCWebsiteUploadBeginResponsePayload {
+    uploadId: UploadId;
+    expiresAt: ExpiresAt;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ChunkCount, ChunkManifest, ChunkSize, DigestMultibase, ExpectedSha256, ExpectedSizeBytes, ExpiresAt, Ext, UploadId, UploadTarget, WebsiteEtag, WebsitePath };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/website/upload/begin/0.1";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCWebsiteUploadBeginPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/website/upload/begin/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCWebsiteUploadBeginResponsePayload;
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vtc/website/upload/begin/0.1";
+    readonly title: "VTC Website — Upload — Begin — payload";
+    readonly description: "Open an upload of one website file or a whole-site bundle, committing to its size, SHA-256 and chunk digests. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["target", "expectedSha256", "expectedSizeBytes", "chunks"];
+    readonly properties: {
+        readonly target: {
+            readonly $ref: "#/$defs/UploadTarget";
+        };
+        readonly expectedSha256: {
+            readonly $ref: "#/$defs/ExpectedSha256";
+        };
+        readonly expectedSizeBytes: {
+            readonly $ref: "#/$defs/ExpectedSizeBytes";
+        };
+        readonly chunks: {
+            readonly $ref: "#/$defs/ChunkManifest";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Website — Upload — Begin — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["uploadId", "expiresAt"];
+            readonly properties: {
+                readonly uploadId: {
+                    readonly $ref: "#/$defs/UploadId";
+                };
+                readonly expiresAt: {
+                    readonly $ref: "#/$defs/ExpiresAt";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly ExpiresAt: {
+            readonly title: "ExpiresAt";
+            readonly description: "After which the bundle is collected: staged bytes discarded, tokens and chunk requests refused. Short by design. For a chunked transfer a recipient may move it later as chunks are exchanged, never past its own ceiling — each chunk response reports the current value.";
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly UploadId: {
+            readonly title: "UploadId";
+            readonly type: "string";
+            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}$";
+            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.";
+        };
+        readonly ChunkManifest: {
+            readonly title: "ChunkManifest";
+            readonly description: "The terms of a `chunkedTrustTask` transfer, committed before any chunk moves. On export the recipient states them in the descriptor; on import the producer pre-commits them in the request and the recipient echoes them. Either way the manifest arrives in a document whose proof is REQUIRED, so the per-chunk digests are authenticated by the party that computed them and each chunk can be verified — and a single bad chunk re-fetched or refused — on arrival rather than only after reassembly.\n\nConsistency rules JSON Schema cannot state: `chunkCount` MUST equal ceil(expectedSizeBytes / chunkSize) for the bundle the manifest describes, and `chunkDigests` MUST have exactly `chunkCount` items. A party receiving a manifest violating either MUST refuse it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["chunkSize", "chunkCount", "chunkDigests"];
+            readonly properties: {
+                readonly chunkSize: {
+                    readonly $ref: "#/$defs/ChunkSize";
+                };
+                readonly chunkCount: {
+                    readonly $ref: "#/$defs/ChunkCount";
+                };
+                readonly chunkDigests: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 4096;
+                    readonly description: "Digest of each chunk's raw bytes (not of its base64url encoding), in index order. Compared as decoded multihash bytes, never as encoded strings. sha2-256 is RECOMMENDED and MUST be implemented by every party; a party that does not implement the hash a digest names MUST treat the manifest as unverifiable rather than skip the check.";
+                    readonly items: {
+                        readonly $ref: "#/$defs/DigestMultibase";
+                    };
+                };
+            };
+        };
+        readonly ChunkCount: {
+            readonly title: "ChunkCount";
+            readonly description: "Number of chunks in the bundle, equal to ceil(expectedSizeBytes / chunkSize). Bounded at 4096 so that the manifest itself — one digest per chunk — fits in the single document that carries it under the same message-size reasoning as a chunk.";
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 4096;
+        };
+        readonly ChunkSize: {
+            readonly title: "ChunkSize";
+            readonly description: "Size in bytes of every chunk except the last, which carries the remainder and is between 1 and this value inclusive. The ceiling of 262144 (256 KiB) is normative and is derived in `vta/backup/initiate-export/1.1` under Chunked transfer: it is the largest power of two whose `get-chunk` or `put-chunk` document still fits a 1 MiB mediator message after base64url encoding of `data`, DIDComm authcrypt encoding, and two nested forward wrappers. The floor of 16384 keeps a 1 GiB bundle within `ChunkCount`'s ceiling at sizes a constrained transport can still choose.";
+            readonly type: "integer";
+            readonly minimum: 16384;
+            readonly maximum: 262144;
+        };
+        readonly DigestMultibase: {
+            readonly title: "DigestMultibase";
+            readonly description: "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.";
+            readonly type: "string";
+            readonly minLength: 16;
+            readonly pattern: "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$";
+            readonly examples: readonly ["zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"];
+        };
+        readonly ExpectedSizeBytes: {
+            readonly title: "ExpectedSizeBytes";
+            readonly description: "Total byte count of the bundle. A zero-length bundle is not a degenerate success — nothing was serialized — so the floor is 1.";
+            readonly type: "integer";
+            readonly minimum: 1;
+        };
+        readonly ExpectedSha256: {
+            readonly title: "ExpectedSha256";
+            readonly description: "Lowercase hex SHA-256 of the whole bundle's bytes. Kept in the hex form the 1.0 descriptor published rather than moved to DigestMultibase, because it is an unchanged member of an existing descriptor and re-encoding it would break every stream producer for no gain in what it checks. For a chunked transfer it is the check over the reassembled bundle, applied after every chunk has verified individually, so that a correct set of chunks assembled in the wrong order is still caught.";
+            readonly type: "string";
+            readonly pattern: "^[0-9a-f]{64}$";
+        };
+        readonly UploadTarget: {
+            readonly title: "UploadTarget";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["kind"];
+            readonly description: "What the uploaded bytes are for, committed before any byte moves. `file`: one file at `path`, written into the site when the upload commits — the single-file write. `bundle`: a gzip-compressed tar of the whole site, staged when the upload commits and published by vtc/website/deploy. `path` is required for a `file` target and forbidden for a `bundle`, and `ifMatch` is allowed only for a `file` — rules over two members that this schema does not express; a community refuses a violation with `malformedRequest`. `ifMatch` is optimistic concurrency: the write commits only if the file's current content hash is this value.";
+            readonly properties: {
+                readonly kind: {
+                    readonly type: "string";
+                    readonly enum: readonly ["file", "bundle"];
+                };
+                readonly path: {
+                    readonly $ref: "#/$defs/WebsitePath";
+                };
+                readonly ifMatch: {
+                    readonly $ref: "#/$defs/WebsiteEtag";
+                };
+            };
+        };
+        readonly WebsiteEtag: {
+            readonly title: "WebsiteEtag";
+            readonly type: "string";
+            readonly pattern: "^[0-9a-f]{64}$";
+            readonly 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.";
+        };
+        readonly WebsitePath: {
+            readonly title: "WebsitePath";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 1024;
+            readonly pattern: "^[^\\\\]+$";
+            readonly 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.";
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Website — Upload — Begin — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["uploadId", "expiresAt"];
+            readonly properties: {
+                readonly uploadId: {
+                    readonly $ref: "#/$defs/UploadId";
+                };
+                readonly expiresAt: {
+                    readonly $ref: "#/$defs/ExpiresAt";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly ExpiresAt: {
+            readonly title: "ExpiresAt";
+            readonly description: "After which the bundle is collected: staged bytes discarded, tokens and chunk requests refused. Short by design. For a chunked transfer a recipient may move it later as chunks are exchanged, never past its own ceiling — each chunk response reports the current value.";
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly UploadId: {
+            readonly title: "UploadId";
+            readonly type: "string";
+            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}$";
+            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.";
+        };
+        readonly ChunkManifest: {
+            readonly title: "ChunkManifest";
+            readonly description: "The terms of a `chunkedTrustTask` transfer, committed before any chunk moves. On export the recipient states them in the descriptor; on import the producer pre-commits them in the request and the recipient echoes them. Either way the manifest arrives in a document whose proof is REQUIRED, so the per-chunk digests are authenticated by the party that computed them and each chunk can be verified — and a single bad chunk re-fetched or refused — on arrival rather than only after reassembly.\n\nConsistency rules JSON Schema cannot state: `chunkCount` MUST equal ceil(expectedSizeBytes / chunkSize) for the bundle the manifest describes, and `chunkDigests` MUST have exactly `chunkCount` items. A party receiving a manifest violating either MUST refuse it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["chunkSize", "chunkCount", "chunkDigests"];
+            readonly properties: {
+                readonly chunkSize: {
+                    readonly $ref: "#/$defs/ChunkSize";
+                };
+                readonly chunkCount: {
+                    readonly $ref: "#/$defs/ChunkCount";
+                };
+                readonly chunkDigests: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 4096;
+                    readonly description: "Digest of each chunk's raw bytes (not of its base64url encoding), in index order. Compared as decoded multihash bytes, never as encoded strings. sha2-256 is RECOMMENDED and MUST be implemented by every party; a party that does not implement the hash a digest names MUST treat the manifest as unverifiable rather than skip the check.";
+                    readonly items: {
+                        readonly $ref: "#/$defs/DigestMultibase";
+                    };
+                };
+            };
+        };
+        readonly ChunkCount: {
+            readonly title: "ChunkCount";
+            readonly description: "Number of chunks in the bundle, equal to ceil(expectedSizeBytes / chunkSize). Bounded at 4096 so that the manifest itself — one digest per chunk — fits in the single document that carries it under the same message-size reasoning as a chunk.";
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 4096;
+        };
+        readonly ChunkSize: {
+            readonly title: "ChunkSize";
+            readonly description: "Size in bytes of every chunk except the last, which carries the remainder and is between 1 and this value inclusive. The ceiling of 262144 (256 KiB) is normative and is derived in `vta/backup/initiate-export/1.1` under Chunked transfer: it is the largest power of two whose `get-chunk` or `put-chunk` document still fits a 1 MiB mediator message after base64url encoding of `data`, DIDComm authcrypt encoding, and two nested forward wrappers. The floor of 16384 keeps a 1 GiB bundle within `ChunkCount`'s ceiling at sizes a constrained transport can still choose.";
+            readonly type: "integer";
+            readonly minimum: 16384;
+            readonly maximum: 262144;
+        };
+        readonly DigestMultibase: {
+            readonly title: "DigestMultibase";
+            readonly description: "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.";
+            readonly type: "string";
+            readonly minLength: 16;
+            readonly pattern: "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$";
+            readonly examples: readonly ["zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"];
+        };
+        readonly ExpectedSizeBytes: {
+            readonly title: "ExpectedSizeBytes";
+            readonly description: "Total byte count of the bundle. A zero-length bundle is not a degenerate success — nothing was serialized — so the floor is 1.";
+            readonly type: "integer";
+            readonly minimum: 1;
+        };
+        readonly ExpectedSha256: {
+            readonly title: "ExpectedSha256";
+            readonly description: "Lowercase hex SHA-256 of the whole bundle's bytes. Kept in the hex form the 1.0 descriptor published rather than moved to DigestMultibase, because it is an unchanged member of an existing descriptor and re-encoding it would break every stream producer for no gain in what it checks. For a chunked transfer it is the check over the reassembled bundle, applied after every chunk has verified individually, so that a correct set of chunks assembled in the wrong order is still caught.";
+            readonly type: "string";
+            readonly pattern: "^[0-9a-f]{64}$";
+        };
+        readonly UploadTarget: {
+            readonly title: "UploadTarget";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["kind"];
+            readonly description: "What the uploaded bytes are for, committed before any byte moves. `file`: one file at `path`, written into the site when the upload commits — the single-file write. `bundle`: a gzip-compressed tar of the whole site, staged when the upload commits and published by vtc/website/deploy. `path` is required for a `file` target and forbidden for a `bundle`, and `ifMatch` is allowed only for a `file` — rules over two members that this schema does not express; a community refuses a violation with `malformedRequest`. `ifMatch` is optimistic concurrency: the write commits only if the file's current content hash is this value.";
+            readonly properties: {
+                readonly kind: {
+                    readonly type: "string";
+                    readonly enum: readonly ["file", "bundle"];
+                };
+                readonly path: {
+                    readonly $ref: "#/$defs/WebsitePath";
+                };
+                readonly ifMatch: {
+                    readonly $ref: "#/$defs/WebsiteEtag";
+                };
+            };
+        };
+        readonly WebsiteEtag: {
+            readonly title: "WebsiteEtag";
+            readonly type: "string";
+            readonly pattern: "^[0-9a-f]{64}$";
+            readonly 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.";
+        };
+        readonly WebsitePath: {
+            readonly title: "WebsitePath";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 1024;
+            readonly pattern: "^[^\\\\]+$";
+            readonly 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.";
+        };
+    };
+};
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/website/upload/begin/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtc/website/upload/begin/0.1";
+        readonly title: "VTC Website — Upload — Begin — payload";
+        readonly description: "Open an upload of one website file or a whole-site bundle, committing to its size, SHA-256 and chunk digests. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["target", "expectedSha256", "expectedSizeBytes", "chunks"];
+        readonly properties: {
+            readonly target: {
+                readonly $ref: "#/$defs/UploadTarget";
+            };
+            readonly expectedSha256: {
+                readonly $ref: "#/$defs/ExpectedSha256";
+            };
+            readonly expectedSizeBytes: {
+                readonly $ref: "#/$defs/ExpectedSizeBytes";
+            };
+            readonly chunks: {
+                readonly $ref: "#/$defs/ChunkManifest";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Website — Upload — Begin — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["uploadId", "expiresAt"];
+                readonly properties: {
+                    readonly uploadId: {
+                        readonly $ref: "#/$defs/UploadId";
+                    };
+                    readonly expiresAt: {
+                        readonly $ref: "#/$defs/ExpiresAt";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly ExpiresAt: {
+                readonly title: "ExpiresAt";
+                readonly description: "After which the bundle is collected: staged bytes discarded, tokens and chunk requests refused. Short by design. For a chunked transfer a recipient may move it later as chunks are exchanged, never past its own ceiling — each chunk response reports the current value.";
+                readonly type: "string";
+                readonly format: "date-time";
+            };
+            readonly UploadId: {
+                readonly title: "UploadId";
+                readonly type: "string";
+                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}$";
+                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.";
+            };
+            readonly ChunkManifest: {
+                readonly title: "ChunkManifest";
+                readonly description: "The terms of a `chunkedTrustTask` transfer, committed before any chunk moves. On export the recipient states them in the descriptor; on import the producer pre-commits them in the request and the recipient echoes them. Either way the manifest arrives in a document whose proof is REQUIRED, so the per-chunk digests are authenticated by the party that computed them and each chunk can be verified — and a single bad chunk re-fetched or refused — on arrival rather than only after reassembly.\n\nConsistency rules JSON Schema cannot state: `chunkCount` MUST equal ceil(expectedSizeBytes / chunkSize) for the bundle the manifest describes, and `chunkDigests` MUST have exactly `chunkCount` items. A party receiving a manifest violating either MUST refuse it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["chunkSize", "chunkCount", "chunkDigests"];
+                readonly properties: {
+                    readonly chunkSize: {
+                        readonly $ref: "#/$defs/ChunkSize";
+                    };
+                    readonly chunkCount: {
+                        readonly $ref: "#/$defs/ChunkCount";
+                    };
+                    readonly chunkDigests: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 4096;
+                        readonly description: "Digest of each chunk's raw bytes (not of its base64url encoding), in index order. Compared as decoded multihash bytes, never as encoded strings. sha2-256 is RECOMMENDED and MUST be implemented by every party; a party that does not implement the hash a digest names MUST treat the manifest as unverifiable rather than skip the check.";
+                        readonly items: {
+                            readonly $ref: "#/$defs/DigestMultibase";
+                        };
+                    };
+                };
+            };
+            readonly ChunkCount: {
+                readonly title: "ChunkCount";
+                readonly description: "Number of chunks in the bundle, equal to ceil(expectedSizeBytes / chunkSize). Bounded at 4096 so that the manifest itself — one digest per chunk — fits in the single document that carries it under the same message-size reasoning as a chunk.";
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 4096;
+            };
+            readonly ChunkSize: {
+                readonly title: "ChunkSize";
+                readonly description: "Size in bytes of every chunk except the last, which carries the remainder and is between 1 and this value inclusive. The ceiling of 262144 (256 KiB) is normative and is derived in `vta/backup/initiate-export/1.1` under Chunked transfer: it is the largest power of two whose `get-chunk` or `put-chunk` document still fits a 1 MiB mediator message after base64url encoding of `data`, DIDComm authcrypt encoding, and two nested forward wrappers. The floor of 16384 keeps a 1 GiB bundle within `ChunkCount`'s ceiling at sizes a constrained transport can still choose.";
+                readonly type: "integer";
+                readonly minimum: 16384;
+                readonly maximum: 262144;
+            };
+            readonly DigestMultibase: {
+                readonly title: "DigestMultibase";
+                readonly description: "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.";
+                readonly type: "string";
+                readonly minLength: 16;
+                readonly pattern: "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$";
+                readonly examples: readonly ["zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"];
+            };
+            readonly ExpectedSizeBytes: {
+                readonly title: "ExpectedSizeBytes";
+                readonly description: "Total byte count of the bundle. A zero-length bundle is not a degenerate success — nothing was serialized — so the floor is 1.";
+                readonly type: "integer";
+                readonly minimum: 1;
+            };
+            readonly ExpectedSha256: {
+                readonly title: "ExpectedSha256";
+                readonly description: "Lowercase hex SHA-256 of the whole bundle's bytes. Kept in the hex form the 1.0 descriptor published rather than moved to DigestMultibase, because it is an unchanged member of an existing descriptor and re-encoding it would break every stream producer for no gain in what it checks. For a chunked transfer it is the check over the reassembled bundle, applied after every chunk has verified individually, so that a correct set of chunks assembled in the wrong order is still caught.";
+                readonly type: "string";
+                readonly pattern: "^[0-9a-f]{64}$";
+            };
+            readonly UploadTarget: {
+                readonly title: "UploadTarget";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["kind"];
+                readonly description: "What the uploaded bytes are for, committed before any byte moves. `file`: one file at `path`, written into the site when the upload commits — the single-file write. `bundle`: a gzip-compressed tar of the whole site, staged when the upload commits and published by vtc/website/deploy. `path` is required for a `file` target and forbidden for a `bundle`, and `ifMatch` is allowed only for a `file` — rules over two members that this schema does not express; a community refuses a violation with `malformedRequest`. `ifMatch` is optimistic concurrency: the write commits only if the file's current content hash is this value.";
+                readonly properties: {
+                    readonly kind: {
+                        readonly type: "string";
+                        readonly enum: readonly ["file", "bundle"];
+                    };
+                    readonly path: {
+                        readonly $ref: "#/$defs/WebsitePath";
+                    };
+                    readonly ifMatch: {
+                        readonly $ref: "#/$defs/WebsiteEtag";
+                    };
+                };
+            };
+            readonly WebsiteEtag: {
+                readonly title: "WebsiteEtag";
+                readonly type: "string";
+                readonly pattern: "^[0-9a-f]{64}$";
+                readonly 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.";
+            };
+            readonly WebsitePath: {
+                readonly title: "WebsitePath";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 1024;
+                readonly pattern: "^[^\\\\]+$";
+                readonly 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.";
+            };
+        };
+    };
+};
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/website/upload/begin/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Website — Upload — Begin — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["uploadId", "expiresAt"];
+                readonly properties: {
+                    readonly uploadId: {
+                        readonly $ref: "#/$defs/UploadId";
+                    };
+                    readonly expiresAt: {
+                        readonly $ref: "#/$defs/ExpiresAt";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly ExpiresAt: {
+                readonly title: "ExpiresAt";
+                readonly description: "After which the bundle is collected: staged bytes discarded, tokens and chunk requests refused. Short by design. For a chunked transfer a recipient may move it later as chunks are exchanged, never past its own ceiling — each chunk response reports the current value.";
+                readonly type: "string";
+                readonly format: "date-time";
+            };
+            readonly UploadId: {
+                readonly title: "UploadId";
+                readonly type: "string";
+                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}$";
+                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.";
+            };
+            readonly ChunkManifest: {
+                readonly title: "ChunkManifest";
+                readonly description: "The terms of a `chunkedTrustTask` transfer, committed before any chunk moves. On export the recipient states them in the descriptor; on import the producer pre-commits them in the request and the recipient echoes them. Either way the manifest arrives in a document whose proof is REQUIRED, so the per-chunk digests are authenticated by the party that computed them and each chunk can be verified — and a single bad chunk re-fetched or refused — on arrival rather than only after reassembly.\n\nConsistency rules JSON Schema cannot state: `chunkCount` MUST equal ceil(expectedSizeBytes / chunkSize) for the bundle the manifest describes, and `chunkDigests` MUST have exactly `chunkCount` items. A party receiving a manifest violating either MUST refuse it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["chunkSize", "chunkCount", "chunkDigests"];
+                readonly properties: {
+                    readonly chunkSize: {
+                        readonly $ref: "#/$defs/ChunkSize";
+                    };
+                    readonly chunkCount: {
+                        readonly $ref: "#/$defs/ChunkCount";
+                    };
+                    readonly chunkDigests: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 4096;
+                        readonly description: "Digest of each chunk's raw bytes (not of its base64url encoding), in index order. Compared as decoded multihash bytes, never as encoded strings. sha2-256 is RECOMMENDED and MUST be implemented by every party; a party that does not implement the hash a digest names MUST treat the manifest as unverifiable rather than skip the check.";
+                        readonly items: {
+                            readonly $ref: "#/$defs/DigestMultibase";
+                        };
+                    };
+                };
+            };
+            readonly ChunkCount: {
+                readonly title: "ChunkCount";
+                readonly description: "Number of chunks in the bundle, equal to ceil(expectedSizeBytes / chunkSize). Bounded at 4096 so that the manifest itself — one digest per chunk — fits in the single document that carries it under the same message-size reasoning as a chunk.";
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 4096;
+            };
+            readonly ChunkSize: {
+                readonly title: "ChunkSize";
+                readonly description: "Size in bytes of every chunk except the last, which carries the remainder and is between 1 and this value inclusive. The ceiling of 262144 (256 KiB) is normative and is derived in `vta/backup/initiate-export/1.1` under Chunked transfer: it is the largest power of two whose `get-chunk` or `put-chunk` document still fits a 1 MiB mediator message after base64url encoding of `data`, DIDComm authcrypt encoding, and two nested forward wrappers. The floor of 16384 keeps a 1 GiB bundle within `ChunkCount`'s ceiling at sizes a constrained transport can still choose.";
+                readonly type: "integer";
+                readonly minimum: 16384;
+                readonly maximum: 262144;
+            };
+            readonly DigestMultibase: {
+                readonly title: "DigestMultibase";
+                readonly description: "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.";
+                readonly type: "string";
+                readonly minLength: 16;
+                readonly pattern: "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$";
+                readonly examples: readonly ["zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"];
+            };
+            readonly ExpectedSizeBytes: {
+                readonly title: "ExpectedSizeBytes";
+                readonly description: "Total byte count of the bundle. A zero-length bundle is not a degenerate success — nothing was serialized — so the floor is 1.";
+                readonly type: "integer";
+                readonly minimum: 1;
+            };
+            readonly ExpectedSha256: {
+                readonly title: "ExpectedSha256";
+                readonly description: "Lowercase hex SHA-256 of the whole bundle's bytes. Kept in the hex form the 1.0 descriptor published rather than moved to DigestMultibase, because it is an unchanged member of an existing descriptor and re-encoding it would break every stream producer for no gain in what it checks. For a chunked transfer it is the check over the reassembled bundle, applied after every chunk has verified individually, so that a correct set of chunks assembled in the wrong order is still caught.";
+                readonly type: "string";
+                readonly pattern: "^[0-9a-f]{64}$";
+            };
+            readonly UploadTarget: {
+                readonly title: "UploadTarget";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["kind"];
+                readonly description: "What the uploaded bytes are for, committed before any byte moves. `file`: one file at `path`, written into the site when the upload commits — the single-file write. `bundle`: a gzip-compressed tar of the whole site, staged when the upload commits and published by vtc/website/deploy. `path` is required for a `file` target and forbidden for a `bundle`, and `ifMatch` is allowed only for a `file` — rules over two members that this schema does not express; a community refuses a violation with `malformedRequest`. `ifMatch` is optimistic concurrency: the write commits only if the file's current content hash is this value.";
+                readonly properties: {
+                    readonly kind: {
+                        readonly type: "string";
+                        readonly enum: readonly ["file", "bundle"];
+                    };
+                    readonly path: {
+                        readonly $ref: "#/$defs/WebsitePath";
+                    };
+                    readonly ifMatch: {
+                        readonly $ref: "#/$defs/WebsiteEtag";
+                    };
+                };
+            };
+            readonly WebsiteEtag: {
+                readonly title: "WebsiteEtag";
+                readonly type: "string";
+                readonly pattern: "^[0-9a-f]{64}$";
+                readonly 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.";
+            };
+            readonly WebsitePath: {
+                readonly title: "WebsitePath";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 1024;
+                readonly pattern: "^[^\\\\]+$";
+                readonly 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.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map