@openvtc/trust-tasks 0.21.11 → 0.21.13

package/src/vtc/website/deploy/0.1/payload.ts

@@ -0,0 +1,255 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/website/deploy/0.1/payload.schema.json
+ */
+
+import type { ExpectedSha256, ExpectedSizeBytes, Ext, UploadId } from "../../../../_shared/components.js";
+
+
+/**
+ * Publish a staged bundle upload. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCWebsiteDeployPayload {
+  uploadId: UploadId;
+  ext?: Ext;
+}
+export interface VTCWebsiteDeployResponsePayload {
+  /**
+   * How the site was replaced.
+   */
+  deployMode: "live" | "managed";
+  bundleSha256: ExpectedSha256;
+  bundleSizeBytes: ExpectedSizeBytes;
+  /**
+   * The generation created; 0 in live mode.
+   */
+  targetGeneration: number;
+  /**
+   * Old generations removed; 0 in live mode.
+   */
+  prunedGenerations: number;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ExpectedSha256, ExpectedSizeBytes, Ext, UploadId };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/website/deploy/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCWebsiteDeployPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/website/deploy/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCWebsiteDeployResponsePayload;
+
+/**
+ * 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 const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/vtc/website/deploy/0.1",
+  "title": "VTC Website — Deploy — payload",
+  "description": "Publish a staged bundle upload. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "uploadId"
+  ],
+  "properties": {
+    "uploadId": {
+      "$ref": "#/$defs/UploadId"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Website — Deploy — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "deployMode",
+        "bundleSha256",
+        "bundleSizeBytes",
+        "targetGeneration",
+        "prunedGenerations"
+      ],
+      "properties": {
+        "deployMode": {
+          "type": "string",
+          "enum": [
+            "live",
+            "managed"
+          ],
+          "description": "How the site was replaced."
+        },
+        "bundleSha256": {
+          "$ref": "#/$defs/ExpectedSha256"
+        },
+        "bundleSizeBytes": {
+          "$ref": "#/$defs/ExpectedSizeBytes"
+        },
+        "targetGeneration": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The generation created; 0 in live mode."
+        },
+        "prunedGenerations": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Old generations removed; 0 in live mode."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "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.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "ExpectedSizeBytes": {
+      "title": "ExpectedSizeBytes",
+      "description": "Total byte count of the bundle. A zero-length bundle is not a degenerate success — nothing was serialized — so the floor is 1.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "ExpectedSha256": {
+      "title": "ExpectedSha256",
+      "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.",
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$"
+    },
+    "UploadId": {
+      "title": "UploadId",
+      "type": "string",
+      "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}$",
+      "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 const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Website — Deploy — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "deployMode",
+        "bundleSha256",
+        "bundleSizeBytes",
+        "targetGeneration",
+        "prunedGenerations"
+      ],
+      "properties": {
+        "deployMode": {
+          "type": "string",
+          "enum": [
+            "live",
+            "managed"
+          ],
+          "description": "How the site was replaced."
+        },
+        "bundleSha256": {
+          "$ref": "#/$defs/ExpectedSha256"
+        },
+        "bundleSizeBytes": {
+          "$ref": "#/$defs/ExpectedSizeBytes"
+        },
+        "targetGeneration": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The generation created; 0 in live mode."
+        },
+        "prunedGenerations": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Old generations removed; 0 in live mode."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "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.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "ExpectedSizeBytes": {
+      "title": "ExpectedSizeBytes",
+      "description": "Total byte count of the bundle. A zero-length bundle is not a degenerate success — nothing was serialized — so the floor is 1.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "ExpectedSha256": {
+      "title": "ExpectedSha256",
+      "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.",
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$"
+    },
+    "UploadId": {
+      "title": "UploadId",
+      "type": "string",
+      "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}$",
+      "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 const;
+
+/**
+ * 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 const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * 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 const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vtc/website/files/show/0.1/payload.ts

@@ -0,0 +1,303 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/website/files/show/0.1/payload.schema.json
+ */
+
+import type { Ext, FileData, WebsiteEtag, WebsitePath } from "../../../../../_shared/components.js";
+
+
+/**
+ * Read a range of one website file. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCWebsiteFilesShowPayload {
+  path: WebsitePath;
+  /**
+   * Byte offset to read from; 0 when absent.
+   */
+  offset?: number;
+  /**
+   * Bytes to read; 262144 when absent.
+   */
+  length?: number;
+  ifMatch?: WebsiteEtag;
+  ext?: Ext;
+}
+export interface VTCWebsiteFilesShowResponsePayload {
+  path: WebsitePath;
+  etag: WebsiteEtag;
+  /**
+   * The whole file's size.
+   */
+  sizeBytes: number;
+  /**
+   * The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown.
+   */
+  contentType: string;
+  /**
+   * Echoed.
+   */
+  offset: number;
+  data: FileData;
+  /**
+   * Whether this range reached the end of the file.
+   */
+  complete: boolean;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, FileData, WebsiteEtag, WebsitePath };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/website/files/show/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCWebsiteFilesShowPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/website/files/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCWebsiteFilesShowResponsePayload;
+
+/**
+ * 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 const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/vtc/website/files/show/0.1",
+  "title": "VTC Website — Files — Show — payload",
+  "description": "Read a range of one website file. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "path"
+  ],
+  "properties": {
+    "path": {
+      "$ref": "#/$defs/WebsitePath"
+    },
+    "offset": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Byte offset to read from; 0 when absent."
+    },
+    "length": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 262144,
+      "description": "Bytes to read; 262144 when absent."
+    },
+    "ifMatch": {
+      "$ref": "#/$defs/WebsiteEtag"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Website — Files — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "etag",
+        "sizeBytes",
+        "contentType",
+        "offset",
+        "data",
+        "complete"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "#/$defs/WebsitePath"
+        },
+        "etag": {
+          "$ref": "#/$defs/WebsiteEtag"
+        },
+        "sizeBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The whole file's size."
+        },
+        "contentType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255,
+          "description": "The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown."
+        },
+        "offset": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Echoed."
+        },
+        "data": {
+          "$ref": "#/$defs/FileData"
+        },
+        "complete": {
+          "type": "boolean",
+          "description": "Whether this range reached the end of the file."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "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.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "FileData": {
+      "title": "FileData",
+      "type": "string",
+      "maxLength": 349526,
+      "pattern": "^[A-Za-z0-9_-]*$",
+      "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."
+    },
+    "WebsiteEtag": {
+      "title": "WebsiteEtag",
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$",
+      "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."
+    },
+    "WebsitePath": {
+      "title": "WebsitePath",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "pattern": "^[^\\\\]+$",
+      "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 const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Website — Files — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "etag",
+        "sizeBytes",
+        "contentType",
+        "offset",
+        "data",
+        "complete"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "#/$defs/WebsitePath"
+        },
+        "etag": {
+          "$ref": "#/$defs/WebsiteEtag"
+        },
+        "sizeBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The whole file's size."
+        },
+        "contentType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255,
+          "description": "The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown."
+        },
+        "offset": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Echoed."
+        },
+        "data": {
+          "$ref": "#/$defs/FileData"
+        },
+        "complete": {
+          "type": "boolean",
+          "description": "Whether this range reached the end of the file."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "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.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "FileData": {
+      "title": "FileData",
+      "type": "string",
+      "maxLength": 349526,
+      "pattern": "^[A-Za-z0-9_-]*$",
+      "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."
+    },
+    "WebsiteEtag": {
+      "title": "WebsiteEtag",
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$",
+      "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."
+    },
+    "WebsitePath": {
+      "title": "WebsitePath",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "pattern": "^[^\\\\]+$",
+      "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 const;
+
+/**
+ * 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 const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * 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 const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;