@openvtc/trust-tasks 0.21.11 → 0.21.13

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

@@ -0,0 +1,603 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/website/upload/commit/0.1/payload.schema.json
+ */
+import type { ExpectedSha256, ExpectedSizeBytes, ExpiresAt, Ext, UploadId, UploadTarget, WebsiteEtag, WebsitePath } from "../../../../../_shared/components.js";
+/**
+ * Complete an upload. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCWebsiteUploadCommitPayload {
+    uploadId: UploadId;
+    ext?: Ext;
+}
+/**
+ * Exactly one of `file` (for a `file` target) and `stagedUntil` (for a `bundle` target) is present — a rule over two members that this schema does not express.
+ */
+export interface VTCWebsiteUploadCommitResponsePayload {
+    uploadId: UploadId;
+    target: UploadTarget;
+    sha256: ExpectedSha256;
+    sizeBytes: ExpectedSizeBytes;
+    file?: WrittenFile;
+    stagedUntil?: ExpiresAt;
+    ext?: Ext;
+}
+/**
+ * The file a `file` upload wrote.
+ */
+export interface WrittenFile {
+    path: WebsitePath;
+    etag: WebsiteEtag;
+    /**
+     * The file's size in bytes.
+     */
+    sizeBytes: number;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ExpectedSha256, ExpectedSizeBytes, ExpiresAt, Ext, UploadId, UploadTarget, WebsiteEtag, WebsitePath };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/website/upload/commit/0.1";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCWebsiteUploadCommitPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/website/upload/commit/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCWebsiteUploadCommitResponsePayload;
+/**
+ * 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/commit/0.1";
+    readonly title: "VTC Website — Upload — Commit — payload";
+    readonly description: "Complete an upload. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["uploadId"];
+    readonly properties: {
+        readonly uploadId: {
+            readonly $ref: "#/$defs/UploadId";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly WrittenFile: {
+            readonly title: "WrittenFile";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["path", "etag", "sizeBytes"];
+            readonly description: "The file a `file` upload wrote.";
+            readonly properties: {
+                readonly path: {
+                    readonly $ref: "#/$defs/WebsitePath";
+                };
+                readonly etag: {
+                    readonly $ref: "#/$defs/WebsiteEtag";
+                };
+                readonly sizeBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly description: "The file's size in bytes.";
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Website — Upload — Commit — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["uploadId", "target", "sha256", "sizeBytes"];
+            readonly description: "Exactly one of `file` (for a `file` target) and `stagedUntil` (for a `bundle` target) is present — a rule over two members that this schema does not express.";
+            readonly properties: {
+                readonly uploadId: {
+                    readonly $ref: "#/$defs/UploadId";
+                };
+                readonly target: {
+                    readonly $ref: "#/$defs/UploadTarget";
+                };
+                readonly sha256: {
+                    readonly $ref: "#/$defs/ExpectedSha256";
+                };
+                readonly sizeBytes: {
+                    readonly $ref: "#/$defs/ExpectedSizeBytes";
+                };
+                readonly file: {
+                    readonly $ref: "#/$defs/WrittenFile";
+                };
+                readonly stagedUntil: {
+                    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 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.";
+        };
+        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.";
+        };
+    };
+};
+/** 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 WrittenFile: {
+            readonly title: "WrittenFile";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["path", "etag", "sizeBytes"];
+            readonly description: "The file a `file` upload wrote.";
+            readonly properties: {
+                readonly path: {
+                    readonly $ref: "#/$defs/WebsitePath";
+                };
+                readonly etag: {
+                    readonly $ref: "#/$defs/WebsiteEtag";
+                };
+                readonly sizeBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly description: "The file's size in bytes.";
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Website — Upload — Commit — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["uploadId", "target", "sha256", "sizeBytes"];
+            readonly description: "Exactly one of `file` (for a `file` target) and `stagedUntil` (for a `bundle` target) is present — a rule over two members that this schema does not express.";
+            readonly properties: {
+                readonly uploadId: {
+                    readonly $ref: "#/$defs/UploadId";
+                };
+                readonly target: {
+                    readonly $ref: "#/$defs/UploadTarget";
+                };
+                readonly sha256: {
+                    readonly $ref: "#/$defs/ExpectedSha256";
+                };
+                readonly sizeBytes: {
+                    readonly $ref: "#/$defs/ExpectedSizeBytes";
+                };
+                readonly file: {
+                    readonly $ref: "#/$defs/WrittenFile";
+                };
+                readonly stagedUntil: {
+                    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 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.";
+        };
+        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.";
+        };
+    };
+};
+/**
+ * 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/commit/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/commit/0.1";
+        readonly title: "VTC Website — Upload — Commit — payload";
+        readonly description: "Complete an upload. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["uploadId"];
+        readonly properties: {
+            readonly uploadId: {
+                readonly $ref: "#/$defs/UploadId";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly WrittenFile: {
+                readonly title: "WrittenFile";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["path", "etag", "sizeBytes"];
+                readonly description: "The file a `file` upload wrote.";
+                readonly properties: {
+                    readonly path: {
+                        readonly $ref: "#/$defs/WebsitePath";
+                    };
+                    readonly etag: {
+                        readonly $ref: "#/$defs/WebsiteEtag";
+                    };
+                    readonly sizeBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "The file's size in bytes.";
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Website — Upload — Commit — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["uploadId", "target", "sha256", "sizeBytes"];
+                readonly description: "Exactly one of `file` (for a `file` target) and `stagedUntil` (for a `bundle` target) is present — a rule over two members that this schema does not express.";
+                readonly properties: {
+                    readonly uploadId: {
+                        readonly $ref: "#/$defs/UploadId";
+                    };
+                    readonly target: {
+                        readonly $ref: "#/$defs/UploadTarget";
+                    };
+                    readonly sha256: {
+                        readonly $ref: "#/$defs/ExpectedSha256";
+                    };
+                    readonly sizeBytes: {
+                        readonly $ref: "#/$defs/ExpectedSizeBytes";
+                    };
+                    readonly file: {
+                        readonly $ref: "#/$defs/WrittenFile";
+                    };
+                    readonly stagedUntil: {
+                        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 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.";
+            };
+            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.";
+            };
+        };
+    };
+};
+/**
+ * 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/commit/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 WrittenFile: {
+                readonly title: "WrittenFile";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["path", "etag", "sizeBytes"];
+                readonly description: "The file a `file` upload wrote.";
+                readonly properties: {
+                    readonly path: {
+                        readonly $ref: "#/$defs/WebsitePath";
+                    };
+                    readonly etag: {
+                        readonly $ref: "#/$defs/WebsiteEtag";
+                    };
+                    readonly sizeBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "The file's size in bytes.";
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Website — Upload — Commit — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["uploadId", "target", "sha256", "sizeBytes"];
+                readonly description: "Exactly one of `file` (for a `file` target) and `stagedUntil` (for a `bundle` target) is present — a rule over two members that this schema does not express.";
+                readonly properties: {
+                    readonly uploadId: {
+                        readonly $ref: "#/$defs/UploadId";
+                    };
+                    readonly target: {
+                        readonly $ref: "#/$defs/UploadTarget";
+                    };
+                    readonly sha256: {
+                        readonly $ref: "#/$defs/ExpectedSha256";
+                    };
+                    readonly sizeBytes: {
+                        readonly $ref: "#/$defs/ExpectedSizeBytes";
+                    };
+                    readonly file: {
+                        readonly $ref: "#/$defs/WrittenFile";
+                    };
+                    readonly stagedUntil: {
+                        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 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.";
+            };
+            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.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vtc/website/upload/commit/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/website/upload/commit/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAGhK;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,EAAE,QAAQ,CAAC;IACnB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,kHAAkH;AAClH,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;AAEpH,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,2DAAoE,CAAC;AAE7F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,6BAA6B,CAAC;AAEpD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,oEAA6E,CAAC;AAE/G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,qCAAqC,CAAC;AAE7D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwJjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyI1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}