@openvtc/trust-tasks 0.21.11 → 0.21.13

package/dist/vtc/website/files/show/0.1/payload.d.ts

@@ -0,0 +1,455 @@
+/**
+ * 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 declare const TYPE_URI: "https://trusttasks.org/spec/vtc/website/files/show/0.1";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCWebsiteFilesShowPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/website/files/show/0.1#response";
+/** 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vtc/website/files/show/0.1";
+    readonly title: "VTC Website — Files — Show — payload";
+    readonly description: "Read a range of one website file. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["path"];
+    readonly properties: {
+        readonly path: {
+            readonly $ref: "#/$defs/WebsitePath";
+        };
+        readonly offset: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly description: "Byte offset to read from; 0 when absent.";
+        };
+        readonly length: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 262144;
+            readonly description: "Bytes to read; 262144 when absent.";
+        };
+        readonly ifMatch: {
+            readonly $ref: "#/$defs/WebsiteEtag";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Website — Files — Show — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["path", "etag", "sizeBytes", "contentType", "offset", "data", "complete"];
+            readonly properties: {
+                readonly path: {
+                    readonly $ref: "#/$defs/WebsitePath";
+                };
+                readonly etag: {
+                    readonly $ref: "#/$defs/WebsiteEtag";
+                };
+                readonly sizeBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "The whole file's size.";
+                };
+                readonly contentType: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 255;
+                    readonly description: "The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown.";
+                };
+                readonly offset: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Echoed.";
+                };
+                readonly data: {
+                    readonly $ref: "#/$defs/FileData";
+                };
+                readonly complete: {
+                    readonly type: "boolean";
+                    readonly description: "Whether this range reached the end of the file.";
+                };
+                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 FileData: {
+            readonly title: "FileData";
+            readonly type: "string";
+            readonly maxLength: 349526;
+            readonly pattern: "^[A-Za-z0-9_-]*$";
+            readonly 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.";
+        };
+        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 — Files — Show — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["path", "etag", "sizeBytes", "contentType", "offset", "data", "complete"];
+            readonly properties: {
+                readonly path: {
+                    readonly $ref: "#/$defs/WebsitePath";
+                };
+                readonly etag: {
+                    readonly $ref: "#/$defs/WebsiteEtag";
+                };
+                readonly sizeBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "The whole file's size.";
+                };
+                readonly contentType: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 255;
+                    readonly description: "The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown.";
+                };
+                readonly offset: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Echoed.";
+                };
+                readonly data: {
+                    readonly $ref: "#/$defs/FileData";
+                };
+                readonly complete: {
+                    readonly type: "boolean";
+                    readonly description: "Whether this range reached the end of the file.";
+                };
+                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 FileData: {
+            readonly title: "FileData";
+            readonly type: "string";
+            readonly maxLength: 349526;
+            readonly pattern: "^[A-Za-z0-9_-]*$";
+            readonly 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.";
+        };
+        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/files/show/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtc/website/files/show/0.1";
+        readonly title: "VTC Website — Files — Show — payload";
+        readonly description: "Read a range of one website file. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["path"];
+        readonly properties: {
+            readonly path: {
+                readonly $ref: "#/$defs/WebsitePath";
+            };
+            readonly offset: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: "Byte offset to read from; 0 when absent.";
+            };
+            readonly length: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 262144;
+                readonly description: "Bytes to read; 262144 when absent.";
+            };
+            readonly ifMatch: {
+                readonly $ref: "#/$defs/WebsiteEtag";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Website — Files — Show — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["path", "etag", "sizeBytes", "contentType", "offset", "data", "complete"];
+                readonly properties: {
+                    readonly path: {
+                        readonly $ref: "#/$defs/WebsitePath";
+                    };
+                    readonly etag: {
+                        readonly $ref: "#/$defs/WebsiteEtag";
+                    };
+                    readonly sizeBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "The whole file's size.";
+                    };
+                    readonly contentType: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly description: "The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown.";
+                    };
+                    readonly offset: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Echoed.";
+                    };
+                    readonly data: {
+                        readonly $ref: "#/$defs/FileData";
+                    };
+                    readonly complete: {
+                        readonly type: "boolean";
+                        readonly description: "Whether this range reached the end of the file.";
+                    };
+                    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 FileData: {
+                readonly title: "FileData";
+                readonly type: "string";
+                readonly maxLength: 349526;
+                readonly pattern: "^[A-Za-z0-9_-]*$";
+                readonly 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.";
+            };
+            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/files/show/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    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 — Files — Show — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["path", "etag", "sizeBytes", "contentType", "offset", "data", "complete"];
+                readonly properties: {
+                    readonly path: {
+                        readonly $ref: "#/$defs/WebsitePath";
+                    };
+                    readonly etag: {
+                        readonly $ref: "#/$defs/WebsiteEtag";
+                    };
+                    readonly sizeBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "The whole file's size.";
+                    };
+                    readonly contentType: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly description: "The media type the site serves the file as, guessed from its extension; `application/octet-stream` when unknown.";
+                    };
+                    readonly offset: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Echoed.";
+                    };
+                    readonly data: {
+                        readonly $ref: "#/$defs/FileData";
+                    };
+                    readonly complete: {
+                        readonly type: "boolean";
+                        readonly description: "Whether this range reached the end of the file.";
+                    };
+                    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 FileData: {
+                readonly title: "FileData";
+                readonly type: "string";
+                readonly maxLength: 349526;
+                readonly pattern: "^[A-Za-z0-9_-]*$";
+                readonly 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.";
+            };
+            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

package/dist/vtc/website/files/show/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/website/files/show/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAGpG;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;AAExD,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,wDAAiE,CAAC;AAE1F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAEjD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,iEAA0E,CAAC;AAE5G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,kCAAkC,CAAC;AAE1D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqF1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}